1</sub>H), and a \\\"0\\\" bit with a shorter pulse (T<sub>0</sub>H). The total cycle length of a bit is the same.\\nThe \\\"reset\\\" pulse (T<sub>RST</sub>) latches the sent RGB data to all of the LEDs and denotes a completed \\\"frame\\\".\\n\\nSome WS2812 variants have slightly different timing parameter requirements, which can be accounted for if necessary using the above `#define`s in your `config.h`.\", \"Byte Order {#byte-order}\": \"Some WS2812 variants may have their color components in a different physical or logical order. For example, the WS2812B-2020 has physically swapped red and green LEDs, which causes the wrong color to be displayed, because the default order of the bytes sent over the wire is defined as GRB.\\nIf you find your LED colors are consistently swapped, you may need to change the byte order by adding the following to your `config.h`:\\n\\n```\\n#define WS2812_BYTE_ORDER WS2812_BYTE_ORDER_GRB\\n```\\n\\nWhere the byte order may be one of:\\n\\n|Byte Order|Known Devices |\\n|----------|----------------------------|\\n|`GRB` |Most WS2812s, SK6812, SK6805|\\n|`RGB` |WS2812B-2020 |\\n|`BGR` |TM1812 |\", \"RGBW Support {#rgbw-support}\": \"Rendering the color white with RGB LEDs is typically inconsistent due to inherent variations between each individual LED die. However, some WS2812 variants (such as SK6812RGBW) also possess a white LED along with the red, green, and blue channels, which allows for a more accurate white to be displayed.\\n\\nQMK can automatically convert the RGB data to be sent to the LEDs to mix in the white channel:\\n\\n```\\nw = min(r, g, b)\\nr -= w\\ng -= w\\nb -= w\\n```\\n\\nThus, an RGB triplet of `255,255,255` will simply turn on the white LED fully (`0,0,0,255`).\\n\\nTo enable RGBW conversion, add the following to your `config.h`:\\n\\n```\\n#define WS2812_RGBW\\n```\"}, \"Driver Configuration {#driver-configuration}\": {\"Bitbang Driver {#bitbang-driver}\": \"This is the default WS2812 driver. It operates by \\\"bit-banging\\\" ie. directly toggling the GPIO.\\n\\nPlease note that on AVR devices, due to the tight timing requirements longer chains and/or heavy CPU loads may cause visible lag. Unfortunately this driver is usually the only option for AVR.\\n\\n```\\nWS2812_DRIVER = bitbang\\n```\", \"I2C Driver {#i2c-driver}\": \"A specialized driver mainly used for PS2AVRGB (Bootmapper Client) boards, which possess an ATtiny85 that handles the WS2812 LEDs.\\n\\n```\\nWS2812_DRIVER = i2c\\n```\\n\\nThe following `#define`s apply only to the `i2c` driver:\\n\\n|Define |Default|Description |\\n|--------------------|-------|---------------------------------|\\n|`WS2812_I2C_ADDRESS`|`0xB0` |The I2C address of the ATtiny85. |\\n|`WS2812_I2C_TIMEOUT`|`100` |The I2C timeout, in milliseconds.|\", \"PIO Driver {#pio-driver}\": \"This driver is RP2040-only, and leverages the onboard PIO (programmable I/O) system and DMA to offload processing from the CPU.\\n\\nThe WS2812 PIO program uses one state machine, six instructions and one DMA interrupt handler callback. Due to the implementation the time resolution for this driver is 50 ns - any value not specified in this interval will be rounded to the next matching interval.\\n\\n```\\nWS2812_DRIVER = vendor\\n```\", \"PWM Driver {#pwm-driver}\": \"This driver is ARM-only, and leverages the onboard PWM peripheral and DMA to offload processing from the CPU.\\n\\n```\\nWS2812_DRIVER = pwm\\n```\", \"SPI Driver {#spi-driver}\": \"This driver is ARM-only, and leverages the onboard SPI peripheral and DMA to offload processing from the CPU. The DI pin **must** be connected to the MOSI pin on the MCU, and all other SPI pins **must** be left unused. This is also very dependent on your MCU's SPI peripheral clock speed, and may or may not be possible depending on the MCU selected.\\n\\n```\\nWS2812_DRIVER = spi\\n```\"}, \"ChibiOS/ARM Configuration {#arm-configuration}\": {\"Logic Levels {#logic-levels}\": {\"1. Open Drain Circuit {#open-drain-circuit}\": \"By default, `WS2812_DI_PIN` is configured as a *push-pull* output, meaning the pin is effectively always driven either to VCC or to ground; however, it can be configured in *open drain* mode instead.\\n\\nIn this mode, the MCU will only pull the GPIO *low*, and leaves it floating otherwise. A pullup resistor (typically around 10k\\u2126) between DI and 5V is then responsible for pulling the line high when the MCU is not driving the GPIO.\\n\\nTo use the DI pin in open drain configuration, add the following to your `config.h`:\\n\\n```\\n#define WS2812_EXTERNAL_PULLUP\\n```\\n\\n::: warning\\nBecause the GPIO is being pulled to 5V in this situation rather than VCC (3.3V), **it must be a 5V tolerant pin**. Consult your MCU's datasheet first \\u2013 if there are no eligible pins, you must use a level shifter instead.\\n:::\", \"2. Level Shifter {#level-shifter}\": \"A level shifter IC, such as the SN74LV1T34, can be placed between the GPIO and the first LED's DI pin to convert the 3.3V logic to 5V. This requires no additional configuration in the firmware, nor a 5V tolerant GPIO, but may be more expensive and is generally less handwire-friendly.\"}, \"SPI Driver {#arm-spi-driver}\": {\"Setting the Baudrate {#arm-spi-baudrate}\": \"To adjust the SPI baudrate, you will need to derive the target baudrate from the clock tree provided by STM32CubeMX, and add the following to your `config.h`:\\n\\n```\\n#define WS2812_SPI_DIVISOR 16\\n```\\n\\nOnly divisors of 2, 4, 8, 16, 32, 64, 128 and 256 are supported on STM32 devices. Other MCUs may have similar constraints -- check the reference manual for your respective MCU for specifics.\", \"Circular Buffer {#arm-spi-circular-buffer}\": \"A circular buffer can be enabled if you experience flickering.\\n\\nTo enable the circular buffer, add the following to your `config.h`:\\n\\n```\\n#define WS2812_SPI_USE_CIRCULAR_BUFFER\\n```\"}, \"PIO Driver {#arm-pio-driver}\": \"The following `#define`s apply only to the PIO driver:\\n\\n|Define |Default |Description |\\n|---------------------|-------------|---------------------------------------|\\n|`WS2812_PIO_USE_PIO1`|*Not defined*|Use the PIO1 peripheral instead of PIO0|\", \"PWM Driver {#arm-pwm-driver}\": \"Depending on the ChibiOS board configuration, you may need to enable PWM at the keyboard level. For STM32, this would look like:\\n\\n::: code-group\\n\\n```\\n#pragma once\\n\\n#define HAL_USE_PWM TRUE // [!code focus]\\n\\n#include_next <halconf.h>\\n```\\n\\n```\\n#pragma once\\n\\n#include_next <mcuconf.h>\\n\\n#undef STM32_PWM_USE_TIM2 // [!code focus]\\n#define STM32_PWM_USE_TIM2 TRUE // [!code focus]\\n```\\n\\n:::\\n\\nThe following `#define`s apply only to the `pwm` driver:\\n\\n|Define |Default |Description |\\n|---------------------------------|--------------------|------------------------------------------------------------------------------------------|\\n|`WS2812_PWM_DRIVER` |`PWMD2` |The PWM driver to use |\\n|`WS2812_PWM_CHANNEL` |`2` |The PWM channel to use |\\n|`WS2812_PWM_PAL_MODE` |`2` |The pin alternative function to use |\\n|`WS2812_PWM_DMA_STREAM` |`STM32_DMA1_STREAM2`|The DMA Stream for `TIMx_UP` |\\n|`WS2812_PWM_DMA_CHANNEL` |`2` |The DMA Channel for `TIMx_UP` |\\n|`WS2812_PWM_DMAMUX_ID` |*Not defined* |The DMAMUX configuration for `TIMx_UP` - only required if your MCU has a DMAMUX peripheral|\\n|`WS2812_PWM_COMPLEMENTARY_OUTPUT`|*Not defined* |Whether the PWM output is complementary (`TIMx_CHyN`) |\\n\\n::: tip\\nUsing a complementary timer output (`TIMx_CHyN`) is possible only for advanced-control timers (1, 8 and 20 on STM32). Complementary outputs of general-purpose timers are not supported due to ChibiOS limitations.\\n:::\"}, \"API {#api}\": {\"`void ws2812_init(void)` {#api-ws2812-init}\": \"Initialize the LED driver. This function should be called first.\\n\\n[]\", \"`void ws2812_set_color(int index, uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color}\": {\"Arguments {#api-ws2812-set-color-arguments}\": [\"`int index` \\nThe LED index in the WS2812 chain.\", \"`uint8_t red` \\nThe red value to set.\", \"`uint8_t green` \\nThe green value to set.\", \"`uint8_t blue` \\nThe blue value to set.\"]}, \"`void ws812_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-ws2812-set-color-all}\": {\"Arguments {#api-ws2812-set-color-all-arguments}\": [\"`uint8_t red` \\nThe red value to set.\", \"`uint8_t green` \\nThe green value to set.\", \"`uint8_t blue` \\nThe blue value to set.\"]}, \"`void ws2812_flush(void)` {#api-ws2812-flush}\": \"Flush the PWM values to the LED chain.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 107, \\\"subpages\\\", 25]\"}], \"path\": \"[\\\"subpages\\\", 107]\"}, {\"title\": \"Features\", \"description\": \"Documentation section: features\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/qmk_firmware/original/docs/features\"}, \"subpages\": [{\"title\": \"Audio\", \"description\": null, \"content\": {\"AVR based boards\": {\"Wiring\": \"per speaker is - for example with a piezo buzzer - the black lead to Ground, and the red lead connected to the selected AUDIO_PIN for the primary; and similarly with AUDIO_PIN_ALT for the secondary.\"}, \"ARM based boards\": {\"DAC (additive)\": \"Another option, besides dac_basic (which produces sound through a square-wave), is to use the DAC to do additive wave synthesis.\\nWith a number of predefined wave-forms or by providing your own implementation to generate samples on the fly.\\nTo use this feature set `AUDIO_DRIVER = dac_additive` in your `rules.mk`, and select in `config.h` EITHER `#define AUDIO_PIN A4` or `#define AUDIO_PIN A5`.\\n\\nThe used waveform *defaults* to sine, but others can be selected by adding one of the following defines to `config.h`:\\n\\n['`#define AUDIO_DAC_SAMPLE_WAVEFORM_SINE`', '`#define AUDIO_DAC_SAMPLE_WAVEFORM_TRIANGLE`', '`#define AUDIO_DAC_SAMPLE_WAVEFORM_TRAPEZOID`', '`#define AUDIO_DAC_SAMPLE_WAVEFORM_SQUARE`']\\n\\nShould you rather choose to generate and use your own sample-table with the DAC unit, implement `uint16_t dac_value_generate(void)` with your keyboard - for an example implementation see keyboards/planck/keymaps/synth_sample or keyboards/planck/keymaps/synth_wavetable\", \"PWM (software)\": {\"Wiring\": \"the usual piezo wiring: red goes to the selected AUDIO_PIN, black goes to ground.\\n\\nOR if you can chose to drive one piezo with two pins, for example `#define AUDIO_PIN B1`, `#define AUDIO_PIN_ALT B2` in `config.h`, with `#define AUDIO_PIN_ALT_AS_NEGATIVE` - then the red lead could go to B1, the black to B2.\"}, \"PWM (hardware)\": \"STM32F1xx have to fall back to using PWM, but can do so in hardware; but again on currently only one speaker/pin.\\n\\n`AUDIO_DRIVER = pwm_hardware` in `rules.mk`, and in `config.h`:\\n`#define AUDIO_PIN A8`\\n`#define AUDIO_PWM_DRIVER PWMD1`\\n`#define AUDIO_PWM_CHANNEL 1`\\n(as well as `#define AUDIO_PWM_PAL_MODE 42` if you are on STM32F2 or larger)\\nwhich will use Timer 1 to directly drive pin PA8 through the PWM hardware (TIM1_CH1 = PA8).\\nShould you want to use the pwm-hardware on another pin and timer - be ready to dig into the STM32 data-sheet to pick the right TIMx_CHy and pin-alternate function.\"}, \"Tone Multiplexing\": \"Since most drivers can only render one tone per speaker at a time (with the one exception: arm dac-additive) there also exists a \\\"workaround-feature\\\" that does time-slicing/multiplexing - which does what the name implies: cycle through a set of active tones (e.g. when playing chords in Music Mode) at a given rate, and put one tone at a time out through the one/few speakers that are available.\\n\\nTo enable this feature, and configure a starting-rate, add the following defines to `config.h`:\\n\\n```\\n#define AUDIO_ENABLE_TONE_MULTIPLEXING\\n#define AUDIO_TONE_MULTIPLEXING_RATE_DEFAULT 10\\n```\\n\\nThe audio core offers interface functions to get/set/change the tone multiplexing rate from within `keymap.c`.\", \"Songs\": \"There's a couple of different sounds that will automatically be enabled without any other configuration:\\n\\n```\\nSTARTUP_SONG // plays when the keyboard starts up (audio.c)\\nGOODBYE_SONG // plays when you press the QK_BOOT key (quantum.c)\\nAG_NORM_SONG // plays when you press AG_NORM (quantum.c)\\nAG_SWAP_SONG // plays when you press AG_SWAP (quantum.c)\\nCG_NORM_SONG // plays when you press CG_NORM (quantum.c)\\nCG_SWAP_SONG // plays when you press CG_SWAP (quantum.c)\\nMUSIC_ON_SONG // plays when music mode is activated (process_music.c)\\nMUSIC_OFF_SONG // plays when music mode is deactivated (process_music.c)\\nCHROMATIC_SONG // plays when the chromatic music mode is selected (process_music.c)\\nGUITAR_SONG // plays when the guitar music mode is selected (process_music.c)\\nVIOLIN_SONG // plays when the violin music mode is selected (process_music.c)\\nMAJOR_SONG // plays when the major music mode is selected (process_music.c)\\n```\\n\\nYou can override the default songs by doing something like this in your `config.h`:\\n\\n```\\n#ifdef AUDIO_ENABLE\\n# define STARTUP_SONG SONG(STARTUP_SOUND)\\n#endif\\n```\\n\\nA full list of sounds can be found in [quantum/audio/song_list.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/song_list.h) - feel free to add your own to this list! All available notes can be seen in [quantum/audio/musical_notes.h](https://github.com/qmk/qmk_firmware/blob/master/quantum/audio/musical_notes.h).\\n\\nAdditionally, if you with to maintain your own list of songs (such as ones that may be copyrighted) and not have them added to the repo, you can create a `user_song_list.h` file and place it in your keymap (or userspace) folder. This file will be automatically included, it just needs to exist.\\n\\nTo play a custom sound at a particular time, you can define a song like this (near the top of the file):\\n\\n```\\nfloat my_song[][2] = SONG(QWERTY_SOUND);\\n```\\n\\nAnd then play your song like this:\\n\\n```\\nPLAY_SONG(my_song);\\n```\\n\\nAlternatively, you can play it in a loop like this:\\n\\n```\\nPLAY_LOOP(my_song);\\n```\\n\\nIt's advised that you wrap all audio features in `#ifdef AUDIO_ENABLE` / `#endif` to avoid causing problems when audio isn't built into the keyboard.\\n\\nThe available keycodes for audio are: \\n\\n|Key |Aliases |Description |\\n|-------------------------|---------|-------------------------------------------|\\n|`QK_AUDIO_ON` |`AU_ON` |Turns on Audio Feature |\\n|`QK_AUDIO_OFF` |`AU_OFF` |Turns off Audio Feature |\\n|`QK_AUDIO_TOGGLE` |`AU_TOGG`|Toggles Audio state |\\n\\n::: warning\\nThese keycodes turn all of the audio functionality on and off. Turning it off means that audio feedback, audio clicky, music mode, etc. are disabled, completely.\\n:::\", \"Audio Config\": \"| Settings | Default | Description |\\n|----------------------------------|----------------------|---------------------------------------------------------------------------------------------|\\n|`AUDIO_PIN` | *Not defined* |Configures the pin that the speaker is connected to. |\\n|`AUDIO_PIN_ALT` | *Not defined* |Configures the pin for a second speaker or second pin connected to one speaker. |\\n|`AUDIO_PIN_ALT_AS_NEGATIVE` | *Not defined* |Enables support for one speaker connected to two pins. |\\n|`AUDIO_INIT_DELAY` | *Not defined* |Enables delay during startup song to accomidate for USB startup issues. |\\n|`AUDIO_ENABLE_TONE_MULTIPLEXING` | *Not defined* |Enables time splicing/multiplexing to create multiple tones simutaneously. |\\n|`AUDIO_POWER_CONTROL_PIN` | *Not defined* |Enables power control code to enable or cut off power to speaker (such as with PAM8302 amp). |\\n|`AUDIO_POWER_CONTROL_PIN_ON_STATE`| `1` |The state of the audio power control pin when audio is \\\"on\\\" - `1` for high, `0` for low. |\\n|`STARTUP_SONG` | `STARTUP_SOUND` |Plays when the keyboard starts up (audio.c) |\\n|`GOODBYE_SONG` | `GOODBYE_SOUND` |Plays when you press the QK_BOOT key (quantum.c) |\\n|`AG_NORM_SONG` | `AG_NORM_SOUND` |Plays when you press AG_NORM (process_magic.c) |\\n|`AG_SWAP_SONG` | `AG_SWAP_SOUND` |Plays when you press AG_SWAP (process_magic.c) |\\n|`CG_NORM_SONG` | `AG_NORM_SOUND` |Plays when you press CG_NORM (process_magic.c) |\\n|`CG_SWAP_SONG` | `AG_SWAP_SOUND` |Plays when you press CG_SWAP (process_magic.c) |\\n|`MUSIC_ON_SONG` | `MUSIC_ON_SOUND` |Plays when music mode is activated (process_music.c) |\\n|`MUSIC_OFF_SONG` | `MUSIC_OFF_SOUND` |Plays when music mode is deactivated (process_music.c) |\\n|`MIDI_ON_SONG` | `MUSIC_ON_SOUND` |Plays when midi mode is activated (process_music.c) |\\n|`MIDI_OFF_SONG` | `MUSIC_OFF_SOUND` |Plays when midi mode is deactivated (process_music.c) |\\n|`CHROMATIC_SONG` | `CHROMATIC_SOUND` |Plays when the chromatic music mode is selected (process_music.c) |\\n|`GUITAR_SONG` | `GUITAR_SOUND` |Plays when the guitar music mode is selected (process_music.c) |\\n|`VIOLIN_SONG` | `VIOLIN_SOUND` |Plays when the violin music mode is selected (process_music.c) |\\n|`MAJOR_SONG` | `MAJOR_SOUND` |Plays when the major music mode is selected (process_music.c) |\\n|`DEFAULT_LAYER_SONGS` | *Not defined* |Plays song when switched default layers with [`set_single_persistent_default_layer(layer)`](../ref_functions#setting-the-persistent-default-layer)(quantum.c). |\\n|`SENDSTRING_BELL` | *Not defined* |Plays chime when the \\\"enter\\\" (\\\"\\\\a\\\") character is sent (send_string.c) |\", \"Tempo\": \"the 'speed' at which SONGs are played is dictated by the set Tempo, which is measured in beats-per-minute. Note lengths are defined relative to that.\\nThe initial/default tempo is set to 120 bpm, but can be configured by setting `TEMPO_DEFAULT` in `config.c`.\\nThere is also a set of functions to modify the tempo from within the user/keymap code:\\n\\n```\\nvoid audio_set_tempo(uint8_t tempo);\\nvoid audio_increase_tempo(uint8_t tempo_change);\\nvoid audio_decrease_tempo(uint8_t tempo_change);\\n```\", \"ARM Audio Volume\": \"For ARM devices, you can adjust the DAC sample values. If your board is too loud for you or your coworkers, you can set the max using `AUDIO_DAC_SAMPLE_MAX` in your `config.h`:\\n\\n```\\n#define AUDIO_DAC_SAMPLE_MAX 4095U\\n```\\n\\nthe DAC usually runs in 12Bit mode, hence a volume of 100% = 4095U\\n\\nNote: this only adjusts the volume aka 'works' if you stick to WAVEFORM_SQUARE, since its samples are generated on the fly - any other waveform uses a hardcoded/precomputed sample-buffer.\", \"Voices\": \"Aka \\\"audio effects\\\", different ones can be enabled by setting in `config.h` these defines:\\n`#define AUDIO_VOICES` to enable the feature, and `#define AUDIO_VOICE_DEFAULT something` to select a specific effect\\nfor details see quantum/audio/voices.h and .c\\n\\nKeycodes available:\\n\\n|Key |Aliases |Description |\\n|-------------------------|---------|-------------------------------------------|\\n|`QK_AUDIO_VOICE_NEXT` |`AU_NEXT`|Cycles through the audio voices |\\n|`QK_AUDIO_VOICE_PREVIOUS`|`AU_PREV`|Cycles through the audio voices in reverse |\", \"Music Mode\": {\"Music Mask\": \"By default, `MUSIC_MASK` is set to `keycode < 0xFF` which means keycodes less than `0xFF` are turned into notes, and don't output anything. You can change this by defining this in your `config.h` like this:\\n\\n```\\n#define MUSIC_MASK keycode != KC_NO\\n```\\n\\nWhich will capture all keycodes - be careful, this will get you stuck in music mode until you restart your keyboard!\\n\\nFor a more advanced way to control which keycodes should still be processed, you can use `music_mask_kb(keycode)` in `<keyboard>.c` and `music_mask_user(keycode)` in your `keymap.c`:\\n\\n```\\n bool music_mask_user(uint16_t keycode) {\\n switch (keycode) {\\n case RAISE:\\n case LOWER:\\n return false;\\n default:\\n return true;\\n }\\n }\\n```\\n\\nThings that return false are not part of the mask, and are always processed.\", \"Music Map\": \"By default, the Music Mode uses the columns and row to determine the scale for the keys. For a board that uses a rectangular matrix that matches the keyboard layout, this is just fine. However, for boards that use a more complicated matrix (such as the Planck Rev6, or many split keyboards) this would result in a very skewed experience. \\n\\nHowever, the Music Map option allows you to remap the scaling for the music mode, so it fits the layout, and is more natural. \\n\\nTo enable this feature, add `#define MUSIC_MAP` to your `config.h` file, and then you will want to add a `uint8_t music_map` to your keyboard's `c` file, or your `keymap.c`.\\n\\n```\\nconst uint8_t music_map[MATRIX_ROWS][MATRIX_COLS] = LAYOUT_ortho_4x12(\\n 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47,\\n 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35,\\n 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23,\\n 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11\\n);\\n```\\n\\nYou will want to use whichever `LAYOUT` macro that your keyboard uses here. This maps it to the correct key location. Start in the bottom left of the keyboard layout, and move to the right, and then upwards. Fill in all the entries until you have a complete matrix. \\n\\nYou can look at the [Planck Keyboard](https://github.com/qmk/qmk_firmware/blob/e9ace1487887c1f8b4a7e8e6d87c322988bec9ce/keyboards/planck/planck.c#L24-L29) as an example of how to implement this. \"}, \"Audio Click\": \"This adds a click sound each time you hit a button, to simulate click sounds from the keyboard. And the sounds are slightly different for each keypress, so it doesn't sound like a single long note, if you type rapidly. \\n\\nKeycodes available:\\n\\n|Key |Aliases |Description |\\n|-------------------------|---------|-------------------------------------------|\\n|`QK_AUDIO_CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |\\n|`QK_AUDIO_CLICKY_ON` |`CK_ON` |Turns on Audio clicky mode |\\n|`QK_AUDIO_CLICKY_OFF` |`CK_OFF` |Turns on Audio clicky mode |\\n|`QK_AUDIO_CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |\\n|`QK_AUDIO_CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |\\n|`QK_AUDIO_CLICKY_RESET` |`CK_RST` |Resets frequency to default |\\n\\nThe feature is disabled by default, to save space. To enable it, add this to your `config.h`:\\n\\n```\\n#define AUDIO_CLICKY\\n```\\n\\nYou can configure the default, min and max frequencies, the stepping and built in randomness by defining these values: \\n\\n| Option | Default Value | Description |\\n|--------|---------------|-------------|\\n| `AUDIO_CLICKY_FREQ_DEFAULT` | 440.0f | Sets the default/starting audio frequency for the clicky sounds. |\\n| `AUDIO_CLICKY_FREQ_MIN` | 65.0f | Sets the lowest frequency (under 60f are a bit buggy). |\\n| `AUDIO_CLICKY_FREQ_MAX` | 1500.0f | Sets the highest frequency. Too high may result in coworkers attacking you. |\\n| `AUDIO_CLICKY_FREQ_FACTOR` | 1.18921f| Sets the stepping of UP/DOWN key codes. This is a multiplicative factor. The default steps the frequency up/down by a musical minor third. |\\n| `AUDIO_CLICKY_FREQ_RANDOMNESS` | 0.05f | Sets a factor of randomness for the clicks, Setting this to `0f` will make each click identical, and `1.0f` will make this sound much like the 90's computer screen scrolling/typing effect. | \\n| `AUDIO_CLICKY_DELAY_DURATION` | 1 | An integer note duration where 1 is 1/16th of the tempo, or a sixty-fourth note (see `quantum/audio/musical_notes.h` for implementation details). The main clicky effect will be delayed by this duration. Adjusting this to values around 6-12 will help compensate for loud switches. |\", \"MIDI Functionality\": \"See [MIDI](midi)\", \"Audio Keycodes\": \"|Key |Aliases |Description |\\n|-------------------------|---------|-------------------------------------------|\\n|`QK_AUDIO_ON` |`AU_ON` |Turns on Audio Feature |\\n|`QK_AUDIO_OFF` |`AU_OFF` |Turns off Audio Feature |\\n|`QK_AUDIO_TOGGLE` |`AU_TOGG`|Toggles Audio state |\\n|`QK_AUDIO_CLICKY_TOGGLE` |`CK_TOGG`|Toggles Audio clicky mode |\\n|`QK_AUDIO_CLICKY_ON` |`CK_ON` |Turns on Audio clicky mode |\\n|`QK_AUDIO_CLICKY_OFF` |`CK_OFF` |Turns on Audio clicky mode |\\n|`QK_AUDIO_CLICKY_UP` |`CK_UP` |Increases frequency of the clicks |\\n|`QK_AUDIO_CLICKY_DOWN` |`CK_DOWN`|Decreases frequency of the clicks |\\n|`QK_AUDIO_CLICKY_RESET` |`CK_RST` |Resets frequency to default |\\n|`QK_MUSIC_ON` |`MU_ON` |Turns on Music Mode |\\n|`QK_MUSIC_OFF` |`MU_OFF` |Turns off Music Mode |\\n|`QK_MUSIC_TOGGLE` |`MU_TOGG`|Toggles Music Mode |\\n|`QK_MUSIC_MODE_NEXT` |`MU_NEXT`|Cycles through the music modes |\\n|`QK_AUDIO_VOICE_NEXT` |`AU_NEXT`|Cycles through the audio voices |\\n|`QK_AUDIO_VOICE_PREVIOUS`|`AU_PREV`|Cycles through the audio voices in reverse |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 0]\"}, {\"title\": \"Auto Shift: Why Do We Need a Shift Key?\", \"description\": null, \"content\": {\"Why Auto Shift?\": \"Many people suffer from various forms of RSI. A common cause is stretching your\\nfingers repetitively long distances. For us on the keyboard, the pinky does that\\nall too often when reaching for the shift key. Auto Shift looks to alleviate that\\nproblem.\", \"How Does It Work?\": \"When you tap a key, it stays depressed for a short period of time before it is\\nthen released. This depressed time is a different length for everyone. Auto Shift\\ndefines a constant `AUTO_SHIFT_TIMEOUT` which is typically set to twice your\\nnormal pressed state time. When you press a key, a timer starts, and if you\\nhave not released the key after the `AUTO_SHIFT_TIMEOUT` period, then a shifted\\nversion of the key is emitted. If the time is less than the `AUTO_SHIFT_TIMEOUT`\\ntime, or you press another key, then the normal state is emitted.\\n\\nIf `AUTO_SHIFT_REPEAT` is defined, there is keyrepeat support. Holding the key\\ndown will repeat the shifted key, though this can be disabled with\\n`AUTO_SHIFT_NO_AUTO_REPEAT`. If you want to repeat the normal key, then tap it\\nonce then immediately (within `TAPPING_TERM`) hold it down again (this works\\nwith the shifted value as well if auto-repeat is disabled).\\n\\nThere are also the `get_auto_shift_repeat` and `get_auto_shift_no_auto_repeat`\\nfunctions for more granular control. Neither will have an effect unless\\n`AUTO_SHIFT_REPEAT_PER_KEY` or `AUTO_SHIFT_NO_AUTO_REPEAT_PER_KEY` respectively\\nare defined.\", \"Are There Limitations to Auto Shift?\": \"Yes, unfortunately.\\n\\n['You will have characters that are shifted when you did not intend on shifting, and\\\\nother characters you wanted shifted, but were not. This simply comes down to\\\\npractice. As we get in a hurry, we think we have hit the key long enough for a\\\\nshifted version, but we did not. On the other hand, we may think we are tapping\\\\nthe keys, but really we have held it for a little longer than anticipated.', \\\"Additionally, with keyrepeat the desired shift state can get mixed up. It will\\\\nalways 'belong' to the last key pressed. For example, keyrepeating a capital\\\\nand then tapping something lowercase (whether or not it's an Auto Shift key)\\\\nwill result in the capital's *key* still being held, but shift not.\\\", 'Auto Shift does not apply to Tap Hold keys. For automatic shifting of Tap Hold\\\\nkeys see [Retro Shift](#retro-shift).']\", \"How Do I Enable Auto Shift?\": \"Add to your `rules.mk` in the keymap folder:\\n\\n```\\nAUTO_SHIFT_ENABLE = yes\\n```\\n\\nIf no `rules.mk` exists, you can create one.\\n\\nThen compile and install your new firmware with Auto Key enabled! That's it!\", \"Modifiers\": \"By default, Auto Shift is disabled for any key press that is accompanied by one or more\\nmodifiers. Thus, Ctrl+A that you hold for a really long time is not the same\\nas Ctrl+Shift+A.\\n\\nYou can re-enable Auto Shift for modifiers by adding a define to your `config.h`\\n\\n```\\n#define AUTO_SHIFT_MODIFIERS\\n```\\n\\nIn which case, Ctrl+A held past the `AUTO_SHIFT_TIMEOUT` will be sent as Ctrl+Shift+A\", \"Configuring Auto Shift\": {\"AUTO_SHIFT_TIMEOUT (Value in ms)\": \"This controls how long you have to hold a key before you get the shifted state.\\nObviously, this is different for everyone. For the common person, a setting of\\n135 to 150 works great. However, one should start with a value of at least 175, which\\nis the default value. Then work down from there. The idea is to have the shortest time required to get the shifted state without having false positives.\\n\\nPlay with this value until things are perfect. Many find that all will work well\\nat a given value, but one or two keys will still emit the shifted state on\\noccasion. This is simply due to habit and holding some keys a little longer\\nthan others. Once you find this value, work on tapping your problem keys a little\\nquicker than normal and you will be set.\\n\\n::: tip\\nAuto Shift has three special keys that can help you get this value right very quick. See \\\"Auto Shift Setup\\\" for more details!\\n:::\\n\\nFor more granular control of this feature, you can add the following to your `config.h`:\\n\\n```\\n#define AUTO_SHIFT_TIMEOUT_PER_KEY\\n```\\n\\nYou can then add the following function to your keymap:\\n\\n```\\nuint16_t get_autoshift_timeout(uint16_t keycode, keyrecord_t *record) {\\n switch(keycode) {\\n case AUTO_SHIFT_NUMERIC:\\n return 2 * get_generic_autoshift_timeout();\\n case AUTO_SHIFT_SPECIAL:\\n return get_generic_autoshift_timeout() + 50;\\n case AUTO_SHIFT_ALPHA:\\n default:\\n return get_generic_autoshift_timeout();\\n }\\n}\\n```\\n\\nNote that you cannot override individual keys that are in one of those groups\\nif you are using them; trying to add a case for `KC_A` in the above example will\\nnot compile as `AUTO_SHIFT_ALPHA` is there. A possible solution is a second switch\\nabove to handle individual keys with no default case and only referencing the\\ngroups in the below fallback switch.\", \"NO_AUTO_SHIFT_SPECIAL (simple define)\": \"Do not Auto Shift special keys, which include -\\\\_, =+, [{, ]}, ;:, '\\\", ,<, .>,\\n/?, and the KC_TAB.\", \"NO_AUTO_SHIFT_TAB (simple define)\": \"Do not Auto Shift KC_TAB but leave Auto Shift enabled for the other special\\ncharacters.\", \"NO_AUTO_SHIFT_SYMBOLS (simple define)\": \"Do not Auto Shift symbol keys, which include -\\\\_, =+, [{, ]}, ;:, '\\\", ,<, .>,\\nand /?.\", \"NO_AUTO_SHIFT_NUMERIC (simple define)\": \"Do not Auto Shift numeric keys, zero through nine.\", \"NO_AUTO_SHIFT_ALPHA (simple define)\": \"Do not Auto Shift alpha characters, which include A through Z.\", \"AUTO_SHIFT_ENTER (simple define)\": \"Auto Shift the enter key.\", \"Auto Shift Per Key\": \"There are functions that allows you to determine which keys should be autoshifted, much like the tap-hold keys.\\n\\nThe first of these, used to simply add a key to Auto Shift, is `get_custom_auto_shifted_key`:\\n\\n```\\nbool get_custom_auto_shifted_key(uint16_t keycode, keyrecord_t *record) {\\n switch(keycode) {\\n case KC_DOT:\\n return true;\\n default:\\n return false;\\n }\\n}\\n```\\n\\nFor more granular control, there is `get_auto_shifted_key`. The default function looks like this:\\n\\n```\\nbool get_auto_shifted_key(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n# ifndef NO_AUTO_SHIFT_ALPHA\\n case AUTO_SHIFT_ALPHA:\\n# endif\\n# ifndef NO_AUTO_SHIFT_NUMERIC\\n case AUTO_SHIFT_NUMERIC:\\n# endif\\n# ifndef NO_AUTO_SHIFT_SPECIAL\\n# ifndef NO_AUTO_SHIFT_TAB\\n case KC_TAB:\\n# endif\\n# ifndef NO_AUTO_SHIFT_SYMBOLS\\n case AUTO_SHIFT_SYMBOLS:\\n# endif\\n# endif\\n# ifdef AUTO_SHIFT_ENTER\\n case KC_ENT:\\n# endif\\n return true;\\n }\\n return get_custom_auto_shifted_key(keycode, record);\\n}\\n```\\n\\nThis functionality is enabled by default, and does not need a define.\", \"AUTO_SHIFT_REPEAT (simple define)\": \"Enables keyrepeat.\", \"AUTO_SHIFT_NO_AUTO_REPEAT (simple define)\": \"Disables automatically keyrepeating when `AUTO_SHIFT_TIMEOUT` is exceeded.\", \"AUTO_SHIFT_ALPHA (predefined key group)\": \"A predefined group of keys representing A through Z.\", \"AUTO_SHIFT_NUMERIC (predefined key group)\": \"A predefined group of keys representing 0 through 9. Note, these are defined as\\n1 through 0 since that is the order they normally appear in.\", \"AUTO_SHIFT_SYMBOLS (predefined key group)\": \"A predefined group of keys representing symbolic characters which include -\\\\_, =+, [{, ]}, ;:, '\\\", ,<, .>,\\nand /?.\", \"AUTO_SHIFT_SPECIAL (predefined key group)\": \"A predefined group of keys that combines AUTO_SHIFT_SYMBOLS and KC_TAB.\"}, \"Custom Shifted Values\": \"Especially on small keyboards, the default shifted value for many keys is not\\noptimal. To provide more customizability, there are two user-definable\\nfunctions, `autoshift_press/release_user`. These register or unregister the\\ncorrect value for the passed key. Below is an example adding period to Auto\\nShift and making its shifted value exclamation point. Make sure to use weak\\nmods - setting real would make any keys following it use their shifted values\\nas if you were holding the key. Clearing of modifiers is handled by Auto Shift,\\nand the OS-sent shift value if keyrepeating multiple keys is always that of\\nthe last key pressed (whether or not it's an Auto Shift key).\\n\\nYou can also have non-shifted keys for the shifted values (or even no shifted\\nvalue), just don't set a shift modifier!\\n\\n```\\nbool get_custom_auto_shifted_key(uint16_t keycode, keyrecord_t *record) {\\n switch(keycode) {\\n case KC_DOT:\\n return true;\\n default:\\n return false;\\n }\\n}\\n\\nvoid autoshift_press_user(uint16_t keycode, bool shifted, keyrecord_t *record) {\\n switch(keycode) {\\n case KC_DOT:\\n register_code16((!shifted) ? KC_DOT : KC_EXLM);\\n break;\\n default:\\n if (shifted) {\\n add_weak_mods(MOD_BIT(KC_LSFT));\\n }\\n // & 0xFF gets the Tap key for Tap Holds, required when using Retro Shift\\n register_code16((IS_RETRO(keycode)) ? keycode & 0xFF : keycode);\\n }\\n}\\n\\nvoid autoshift_release_user(uint16_t keycode, bool shifted, keyrecord_t *record) {\\n switch(keycode) {\\n case KC_DOT:\\n unregister_code16((!shifted) ? KC_DOT : KC_EXLM);\\n break;\\n default:\\n // & 0xFF gets the Tap key for Tap Holds, required when using Retro Shift\\n // The IS_RETRO check isn't really necessary here, always using\\n // keycode & 0xFF would be fine.\\n unregister_code16((IS_RETRO(keycode)) ? keycode & 0xFF : keycode);\\n }\\n}\\n```\", \"Retro Shift\": {\"Retro Shift and Tap Hold Configurations\": \"Tap Hold Configurations work a little differently when using Retro Shift.\\nReferencing `TAPPING_TERM` makes little sense, as holding longer would result in\\nshifting one of the keys.\\n\\n`RETRO_SHIFT` enables [`PERMISSIVE_HOLD`-like behaviour](../tap_hold#permissive-hold) (even if not explicitly enabled) on all mod-taps for which `RETRO_SHIFT` applies.\"}, \"Using Auto Shift Setup\": {\"Setup\": \"Map three keys temporarily in your keymap:\\n\\n|Keycode |Aliases |Description |\\n|----------------------|---------|--------------------------------------------|\\n|`QK_AUTO_SHIFT_DOWN` |`AS_DOWN`|Lower the Auto Shift timeout variable (down)|\\n|`QK_AUTO_SHIFT_UP` |`AS_UP` |Raise the Auto Shift timeout variable (up) |\\n|`QK_AUTO_SHIFT_REPORT`|`AS_RPT` |Report your current Auto Shift timeout value|\\n|`QK_AUTO_SHIFT_ON` |`AS_ON` |Turns on the Auto Shift Function |\\n|`QK_AUTO_SHIFT_OFF` |`AS_OFF` |Turns off the Auto Shift Function |\\n|`QK_AUTO_SHIFT_TOGGLE`|`AS_TOGG`|Toggles the state of the Auto Shift feature |\\n\\nCompile and upload your new firmware.\", \"Use\": {\"An Example Run\": \"```\\nhello world. my name is john doe. i am a computer programmer playing with\\nkeyboards right now.\\n\\n[PRESS AS_DOWN quite a few times]\\n\\nheLLo woRLd. mY nAMe is JOHn dOE. i AM A compUTeR proGRaMMER PlAYiNG witH\\nKEYboArDS RiGHT NOw.\\n\\n[PRESS AS_UP a few times]\\n\\nhello world. my name is john Doe. i am a computer programmer playing with\\nkeyboarDs right now.\\n\\n[PRESS AS_RPT]\\n\\n115\\n```\\n\\nThe keyboard typed `115` which represents your current `AUTO_SHIFT_TIMEOUT`\\nvalue. You are now set! Practice on the *D* key a little bit that showed up\\nin the testing and you'll be golden.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 1]\"}, {\"title\": \"Autocorrect\", \"description\": null, \"content\": {\"How does it work? {#how-does-it-work}\": \"The feature maintains a small buffer of recent key presses. On each key press, it checks whether the buffer ends in a recognized typo, and if so, automatically sends keystrokes to correct it.\\n\\nThe tricky part is how to efficiently check the buffer for typos. We don\\u2019t want to spend too much memory or time on storing or searching the typos. A good solution is to represent the typos with a trie data structure. A trie is a tree data structure where each node is a letter, and words are formed by following a path to one of the leaves.\\n\\n\\n\\nSince we search whether the buffer ends in a typo, we store the trie writing in reverse. The trie is queried starting from the last letter, then second to last letter, and so on, until either a letter doesn\\u2019t match or we reach a leaf, meaning a typo was found.\", \"How do I enable Autocorrection {#how-do-i-enable-autocorrection}\": \"In your `rules.mk`, add this:\\n\\n```\\nAUTOCORRECT_ENABLE = yes\\n```\\n\\nAdditionally, you will need a library for autocorrection. A small sample library is included by default, so that you can get up and running right away, but you can provide a customized library.\\n\\nBy default, autocorrect is disabled. To enable it, you need to use the `AC_TOGG` keycode to enable it. The status is stored in persistent memory, so you shouldn't need to enabled it again.\", \"Customizing autocorrect library {#customizing-autocorrect-library}\": {\"Avoiding false triggers {#avoiding-false-triggers}\": \"By default, typos are searched within words, to find typos within longer identifiers like maxFitlerOuput. While this is useful, a consequence is that autocorrection will falsely trigger when a typo happens to be a substring of a correctly-spelled word. For instance, if we had thier -> their as an entry, it would falsely trigger on (correct, though relatively uncommon) words like \\u201cwealthier\\u201d and \\u201cfilthier.\\u201d\\n\\nThe solution is to set a word break : before and/or after the typo to constrain matching. : matches space, period, comma, underscore, digits, and most other non-alpha characters.\\n\\n|Text |thier |:thier |thier: |:thier: |\\n|-----------------|:------:|:------:|:------:|:------:|\\n|see `thier` typo |matches |matches |matches |matches |\\n|it\\u2019s `thiers` |matches |matches |no |no |\\n|wealthier words |matches |no |matches |no |\\n\\n:thier: is most restrictive, matching only when thier is a whole word.\\n\\nThe `qmk generate-autocorrect-data` commands can make an effort to check for entries that would false trigger as substrings of correct words. It searches each typo against a dictionary of 25K English words from the english_words Python package, provided it\\u2019s installed. (run `python3 -m pip install english_words` to install it.)\\n\\n::: tip\\nUnfortunately, this is limited to just english words, at this point.\\n:::\"}, \"Overriding Autocorrect\": {\"Keycodes {#keycodes}\": \"|Keycode |Aliases |Description |\\n|-----------------------|---------|----------------------------------------------|\\n|`QK_AUTOCORRECT_ON` |`AC_ON` |Turns on the Autocorrect feature. |\\n|`QK_AUTOCORRECT_OFF` |`AC_OFF` |Turns off the Autocorrect feature. |\\n|`QK_AUTOCORRECT_TOGGLE`|`AC_TOGG`|Toggles the status of the Autocorrect feature.|\"}, \"User Callback Functions\": {\"Process Autocorrect\": {\"Process Autocorrect Example\": \"If you have a custom keycode `QMKBEST` that should be ignored as part of a word, and another custom keycode `QMKLAYER` that should override autocorrect, both can be added to the bottom of the `process_autocorrect_user` `switch` statement in your source code:\\n\\n```\\nbool process_autocorrect_user(uint16_t *keycode, keyrecord_t *record, uint8_t *typo_buffer_size, uint8_t *mods) {\\n // See quantum_keycodes.h for reference on these matched ranges.\\n switch (*keycode) {\\n // Exclude these keycodes from processing.\\n case KC_LSFT:\\n case KC_RSFT:\\n case KC_CAPS:\\n case QK_TO ... QK_ONE_SHOT_LAYER_MAX:\\n case QK_LAYER_TAP_TOGGLE ... QK_LAYER_MOD_MAX:\\n case QK_ONE_SHOT_MOD ... QK_ONE_SHOT_MOD_MAX:\\n return false;\\n\\n // Mask for base keycode from shifted keys.\\n case QK_LSFT ... QK_LSFT + 255:\\n case QK_RSFT ... QK_RSFT + 255:\\n if (*keycode >= QK_LSFT && *keycode <= (QK_LSFT + 255)) {\\n *mods |= MOD_LSFT;\\n } else {\\n *mods |= MOD_RSFT;\\n }\\n *keycode &= 0xFF; // Get the basic keycode.\\n return true;\\n#ifndef NO_ACTION_TAPPING\\n // Exclude tap-hold keys when they are held down\\n // and mask for base keycode when they are tapped.\\n case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:\\n# ifdef NO_ACTION_LAYER\\n // Exclude Layer Tap, if layers are disabled\\n // but action tapping is still enabled.\\n return false;\\n# endif\\n case QK_MOD_TAP ... QK_MOD_TAP_MAX:\\n // Exclude hold if mods other than Shift is not active\\n if (!record->tap.count) {\\n return false;\\n }\\n *keycode &= 0xFF;\\n break;\\n#else\\n case QK_MOD_TAP ... QK_MOD_TAP_MAX:\\n case QK_LAYER_TAP ... QK_LAYER_TAP_MAX:\\n // Exclude if disabled\\n return false;\\n#endif\\n // Exclude swap hands keys when they are held down\\n // and mask for base keycode when they are tapped.\\n case QK_SWAP_HANDS ... QK_SWAP_HANDS_MAX:\\n#ifdef SWAP_HANDS_ENABLE\\n if (*keycode >= 0x56F0 || !record->tap.count) {\\n return false;\\n }\\n *keycode &= 0xFF;\\n break;\\n#else\\n // Exclude if disabled\\n return false;\\n#endif\\n // Handle custom keycodes\\n case QMKBEST:\\n return false;\\n case QMKLAYER:\\n *typo_buffer_size = 0;\\n return false;\\n }\\n\\n // Disable autocorrect while a mod other than shift is active.\\n if ((*mods & ~MOD_MASK_SHIFT) != 0) {\\n *typo_buffer_size = 0;\\n return false;\\n }\\n\\n return true;\\n}\\n```\\n\\n::: tip\\nIn this callback function, `return false` will skip processing of that keycode for autocorrect. Adding `*typo_buffer_size = 0` will also reset the autocorrect buffer at the same time, cancelling any current letters already stored in the buffer.\\n:::\"}, \"Apply Autocorrect\": {\"Apply Autocorrect Example\": \"This following example will play a sound when a typo is autocorrected and execute the autocorrection itself:\\n\\n```\\n#ifdef AUDIO_ENABLE\\nfloat autocorrect_song[][2] = SONG(TERMINAL_SOUND);\\n#endif\\n\\nbool apply_autocorrect(uint8_t backspaces, const char *str, char *typo, char *correct) {\\n#ifdef AUDIO_ENABLE\\n PLAY_SONG(autocorrect_song);\\n#endif\\n for (uint8_t i = 0; i < backspaces; ++i) {\\n tap_code(KC_BSPC);\\n }\\n send_string_P(str);\\n return false;\\n}\\n```\\n\\n::: tip\\nIn this callback function, `return false` will stop the normal processing of autocorrect, which requires manually handling of removing the \\\"bad\\\" characters and typing the new characters.\\n:::\\n\\n::: warning\\n***IMPORTANT***: `str` is a pointer to `PROGMEM` data for the autocorrection. If you return false, and want to send the string, this needs to use `send_string_P` and not `send_string` nor `SEND_STRING`.\\n:::\\n\\nYou can also use `apply_autocorrect` to detect and display the event but allow internal code to execute the autocorrection with `return true`:\\n\\n```\\nbool apply_autocorrect(uint8_t backspaces, const char *str, char *typo, char *correct) {\\n#ifdef OLED_ENABLE\\n oled_write_P(PSTR(\\\"Auto-corrected\\\"), false);\\n#endif\\n#ifdef CONSOLE_ENABLE\\n printf(\\\"'%s' was corrected to '%s'\\\\n\\\", typo, correct);\\n#endif\\n return true;\\n}\\n```\"}, \"Autocorrect Status\": \"Additional user callback functions to manipulate Autocorrect:\\n\\n| Function | Description |\\n|----------------------------|----------------------------------------------|\\n| `autocorrect_enable()` | Turns Autocorrect on. |\\n| `autocorrect_disable()` | Turns Autocorrect off. |\\n| `autocorrect_toggle()` | Toggles Autocorrect. |\\n| `autocorrect_is_enabled()` | Returns true if Autocorrect is currently on. |\"}, \"Appendix: Trie binary data format {#appendix}\": {\"Encoding {#encoding}\": \"All autocorrection data is stored in a single flat array autocorrect_data. Each trie node is associated with a byte offset into this array, where data for that node is encoded, beginning with root at offset 0. There are three kinds of nodes. The highest two bits of the first byte of the node indicate what kind:\\n\\n['00 \\u21d2 chain node: a trie node with a single child.', '01 \\u21d2 branching node: a trie node with multiple children.', '10 \\u21d2 leaf node: a leaf, corresponding to a typo and storing its correction.']\\n\\n\\n\\n**Branching node**. Each branch is encoded with one byte for the keycode (KC_A\\u2013KC_Z) followed by a link to the child node. Links between nodes are 16-bit byte offsets relative to the beginning of the array, serialized in little endian order.\\n\\nAll branches are serialized this way, one after another, and terminated with a zero byte. As described above, the node is identified as a branch by setting the two high bits of the first byte to 01, done by bitwise ORing the first keycode with 64. keycode. The root node for the above figure would be serialized like:\\n\\n```\\n+-------+-------+-------+-------+-------+-------+-------+\\n| R|64 | node 2 | T | node 3 | 0 |\\n+-------+-------+-------+-------+-------+-------+-------+\\n```\\n\\n**Chain node**. Tries tend to have long chains of single-child nodes, as seen in the example above with f-i-t-l in fitler. So to save space, we use a different format to encode chains than branching nodes. A chain is encoded as a string of keycodes, beginning with the node closest to the root, and terminated with a zero byte. The child of the last node in the chain is encoded immediately after. That child could be either a branching node or a leaf.\\n\\nIn the figure above, the f-i-t-l chain is encoded as\\n\\n```\\n+-------+-------+-------+-------+-------+\\n| L | T | I | F | 0 |\\n+-------+-------+-------+-------+-------+\\n```\\n\\nIf we were to encode this chain using the same format used for branching nodes, we would encode a 16-bit node link with every node, costing 8 more bytes in this example. Across the whole trie, this adds up. Conveniently, we can point to intermediate points in the chain and interpret the bytes in the same way as before. E.g. starting at the i instead of the l, and the subchain has the same format.\\n\\n**Leaf node**. A leaf node corresponds to a particular typo and stores data to correct the typo. The leaf begins with a byte for the number of backspaces to type, and is followed by a null-terminated ASCII string of the replacement text. The idea is, after tapping backspace the indicated number of times, we can simply pass this string to the `send_string_P` function. For fitler, we need to tap backspace 3 times (not 4, because we catch the typo as the final \\u2018r\\u2019 is pressed) and replace it with lter. To identify the node as a leaf, the two high bits are set to 10 by ORing the backspace count with 128:\\n\\n```\\n+-------+-------+-------+-------+-------+-------+\\n| 3|128 | 'l' | 't' | 'e' | 'r' | 0 |\\n+-------+-------+-------+-------+-------+-------+\\n```\", \"Decoding {#decoding}\": \"This format is by design decodable with fairly simple logic. A 16-bit variable state represents our current position in the trie, initialized with 0 to start at the root node. Then, for each keycode, test the highest two bits in the byte at state to identify the kind of node.\\n\\n['00 \\u21d2 **chain node**: If the node\\u2019s byte matches the keycode, increment state by one to go to the next byte. If the next byte is zero, increment again to go to the following node.', '01 \\u21d2 **branching node**: Search the branches for one that matches the keycode, and follow its node link.', '10 \\u21d2 **leaf node**: a typo has been found! We read its first byte for the number of backspaces to type, then pass its following bytes to send_string_P to type the correction.']\"}, \"Credits\": \"Credit goes to [getreuer](https://github.com/getreuer) for originally implementing this [here](https://getreuer.info/posts/keyboards/autocorrection/#how-does-it-work). As well as to [filterpaper](https://github.com/filterpaper) for converting the code to use PROGMEM, and additional improvements.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 2]\"}, {\"title\": \"Backlighting {#backlighting}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Most keyboards have backlighting enabled by default if they support it, but if it is not working for you (or you have added support), check that your `rules.mk` includes the following:\\n\\n```\\nBACKLIGHT_ENABLE = yes\\n```\", \"Keycodes {#keycodes}\": \"|Key |Aliases |Description |\\n|-------------------------------|---------|-----------------------------------|\\n|`QK_BACKLIGHT_TOGGLE` |`BL_TOGG`|Turn the backlight on or off |\\n|`QK_BACKLIGHT_STEP` |`BL_STEP`|Cycle through backlight levels |\\n|`QK_BACKLIGHT_ON` |`BL_ON` |Set the backlight to max brightness|\\n|`QK_BACKLIGHT_OFF` |`BL_OFF` |Turn the backlight off |\\n|`QK_BACKLIGHT_UP` |`BL_UP` |Increase the backlight level |\\n|`QK_BACKLIGHT_DOWN` |`BL_DOWN`|Decrease the backlight level |\\n|`QK_BACKLIGHT_TOGGLE_BREATHING`|`BL_BRTG`|Toggle backlight breathing |\", \"Basic Configuration {#basic-configuration}\": {\"\\\"On\\\" State {#on-state}\": \"Most backlight circuits are driven by an N-channel MOSFET or NPN transistor. This means that to turn the transistor *on* and light the LEDs, you must drive the backlight pin, connected to the gate or base, *high*.\\nSometimes, however, a P-channel MOSFET, or a PNP transistor is used. In this case, when the transistor is on, the pin is driven *low* instead.\\n\\nTo configure the \\\"on\\\" state of the backlight circuit, add the following to your `config.h`:\\n\\n```\\n#define BACKLIGHT_ON_STATE 0\\n```\", \"Multiple Backlight Pins {#multiple-backlight-pins}\": \"Most keyboards have only one backlight pin which controls all backlight LEDs (especially if the backlight is connected to a hardware PWM pin).\\nThe `timer` and `software` drivers allow you to define multiple backlight pins, which will be turned on and off at the same time during the PWM duty cycle.\\n\\nThis feature allows to set, for instance, the Caps Lock LED's (or any other controllable LED) brightness at the same level as the other LEDs of the backlight. This is useful if you have mapped Control in place of Caps Lock and you need the Caps Lock LED to be part of the backlight instead of being activated when Caps Lock is on, as it is usually wired to a separate pin from the backlight.\\n\\nTo configure multiple backlight pins, add something like this to your `config.h`, instead of `BACKLIGHT_PIN`:\\n\\n```\\n#define BACKLIGHT_PINS { F5, B2 }\\n```\"}, \"Driver Configuration {#driver-configuration}\": {\"PWM Driver {#pwm-driver}\": \"This is the default backlight driver, which leverages the hardware PWM output capability of the microcontroller.\\n\\n```\\nBACKLIGHT_DRIVER = pwm\\n```\", \"Timer Driver {#timer-driver}\": \"This driver is similar to the PWM driver, but instead of directly configuring the pin to output a PWM signal, an interrupt handler is attached to the timer to turn the pin on and off as appropriate.\\n\\n```\\nBACKLIGHT_DRIVER = timer\\n```\", \"Software Driver {#software-driver}\": \"In this mode, PWM is \\\"emulated\\\" while running other keyboard tasks. It offers maximum hardware compatibility without extra platform configuration. However, breathing is not supported, and the backlight can flicker when the keyboard is busy.\\n\\n```\\nBACKLIGHT_DRIVER = software\\n```\", \"Custom Driver {#custom-driver}\": \"If none of the above drivers apply to your board (for example, you are using a separate IC to control the backlight), you can implement a custom backlight driver using a simple API.\\n\\n```\\nBACKLIGHT_DRIVER = custom\\n```\\n\\n```\\nvoid backlight_init_ports(void) {\\n // Optional - runs on startup\\n // Usually you want to configure pins here\\n}\\nvoid backlight_set(uint8_t level) {\\n // Optional - runs on level change\\n // Usually you want to respond to the new value\\n}\\n\\nvoid backlight_task(void) {\\n // Optional - runs periodically\\n // Note that this is called in the main keyboard loop,\\n // so long running actions here can cause performance issues\\n}\\n```\"}, \"AVR Configuration {#avr-configuration}\": {\"PWM Driver {#avr-pwm-driver}\": \"The following table describes the supported pins for the PWM driver. Only cells marked with a timer number are capable of hardware PWM output; any others must use the `timer` driver.\\n\\n|Backlight Pin|AT90USB64/128|AT90USB162|ATmega16/32U4|ATmega16/32U2|ATmega32A|ATmega328/P|\\n|-------------|-------------|----------|-------------|-------------|---------|-----------|\\n|`B1` | | | | | |Timer 1 |\\n|`B2` | | | | | |Timer 1 |\\n|`B5` |Timer 1 | |Timer 1 | | | |\\n|`B6` |Timer 1 | |Timer 1 | | | |\\n|`B7` |Timer 1 |Timer 1 |Timer 1 |Timer 1 | | |\\n|`C4` |Timer 3 | | | | | |\\n|`C5` |Timer 3 |Timer 1 | |Timer 1 | | |\\n|`C6` |Timer 3 |Timer 1 |Timer 3 |Timer 1 | | |\\n|`D4` | | | | |Timer 1 | |\\n|`D5` | | | | |Timer 1 | |\", \"Timer Driver {#avr-timer-driver}\": \"Any GPIO pin can be used with this driver. The following table describes the supported timers:\\n\\n|AT90USB64/128|AT90USB162|ATmega16/32U4|ATmega16/32U2|ATmega32A|ATmega328/P|\\n|-------------|----------|-------------|-------------|---------|-----------|\\n|Timers 1 & 3 |Timer 1 |Timers 1 & 3 |Timer 1 |Timer 1 |Timer 1 |\\n\\nThe following `#define`s apply only to the `timer` driver:\\n\\n|Define |Default|Description |\\n|-----------------------|-------|----------------|\\n|`BACKLIGHT_PWM_TIMER` |`1` |The timer to use|\\n\\nNote that the choice of timer may conflict with the [Audio](audio) feature.\"}, \"ChibiOS/ARM Configuration {#arm-configuration}\": {\"PWM Driver {#arm-pwm-driver}\": \"Depending on the ChibiOS board configuration, you may need to enable PWM at the keyboard level. For STM32, this would look like:\\n\\n::: code-group\\n\\n```\\n#pragma once\\n\\n#define HAL_USE_PWM TRUE // [!code focus]\\n\\n#include_next <halconf.h>\\n```\\n\\n```\\n#pragma once\\n\\n#include_next <mcuconf.h>\\n\\n#undef STM32_PWM_USE_TIM4 // [!code focus]\\n#define STM32_PWM_USE_TIM4 TRUE // [!code focus]\\n```\\n\\n:::\\n\\nThe following `#define`s apply only to the `pwm` driver:\\n\\n|Define |Default |Description |\\n|-----------------------|-------------|---------------------------------------------------------------|\\n|`BACKLIGHT_PWM_DRIVER` |`PWMD4` |The PWM driver to use |\\n|`BACKLIGHT_PWM_CHANNEL`|`3` |The PWM channel to use |\\n|`BACKLIGHT_PAL_MODE` |`2` |The pin alternative function to use |\\n|`BACKLIGHT_PWM_PERIOD` |*Not defined*|The PWM period in counter ticks - Default is platform dependent|\\n\\nRefer to the ST datasheet for your particular MCU to determine these values. For example, these defaults are set up for pin `B8` on a Proton-C (STM32F303) using `TIM4_CH3` on AF2. Unless you are designing your own keyboard, you generally should not need to change them.\", \"Timer Driver {#arm-timer-driver}\": \"Depending on the ChibiOS board configuration, you may need to enable general-purpose timers at the keyboard level. For STM32, this would look like:\\n\\n::: code-group\\n\\n```\\n#pragma once\\n\\n#define HAL_USE_GPT TRUE // [!code focus]\\n\\n#include_next <halconf.h>\\n```\\n\\n```\\n#pragma once\\n\\n#include_next <mcuconf.h>\\n\\n#undef STM32_GPT_USE_TIM15 // [!code focus]\\n#define STM32_GPT_USE_TIM15 TRUE // [!code focus]\\n```\\n\\n:::\\n\\nThe following `#define`s apply only to the `timer` driver:\\n\\n|Define |Default |Description |\\n|----------------------|--------|----------------|\\n|`BACKLIGHT_GPT_DRIVER`|`GPTD15`|The timer to use|\"}, \"Example Schematic\": \"Since the MCU can only supply so much current to its GPIO pins, instead of powering the backlight directly from the MCU, the backlight pin is connected to a transistor or MOSFET that switches the power to the LEDs.\\n\\nIn this typical example, the backlight LEDs are all connected in parallel towards an N-channel MOSFET. Its gate pin is wired to one of the microcontroller's GPIO pins through a 470\\u2126 resistor to avoid ringing.\\nA pulldown resistor is also placed between the gate pin and ground to keep it at a defined state when it is not otherwise being driven by the MCU.\\nThe values of these resistors are not critical - see [this Electronics StackExchange question](https://electronics.stackexchange.com/q/68748) for more information.\\n\\n\", \"API {#api}\": {\"`void backlight_toggle(void)` {#api-backlight-toggle}\": \"Toggle the backlight on or off.\\n\\n[]\", \"`void backlight_enable(void)` {#api-backlight-enable}\": \"Turn the backlight on.\\n\\n[]\", \"`void backlight_disable(void)` {#api-backlight-disable}\": \"Turn the backlight off.\\n\\n[]\", \"`void backlight_step(void)` {#api-backlight-step}\": \"Cycle through backlight levels.\\n\\n[]\", \"`void backlight_increase(void)` {#api-backlight-increase}\": \"Increase the backlight level.\\n\\n[]\", \"`void backlight_decrease(void)` {#api-backlight-decrease}\": \"Decrease the backlight level.\\n\\n[]\", \"`void backlight_level(uint8_t level)` {#api-backlight-level}\": {\"Arguments {#api-backlight-level-arguments}\": [\"`uint8_t level` \\nThe level to set, from 0 to `BACKLIGHT_LEVELS`.\"]}, \"`uint8_t get_backlight_level(void)` {#api-get-backlight-level}\": {\"Return Value {#api-get-backlight-level-return}\": \"The current backlight level, from 0 to `BACKLIGHT_LEVELS`.\\n\\n[]\"}, \"`bool is_backlight_enabled(void)` {#api-is-backlight-enabled}\": {\"Return Value {#api-is-backlight-enabled-return}\": \"`true` if the backlight is enabled.\\n\\n[]\"}, \"`void backlight_toggle_breathing(void)` {#api-backlight-toggle-breathing}\": \"Toggle backlight breathing on or off.\\n\\n[]\", \"`void backlight_enable_breathing(void)` {#api-backlight-enable-breathing}\": \"Turn backlight breathing on.\\n\\n[]\", \"`void backlight_disable_breathing(void)` {#api-backlight-disable-breathing}\": \"Turn backlight breathing off.\\n\\n[]\", \"`bool is_backlight_breathing(void)` {#api-is-backlight-breathing}\": {\"Return Value {#api-is-backlight-breathing-return}\": \"`true` if backlight breathing is enabled.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 3]\"}, {\"title\": \"Bootmagic {#bootmagic}\", \"description\": null, \"content\": {\"Split Keyboards\": \"When [handedness](split_keyboard#setting-handedness) is predetermined via options like `SPLIT_HAND_PIN` or `EE_HANDS`, you might need to configure a different key between halves. To identify the correct key for the right half, examine the split key matrix defined in the `<keyboard>.h` file, e.g.:\\n\\n```\\n#define LAYOUT_split_3x5_2( \\\\\\n L01, L02, L03, L04, L05, R01, R02, R03, R04, R05, \\\\\\n L06, L07, L08, L09, L10, R06, R07, R08, R09, R10, \\\\\\n L11, L12, L13, L14, L15, R11, R12, R13, R14, R15, \\\\\\n L16, L17, R16, R17 \\\\\\n ) \\\\\\n { \\\\\\n { L01, L02, L03, L04, L05 }, \\\\\\n { L06, L07, L08, L09, L10 }, \\\\\\n { L11, L12, L13, L14, L15 }, \\\\\\n { L16, L17, KC_NO, KC_NO, KC_NO }, \\\\\\n { R01, R02, R03, R04, R05 }, \\\\\\n { R06, R07, R08, R09, R10 }, \\\\\\n { R11, R12, R13, R14, R15 }, \\\\\\n { R16, R17, KC_NO, KC_NO, KC_NO } \\\\\\n }\\n```\\n\\nIf you pick the top right key for the right half, it is `R05` on the top layout. Within the key matrix below, `R05` is located on row 4 columnn 4. To use that key as the right half's Bootmagic trigger, add these entries to your `config.h` file:\\n\\n```\\n#define BOOTMAGIC_ROW_RIGHT 4\\n#define BOOTMAGIC_COLUMN_RIGHT 4\\n```\\n\\n::: tip\\nThese values are not set by default.\\n:::\", \"Advanced Bootmagic\": \"The `bootmagic_scan` function is defined weakly, so that you can replace this in your code, if you need. A great example of this is the Zeal60 boards that have some additional handling needed.\\n\\nTo replace the function, all you need to do is add something like this to your code:\\n\\n```\\nvoid bootmagic_scan(void) {\\n matrix_scan();\\n wait_ms(DEBOUNCE * 2);\\n matrix_scan();\\n\\n if (matrix_get_row(BOOTMAGIC_ROW) & (1 << BOOTMAGIC_COLUMN)) {\\n // Jump to bootloader.\\n bootloader_jump();\\n }\\n}\\n```\\n\\nYou can define additional logic here. For instance, resetting the EEPROM or requiring additional keys to be pressed to trigger Bootmagic. Keep in mind that `bootmagic_scan` is called before a majority of features are initialized in the firmware.\", \"Addenda\": \"To manipulate settings that were formerly configured through the now-deprecated full Bootmagic feature, see [Magic Keycodes](../keycodes_magic).\\n\\nThe Command feature, formerly known as Magic, also allows you to control different aspects of your keyboard. While it shares some functionality with Magic Keycodes, it also allows you to do things that Magic Keycodes cannot, such as printing version information to the console. For more information, see [Command](command).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 4]\"}, {\"title\": \"Caps Word\", \"description\": null, \"content\": {\"How do I enable Caps Word {#how-do-i-enable-caps-word}\": {\"Troubleshooting: Command {#troubleshooting-command}\": \"When using `BOTH_SHIFTS_TURNS_ON_CAPS_WORD`, you might see a compile message\\n**\\\"BOTH_SHIFTS_TURNS_ON_CAPS_WORD and Command should not be enabled at the same\\ntime, since both use the Left Shift + Right Shift key combination.\\\"**\\n\\nMany keyboards enable the [Command feature](command), which by\\ndefault is also activated using the Left Shift + Right Shift key combination. To\\nfix this conflict, please disable Command by adding in rules.mk:\\n\\n```\\nCOMMAND_ENABLE = no\\n```\\n\\nOr configure Command to use another key combination like Left Ctrl + Right Ctrl\\nby defining `IS_COMMAND()` in config.h:\\n\\n```\\n// Activate Command with Left Ctrl + Right Ctrl.\\n#define IS_COMMAND() (get_mods() == MOD_MASK_CTRL)\\n```\"}, \"Customizing Caps Word {#customizing-caps-word}\": {\"Invert on shift {#invert-on-shift}\": \"By default, Caps Word turns off when Shift keys are pressed, considering them as\\nword-breaking. Alternatively with the `CAPS_WORD_INVERT_ON_SHIFT` option,\\npressing the Shift key continues Caps Word and inverts the shift state. This\\nis convenient for uncapitalizing one or a few letters within a word, for\\nexample with Caps Word on, typing \\\"D, B, Shift+A, Shift+A, S\\\" produces \\\"DBaaS\\\",\\nor typing \\\"P, D, F, Shift+S\\\" produces \\\"PDFs\\\".\\n\\nEnable it by adding in config.h\\n\\n```\\n#define CAPS_WORD_INVERT_ON_SHIFT\\n```\\n\\nThis option works with regular Shift keys `KC_LSFT` and `KC_RSFT`, mod-tap Shift\\nkeys, and one-shot Shift keys. Note that while Caps Word is on, one-shot Shift\\nkeys behave like regular Shift keys, and have effect only while they are held.\", \"Idle timeout {#idle-timeout}\": \"Caps Word turns off automatically if no keys are pressed for\\n`CAPS_WORD_IDLE_TIMEOUT` milliseconds. The default is 5000 (5 seconds).\\nConfigure the timeout duration in config.h, for instance\\n\\n```\\n#define CAPS_WORD_IDLE_TIMEOUT 3000 // 3 seconds.\\n```\\n\\nSetting `CAPS_WORD_IDLE_TIMEOUT` to 0 configures Caps Word to never time out.\\nCaps Word then remains active indefinitely until a word breaking key is pressed.\", \"Functions {#functions}\": \"Functions to manipulate Caps Word:\\n\\n| Function | Description |\\n|-------------------------|------------------------------------------------|\\n| `caps_word_on()` | Turns Caps Word on. |\\n| `caps_word_off()` | Turns Caps Word off. |\\n| `caps_word_toggle()` | Toggles Caps Word. |\\n| `is_caps_word_on()` | Returns true if Caps Word is currently on. |\", \"Configure which keys are \\\"word breaking\\\" {#configure-which-keys-are-word-breaking}\": \"You can define the `caps_word_press_user(uint16_t keycode)` callback to\\nconfigure which keys should be shifted and which keys are considered \\\"word\\nbreaking\\\" and stop Caps Word.\\n\\nThe callback is called on every key press while Caps Word is active. When the\\nkey should be shifted (that is, a letter key), the callback should call\\n`add_weak_mods(MOD_BIT(KC_LSFT))` to shift the key. Returning true continues the\\ncurrent \\\"word,\\\" while returning false is \\\"word breaking\\\" and deactivates Caps\\nWord. The default callback is\\n\\n```\\nbool caps_word_press_user(uint16_t keycode) {\\n switch (keycode) {\\n // Keycodes that continue Caps Word, with shift applied.\\n case KC_A ... KC_Z:\\n case KC_MINS:\\n add_weak_mods(MOD_BIT(KC_LSFT)); // Apply shift to next key.\\n return true;\\n\\n // Keycodes that continue Caps Word, without shifting.\\n case KC_1 ... KC_0:\\n case KC_BSPC:\\n case KC_DEL:\\n case KC_UNDS:\\n return true;\\n\\n default:\\n return false; // Deactivate Caps Word.\\n }\\n}\\n```\", \"Representing Caps Word state {#representing-caps-word-state}\": \"Define `caps_word_set_user(bool active)` to get callbacks when Caps Word turns\\non or off. This is useful to represent the current Caps Word state, e.g. by\\nsetting an LED or playing a sound. In your keymap, define\\n\\n```\\nvoid caps_word_set_user(bool active) {\\n if (active) {\\n // Do something when Caps Word activates.\\n } else {\\n // Do something when Caps Word deactivates.\\n }\\n}\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 5]\"}, {\"title\": \"Combos\", \"description\": null, \"content\": {\"Advanced Keycodes Support\": \"Advanced keycodes, such as [Mod-Tap](../mod_tap) and [Tap Dance](tap_dance) are also supported together with combos. If you use these advanced keycodes in your keymap, you will need to place the full keycode in the combo definition, e.g.:\\n\\n```\\nconst uint16_t PROGMEM test_combo1[] = {LSFT_T(KC_A), LT(1, KC_B), COMBO_END};\\nconst uint16_t PROGMEM test_combo2[] = {TD(TD_ESC_CAPS), KC_F1, COMBO_END};\\n```\", \"Overlapping Combos\": \"It is possible to overlap combos. Before, with the example below both combos would activate when all three keys were pressed. Now only the three key combo will activate.\\n\\n```\\nconst uint16_t PROGMEM test_combo1[] = {LSFT_T(KC_A), LT(1, KC_B), COMBO_END};\\nconst uint16_t PROGMEM test_combo2[] = {LSFT_T(KC_A), LT(1, KC_B), KC_C, COMBO_END};\\ncombo_t key_combos[] = {\\n COMBO(test_combo1, KC_ESC)\\n COMBO(test_combo2, KC_TAB)\\n};\\n```\", \"Examples\": \"A long list of combos can be defined in an `enum` list:\\n\\n```\\nenum combos {\\n AB_ESC,\\n JK_TAB,\\n QW_SFT,\\n SD_LAYER\\n};\\n\\nconst uint16_t PROGMEM ab_combo[] = {KC_A, KC_B, COMBO_END};\\nconst uint16_t PROGMEM jk_combo[] = {KC_J, KC_K, COMBO_END};\\nconst uint16_t PROGMEM qw_combo[] = {KC_Q, KC_W, COMBO_END};\\nconst uint16_t PROGMEM sd_combo[] = {KC_S, KC_D, COMBO_END};\\n\\ncombo_t key_combos[] = {\\n [AB_ESC] = COMBO(ab_combo, KC_ESC),\\n [JK_TAB] = COMBO(jk_combo, KC_TAB),\\n [QW_SFT] = COMBO(qw_combo, KC_LSFT),\\n [SD_LAYER] = COMBO(sd_combo, MO(_LAYER)),\\n};\\n```\\n\\nFor a more complicated implementation, you can use the `process_combo_event` function to add custom handling.\\n\\n```\\nenum combo_events {\\n EM_EMAIL,\\n BSPC_LSFT_CLEAR,\\n};\\n\\nconst uint16_t PROGMEM email_combo[] = {KC_E, KC_M, COMBO_END};\\nconst uint16_t PROGMEM clear_line_combo[] = {KC_BSPC, KC_LSFT, COMBO_END};\\n\\ncombo_t key_combos[] = {\\n [EM_EMAIL] = COMBO_ACTION(email_combo),\\n [BSPC_LSFT_CLEAR] = COMBO_ACTION(clear_line_combo),\\n};\\n/* COMBO_ACTION(x) is same as COMBO(x, KC_NO) */\\n\\nvoid process_combo_event(uint16_t combo_index, bool pressed) {\\n switch(combo_index) {\\n case EM_EMAIL:\\n if (pressed) {\\n SEND_STRING(\\\"john.doe@example.com\\\");\\n }\\n break;\\n case BSPC_LSFT_CLEAR:\\n if (pressed) {\\n tap_code16(KC_END);\\n tap_code16(S(KC_HOME));\\n tap_code16(KC_BSPC);\\n }\\n break;\\n }\\n}\\n```\\n\\nThis will send \\\"john.doe@example.com\\\" if you chord E and M together, and clear the current line with Backspace and Left-Shift. You could change this to do stuff like play sounds or change settings.\\n\\nIt is worth noting that `COMBO_ACTION`s are not needed anymore. As of [PR#8591](https://github.com/qmk/qmk_firmware/pull/8591/), it is possible to run your own custom keycodes from combos. Just define the custom keycode, program its functionality in `process_record_user`, and define a combo with `COMBO(<key_array>, <your_custom_keycode>)`. See the first example in [Macros](../feature_macros).\", \"Keycodes\": \"You can enable, disable and toggle the Combo feature on the fly. This is useful if you need to disable them temporarily, such as for a game. The following keycodes are available for use in your `keymap.c`\\n\\n|Keycode |Aliases |Description |\\n|-----------------|---------|--------------------------------|\\n|`QK_COMBO_ON` |`CM_ON` |Turns on Combo feature |\\n|`QK_COMBO_OFF` |`CM_OFF` |Turns off Combo feature |\\n|`QK_COMBO_TOGGLE`|`CM_TOGG`|Toggles Combo feature on and off|\", \"Advanced Configuration\": {\"Combo Term\": \"By default, the timeout for the Combos to be recognized is set to 50ms. This can be changed if accidental combo misfires are happening or if you're having difficulties pressing keys at the same time. For instance, `#define COMBO_TERM 40` would set the timeout period for combos to 40ms.\", \"Buffer and state sizes\": \"If you're using long combos, or you have a lot of overlapping combos, you may run into issues with this, as the buffers may not be large enough to accommodate what you're doing. In this case, you can configure the sizes of the buffers used. Be aware, larger combo sizes and larger buffers will increase memory usage!\\n\\nTo configure the amount of keys a combo can be composed of, change the following:\\n\\n| Keys | Define to be set |\\n|------|-----------------------------------|\\n| 6 | `#define EXTRA_SHORT_COMBOS` |\\n| 8 | QMK Default |\\n| 16 | `#define EXTRA_LONG_COMBOS` |\\n| 32 | `#define EXTRA_EXTRA_LONG_COMBOS` |\\n\\nDefining `EXTRA_SHORT_COMBOS` combines a combo's internal state into just one byte. This can, in some cases, save some memory. If it doesn't, no point using it. If you do, you also have to make sure you don't define combos with more than 6 keys.\\n\\nProcessing combos has two buffers, one for the key presses, another for the combos being activated. Use the following options to configure the sizes of these buffers:\\n\\n| Define | Default |\\n|-------------------------------------|------------------------------------------------------|\\n| `#define COMBO_KEY_BUFFER_LENGTH 8` | 8 (the key amount `(EXTRA_)EXTRA_LONG_COMBOS` gives) |\\n| `#define COMBO_BUFFER_LENGTH 4` | 4 |\", \"Modifier Combos\": \"If a combo resolves to a Modifier, the window for processing the combo can be extended independently from normal combos. By default, this is disabled but can be enabled with `#define COMBO_MUST_HOLD_MODS`, and the time window can be configured with `#define COMBO_HOLD_TERM 150` (default: `TAPPING_TERM`). With `COMBO_MUST_HOLD_MODS`, you cannot tap the combo any more which makes the combo less prone to misfires.\", \"Strict key press order\": \"By defining `COMBO_MUST_PRESS_IN_ORDER` combos only activate when the keys are pressed in the same order as they are defined in the key array.\", \"Per Combo Timing, Holding, Tapping and Key Press Order\": \"For each combo, it is possible to configure the time window it has to pressed in, if it needs to be held down, if it needs to be tapped, or if its keys need to be pressed in order.\\n\\nFor example, tap-only combos are useful if any (or all) of the underlying keys are mod-tap or layer-tap keys. When you tap the combo, you get the combo result. When you press the combo and hold it down, the combo doesn't activate. Instead the keys are processed separately as if the combo wasn't even there.\\n\\nIn order to use these features, the following configuration options and functions need to be defined. Coming up with useful timings and configuration is left as an exercise for the reader.\\n\\n| Config Flag | Function | Description |\\n|-----------------------------|-----------------------------------------------------------|--------------------------------------------------------------------------------------------------------|\\n| `COMBO_TERM_PER_COMBO` | `uint16_t get_combo_term(uint16_t combo_index, combo_t *combo)` | Optional per-combo timeout window. (default: `COMBO_TERM`) |\\n| `COMBO_MUST_HOLD_PER_COMBO` | `bool get_combo_must_hold(uint16_t combo_index, combo_t *combo)` | Controls if a given combo should fire immediately on tap or if it needs to be held. (default: `false`) |\\n| `COMBO_MUST_TAP_PER_COMBO` | `bool get_combo_must_tap(uint16_t combo_index, combo_t *combo)` | Controls if a given combo should fire only if tapped within `COMBO_HOLD_TERM`. (default: `false`) |\\n| `COMBO_MUST_PRESS_IN_ORDER_PER_COMBO` | `bool get_combo_must_press_in_order(uint16_t combo_index, combo_t *combo)` | Controls if a given combo should fire only if its keys are pressed in order. (default: `true`) |\\n\\nExamples:\\n\\n```\\n#ifdef COMBO_TERM_PER_COMBO\\nuint16_t get_combo_term(uint16_t combo_index, combo_t *combo) {\\n // decide by combo->keycode\\n switch (combo->keycode) {\\n case KC_X:\\n return 50;\\n }\\n\\n // or with combo index, i.e. its name from enum.\\n switch (combo_index) {\\n case COMBO_NAME_HERE:\\n return 9001;\\n }\\n\\n // And if you're feeling adventurous, you can even decide by the keys in the chord,\\n // i.e. the exact array of keys you defined for the combo.\\n // This can be useful if your combos have a common key and you want to apply the\\n // same combo term for all of them.\\n if (combo->keys[0] == KC_ENT) { // if first key in the array is Enter\\n return 150;\\n }\\n\\n return COMBO_TERM;\\n}\\n#endif\\n\\n#ifdef COMBO_MUST_HOLD_PER_COMBO\\nbool get_combo_must_hold(uint16_t combo_index, combo_t *combo) {\\n // Same as above, decide by keycode, the combo index, or by the keys in the chord.\\n\\n if (KEYCODE_IS_MOD(combo->keycode) || \\n (combo->keycode >= QK_MOMENTARY && combo->keycode <= QK_MOMENTARY_MAX) // MO(kc) keycodes\\n ) {\\n return true;\\n }\\n\\n switch (combo_index) {\\n case COMBO_NAME_HERE:\\n return true;\\n }\\n\\n return false;\\n}\\n#endif\\n\\n#ifdef COMBO_MUST_TAP_PER_COMBO\\nbool get_combo_must_tap(uint16_t combo_index, combo_t *combo) {\\n // If you want all combos to be tap-only, just uncomment the next line\\n // return true\\n\\n // If you want *all* combos, that have Mod-Tap/Layer-Tap/Momentary keys in its chord, to be tap-only, this is for you:\\n uint16_t key;\\n uint8_t idx = 0;\\n while ((key = pgm_read_word(&combo->keys[idx])) != COMBO_END) {\\n switch (key) {\\n case QK_MOD_TAP...QK_MOD_TAP_MAX:\\n case QK_LAYER_TAP...QK_LAYER_TAP_MAX:\\n case QK_MOMENTARY...QK_MOMENTARY_MAX:\\n return true;\\n }\\n idx += 1;\\n }\\n return false;\\n\\n}\\n#endif\\n\\n#ifdef COMBO_MUST_PRESS_IN_ORDER_PER_COMBO\\nbool get_combo_must_press_in_order(uint16_t combo_index, combo_t *combo) {\\n switch (combo_index) {\\n /* List combos here that you want to only activate if their keys\\n * are pressed in the same order as they are defined in the combo's key\\n * array. */\\n case COMBO_NAME_HERE:\\n return true;\\n default:\\n return false;\\n }\\n}\\n#endif\\n```\", \"Generic hook to (dis)allow a combo activation\": \"By defining `COMBO_SHOULD_TRIGGER` and its companying function `bool combo_should_trigger(uint16_t combo_index, combo_t *combo, uint16_t keycode, keyrecord_t *record)` you can block or allow combos to activate on the conditions of your choice.\\nFor example, you could disallow some combos on the base layer and allow them on another. Or disable combos on the home row when a timer is running.\\n\\nExamples:\\n\\n```\\nbool combo_should_trigger(uint16_t combo_index, combo_t *combo, uint16_t keycode, keyrecord_t *record) {\\n /* Disable combo `SOME_COMBO` on layer `_LAYER_A` */\\n switch (combo_index) {\\n case SOME_COMBO:\\n if (layer_state_is(_LAYER_A)) {\\n return false;\\n }\\n }\\n\\n return true;\\n}\\n```\", \"Combo timer\": {\"`#define COMBO_STRICT_TIMER`\": \"With `COMBO_STRICT_TIMER`, the timer is started only on the first key press.\\nInputting combos is now less relaxed; you need to make sure the full chord is pressed within the `COMBO_TERM`.\\nMisfires are less common but if you type multiple combos fast, there is a\\nchance that the latter ones might not activate properly.\", \"`#define COMBO_NO_TIMER`\": \"By defining `COMBO_NO_TIMER`, the timer is disabled completely and combos are activated on the first key release.\\nThis also disables the \\\"must hold\\\" functionalities as they just wouldn't work at all.\"}, \"Customizable key releases\": \"By defining `COMBO_PROCESS_KEY_RELEASE` and implementing the function `bool process_combo_key_release(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode)`, you can run your custom code on each key release after a combo was activated. For example you could change the RGB colors, activate haptics, or alter the modifiers.\\n\\nYou can also release a combo early by returning `true` from the function.\\n\\nHere's an example where a combo resolves to two modifiers, and on key releases the modifiers are unregistered one by one, depending on which key was released.\\n\\n```\\nenum combos {\\n AB_MODS\\n};\\n\\nconst uint16_t PROGMEM ab_combo[] = {KC_A, KC_B, COMBO_END};\\n\\ncombo_t key_combos[] = {\\n [AB_MODS] = COMBO(ab_combo, LCTL(KC_LSFT)),\\n};\\n\\nbool process_combo_key_release(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode) {\\n switch (combo_index) {\\n case AB_MODS:\\n switch(keycode) {\\n case KC_A:\\n unregister_mods(MOD_MASK_CTRL);\\n break;\\n case KC_B:\\n unregister_mods(MOD_MASK_SHIFT);\\n break;\\n }\\n return false; // do not release combo\\n }\\n return false;\\n}\\n```\", \"Customizable key repress\": \"By defining `COMBO_PROCESS_KEY_REPRESS` and implementing `bool process_combo_key_repress(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode)` you can run your custom code when you repress just released key of a combo. By combining it with custom `process_combo_event` we can for example make special handling for Alt+Tab to switch windows, which, on combo F+G activation, registers Alt and presses Tab - then we can switch windows forward by releasing G and pressing it again, or backwards with F key. Here's the full example:\\n\\n```\\nenum combos {\\n CMB_ALTTAB\\n};\\n\\nconst uint16_t PROGMEM combo_alttab[] = {KC_F, KC_G, COMBO_END};\\n\\ncombo_t key_combos[COMBO_LENGTH] = {\\n [CMB_ALTTAB] = COMBO(combo_alttab, KC_NO), // KC_NO to leave processing for process_combo_event\\n};\\n\\nvoid process_combo_event(uint16_t combo_index, bool pressed) {\\n switch (combo_index) {\\n case CMB_ALTTAB:\\n if (pressed) {\\n register_mods(MOD_LALT);\\n tap_code(KC_TAB);\\n } else {\\n unregister_mods(MOD_LALT);\\n }\\n break;\\n }\\n}\\n\\nbool process_combo_key_repress(uint16_t combo_index, combo_t *combo, uint8_t key_index, uint16_t keycode) {\\n switch (combo_index) {\\n case CMB_ALTTAB:\\n switch (keycode) {\\n case KC_F:\\n tap_code16(S(KC_TAB));\\n return true;\\n case KC_G:\\n tap_code(KC_TAB);\\n return true;\\n }\\n }\\n return false;\\n}\\n```\", \"Layer independent combos\": {\"Combo reference layers by layer.\": \"If not using `COMBO_ONLY_FROM_LAYER` it is possible to specify a\\ncombo reference layer for any layer using the `combo_ref_from_layer` hook. \\nThe combo macros automatically create this function from the `COMBO_REF_LAYER()`\\nentries given.\\n\\nThis function returns the assigned reference layer for the current layer.\\nif there is no match, it returns the default reference layer if set, \\nor the current layer otherwise. A default layer can be set with\\n`DEFAULT_REF_LAYER(_MY_COMBO_REF_LAYER)`\\n\\nIf not set, the default reference layer selection from the automatically generated \\n`combo-ref-from-layer()` will be the current layer.\\n\\nThe following `combo_ref_from_layer` function \\nwill give a reference layer of _QWERTY for the _DVORAK layer and\\nwill give the _NAV layer as a reference to it's self. All other layers\\nwill have the default for their combo reference layer. If the default\\nis not set, all other layers will reference themselves.\\n\\n```\\n#define COMBO_REF_DEFAULT _MY_COMBO_LAYER\\n\\nuint8_t combo_ref_from_layer(uint8_t layer){\\n switch (get_highest_layer(layer_state)){\\n case _DVORAK: return _QWERTY;\\n case _NAV: return _NAV;\\n default: return _MY_COMBO_LAYER;\\n }\\n return layer; // important if default is not in case.\\n}\\n```\\n\\nThe equivalent definition using the combo macros is this:\\n\\n```\\nCOMBO_REF_LAYER(_DVORAK, _QWERTY)\\nCOMBO_REF_LAYER(_NAV, _NAV)\\nDEFAULT_REF_LAYER(_MY_COMBO_LAYER).\\n```\"}}, \"User callbacks\": \"In addition to the keycodes, there are a few functions that you can use to set the status, or check it:\\n\\n|Function |Description |\\n|-----------|--------------------------------------------------------------------|\\n| `combo_enable()` | Enables the combo feature |\\n| `combo_disable()` | Disables the combo feature, and clears the combo buffer |\\n| `combo_toggle()` | Toggles the state of the combo feature |\\n| `is_combo_enabled()` | Returns the status of the combo feature state (true or false) |\", \"Dictionary Management\": \"Having 3 places to update when adding new combos or altering old ones does become cumbersome when you have a lot of combos. We can alleviate this with some magic! ... If you consider C macros magic.\\nFirst, you need to add `VPATH += keyboards/gboards` to your `rules.mk`. Next, include the file `g/keymap_combo.h` in your `keymap.c`.\\n\\n::: warning\\nThis functionality uses the same `process_combo_event` function as `COMBO_ACTION` macros do, so you cannot use the function yourself in your keymap. Instead, you have to define the `case`s of the `switch` statement by themselves within `inject.h`, which `g/keymap_combo.h` will then include into the function.\\n:::\\n\\nThen, write your combos in `combos.def` file in the following manner:\\n\\n```\\n// Alternate reference layers by layer\\n// Layer Reference layer\\nCOMBO_REF_LAYER(_DVORAK, _QWERTY) // reference the qwerty layer for dvorak.\\nCOMBO_REF_LAYER(_NAV, _NAV) // explicit reference to self instead of the default.\\n\\n// name result chord keys\\nCOMB(AB_ESC, KC_ESC, KC_A, KC_B)\\nCOMB(JK_TAB, KC_TAB, KC_J, KC_K)\\nCOMB(JKL_SPC, KC_SPC, KC_J, KC_K, KC_L)\\nCOMB(BSSL_CLR, KC_NO, KC_BSPC, KC_LSFT) // using KC_NO as the resulting keycode is the same as COMBO_ACTION before.\\nCOMB(QW_UNDO, C(KC_Z), KC_Q, KC_W)\\nSUBS(TH_THE, \\\"the\\\", KC_T, KC_H) // SUBS uses SEND_STRING to output the given string.\\n...\\n```\\n\\nFor small to huge ready made dictionaries of combos, you can check out http://combos.gboards.ca/.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 6]\"}, {\"title\": \"Command\", \"description\": null, \"content\": {\"Usage\": \"To use Command, hold down the key combination defined by the `IS_COMMAND()` macro. By default this is Left Shift+Right Shift. Then, press the key corresponding to the command you want. For example, to output the current QMK version to the QMK Toolbox console, press Left Shift+Right Shift+`V`.\", \"Configuration\": \"If you would like to change the key assignments for Command, `#define` these in your `config.h` at either the keyboard or keymap level. All keycode assignments here must omit the `KC_` prefix.\\n\\n|Define |Default |Description |\\n|------------------------------------|--------------------------------|------------------------------------------------|\\n|`IS_COMMAND()` |`(get_mods() == MOD_MASK_SHIFT)`|The key combination to activate Command |\\n|`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row |\\n|`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys |\\n|`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` |\\n|`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial |\\n|`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging |\\n|`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging |\\n|`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging |\\n|`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console |\\n|`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console |\\n|`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console|\\n|`MAGIC_KEY_HELP` |`H` |Print Command help to the console |\\n|`MAGIC_KEY_HELP_ALT` |`SLASH` |Print Command help to the console (alternate) |\\n|`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer |\\n|`MAGIC_KEY_LAYER0_ALT` |`GRAVE` |Make layer 0 the default layer (alternate) |\\n|`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer |\\n|`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer |\\n|`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer |\\n|`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer |\\n|`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer |\\n|`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer |\\n|`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer |\\n|`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer |\\n|`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer |\\n|`MAGIC_KEY_BOOTLOADER` |`B` |Jump to bootloader |\\n|`MAGIC_KEY_BOOTLOADER_ALT` |`ESC` |Jump to bootloader (alternate) |\\n|`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed |\\n|`MAGIC_KEY_EEPROM` |`E` |Print stored EEPROM config to the console |\\n|`MAGIC_KEY_EEPROM_CLEAR` |`BSPACE` |Clear the EEPROM |\\n|`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) |\\n|`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 7]\"}, {\"title\": \"Community Modules\", \"description\": null, \"content\": {\"Adding a Community Module to your build\": \"Community Modules have first-class support for [External Userspace](/newbs_external_userspace), and QMK strongly recommends using External Userspace for hosting keymaps and Community Modules together.\\n\\nModules must live in either of two locations:\\n\\n['`<QMK_USERSPACE>/modules/`', '`<QMK_FIRMWARE>/modules/`']\\n\\nA basic module is provided within QMK itself -- `qmk/hello_world` -- which prints out a notification over [HID console](/faq_debug) after 10 seconds, and adds a new keycode, `COMMUNITY_MODULE_HELLO` (aliased to `CM_HELO`) which types `Hello there.` to the active application when the corresponding key is pressed.\\n\\nTo add this module to your build, in your keymap's directory create a `keymap.json` with the following content:\\n\\n```\\n{\\n \\\"modules\\\": [\\n \\\"qmk/hello_world\\\"\\n ]\\n}\\n```\\n\\nIf you already have a `keymap.json`, you'll need to manually merge the `modules` section into your keymap.\\n\\n::: warning\\nCommunity Modules are not supported by QMK Configurator. If you wish to use Community Modules, you must build your own firmware.\\n:::\", \"Adding a Community Module to your External Userspace\": \"Module authors are encouraged to provide a git repository on GitHub which may be imported into a user's external userspace. If a user wishes to import a module repository, they can do the following:\\n\\n```\\ncd /path/to/your/external/userspace\\nmkdir -p modules\\n# Replace the following {user} and {repo} with the author's community module repository\\ngit submodule add https://github.com/{user}/{repo}.git modules/{user}\\ngit submodule update --init --recursive\\n```\\n\\nThis will ensure the copy of the module is made in your userspace.\\n\\nAdd a new entry into your `keymap.json` with the desired modules, replacing `{user}` and `{module_name}` as appropriate:\\n\\n```\\n{\\n \\\"modules\\\": [\\n \\\"qmk/hello_world\\\",\\n \\\"{user}/{module_name}\\\"\\n ]\\n}\\n```\\n\\n::: info\\nThe module listed in `keymap.json` is the relative path within the `modules/` directory. So long as the module is present _somewhere_ under `modules/`, then the `keymap.json` can refer to that path.\\n:::\", \"Writing a QMK Community Module\": {\"`qmk_module.json`\": \"A Community Module is denoted by a `qmk_module.json` file such as the following:\\n\\n```\\n{\\n \\\"module_name\\\": \\\"Hello World\\\",\\n \\\"maintainer\\\": \\\"QMK Maintainers\\\",\\n \\\"license\\\": \\\"GPL-2.0-or-later\\\",\\n \\\"features\\\": {\\n \\\"deferred_exec\\\": true\\n },\\n \\\"keycodes\\\": [\\n {\\n \\\"key\\\": \\\"COMMUNITY_MODULE_HELLO\\\",\\n \\\"aliases\\\": [\\\"CM_HELO\\\"]\\n }\\n ]\\n}\\n```\\n\\nAt minimum, the module must provide the `module_name` and `maintainer` fields.\\n\\nThe `license` field is encouraged to indicate the terms for using and sharing the module. It is recommended to use a [SPDX license identifier](https://spdx.org/licenses/) like \\\"`Apache-2.0`\\\" or \\\"`GPL-2.0-or-later`\\\" if possible.\\n\\nThe `url` field may specify a URL to more information about the module.\\n\\nThe use of `features` matches the definition normally provided within `keyboard.json` and `info.json`, allowing a module to signal to the build system that it has its own dependencies. In the example above, it enables the _deferred executor_ feature whenever the above module is used in a build.\\n\\nThe `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap.\", \"`rules.mk` / `post_rules.mk`\": \"These two files follows standard QMK build system logic, allowing for `Makefile`-style customisation as if it were present in the keyboard or keymap.\", \"`<module>.c`\": \"This file will be automatically added to the build if the filename matches the directory name. For example, the `qmk/hello_world` module contains a `hello_world.c` file, which is automatically added to the build.\\n\\n::: info\\nOther files intended to be included must use the normal method of `SRC += my_file.c` inside `rules.mk`.\\n:::\\n\\n::: tip\\nThis file should use `ASSERT_COMMUNITY_MODULES_MIN_API_VERSION(1,0,0);` to enforce a minimum version of the API that it requires, ensuring the Community Module is built with a compatible version of QMK. The list of APIs and corresponding version is given at the bottom of this document. Note the use of commas instead of periods.\\n:::\", \"`introspection.c` / `introspection.h`\": \"These two files hook into the keymap introspection logic -- the header is prepended before the user keymap, and the C source file is appended after the user keymap.\\n\\nThe header may provide definitions which are useful to the user's `keymap.c`.\\n\\nThe source file may provide functions which allow access to information specified in the user's `keymap.c`.\\n\\n::: warning\\nIntrospection is a relatively advanced topic within QMK, and existing patterns should be followed. If you need help please [open an issue](https://github.com/qmk/qmk_firmware/issues/new) or [chat with us on Discord](https://discord.gg/qmk).\\n:::\", \"`led_matrix_module.inc`\": \"This file defines LED matrix effects in the same form as used with `led_matrix_kb.inc` and `led_matrix_user.inc` (see [Custom LED Matrix Effects](led_matrix#custom-led-matrix-effects)). Effect mode names are prepended with `LED_MATRIX_COMMUNITY_MODULE_`.\", \"`rgb_matrix_module.inc`\": \"This file defines RGB matrix effects in the same form as used with `rgb_matrix_kb.inc` and `rgb_matrix_user.inc` (see [Custom RGB Matrix Effects](rgb_matrix#custom-rgb-matrix-effects)). Effect mode names are prepended with `RGB_MATRIX_COMMUNITY_MODULE_`.\", \"Compatible APIs\": \"Community Modules may provide specializations for the following APIs:\\n\\n| Base API | API Format | Example (`hello_world` module) | API Version |\\n|----------------------------------|-------------------------------------------|---------------------------------------------|-------------|\\n| `keyboard_pre_init` | `keyboard_pre_init_<module>` | `keyboard_pre_init_hello_world` | `0.1.0` |\\n| `keyboard_post_init` | `keyboard_post_init_<module>` | `keyboard_post_init_hello_world` | `0.1.0` |\\n| `pre_process_record` | `pre_process_record_<module>` | `pre_process_record_hello_world` | `0.1.0` |\\n| `process_record` | `process_record_<module>` | `process_record_hello_world` | `0.1.0` |\\n| `post_process_record` | `post_process_record_<module>` | `post_process_record_hello_world` | `0.1.0` |\\n| `housekeeping_task` | `housekeeping_task_<module>` | `housekeeping_task_hello_world` | `1.0.0` |\\n| `suspend_power_down` | `suspend_power_down_<module>` | `suspend_power_down_hello_world` | `1.0.0` |\\n| `suspend_wakeup_init` | `suspend_wakeup_init_<module>` | `suspend_wakeup_init_hello_world` | `1.0.0` |\\n| `shutdown` | `shutdown_<module>` | `shutdown_hello_world` | `1.0.0` |\\n| `process_detected_host_os` | `process_detected_host_os_<module>` | `process_detected_host_os_hello_world` | `1.0.0` |\\n| `default_layer_state_set` | `default_layer_state_set_<module>` | `default_layer_state_set_hello_world` | `1.1.0` |\\n| `layer_state_set` | `layer_state_set_<module>` | `layer_state_set_hello_world` | `1.1.0` |\\n| `led_matrix_indicators` | `led_matrix_indicators_<module>` | `led_matrix_indicators_hello_world` | `1.1.0` |\\n| `led_matrix_indicators_advanced` | `led_matrix_indicators_advanced_<module>` | `led_matrix_indicators_advanced_hello_world` | `1.1.0` |\\n| `rgb_matrix_indicators` | `rgb_matrix_indicators_<module>` | `rgb_matrix_indicators_hello_world` | `1.1.0` |\\n| `rgb_matrix_indicators_advanced` | `rgb_matrix_indicators_advanced_<module>` | `rgb_matrix_indicators_advanced_hello_world` | `1.1.0` |\\n| `pointing_device_init` | `pointing_device_init_<module>` | `pointing_device_init_hello_world` | `1.1.0` |\\n| `pointing_device_task` | `pointing_device_task_<module>` | `pointing_device_task_hello_world` | `1.1.0` |\\n\\n::: info\\nAn unspecified API is disregarded if a Community Module does not provide a specialization for it.\\n:::\\n\\nEach API has an equivalent `_<module>_kb()` and `_<module>_user()` hook, as per the normal QMK [`_quantum`, `_kb`, and `_user` functions](/custom_quantum_functions#a-word-on-core-vs-keyboards-vs-keymap).\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 8]\"}, {\"title\": \"Digitizer {#digitizer}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nDIGITIZER_ENABLE = yes\\n```\", \"Positioning {#positioning}\": \"The X and Y coordinates are normalized, meaning their value must be set between 0 and 1. For the X component, the value `0` is the leftmost position, whereas the value `1` is the rightmost position. Similarly for the Y component, `0` is at the top and `1` at the bottom.\\n\\n::: tip\\nSince there is no display attached, the OS will likely map these coordinates to the virtual desktop. This may be important to know if you have multiple monitors.\\n:::\", \"Examples {#examples}\": \"This example simply places the cursor in the middle of the screen:\\n\\n```\\ndigitizer_in_range_on();\\ndigitizer_set_position(0.5, 0.5);\\n```\\n\\nThe \\\"in range\\\" indicator is required to be on for the change in coordinates to be taken. It can then be turned off again to signal the end of the digitizer interaction, but it is not strictly required.\\n\\nYou can also modify the digitizer state directly, if you need to change multiple fields in a single report:\\n\\n```\\ndigitizer_state.in_range = true;\\ndigitizer_state.dirty = true;\\ndigitizer_flush();\\n```\\n\\n`digitizer_state` is a struct of type `digitizer_t`.\", \"API {#api}\": {\"`struct digitizer_t` {#api-digitizer-t}\": {\"Members {#api-digitizer-t-members}\": [\"`bool in_range` \\nIndicates to the host that the contact is within range (ie. close to or in contact with the digitizer surface).\", \"`bool tip` \\nThe state of the tip switch.\", \"`bool barrel` \\nThe state of the barrel switch.\", \"`float x` \\nThe X coordinate of the digitizer contact.\", \"`float y` \\nThe Y coordinate of the digitizer contact.\", \"`bool dirty` \\nWhether the current state needs to be sent to the host.\"]}, \"`void digitizer_flush(void)` {#api-digitizer-flush}\": \"Send the digitizer report to the host if it is marked as dirty.\\n\\n[]\", \"`void digitizer_in_range_on(void)` {#api-digitizer-in-range-on}\": \"Assert the \\\"in range\\\" indicator, and flush the report.\\n\\n[]\", \"`void digitizer_in_range_off(void)` {#api-digitizer-in-range-off}\": \"Deassert the \\\"in range\\\" indicator, and flush the report.\\n\\n[]\", \"`void digitizer_tip_switch_on(void)` {#api-digitizer-tip-switch-on}\": \"Assert the tip switch, and flush the report.\\n\\n[]\", \"`void digitizer_tip_switch_off(void)` {#api-digitizer-tip-switch-off}\": \"Deassert the tip switch, and flush the report.\\n\\n[]\", \"`void digitizer_barrel_switch_on(void)` {#api-digitizer-barrel-switch-on}\": \"Assert the barrel switch, and flush the report.\\n\\n[]\", \"`void digitizer_barrel_switch_off(void)` {#api-digitizer-barrel-switch-off}\": \"Deassert the barrel switch, and flush the report.\\n\\n[]\", \"`void digitizer_set_position(float x, float y)` {#api-digitizer-set-position}\": {\"Arguments {#api-digitizer-set-position-arguments}\": [\"`float x` \\nThe X value of the contact position, from 0 to 1.\", \"`float y` \\nThe Y value of the contact position, from 0 to 1.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 9]\"}, {\"title\": \"DIP Switches\", \"description\": null, \"content\": {\"DIP Switch map {#dip-switch-map}\": \"DIP Switch mapping may be added to your `keymap.c`, which replicates the normal keyswitch functionality, but with dip switches. Add this to your keymap's `rules.mk`:\\n\\n```\\nDIP_SWITCH_MAP_ENABLE = yes\\n```\\n\\nYour `keymap.c` will then need a dip switch mapping defined (for two dip switches):\\n\\n```\\n#if defined(DIP_SWITCH_MAP_ENABLE)\\nconst uint16_t PROGMEM dip_switch_map[NUM_DIP_SWITCHES][NUM_DIP_STATES] = {\\n DIP_SWITCH_OFF_ON(DF(0), DF(1)),\\n DIP_SWITCH_OFF_ON(EC_NORM, EC_SWAP)\\n};\\n#endif\\n```\\n\\n::: tip\\nThis should only be enabled at the keymap level.\\n:::\", \"Callbacks\": \"The callback functions can be inserted into your `<keyboard>.c`:\\n\\n```\\nbool dip_switch_update_kb(uint8_t index, bool active) { \\n if (!dip_switch_update_user(index, active)) { return false; }\\n return true;\\n}\\n```\\n\\nor `keymap.c`:\\n\\n```\\nbool dip_switch_update_user(uint8_t index, bool active) { \\n switch (index) {\\n case 0:\\n if(active) { audio_on(); } else { audio_off(); }\\n break;\\n case 1:\\n if(active) { clicky_on(); } else { clicky_off(); }\\n break;\\n case 2:\\n if(active) { music_on(); } else { music_off(); }\\n break;\\n case 3:\\n if (active) {\\n #ifdef AUDIO_ENABLE\\n PLAY_SONG(plover_song);\\n #endif\\n layer_on(_PLOVER);\\n } else {\\n #ifdef AUDIO_ENABLE\\n PLAY_SONG(plover_gb_song);\\n #endif\\n layer_off(_PLOVER);\\n }\\n break;\\n }\\n return true;\\n}\\n```\\n\\nAdditionally, we support bit mask functions which allow for more complex handling. \\n\\n```\\nbool dip_switch_update_mask_kb(uint32_t state) { \\n if (!dip_switch_update_mask_user(state)) { return false; }\\n return true;\\n}\\n```\\n\\nor `keymap.c`:\\n\\n```\\nbool dip_switch_update_mask_user(uint32_t state) { \\n if (state & (1UL<<0) && state & (1UL<<1)) {\\n layer_on(_ADJUST); // C on esc\\n } else {\\n layer_off(_ADJUST);\\n }\\n if (state & (1UL<<0)) {\\n layer_on(_TEST_A); // A on ESC\\n } else {\\n layer_off(_TEST_A);\\n }\\n if (state & (1UL<<1)) {\\n layer_on(_TEST_B); // B on esc\\n } else {\\n layer_off(_TEST_B);\\n }\\n return true;\\n}\\n```\", \"Hardware\": {\"Connects each switch in the dip switch to the GPIO pin of the MCU\": \"One side of the DIP switch should be wired directly to the pin on the MCU, and the other side to ground. It should not matter which side is connected to which, as it should be functionally the same. \", \"Connect each switch in the DIP switch to an unused intersections in the key matrix.\": \"As with the keyswitch, a diode and DIP switch connect the ROW line to the COL line.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 10]\"}, {\"title\": \"Dynamic Macros: Record and Replay Macros in Runtime\", \"description\": null, \"content\": {\"Customization \": {\"DYNAMIC_MACRO_USER_CALL\": \"For users of the earlier versions of dynamic macros: It is still possible to finish the macro recording using just the layer modifier used to access the dynamic macro keys, without a dedicated `DM_RSTP` key. If you want this behavior back, add `#define DYNAMIC_MACRO_USER_CALL` to your `config.h` and insert the following snippet at the beginning of your `process_record_user()` function:\\n\\n```\\n uint16_t macro_kc = (keycode == MO(_DYN) ? DM_RSTP : keycode);\\n\\n if (!process_record_dynamic_macro(macro_kc, record)) {\\n return false;\\n }\\n```\", \"User Hooks\": \"There are a number of hooks that you can use to add custom functionality and feedback options to Dynamic Macro feature. This allows for some additional degree of customization. \\n\\nNote, that direction indicates which macro it is, with `1` being Macro 1, `-1` being Macro 2, and 0 being no macro. \\n\\n['`dynamic_macro_record_start_user(int8_t direction)` - Triggered when you start recording a macro.', '`dynamic_macro_play_user(int8_t direction)` - Triggered when you play back a macro.', '`dynamic_macro_record_key_user(int8_t direction, keyrecord_t *record)` - Triggered on each keypress while recording a macro.', '`dynamic_macro_record_end_user(int8_t direction)` - Triggered when the macro recording is stopped. ']\\n\\nAdditionally, you can call `dynamic_macro_led_blink()` to flash the backlights if that feature is enabled. \"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 11]\"}, {\"title\": \"Encoders\", \"description\": null, \"content\": {\"Split Keyboards\": \"If you are using different pinouts for the encoders on each half of a split keyboard, you can define the pinout (and optionally, resolutions) for the right half like this:\\n\\n```\\n#define ENCODER_A_PINS_RIGHT { encoder1a, encoder2a }\\n#define ENCODER_B_PINS_RIGHT { encoder1b, encoder2b }\\n#define ENCODER_RESOLUTIONS_RIGHT { 2, 4 }\\n```\\n\\nIf the `_RIGHT` definitions aren't specified in your `config.h`, then the non-`_RIGHT` versions will be applied to both sides of the split.\\n\\nAdditionally, if one side does not have an encoder, you can specify `{}` for the pins/resolution -- for example, a split keyboard with only a right-side encoder:\\n\\n```\\n#define ENCODER_A_PINS { }\\n#define ENCODER_B_PINS { }\\n#define ENCODER_RESOLUTIONS { }\\n#define ENCODER_A_PINS_RIGHT { B12 }\\n#define ENCODER_B_PINS_RIGHT { B13 }\\n#define ENCODER_RESOLUTIONS_RIGHT { 4 }\\n```\\n\\n::: warning\\nKeep in mind that whenver you change the encoder resolution, you will need to reflash the half that has the encoder affected by the change.\\n:::\", \"Encoder map {#encoder-map}\": \"Encoder mapping may be added to your `keymap.c`, which replicates the normal keyswitch layer handling functionality, but with encoders. Add this to your keymap's `rules.mk`:\\n\\n```\\nENCODER_MAP_ENABLE = yes\\n```\\n\\nYour `keymap.c` will then need an encoder mapping defined (for four layers and two encoders):\\n\\n```\\n#if defined(ENCODER_MAP_ENABLE)\\nconst uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {\\n [0] = { ENCODER_CCW_CW(MS_WHLU, MS_WHLD), ENCODER_CCW_CW(KC_VOLD, KC_VOLU) },\\n [1] = { ENCODER_CCW_CW(UG_HUED, UG_HUEU), ENCODER_CCW_CW(UG_SATD, UG_SATU) },\\n [2] = { ENCODER_CCW_CW(UG_VALD, UG_VALU), ENCODER_CCW_CW(UG_SPDD, UG_SPDU) },\\n [3] = { ENCODER_CCW_CW(UG_PREV, UG_NEXT), ENCODER_CCW_CW(KC_RIGHT, KC_LEFT) },\\n};\\n#endif\\n```\\n\\n::: tip\\nThis should only be enabled at the keymap level.\\n:::\\n\\nUsing encoder mapping pumps events through the normal QMK keycode processing pipeline, resulting in a _keydown/keyup_ combination pushed through `process_record_xxxxx()`. To configure the amount of time between the encoder \\\"keyup\\\" and \\\"keydown\\\", you can add the following to your `config.h`:\\n\\n```\\n#define ENCODER_MAP_KEY_DELAY 10\\n```\\n\\n::: tip\\nBy default, the encoder map delay matches the value of `TAP_CODE_DELAY`.\\n:::\", \"Callbacks\": \"::: tip\\n[**Default Behaviour**](https://github.com/qmk/qmk_firmware/blob/master/quantum/encoder.c#L79-): all encoders installed will function as volume up (`KC_VOLU`) on clockwise rotation and volume down (`KC_VOLD`) on counter-clockwise rotation. If you do not wish to override this, no further configuration is necessary.\\n:::\\n\\nIf you would like the alter the default behaviour, and are not using `ENCODER_MAP_ENABLE = yes`, the callback functions can be inserted into your `<keyboard>.c`:\\n\\n```\\nbool encoder_update_kb(uint8_t index, bool clockwise) {\\n if (!encoder_update_user(index, clockwise)) {\\n return false; /* Don't process further events if user function exists and returns false */\\n }\\n if (index == 0) { /* First encoder */\\n if (clockwise) {\\n tap_code(KC_PGDN);\\n } else {\\n tap_code(KC_PGUP);\\n }\\n } else if (index == 1) { /* Second encoder */\\n if (clockwise) {\\n rgb_matrix_increase_hue();\\n } else {\\n rgb_matrix_decrease_hue();\\n }\\n }\\n return true;\\n}\\n```\\n\\nor `keymap.c`:\\n\\n```\\nbool encoder_update_user(uint8_t index, bool clockwise) {\\n if (index == 0) { /* First encoder */\\n if (clockwise) {\\n tap_code(KC_PGDN);\\n } else {\\n tap_code(KC_PGUP);\\n }\\n } else if (index == 1) { /* Second encoder */\\n if (clockwise) {\\n rgb_matrix_increase_hue();\\n } else {\\n rgb_matrix_decrease_hue();\\n }\\n }\\n return false;\\n}\\n```\\n\\n::: warning\\nIf you return `true` in the keymap level `_user` function, it will allow the keyboard/core level encoder code to run on top of your own. Returning `false` will override the keyboard level function, if setup correctly. This is generally the safest option to avoid confusion.\\n:::\", \"Hardware\": \"The A an B lines of the encoders should be wired directly to the MCU, and the C/common lines should be wired to ground.\", \"Multiple Encoders\": \"Multiple encoders may share pins so long as each encoder has a distinct pair of pins when the following conditions are met:\\n\\n['using detent encoders', \\\"pads must be high at the detent stability point which is called 'default position' in QMK\\\", 'no more than two encoders sharing a pin can be turned at the same time']\\n\\nFor example you can support two encoders using only 3 pins like this\\n\\n```\\n#define ENCODER_A_PINS { B1, B1 }\\n#define ENCODER_B_PINS { B2, B3 }\\n```\\n\\nYou could even support three encoders using only three pins (one per encoder) however in this configuration, rotating two encoders which share pins simultaneously will often generate incorrect output. For example:\\n\\n```\\n#define ENCODER_A_PINS { B1, B1, B2 }\\n#define ENCODER_B_PINS { B2, B3, B3 }\\n```\\n\\nHere rotating Encoder 0 `B1 B2` and Encoder 1 `B1 B3` could be interpreted as rotating Encoder 2 `B2 B3` or `B3 B2` depending on the timing. This may still be a useful configuration depending on your use case\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 12]\"}, {\"title\": \"Grave Escape\", \"description\": null, \"content\": {\"Usage\": \"Replace the `KC_GRV` key in your keymap (usually to the left of the `1` key) with `QK_GESC`. Most of the time this key will output `KC_ESC` when pressed. However, when Shift or GUI are held down it will output `KC_GRV` instead.\", \"What Your OS Sees\": \"If Mary presses `QK_GESC` on her keyboard, the OS will see an KC_ESC character. Now if Mary holds Shift down and presses `QK_GESC` it will output `~`, or a shifted backtick. Now if she holds GUI/CMD/WIN, it will output a simple <code>`</code> character.\", \"Keycodes\": {\"Caveats\": \"On macOS, Command+<code>`</code> is by default mapped to \\\"Move focus to next window\\\" so it will not output a backtick. Additionally, Terminal always recognises this shortcut to cycle between windows, even if the shortcut is changed in the Keyboard preferences.\"}, \"Configuration\": \"There are several possible key combinations this will break, among them Control+Shift+Escape on Windows and Command+Option+Escape on macOS. To work around this, you can `#define` these options in your `config.h`:\\n\\n|Define |Description |\\n|--------------------------|-----------------------------------------|\\n|`GRAVE_ESC_ALT_OVERRIDE` |Always send Escape if Alt is pressed |\\n|`GRAVE_ESC_CTRL_OVERRIDE` |Always send Escape if Control is pressed |\\n|`GRAVE_ESC_GUI_OVERRIDE` |Always send Escape if GUI is pressed |\\n|`GRAVE_ESC_SHIFT_OVERRIDE`|Always send Escape if Shift is pressed |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 13]\"}, {\"title\": \"Haptic Feedback\", \"description\": null, \"content\": {\"Haptic feedback rules.mk options\": \"The following options are currently available for haptic feedback in `rules.mk`:\\n\\n```\\nHAPTIC_ENABLE = yes\\n\\nHAPTIC_DRIVER = drv2605l\\n# or\\nHAPTIC_DRIVER = solenoid\\n```\\n\\nThe following `config.h` settings are available for all types of haptic feedback:\\n\\n| Settings | Default | Description |\\n|--------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------|\\n|`HAPTIC_ENABLE_PIN` | *Not defined* |Configures a pin to enable a boost converter for some haptic solution, often used with solenoid drivers. |\\n|`HAPTIC_ENABLE_PIN_ACTIVE_LOW` | *Not defined* |If defined then the haptic enable pin is active-low. |\\n|`HAPTIC_ENABLE_STATUS_LED` | *Not defined* |Configures a pin to reflect the current enabled/disabled status of haptic feedback. |\\n|`HAPTIC_ENABLE_STATUS_LED_ACTIVE_LOW` | *Not defined* |If defined then the haptic status led will be active-low. |\\n|`HAPTIC_OFF_IN_LOW_POWER` | `0` |If set to `1`, haptic feedback is disabled before the device is configured, and while the device is suspended. |\", \"Known Supported Hardware\": \"| Name | Description |\\n|--------------------|-------------------------------------------------|\\n| [LV061228B-L65-A](https://www.digikey.com/product-detail/en/jinlong-machinery-electronics-inc/LV061228B-L65-A/1670-1050-ND/7732325) | z-axis 2v LRA |\\n| [Mini Motor Disc](https://www.adafruit.com/product/1201) | small 2-5v ERM |\", \"Haptic Keycodes\": {\"Solenoids\": \"The solenoid code supports relay switches, and similar hardware, as well as solenoids. \\n\\nFor a regular solenoid, you will need a build a circuit to drive the solenoid through a mosfet as most MCU will not be able to provide the current needed to drive the coil in the solenoid.\\n\\n[Wiring diagram provided by Adafruit](https://cdn-shop.adafruit.com/product-files/412/solenoid_driver.pdf)\\n\\nFor relay switches, the hardware may already contain all of that ciruitry, and just require VCC, GND and a data pin.\\n\\n| Settings | Default | Description |\\n|----------------------------|----------------------|--------------------------------------------------------------|\\n|`SOLENOID_PIN` | *Not defined* |Configures the pin that the switch is connected to. |\\n|`SOLENOID_PIN_ACTIVE_LOW` | *Not defined* |If defined then the switch trigger pin is active low. |\\n|`SOLENOID_PINS` | *Not defined* |Configures an array of pins to be used for switch activation. |\\n|`SOLENOID_PINS_ACTIVE_LOW` | *Not defined* |Allows you to specify how each pin is pulled for activation. |\\n|`SOLENOID_RANDOM_FIRE` | *Not defined* |When there are multiple solenoids, will select a random one to fire.|\\n|`SOLENOID_DEFAULT_DWELL` | `12` ms |Configures the default dwell time for the switch. |\\n|`SOLENOID_MIN_DWELL` | `4` ms |Sets the lower limit for the dwell. |\\n|`SOLENOID_MAX_DWELL` | `100` ms |Sets the upper limit for the dwell. |\\n|`SOLENOID_DWELL_STEP_SIZE` | `1` ms |The step size to use when `HF_DWL*` keycodes are sent. |\\n|`SOLENOID_DEFAULT_BUZZ` | `0` (disabled) |On `HF_RST` buzz is set \\\"on\\\" if this is \\\"1\\\" |\\n|`SOLENOID_BUZZ_ACTUATED` | `SOLENOID_MIN_DWELL` |Actuated-time when the switch is in buzz mode. |\\n|`SOLENOID_BUZZ_NONACTUATED` | `SOLENOID_MIN_DWELL` |Non-Actuated-time when the switch is in buzz mode. |\\n\\n['If solenoid buzz is off, then dwell time is how long the \\\"plunger\\\" stays activated. The dwell time changes how the solenoid sounds.', 'If solenoid buzz is on, then dwell time sets the length of the buzz, while `SOLENOID_BUZZ_ACTUATED` and `SOLENOID_BUZZ_NONACTUATED` set the (non-)actuation times withing the buzz period.', 'With the current implementation, for any of the above time settings, the precision of these settings may be affected by how fast the keyboard is able to scan the matrix.\\\\nTherefore, if the keyboards scanning routine is slow, it may be preferable to set `SOLENOID_DWELL_STEP_SIZE` to a value slightly smaller than the time it takes to scan the keyboard.']\\n\\nBeware that some pins may be powered during bootloader (ie. A13 on the STM32F303 chip) and will result in the solenoid kept in the on state through the whole flashing process. This may overheat and damage the solenoid. If you find that the pin the solenoid is connected to is triggering the solenoid during bootloader/DFU, select another pin.\", \"DRV2605L\": {\"Feedback motor setup\": {\"ERM\": \"Eccentric Rotating Mass vibration motors (ERM) is motor with a off-set weight attached so when drive signal is attached, the off-set weight spins and causes a sinusoidal wave that translate into vibrations.\\n\\n```\\n#define DRV2605L_FB_ERM_LRA 0\\n#define DRV2605L_FB_BRAKEFACTOR 3 /* For 1x:0, 2x:1, 3x:2, 4x:3, 6x:4, 8x:5, 16x:6, Disable Braking:7 */\\n#define DRV2605L_FB_LOOPGAIN 1 /* For Low:0, Medium:1, High:2, Very High:3 */\\n\\n/* Please refer to your datasheet for the optimal setting for your specific motor. */\\n#define DRV2605L_RATED_VOLTAGE 3\\n#define DRV2605L_V_PEAK 5\\n```\", \"LRA\": \"Linear resonant actuators (LRA, also know as a linear vibrator) works different from a ERM. A LRA has a weight and magnet suspended by springs and a voice coil. When the drive signal is applied, the weight would be vibrate on a single axis (side to side or up and down). Since the weight is attached to a spring, there is a resonance effect at a specific frequency. This frequency is where the LRA will operate the most efficiently. Refer to the motor's datasheet for the recommanded range for this frequency.\\n\\n```\\n#define DRV2605L_FB_ERM_LRA 1\\n#define DRV2605L_FB_BRAKEFACTOR 3 /* For 1x:0, 2x:1, 3x:2, 4x:3, 6x:4, 8x:5, 16x:6, Disable Braking:7 */\\n#define DRV2605L_FB_LOOPGAIN 1 /* For Low:0, Medium:1, High:2, Very High:3 */\\n\\n/* Please refer to your datasheet for the optimal setting for your specific motor. */\\n#define DRV2605L_RATED_VOLTAGE 2\\n#define DRV2605L_V_PEAK 2.8\\n#define DRV2605L_V_RMS 2.0 \\n#define DRV2605L_V_PEAK 2.1\\n#define DRV2605L_F_LRA 205 /* resonance freq */\\n```\"}, \"DRV2605L waveform library\": \"DRV2605L comes with preloaded library of various waveform sequences that can be called and played. If writing a macro, these waveforms can be played using `DRV_pulse(*sequence name or number*)`\\n\\nList of waveform sequences from the datasheet:\\n\\n|seq# | Sequence name |seq# | Sequence name |seq# |Sequence name |\\n|-----|---------------------|-----|-----------------------------------|-----|--------------------------------------|\\n| 1 | strong_click | 43 | lg_dblclick_med_60 | 85 | transition_rampup_med_smooth2 |\\n| 2 | strong_click_60 | 44 | lg_dblsharp_tick | 86 | transition_rampup_short_smooth1 |\\n| 3 | strong_click_30 | 45 | lg_dblsharp_tick_80 | 87 | transition_rampup_short_smooth2 |\\n| 4 | sharp_click | 46 | lg_dblsharp_tick_60 | 88 | transition_rampup_long_sharp1 |\\n| 5 | sharp_click_60 | 47 | buzz | 89 | transition_rampup_long_sharp2 |\\n| 6 | sharp_click_30 | 48 | buzz_80 | 90 | transition_rampup_med_sharp1 |\\n| 7 | soft_bump | 49 | buzz_60 | 91 | transition_rampup_med_sharp2 |\\n| 8 | soft_bump_60 | 50 | buzz_40 | 92 | transition_rampup_short_sharp1 |\\n| 9 | soft_bump_30 | 51 | buzz_20 | 93 | transition_rampup_short_sharp2 |\\n| 10 | dbl_click | 52 | pulsing_strong | 94 | transition_rampdown_long_smooth1_50 |\\n| 11 | dbl_click_60 | 53 | pulsing_strong_80 | 95 | transition_rampdown_long_smooth2_50 |\\n| 12 | trp_click | 54 | pulsing_medium | 96 | transition_rampdown_med_smooth1_50 |\\n| 13 | soft_fuzz | 55 | pulsing_medium_80 | 97 | transition_rampdown_med_smooth2_50 |\\n| 14 | strong_buzz | 56 | pulsing_sharp | 98 | transition_rampdown_short_smooth1_50 |\\n| 15 | alert_750ms | 57 | pulsing_sharp_80 | 99 | transition_rampdown_short_smooth2_50 |\\n| 16 | alert_1000ms | 58 | transition_click | 100 | transition_rampdown_long_sharp1_50 |\\n| 17 | strong_click1 | 59 | transition_click_80 | 101 | transition_rampdown_long_sharp2_50 |\\n| 18 | strong_click2_80 | 60 | transition_click_60 | 102 | transition_rampdown_med_sharp1_50 |\\n| 19 | strong_click3_60 | 61 | transition_click_40 | 103 | transition_rampdown_med_sharp2_50 |\\n| 20 | strong_click4_30 | 62 | transition_click_20 | 104 | transition_rampdown_short_sharp1_50 |\\n| 21 | medium_click1 | 63 | transition_click_10 | 105 | transition_rampdown_short_sharp2_50 |\\n| 22 | medium_click2_80 | 64 | transition_hum | 106 | transition_rampup_long_smooth1_50 |\\n| 23 | medium_click3_60 | 65 | transition_hum_80 | 107 | transition_rampup_long_smooth2_50 |\\n| 24 | sharp_tick1 | 66 | transition_hum_60 | 108 | transition_rampup_med_smooth1_50 |\\n| 25 | sharp_tick2_80 | 67 | transition_hum_40 | 109 | transition_rampup_med_smooth2_50 |\\n| 26 | sharp_tick3_60 | 68 | transition_hum_20 | 110 | transition_rampup_short_smooth1_50 |\\n| 27 | sh_dblclick_str | 69 | transition_hum_10 | 111 | transition_rampup_short_smooth2_50 |\\n| 28 | sh_dblclick_str_80 | 70 | transition_rampdown_long_smooth1 | 112 | transition_rampup_long_sharp1_50 |\\n| 29 | sh_dblclick_str_60 | 71 | transition_rampdown_long_smooth2 | 113 | transition_rampup_long_sharp2_50 |\\n| 30 | sh_dblclick_str_30 | 72 | transition_rampdown_med_smooth1 | 114 | transition_rampup_med_sharp1_50 |\\n| 31 | sh_dblclick_med | 73 | transition_rampdown_med_smooth2 | 115 | transition_rampup_med_sharp2_50 |\\n| 32 | sh_dblclick_med_80 | 74 | transition_rampdown_short_smooth1 | 116 | transition_rampup_short_sharp1_50 |\\n| 33 | sh_dblclick_med_60 | 75 | transition_rampdown_short_smooth2 | 117 | transition_rampup_short_sharp2_50 |\\n| 34 | sh_dblsharp_tick | 76 | transition_rampdown_long_sharp1 | 118 | long_buzz_for_programmatic_stopping |\\n| 35 | sh_dblsharp_tick_80 | 77 | transition_rampdown_long_sharp2 | 119 | smooth_hum1_50 |\\n| 36 | sh_dblsharp_tick_60 | 78 | transition_rampdown_med_sharp1 | 120 | smooth_hum2_40 |\\n| 37 | lg_dblclick_str | 79 | transition_rampdown_med_sharp2 | 121 | smooth_hum3_30 |\\n| 38 | lg_dblclick_str_80 | 80 | transition_rampdown_short_sharp1 | 122 | smooth_hum4_20 |\\n| 39 | lg_dblclick_str_60 | 81 | transition_rampdown_short_sharp2 | 123 | smooth_hum5_10 |\\n| 40 | lg_dblclick_str_30 | 82 | transition_rampup_long_smooth1 | | |\\n| 41 | lg_dblclick_med | 83 | transition_rampup_long_smooth2 | | |\\n| 42 | lg_dblclick_med_80 | 84 | transition_rampup_med_smooth1 | | |\"}, \"Optional DRV2605L defines\": \"```\\n#define DRV2605L_GREETING *sequence name or number*\\n```\\n\\nIf haptic feedback is enabled, the keyboard will vibrate to a specific sequence during startup. That can be selected using the following define:\\n\\n```\\n#define DRV2605L_DEFAULT_MODE *sequence name or number*\\n```\\n\\nThis will set what sequence `HF_RST` will set as the active mode. If not defined, mode will be set to 1 when `HF_RST` is pressed.\", \"DRV2605L Continuous Haptic Mode\": \"This mode sets continuous haptic feedback with the option to increase or decrease strength.\"}, \"Haptic Key Exclusion\": {\"NO_HAPTIC_MOD\": \"With the entry of `#define NO_HAPTIC_MOD` in config.h, the following keys will not trigger feedback:\\n\\n['Usual modifier keys such as Control/Shift/Alt/Gui (For example `KC_LCTL`)', '`MO()` momentary keys. See also [Layers](../feature_layers).', '`LM()` momentary keys with mod active.', '`LT()` layer tap keys, when held to activate a layer. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered.', '`TT()` layer tap toggle keys, when held to activate a layer. However when tapped `TAPPING_TOGGLE` times to permanently toggle the layer, on the last tap haptic feedback is still triggered.', '`MT()` mod tap keys, when held to keep a usual modifier key pressed. However when tapped, and the key is quickly released, and sends a keycode, haptic feedback is still triggered. See also [Mod-Tap](../mod_tap).']\", \"NO_HAPTIC_ALPHA\": \"With the entry of `#define NO_HAPTIC_ALPHA` in config.h, none of the alpha keys (A ... Z) will trigger a feedback.\", \"NO_HAPTIC_PUNCTUATION\": \"With the entry of `#define NO_HAPTIC_PUNCTUATION` in config.h, none of the following keys will trigger a feedback: Enter, ESC, Backspace, Space, Minus, Equal, Left Bracket, Right Bracket, Backslash, Non-US Hash, Semicolon, Quote, Grave, Comma, Slash, Dot, Non-US Backslash.\", \"NO_HAPTIC_LOCKKEYS\": \"With the entry of `#define NO_HAPTIC_LOCKKEYS` in config.h, none of the following keys will trigger a feedback: Caps Lock, Scroll Lock, Num Lock.\", \"NO_HAPTIC_NAV\": \"With the entry of `#define NO_HAPTIC_NAV` in config.h, none of the following keys will trigger a feedback: Print Screen, Pause, Insert, Delete, Page Down, Page Up, Left Arrow, Up Arrow, Right Arrow, Down Arrow, End, Home.\", \"NO_HAPTIC_NUMERIC\": \"With the entry of `#define NO_HAPTIC_NUMERIC` in config.h, none of the following keys between 0 and 9 (KC_1 ... KC_0) will trigger a feedback.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 14]\"}, {\"title\": \"HD44780 LCD Driver {#hd44780-lcd-driver}\", \"description\": null, \"content\": {\"Supported Hardware {#supported-hardware}\": \"LCD modules using [HD44780U](https://www.sparkfun.com/datasheets/LCD/HD44780.pdf) IC or equivalent, communicating in 4-bit mode.\\n\\n|Module|Size |Notes |\\n|------|--------------|---------------------------------|\\n|1602A |16x2, 5x8 dots| |\\n|2004A |20x4, 5x8 dots|Untested, not currently supported|\\n\\nTo run these modules at 3.3V, an additional MAX660 voltage converter IC must be soldered on, along with two 10\\u00b5F capacitors. See [this page](https://www.codrey.com/electronic-circuits/hack-your-16x2-lcd/) for more details.\", \"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nHD44780_ENABLE = yes\\n```\", \"Basic Configuration {#basic-configuration}\": \"Add the following to your `config.h`:\\n\\n|Define |Default |Description |\\n|-----------------------|--------------|-----------------------------------------------------------------------------------------------------|\\n|`HD44780_DATA_PINS` |*Not defined* |(Required) An array of four GPIO pins connected to the display's D4-D7 pins, eg. `{ B1, B3, B2, B6 }`|\\n|`HD44780_RS_PIN` |*Not defined* |(Required) The GPIO connected to the display's RS pin |\\n|`HD44780_RW_PIN` |*Not defined* |(Required) The GPIO connected to the display's RW pin |\\n|`HD44780_E_PIN` |*Not defined* |(Required) The GPIO connected to the display's E pin |\\n|`HD44780_DISPLAY_COLS` |`16` |The number of visible characters on a single line of the display |\\n|`HD44780_DISPLAY_LINES`|`2` |The number of visible lines on the display |\\n|`HD44780_WRAP_LINES` |*Not defined* |If defined, input characters will wrap to the next line |\", \"Examples {#examples}\": {\"Hello World {#example-hello-world}\": \"Add the following to your `keymap.c`:\\n\\n```\\nvoid keyboard_post_init_user(void) {\\n hd44780_init(true, true); // Show blinking cursor\\n hd44780_puts_P(PSTR(\\\"Hello, world!\\\\n\\\"));\\n}\\n```\", \"Custom Character Definition {#example-custom-character}\": \"Up to eight custom characters can be defined. This data is stored in the Character Generator RAM (CGRAM), and is not persistent across power cycles.\\n\\nThis example defines the QMK Psi as the first custom character. The first 16 positions in the character set are reserved for the eight custom characters duplicated.\\n\\n```\\nByte | 16 8 4 2 1\\n 1 | x x x \\u25a0 \\u25a1 \\u25a0 \\u25a1 \\u25a0\\n 2 | x x x \\u25a0 \\u25a1 \\u25a0 \\u25a1 \\u25a0\\n 3 | x x x \\u25a0 \\u25a1 \\u25a0 \\u25a1 \\u25a0\\n 4 | x x x \\u25a1 \\u25a0 \\u25a0 \\u25a0 \\u25a1\\n 5 | x x x \\u25a1 \\u25a1 \\u25a0 \\u25a1 \\u25a1\\n 6 | x x x \\u25a1 \\u25a1 \\u25a0 \\u25a1 \\u25a1\\n 7 | x x x \\u25a1 \\u25a1 \\u25a0 \\u25a1 \\u25a1\\n 8 | x x x \\u25a1 \\u25a1 \\u25a1 \\u25a1 \\u25a1\\n```\\n\\n```\\nconst uint8_t PROGMEM psi[8] = { 0x15, 0x15, 0x15, 0x0E, 0x04, 0x04, 0x04, 0x00 };\\n\\nvoid keyboard_post_init_user(void) {\\n hd44780_init(false, false);\\n hd44780_define_char_P(0, psi);\\n // Cursor is incremented while defining characters so must be reset\\n hd44780_home();\\n // 0x08 to avoid null terminator\\n hd44780_puts_P(PSTR(\\\"\\\\x08 QMK Firmware\\\"));\\n}\\n```\"}, \"API {#api}\": {\"`void hd44780_init(bool cursor, bool blink)` {#api-hd44780-init}\": {\"Arguments {#api-hd44780-init-arguments}\": [\"`bool cursor` \\nWhether to show the cursor.\", \"`bool blink` \\nWhether to blink the cursor, if shown.\"]}, \"`void hd44780_clear(void)` {#api-hd44780-clear}\": \"Clear the display.\\n\\nThis function is called on init.\\n\\n[]\", \"`void hd44780_home(void)` {#api-hd44780-home}\": \"Move the cursor to the home position.\\n\\nThis function is called on init.\\n\\n[]\", \"`void hd44780_on(bool cursor, bool blink)` {#api-hd44780-on}\": {\"Arguments {#api-hd44780-on-arguments}\": [\"`bool cursor` \\nWhether to show the cursor.\", \"`bool blink` \\nWhether to blink the cursor, if shown.\"]}, \"`void hd44780_off(void)` {#api-hd44780-off}\": \"Turn the display off.\\n\\n[]\", \"`void hd44780_set_cursor(uint8_t col, uint8_t line)` {#api-hd44780-set-cursor}\": {\"Arguments {#api-hd44780-set-cursor-arguments}\": [\"`uint8_t col` \\nThe column number to move to, from 0 to 15 on 16x2 displays.\", \"`bool line` \\nThe line number to move to, either 0 or 1 on 16x2 displays.\"]}, \"`void hd44780_putc(char c)` {#api-hd44780-putc}\": {\"Arguments {#api-hd44780-putc-arguments}\": [\"`char c` \\nThe character to print.\"]}, \"`void hd44780_puts(const char *s)` {#api-hd44780-puts}\": {\"Arguments {#api-hd44780-puts-arguments}\": [\"`const char *s` \\nThe string to print.\"]}, \"`void hd44780_puts_P(const char *s)` {#api-hd44780-puts-p}\": {\"Arguments {#api-hd44780-puts-p-arguments}\": [\"`const char *s` \\nThe PROGMEM string to print (ie. `PSTR(\\\"Hello\\\")`).\"]}, \"`void hd44780_define_char(uint8_t index, uint8_t *data)` {#api-hd44780-define-char}\": {\"Arguments {#api-hd44780-define-char-arguments}\": [\"`uint8_t index` \\nThe index of the custom character to define, from 0 to 7.\", \"`uint8_t *data` \\nAn array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column.\"]}, \"`void hd44780_define_char_P(uint8_t index, const uint8_t *data)` {#api-hd44780-define-char-p}\": {\"Arguments {#api-hd44780-define-char-p-arguments}\": [\"`uint8_t index` \\nThe index of the custom character to define, from 0 to 7.\", \"`const uint8_t *data` \\nA PROGMEM array of 8 bytes containing the 5-bit row data of the character, where the first byte is the topmost row, and the least significant bit of each byte is the rightmost column.\"]}, \"`bool hd44780_busy(void)` {#api-hd44780-busy}\": {\"Return Value {#api-hd44780-busy-arguments}\": \"`true` if the display is busy.\\n\\n[]\"}, \"`void hd44780_write(uint8_t data, bool isData)` {#api-hd44780-write}\": {\"Arguments {#api-hd44780-write-arguments}\": [\"`uint8_t data` \\nThe byte to send to the display.\", \"`bool isData` \\nWhether the byte is an instruction or character data.\"]}, \"`uint8_t hd44780_read(bool isData)` {#api-hd44780-read}\": {\"Arguments {#api-hd44780-read-arguments}\": [\"`bool isData` \\nWhether to read the current cursor position, or the character at the cursor.\"], \"Return Value {#api-hd44780-read-return}\": \"If `isData` is `true`, the returned byte will be the character at the current DDRAM address. Otherwise, it will be the current DDRAM address and the busy flag.\\n\\n[]\"}, \"`void hd44780_command(uint8_t command)` {#api-hd44780-command}\": {\"Arguments {#api-hd44780-command-arguments}\": [\"`uint8_t command` \\nThe command to send.\"]}, \"`void hd44780_data(uint8_t data)` {#api-hd44780-data}\": {\"Arguments {#api-hd44780-data-arguments}\": [\"`uint8_t data` \\nThe byte of data to send.\"]}, \"`void hd44780_set_cgram_address(uint8_t address)` {#api-hd44780-set-cgram-address}\": {\"Arguments {#api-hd44780-set-cgram-address-arguments}\": [\"`uint8_t address` \\nThe CGRAM address to move to, from `0x00` to `0x3F`.\"]}, \"`void hd44780_set_ddram_address(uint8_t address)` {#api-hd44780-set-ddram-address}\": {\"Arguments {#api-hd44780-set-ddram-address-arguments}\": [\"`uint8_t address` \\nThe DDRAM address to move to, from `0x00` to `0x7F`.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 15]\"}, {\"title\": \"Joystick {#joystick}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nJOYSTICK_ENABLE = yes\\n```\\n\\nBy default the joystick driver is `analog`, but you can change this with:\\n\\n```\\nJOYSTICK_DRIVER = digital\\n```\\n\\nWhen using `analog` with ARM, [you must use 3.3v with your Joystick](../drivers/adc). Although ARM boards such as the [Helios](https://keeb.supply/products/0xcb-helios) have 5v pin output, the ADC driver does not support it.\", \"Configuration {#configuration}\": {\"Hat Switch {#hat-switch}\": \"To enable the 8-way hat switch, add the following to your `config.h`:\\n\\n```\\n#define JOYSTICK_HAS_HAT\\n```\\n\\nThe position can be set by calling `joystick_set_hat(value)`. The range of values moves clockwise from the top (ie. north), with the default \\\"center\\\" position represented by a value of `-1`:\\n\\n```\\n 0\\n 7 N 1\\n NW .--'--. NE\\n / \\\\\\n6 W | -1 | E 2\\n \\\\ /\\n SW '--.--' SE\\n 5 S 3\\n 4\\n```\\n\\nAlternatively you can use these predefined names:\\n\\n|Define |Value|Angle|\\n|------------------------|-----|-----|\\n|`JOYSTICK_HAT_CENTER` |`-1` | |\\n|`JOYSTICK_HAT_NORTH` |`0` |0\\u00b0 |\\n|`JOYSTICK_HAT_NORTHEAST`|`1` |45\\u00b0 |\\n|`JOYSTICK_HAT_EAST` |`2` |90\\u00b0 |\\n|`JOYSTICK_HAT_SOUTHEAST`|`3` |135\\u00b0 |\\n|`JOYSTICK_HAT_SOUTH` |`4` |180\\u00b0 |\\n|`JOYSTICK_HAT_SOUTHWEST`|`5` |225\\u00b0 |\\n|`JOYSTICK_HAT_WEST` |`6` |270\\u00b0 |\\n|`JOYSTICK_HAT_NORTHWEST`|`7` |315\\u00b0 |\", \"Axes {#axes}\": {\"Virtual Axes {#virtual-axes}\": \"The following example adjusts two virtual axes (X and Y) based on keypad presses, with `KC_P0` as a precision modifier:\\n\\n```\\njoystick_config_t joystick_axes[JOYSTICK_AXIS_COUNT] = {\\n JOYSTICK_AXIS_VIRTUAL, // x\\n JOYSTICK_AXIS_VIRTUAL // y\\n};\\n\\nstatic bool precision = false;\\nstatic uint16_t precision_mod = 64;\\nstatic uint16_t axis_val = 127;\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n int16_t precision_val = axis_val;\\n if (precision) {\\n precision_val -= precision_mod;\\n }\\n\\n switch (keycode) {\\n case KC_P8:\\n joystick_set_axis(1, record->event.pressed ? -precision_val : 0);\\n return false;\\n case KC_P2:\\n joystick_set_axis(1, record->event.pressed ? precision_val : 0);\\n return false;\\n case KC_P4:\\n joystick_set_axis(0, record->event.pressed ? -precision_val : 0);\\n return false;\\n case KC_P6:\\n joystick_set_axis(0, record->event.pressed ? precision_val : 0);\\n return false;\\n case KC_P0:\\n precision = record->event.pressed;\\n return false;\\n }\\n return true;\\n}\\n```\"}}, \"Keycodes {#keycodes}\": \"|Key |Aliases|Description|\\n|-----------------------|-------|-----------|\\n|`QK_JOYSTICK_BUTTON_0` |`JS_0` |Button 0 |\\n|`QK_JOYSTICK_BUTTON_1` |`JS_1` |Button 1 |\\n|`QK_JOYSTICK_BUTTON_2` |`JS_2` |Button 2 |\\n|`QK_JOYSTICK_BUTTON_3` |`JS_3` |Button 3 |\\n|`QK_JOYSTICK_BUTTON_4` |`JS_4` |Button 4 |\\n|`QK_JOYSTICK_BUTTON_5` |`JS_5` |Button 5 |\\n|`QK_JOYSTICK_BUTTON_6` |`JS_6` |Button 6 |\\n|`QK_JOYSTICK_BUTTON_7` |`JS_7` |Button 7 |\\n|`QK_JOYSTICK_BUTTON_8` |`JS_8` |Button 8 |\\n|`QK_JOYSTICK_BUTTON_9` |`JS_9` |Button 9 |\\n|`QK_JOYSTICK_BUTTON_10`|`JS_10`|Button 10 |\\n|`QK_JOYSTICK_BUTTON_11`|`JS_11`|Button 11 |\\n|`QK_JOYSTICK_BUTTON_12`|`JS_12`|Button 12 |\\n|`QK_JOYSTICK_BUTTON_13`|`JS_13`|Button 13 |\\n|`QK_JOYSTICK_BUTTON_14`|`JS_14`|Button 14 |\\n|`QK_JOYSTICK_BUTTON_15`|`JS_15`|Button 15 |\\n|`QK_JOYSTICK_BUTTON_16`|`JS_16`|Button 16 |\\n|`QK_JOYSTICK_BUTTON_17`|`JS_17`|Button 17 |\\n|`QK_JOYSTICK_BUTTON_18`|`JS_18`|Button 18 |\\n|`QK_JOYSTICK_BUTTON_19`|`JS_19`|Button 19 |\\n|`QK_JOYSTICK_BUTTON_20`|`JS_20`|Button 20 |\\n|`QK_JOYSTICK_BUTTON_21`|`JS_21`|Button 21 |\\n|`QK_JOYSTICK_BUTTON_22`|`JS_22`|Button 22 |\\n|`QK_JOYSTICK_BUTTON_23`|`JS_23`|Button 23 |\\n|`QK_JOYSTICK_BUTTON_24`|`JS_24`|Button 24 |\\n|`QK_JOYSTICK_BUTTON_25`|`JS_25`|Button 25 |\\n|`QK_JOYSTICK_BUTTON_26`|`JS_26`|Button 26 |\\n|`QK_JOYSTICK_BUTTON_27`|`JS_27`|Button 27 |\\n|`QK_JOYSTICK_BUTTON_28`|`JS_28`|Button 28 |\\n|`QK_JOYSTICK_BUTTON_29`|`JS_29`|Button 29 |\\n|`QK_JOYSTICK_BUTTON_30`|`JS_30`|Button 30 |\\n|`QK_JOYSTICK_BUTTON_31`|`JS_31`|Button 31 |\", \"API {#api}\": {\"`struct joystick_t` {#api-joystick-t}\": {\"Members {#api-joystick-t-members}\": [\"`uint8_t buttons[]` \\nA bit-packed array containing the joystick button states. The size is calculated as `(JOYSTICK_BUTTON_COUNT - 1) / 8 + 1`.\", \"`int16_t axes[]` \\nAn array of analog values for each defined axis.\", \"`int8_t hat` \\nThe hat switch position.\", \"`bool dirty` \\nWhether the current state needs to be sent to the host.\"]}, \"`struct joystick_config_t` {#api-joystick-config-t}\": {\"Members {#api-joystick-config-t-members}\": [\"`pin_t input_pin` \\nThe pin to read the analog value from, or `JS_VIRTUAL_AXIS`.\", \"`uint16_t min_digit` \\nThe minimum analog value.\", \"`uint16_t mid_digit` \\nThe resting or midpoint analog value.\", \"`uint16_t max_digit` \\nThe maximum analog value.\"]}, \"`void joystick_flush(void)` {#api-joystick-flush}\": \"Send the joystick report to the host, if it has been marked as dirty.\\n\\n[]\", \"`void register_joystick_button(uint8_t button)` {#api-register-joystick-button}\": {\"Arguments {#api-register-joystick-button-arguments}\": [\"`uint8_t button` \\nThe index of the button to press, from 0 to 31.\"]}, \"`void unregister_joystick_button(uint8_t button)` {#api-unregister-joystick-button}\": {\"Arguments {#api-unregister-joystick-button-arguments}\": [\"`uint8_t button` \\nThe index of the button to release, from 0 to 31.\"]}, \"`int16_t joystick_read_axis(uint8_t axis)` {#api-joystick-read-axis}\": {\"Arguments {#api-joystick-read-axis-arguments}\": [\"`uint8_t axis` \\nThe axis to read.\"], \"Return Value {#api-joystick-read-axis-return}\": \"A signed 16-bit integer, where 0 is the resting or mid point.\"}, \"`void joystick_set_axis(uint8_t axis, int16_t value)` {#api-joystick-set-axis}\": {\"Arguments {#api-joystick-set-axis-arguments}\": [\"`uint8_t axis` \\nThe axis to set the value of.\", \"`int16_t value` \\nThe value to set.\"]}, \"`void joystick_set_hat(int8_t value)` {#api-joystick-set-hat}\": {\"Arguments {#api-joystick-set-hat-arguments}\": [\"`int8_t value` \\nThe hat switch position to set.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 16]\"}, {\"title\": \"Key Lock\", \"description\": null, \"content\": {\"Usage\": \"First, enable Key Lock by setting `KEY_LOCK_ENABLE = yes` in your `rules.mk`. Then pick a key in your keymap and assign it the keycode `QK_LOCK`.\", \"Keycodes\": \"|Keycode |Description |\\n|---------|--------------------------------------------------------------|\\n|`QK_LOCK`|Hold down the next key pressed, until the key is pressed again|\", \"Caveats\": \"Key Lock is only able to hold standard action keys and [One Shot modifier](../one_shot_keys) keys (for example, if you have your Shift defined as `OSM(MOD_LSFT)`).\\nThis does not include any of the QMK special functions (except One Shot modifiers), or shifted versions of keys such as `KC_LPRN`. If it's in the [Basic Keycodes](../keycodes_basic) list, it can be held.\\n\\nSwitching layers will not cancel the Key Lock. The Key Lock can be cancelled by calling the `cancel_key_lock()` function.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 17]\"}, {\"title\": \"Key Overrides {#key-overrides}\", \"description\": null, \"content\": {\"Setup {#setup}\": \"To enable this feature, you need to add `KEY_OVERRIDE_ENABLE = yes` to your `rules.mk`.\\n\\nThen, in your `keymap.c` file, you'll need to define the array `key_overrides`, which defines all key overrides to be used. Each override is a value of type `key_override_t`. The array `key_overrides`contains pointers to `key_override_t` values (`const key_override_t **`).\", \"Creating Key Overrides {#creating-key-overrides}\": \"The `key_override_t` struct has many options that allow you to precisely tune your overrides. The full reference is shown below. Instead of manually creating a `key_override_t` value, it is recommended to use these dedicated initializers:\\n\\n`ko_make_basic(modifiers, key, replacement)`\\n\\nReturns a `key_override_t`, which sends `replacement` (can be a key-modifier combination), when `key` and `modifiers` are all pressed down. This override still activates if any additional modifiers not specified in `modifiers` are also pressed down. See `ko_make_with_layers_and_negmods` to customize this behavior.\\n\\n`ko_make_with_layers(modifiers, key, replacement, layers)`\\n\\nAdditionally takes a bitmask `layers` that defines on which layers the override is used.\\n\\n`ko_make_with_layers_and_negmods(modifiers, key, replacement, layers, negative_mods)`\\n\\nAdditionally takes a bitmask `negative_mods` that defines which modifiers may not be pressed for this override to activate.\\n\\n`ko_make_with_layers_negmods_and_options(modifiers, key, replacement, layers, negative_mods, options)`\\n\\nAdditionally takes a bitmask `options` that specifies additional options. See `ko_option_t` for available options.\\n\\nFor more customization possibilities, you may directly create a `key_override_t`, which allows you to customize even more behavior. Read further below for details and examples.\", \"Simple Example {#simple-example}\": \"This shows how the mentioned example of sending `delete` when `shift` + `backspace` are pressed is realized:\\n\\n```\\nconst key_override_t delete_key_override = ko_make_basic(MOD_MASK_SHIFT, KC_BSPC, KC_DEL);\\n\\n// This globally defines all key overrides to be used\\nconst key_override_t *key_overrides[] = {\\n &delete_key_override\\n};\\n```\", \"Intermediate Difficulty Examples {#intermediate-difficulty-examples}\": {\"Media Controls & Screen Brightness {#media-controls-amp-screen-brightness}\": \"In this example a single key is configured to control media, volume and screen brightness by using key overrides.\\n\\n['The key is set to send `play/pause` in the keymap.']\\n\\nThe following key overrides will be configured:\\n\\n['`Ctrl` + `play/pause` will send `next track`.', '`Ctrl` + `Shift` + `play/pause` will send `previous track`. ', '`Alt` + `play/pause` will send `volume up`. ', '`Alt` + `Shift` + `play/pause` will send `volume down`.', '`Ctrl` + `Alt` + `play/pause` will send `brightness up`.', '`Ctrl` + `Alt` + `Shift` + `play/pause` will send `brightness down`.']\\n\\n```\\nconst key_override_t next_track_override = \\n ko_make_with_layers_negmods_and_options(\\n MOD_MASK_CTRL, // Trigger modifiers: ctrl\\n KC_MPLY, // Trigger key: play/pause\\n KC_MNXT, // Replacement key\\n ~0, // Activate on all layers\\n MOD_MASK_SA, // Do not activate when shift or alt are pressed\\n ko_option_no_reregister_trigger); // Specifies that the play key is not registered again after lifting ctrl\\n \\nconst key_override_t prev_track_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CS, KC_MPLY,\\n KC_MPRV, ~0, MOD_MASK_ALT, ko_option_no_reregister_trigger);\\n\\nconst key_override_t vol_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_ALT, KC_MPLY,\\n KC_VOLU, ~0, MOD_MASK_CS, ko_option_no_reregister_trigger);\\n\\nconst key_override_t vol_down_override = ko_make_with_layers_negmods_and_options(MOD_MASK_SA, KC_MPLY,\\n KC_VOLD, ~0, MOD_MASK_CTRL, ko_option_no_reregister_trigger);\\n\\nconst key_override_t brightness_up_override = ko_make_with_layers_negmods_and_options(MOD_MASK_CA, KC_MPLY,\\n KC_BRIU, ~0, MOD_MASK_SHIFT, ko_option_no_reregister_trigger);\\n\\nconst key_override_t brightness_down_override = ko_make_basic(MOD_MASK_CSA, KC_MPLY, KC_BRID);\\n\\n// This globally defines all key overrides to be used\\nconst key_override_t *key_overrides[] = {\\n &next_track_override,\\n &prev_track_override,\\n &vol_up_override,\\n &vol_down_override,\\n &brightness_up_override,\\n &brightness_down_override\\n};\\n```\", \"Flexible macOS-friendly Grave Escape {#flexible-macos-friendly-grave-escape}\": \"The [Grave Escape feature](grave_esc) is limited in its configurability and has [bugs when used on macOS](grave_esc#caveats). Key overrides can be used to achieve a similar functionality as Grave Escape, but with more customization and without bugs on macOS.\\n\\n```\\n// Shift + esc = ~\\nconst key_override_t tilde_esc_override = ko_make_basic(MOD_MASK_SHIFT, KC_ESC, S(KC_GRV));\\n\\n// GUI + esc = `\\nconst key_override_t grave_esc_override = ko_make_basic(MOD_MASK_GUI, KC_ESC, KC_GRV);\\n\\nconst key_override_t *key_overrides[] = {\\n &tilde_esc_override,\\n &grave_esc_override\\n};\\n```\\n\\nIn addition to not encountering unexpected bugs on macOS, you can also change the behavior as you wish. Instead setting `GUI` + `ESC` = `` ` `` you may change it to an arbitrary other modifier, for example `Ctrl` + `ESC` = `` ` ``.\"}, \"Advanced Examples {#advanced-examples}\": {\"Modifiers as Layer Keys {#modifiers-as-layer-keys}\": \"Do you really need a dedicated key to toggle your fn layer? With key overrides, perhaps not. This example shows how you can configure to use `rGUI` + `rAlt` (right GUI and right alt) to access a momentary layer like an fn layer. With this you completely eliminate the need to use a dedicated layer key. Of course the choice of modifier keys can be changed as needed, `rGUI` + `rAlt` is just an example here. \\n\\n```\\n// This is called when the override activates and deactivates. Enable the fn layer on activation and disable on deactivation\\nbool momentary_layer(bool key_down, void *layer) {\\n if (key_down) {\\n layer_on((uint8_t)(uintptr_t)layer);\\n } else {\\n layer_off((uint8_t)(uintptr_t)layer);\\n }\\n\\n return false;\\n}\\n\\nconst key_override_t fn_override = {.trigger_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //\\n .layers = ~(1 << LAYER_FN), //\\n .suppressed_mods = MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT), //\\n .options = ko_option_no_unregister_on_other_key_down, //\\n .negative_mod_mask = (uint8_t) ~(MOD_BIT(KC_RGUI) | MOD_BIT(KC_RALT)), //\\n .custom_action = momentary_layer, //\\n .context = (void *)LAYER_FN, //\\n .trigger = KC_NO, //\\n .replacement = KC_NO, //\\n .enabled = NULL};\\n```\"}, \"Keycodes {#keycodes}\": \"|Keycode |Aliases |Description |\\n|------------------------|---------|----------------------|\\n|`QK_KEY_OVERRIDE_TOGGLE`|`KO_TOGG`|Toggle key overrides |\\n|`QK_KEY_OVERRIDE_ON` |`KO_ON` |Turn on key overrides |\\n|`QK_KEY_OVERRIDE_OFF` |`KO_OFF` |Turn off key overrides|\", \"Reference for `key_override_t` {#reference-for-key_override_t}\": \"Advanced users may need more customization than what is offered by the simple `ko_make` initializers. For this, directly create a `key_override_t` value and set all members. Below is a reference for all members of `key_override_t`.\\n\\n| Member | Description |\\n|--------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\\n| `uint16_t trigger` | The non-modifier keycode that triggers the override. This keycode, and the necessary modifiers (`trigger_mods`) must be pressed to activate this override. Set this to the keycode of the key that should activate the override. Set to `KC_NO` to require only the necessary modifiers to be pressed and no non-modifier. |\\n| `uint8_t trigger_mods` | Which mods need to be down for activation. If both sides of a modifier are set (e.g. left ctrl and right ctrl) then only one is required to be pressed (e.g. left ctrl suffices). Use the `MOD_MASK_XXX` and `MOD_BIT()` macros for this. |\\n| `layer_state_t layers` | This is a BITMASK (!), defining which layers this override applies to. To use this override on layer i set the ith bit `(1 << i)`. |\\n| `uint8_t negative_mod_mask` | Which modifiers cannot be down. It must hold that `(active_modifiers & negative_mod_mask) == 0`, otherwise the key override will not be activated. An active override will be deactivated once this is no longer true. |\\n| `uint8_t suppressed_mods` | Modifiers to 'suppress' while the override is active. To suppress a modifier means that even though the modifier key is held down, the host OS sees the modifier as not pressed. Can be used to suppress the trigger modifiers, as a trivial example. |\\n| `uint16_t replacement` | The complex keycode to send as replacement when this override is triggered. This can be a simple keycode, a key-modifier combination (e.g. `C(KC_A)`), or `KC_NO` (to register no replacement keycode). Use in combination with suppressed_mods to get the correct modifiers to be sent. |\\n| `ko_option_t options` | Options controlling the behavior of the override, such as what actions are allowed to activate the override. |\\n| `bool (*custom_action)(bool activated, void *context)` | If not NULL, this function will be called right before the replacement key is registered, along with the provided context and a flag indicating whether the override was activated or deactivated. This function allows you to run some custom actions for specific key overrides. If you return `false`, the replacement key is not registered/unregistered as it would normally. Return `true` to register and unregister the override normally. |\\n| `void *context` | A context that will be passed to the custom action function. |\\n| `bool *enabled` | If this points to false this override will not be used. Set to NULL to always have this override enabled. |\", \"Reference for `ko_option_t` {#reference-for-ko_option_t}\": \"Bitfield with various options controlling the behavior of a key override.\\n\\n| Value | Description |\\n|------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\\n| `ko_option_activation_trigger_down` | Allow activating when the trigger key is pressed down. |\\n| `ko_option_activation_required_mod_down` | Allow activating when a necessary modifier is pressed down. |\\n| `ko_option_activation_negative_mod_up` | Allow activating when a negative modifier is released. |\\n| `ko_option_one_mod` | If set, any of the modifiers in `trigger_mods` will be enough to activate the override (logical OR of modifiers). If not set, all the modifiers in `trigger_mods` have to be pressed (logical AND of modifiers). |\\n| `ko_option_no_unregister_on_other_key_down` | If set, the override will not deactivate when another key is pressed down. Use only if you really know you need this. |\\n| `ko_option_no_reregister_trigger` | If set, the trigger key will never be registered again after the override is deactivated. |\\n| `ko_options_default` | The default options used by the `ko_make_xxx` functions |\", \"For Advanced Users: Inner Workings {#for-advanced-users-inner-workings}\": \"This section explains how a key override works in detail, explaining where each member of `key_override_t` comes into play. Understanding this is essential to be able to take full advantage of all the options offered by key overrides.\\n\\nActivation {#activation}\\n\\nWhen the necessary keys are pressed (`trigger_mods` + `trigger`), the override is 'activated' and the replacement key is registered in the keyboard report (`replacement`), while the `trigger` key is removed from the keyboard report. The trigger modifiers may also be removed from the keyboard report upon activation of an override (`suppressed_mods`). The override will not activate if any of the `negative_modifiers` are pressed.\\n\\nOverrides can activate in three different cases:\\n\\n['The trigger key is pressed down and necessary modifiers are already down.', 'A necessary modifier is pressed down, while the trigger key and other necessary modifiers are already down.', 'A negative modifier is released, while all necessary modifiers and the trigger key are already down.']\\n\\nUse the `option` member to customize which of these events are allowed to activate your overrides (default: all three).\\n\\nIn any case, a key override can only activate if the `trigger` key is the _last_ non-modifier key that was pressed down. This emulates the behavior of how standard OSes (macOS, Windows, Linux) handle normal key input (to understand: Hold down `a`, then also hold down `b`, then hold down `shift`; `B` will be typed but not `A`).\\n\\nDeactivation {#deactivation}\\n\\nAn override is 'deactivated' when one of the trigger keys (`trigger_mods`, `trigger`) is lifted, another non-modifier key is pressed down, or one of the `negative_modifiers` is pressed down. When an override deactivates, the `replacement` key is removed from the keyboard report, while the `suppressed_mods` that are still held down are re-added to the keyboard report. By default, the `trigger` key is re-added to the keyboard report if it is still held down and no other non-modifier key has been pressed since. This again emulates the behavior of how standard OSes handle normal key input (To understand: hold down `a`, then also hold down `b`, then also `shift`, then release `b`; `A` will not be typed even though you are holding the `a` and `shift` keys). Use the `option` field `ko_option_no_reregister_trigger` to prevent re-registering the trigger key in all cases.\\n\\nKey Repeat Delay {#key-repeat-delay}\\n\\nA third way in which standard OS-handling of modifier-key input is emulated in key overrides is with a ['key repeat delay'](https://www.dummies.com/computers/pcs/set-your-keyboards-repeat-delay-and-repeat-rate/). To explain what this is, let's look at how normal keyboard input is handled by mainstream OSes again: If you hold down `a`, followed by `shift`, you will see the letter `a` is first typed, then for a short moment nothing is typed and then repeating `A`s are typed. Take note that, although shift is pressed down just after `a` is pressed, it takes a moment until `A` is typed. This is caused by the aforementioned key repeat delay, and it is a feature that prevents unwanted repeated characters from being typed.\\n\\nThis applies equally to releasing a modifier: When you hold `shift`, then press `a`, the letter `A` is typed. Now if you release `shift` first, followed by `a` shortly after, you will not see the letter `a` being typed, even though for a short moment of time you were just holding down the key `a`. This is because no modified characters are typed until the key repeat delay has passed.\\n\\nThis exact behavior is implemented in key overrides as well: If a key override for `shift` + `a` = `b` exists, and `a` is pressed and held, followed by `shift`, you will not immediately see the letter `b` being typed. Instead, this event is deferred for a short moment, until the key repeat delay has passed, measured from the moment when the trigger key (`a`) was pressed down.\\n\\nThe duration of the key repeat delay is controlled with the `KEY_OVERRIDE_REPEAT_DELAY` macro. Define this value in your `config.h` file to change it. It is 500ms by default.\", \"Difference to Combos {#difference-to-combos}\": \"Note that key overrides are very different from [combos](combo). Combos require that you press down several keys almost _at the same time_ and can work with any combination of non-modifier keys. Key overrides work like keyboard shortcuts (e.g. `ctrl` + `z`): They take combinations of _multiple_ modifiers and _one_ non-modifier key to then perform some custom action. Key overrides are implemented with much care to behave just like normal keyboard shortcuts would in regards to the order of pressed keys, timing, and interaction with other pressed keys. There are a number of optional settings that can be used to really fine-tune the behavior of each key override as well. Using key overrides also does not delay key input for regular key presses, which inherently happens in combos and may be undesirable.\", \"Solution to the problem of flashing modifiers {#neutralize-flashing-modifiers}\": \"If the programs you use bind an action to taps of modifier keys (e.g. tapping left GUI to bring up the applications menu or tapping left Alt to focus the menu bar), you may find that using key overrides with suppressed mods falsely triggers those actions. To counteract this, you can define a `DUMMY_MOD_NEUTRALIZER_KEYCODE` in `config.h` that will get sent in between the register and unregister events of a suppressed modifier. That way, the programs on your computer will no longer interpret the mod suppression induced by key overrides as a lone tap of a modifier key and will thus not falsely trigger the undesired action.\\n\\nNaturally, for this technique to be effective, you must choose a `DUMMY_MOD_NEUTRALIZER_KEYCODE` for which no keyboard shortcuts are bound to. Recommended values are: `KC_RIGHT_CTRL` or `KC_F18`. \\nPlease note that `DUMMY_MOD_NEUTRALIZER_KEYCODE` must be a basic, unmodified, HID keycode so values like `KC_NO`, `KC_TRANSPARENT` or `KC_PIPE` aka `S(KC_BACKSLASH)` are not permitted.\\n\\nBy default, only left Alt and left GUI are neutralized. If you want to change the list of applicable modifier masks, use the following in your `config.h`:\\n\\n```\\n#define MODS_TO_NEUTRALIZE { <mod_mask_1>, <mod_mask_2>, ... }\\n```\\n\\nExamples:\\n\\n```\\n#define DUMMY_MOD_NEUTRALIZER_KEYCODE KC_RIGHT_CTRL\\n\\n// Neutralize left alt and left GUI (Default value)\\n#define MODS_TO_NEUTRALIZE { MOD_BIT(KC_LEFT_ALT), MOD_BIT(KC_LEFT_GUI) }\\n\\n// Neutralize left alt, left GUI, right GUI and left Control+Shift\\n#define MODS_TO_NEUTRALIZE { MOD_BIT(KC_LEFT_ALT), MOD_BIT(KC_LEFT_GUI), MOD_BIT(KC_RIGHT_GUI), MOD_BIT(KC_LEFT_CTRL)|MOD_BIT(KC_LEFT_SHIFT) }\\n```\\n\\n::: warning\\nDo not use `MOD_xxx` constants like `MOD_LSFT` or `MOD_RALT`, since they're 5-bit packed bit-arrays while `MODS_TO_NEUTRALIZE` expects a list of 8-bit packed bit-arrays. Use `MOD_BIT(<kc>)` or `MOD_MASK_xxx` instead.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 18]\"}, {\"title\": \"Layer Lock\", \"description\": null, \"content\": {\"How do I enable Layer Lock\": \"In your rules.mk, add:\\n\\n```\\nLAYER_LOCK_ENABLE = yes\\n```\\n\\nPick a key in your keymap on a layer you intend to lock, and assign it the\\nkeycode `QK_LAYER_LOCK` (short alias `QK_LLCK`). Note that locking the base\\nlayer has no effect, so typically, this key is used on layers above the base\\nlayer.\", \"Example use\": \"Consider a keymap with the following base layer.\\n\\n\\n\\nThe highlighted key is a momentary layer switch `MO(NAV)`. Holding it accesses a\\nnavigation layer.\\n\\n\\n\\nHolding the NAV key is fine for brief use, but awkward to continue holding when\\nusing navigation functions continuously. The Layer Lock key comes to the rescue:\\n\\n['Hold the NAV key, activating the navigation layer.', 'Tap Layer Lock.', 'Release NAV. The navigation layer stays on.', 'Make use of the arrow keys, etc.', 'Tap Layer Lock or NAV again to turn the navigation layer back off.']\\n\\nA variation that would also work is to put the Layer Lock key on the base layer\\nand make other layers transparent (`KC_TRNS`) in that position. Pressing the\\nLayer Lock key locks (or unlocks) the highest active layer, regardless of which\\nlayer the Layer Lock key is on.\", \"Idle timeout\": \"Optionally, Layer Lock may be configured to unlock if the keyboard is idle\\nfor some time. In config.h, define `LAYER_LOCK_IDLE_TIMEOUT` in units of\\nmilliseconds:\\n\\n```\\n#define LAYER_LOCK_IDLE_TIMEOUT 60000 // Turn off after 60 seconds.\\n```\", \"Functions\": \"Use the following functions to query and manipulate the layer lock state.\\n\\n| Function | Description |\\n|----------------------------|------------------------------------|\\n| `is_layer_locked(layer)` | Checks whether `layer` is locked. |\\n| `layer_lock_on(layer)` | Locks and turns on `layer`. |\\n| `layer_lock_off(layer)` | Unlocks and turns off `layer`. |\\n| `layer_lock_invert(layer)` | Toggles whether `layer` is locked. |\", \"Representing the current Layer Lock state\": \"There is an optional callback `layer_lock_set_user()` that gets called when a\\nlayer is locked or unlocked. This is useful to represent the current lock state\\nfor instance by setting an LED. In keymap.c, define\\n\\n```\\nbool layer_lock_set_user(layer_state_t locked_layers) {\\n // Do something like `set_led(is_layer_locked(NAV));`\\n return true;\\n}\\n```\\n\\nThe argument `locked_layers` is a bitfield in which the kth bit is on if the kth\\nlayer is locked. Alternatively, you can use `is_layer_locked(layer)` to check if\\na given layer is locked.\", \"Combine Layer Lock with a mod-tap\": \"It is possible to create a [mod-tap MT key](../mod_tap) that acts as a modifier\\non hold and Layer Lock on tap. Since Layer Lock is not a [basic\\nkeycode](../keycodes_basic), attempting `MT(mod, QK_LLCK)` is invalid does not\\nwork directly, yet this effect can be achieved through [changing the tap\\nfunction](../mod_tap#changing-tap-function). For example, the following\\nimplements a `SFTLLCK` key that acts as Shift on hold and Layer Lock on tap:\\n\\n```\\n#define SFTLLCK LSFT_T(KC_0)\\n\\n// Use SFTLLCK in your keymap...\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case SFTLLCK:\\n if (record->tap.count) {\\n if (record->event.pressed) {\\n // Toggle the lock on the highest layer.\\n layer_lock_invert(get_highest_layer(layer_state));\\n }\\n return false;\\n }\\n break;\\n\\n // Other macros...\\n }\\n return true;\\n}\\n```\\n\\nIn the above, `KC_0` is an arbitrary placeholder for the tapping keycode. This\\nkeycode will never be sent, so any basic keycode will do. In\\n`process_record_user()`, the tap press event is changed to toggle the lock on\\nthe highest layer. Layer Lock can be combined with a [layer-tap LT\\nkey](../feature_layers#switching-and-toggling-layers) similarly.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 19]\"}, {\"title\": \"The Leader Key: A New Kind of Modifier {#the-leader-key}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nLEADER_ENABLE = yes\\n```\\n\\nThen add the `QK_LEAD` keycode to your keymap.\", \"Callbacks {#callbacks}\": \"These callbacks are invoked when the leader sequence begins and ends. In the latter you can implement your custom functionality based on the contents of the sequence buffer.\\n\\n```\\nvoid leader_start_user(void) {\\n // Do something when the leader key is pressed\\n}\\n\\nvoid leader_end_user(void) {\\n if (leader_sequence_one_key(KC_F)) {\\n // Leader, f => Types the below string\\n SEND_STRING(\\\"QMK is awesome.\\\");\\n } else if (leader_sequence_two_keys(KC_D, KC_D)) {\\n // Leader, d, d => Ctrl+A, Ctrl+C\\n SEND_STRING(SS_LCTL(\\\"a\\\") SS_LCTL(\\\"c\\\"));\\n } else if (leader_sequence_three_keys(KC_D, KC_D, KC_S)) {\\n // Leader, d, d, s => Types the below string\\n SEND_STRING(\\\"https://start.duckduckgo.com\\\\n\\\");\\n } else if (leader_sequence_two_keys(KC_A, KC_S)) {\\n // Leader, a, s => GUI+S\\n tap_code16(LGUI(KC_S));\\n }\\n}\\n```\", \"Basic Configuration {#basic-configuration}\": {\"Timeout {#timeout}\": \"This is the amount of time you have to complete a sequence once the leader key has been pressed. The default value is 300 milliseconds, but you can change this by adding the following to your `config.h`:\\n\\n```\\n#define LEADER_TIMEOUT 350\\n```\", \"Per-Key Timeout {#per-key-timeout}\": \"Rather than relying on an incredibly high timeout for long leader key strings or those of us without 200 wpm typing skills, you can enable per-key timing to ensure that each key pressed provides you with more time to finish the sequence. This is incredibly helpful with leader key emulation of tap dance (such as multiple taps of the same key like C, C, C).\\n\\nTo enable this, add the following to your `config.h`:\\n\\n```\\n#define LEADER_PER_KEY_TIMING\\n```\\n\\nAfter this, it's recommended that you lower your timeout below 300 ms:\\n\\n```\\n#define LEADER_TIMEOUT 250\\n```\\n\\nNow, something like this won't seem impossible to do without a 1000 millisecond timeout:\\n\\n```\\nif (leader_sequence_three_keys(KC_C, KC_C, KC_C)) {\\n SEND_STRING(\\\"Per key timing is great!!!\\\");\\n}\\n```\", \"Disabling Initial Timeout {#disabling-initial-timeout}\": \"Sometimes your leader key may be too far away from the rest of the keys in the sequence. Imagine that your leader key is one of your outer top right keys - you may need to reposition your hand just to reach your leader key. This can make typing the entire sequence on time hard difficult if you are able to type most of the sequence fast. For example, if your sequence is `Leader + asd`, typing `asd` fast is very easy once you have your hands in your home row, but starting the sequence in time after moving your hand out of the home row to reach the leader key and back is not.\\n\\nTo remove the stress this situation produces to your hands, you can disable the timeout just for the leader key. Add the following to your `config.h`:\\n\\n```\\n#define LEADER_NO_TIMEOUT\\n```\\n\\nNow, after you hit the leader key, you will have an infinite amount of time to start the rest of the sequence, allowing you to properly position your hands to type the rest of the sequence comfortably. This way you can configure a very short `LEADER_TIMEOUT`, but still have plenty of time to position your hands.\", \"Strict Key Processing {#strict-key-processing}\": \"By default, only the \\\"tap keycode\\\" portions of [Mod-Taps](../mod_tap) and [Layer Taps](../feature_layers#switching-and-toggling-layers) are added to the sequence buffer. This means if you press eg. `LT(3, KC_A)` as part of a sequence, `KC_A` will be added to the buffer, rather than the entire `LT(3, KC_A)` keycode.\\n\\nThis gives a more expected behaviour for most users, however you may want to change this.\\n\\nTo enable this, add the following to your `config.h`:\\n\\n```\\n#define LEADER_KEY_STRICT_KEY_PROCESSING\\n```\"}, \"Example {#example}\": \"This example will play the Mario \\\"One Up\\\" sound when you hit `QK_LEAD` to start the leader sequence. When the sequence ends, it will play \\\"All Star\\\" if it completes successfully or \\\"Rick Roll\\\" you if it fails (in other words, no sequence matched).\\n\\n```\\n#ifdef AUDIO_ENABLE\\nfloat leader_start_song[][2] = SONG(ONE_UP_SOUND);\\nfloat leader_succeed_song[][2] = SONG(ALL_STAR);\\nfloat leader_fail_song[][2] = SONG(RICK_ROLL);\\n#endif\\n\\nvoid leader_start_user(void) {\\n#ifdef AUDIO_ENABLE\\n PLAY_SONG(leader_start_song);\\n#endif\\n}\\n\\nvoid leader_end_user(void) {\\n bool did_leader_succeed = false;\\n\\n if (leader_sequence_one_key(KC_E)) {\\n SEND_STRING(SS_LCTL(SS_LSFT(\\\"t\\\")));\\n did_leader_succeed = true;\\n } else if (leader_sequence_two_keys(KC_E, KC_D)) {\\n SEND_STRING(SS_LGUI(\\\"r\\\") \\\"cmd\\\\n\\\" SS_LCTL(\\\"c\\\"));\\n did_leader_succeed = true;\\n }\\n\\n#ifdef AUDIO_ENABLE\\n if (did_leader_succeed) {\\n PLAY_SONG(leader_succeed_song);\\n } else {\\n PLAY_SONG(leader_fail_song);\\n }\\n#endif\\n}\\n```\", \"Keycodes {#keycodes}\": \"|Key |Aliases |Description |\\n|-----------------------|---------|-------------------------|\\n|`QK_LEADER` |`QK_LEAD`|Begin the leader sequence|\", \"API {#api}\": {\"`void leader_start_user(void)` {#api-leader-start-user}\": \"User callback, invoked when the leader sequence begins.\\n\\n[]\", \"`void leader_end_user(void)` {#api-leader-end-user}\": \"User callback, invoked when the leader sequence ends.\\n\\n[]\", \"`bool leader_add_user(uint16_t keycode)` {#api-leader-add-user}\": {\"Arguments {#api-leader-add-user-arguments}\": [\"`uint16_t keycode` \\nThe keycode to added to the leader sequence.\"], \"Return Value {#api-leader-add-user-return}\": \"`true` to finish the key sequence, `false` to continue.\\n\\n[]\"}, \"`void leader_start(void)` {#api-leader-start}\": \"Begin the leader sequence, resetting the buffer and timer.\\n\\n[]\", \"`void leader_end(void)` {#api-leader-end}\": \"End the leader sequence.\\n\\n[]\", \"`bool leader_sequence_active(void)` {#api-leader-sequence-active}\": \"Whether the leader sequence is active.\\n\\n[]\", \"`bool leader_sequence_add(uint16_t keycode)` {#api-leader-sequence-add}\": {\"Arguments {#api-leader-sequence-add-arguments}\": [\"`uint16_t keycode` \\nThe keycode to add.\"], \"Return Value {#api-leader-sequence-add-return}\": \"`true` if the keycode was added, `false` if the buffer is full.\\n\\n[]\"}, \"`bool leader_sequence_timed_out(void)` {#api-leader-sequence-timed-out}\": \"Whether the leader sequence has reached the timeout.\\n\\nIf `LEADER_NO_TIMEOUT` is defined, the buffer must also contain at least one key.\\n\\n[]\", \"`bool leader_reset_timer(void)` {#api-leader-reset-timer}\": \"Reset the leader sequence timer.\\n\\n[]\", \"`bool leader_sequence_one_key(uint16_t kc)` {#api-leader-sequence-one-key}\": {\"Arguments {#api-leader-sequence-one-key-arguments}\": [\"`uint16_t kc` \\nThe keycode to check.\"], \"Return Value {#api-leader-sequence-one-key-return}\": \"`true` if the sequence buffer matches.\\n\\n[]\"}, \"`bool leader_sequence_two_keys(uint16_t kc1, uint16_t kc2)` {#api-leader-sequence-two-keys}\": {\"Arguments {#api-leader-sequence-two-keys-arguments}\": [\"`uint16_t kc1` \\nThe first keycode to check.\", \"`uint16_t kc2` \\nThe second keycode to check.\"], \"Return Value {#api-leader-sequence-two-keys-return}\": \"`true` if the sequence buffer matches.\\n\\n[]\"}, \"`bool leader_sequence_three_keys(uint16_t kc1, uint16_t kc2, uint16_t kc3)` {#api-leader-sequence-three-keys}\": {\"Arguments {#api-leader-sequence-three-keys-arguments}\": [\"`uint16_t kc1` \\nThe first keycode to check.\", \"`uint16_t kc2` \\nThe second keycode to check.\", \"`uint16_t kc3` \\nThe third keycode to check.\"], \"Return Value {#api-leader-sequence-three-keys-return}\": \"`true` if the sequence buffer matches.\\n\\n[]\"}, \"`bool leader_sequence_four_keys(uint16_t kc1, uint16_t kc2, uint16_t kc3, uint16_t kc4)` {#api-leader-sequence-four-keys}\": {\"Arguments {#api-leader-sequence-four-keys-arguments}\": [\"`uint16_t kc1` \\nThe first keycode to check.\", \"`uint16_t kc2` \\nThe second keycode to check.\", \"`uint16_t kc3` \\nThe third keycode to check.\", \"`uint16_t kc4` \\nThe fourth keycode to check.\"], \"Return Value {#api-leader-sequence-four-keys-return}\": \"`true` if the sequence buffer matches.\\n\\n[]\"}, \"`bool leader_sequence_five_keys(uint16_t kc1, uint16_t kc2, uint16_t kc3, uint16_t kc4, uint16_t kc5)` {#api-leader-sequence-five-keys}\": {\"Arguments {#api-leader-sequence-five-keys-arguments}\": [\"`uint16_t kc1` \\nThe first keycode to check.\", \"`uint16_t kc2` \\nThe second keycode to check.\", \"`uint16_t kc3` \\nThe third keycode to check.\", \"`uint16_t kc4` \\nThe fourth keycode to check.\", \"`uint16_t kc5` \\nThe fifth keycode to check.\"], \"Return Value {#api-leader-sequence-five-keys-return}\": \"`true` if the sequence buffer matches.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 20]\"}, {\"title\": \"LED Indicators\", \"description\": null, \"content\": {\"Configuration Options\": \"To configure the indicators, `#define` these in your `config.h`:\\n\\n|Define |Default |Description |\\n|---------------------|-------------|-------------------------------------------|\\n|`LED_NUM_LOCK_PIN` |*Not defined*|The pin that controls the `Num Lock` LED |\\n|`LED_CAPS_LOCK_PIN` |*Not defined*|The pin that controls the `Caps Lock` LED |\\n|`LED_SCROLL_LOCK_PIN`|*Not defined*|The pin that controls the `Scroll Lock` LED|\\n|`LED_COMPOSE_PIN` |*Not defined*|The pin that controls the `Compose` LED |\\n|`LED_KANA_PIN` |*Not defined*|The pin that controls the `Kana` LED |\\n|`LED_PIN_ON_STATE` |`1` |The state of the indicator pins when the LED is \\\"on\\\" - `1` for high, `0` for low|\\n\\nUnless you are designing your own keyboard, you generally should not need to change the above config options.\", \"LED update function\": {\"Example of keyboard LED update implementation\": \"This is a template indicator function that can be implemented on keyboard level code:\\n\\n```\\nbool led_update_kb(led_t led_state) {\\n bool res = led_update_user(led_state);\\n if(res) {\\n // gpio_write_pin sets the pin high for 1 and low for 0.\\n // In this example the pins are inverted, setting\\n // it low/0 turns it on, and high/1 turns the LED off.\\n // This behavior depends on whether the LED is between the pin\\n // and VCC or the pin and GND.\\n gpio_write_pin(B0, !led_state.num_lock);\\n gpio_write_pin(B1, !led_state.caps_lock);\\n gpio_write_pin(B2, !led_state.scroll_lock);\\n gpio_write_pin(B3, !led_state.compose);\\n gpio_write_pin(B4, !led_state.kana);\\n }\\n return res;\\n}\\n```\", \"Example of user LED update implementation\": \"This is an incomplete example will play a sound if Caps Lock is turned on or off. It returns `true` to allow keyboard LED function to maintain their state.\\n\\n```\\n#ifdef AUDIO_ENABLE\\n float caps_on[][2] = SONG(CAPS_LOCK_ON_SOUND);\\n float caps_off[][2] = SONG(CAPS_LOCK_OFF_SOUND);\\n#endif\\n\\nbool led_update_user(led_t led_state) {\\n #ifdef AUDIO_ENABLE\\n static uint8_t caps_state = 0;\\n if (caps_state != led_state.caps_lock) {\\n led_state.caps_lock ? PLAY_SONG(caps_on) : PLAY_SONG(caps_off);\\n caps_state = led_state.caps_lock;\\n }\\n #endif\\n return true;\\n}\\n```\"}, \"Host keyboard LED state \": \"The `host_keyboard_led_state()` function will report the LED state returned from the host computer as `led_t`. This is useful for reading the LED state outside `led_update_*`. For example, you can get the boolean state of Caps Lock from the host with:\\n\\n```\\nbool caps = host_keyboard_led_state().caps_lock;\\n```\", \"`led_update_ports()`\": \"This function writes the LED state to the actual hardware. Call it manually\\nfrom your `led_update_*()` callbacks to modify the handling of the standard\\nkeyboard LEDs.\\nFor example when repurposing a standard LED indicator as layer indicator.\", \"Setting Physical LED State\": {\"Ergodox Boards\": \"The Ergodox implementations provide `ergodox_right_led_1`/`2`/`3_on`/`off()` to turn individual LEDs on or off, as well as `ergodox_right_led_on`/`off(uint8_t led)` to turn them on or off by their index.\\n\\nIn addition, it is possible to specify the brightness level of all LEDs with `ergodox_led_all_set(uint8_t n)`; of individual LEDs with `ergodox_right_led_1`/`2`/`3_set(uint8_t n)`; or by index with `ergodox_right_led_set(uint8_t led, uint8_t n)`.\\n\\nErgodox boards also define `LED_BRIGHTNESS_LO` for the lowest brightness and `LED_BRIGHTNESS_HI` for the highest brightness (which is the default).\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 21]\"}, {\"title\": \"LED Matrix Lighting {#led-matrix-lighting}\", \"description\": null, \"content\": {\"Driver Configuration {#driver-configuration}\": \"LED Matrix is an abstraction layer on top of an underlying LED driver API. The list of supported LED drivers is below; see the respective documentation for information on how to configure the driver.\\n\\n|Driver |Max LEDs|\\n|-------------------------------------|--------|\\n|[IS31FL3218](../drivers/is31fl3218) |18 |\\n|[IS31FL3236](../drivers/is31fl3236) |36 |\\n|[IS31FL3729](../drivers/is31fl3729) |135 |\\n|[IS31FL3731](../drivers/is31fl3731) |144 |\\n|[IS31FL3733](../drivers/is31fl3733) |192 |\\n|[IS31FL3736](../drivers/is31fl3736) |96 |\\n|[IS31FL3737](../drivers/is31fl3737) |144 |\\n|[IS31FL3741](../drivers/is31fl3741) |351 |\\n|[IS31FL3742A](../drivers/is31fl3742a)|180 |\\n|[IS31FL3743A](../drivers/is31fl3743a)|198 |\\n|[IS31FL3745](../drivers/is31fl3745) |144 |\\n|[IS31FL3746A](../drivers/is31fl3746a)|72 |\\n|[SNLED27351](../drivers/snled27351) |192 |\\n\\nTo assign the LED Matrix driver, add the following to your `rules.mk`, for example:\\n\\n```\\nLED_MATRIX_DRIVER = is31fl3218\\n```\", \"Common Configuration {#common-configuration}\": \"From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:\\n\\n```\\nled_config_t g_led_config = { {\\n // Key Matrix to LED Index\\n { 5, NO_LED, NO_LED, 0 },\\n { NO_LED, NO_LED, NO_LED, NO_LED },\\n { 4, NO_LED, NO_LED, 1 },\\n { 3, NO_LED, NO_LED, 2 }\\n}, {\\n // LED Index to Physical Position\\n { 188, 16 }, { 187, 48 }, { 149, 64 }, { 112, 64 }, { 37, 48 }, { 38, 16 }\\n}, {\\n // LED Index to Flag\\n 1, 4, 4, 4, 4, 1\\n} };\\n```\\n\\nThe first part, `// Key Matrix to LED Index`, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, `// LED Index to Physical Position` represents the LED's physical `{ x, y }` position on the keyboard. The default expected range of values for `{ x, y }` is the inclusive range `{ 0..224, 0..64 }`. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents `{ x, y }` coordinate `{ 0, 0 }` and the bottom right of your keyboard represents `{ 224, 64 }`. Using this as a basis, you can use the following formula to calculate the physical position:\\n\\n```\\nx = 224 / (NUMBER_OF_COLS - 1) * COL_POSITION\\ny = 64 / (NUMBER_OF_ROWS - 1) * ROW_POSITION\\n```\\n\\nWhere NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.\\n\\nAs mentioned earlier, the center of the keyboard by default is expected to be `{ 112, 32 }`, but this can be changed if you want to more accurately calculate the LED's physical `{ x, y }` positions. Keyboard designers can implement `#define LED_MATRIX_CENTER { 112, 32 }` in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the `{ x, y }` values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.\\n\\n`// LED Index to Flag` is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.\", \"Flags {#flags}\": \"|Define |Value |Description |\\n|----------------------------|------|-------------------------------------------------|\\n|`HAS_FLAGS(bits, flags)` |*n/a* |Evaluates to `true` if `bits` has all `flags` set|\\n|`HAS_ANY_FLAGS(bits, flags)`|*n/a* |Evaluates to `true` if `bits` has any `flags` set|\\n|`LED_FLAG_NONE` |`0x00`|If this LED has no flags |\\n|`LED_FLAG_ALL` |`0xFF`|If this LED has all flags |\\n|`LED_FLAG_MODIFIER` |`0x01`|If the LED is on a modifier key |\\n|`LED_FLAG_KEYLIGHT` |`0x04`|If the LED is for key backlight |\\n|`LED_FLAG_INDICATOR` |`0x08`|If the LED is for keyboard state indication |\", \"Keycodes {#keycodes}\": \"|Key |Aliases |Description |\\n|-------------------------------|---------|-----------------------------------|\\n|`QK_LED_MATRIX_ON` |`LM_ON` |Turn on LED Matrix |\\n|`QK_LED_MATRIX_OFF` |`LM_OFF` |Turn off LED Matrix |\\n|`QK_LED_MATRIX_TOGGLE` |`LM_TOGG`|Toggle LED Matrix on or off |\\n|`QK_LED_MATRIX_MODE_NEXT` |`LM_NEXT`|Cycle through animations |\\n|`QK_LED_MATRIX_MODE_PREVIOUS` |`LM_PREV`|Cycle through animations in reverse|\\n|`QK_LED_MATRIX_BRIGHTNESS_UP` |`LM_BRIU`|Increase the brightness level |\\n|`QK_LED_MATRIX_BRIGHTNESS_DOWN`|`LM_BRID`|Decrease the brightness level |\\n|`QK_LED_MATRIX_SPEED_UP` |`LM_SPDU`|Increase the animation speed |\\n|`QK_LED_MATRIX_SPEED_DOWN` |`LM_SPDD`|Decrease the animation speed |\", \"LED Matrix Effects {#led-matrix-effects}\": \"These are the effects that are currently available:\\n\\n```\\nenum led_matrix_effects {\\n LED_MATRIX_NONE = 0,\\n LED_MATRIX_SOLID = 1, // Static single val, no speed support\\n LED_MATRIX_ALPHAS_MODS, // Static dual val, speed is val for LEDs marked as modifiers\\n LED_MATRIX_BREATHING, // Cycling brightness animation\\n LED_MATRIX_BAND, // Band fading brightness scrolling left to right\\n LED_MATRIX_BAND_PINWHEEL, // 3 blade spinning pinwheel fades brightness\\n LED_MATRIX_BAND_SPIRAL, // Spinning spiral fades brightness\\n LED_MATRIX_CYCLE_LEFT_RIGHT, // Full gradient scrolling left to right\\n LED_MATRIX_CYCLE_UP_DOWN, // Full gradient scrolling top to bottom\\n LED_MATRIX_CYCLE_OUT_IN, // Full gradient scrolling out to in\\n LED_MATRIX_DUAL_BEACON, // Full gradient spinning around center of keyboard\\n LED_MATRIX_SOLID_REACTIVE_SIMPLE, // Pulses keys hit then fades out\\n LED_MATRIX_SOLID_REACTIVE_WIDE, // Value pulses near a single key hit then fades out\\n LED_MATRIX_SOLID_REACTIVE_MULTIWIDE, // Value pulses near multiple key hits then fades out\\n LED_MATRIX_SOLID_REACTIVE_CROSS, // Value pulses the same column and row of a single key hit then fades out\\n LED_MATRIX_SOLID_REACTIVE_MULTICROSS, // Value pulses the same column and row of multiple key hits then fades out\\n LED_MATRIX_SOLID_REACTIVE_NEXUS, // Value pulses away on the same column and row of a single key hit then fades out\\n LED_MATRIX_SOLID_REACTIVE_MULTINEXUS, // Value pulses away on the same column and row of multiple key hits then fades out\\n LED_MATRIX_SOLID_SPLASH, // Value pulses away from a single key hit then fades out\\n LED_MATRIX_SOLID_MULTISPLASH, // Value pulses away from multiple key hits then fades out\\n LED_MATRIX_WAVE_LEFT_RIGHT, // Sine wave scrolling from left to right\\n LED_MATRIX_WAVE_UP_DOWN, // Sine wave scrolling from up to down\\n LED_MATRIX_EFFECT_MAX\\n};\\n```\\n\\nYou can enable a single effect by defining `ENABLE_[EFFECT_NAME]` in your `config.h`:\\n\\n|Define |Description |\\n|-------------------------------------------------------|----------------------------------------------|\\n|`#define ENABLE_LED_MATRIX_ALPHAS_MODS` |Enables `LED_MATRIX_ALPHAS_MODS` |\\n|`#define ENABLE_LED_MATRIX_BREATHING` |Enables `LED_MATRIX_BREATHING` |\\n|`#define ENABLE_LED_MATRIX_BAND` |Enables `LED_MATRIX_BAND` |\\n|`#define ENABLE_LED_MATRIX_BAND_PINWHEEL` |Enables `LED_MATRIX_BAND_PINWHEEL` |\\n|`#define ENABLE_LED_MATRIX_BAND_SPIRAL` |Enables `LED_MATRIX_BAND_SPIRAL` |\\n|`#define ENABLE_LED_MATRIX_CYCLE_LEFT_RIGHT` |Enables `LED_MATRIX_CYCLE_LEFT_RIGHT` |\\n|`#define ENABLE_LED_MATRIX_CYCLE_UP_DOWN` |Enables `LED_MATRIX_CYCLE_UP_DOWN` |\\n|`#define ENABLE_LED_MATRIX_CYCLE_OUT_IN` |Enables `LED_MATRIX_CYCLE_OUT_IN` |\\n|`#define ENABLE_LED_MATRIX_DUAL_BEACON` |Enables `LED_MATRIX_DUAL_BEACON` |\\n|`#define ENABLE_LED_MATRIX_WAVE_LEFT_RIGHT` |Enables `LED_MATRIX_WAVE_LEFT_RIGHT` |\\n|`#define ENABLE_LED_MATRIX_WAVE_UP_DOWN` |Enables `LED_MATRIX_WAVE_UP_DOWN` |\\n\\n|Reactive Defines |Description |\\n|-------------------------------------------------------|----------------------------------------------|\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_SIMPLE` |Enables `LED_MATRIX_SOLID_REACTIVE_SIMPLE` |\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_WIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_WIDE` |\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTIWIDE` |\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_CROSS` |Enables `LED_MATRIX_SOLID_REACTIVE_CROSS` |\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTICROSS` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTICROSS`|\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_NEXUS` |Enables `LED_MATRIX_SOLID_REACTIVE_NEXUS` |\\n|`#define ENABLE_LED_MATRIX_SOLID_REACTIVE_MULTINEXUS` |Enables `LED_MATRIX_SOLID_REACTIVE_MULTINEXUS`|\\n|`#define ENABLE_LED_MATRIX_SOLID_SPLASH` |Enables `LED_MATRIX_SOLID_SPLASH` |\\n|`#define ENABLE_LED_MATRIX_SOLID_MULTISPLASH` |Enables `LED_MATRIX_SOLID_MULTISPLASH` |\\n\\n::: tip\\nThese modes introduce additional logic that can increase firmware size.\\n:::\", \"Custom LED Matrix Effects {#custom-led-matrix-effects}\": \"By setting `LED_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. To declare new effects, create a `led_matrix_user.inc` file in the user keymap directory or userspace folder.\\n\\n::: tip\\nHardware maintainers who want to limit custom effects to a specific keyboard can create a `led_matrix_kb.inc` file in the root of the keyboard directory, and add `LED_MATRIX_CUSTOM_KB = yes` to the keyboard level `rules.mk`.\\n:::\\n\\n```\\n// !!! DO NOT ADD #pragma once !!! //\\n\\n// Step 1.\\n// Declare custom effects using the LED_MATRIX_EFFECT macro\\n// (note the lack of semicolon after the macro!)\\nLED_MATRIX_EFFECT(my_cool_effect)\\nLED_MATRIX_EFFECT(my_cool_effect2)\\n\\n// Step 2.\\n// Define effects inside the `LED_MATRIX_CUSTOM_EFFECT_IMPLS` ifdef block\\n#ifdef LED_MATRIX_CUSTOM_EFFECT_IMPLS\\n\\n// e.g: A simple effect, self-contained within a single method\\nstatic bool my_cool_effect(effect_params_t* params) {\\n LED_MATRIX_USE_LIMITS(led_min, led_max);\\n for (uint8_t i = led_min; i < led_max; i++) {\\n led_matrix_set_value(i, 0xFF);\\n }\\n return led_matrix_check_finished_leds(led_max);\\n}\\n\\n// e.g: A more complex effect, relying on external methods and state, with\\n// dedicated init and run methods\\nstatic uint8_t some_global_state;\\nstatic void my_cool_effect2_complex_init(effect_params_t* params) {\\n some_global_state = 1;\\n}\\nstatic bool my_cool_effect2_complex_run(effect_params_t* params) {\\n LED_MATRIX_USE_LIMITS(led_min, led_max);\\n for (uint8_t i = led_min; i < led_max; i++) {\\n led_matrix_set_value(i, some_global_state++);\\n }\\n return led_matrix_check_finished_leds(led_max);\\n}\\nstatic bool my_cool_effect2(effect_params_t* params) {\\n if (params->init) my_cool_effect2_complex_init(params);\\n return my_cool_effect2_complex_run(params);\\n}\\n\\n#endif // LED_MATRIX_CUSTOM_EFFECT_IMPLS\\n```\\n\\nTo switch to your custom effect programmatically, simply call `led_matrix_mode()` and prepend `LED_MATRIX_CUSTOM_` to the effect name your specified in `LED_MATRIX_EFFECT()`. For example, an effect declared as `LED_MATRIX_EFFECT(my_cool_effect)` would be referenced with:\\n\\n```\\nled_matrix_mode(LED_MATRIX_CUSTOM_my_cool_effect);\\n```\\n\\nFor inspiration and examples, check out the built-in effects under `quantum/led_matrix/animations/`.\", \"Additional `config.h` Options {#additional-configh-options}\": \"```\\n#define LED_MATRIX_KEYRELEASES // reactive effects respond to keyreleases (instead of keypresses)\\n#define LED_MATRIX_TIMEOUT 0 // number of milliseconds to wait until led automatically turns off\\n#define LED_MATRIX_SLEEP // turn off effects when suspended\\n#define LED_MATRIX_LED_PROCESS_LIMIT (LED_MATRIX_LED_COUNT + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)\\n#define LED_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)\\n#define LED_MATRIX_MAXIMUM_BRIGHTNESS 255 // limits maximum brightness of LEDs\\n#define LED_MATRIX_DEFAULT_ON true // Sets the default enabled state, if none has been set\\n#define LED_MATRIX_DEFAULT_MODE LED_MATRIX_SOLID // Sets the default mode, if none has been set\\n#define LED_MATRIX_DEFAULT_VAL LED_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set\\n#define LED_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set\\n#define LED_MATRIX_VAL_STEP 8 // The value by which to increment the brightness per adjustment action\\n#define LED_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action\\n#define LED_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set\\n#define LED_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.\\n // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR\\n```\", \"EEPROM storage {#eeprom-storage}\": \"The EEPROM for it is currently shared with the RGB Matrix system (it's generally assumed only one feature would be used at a time).\", \"Callbacks {#callbacks}\": {\"Indicators {#indicators}\": \"If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, then you can use the `led_matrix_indicators_kb` function on the keyboard level source file, or `led_matrix_indicators_user` function in the user `keymap.c`.\\n\\n```\\nbool led_matrix_indicators_kb(void) {\\n if (!led_matrix_indicators_user()) {\\n return false;\\n }\\n led_matrix_set_value(index, value);\\n return true;\\n}\\n```\\n\\nIn addition, there are the advanced indicator functions. These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive. This includes a special macro to help make this easier to use: `LED_MATRIX_INDICATOR_SET_VALUE(i, v)`.\\n\\n```\\nvoid led_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {\\n LED_MATRIX_INDICATOR_SET_VALUE(index, value);\\n return false;\\n}\\n```\"}, \"API {#api}\": {\"`void led_matrix_toggle(void)` {#api-led-matrix-toggle}\": \"Toggle LED Matrix on or off.\\n\\n[]\", \"`void led_matrix_toggle_noeeprom(void)` {#api-led-matrix-toggle-noeeprom}\": \"Toggle LED Matrix on or off. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_enable(void)` {#api-led-matrix-enable}\": \"Turn LED Matrix on.\\n\\n[]\", \"`void led_matrix_enable_noeeprom(void)` {#api-led-matrix-enable-noeeprom}\": \"Turn LED Matrix on. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_disable(void)` {#api-led-matrix-disable}\": \"Turn LED Matrix off.\\n\\n[]\", \"`void led_matrix_disable_noeeprom(void)` {#api-led-matrix-disable-noeeprom}\": \"Turn LED Matrix off. New state is not written to EEPROM.\\n\\n[]\", \"`bool led_matrix_is_enabled(void)` {#api-led-matrix-is-enabled}\": {\"Return Value {#api-led-matrix-is-enabled-return}\": \"`true` if LED Matrix is enabled.\\n\\n[]\"}, \"`void led_matrix_set_value(uint8_t index, uint8_t v)` {#led-matrix-set-value}\": {\"Arguments {#api-led-matrix-set-value-arguments}\": [\"`uint8_t index` \\nThe LED index, from 0 to `LED_MATRIX_LED_COUNT - 1`.\", \"`uint8_t v` \\nThe brightness value to set.\"]}, \"`void led_matrix_set_value_all(uint8_t v)` {#api-led-matrix-set-value-all}\": {\"Arguments {#api-led-matrix-set-value-all-arguments}\": [\"`uint8_t v` \\nThe brightness value to set.\"]}, \"`void led_matrix_mode(uint8_t mode)` {#api-led-matrix-mode}\": {\"Arguments {#api-led-matrix-mode-arguments}\": [\"`uint8_t mode` \\nThe effect to switch to.\"]}, \"`void led_matrix_mode_noeeprom(uint8_t mode)` {#api-led-matrix-mode-noeeprom}\": {\"Arguments {#api-led-matrix-mode-noeeprom-arguments}\": [\"`uint8_t mode` \\nThe effect to switch to.\"]}, \"`void led_matrix_step(void)` {#api-led-matrix-step}\": \"Move to the next enabled effect.\\n\\n[]\", \"`void led_matrix_step_noeeprom(void)` {#api-led-matrix-step-noeeprom}\": \"Move to the next enabled effect. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_step_reverse(void)` {#api-led-matrix-step-reverse}\": \"Move to the previous enabled effect.\\n\\n[]\", \"`void led_matrix_step_reverse_noeeprom(void)` {#api-led-matrix-step-reverse-noeeprom}\": \"Move to the previous enabled effect. New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t led_matrix_get_mode(void)` {#api-led-matrix-get-mode}\": {\"Return Value {#api-led-matrix-get-mode-return}\": \"The index of the currently running effect.\\n\\n[]\"}, \"`void val_matrix_increase_val(void)` {#api-led-matrix-increase-val}\": \"Increase the global effect brightness.\\n\\n[]\", \"`void led_matrix_increase_val_noeeprom(void)` {#api-led-matrix-increase-val-noeeprom}\": \"Increase the global effect brightness. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_decrease_val(void)` {#api-led-matrix-decrease-val}\": \"Decrease the global effect brightness.\\n\\n[]\", \"`void led_matrix_decrease_val_noeeprom(void)` {#api-led-matrix-decrease-val-noeeprom}\": \"Decrease the global effect brightness. New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t led_matrix_get_val(void)` {#api-led-matrix-get-val}\": {\"Return Value {#api-led-matrix-get-val-return}\": \"The current brightness value, from 0 to 255.\\n\\n[]\"}, \"`void led_matrix_increase_speed(void)` {#api-led-matrix-increase-speed}\": \"Increase the effect speed.\\n\\n[]\", \"`void led_matrix_increase_speed_noeeprom(void)` {#api-led-matrix-increase-speed-noeeprom}\": \"Increase the effect speed. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_decrease_speed(void)` {#api-led-matrix-decrease-speed}\": \"Decrease the effect speed.\\n\\n[]\", \"`void led_matrix_decrease_speed_noeeprom(void)` {#api-led-matrix-decrease-speed-noeeprom}\": \"Decrease the effect speed. New state is not written to EEPROM.\\n\\n[]\", \"`void led_matrix_set_speed(uint8_t speed)` {#api-led-matrix-set-speed}\": {\"Arguments {#api-led-matrix-set-speed-arguments}\": [\"`uint8_t speed` \\nThe new speed to set, from 0 to 255.\"]}, \"`void led_matrix_set_speed_noeeprom(uint8_t speed)` {#api-led-matrix-set-speed-noeeprom}\": {\"Arguments {#api-led-matrix-set-speed-noeeprom-arguments}\": [\"`uint8_t speed` \\nThe new speed to set, from 0 to 255.\"]}, \"`uint8_t led_matrix_get_speed(void)` {#api-led-matrix-get-speed}\": {\"Return Value {#api-led-matrix-get-speed-return}\": \"The current effect speed, from 0 to 255.\\n\\n[]\"}, \"`void led_matrix_reload_from_eeprom(void)` {#api-led-matrix-reload-from-eeprom}\": \"Reload the effect configuration (enabled, mode and brightness) from EEPROM.\\n\\n[]\", \"`bool led_matrix_get_suspend_state(void)` {#api-led-matrix-get-suspend-state}\": {\"Return Value {#api-led-matrix-get-suspend-state-return}\": \"`true` if LED Matrix is currently in the suspended state.\\n\\n[]\"}, \"`bool led_matrix_indicators_kb(void)` {#api-led-matrix-indicators-kb}\": {\"Return Value {#api-led-matrix-indicators-kb-return}\": \"Currently unused.\\n\\n[]\"}, \"`bool led_matrix_indicators_user(void)` {#api-led-matrix-indicators-user}\": {\"Return Value {#api-led-matrix-indicators-user-return}\": \"`true` to continue running the keyboard-level callback.\\n\\n[]\"}, \"`bool led_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max)` {#api-led-matrix-indicators-advanced-kb}\": \"Keyboard-level callback, invoked after current animation frame is rendered but before it is flushed to the LEDs.\", \"Arguments {#api-led-matrix-indicators-advanced-kb-arguments}\": {\"Return Value {#api-led-matrix-indicators-advanced-kb-return}\": \"Currently unused.\\n\\n[]\"}, \"`bool led_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max)` {#api-led-matrix-indicators-advanced-user}\": \"Keymap-level callback, invoked after current animation frame is rendered but before it is flushed to the LEDs.\", \"Arguments {#api-led-matrix-indicators-advanced-user-arguments}\": {\"Return Value {#api-led-matrix-indicators-advanced-user-return}\": \"`true` to continue running the keyboard-level callback.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 22]\"}, {\"title\": \"MIDI\", \"description\": null, \"content\": {\"Usage\": {\"Caveats\": \"MIDI requires 2 USB endpoints and as such may not work on some hardware such as V-USB controllers.\", \"Basic MIDI\": \"To enable basic MIDI, add the following to your `config.h`:\\n\\n```\\n#define MIDI_BASIC\\n```\", \"Advanced MIDI\": {\"Sending Control Change (CC) Messages\": \"If you're aiming to emulate the features of something like a Launchpad or other MIDI controller you'll need to access the internal MIDI device directly.\\n\\nBecause there are so many possible CC messages, not all of them are implemented as keycodes. Additionally, you might need to provide more than just two values that you would get from a keycode (pressed and released) - for example, the analog values from a fader or a potentiometer. So, you will need to implement [custom keycodes](../feature_macros) if you want to use them in your keymap directly using `process_record_user()`.\\n\\nFor reference of all the possible control code numbers see [MIDI Specification](#midi-specification)\", \"Example code for using Generic On Off Switches as per MIDI Specification.\": \"```\\n#include QMK_KEYBOARD_H\\n\\nextern MidiDevice midi_device;\\n\\n// MIDI CC codes for generic on/off switches (80, 81, 82, 83)\\n// Off: 0-63\\n// On: 64-127\\n\\n#define MIDI_CC_OFF 0\\n#define MIDI_CC_ON 127\\n\\nenum custom_keycodes {\\n MIDI_CC80 = SAFE_RANGE,\\n};\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case MIDI_CC80:\\n if (record->event.pressed) {\\n midi_send_cc(&midi_device, midi_config.channel, 80, MIDI_CC_ON);\\n } else {\\n midi_send_cc(&midi_device, midi_config.channel, 80, MIDI_CC_OFF);\\n }\\n return true;\\n }\\n return true;\\n};\\n\\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\\n LAYOUT(\\n // ...\\n MIDI_CC80,\\n // ...\\n )\\n};\\n```\"}, \"Keycodes\": \"|Keycode |Aliases |Description |\\n|-------------------------------|------------------|---------------------------------|\\n|`QK_MIDI_ON` |`MI_ON` |Turn MIDI on |\\n|`QK_MIDI_OFF` |`MI_OFF` |Turn MIDI off |\\n|`QK_MIDI_TOGGLE` |`MI_TOGG` |Toggle MIDI enabled |\\n|`QK_MIDI_NOTE_C_0` |`MI_C` |C octave 0 |\\n|`QK_MIDI_NOTE_C_SHARP_0` |`MI_Cs`, `MI_Db` |C\\u266f/D\\u266d octave 0 |\\n|`QK_MIDI_NOTE_D_0` |`MI_D` |D octave 0 |\\n|`QK_MIDI_NOTE_D_SHARP_0` |`MI_Ds`, `MI_Eb` |D\\u266f/E\\u266d octave 0 |\\n|`QK_MIDI_NOTE_E_0` |`MI_E` |E octave 0 |\\n|`QK_MIDI_NOTE_F_0` |`MI_F` |F octave 0 |\\n|`QK_MIDI_NOTE_F_SHARP_0` |`MI_Fs`, `MI_Gb` |F\\u266f/G\\u266d octave 0 |\\n|`QK_MIDI_NOTE_G_0` |`MI_G` |G octave 0 |\\n|`QK_MIDI_NOTE_G_SHARP_0` |`MI_Gs`, `MI_Ab` |G\\u266f/A\\u266d octave 0 |\\n|`QK_MIDI_NOTE_A_0` |`MI_A` |A octave 0 |\\n|`QK_MIDI_NOTE_A_SHARP_0` |`MI_As`, `MI_Bb` |A\\u266f/B\\u266d octave 0 |\\n|`QK_MIDI_NOTE_B_0` |`MI_B` |B octave 0 |\\n|`QK_MIDI_NOTE_C_1` |`MI_C1` |C octave 1 |\\n|`QK_MIDI_NOTE_C_SHARP_1` |`MI_Cs1`, `MI_Db1`|C\\u266f/D\\u266d octave 1 |\\n|`QK_MIDI_NOTE_D_1` |`MI_D1` |D octave 1 |\\n|`QK_MIDI_NOTE_D_SHARP_1` |`MI_Ds1`, `MI_Eb1`|D\\u266f/E\\u266d octave 1 |\\n|`QK_MIDI_NOTE_E_1` |`MI_E1` |E octave 1 |\\n|`QK_MIDI_NOTE_F_1` |`MI_F1` |F octave 1 |\\n|`QK_MIDI_NOTE_F_SHARP_1` |`MI_Fs1`, `MI_Gb1`|F\\u266f/G\\u266d octave 1 |\\n|`QK_MIDI_NOTE_G_1` |`MI_G1` |G octave 1 |\\n|`QK_MIDI_NOTE_G_SHARP_1` |`MI_Gs1`, `MI_Ab1`|G\\u266f/A\\u266d octave 1 |\\n|`QK_MIDI_NOTE_A_1` |`MI_A1` |A octave 1 |\\n|`QK_MIDI_NOTE_A_SHARP_1` |`MI_As1`, `MI_Bb1`|A\\u266f/B\\u266d octave 1 |\\n|`QK_MIDI_NOTE_B_1` |`MI_B1` |B octave 1 |\\n|`QK_MIDI_NOTE_C_2` |`MI_C2` |C octave 2 |\\n|`QK_MIDI_NOTE_C_SHARP_2` |`MI_Cs2`, `MI_Db2`|C\\u266f/D\\u266d octave 2 |\\n|`QK_MIDI_NOTE_D_2` |`MI_D2` |D octave 2 |\\n|`QK_MIDI_NOTE_D_SHARP_2` |`MI_Ds2`, `MI_Eb2`|D\\u266f/E\\u266d octave 2 |\\n|`QK_MIDI_NOTE_E_2` |`MI_E2` |E octave 2 |\\n|`QK_MIDI_NOTE_F_2` |`MI_F2` |F octave 2 |\\n|`QK_MIDI_NOTE_F_SHARP_2` |`MI_Fs2`, `MI_Gb2`|F\\u266f/G\\u266d octave 2 |\\n|`QK_MIDI_NOTE_G_2` |`MI_G2` |G octave 2 |\\n|`QK_MIDI_NOTE_G_SHARP_2` |`MI_Gs2`, `MI_Ab2`|G\\u266f/A\\u266d octave 2 |\\n|`QK_MIDI_NOTE_A_2` |`MI_A2` |A octave 2 |\\n|`QK_MIDI_NOTE_A_SHARP_2` |`MI_As2`, `MI_Bb2`|A\\u266f/B\\u266d octave 2 |\\n|`QK_MIDI_NOTE_B_2` |`MI_B2` |B octave 2 |\\n|`QK_MIDI_NOTE_C_3` |`MI_C3` |C octave 3 |\\n|`QK_MIDI_NOTE_C_SHARP_3` |`MI_Cs3`, `MI_Db3`|C\\u266f/D\\u266d octave 3 |\\n|`QK_MIDI_NOTE_D_3` |`MI_D3` |D octave 3 |\\n|`QK_MIDI_NOTE_D_SHARP_3` |`MI_Ds3`, `MI_Eb3`|D\\u266f/E\\u266d octave 3 |\\n|`QK_MIDI_NOTE_E_3` |`MI_E3` |E octave 3 |\\n|`QK_MIDI_NOTE_F_3` |`MI_F3` |F octave 3 |\\n|`QK_MIDI_NOTE_F_SHARP_3` |`MI_Fs3`, `MI_Gb3`|F\\u266f/G\\u266d octave 3 |\\n|`QK_MIDI_NOTE_G_3` |`MI_G3` |G octave 3 |\\n|`QK_MIDI_NOTE_G_SHARP_3` |`MI_Gs3`, `MI_Ab3`|G\\u266f/A\\u266d octave 3 |\\n|`QK_MIDI_NOTE_A_3` |`MI_A3` |A octave 3 |\\n|`QK_MIDI_NOTE_A_SHARP_3` |`MI_As3`, `MI_Bb3`|A\\u266f/B\\u266d octave 3 |\\n|`QK_MIDI_NOTE_B_3` |`MI_B3` |B octave 3 |\\n|`QK_MIDI_NOTE_C_4` |`MI_C4` |C octave 4 |\\n|`QK_MIDI_NOTE_C_SHARP_4` |`MI_Cs4`, `MI_Db4`|C\\u266f/D\\u266d octave 4 |\\n|`QK_MIDI_NOTE_D_4` |`MI_D4` |D octave 4 |\\n|`QK_MIDI_NOTE_D_SHARP_4` |`MI_Ds4`, `MI_Eb4`|D\\u266f/E\\u266d octave 4 |\\n|`QK_MIDI_NOTE_E_4` |`MI_E4` |E octave 4 |\\n|`QK_MIDI_NOTE_F_4` |`MI_F4` |F octave 4 |\\n|`QK_MIDI_NOTE_F_SHARP_4` |`MI_Fs4`, `MI_Gb4`|F\\u266f/G\\u266d octave 4 |\\n|`QK_MIDI_NOTE_G_4` |`MI_G4` |G octave 4 |\\n|`QK_MIDI_NOTE_G_SHARP_4` |`MI_Gs4`, `MI_Ab4`|G\\u266f/A\\u266d octave 4 |\\n|`QK_MIDI_NOTE_A_4` |`MI_A4` |A octave 4 |\\n|`QK_MIDI_NOTE_A_SHARP_4` |`MI_As4`, `MI_Bb4`|A\\u266f/B\\u266d octave 4 |\\n|`QK_MIDI_NOTE_B_4` |`MI_B4` |B octave 4 |\\n|`QK_MIDI_NOTE_C_5` |`MI_C5` |C octave 5 |\\n|`QK_MIDI_NOTE_C_SHARP_5` |`MI_Cs5`, `MI_Db5`|C\\u266f/D\\u266d octave 5 |\\n|`QK_MIDI_NOTE_D_5` |`MI_D5` |D octave 5 |\\n|`QK_MIDI_NOTE_D_SHARP_5` |`MI_Ds5`, `MI_Eb5`|D\\u266f/E\\u266d octave 5 |\\n|`QK_MIDI_NOTE_E_5` |`MI_E5` |E octave 5 |\\n|`QK_MIDI_NOTE_F_5` |`MI_F5` |F octave 5 |\\n|`QK_MIDI_NOTE_F_SHARP_5` |`MI_Fs5`, `MI_Gb5`|F\\u266f/G\\u266d octave 5 |\\n|`QK_MIDI_NOTE_G_5` |`MI_G5` |G octave 5 |\\n|`QK_MIDI_NOTE_G_SHARP_5` |`MI_Gs5`, `MI_Ab5`|G\\u266f/A\\u266d octave 5 |\\n|`QK_MIDI_NOTE_A_5` |`MI_A5` |A octave 5 |\\n|`QK_MIDI_NOTE_A_SHARP_5` |`MI_As5`, `MI_Bb5`|A\\u266f/B\\u266d octave 5 |\\n|`QK_MIDI_NOTE_B_5` |`MI_B5` |B octave 5 |\\n|`QK_MIDI_OCTAVE_N2` |`MI_OCN2` |Set octave to -2 |\\n|`QK_MIDI_OCTAVE_N1` |`MI_OCN1` |Set octave to -1 |\\n|`QK_MIDI_OCTAVE_0` |`MI_OC0` |Set octave to 0 |\\n|`QK_MIDI_OCTAVE_1` |`MI_OC1` |Set octave to 1 |\\n|`QK_MIDI_OCTAVE_2` |`MI_OC2` |Set octave to 2 |\\n|`QK_MIDI_OCTAVE_3` |`MI_OC3` |Set octave to 3 |\\n|`QK_MIDI_OCTAVE_4` |`MI_OC4` |Set octave to 4 |\\n|`QK_MIDI_OCTAVE_5` |`MI_OC5` |Set octave to 5 |\\n|`QK_MIDI_OCTAVE_6` |`MI_OC6` |Set octave to 6 |\\n|`QK_MIDI_OCTAVE_7` |`MI_OC7` |Set octave to 7 |\\n|`QK_MIDI_OCTAVE_DOWN` |`MI_OCTD` |Move down an octave |\\n|`QK_MIDI_OCTAVE_UP` |`MI_OCTU` |Move up an octave |\\n|`QK_MIDI_TRANSPOSE_N6` |`MI_TRN6` |Set transposition to -6 semitones|\\n|`QK_MIDI_TRANSPOSE_N5` |`MI_TRN5` |Set transposition to -5 semitones|\\n|`QK_MIDI_TRANSPOSE_N4` |`MI_TRN4` |Set transposition to -4 semitones|\\n|`QK_MIDI_TRANSPOSE_N3` |`MI_TRN3` |Set transposition to -3 semitones|\\n|`QK_MIDI_TRANSPOSE_N2` |`MI_TRN2` |Set transposition to -2 semitones|\\n|`QK_MIDI_TRANSPOSE_N1` |`MI_TRN1` |Set transposition to -1 semitone |\\n|`QK_MIDI_TRANSPOSE_0` |`MI_TR0` |No transposition |\\n|`QK_MIDI_TRANSPOSE_1` |`MI_TR1` |Set transposition to +1 semitone |\\n|`QK_MIDI_TRANSPOSE_2` |`MI_TR2` |Set transposition to +2 semitones|\\n|`QK_MIDI_TRANSPOSE_3` |`MI_TR3` |Set transposition to +3 semitones|\\n|`QK_MIDI_TRANSPOSE_4` |`MI_TR4` |Set transposition to +4 semitones|\\n|`QK_MIDI_TRANSPOSE_5` |`MI_TR5` |Set transposition to +5 semitones|\\n|`QK_MIDI_TRANSPOSE_6` |`MI_TR6` |Set transposition to +6 semitones|\\n|`QK_MIDI_TRANSPOSE_DOWN` |`MI_TRSD` |Decrease transposition |\\n|`QK_MIDI_TRANSPOSE_UP` |`MI_TRSU` |Increase transposition |\\n|`QK_MIDI_VELOCITY_0` |`MI_VL0` |Set velocity to 0 |\\n|`QK_MIDI_VELOCITY_1` |`MI_VL1` |Set velocity to 12 |\\n|`QK_MIDI_VELOCITY_2` |`MI_VL2` |Set velocity to 25 |\\n|`QK_MIDI_VELOCITY_3` |`MI_VL3` |Set velocity to 38 |\\n|`QK_MIDI_VELOCITY_4` |`MI_VL4` |Set velocity to 51 |\\n|`QK_MIDI_VELOCITY_5` |`MI_VL5` |Set velocity to 64 |\\n|`QK_MIDI_VELOCITY_6` |`MI_VL6` |Set velocity to 76 |\\n|`QK_MIDI_VELOCITY_7` |`MI_VL7` |Set velocity to 89 |\\n|`QK_MIDI_VELOCITY_8` |`MI_VL8` |Set velocity to 102 |\\n|`QK_MIDI_VELOCITY_9` |`MI_VL9` |Set velocity to 114 |\\n|`QK_MIDI_VELOCITY_10` |`MI_VL10` |Set velocity to 127 |\\n|`QK_MIDI_VELOCITY_DOWN` |`MI_VELD` |Decrease velocity |\\n|`QK_MIDI_VELOCITY_UP` |`MI_VELU` |Increase velocity |\\n|`QK_MIDI_CHANNEL_1` |`MI_CH1` |Set channel to 1 |\\n|`QK_MIDI_CHANNEL_2` |`MI_CH2` |Set channel to 2 |\\n|`QK_MIDI_CHANNEL_3` |`MI_CH3` |Set channel to 3 |\\n|`QK_MIDI_CHANNEL_4` |`MI_CH4` |Set channel to 4 |\\n|`QK_MIDI_CHANNEL_5` |`MI_CH5` |Set channel to 5 |\\n|`QK_MIDI_CHANNEL_6` |`MI_CH6` |Set channel to 6 |\\n|`QK_MIDI_CHANNEL_7` |`MI_CH7` |Set channel to 7 |\\n|`QK_MIDI_CHANNEL_8` |`MI_CH8` |Set channel to 8 |\\n|`QK_MIDI_CHANNEL_9` |`MI_CH9` |Set channel to 9 |\\n|`QK_MIDI_CHANNEL_10` |`MI_CH10` |Set channel to 10 |\\n|`QK_MIDI_CHANNEL_11` |`MI_CH11` |Set channel to 11 |\\n|`QK_MIDI_CHANNEL_12` |`MI_CH12` |Set channel to 12 |\\n|`QK_MIDI_CHANNEL_13` |`MI_CH13` |Set channel to 13 |\\n|`QK_MIDI_CHANNEL_14` |`MI_CH14` |Set channel to 14 |\\n|`QK_MIDI_CHANNEL_15` |`MI_CH15` |Set channel to 15 |\\n|`QK_MIDI_CHANNEL_16` |`MI_CH16` |Set channel to 16 |\\n|`QK_MIDI_CHANNEL_DOWN` |`MI_CHND` |Decrease channel |\\n|`QK_MIDI_CHANNEL_UP` |`MI_CHNU` |Increase channel |\\n|`QK_MIDI_ALL_NOTES_OFF` |`MI_AOFF` |Stop all notes |\\n|`QK_MIDI_SUSTAIN` |`MI_SUST` |Sustain |\\n|`QK_MIDI_PORTAMENTO` |`MI_PORT` |Portmento |\\n|`QK_MIDI_SOSTENUTO` |`MI_SOST` |Sostenuto |\\n|`QK_MIDI_SOFT` |`MI_SOFT` |Soft Pedal |\\n|`QK_MIDI_LEGATO` |`MI_LEG` |Legato |\\n|`QK_MIDI_MODULATION` |`MI_MOD` |Modulation |\\n|`QK_MIDI_MODULATION_SPEED_DOWN`|`MI_MODD` |Decrease modulation speed |\\n|`QK_MIDI_MODULATION_SPEED_UP` |`MI_MODU` |Increase modulation speed |\\n|`QK_MIDI_PITCH_BEND_DOWN` |`MI_BNDD` |Bend pitch down |\\n|`QK_MIDI_PITCH_BEND_UP` |`MI_BNDU` |Bend pitch up |\", \"Configuration\": \"Certain values are stored in the `midi_config` struct. This configuration is not persisted to EEPROM. By default, these values are:\\n\\n|Configuration |Value|Comments |\\n|-------------------|-----|-----------------------|\\n|Octave |`4` |Corresponds to `MI_OC2`|\\n|Transposition |`0` | |\\n|Velocity |`127`| |\\n|Channel |`0` | |\\n|Modulation Interval|`8` | |\\n\\nFor the above, the `MI_C` keycode will produce a C3 (note number 48), and so on.\", \"References\": {\"MIDI Specification\": [\"[MIDI.org](https://www.midi.org/specifications-old/item/table-1-summary-of-midi-message)\", \"[CMU MIDI Programmer's Reference](https://www.cs.cmu.edu/~music/cmsip/readings/MIDI%20tutorial%20for%20programmers.html)\"], \"QMK C Files\": [\"`quantum/process_keycode/process_midi.c`\", \"`quantum/quantum_keycodes.h`\", \"`quantum/midi/midi.h`\", \"`quantum/midi/midi.c`\", \"`quantum/midi/qmk_midi.c`\", \"`quantum/midi/midi_device.h`\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 23]\"}, {\"title\": \"Mouse keys\", \"description\": null, \"content\": {\"Adding mouse keys to your keyboard\": {\"Enabling mouse keys\": \"To enable mouse keys, add the following line to your keymap\\u2019s `rules.mk`:\\n\\n```\\nMOUSEKEY_ENABLE = yes\\n```\", \"Mapping mouse actions\": \"In your keymap you can use the following keycodes to map key presses to mouse actions:\\n\\n|Key |Aliases |Description |\\n|-------------------------|---------|---------------------------|\\n|`QK_MOUSE_CURSOR_UP` |`MS_UP` |Mouse cursor up |\\n|`QK_MOUSE_CURSOR_DOWN` |`MS_DOWN`|Mouse cursor down |\\n|`QK_MOUSE_CURSOR_LEFT` |`MS_LEFT`|Mouse cursor left |\\n|`QK_MOUSE_CURSOR_RIGHT` |`MS_RGHT`|Mouse cursor right |\\n|`QK_MOUSE_BUTTON_1` |`MS_BTN1`|Mouse button 1 |\\n|`QK_MOUSE_BUTTON_2` |`MS_BTN2`|Mouse button 2 |\\n|`QK_MOUSE_BUTTON_3` |`MS_BTN3`|Mouse button 3 |\\n|`QK_MOUSE_BUTTON_4` |`MS_BTN4`|Mouse button 4 |\\n|`QK_MOUSE_BUTTON_5` |`MS_BTN5`|Mouse button 5 |\\n|`QK_MOUSE_BUTTON_6` |`MS_BTN6`|Mouse button 6 |\\n|`QK_MOUSE_BUTTON_7` |`MS_BTN7`|Mouse button 7 |\\n|`QK_MOUSE_BUTTON_8` |`MS_BTN8`|Mouse button 8 |\\n|`QK_MOUSE_WHEEL_UP` |`MS_WHLU`|Mouse wheel up |\\n|`QK_MOUSE_WHEEL_DOWN` |`MS_WHLD`|Mouse wheel down |\\n|`QK_MOUSE_WHEEL_LEFT` |`MS_WHLL`|Mouse wheel left |\\n|`QK_MOUSE_WHEEL_RIGHT` |`MS_WHLR`|Mouse wheel right |\\n|`QK_MOUSE_ACCELERATION_0`|`MS_ACL0`|Set mouse acceleration to 0|\\n|`QK_MOUSE_ACCELERATION_1`|`MS_ACL1`|Set mouse acceleration to 1|\\n|`QK_MOUSE_ACCELERATION_2`|`MS_ACL2`|Set mouse acceleration to 2|\"}, \"Configuring mouse keys\": {\"Accelerated mode\": \"This is the default mode. You can adjust the cursor and scrolling acceleration using the following settings in your keymap\\u2019s `config.h` file:\\n\\n|Define |Default|Description |\\n|----------------------------|-------|---------------------------------------------------------|\\n|`MOUSEKEY_DELAY` |10 |Delay between pressing a movement key and cursor movement|\\n|`MOUSEKEY_INTERVAL` |20 |Time between cursor movements in milliseconds |\\n|`MOUSEKEY_MOVE_DELTA` |8 |Step size |\\n|`MOUSEKEY_MAX_SPEED` |10 |Maximum cursor speed at which acceleration stops |\\n|`MOUSEKEY_TIME_TO_MAX` |30 |Time until maximum cursor speed is reached |\\n|`MOUSEKEY_WHEEL_DELAY` |10 |Delay between pressing a wheel key and wheel movement |\\n|`MOUSEKEY_WHEEL_INTERVAL` |80 |Time between wheel movements |\\n|`MOUSEKEY_WHEEL_DELTA` |1 |Wheel movement step size |\\n|`MOUSEKEY_WHEEL_MAX_SPEED` |8 |Maximum number of scroll steps per scroll action |\\n|`MOUSEKEY_WHEEL_TIME_TO_MAX`|40 |Time until maximum scroll speed is reached |\\n\\nTips:\\n\\n['Setting `MOUSEKEY_DELAY` too low makes the cursor unresponsive. Setting it too high makes small movements difficult.', 'For smoother cursor movements, lower the value of `MOUSEKEY_INTERVAL`. If the refresh rate of your display is 60Hz, you could set it to `16` (1/60). As this raises the cursor speed significantly, you may want to lower `MOUSEKEY_MAX_SPEED`.', 'Setting `MOUSEKEY_TIME_TO_MAX` or `MOUSEKEY_WHEEL_TIME_TO_MAX` to `0` will disable acceleration for the cursor or scrolling respectively. This way you can make one of them constant while keeping the other accelerated, which is not possible in constant speed mode.', 'Setting `MOUSEKEY_WHEEL_INTERVAL` too low will make scrolling too fast. Setting it too high will make scrolling too slow when the wheel key is held down.']\\n\\nCursor acceleration uses the same algorithm as the X Window System MouseKeysAccel feature. You can read more about it [on Wikipedia](https://en.wikipedia.org/wiki/Mouse_keys).\", \"Kinetic Mode\": \"This is an extension of the accelerated mode. The kinetic mode uses a quadratic curve on the cursor speed which allows precise movements at the beginning and allows to cover large distances by increasing cursor speed quickly thereafter. You can adjust the cursor and scrolling acceleration using the following settings in your keymap\\u2019s `config.h` file:\\n\\n|Define |Default |Description |\\n|--------------------------------------|---------|---------------------------------------------------------------|\\n|`MK_KINETIC_SPEED` |undefined|Enable kinetic mode |\\n|`MOUSEKEY_DELAY` |5 |Delay between pressing a movement key and cursor movement |\\n|`MOUSEKEY_INTERVAL` |10 |Time between cursor movements in milliseconds |\\n|`MOUSEKEY_MOVE_DELTA` |16 |Step size for accelerating from initial to base speed |\\n|`MOUSEKEY_INITIAL_SPEED` |100 |Initial speed of the cursor in pixel per second |\\n|`MOUSEKEY_BASE_SPEED` |5000 |Maximum cursor speed at which acceleration stops |\\n|`MOUSEKEY_DECELERATED_SPEED` |400 |Decelerated cursor speed |\\n|`MOUSEKEY_ACCELERATED_SPEED` |3000 |Accelerated cursor speed |\\n|`MOUSEKEY_WHEEL_INITIAL_MOVEMENTS` |16 |Initial number of movements of the mouse wheel |\\n|`MOUSEKEY_WHEEL_BASE_MOVEMENTS` |32 |Maximum number of movements at which acceleration stops |\\n|`MOUSEKEY_WHEEL_ACCELERATED_MOVEMENTS`|48 |Accelerated wheel movements |\\n|`MOUSEKEY_WHEEL_DECELERATED_MOVEMENTS`|8 |Decelerated wheel movements |\\n\\nTips:\\n\\n['The smoothness of the cursor movement depends on the `MOUSEKEY_INTERVAL` setting. The shorter the interval is set the smoother the movement will be. Setting the value too low makes the cursor unresponsive. Lower settings are possible if the micro processor is fast enough. For example: At an interval of `8` milliseconds, `125` movements per second will be initiated. With a base speed of `1000` each movement will move the cursor by `8` pixels.', \\\"Mouse wheel movements are implemented differently from cursor movements. While it's okay for the cursor to move multiple pixels at once for the mouse wheel this would lead to jerky movements. Instead, the mouse wheel operates at step size `1`. Setting mouse wheel speed is done by adjusting the number of wheel movements per second.\\\"]\", \"Constant mode\": \"In this mode you can define multiple different speeds for both the cursor and the mouse wheel. There is no acceleration. `MS_ACL0`, `MS_ACL1` and `MS_ACL2` change the cursor and scroll speed to their respective setting.\\n\\nYou can choose whether speed selection is momentary or tap-to-select:\\n\\n['**Momentary:** The chosen speed is only active while you hold the respective key. When the key is raised, mouse keys returns to the unmodified speed.', '**Tap-to-select:** The chosen speed is activated when you press the respective key and remains active even after the key has been raised. The default speed is that of `MS_ACL1`. There is no unmodified speed.']\\n\\nThe default speeds from slowest to fastest are as follows:\\n\\n['**Momentary:** `MS_ACL0` < `MS_ACL1` < *unmodified* < `MS_ACL2`', '**Tap-to-select:** `MS_ACL0` < `MS_ACL1` < `MS_ACL2`']\\n\\nTo use constant speed mode, you must at least define `MK_3_SPEED` in your keymap\\u2019s `config.h` file:\\n\\n```\\n#define MK_3_SPEED\\n```\\n\\nTo enable momentary mode, also define `MK_MOMENTARY_ACCEL`:\\n\\n```\\n#define MK_MOMENTARY_ACCEL\\n```\\n\\nUse the following settings if you want to adjust cursor movement or scrolling:\\n\\n|Define |Default |Description |\\n|---------------------|-------------|-------------------------------------------|\\n|`MK_3_SPEED` |*Not defined*|Enable constant cursor speeds |\\n|`MK_MOMENTARY_ACCEL` |*Not defined*|Enable momentary speed selection |\\n|`MK_C_OFFSET_UNMOD` |16 |Cursor offset per movement (unmodified) |\\n|`MK_C_INTERVAL_UNMOD`|16 |Time between cursor movements (unmodified) |\\n|`MK_C_OFFSET_0` |1 |Cursor offset per movement (`MS_ACL0`) |\\n|`MK_C_INTERVAL_0` |32 |Time between cursor movements (`MS_ACL0`) |\\n|`MK_C_OFFSET_1` |4 |Cursor offset per movement (`MS_ACL1`) |\\n|`MK_C_INTERVAL_1` |16 |Time between cursor movements (`MS_ACL1`) |\\n|`MK_C_OFFSET_2` |32 |Cursor offset per movement (`MS_ACL2`) |\\n|`MK_C_INTERVAL_2` |16 |Time between cursor movements (`MS_ACL2`) |\\n|`MK_W_OFFSET_UNMOD` |1 |Scroll steps per scroll action (unmodified)|\\n|`MK_W_INTERVAL_UNMOD`|40 |Time between scroll steps (unmodified) |\\n|`MK_W_OFFSET_0` |1 |Scroll steps per scroll action (`MS_ACL0`) |\\n|`MK_W_INTERVAL_0` |360 |Time between scroll steps (`MS_ACL0`) |\\n|`MK_W_OFFSET_1` |1 |Scroll steps per scroll action (`MS_ACL1`) |\\n|`MK_W_INTERVAL_1` |120 |Time between scroll steps (`MS_ACL1`) |\\n|`MK_W_OFFSET_2` |1 |Scroll steps per scroll action (`MS_ACL2`) |\\n|`MK_W_INTERVAL_2` |20 |Time between scroll steps (`MS_ACL2`) |\", \"Combined mode\": \"This mode functions like **Accelerated** mode, however, you can hold `MS_ACL0`, `MS_ACL1` and `MS_ACL2`\\nto momentarily (while held) set the cursor and scroll speeds to constant speeds. When no acceleration\\nkeys are held, this mode is identical to **Accelerated** mode, and can be modified using all of the\\nrelevant settings.\\n\\n['**MS_ACL0:** This acceleration sets your cursor to the slowest possible speed. This is useful for very\\\\nsmall and detailed movements of the cursor.', '**MS_ACL1:** This acceleration sets your cursor to half the maximum (user defined) speed.', '**MS_ACL2:** This acceleration sets your cursor to the maximum (computer defined) speed. This is\\\\nuseful for moving the cursor large distances without much accuracy.']\\n\\nTo use combined speed mode, you must at least define `MK_COMBINED` in your keymap\\u2019s `config.h` file:\\n\\n```\\n#define MK_COMBINED\\n```\", \"Inertia mode\": \"This mode provides smooth motion, like sliding on ice. The cursor accelerates\\nalong a quadratic curve while a key is held, then glides to a stop after the\\nkey is released. Vertical and horizontal movements are tracked independently,\\nso the cursor can move in many directions and make curves.\\n\\nCannot be used at the same time as Kinetic mode, Constant mode, or Combined mode.\\n\\nRecommended settings in your keymap\\u2019s `config.h` file:\\n\\n|Define |Default |Description |\\n|----------------------------|---------|-----------------------------------------------------------|\\n|`MOUSEKEY_INERTIA` |undefined|Enable Inertia mode |\\n|`MOUSEKEY_DELAY` |150 |Delay between pressing a movement key and cursor movement |\\n|`MOUSEKEY_INTERVAL` |16 |Time between cursor movements in milliseconds (16 = 60fps) |\\n|`MOUSEKEY_MAX_SPEED` |32 |Maximum cursor speed at which acceleration stops |\\n|`MOUSEKEY_TIME_TO_MAX` |32 |Number of frames until maximum cursor speed is reached |\\n|`MOUSEKEY_FRICTION` |24 |How quickly the cursor stops after releasing a key |\\n|`MOUSEKEY_MOVE_DELTA` |1 |How much to move on first frame (1 strongly recommended) |\\n\\nTips:\\n\\n[\\\"Set `MOUSEKEY_DELAY` to roughly the same value as your host computer's key repeat delay, in ms. Recommended values are 100 to 300.\\\", \\\"Set `MOUSEKEY_INTERVAL` to a value of 1000 / your monitor's FPS. For 60 FPS, 1000/60 = 16.\\\", 'Set `MOUSEKEY_MAX_SPEED` based on your screen resolution and refresh rate, like Width / FPS. For example, 1920 pixels / 60 FPS = 32 pixels per frame.', 'Set `MOUSEKEY_TIME_TO_MAX` to a value of approximately FPS / 2, to make it reach full speed in half a second (or so).', 'Set `MOUSEKEY_FRICTION` to something between 1 and 255. Lower makes the cursor glide longer. Values from 8 to 40 are the most effective.', 'Keep `MOUSEKEY_MOVE_DELTA` at 1. This allows precise movements before the gliding effect starts.', 'Mouse wheel options are the same as the default accelerated mode, and do not use inertia.']\", \"Overlapping mouse key control\": \"When additional overlapping mouse key is pressed, the mouse cursor will continue in a new direction with the same acceleration. The following settings can be used to reset the acceleration with new overlapping keys for more precise control if desired:\\n\\n|Define |Default |Description |\\n|------------------------------|----------------------|-----------------------------------------------------------------------|\\n|`MOUSEKEY_OVERLAP_RESET` |undefined |Enables overlapping mouse key control |\\n|`MOUSEKEY_OVERLAP_MOVE_DELTA` |`MOUSEKEY_MOVE_DELTA` |Step size of reset movement acceleration |\\n|`MOUSEKEY_OVERLAP_WHEEL_DELTA`|`MOUSEKEY_WHEEL_DELTA`|Step size of reset mouse wheel acceleration |\\n|`MOUSEKEY_OVERLAP_INTERVAL` |`MOUSEKEY_INTERVAL` |Reset time between cursor movements in milliseconds (Kinetic mode only)|\\n\\n::: tip\\nThis feature will not be applied on Inertial mode\\n:::\"}, \"Use with PS/2 Mouse and Pointing Device\": \"Mouse keys button state is shared with [PS/2 mouse](ps2_mouse) and [pointing device](pointing_device) so mouse keys button presses can be used for clicks and drags.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 24]\"}, {\"title\": \"OLED Driver\", \"description\": null, \"content\": {\"Supported Hardware\": \"OLED modules using SSD1306, SH1106 or SH1107 driver ICs, communicating over I2C or SPI.\\nTested combinations:\\n\\n|IC |Size |Platform|Notes |\\n|---------|-------|--------|------------------------|\\n|SSD1306 |128x32 |AVR |Primary support |\\n|SSD1306 |128x64 |AVR |Verified working |\\n|SSD1306 |128x32 |Arm | |\\n|SSD1306 |128x64 |Arm |Verified working |\\n|SH1106 |128x64 |AVR |No scrolling |\\n|SH1107 |64x128 |AVR |No scrolling |\\n|SH1107 |64x128 |Arm |No scrolling |\\n|SH1107 |128x128|Arm |No scrolling |\\n\\nHardware configurations using Arm-based microcontrollers or different sizes of OLED modules may be compatible, but are untested.\", \"Usage\": \"To enable the OLED feature, there are two steps. First, when compiling your keyboard, you'll need to add the following to your `rules.mk`:\\n\\n```\\nOLED_ENABLE = yes\\n```\", \"OLED type\": \"|OLED Driver |Supported Device |\\n|-------------------|------------------------------------|\\n|`ssd1306` (default)|For both SSD1306, SH1106, and SH1107|\\n\\ne.g.\\n\\n```\\nOLED_DRIVER = ssd1306\\n```\\n\\n|OLED Transport | |\\n|---------------|------------------------------------------------|\\n|`i2c` (default)| Uses I2C for communication with the OLED panel |\\n|`spi` | Uses SPI for communication with the OLED panel |\\n\\ne.g.\\n\\n```\\nOLED_TRANSPORT = i2c\\n```\\n\\nThen in your `keymap.c` file, implement the OLED task call. This example assumes your keymap has three layers named `_QWERTY`, `_FN` and `_ADJ`:\\n\\n```\\n#ifdef OLED_ENABLE\\nbool oled_task_user(void) {\\n // Host Keyboard Layer Status\\n oled_write_P(PSTR(\\\"Layer: \\\"), false);\\n\\n switch (get_highest_layer(layer_state)) {\\n case _QWERTY:\\n oled_write_P(PSTR(\\\"Default\\\\n\\\"), false);\\n break;\\n case _FN:\\n oled_write_P(PSTR(\\\"FN\\\\n\\\"), false);\\n break;\\n case _ADJ:\\n oled_write_P(PSTR(\\\"ADJ\\\\n\\\"), false);\\n break;\\n default:\\n // Or use the write_ln shortcut over adding '\\\\n' to the end of your string\\n oled_write_ln_P(PSTR(\\\"Undefined\\\"), false);\\n }\\n\\n // Host Keyboard LED Status\\n led_t led_state = host_keyboard_led_state();\\n oled_write_P(led_state.num_lock ? PSTR(\\\"NUM \\\") : PSTR(\\\" \\\"), false);\\n oled_write_P(led_state.caps_lock ? PSTR(\\\"CAP \\\") : PSTR(\\\" \\\"), false);\\n oled_write_P(led_state.scroll_lock ? PSTR(\\\"SCR \\\") : PSTR(\\\" \\\"), false);\\n \\n return false;\\n}\\n#endif\\n```\", \"Logo Example\": \"In the default font, certain ranges of characters are reserved for a QMK logo. To render this logo to the OLED screen, use the following code example:\\n\\n```\\nstatic void render_logo(void) {\\n static const char PROGMEM qmk_logo[] = {\\n 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90, 0x91, 0x92, 0x93, 0x94,\\n 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0, 0xB1, 0xB2, 0xB3, 0xB4,\\n 0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF, 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0x00\\n };\\n\\n oled_write_P(qmk_logo, false);\\n}\\n\\nbool oled_task_user(void) {\\n render_logo();\\n return false;\\n}\\n```\\n\\n::: tip\\nThe default font file is located at `drivers/oled/glcdfont.c` and its location can be overwritten with the `OLED_FONT_H` configuration option. Font file content can be edited with external tools such as [Helix Font Editor](https://helixfonteditor.netlify.app/) and [Logo Editor](https://joric.github.io/qle/).\\n:::\", \"Buffer Read Example\": \"For some purposes, you may need to read the current state of the OLED display\\nbuffer. The `oled_read_raw` function can be used to safely read bytes from the\\nbuffer.\\n\\nIn this example, calling `fade_display` in the `oled_task_user` function will\\nslowly fade away whatever is on the screen by turning random pixels black over\\ntime.\\n\\n```\\n//Setup some mask which can be or'd with bytes to turn off pixels\\nconst uint8_t single_bit_masks[8] = {127, 191, 223, 239, 247, 251, 253, 254};\\n\\nstatic void fade_display(void) {\\n //Define the reader structure\\n oled_buffer_reader_t reader;\\n uint8_t buff_char;\\n if (random() % 30 == 0) {\\n srand(timer_read());\\n // Fetch a pointer for the buffer byte at index 0. The return structure\\n // will have the pointer and the number of bytes remaining from this\\n // index position if we want to perform a sequential read by\\n // incrementing the buffer pointer\\n reader = oled_read_raw(0);\\n //Loop over the remaining buffer and erase pixels as we go\\n for (uint16_t i = 0; i < reader.remaining_element_count; i++) {\\n //Get the actual byte in the buffer by dereferencing the pointer\\n buff_char = *reader.current_element;\\n if (buff_char != 0) {\\n oled_write_raw_byte(buff_char & single_bit_masks[rand() % 8], i);\\n }\\n //increment the pointer to fetch a new byte during the next loop\\n reader.current_element++;\\n }\\n }\\n}\\n```\", \"Other Examples\": \"In split keyboards, it is very common to have two OLED displays that each render different content and are oriented or flipped differently. You can do this by switching which content to render by using the return value from `is_keyboard_master()` or `is_keyboard_left()` found in `split_util.h`, e.g:\\n\\n```\\n#ifdef OLED_ENABLE\\noled_rotation_t oled_init_user(oled_rotation_t rotation) {\\n if (!is_keyboard_master()) {\\n return OLED_ROTATION_180; // flips the display 180 degrees if offhand\\n }\\n\\n return rotation;\\n}\\n\\nbool oled_task_user(void) {\\n if (is_keyboard_master()) {\\n render_status(); // Renders the current keyboard state (layer, lock, caps, scroll, etc)\\n } else {\\n render_logo(); // Renders a static logo\\n oled_scroll_left(); // Turns on scrolling\\n }\\n return false;\\n}\\n#endif\\n```\\n\\nRender a message before booting into bootloader mode.\\n\\n```\\nvoid oled_render_boot(bool bootloader) {\\n oled_clear();\\n for (int i = 0; i < 16; i++) {\\n oled_set_cursor(0, i);\\n if (bootloader) {\\n oled_write_P(PSTR(\\\"Awaiting New Firmware \\\"), false);\\n } else {\\n oled_write_P(PSTR(\\\"Rebooting \\\"), false);\\n }\\n }\\n\\n oled_render_dirty(true);\\n}\\n\\nbool shutdown_user(bool jump_to_bootloader) {\\n oled_render_boot(jump_to_bootloader);\\n}\\n\\n```\", \"Basic Configuration\": {\"I2C Configuration\": \"|Define |Default |Description |\\n|---------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------|\\n|`OLED_DISPLAY_ADDRESS` |`0x3C` |The i2c address of the OLED Display |\", \"SPI Configuration\": \"|Define |Default |Description |\\n|---------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------|\\n|`OLED_DC_PIN` | Required |The pin used for the DC connection of the OLED Display. |\\n|`OLED_CS_PIN` | Required |The pin used for the CS connection of the OLED Display. |\\n|`OLED_RST_PIN` | *Not defined* |The pin used for the RST connection of the OLED Display (may be left undefined if the RST pin is not connected). |\\n|`OLED_SPI_MODE` |`3` (default) |The SPI Mode for the OLED Display (not typically changed). |\\n|`OLED_SPI_DIVISOR` |`2` (default) |The SPI Multiplier to use for the OLED Display. |\"}, \"128x64 & Custom sized OLED Displays\": {\"90 Degree Rotation - Technical Mumbo Jumbo\": \"```\\n// OLED Rotation enum values are flags\\ntypedef enum {\\n OLED_ROTATION_0 = 0,\\n OLED_ROTATION_90 = 1,\\n OLED_ROTATION_180 = 2,\\n OLED_ROTATION_270 = 3, // OLED_ROTATION_90 | OLED_ROTATION_180\\n} oled_rotation_t;\\n```\\n\\nOLED displays driven by SSD1306, SH1106 or SH1107 drivers only natively support in hardware 0 degree and 180 degree rendering. This feature is done in software and not free. Using this feature will increase the time to calculate what data to send over i2c to the OLED. If you are strapped for cycles, this can cause keycodes to not register. In testing however, the rendering time on an ATmega32U4 board only went from 2ms to 5ms and keycodes not registering was only noticed once we hit 15ms.\\n\\n90 degree rotation is achieved by using bitwise operations to rotate each 8 block of memory and uses two precalculated arrays to remap buffer memory to OLED memory. The memory map defines are precalculated for remap performance and are calculated based on the display height, width, and block size. For example, in the 128x32 implementation with a `uint8_t` block type, we have a 64 byte block size. This gives us eight 8 byte blocks that need to be rotated and rendered. The OLED renders horizontally two 8 byte blocks before moving down a page, e.g:\\n\\n| | | | | | |\\n|---|---|---|---|---|---|\\n| 0 | 1 | | | | |\\n| 2 | 3 | | | | |\\n| 4 | 5 | | | | |\\n| 6 | 7 | | | | |\\n\\nHowever the local buffer is stored as if it was Height x Width display instead of Width x Height, e.g:\\n\\n| | | | | | |\\n|---|---|---|---|---|---|\\n| 3 | 7 | | | | |\\n| 2 | 6 | | | | |\\n| 1 | 5 | | | | |\\n| 0 | 4 | | | | |\\n\\nSo those precalculated arrays just index the memory offsets in the order in which each one iterates its data.\\n\\nRotation on SH1106 and SH1107 is noticeably less efficient than on SSD1306, because these controllers do not support the \\u201chorizontal addressing mode\\u201d, which allows transferring the data for the whole rotated block at once; instead, separate address setup commands for every page in the block are required. The screen refresh time for SH1107 is therefore about 45% higher than for a same size screen with SSD1306 when using STM32 MCUs (on AVR the slowdown is about 20%, because the code which actually rotates the bitmap consumes more time).\"}, \"OLED API\": \"```\\n// OLED Rotation enum values are flags\\ntypedef enum {\\n OLED_ROTATION_0 = 0,\\n OLED_ROTATION_90 = 1,\\n OLED_ROTATION_180 = 2,\\n OLED_ROTATION_270 = 3, // OLED_ROTATION_90 | OLED_ROTATION_180\\n} oled_rotation_t;\\n\\n// Initialize the oled display, rotating the rendered output based on the define passed in.\\n// Returns true if the OLED was initialized successfully\\nbool oled_init(oled_rotation_t rotation);\\n\\n// Called at the start of oled_init, weak function overridable by the user\\n// rotation - the value passed into oled_init\\n// Return new oled_rotation_t if you want to override default rotation\\noled_rotation_t oled_init_kb(oled_rotation_t rotation);\\noled_rotation_t oled_init_user(oled_rotation_t rotation);\\n\\n// Send commands/data to screen\\nbool oled_send_cmd(const uint8_t *data, uint16_t size);\\nbool oled_send_cmd_P(const uint8_t *data, uint16_t size);\\nbool oled_send_data(const uint8_t *data, uint16_t size);\\n\\n// Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering\\nvoid oled_clear(void);\\n\\n// Alias to oled_render_dirty to avoid a change in api.\\n#define oled_render() oled_render_dirty(false)\\n\\n// Renders all dirty blocks to the display at one time or a subset depending on the value of\\n// all.\\nvoid oled_render_dirty(bool all);\\n\\n// Moves cursor to character position indicated by column and line, wraps if out of bounds\\n// Max column denoted by 'oled_max_chars()' and max lines by 'oled_max_lines()' functions\\nvoid oled_set_cursor(uint8_t col, uint8_t line);\\n\\n// Advances the cursor to the next page, writing ' ' if true\\n// Wraps to the beginning when out of bounds\\nvoid oled_advance_page(bool clearPageRemainder);\\n\\n// Moves the cursor forward 1 character length\\n// Advance page if there is not enough room for the next character\\n// Wraps to the beginning when out of bounds\\nvoid oled_advance_char(void);\\n\\n// Writes a single character to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Main handler that writes character data to the display buffer\\nvoid oled_write_char(const char data, bool invert);\\n\\n// Writes a string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\nvoid oled_write(const char *data, bool invert);\\n\\n// Writes a string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Advances the cursor to the next page, wiring ' ' to the remainder of the current page\\nvoid oled_write_ln(const char *data, bool invert);\\n\\n// Pans the buffer to the right (or left by passing true) by moving contents of the buffer\\n// Useful for moving the screen in preparation for new drawing\\nvoid oled_pan(bool left);\\n\\n// Returns a pointer to the requested start index in the buffer plus remaining\\n// buffer length as struct\\noled_buffer_reader_t oled_read_raw(uint16_t start_index);\\n\\n// Writes a string to the buffer at current cursor position\\nvoid oled_write_raw(const char *data, uint16_t size);\\n\\n// Writes a single byte into the buffer at the specified index\\nvoid oled_write_raw_byte(const char data, uint16_t index);\\n\\n// Sets a specific pixel on or off\\n// Coordinates start at top-left and go right and down for positive x and y\\nvoid oled_write_pixel(uint8_t x, uint8_t y, bool on);\\n\\n#if defined(__AVR__)\\n// Writes a PROGMEM string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Remapped to call 'void oled_write(const char *data, bool invert);' on ARM\\nvoid oled_write_P(const char *data, bool invert);\\n\\n// Writes a PROGMEM string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Advances the cursor to the next page, wiring ' ' to the remainder of the current page\\n// Remapped to call 'void oled_write_ln(const char *data, bool invert);' on ARM\\nvoid oled_write_ln_P(const char *data, bool invert);\\n\\n// Writes a PROGMEM string to the buffer at current cursor position\\nvoid oled_write_raw_P(const char *data, uint16_t size);\\n#else\\n# define oled_write_P(data, invert) oled_write(data, invert)\\n# define oled_write_ln_P(data, invert) oled_write_ln(data, invert)\\n# define oled_write_raw_P(data, size) oled_write_raw(data, size)\\n#endif // defined(__AVR__)\\n\\n// Can be used to manually turn on the screen if it is off\\n// Returns true if the screen was on or turns on\\nbool oled_on(void);\\n\\n// Can be used to manually turn off the screen if it is on\\n// Returns true if the screen was off or turns off\\nbool oled_off(void);\\n\\n// Returns true if the oled is currently on, false if it is\\n// not\\nbool is_oled_on(void);\\n\\n// Sets the brightness level of the display\\nuint8_t oled_set_brightness(uint8_t level);\\n\\n// Gets the current brightness level of the display\\nuint8_t oled_get_brightness(void);\\n\\n// Basically it's oled_render, but with timeout management and oled_task_user calling!\\nvoid oled_task(void);\\n\\n// Called at the start of oled_task, weak function overridable by the user\\nbool oled_task_kb(void);\\nbool oled_task_user(void);\\n\\n// Set the specific 8 lines rows of the screen to scroll.\\n// 0 is the default for start, and 7 for end, which is the entire\\n// height of the screen. For 128x32 screens, rows 4-7 are not used.\\nvoid oled_scroll_set_area(uint8_t start_line, uint8_t end_line);\\n\\n// Sets scroll speed, 0-7, fastest to slowest. Default is three.\\n// Does not take effect until scrolling is either started or restarted\\n// the ssd1306 supports 8 speeds with the delay\\n// listed below between each frame of the scrolling effect\\n// 0=2, 1=3, 2=4, 3=5, 4=25, 5=64, 6=128, 7=256\\nvoid oled_scroll_set_speed(uint8_t speed);\\n\\n// Begin scrolling the entire display right\\n// Returns true if the screen was scrolling or starts scrolling\\n// NOTE: display contents cannot be changed while scrolling\\nbool oled_scroll_right(void);\\n\\n// Begin scrolling the entire display left\\n// Returns true if the screen was scrolling or starts scrolling\\n// NOTE: display contents cannot be changed while scrolling\\nbool oled_scroll_left(void);\\n\\n// Turns off display scrolling\\n// Returns true if the screen was not scrolling or stops scrolling\\nbool oled_scroll_off(void);\\n\\n// Returns true if the oled is currently scrolling, false if it is\\n// not\\nbool is_oled_scrolling(void);\\n\\n// Inverts the display\\n// Returns true if the screen was or is inverted\\nbool oled_invert(bool invert);\\n\\n// Returns the maximum number of characters that will fit on a line\\nuint8_t oled_max_chars(void);\\n\\n// Returns the maximum number of lines that will fit on the OLED\\nuint8_t oled_max_lines(void);\\n```\\n\\n::: warning\\nScrolling is unsupported on the SH1106 and SH1107.\\n:::\\n\\n::: warning\\nScrolling does not work properly on the SSD1306 if the display width is smaller than 128.\\n:::\", \"SSD1306.h Driver Conversion Guide\": \"|Old API |Recommended New API |\\n|-------------------------|---------------------------------|\\n|`struct CharacterMatrix` |*removed - delete all references*|\\n|`iota_gfx_init` |`oled_init` |\\n|`iota_gfx_on` |`oled_on` |\\n|`iota_gfx_off` |`oled_off` |\\n|`iota_gfx_flush` |`oled_render` |\\n|`iota_gfx_write_char` |`oled_write_char` |\\n|`iota_gfx_write` |`oled_write` |\\n|`iota_gfx_write_P` |`oled_write_P` |\\n|`iota_gfx_clear_screen` |`oled_clear` |\\n|`matrix_clear` |*removed - delete all references*|\\n|`matrix_write_char_inner`|`oled_write_char` |\\n|`matrix_write_char` |`oled_write_char` |\\n|`matrix_write` |`oled_write` |\\n|`matrix_write_ln` |`oled_write_ln` |\\n|`matrix_write_P` |`oled_write_P` |\\n|`matrix_write_ln_P` |`oled_write_ln_P` |\\n|`matrix_render` |`oled_render` |\\n|`iota_gfx_task` |`oled_task` |\\n|`iota_gfx_task_user` |`oled_task_user` |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 25]\"}, {\"title\": \"OS Detection\", \"description\": null, \"content\": {\"Usage\": \"In your `rules.mk` add:\\n\\n```\\nOS_DETECTION_ENABLE = yes\\n```\\n\\nIt will automatically include the required headers file.\\nIt declares `os_variant_t detected_host_os(void);` which you can call to get detected OS.\\n\\nIt returns one of the following values:\\n\\n```\\nenum {\\n OS_UNSURE,\\n OS_LINUX,\\n OS_WINDOWS,\\n OS_MACOS,\\n OS_IOS,\\n} os_variant_t;\\n```\\n\\n::: tip\\nNote that it takes some time after firmware is booted to detect the OS.\\n:::\\nThis time is quite short, probably hundreds of milliseconds, but this data may be not ready in keyboard and layout setup functions which run very early during firmware startup.\", \"Callbacks {#callbacks}\": \"If you want to perform custom actions when the OS is detected, then you can use the `process_detected_host_os_kb` function on the keyboard level source file, or `process_detected_host_os_user` function in the user `keymap.c`.\\n\\n```\\nbool process_detected_host_os_kb(os_variant_t detected_os) {\\n if (!process_detected_host_os_user(detected_os)) {\\n return false;\\n }\\n switch (detected_os) {\\n case OS_MACOS:\\n case OS_IOS:\\n rgb_matrix_set_color_all(RGB_WHITE);\\n break;\\n case OS_WINDOWS:\\n rgb_matrix_set_color_all(RGB_BLUE);\\n break;\\n case OS_LINUX:\\n rgb_matrix_set_color_all(RGB_ORANGE);\\n break;\\n case OS_UNSURE:\\n rgb_matrix_set_color_all(RGB_RED);\\n break;\\n }\\n \\n return true;\\n}\\n```\", \"OS detection stability\": \"The OS detection is currently handled while the USB device descriptor is being assembled. \\nThe process is done in steps, generating a number of intermediate results until it stabilizes.\\nWe therefore resort to debouncing the result until it has been stable for a given amount of milliseconds.\\nThis amount can be configured, in case your board is not stable within the default debouncing time of 200ms.\", \"Configuration Options\": [\"`#define OS_DETECTION_DEBOUNCE 250`\", [\"defined the debounce time for OS detection, in milliseconds\", \"defaults to 250ms\"], \"`#define OS_DETECTION_KEYBOARD_RESET`\", [\"enables the keyboard reset upon a USB device reinitilization\", \"this setting may help with detection issues when switching between devices on some KVMs (see [Troubleshooting](#troubleshooting))\"], \"`#define OS_DETECTION_SINGLE_REPORT`\", [\"allows the report callbacks to be called only once, when the OS detection result is considered stable\", \"subsequent changes in the detection results, if any, are ignored\", \"this setting may help with delayed stability issues when switching devices on some KVMs (see [Troubleshooting](#troubleshooting))\"]], \"Troubleshooting\": \"Some KVMs and USB switches may cause issues when the OS detection is turned on. \\nHere is a list of common issues and how to fix them:\\n\\n[\\\"**Problem**: _keyboard won't redetect the OS when switching between machines using a KVM_\\\", ['**Explanation**: some KVMs keep the USB controller powered on during the switch and OS\\\\ndetection happens when the USB device description is being assembled.', '**Solution**: use `OS_DETECTION_KEYBOARD_RESET` to force the keyboard to reset upon switching.'], '**Problem**: _keyboard OS detection callback gets invoked even minuted after startup_', [\\\"**Explanation**: some OSes, notably macOS on ARM-based Macs, may cause this behavior. \\\\nThe actual cause is not known at this time.'\\\", '**Solution**: use `OS_DETECTION_SINGLE_REPORT` to suppress repeated callback invocations.']]\", \"Debug\": \"If OS is guessed incorrectly, you may want to collect data about USB setup packets to refine the detection logic.\\n\\nTo do so in your `config.h` add:\\n\\n```\\n#define OS_DETECTION_DEBUG_ENABLE\\n```\\n\\nAnd in your `rules.mk` add:\\n\\n```\\nCONSOLE_ENABLE = yes\\n```\\n\\nAnd also include `\\\"os_detection.h\\\"` in your `keymap.c`.\\n\\nThen you can define custom keycodes to store data about USB setup packets in EEPROM (persistent memory) and to print it later on host where you can run `qmk console`:\\n\\n```\\nenum custom_keycodes {\\n STORE_SETUPS = SAFE_RANGE,\\n PRINT_SETUPS,\\n};\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case STORE_SETUPS:\\n if (record->event.pressed) {\\n store_setups_in_eeprom();\\n }\\n return false;\\n case PRINT_SETUPS:\\n if (record->event.pressed) {\\n print_stored_setups();\\n }\\n return false;\\n }\\n}\\n```\\n\\nThen please open an issue on Github with this information and tell what OS was not detected correctly and if you have any intermediate devices between keyboard and your computer.\", \"Credits\": \"Original idea is coming from [FingerprintUSBHost](https://github.com/keyboardio/FingerprintUSBHost) project.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 26]\"}, {\"title\": \"Pointing Device {#pointing-device}\", \"description\": null, \"content\": {\"Sensor Drivers\": {\"ADNS 5050 Sensor\": \"To use the ADNS 5050 sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = adns5050\\n```\\n\\nThe ADNS 5050 sensor uses a serial type protocol for communication, and requires an additional light source.\\n\\n| Setting (`config.h`) | Description | Default |\\n| -------------------- | ------------------------------------------------------------------ | -------------------------- |\\n| `ADNS5050_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |\\n| `ADNS5050_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |\\n| `ADNS5050_CS_PIN` | (Required) The pin connected to the Chip Select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |\\n\\nThe CPI range is 125-1375, in increments of 125. Defaults to 500 CPI.\", \"ADNS 9800 Sensor\": \"To use the ADNS 9800 sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = adns9800\\n```\\n\\nThe ADNS 9800 is an SPI driven optical sensor, that uses laser output for surface tracking.\\n\\n| Setting (`config.h`) | Description | Default |\\n| ----------------------- | ---------------------------------------------------------------------- | ------------------------ |\\n| `ADNS9800_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` |\\n| `ADNS9800_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` |\\n| `ADNS9800_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `3` |\\n| `ADNS9800_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |\\n| `ADNS9800_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |\\n\\nThe CPI range is 800-8200, in increments of 200. Defaults to 1800 CPI. \", \"Analog Joystick\": \"To use an analog joystick to control the pointer, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = analog_joystick\\n```\\n\\nThe Analog Joystick is an analog (ADC) driven sensor. There are a variety of joysticks that you can use for this.\\n\\n| Setting (`config.h`) | Description | Default |\\n| --------------------------------- | -------------------------------------------------------------------------- | ------------- |\\n| `ANALOG_JOYSTICK_X_AXIS_PIN` | (Required) The pin used for the vertical/X axis. | _not defined_ |\\n| `ANALOG_JOYSTICK_Y_AXIS_PIN` | (Required) The pin used for the horizontal/Y axis. | _not defined_ |\\n| `ANALOG_JOYSTICK_AXIS_MIN` | (Optional) Sets the lower range to be considered movement. | `0` |\\n| `ANALOG_JOYSTICK_AXIS_MAX` | (Optional) Sets the upper range to be considered movement. | `1023` |\\n| `ANALOG_JOYSTICK_AUTO_AXIS` | (Optional) Sets ranges to be considered movement automatically. | _not defined_ |\\n| `ANALOG_JOYSTICK_SPEED_REGULATOR` | (Optional) The divisor used to slow down movement. (lower makes it faster) | `20` |\\n| `ANALOG_JOYSTICK_READ_INTERVAL` | (Optional) The interval in milliseconds between reads. | `10` |\\n| `ANALOG_JOYSTICK_SPEED_MAX` | (Optional) The maximum value used for motion. | `2` |\\n| `ANALOG_JOYSTICK_CLICK_PIN` | (Optional) The pin wired up to the press switch of the analog stick. | _not defined_ |\\n| `ANALOG_JOYSTICK_WEIGHTS` | (Optional) Use custom weights for lever positions. | _not defined_ |\\n| `ANALOG_JOYSTICK_CUTOFF` | (Optional) Cut off movement when joystick returns to start position. | _not defined_ |\\n\\nIf `ANALOG_JOYSTICK_AUTO_AXIS` is used, then `ANALOG_JOYSTICK_AXIS_MIN` and `ANALOG_JOYSTICK_AXIS_MAX` are ignored.\\n\\nBy default analog joystick implementation uses `x^2` weighting for lever positions. `ANALOG_JOYSTICK_WEIGHTS` allows to experiment with different configurations that might feel better.\\n\\nE.g. This is weights for `((x-0.4)^3+0.064)/0.282`:\\n\\n```\\n#define ANALOG_JOYSTICK_WEIGHTS {0,2,4,5,7,8,9,10,12,13,14,15,15,16,17,18,18,19,19,20,20,21,21,21,22,22,22,22,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,23,24,24,24,24,24,24,25,25,25,26,26,26,27,28,28,29,29,30,31,32,33,34,35,36,37,38,40,41,43,44,46,48,49,51,53,56,58,60,62,65,68,70,73,76,79,82,85,89,92,96,100}\\n```\\n\\nYou can use following JS code to generate weights for different formulas:\\n\\n```\\nJSON.stringify(Array.from(Array(101).keys()).map(x => Math.ceil((((x/100-0.4)**3+0.064)/0.282*100))))\\n```\", \"Azoteq IQS5XX Trackpad\": {\"Device settings\": \"Specific device profiles are provided which set the required values for dimensions and resolution.\\n\\n| Setting | Description |\\n| -------------------------------- | ---------------------------------------------------------- |\\n| `AZOTEQ_IQS5XX_TPS43` | (Pick One) Sets resolution/mm to TPS43 specifications. |\\n| `AZOTEQ_IQS5XX_TPS65` | (Pick One) Sets resolution/mm to TPS65 specifications. |\\n\\n::: tip\\nIf using one of the above defines you can skip to gesture settings.\\n:::\\n\\n| Setting | Description | Default |\\n| -------------------------------- | ---------------------------------------------------------- | ------------- |\\n| `AZOTEQ_IQS5XX_WIDTH_MM` | (Required) Width of the trackpad sensor in millimeters. | _not defined_ |\\n| `AZOTEQ_IQS5XX_HEIGHT_MM` | (Required) Height of the trackpad sensor in millimeters. | _not defined_ |\\n| `AZOTEQ_IQS5XX_RESOLUTION_X` | (Optional) Specify X resolution for CPI calculation. | _not defined_ |\\n| `AZOTEQ_IQS5XX_RESOLUTION_Y` | (Optional) Specify Y resolution for CPI calculation. | _not defined_ |\\n\\n**`AZOTEQ_IQS5XX_RESOLUTION_X/Y`** fall back resolutions are provided within the driver based on controller model.\\n\\n| I2C Setting | Description | Default |\\n| ------------------------- | ------------------------------------------------------------------------------- | ------- |\\n| `AZOTEQ_IQS5XX_ADDRESS` | (Optional) Sets the I2C Address for the Azoteq trackpad | `0xE8` |\\n| `AZOTEQ_IQS5XX_TIMEOUT_MS`| (Optional) The timeout for i2c communication with in milliseconds. | `10` |\", \"Gesture settings\": \"| Setting | Description | Default |\\n| ----------------------------------------- | ------------------------------------------------------------------------------------ | ----------- |\\n| `AZOTEQ_IQS5XX_TAP_ENABLE` | (Optional) Enable single finger tap. (Left click) | `true` |\\n| `AZOTEQ_IQS5XX_TWO_FINGER_TAP_ENABLE` | (Optional) Enable two finger tap. (Right click) | `true` |\\n| `AZOTEQ_IQS5XX_PRESS_AND_HOLD_ENABLE` | (Optional) Emulates holding left click to select text. | `false` |\\n| `AZOTEQ_IQS5XX_SWIPE_X_ENABLE` | (Optional) Enable swipe gestures X+ (Mouse Button 5) / X- (Mouse Button 4) | `false` |\\n| `AZOTEQ_IQS5XX_SWIPE_Y_ENABLE` | (Optional) Enable swipe gestures Y+ (Mouse Button 3) / Y- (Mouse Button 6) | `false` |\\n| `AZOTEQ_IQS5XX_ZOOM_ENABLE` | (Optional) Enable zoom gestures Zoom Out (Mouse Button 7) / Zoom In (Mouse Button 8) | `false` |\\n| `AZOTEQ_IQS5XX_SCROLL_ENABLE` | (Optional) Enable scrolling using two fingers. | `true` |\\n| `AZOTEQ_IQS5XX_TAP_TIME` | (Optional) Maximum time in ms for tap to be registered. | `150` |\\n| `AZOTEQ_IQS5XX_TAP_DISTANCE` | (Optional) Maximum deviation in pixels before single tap is no longer valid. | `25` |\\n| `AZOTEQ_IQS5XX_HOLD_TIME` | (Optional) Minimum time in ms for press and hold. | `300` |\\n| `AZOTEQ_IQS5XX_SWIPE_INITIAL_TIME` | (Optional) Maximum time to travel initial distance before swipe is registered. | `150` |\\n| `AZOTEQ_IQS5XX_SWIPE_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before swipe is registered. | `300` |\\n| `AZOTEQ_IQS5XX_SWIPE_CONSECUTIVE_TIME` | (Optional) Maximum time to travel consecutive distance before swipe is registered. | `0` |\\n| `AZOTEQ_IQS5XX_SWIPE_CONSECUTIVE_DISTANCE`| (Optional) Minimum travel in pixels before a consecutive swipe is registered. | `2000` |\\n| `AZOTEQ_IQS5XX_SCROLL_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before scroll is registered. | `50` |\\n| `AZOTEQ_IQS5XX_ZOOM_INITIAL_DISTANCE` | (Optional) Minimum travel in pixels before zoom is registered. | `50` |\\n| `AZOTEQ_IQS5XX_ZOOM_CONSECUTIVE_DISTANCE` | (Optional) Maximum time to travel zoom distance before zoom is registered. | `25` |\", \"Rotation settings\": \"| Setting | Description | Default |\\n| ---------------------------- | ---------------------------------------------------------- | ------------- |\\n| `AZOTEQ_IQS5XX_ROTATION_90` | (Optional) Configures hardware for 90 degree rotation. | _not defined_ |\\n| `AZOTEQ_IQS5XX_ROTATION_180` | (Optional) Configures hardware for 180 degree rotation. | _not defined_ |\\n| `AZOTEQ_IQS5XX_ROTATION_270` | (Optional) Configures hardware for 270 degree rotation. | _not defined_ |\"}, \"Cirque Trackpad\": {\"Common settings\": \"| Setting | Description | Default |\\n| ------------------------------------ | ---------------------------------------------------------- | ------------------------------------------- |\\n| `CIRQUE_PINNACLE_DIAMETER_MM` | (Optional) Diameter of the trackpad sensor in millimeters. | `40` |\\n| `CIRQUE_PINNACLE_ATTENUATION` | (Optional) Sets the attenuation of the sensor data. | `EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_4X` |\\n| `CIRQUE_PINNACLE_CURVED_OVERLAY` | (Optional) Applies settings tuned for curved overlay. | _not defined_ |\\n| `CIRQUE_PINNACLE_POSITION_MODE` | (Optional) Mode of operation. | _not defined_ |\\n| `CIRQUE_PINNACLE_SKIP_SENSOR_CHECK` | (Optional) Skips sensor presence check | _not defined_ |\\n\\n**`CIRQUE_PINNACLE_ATTENUATION`** is a measure of how much data is suppressed in regards to sensitivity. The higher the attenuation, the less sensitive the touchpad will be.\\n\\nDefault attenuation is set to 4X, although if you are using a thicker overlay (such as the curved overlay) you will want a lower attenuation such as 2X. The possible values are:\\n\\n['`EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_4X`: Least sensitive', '`EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_3X`', '`EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_2X`', '`EXTREG__TRACK_ADCCONFIG__ADC_ATTENUATE_1X`: Most sensitive']\\n\\n**`CIRQUE_PINNACLE_POSITION_MODE`** can be `CIRQUE_PINNACLE_ABSOLUTE_MODE` or `CIRQUE_PINNACLE_RELATIVE_MODE`. Modes differ in supported features/gestures.\\n\\n['`CIRQUE_PINNACLE_ABSOLUTE_MODE`: Reports absolute x, y, z (touch pressure) coordinates and up to 5 hw buttons connected to the trackpad', '`CIRQUE_PINNACLE_RELATIVE_MODE`: Reports x/y deltas, scroll and up to 3 buttons (2 of them can be from taps, see gestures) connected to trackpad. Supports taps on secondary side of split. Saves about 2k of flash compared to absolute mode with all features.']\\n\\n| I2C Setting | Description | Default |\\n| ------------------------- | ------------------------------------------------------------------------------- | ------- |\\n| `CIRQUE_PINNACLE_ADDR` | (Required) Sets the I2C Address for the Cirque Trackpad | `0x2A` |\\n| `CIRQUE_PINNACLE_TIMEOUT` | (Optional) The timeout for i2c communication with the trackpad in milliseconds. | `20` |\\n\\n| SPI Setting | Description | Default |\\n| ------------------------------ | ---------------------------------------------------------------------- | ------------------------ |\\n| `CIRQUE_PINNACLE_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `1000000` |\\n| `CIRQUE_PINNACLE_SPI_LSBFIRST` | (Optional) Sets the Least/Most Significant Byte First setting for SPI. | `false` |\\n| `CIRQUE_PINNACLE_SPI_MODE` | (Optional) Sets the SPI Mode for the sensor. | `1` |\\n| `CIRQUE_PINNACLE_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |\\n| `CIRQUE_PINNACLE_SPI_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |\\n\\nDefault Scaling is 1024. Actual CPI depends on trackpad diameter.\\n\\nAlso see the `POINTING_DEVICE_TASK_THROTTLE_MS`, which defaults to 10ms when using Cirque Pinnacle, which matches the internal update rate of the position registers (in standard configuration). Advanced configuration for pen/stylus usage might require lower values.\", \"Absolute mode settings\": \"| Setting | Description | Default |\\n|-----------------------------------------|-------------------------------------------------------------------------|-------------|\\n| `CIRQUE_PINNACLE_X_LOWER` | (Optional) The minimum reachable X value on the sensor. | `127` |\\n| `CIRQUE_PINNACLE_X_UPPER` | (Optional) The maximum reachable X value on the sensor. | `1919` |\\n| `CIRQUE_PINNACLE_Y_LOWER` | (Optional) The minimum reachable Y value on the sensor. | `63` |\\n| `CIRQUE_PINNACLE_Y_UPPER` | (Optional) The maximum reachable Y value on the sensor. | `1471` |\\n| `CIRQUE_PINNACLE_REACHABLE_CALIBRATION` | (Optional) Enable console messages to aide in calibrating above values. | not defined |\", \"Absolute mode gestures\": \"| Gesture Setting | Description | Default |\\n| ---------------------------------------------- | ------------------------------------------------------------------------------ | -------------------- |\\n| `CIRQUE_PINNACLE_TAP_ENABLE` | (Optional) Enable tap to click. This currently only works on the master side. | _not defined_ |\\n| `CIRQUE_PINNACLE_TAPPING_TERM` | (Optional) Length of time that a touch can be to be considered a tap. | `TAPPING_TERM`/`200` |\\n| `CIRQUE_PINNACLE_TOUCH_DEBOUNCE` | (Optional) Length of time that a touch can be to be considered a tap. | `TAPPING_TERM`/`200` |\\n\\n`POINTING_DEVICE_GESTURES_SCROLL_ENABLE` in this mode enables circular scroll. Touch originating in outer ring can trigger scroll by moving along the perimeter. Near side triggers vertical scroll and far side triggers horizontal scroll.\\n\\nAdditionally, `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE` is supported in this mode.\", \"Relative mode gestures\": \"| Gesture Setting (`config.h`) | Description | Default |\\n| -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\\n| `CIRQUE_PINNACLE_TAP_ENABLE` | (Optional) Enable tap to \\\"left click\\\". Works on both sides of a split keyboard. | _not defined_ |\\n| `CIRQUE_PINNACLE_SECONDARY_TAP_ENABLE` | (Optional) Tap in upper right corner (half of the finger needs to be outside of the trackpad) of the trackpad will result in \\\"right click\\\". `CIRQUE_PINNACLE_TAP_ENABLE` must be enabled. | _not defined_ |\\n\\nTapping term and debounce are not configurable in this mode since it's handled by trackpad internally.\\n\\n`POINTING_DEVICE_GESTURES_SCROLL_ENABLE` in this mode enables side scroll. Touch originating on the right side can trigger vertical scroll (IntelliSense trackpad style).\"}, \"PAW 3204 Sensor\": \"To use the paw 3204 sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = paw3204\\n```\\n\\nThe paw 3204 sensor uses a serial type protocol for communication, and requires an additional light source. \\n\\n| Setting (`config.h`) | Description | Default |\\n| -------------------- |--------------------------------------------------------------- | -------------------------- |\\n| `PAW3204_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |\\n| `PAW3204_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |\\n\\nThe CPI range is 400-1600, with supported values of (400, 500, 600, 800, 1000, 1200 and 1600). Defaults to 1000 CPI.\", \"Pimoroni Trackball\": \"To use the Pimoroni Trackball module, add this to your `rules.mk`:\\n\\n```\\nPOINTING_DEVICE_DRIVER = pimoroni_trackball\\n```\\n\\nThe Pimoroni Trackball module is a I2C based breakout board with an RGB enable trackball. \\n\\n| Setting (`config.h`) | Description | Default |\\n| ------------------------------------ | ---------------------------------------------------------------------------------- | ------- |\\n| `PIMORONI_TRACKBALL_ADDRESS` | (Required) Sets the I2C Address for the Pimoroni Trackball. | `0x0A` |\\n| `PIMORONI_TRACKBALL_TIMEOUT` | (Optional) The timeout for i2c communication with the trackball in milliseconds. | `100` |\\n| `PIMORONI_TRACKBALL_SCALE` | (Optional) The multiplier used to generate reports from the sensor. | `5` |\\n| `PIMORONI_TRACKBALL_DEBOUNCE_CYCLES` | (Optional) The number of scan cycles used for debouncing on the ball press. | `20` |\\n| `PIMORONI_TRACKBALL_ERROR_COUNT` | (Optional) Specifies the number of read/write errors until the sensor is disabled. | `10` |\", \"PMW3320 Sensor\": \"To use the PMW3320 sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = pmw3320\\n```\\n\\nThe PMW3320 sensor uses a serial type protocol for communication, and requires an additional light source (it could work without one, but expect it to be out of service early).\\n\\n| Setting | Description | Default |\\n| ------------------- | ------------------------------------------------------------------- | -------------------------- |\\n| `PMW3320_SCLK_PIN` | (Required) The pin connected to the clock pin of the sensor. | `POINTING_DEVICE_SCLK_PIN` |\\n| `PMW3320_SDIO_PIN` | (Required) The pin connected to the data pin of the sensor. | `POINTING_DEVICE_SDIO_PIN` |\\n| `PMW3320_CS_PIN` | (Required) The pin connected to the cable select pin of the sensor. | `POINTING_DEVICE_CS_PIN` |\\n\\nThe CPI range is 500-3500, in increments of 250. Defaults to 1000 CPI.\", \"PMW 3360 and PMW 3389 Sensor\": \"This drivers supports both the PMW 3360 and PMW 3389 sensor as well as multiple sensors of the same type _per_ controller, so 2 can be attached at the same side for split keyboards (or unsplit keyboards).\\n\\nTo use the **PMW 3360** sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = pmw3360\\n```\\n\\nThe CPI range is 100-12000, in increments of 100. Defaults to 1600 CPI.\\n\\nTo use the **PMW 3389** sensor, add this to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = pmw3389\\n```\\n\\nThe CPI range is 50-16000, in increments of 50. Defaults to 2000 CPI.\\n\\nBoth PMW 3360 and PMW 3389 are SPI driven optical sensors, that use a built in IR LED for surface tracking.\\nIf you have different CS wiring on each half you can use `PMW33XX_CS_PIN_RIGHT` or `PMW33XX_CS_PINS_RIGHT` in combination with `PMW33XX_CS_PIN` or `PMW33XX_CS_PINS` to configure both sides independently. If `_RIGHT` values aren't provided, they default to be the same as the left ones.\\n\\n| Setting (`config.h`) | Description | Default |\\n| ---------------------------- | ------------------------------------------------------------------------------------------- | ------------------------ |\\n| `PMW33XX_CS_PIN` | (Required) Sets the Chip Select pin connected to the sensor. | `POINTING_DEVICE_CS_PIN` |\\n| `PMW33XX_CS_PINS` | (Alternative) Sets the Chip Select pins connected to multiple sensors. | `{PMW33XX_CS_PIN}` |\\n| `PMW33XX_CS_PIN_RIGHT` | (Optional) Sets the Chip Select pin connected to the sensor on the right half. | `PMW33XX_CS_PIN` |\\n| `PMW33XX_CS_PINS_RIGHT` | (Optional) Sets the Chip Select pins connected to multiple sensors on the right half. | `{PMW33XX_CS_PIN_RIGHT}` |\\n| `PMW33XX_CPI` | (Optional) Sets counts per inch sensitivity of the sensor. | _varies_ |\\n| `PMW33XX_CLOCK_SPEED` | (Optional) Sets the clock speed that the sensor runs at. | `2000000` |\\n| `PMW33XX_SPI_DIVISOR` | (Optional) Sets the SPI Divisor used for SPI communication. | _varies_ |\\n| `PMW33XX_LIFTOFF_DISTANCE` | (Optional) Sets the lift off distance at run time | `0x02` |\\n| `ROTATIONAL_TRANSFORM_ANGLE` | (Optional) Allows for the sensor data to be rotated +/- 127 degrees directly in the sensor. | `0` |\\n\\nTo use multiple sensors, instead of setting `PMW33XX_CS_PIN` you need to set `PMW33XX_CS_PINS` and also handle and merge the read from this sensor in user code.\\nNote that different (per sensor) values of CPI, speed liftoff, rotational angle or flipping of X/Y is not currently supported.\\n\\n```\\n// in config.h:\\n#define PMW33XX_CS_PINS { B5, B6 }\\n// in keyboard.c:\\n#ifdef POINTING_DEVICE_ENABLE\\nvoid pointing_device_init_kb(void) {\\n pmw33xx_init(1); // index 1 is the second device.\\n pmw33xx_set_cpi(0, 800); // applies to first sensor\\n pmw33xx_set_cpi(1, 800); // applies to second sensor\\n pointing_device_init_user();\\n}\\n\\n// Contains report from sensor #0 already, need to merge in from sensor #1\\nreport_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {\\n pmw33xx_report_t report = pmw33xx_read_burst(1);\\n if (!report.motion.b.is_lifted && report.motion.b.is_motion) {\\n// From quantum/pointing_device_drivers.c\\n#define constrain_hid(amt) ((amt) < -127 ? -127 : ((amt) > 127 ? 127 : (amt)))\\n mouse_report.x = constrain_hid(mouse_report.x + report.delta_x);\\n mouse_report.y = constrain_hid(mouse_report.y + report.delta_y);\\n }\\n return pointing_device_task_user(mouse_report);\\n}\\n#endif\\n\\n```\", \"Custom Driver\": \"If you have a sensor type that isn't supported above, a custom option is available by adding the following to your `rules.mk`\\n\\n```\\nPOINTING_DEVICE_DRIVER = custom\\n```\\n\\nUsing the custom driver will require implementing the following functions:\\n\\n```\\nvoid pointing_device_driver_init(void) {}\\nreport_mouse_t pointing_device_driver_get_report(report_mouse_t mouse_report) { return mouse_report; }\\nuint16_t pointing_device_driver_get_cpi(void) { return 0; }\\nvoid pointing_device_driver_set_cpi(uint16_t cpi) {}\\n```\\n\\n::: warning\\nIdeally, new sensor hardware should be added to `drivers/sensors/` and `quantum/pointing_device_drivers.c`, but there may be cases where it's very specific to the hardware. So these functions are provided, just in case. \\n:::\"}, \"Common Configuration\": \"| Setting | Description | Default |\\n| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------- |\\n| `MOUSE_EXTENDED_REPORT` | (Optional) Enables support for extended mouse reports. (-32767 to 32767, instead of just -127 to 127). | _not defined_ |\\n| `WHEEL_EXTENDED_REPORT` | (Optional) Enables support for extended wheel reports. (-32767 to 32767, instead of just -127 to 127). | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_90` | (Optional) Rotates the X and Y data by 90 degrees. | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_180` | (Optional) Rotates the X and Y data by 180 degrees. | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_270` | (Optional) Rotates the X and Y data by 270 degrees. | _not defined_ |\\n| `POINTING_DEVICE_INVERT_X` | (Optional) Inverts the X axis report. | _not defined_ |\\n| `POINTING_DEVICE_INVERT_Y` | (Optional) Inverts the Y axis report. | _not defined_ |\\n| `POINTING_DEVICE_MOTION_PIN` | (Optional) If supported, will only read from sensor if pin is active. | _not defined_ |\\n| `POINTING_DEVICE_MOTION_PIN_ACTIVE_LOW` | (Optional) If defined then the motion pin is active-low. | _varies_ |\\n| `POINTING_DEVICE_TASK_THROTTLE_MS` | (Optional) Limits the frequency that the sensor is polled for motion. | _not defined_ |\\n| `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE` | (Optional) Enable inertial cursor. Cursor continues moving after a flick gesture and slows down by kinetic friction. | _not defined_ |\\n| `POINTING_DEVICE_GESTURES_SCROLL_ENABLE` | (Optional) Enable scroll gesture. The gesture that activates the scroll is device dependent. | _not defined_ |\\n| `POINTING_DEVICE_CS_PIN` | (Optional) Provides a default CS pin, useful for supporting multiple sensor configs. | _not defined_ |\\n| `POINTING_DEVICE_SDIO_PIN` | (Optional) Provides a default SDIO pin, useful for supporting multiple sensor configs. | _not defined_ |\\n| `POINTING_DEVICE_SCLK_PIN` | (Optional) Provides a default SCLK pin, useful for supporting multiple sensor configs. | _not defined_ |\\n\\n::: warning\\nWhen using `SPLIT_POINTING_ENABLE` the `POINTING_DEVICE_MOTION_PIN` functionality is not supported and `POINTING_DEVICE_TASK_THROTTLE_MS` will default to `1`. Increasing this value will increase transport performance at the cost of possible mouse responsiveness.\\n:::\\n\\nThe `POINTING_DEVICE_CS_PIN`, `POINTING_DEVICE_SDIO_PIN`, and `POINTING_DEVICE_SCLK_PIN` provide a convenient way to define a single pin that can be used for an interchangeable sensor config. This allows you to have a single config, without defining each device. Each sensor allows for this to be overridden with their own defines. \\n\\n::: warning\\nAny pointing device with a lift/contact status can integrate inertial cursor feature into its driver, controlled by `POINTING_DEVICE_GESTURES_CURSOR_GLIDE_ENABLE`. e.g. PMW3360 can use Lift_Stat from Motion register. Note that `POINTING_DEVICE_MOTION_PIN` cannot be used with this feature; continuous polling of `get_report()` is needed to generate glide reports.\\n:::\", \"High Resolution Scrolling\": \"| Setting | Description | Default |\\n| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------- |\\n| `POINTING_DEVICE_HIRES_SCROLL_ENABLE` | (Optional) Enables high resolution scrolling. | _not defined_ |\\n| `POINTING_DEVICE_HIRES_SCROLL_MULTIPLIER`| (Optional) Resolution mutiplier value used by high resolution scrolling. Must be between 1 and 127, inclusive. | `120` |\\n| `POINTING_DEVICE_HIRES_SCROLL_EXPONENT` | (Optional) Resolution exponent value used by high resolution scrolling. Must be between 0 and 127, inclusive. | `0` |\\n\\nThe `POINTING_DEVICE_HIRES_SCROLL_ENABLE` setting enables smooth and continuous scrolling when using trackballs or high-end encoders as mouse wheels (as opposed to the typical stepped behavior of most mouse wheels).\\nThis works by adding a resolution multiplier to the HID descriptor for mouse wheel reports, causing the host computer to interpret each wheel tick sent by the keyboard as a fraction of a normal wheel tick.\\nThe resolution multiplier is set to `1 / (POINTING_DEVICE_HIRES_SCROLL_MULTIPLIER * (10 ^ POINTING_DEVICE_HIRES_SCROLL_EXPONENT))`, which is `1 / 120` by default.\\nIf even smoother scrolling than provided by this default value is desired, first try using `#define POINTING_DEVICE_HIRES_SCROLL_EXPONENT 1` which will result in a multiplier of `1 / 1200`.\\n\\nThe function `pointing_device_get_hires_scroll_resolution()` can be called to get the pre-computed resolution multiplier value as a `uint16_t`.\\n\\n::: warning\\nHigh resolution scrolling usually results in larger and/or more frequent mouse reports. This can result in overflow errors and overloading of the host computer's input buffer. \\nTo deal with these issues, define `WHEEL_EXTENDED_REPORT` and throttle the rate at which mouse reports are sent.\\n:::\\n\\n::: warning\\nMany programs, especially those that implement their own smoothing for scrolling, don't work well when they receive simultaneous vertical and horizontal wheel inputs (e.g. from high resolution drag-scroll using a trackball).\\nThese programs typically implement their smoothing in a way that assumes the user will only scroll in one axis at a time, resulting in slow or jittery motion when trying to scroll at an angle.\\nThis can be addressed by snapping scrolling to one axis at a time.\\n:::\", \"Split Keyboard Configuration\": \"The following configuration options are only available when using `SPLIT_POINTING_ENABLE` see [data sync options](split_keyboard#data-sync-options). The rotation and invert `*_RIGHT` options are only used with `POINTING_DEVICE_COMBINED`. If using `POINTING_DEVICE_LEFT` or `POINTING_DEVICE_RIGHT` use the common configuration above to configure your pointing device.\\n\\n| Setting | Description | Default |\\n| ------------------------------------ | ----------------------------------------------------------------------------------------------------- | ------------- |\\n| `POINTING_DEVICE_LEFT` | Pointing device on the left side (Required - pick one only) | _not defined_ |\\n| `POINTING_DEVICE_RIGHT` | Pointing device on the right side (Required - pick one only) | _not defined_ |\\n| `POINTING_DEVICE_COMBINED` | Pointing device on both sides (Required - pick one only) | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_90_RIGHT` | (Optional) Rotates the X and Y data by 90 degrees. | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_180_RIGHT` | (Optional) Rotates the X and Y data by 180 degrees. | _not defined_ |\\n| `POINTING_DEVICE_ROTATION_270_RIGHT` | (Optional) Rotates the X and Y data by 270 degrees. | _not defined_ |\\n| `POINTING_DEVICE_INVERT_X_RIGHT` | (Optional) Inverts the X axis report. | _not defined_ |\\n| `POINTING_DEVICE_INVERT_Y_RIGHT` | (Optional) Inverts the Y axis report. | _not defined_ |\\n\\n::: warning\\nIf there is a `_RIGHT` configuration option or callback, the [common configuration](pointing_device#common-configuration) option will work for the left. For correct left/right detection you should setup a [handedness option](split_keyboard#setting-handedness), `EE_HANDS` is usually a good option for an existing board that doesn't do handedness by hardware.\\n:::\", \"Callbacks and Functions \": \"| Function | Description |\\n| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |\\n| `pointing_device_init_kb(void)` | Callback to allow for keyboard level initialization. Useful for additional hardware sensors. |\\n| `pointing_device_init_user(void)` | Callback to allow for user level initialization. Useful for additional hardware sensors. |\\n| `pointing_device_task_kb(mouse_report)` | Callback that sends sensor data, so keyboard code can intercept and modify the data. Returns a mouse report. |\\n| `pointing_device_task_user(mouse_report)` | Callback that sends sensor data, so user code can intercept and modify the data. Returns a mouse report. |\\n| `pointing_device_handle_buttons(buttons, pressed, button)` | Callback to handle hardware button presses. Returns a `uint8_t`. |\\n| `pointing_device_get_cpi(void)` | Gets the current CPI/DPI setting from the sensor, if supported. |\\n| `pointing_device_set_cpi(uint16_t)` | Sets the CPI/DPI, if supported. |\\n| `pointing_device_get_report(void)` | Returns the current mouse report (as a `report_mouse_t` data structure). |\\n| `pointing_device_set_report(mouse_report)` | Sets the mouse report to the assigned `report_mouse_t` data structured passed to the function. |\\n| `pointing_device_send(void)` | Sends the current mouse report to the host system. Function can be replaced. |\\n| `has_mouse_report_changed(new_report, old_report)` | Compares the old and new `report_mouse_t` data and returns true only if it has changed. |\\n| `pointing_device_adjust_by_defines(mouse_report)` | Applies rotations and invert configurations to a raw mouse report. |\", \"Split Keyboard Callbacks and Functions\": \"The combined functions below are only available when using `SPLIT_POINTING_ENABLE` and `POINTING_DEVICE_COMBINED`. The 2 callbacks `pointing_device_task_combined_*` replace the single sided equivalents above. See the [combined pointing devices example](pointing_device#combined-pointing-devices)\\n\\n| Function | Description |\\n| --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |\\n| `pointing_device_set_shared_report(mouse_report)` | Sets the shared mouse report to the assigned `report_mouse_t` data structured passed to the function. |\\n| `pointing_device_set_cpi_on_side(bool, uint16_t)` | Sets the CPI/DPI of one side, if supported. Passing `true` will set the left and `false` the right |\\n| `pointing_device_combine_reports(left_report, right_report)` | Returns a combined mouse_report of left_report and right_report (as a `report_mouse_t` data structure) |\\n| `pointing_device_task_combined_kb(left_report, right_report)` | Callback, so keyboard code can intercept and modify the data. Returns a combined mouse report. |\\n| `pointing_device_task_combined_user(left_report, right_report)` | Callback, so user code can intercept and modify. Returns a combined mouse report using `pointing_device_combine_reports` |\\n| `pointing_device_adjust_by_defines_right(mouse_report)` | Applies right side rotations and invert configurations to a raw mouse report. |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 27]\"}, {\"title\": \"Programmable Button {#programmable-button}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nPROGRAMMABLE_BUTTON_ENABLE = yes\\n```\", \"Keycodes {#keycodes}\": \"|Key |Aliases|Description |\\n|---------------------------|-------|----------------------|\\n|`QK_PROGRAMMABLE_BUTTON_1` |`PB_1` |Programmable button 1 |\\n|`QK_PROGRAMMABLE_BUTTON_2` |`PB_2` |Programmable button 2 |\\n|`QK_PROGRAMMABLE_BUTTON_3` |`PB_3` |Programmable button 3 |\\n|`QK_PROGRAMMABLE_BUTTON_4` |`PB_4` |Programmable button 4 |\\n|`QK_PROGRAMMABLE_BUTTON_5` |`PB_5` |Programmable button 5 |\\n|`QK_PROGRAMMABLE_BUTTON_6` |`PB_6` |Programmable button 6 |\\n|`QK_PROGRAMMABLE_BUTTON_7` |`PB_7` |Programmable button 7 |\\n|`QK_PROGRAMMABLE_BUTTON_8` |`PB_8` |Programmable button 8 |\\n|`QK_PROGRAMMABLE_BUTTON_9` |`PB_9` |Programmable button 9 |\\n|`QK_PROGRAMMABLE_BUTTON_10`|`PB_10`|Programmable button 10|\\n|`QK_PROGRAMMABLE_BUTTON_11`|`PB_11`|Programmable button 11|\\n|`QK_PROGRAMMABLE_BUTTON_12`|`PB_12`|Programmable button 12|\\n|`QK_PROGRAMMABLE_BUTTON_13`|`PB_13`|Programmable button 13|\\n|`QK_PROGRAMMABLE_BUTTON_14`|`PB_14`|Programmable button 14|\\n|`QK_PROGRAMMABLE_BUTTON_15`|`PB_15`|Programmable button 15|\\n|`QK_PROGRAMMABLE_BUTTON_16`|`PB_16`|Programmable button 16|\\n|`QK_PROGRAMMABLE_BUTTON_17`|`PB_17`|Programmable button 17|\\n|`QK_PROGRAMMABLE_BUTTON_18`|`PB_18`|Programmable button 18|\\n|`QK_PROGRAMMABLE_BUTTON_19`|`PB_19`|Programmable button 19|\\n|`QK_PROGRAMMABLE_BUTTON_20`|`PB_20`|Programmable button 20|\\n|`QK_PROGRAMMABLE_BUTTON_21`|`PB_21`|Programmable button 21|\\n|`QK_PROGRAMMABLE_BUTTON_22`|`PB_22`|Programmable button 22|\\n|`QK_PROGRAMMABLE_BUTTON_23`|`PB_23`|Programmable button 23|\\n|`QK_PROGRAMMABLE_BUTTON_24`|`PB_24`|Programmable button 24|\\n|`QK_PROGRAMMABLE_BUTTON_25`|`PB_25`|Programmable button 25|\\n|`QK_PROGRAMMABLE_BUTTON_26`|`PB_26`|Programmable button 26|\\n|`QK_PROGRAMMABLE_BUTTON_27`|`PB_27`|Programmable button 27|\\n|`QK_PROGRAMMABLE_BUTTON_28`|`PB_28`|Programmable button 28|\\n|`QK_PROGRAMMABLE_BUTTON_29`|`PB_29`|Programmable button 29|\\n|`QK_PROGRAMMABLE_BUTTON_30`|`PB_30`|Programmable button 30|\\n|`QK_PROGRAMMABLE_BUTTON_31`|`PB_31`|Programmable button 31|\\n|`QK_PROGRAMMABLE_BUTTON_32`|`PB_32`|Programmable button 32|\", \"API {#api}\": {\"`void programmable_button_clear(void)` {#api-programmable-button-clear}\": \"Clear the programmable button report.\\n\\n[]\", \"`void programmable_button_add(uint8_t index)` {#api-programmable-button-add}\": {\"Arguments {#api-programmable-button-add-arguments}\": [\"`uint8_t index` \\nThe index of the button to press, from 0 to 31.\"]}, \"`void programmable_button_remove(uint8_t index)` {#api-programmable-button-remove}\": {\"Arguments {#api-programmable-button-remove-arguments}\": [\"`uint8_t index` \\nThe index of the button to release, from 0 to 31.\"]}, \"`void programmable_button_register(uint8_t index)` {#api-programmable-button-register}\": {\"Arguments {#api-programmable-button-register-arguments}\": [\"`uint8_t index` \\nThe index of the button to press, from 0 to 31.\"]}, \"`void programmable_button_unregister(uint8_t index)` {#api-programmable-button-unregister}\": {\"Arguments {#api-programmable-button-unregister-arguments}\": [\"`uint8_t index` \\nThe index of the button to release, from 0 to 31.\"]}, \"`bool programmable_button_is_on(uint8_t index)` {#api-programmable-button-is-on}\": {\"Arguments {#api-programmable-button-is-on-arguments}\": [\"`uint8_t index` \\nThe index of the button to check, from 0 to 31.\"], \"Return Value {#api-programmable-button-is-on-return}\": \"`true` if the button is pressed.\\n\\n[]\"}, \"`void programmable_button_flush(void)` {#api-programmable-button-flush}\": \"Send the programmable button report to the host.\\n\\n[]\", \"`uint32_t programmable_button_get_report(void)` {#api-programmable-button-get-report}\": {\"Return Value {#api-programmable-button-get-report-return}\": \"The bitmask of programmable button states.\\n\\n[]\"}, \"`void programmable_button_set_report(uint32_t report)` {#api-programmable-button-set-report}\": {\"Arguments {#api-programmable-button-set-report-arguments}\": [\"`uint32_t report` \\nA bitmask of programmable button states.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 28]\"}, {\"title\": \"PS/2 Mouse Support {#ps2-mouse-support}\", \"description\": null, \"content\": {\"The Circuitry between Trackpoint and Controller {#the-circuitry-between-trackpoint-and-controller}\": \"To get the things working, a 4.7K drag is needed between the two lines DATA and CLK and the line 5+. \\n\\n```\\n\\n DATA ----------+--------- PIN\\n |\\n 4.7K\\n |\\nMODULE 5+ --------+--+--------- PWR CONTROLLER\\n |\\n 4.7K\\n | \\n CLK ------+------------ PIN\\n```\", \"Driver Configuration {#driver-configuration}\": {\"Busywait Driver {#busywait-driver}\": \"Note: This is not recommended, you may encounter jerky movement or unsent inputs. Please use interrupt or USART version if possible.\\n\\nIn rules.mk:\\n\\n```\\nPS2_MOUSE_ENABLE = yes\\nPS2_ENABLE = yes\\nPS2_DRIVER = busywait\\n```\\n\\nIn your keyboard config.h:\\n\\n```\\n#ifdef PS2_DRIVER_BUSYWAIT\\n# define PS2_CLOCK_PIN D1\\n# define PS2_DATA_PIN D2\\n#endif\\n```\", \"Interrupt Driver (AVR/ATMega32u4) {#interrupt-driver-avr}\": \"The following example uses D2 for clock and D5 for data. You can use any INT or PCINT pin for clock, and any pin for data.\\n\\nIn rules.mk:\\n\\n```\\nPS2_MOUSE_ENABLE = yes\\nPS2_ENABLE = yes\\nPS2_DRIVER = interrupt\\n```\\n\\nIn your keyboard config.h:\\n\\n```\\n#ifdef PS2_DRIVER_INTERRUPT\\n#define PS2_CLOCK_PIN D2\\n#define PS2_DATA_PIN D5\\n\\n#define PS2_INT_INIT() do { \\\\\\n EICRA |= ((1<<ISC21) | \\\\\\n (0<<ISC20)); \\\\\\n} while (0)\\n#define PS2_INT_ON() do { \\\\\\n EIMSK |= (1<<INT2); \\\\\\n} while (0)\\n#define PS2_INT_OFF() do { \\\\\\n EIMSK &= ~(1<<INT2); \\\\\\n} while (0)\\n#define PS2_INT_VECT INT2_vect\\n#endif\\n```\", \"Interrupt Driver (ARM chibios) {#interrupt-driver-chibios}\": \"Pretty much any two pins can be used for the (software) interrupt variant on ARM cores. The example below uses A8 for clock, and A9 for data.\\n\\nIn rules.mk:\\n\\n```\\nPS2_MOUSE_ENABLE = yes\\nPS2_ENABLE = yes\\nPS2_DRIVER = interrupt\\n```\\n\\nIn your keyboard `config.h`:\\n\\n```\\n#define PS2_CLOCK_PIN A8\\n#define PS2_DATA_PIN A9\\n```\\n\\nAnd in the ChibiOS specific `halconf.h`:\\n\\n```\\n#pragma once\\n\\n#define PAL_USE_CALLBACKS TRUE // [!code focus]\\n\\n#include_next <halconf.h>\\n```\", \"USART Driver {#usart-driver}\": \"To use USART on the ATMega32u4, you have to use PD5 for clock and PD2 for data. If one of those are unavailable, you need to use interrupt version.\\n\\nIn rules.mk:\\n\\n```\\nPS2_MOUSE_ENABLE = yes\\nPS2_ENABLE = yes\\nPS2_DRIVER = usart\\n```\\n\\nIn your keyboard config.h:\\n\\n```\\n#ifdef PS2_DRIVER_USART\\n#define PS2_CLOCK_PIN D5\\n#define PS2_DATA_PIN D2\\n\\n/* synchronous, odd parity, 1-bit stop, 8-bit data, sample at falling edge */\\n/* set DDR of CLOCK as input to be slave */\\n#define PS2_USART_INIT() do { \\\\\\n PS2_CLOCK_DDR &= ~(1<<PS2_CLOCK_BIT); \\\\\\n PS2_DATA_DDR &= ~(1<<PS2_DATA_BIT); \\\\\\n UCSR1C = ((1 << UMSEL10) | \\\\\\n (3 << UPM10) | \\\\\\n (0 << USBS1) | \\\\\\n (3 << UCSZ10) | \\\\\\n (0 << UCPOL1)); \\\\\\n UCSR1A = 0; \\\\\\n UBRR1H = 0; \\\\\\n UBRR1L = 0; \\\\\\n} while (0)\\n#define PS2_USART_RX_INT_ON() do { \\\\\\n UCSR1B = ((1 << RXCIE1) | \\\\\\n (1 << RXEN1)); \\\\\\n} while (0)\\n#define PS2_USART_RX_POLL_ON() do { \\\\\\n UCSR1B = (1 << RXEN1); \\\\\\n} while (0)\\n#define PS2_USART_OFF() do { \\\\\\n UCSR1C = 0; \\\\\\n UCSR1B &= ~((1 << RXEN1) | \\\\\\n (1 << TXEN1)); \\\\\\n} while (0)\\n#define PS2_USART_RX_READY (UCSR1A & (1<<RXC1))\\n#define PS2_USART_RX_DATA UDR1\\n#define PS2_USART_ERROR (UCSR1A & ((1<<FE1) | (1<<DOR1) | (1<<UPE1)))\\n#define PS2_USART_RX_VECT USART1_RX_vect\\n#endif\\n```\", \"RP2040 PIO Driver {#rp2040-pio-driver}\": \"The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU.\\n\\nThere are strict requirements for pin ordering but any pair of GPIO pins can be used. The GPIO used for clock must be directly after data, see the included info.json snippet for an example of correct order.\\n\\nYou may optionally switch the PIO peripheral used with the following define in config.h:\\n\\n```\\n#define PS2_PIO_USE_PIO1 // Force the usage of PIO1 peripheral, by default the PS2 implementation uses the PIO0 peripheral\\n```\\n\\nExample info.json content:\\n\\n```\\n \\\"ps2\\\": {\\n \\\"clock_pin\\\": \\\"GP1\\\",\\n \\\"data_pin\\\": \\\"GP0\\\",\\n \\\"driver\\\": \\\"vendor\\\",\\n \\\"enabled\\\": true,\\n \\\"mouse_enabled\\\": true\\n }\\n```\"}, \"Additional Settings {#additional-settings}\": {\"PS/2 Mouse Features {#ps2-mouse-features}\": \"These enable settings supported by the PS/2 mouse protocol.\\n\\n```\\n/* Use remote mode instead of the default stream mode (see link) */\\n#define PS2_MOUSE_USE_REMOTE_MODE\\n\\n/* Enable the scrollwheel or scroll gesture on your mouse or touchpad */\\n#define PS2_MOUSE_ENABLE_SCROLLING\\n\\n/* Some mice will need a scroll mask to be configured. The default is 0xFF. */\\n#define PS2_MOUSE_SCROLL_MASK 0x0F\\n\\n/* Applies a transformation to the movement before sending to the host (see link) */\\n#define PS2_MOUSE_USE_2_1_SCALING\\n\\n/* The time to wait after initializing the ps2 host */\\n#define PS2_MOUSE_INIT_DELAY 1000 /* Default */\\n```\\n\\nYou can also call the following functions from ps2_mouse.h\\n\\n```\\nvoid ps2_mouse_disable_data_reporting(void);\\n\\nvoid ps2_mouse_enable_data_reporting(void);\\n\\nvoid ps2_mouse_set_remote_mode(void);\\n\\nvoid ps2_mouse_set_stream_mode(void);\\n\\nvoid ps2_mouse_set_scaling_2_1(void);\\n\\nvoid ps2_mouse_set_scaling_1_1(void);\\n\\nvoid ps2_mouse_set_resolution(ps2_mouse_resolution_t resolution);\\n\\nvoid ps2_mouse_set_sample_rate(ps2_mouse_sample_rate_t sample_rate);\\n```\", \"Fine Control {#fine-control}\": \"Use the following defines to change the sensitivity and speed of the mouse.\\nNote: you can also use `ps2_mouse_set_resolution` for the same effect (not supported on most touchpads).\\n\\n```\\n#define PS2_MOUSE_X_MULTIPLIER 3\\n#define PS2_MOUSE_Y_MULTIPLIER 3\\n#define PS2_MOUSE_V_MULTIPLIER 1\\n```\", \"Scroll Button {#scroll-button}\": \"If you're using a trackpoint, you will likely want to be able to use it for scrolling.\\nIt's possible to enable a \\\"scroll button/s\\\" that when pressed will cause the mouse to scroll instead of moving.\\nTo enable the feature, you must set a scroll button mask as follows:\\n\\n```\\n#define PS2_MOUSE_SCROLL_BTN_MASK (1<<PS2_MOUSE_BTN_MIDDLE) /* Default */\\n```\\n\\nTo disable the scroll button feature:\\n\\n```\\n#define PS2_MOUSE_SCROLL_BTN_MASK 0\\n```\\n\\nThe available buttons are:\\n\\n```\\n#define PS2_MOUSE_BTN_LEFT 0\\n#define PS2_MOUSE_BTN_RIGHT 1\\n#define PS2_MOUSE_BTN_MIDDLE 2\\n```\\n\\nYou can also combine buttons in the mask by `|`ing them together.\\n\\nOnce you've configured your scroll button mask, you must configure the scroll button send interval.\\nThis is the interval before which if the scroll buttons were released they would be sent to the host.\\nAfter this interval, they will cause the mouse to scroll and will not be sent.\\n\\n```\\n#define PS2_MOUSE_SCROLL_BTN_SEND 300 /* Default */\\n```\\n\\nTo disable sending the scroll buttons:\\n\\n```\\n#define PS2_MOUSE_SCROLL_BTN_SEND 0\\n```\\n\\nFine control over the scrolling is supported with the following defines:\\n\\n```\\n#define PS2_MOUSE_SCROLL_DIVISOR_H 2\\n#define PS2_MOUSE_SCROLL_DIVISOR_V 2\\n```\", \"Invert Mouse buttons {#invert-buttons}\": \"To invert the left & right buttons you can put:\\n\\n```\\n#define PS2_MOUSE_INVERT_BUTTONS\\n```\\n\\ninto config.h.\", \"Invert Mouse and Scroll Axes {#invert-mouse-and-scroll-axes}\": \"To invert the X and Y axes you can put:\\n\\n```\\n#define PS2_MOUSE_INVERT_X\\n#define PS2_MOUSE_INVERT_Y\\n```\\n\\ninto config.h.\\n\\nTo reverse the scroll axes you can put:\\n\\n```\\n#define PS2_MOUSE_INVERT_H\\n#define PS2_MOUSE_INVERT_V\\n```\\n\\ninto config.h.\", \"Rotate Mouse Axes {#rotate-mouse-axes}\": \"Transform the output of the device with a clockwise rotation of 90, 180, or 270\\ndegrees.\\n\\nWhen compensating for device orientation, rotate the output the same amount in\\nthe opposite direction. E.g. if the normal device orientation is considered to\\nbe North-facing, compensate as follows:\\n\\n```\\n#define PS2_MOUSE_ROTATE 270 /* Compensate for East-facing device orientation. */\\n```\\n\\n```\\n#define PS2_MOUSE_ROTATE 180 /* Compensate for South-facing device orientation. */\\n```\\n\\n```\\n#define PS2_MOUSE_ROTATE 90 /* Compensate for West-facing device orientation. */\\n```\", \"Debug Settings {#debug-settings}\": \"To debug the mouse, add `debug_mouse = true` or enable via bootmagic.\\n\\n```\\n/* To debug the mouse reports */\\n#define PS2_MOUSE_DEBUG_HID\\n#define PS2_MOUSE_DEBUG_RAW\\n```\", \"Movement Hook {#movement-hook}\": \"Process mouse movement in the keymap before it is sent to the host. Example\\nuses include filtering noise, adding acceleration, and automatically activating\\na layer. To use, define the following function in your keymap:\\n\\n```\\nvoid ps2_mouse_moved_user(report_mouse_t *mouse_report);\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 29]\"}, {\"title\": \"Raw HID {#raw-hid}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Add the following to your `rules.mk`:\\n\\n```\\nRAW_ENABLE = yes\\n```\", \"Basic Configuration {#basic-configuration}\": \"By default, the HID Usage Page and Usage ID for the Raw HID interface are `0xFF60` and `0x61`. However, they can be changed if necessary by adding the following to your `config.h`:\\n\\n|Define |Default |Description |\\n|----------------|--------|---------------------------------------|\\n|`RAW_USAGE_PAGE`|`0xFF60`|The usage page of the Raw HID interface|\\n|`RAW_USAGE_ID` |`0x61` |The usage ID of the Raw HID interface |\", \"Sending Data to the Keyboard {#sending-data-to-the-keyboard}\": \"To send data to the keyboard, you must first find a library for communicating with HID devices in the programming language of your choice. Here are some examples:\\n\\n['**Node.js:** [node-hid](https://github.com/node-hid/node-hid)', '**C/C++:** [hidapi](https://github.com/libusb/hidapi)', '**Java:** [purejavahidapi](https://github.com/nyholku/purejavahidapi) and [hid4java](https://github.com/gary-rowe/hid4java)', '**Python:** [pyhidapi](https://pypi.org/project/hid/) and [pywinusb](https://pypi.org/project/pywinusb)']\\n\\nPlease refer to these libraries' own documentation for instructions on usage. Remember to close the device once you are finished with it!\\n\\nNext, you will need to know the USB Vendor and Product IDs of the device. These can easily be found by looking at your keyboard's `info.json`, under the `usb` object (alternatively, you can also use Device Manager on Windows, System Information on macOS, or `lsusb` on Linux). For example, the Vendor ID for the Planck Rev 6 is `0x03A8`, and the Product ID is `0xA4F9`.\\n\\nIt's also a good idea to narrow down the list of potential HID devices the library may give you by filtering on the usage page and usage ID, to avoid accidentally opening the interface on the same device for the keyboard, or mouse, or media keys, etc.\\n\\nOnce you are able to open the HID device and send reports to it, it's time to handle them on the keyboard side. Implement the following function in your `keymap.c` and start coding:\\n\\n```\\nvoid raw_hid_receive(uint8_t *data, uint8_t length) {\\n // Your code goes here\\n // `data` is a pointer to the buffer containing the received HID report\\n // `length` is the length of the report - always `RAW_EPSIZE`\\n}\\n```\\n\\n::: warning\\nBecause the HID specification does not support variable length reports, all reports in both directions must be exactly `RAW_EPSIZE` (currently 32) bytes long, regardless of actual payload length. However, variable length payloads can potentially be implemented on top of this by creating your own data structure that may span multiple reports.\\n:::\", \"Receiving Data from the Keyboard {#receiving-data-from-the-keyboard}\": \"If you need the keyboard to send data back to the host, simply call the `raw_hid_send()` function. It requires two arguments - a pointer to a 32-byte buffer containing the data you wish to send, and the length (which should always be `RAW_EPSIZE`).\\n\\nThe received report can then be handled in whichever way your HID library provides.\", \"Simple Example {#simple-example}\": \"The following example reads the first byte of the received report from the host, and if it is an ASCII \\\"A\\\", responds with \\\"B\\\". `memset()` is used to fill the response buffer (which could still contain the previous response) with null bytes.\\n\\n```\\nvoid raw_hid_receive(uint8_t *data, uint8_t length) {\\n uint8_t response[length];\\n memset(response, 0, length);\\n response[0] = 'B';\\n\\n if(data[0] == 'A') {\\n raw_hid_send(response, length);\\n }\\n}\\n```\\n\\nOn the host side (here we are using Python and the `pyhidapi` library), the HID device is opened by enumerating the interfaces on the USB device, then filtering on the usage page and usage ID. Then, a report containing a single ASCII \\\"A\\\" (hex `0x41`) is constructed and sent.\\n\\nFor demonstration purposes, the manufacturer and product strings of the device, along with the request and response, are also printed.\\n\\n```\\nimport sys\\nimport hid\\n\\nvendor_id = 0x4335\\nproduct_id = 0x0002\\n\\nusage_page = 0xFF60\\nusage = 0x61\\nreport_length = 32\\n\\ndef get_raw_hid_interface():\\n device_interfaces = hid.enumerate(vendor_id, product_id)\\n raw_hid_interfaces = [i for i in device_interfaces if i['usage_page'] == usage_page and i['usage'] == usage]\\n\\n if len(raw_hid_interfaces) == 0:\\n return None\\n\\n interface = hid.Device(path=raw_hid_interfaces[0]['path'])\\n\\n print(f\\\"Manufacturer: {interface.manufacturer}\\\")\\n print(f\\\"Product: {interface.product}\\\")\\n\\n return interface\\n\\ndef send_raw_report(data):\\n interface = get_raw_hid_interface()\\n\\n if interface is None:\\n print(\\\"No device found\\\")\\n sys.exit(1)\\n\\n request_data = [0x00] * (report_length + 1) # First byte is Report ID\\n request_data[1:len(data) + 1] = data\\n request_report = bytes(request_data)\\n\\n print(\\\"Request:\\\")\\n print(request_report)\\n\\n try:\\n interface.write(request_report)\\n\\n response_report = interface.read(report_length, timeout=1000)\\n\\n print(\\\"Response:\\\")\\n print(response_report)\\n finally:\\n interface.close()\\n\\nif __name__ == '__main__':\\n send_raw_report([\\n 0x41\\n ])\\n```\", \"API {#api}\": {\"`void raw_hid_receive(uint8_t *data, uint8_t length)` {#api-raw-hid-receive}\": {\"Arguments {#api-raw-hid-receive-arguments}\": [\"`uint8_t *data` \\nA pointer to the received data. Always 32 bytes in length.\", \"`uint8_t length` \\nThe length of the buffer. Always 32.\"]}, \"`void raw_hid_send(uint8_t *data, uint8_t length)` {#api-raw-hid-send}\": {\"Arguments {#api-raw-hid-send-arguments}\": [\"`uint8_t *data` \\nA pointer to the data to send. Must always be 32 bytes in length.\", \"`uint8_t length` \\nThe length of the buffer. Must always be 32.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 30]\"}, {\"title\": \"Repeat Key\", \"description\": null, \"content\": {\"How do I enable Repeat Key\": \"In your `rules.mk`, add:\\n\\n```\\nREPEAT_KEY_ENABLE = yes\\n```\\n\\nThen pick a key in your keymap and assign it the keycode `QK_REPEAT_KEY` (short\\nalias `QK_REP`). Optionally, use the keycode `QK_ALT_REPEAT_KEY` (short alias\\n`QK_AREP`) on another key.\", \"Keycodes\": \"|Keycode |Aliases |Description |\\n|-----------------------|---------|-------------------------------------|\\n|`QK_REPEAT_KEY` |`QK_REP` |Repeat the last pressed key |\\n|`QK_ALT_REPEAT_KEY` |`QK_AREP`|Perform alternate of the last key |\", \"Alternate Repeating\": \"The Alternate Repeat Key performs the \\\"alternate\\\" action of the last pressed key\\nif it is defined. By default, Alternate Repeat is defined for navigation keys to\\nact in the reverse direction. When the last key is the common \\\"select by word\\\"\\nhotkey Ctrl + Shift + Right Arrow, the Alternate Repeat Key performs Ctrl +\\nShift + Left Arrow, which together with the Repeat Key enables convenient\\nselection by words in either direction.\\n\\nAlternate Repeat is enabled with the Repeat Key by default. Optionally, to\\nreduce firmware size, Alternate Repeat may be disabled by adding in config.h:\\n\\n```\\n#define NO_ALT_REPEAT_KEY\\n```\\n\\nThe following alternate keys are defined by default. See\\n`get_alt_repeat_key_keycode_user()` below for how to change or add to these\\ndefinitions. Where it makes sense, these definitions also include combinations \\nwith mods, like Ctrl + Left ↔ Ctrl + Right Arrow.\\n\\n**Navigation** \\n\\n|Keycodes |Description |\\n|-----------------------------------|-----------------------------------|\\n|`KC_LEFT` ↔ `KC_RGHT` | Left ↔ Right Arrow |\\n|`KC_UP` ↔ `KC_DOWN` | Up ↔ Down Arrow |\\n|`KC_HOME` ↔ `KC_END` | Home ↔ End |\\n|`KC_PGUP` ↔ `KC_PGDN` | Page Up ↔ Page Down |\\n|`MS_LEFT` ↔ `MS_RGHT` | Mouse Cursor Left ↔ Right |\\n|`MS_UP` ↔ `MS_DOWN` | Mouse Cursor Up ↔ Down |\\n|`MS_WHLL` ↔ `MS_WHLR` | Mouse Wheel Left ↔ Right |\\n|`MS_WHLU` ↔ `MS_WHLD` | Mouse Wheel Up ↔ Down |\\n\\n**Misc** \\n\\n|Keycodes |Description |\\n|-----------------------------------|-----------------------------------|\\n|`KC_BSPC` ↔ `KC_DEL` | Backspace ↔ Delete |\\n|`KC_LBRC` ↔ `KC_RBRC` | `[` ↔ `]` |\\n|`KC_LCBR` ↔ `KC_RCBR` | `{` ↔ `}` |\\n\\n**Media** \\n\\n|Keycodes |Description |\\n|-----------------------------------|-----------------------------------|\\n|`KC_WBAK` ↔ `KC_WFWD` | Browser Back ↔ Forward |\\n|`KC_MNXT` ↔ `KC_MPRV` | Next ↔ Previous Media Track |\\n|`KC_MFFD` ↔ `KC_MRWD` | Fast Forward ↔ Rewind Media |\\n|`KC_VOLU` ↔ `KC_VOLD` | Volume Up ↔ Down |\\n|`KC_BRIU` ↔ `KC_BRID` | Brightness Up ↔ Down |\\n\\n**Hotkeys in Vim, Emacs, and other programs**\\n\\n|Keycodes |Description |\\n|-----------------------------------|-----------------------------------|\\n|mod + `KC_F` ↔ mod + `KC_B` | Forward ↔ Backward |\\n|mod + `KC_D` ↔ mod + `KC_U` | Down ↔ Up |\\n|mod + `KC_N` ↔ mod + `KC_P` | Next ↔ Previous |\\n|mod + `KC_A` ↔ mod + `KC_E` | Home ↔ End |\\n|mod + `KC_O` ↔ mod + `KC_I` | Vim jump list Older ↔ Newer |\\n|`KC_J` ↔ `KC_K` | Down ↔ Up |\\n|`KC_H` ↔ `KC_L` | Left ↔ Right |\\n|`KC_W` ↔ `KC_B` | Forward ↔ Backward by Word |\\n\\n(where above, \\\"mod\\\" is Ctrl, Alt, or GUI)\", \"Defining alternate keys\": \"Use the `get_alt_repeat_key_keycode_user()` callback to define the \\\"alternate\\\"\\nfor additional keys or override the default definitions. For example, to define\\nCtrl + Y as the alternate of Ctrl + Z, and vice versa, add the following in\\nkeymap.c:\\n\\n```\\nuint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {\\n if ((mods & MOD_MASK_CTRL)) { // Was Ctrl held?\\n switch (keycode) {\\n case KC_Y: return C(KC_Z); // Ctrl + Y reverses to Ctrl + Z.\\n case KC_Z: return C(KC_Y); // Ctrl + Z reverses to Ctrl + Y.\\n }\\n }\\n\\n return KC_TRNS; // Defer to default definitions.\\n}\\n```\\n\\nThe `keycode` and `mods` args are the keycode and mods that were active with the\\nlast pressed key. The meaning of the return value from this function is:\\n\\n['`KC_NO` – do nothing (any predefined alternate key is not used);', '`KC_TRNS` – use the default alternate key if it exists;', 'anything else – use the specified keycode. Any keycode may be returned\\\\nas an alternate key, including custom keycodes.']\\n\\nAnother example, defining Shift + Tab as the alternate of Tab, and vice versa:\\n\\n```\\nuint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {\\n bool shifted = (mods & MOD_MASK_SHIFT); // Was Shift held?\\n switch (keycode) {\\n case KC_TAB:\\n if (shifted) { // If the last key was Shift + Tab,\\n return KC_TAB; // ... the reverse is Tab.\\n } else { // Otherwise, the last key was Tab,\\n return S(KC_TAB); // ... and the reverse is Shift + Tab.\\n }\\n }\\n\\n return KC_TRNS;\\n}\\n```\\n\\nEliminating SFBs\\n\\nAlternate Repeat can be configured more generally to perform an action that\\n\\\"complements\\\" the last key. Alternate Repeat is not limited to reverse\\nrepeating, and it need not be symmetric. You can use it to eliminate cases of\\nsame-finger bigrams in your layout, that is, pairs of letters typed by the same\\nfinger. The following addresses the top 5 same-finger bigrams in English on\\nQWERTY, so that for instance \\\"`ed`\\\" may be typed as <kbd>E</kbd>, <kbd>Alt\\nRepeat</kbd>.\\n\\n```\\nuint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {\\n switch (keycode) {\\n case KC_E: return KC_D; // For \\\"ED\\\" bigram.\\n case KC_D: return KC_E; // For \\\"DE\\\" bigram.\\n case KC_C: return KC_E; // For \\\"CE\\\" bigram.\\n case KC_L: return KC_O; // For \\\"LO\\\" bigram.\\n case KC_U: return KC_N; // For \\\"UN\\\" bigram.\\n }\\n\\n return KC_TRNS;\\n}\\n```\\n\\nTyping shortcuts\\n\\nA useful possibility is having Alternate Repeat press [a\\nmacro](../feature_macros). This way macros can be used without having to\\ndedicate keys to them. The following defines a couple shortcuts.\\n\\n['Typing <kbd>K</kbd>, <kbd>Alt Repeat</kbd> produces \\\"`keyboard`,\\\" with the\\\\ninitial \\\"`k`\\\" typed as usual and the \\\"`eybord`\\\" produced by the macro. ', 'Typing <kbd>.</kbd>, <kbd>Alt Repeat</kbd> produces \\\"`../`,\\\" handy for \\\"up\\\\ndirectory\\\" on the shell. Similary, <kbd>.</kbd> types the initial \\\"`.`\\\" and \\\\n\\\"`./`\\\" is produced by the macro.']\\n\\n```\\nenum custom_keycodes {\\n M_KEYBOARD = SAFE_RANGE,\\n M_UPDIR,\\n // Other custom keys...\\n};\\n\\nuint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {\\n switch (keycode) {\\n case KC_K: return M_KEYBOARD;\\n case KC_DOT: return M_UPDIR;\\n }\\n\\n return KC_TRNS;\\n}\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t* record) {\\n switch (keycode) {\\n case M_KEYBOARD: SEND_STRING(/*k*/\\\"eyboard\\\"); break;\\n case M_UPDIR: SEND_STRING(/*.*/\\\"./\\\"); break;\\n }\\n return true;\\n}\\n```\", \"Ignoring certain keys and mods\": \"In tracking what is \\\"the last key\\\" to be repeated or alternate repeated,\\nmodifier and layer switch keys are always ignored. This makes it possible to set\\nsome mods and change layers between pressing a key and repeating it. By default,\\nall other (non-modifier, non-layer switch) keys are remembered so that they are\\neligible for repeating. To configure additional keys to be ignored, define\\n`remember_last_key_user()` in your keymap.c.\\n\\nIgnoring a key\\n\\nThe following ignores the Backspace key:\\n\\n```\\nbool remember_last_key_user(uint16_t keycode, keyrecord_t* record,\\n uint8_t* remembered_mods) {\\n switch (keycode) {\\n case KC_BSPC:\\n return false; // Ignore backspace.\\n }\\n\\n return true; // Other keys can be repeated.\\n}\\n```\\n\\nThen for instance, the Repeat key in <kbd>Left Arrow</kbd>,\\n<kbd>Backspace</kbd>, <kbd>Repeat</kbd> sends Left Arrow again instead of\\nrepeating Backspace.\\n\\nThe `remember_last_key_user()` callback is called on every key press excluding\\nmodifiers and layer switches. Returning true indicates the key is remembered,\\nwhile false means it is ignored.\\n\\nFiltering remembered mods\\n\\nThe `remembered_mods` arg represents the mods that will be remembered with\\nthis key. It can be modified to forget certain mods. This may be\\nuseful to forget capitalization when repeating shifted letters, so that \\\"Aaron\\\"\\ndoes not becom \\\"AAron\\\":\\n\\n```\\nbool remember_last_key_user(uint16_t keycode, keyrecord_t* record,\\n uint8_t* remembered_mods) {\\n // Forget Shift on letter keys when Shift or AltGr are the only mods.\\n switch (keycode) {\\n case KC_A ... KC_Z:\\n if ((*remembered_mods & ~(MOD_MASK_SHIFT | MOD_BIT(KC_RALT))) == 0) {\\n *remembered_mods &= ~MOD_MASK_SHIFT;\\n }\\n break;\\n }\\n\\n return true;\\n}\\n```\\n\\nFurther conditions\\n\\nBesides checking the keycode, this callback could also make conditions based on\\nthe current layer state (with `IS_LAYER_ON(layer)`) or mods (`get_mods()`). For\\nexample, the following ignores keys on layer 2 as well as key combinations\\ninvolving GUI:\\n\\n```\\nbool remember_last_key_user(uint16_t keycode, keyrecord_t* record,\\n uint8_t* remembered_mods) {\\n if (IS_LAYER_ON(2) || (get_mods() & MOD_MASK_GUI)) {\\n return false; // Ignore layer 2 keys and GUI chords.\\n }\\n\\n return true; // Other keys can be repeated.\\n}\\n```\\n\\n::: tip\\nSee [Layer Functions](../feature_layers#functions) and [Checking Modifier State](../feature_advanced_keycodes#checking-modifier-state) for further details.\\n:::\", \"Handle how a key is repeated\": \"By default, pressing the Repeat Key will simply behave as if the last key\\nwere pressed again. This also works with macro keys with custom handlers,\\ninvoking the macro again. In case fine-tuning is needed for sensible repetition,\\nyou can handle how a key is repeated with `get_repeat_key_count()` within\\n`process_record_user()`. \\n\\nThe `get_repeat_key_count()` function returns a signed count of times the key\\nhas been repeated or alternate repeated. When a key is pressed as usual,\\n`get_repeat_key_count()` is 0. On the first repeat, it is 1, then the second\\nrepeat, 2, and so on. Negative counts are used similarly for alternate\\nrepeating. For instance supposing `MY_MACRO` is a custom keycode used in the\\nlayout:\\n\\n```\\nbool process_record_user(uint16_t keycode, keyrecord_t* record) {\\n switch (keycode) {\\n case MY_MACRO:\\n if (get_repeat_key_count() > 0) {\\n // MY_MACRO is being repeated!\\n if (record->event.pressed) {\\n SEND_STRING(\\\"repeat!\\\"); \\n }\\n } else { \\n // MY_MACRO is being used normally.\\n if (record->event.pressed) { \\n SEND_STRING(\\\"macro\\\");\\n }\\n }\\n return false;\\n \\n // Other macros...\\n }\\n return true;\\n}\\n```\", \"Handle how a key is alternate repeated\": \"Pressing the Alternate Repeat Key behaves as if the \\\"alternate\\\" of the last\\npressed key were pressed, if an alternate is defined. To define how a particular\\nkey is alternate repeated, use the `get_alt_repeat_key_keycode_user()` callback\\nas described above to define which keycode to use as its alternate. Beyond this,\\n`get_repeat_key_count()` may be used in custom handlers to fine-tune behavior\\nwhen alternate repeating.\\n\\nThe following example defines `MY_MACRO` as its own alternate, and specially\\nhandles repeating and alternate repeating:\\n\\n```\\nuint16_t get_alt_repeat_key_keycode_user(uint16_t keycode, uint8_t mods) {\\n switch (keycode) {\\n case MY_MACRO: return MY_MACRO; // MY_MACRO is its own alternate.\\n }\\n return KC_TRNS;\\n}\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t* record) {\\n switch (keycode) {\\n case MY_MACRO:\\n if (get_repeat_key_count() > 0) { // Repeating.\\n if (record->event.pressed) {\\n SEND_STRING(\\\"repeat!\\\"); \\n }\\n } else if (get_repeat_key_count() < 0) { // Alternate repeating.\\n if (record->event.pressed) {\\n SEND_STRING(\\\"alt repeat!\\\");\\n }\\n } else { // Used normally.\\n if (record->event.pressed) { \\n SEND_STRING(\\\"macro\\\");\\n }\\n }\\n return false;\\n \\n // Other macros...\\n }\\n return true;\\n}\\n```\", \"Functions\": \"| Function | Description |\\n|--------------------------------|------------------------------------------------------------------------|\\n| `get_last_keycode()` | The last key's keycode, the key to be repeated. |\\n| `get_last_mods()` | Mods to apply when repeating. |\\n| `set_last_keycode(kc)` | Set the keycode to be repeated. |\\n| `set_last_mods(mods)` | Set the mods to apply when repeating. |\\n| `get_repeat_key_count()` | Signed count of times the key has been repeated or alternate repeated. |\\n| `get_alt_repeat_key_keycode()` | Keycode to be used for alternate repeating. |\", \"Additional \\\"Alternate\\\" keys\": \"By leveraging `get_last_keycode()` in macros, it is possible to define\\nadditional, distinct \\\"Alternate Repeat\\\"-like keys. The following defines two\\nkeys `ALTREP2` and `ALTREP3` and implements ten shortcuts with them for common\\nEnglish 5-gram letter patterns, taking inspiration from\\n[Stenotype](stenography):\\n\\n| Typing | Produces | Typing | Produces |\\n|----------------------------------|----------|----------------------------------|----------|\\n| <kbd>A</kbd>, <kbd>ALTREP2</kbd> | `ation` | <kbd>A</kbd>, <kbd>ALTREP3</kbd> | `about` |\\n| <kbd>I</kbd>, <kbd>ALTREP2</kbd> | `ition` | <kbd>I</kbd>, <kbd>ALTREP3</kbd> | `inter` |\\n| <kbd>S</kbd>, <kbd>ALTREP2</kbd> | `ssion` | <kbd>S</kbd>, <kbd>ALTREP3</kbd> | `state` |\\n| <kbd>T</kbd>, <kbd>ALTREP2</kbd> | `their` | <kbd>T</kbd>, <kbd>ALTREP3</kbd> | `there` |\\n| <kbd>W</kbd>, <kbd>ALTREP2</kbd> | `which` | <kbd>W</kbd>, <kbd>ALTREP3</kbd> | `would` |\\n\\n```\\nenum custom_keycodes {\\n ALTREP2 = SAFE_RANGE,\\n ALTREP3,\\n};\\n\\n// Use ALTREP2 and ALTREP3 in your layout...\\n\\nbool remember_last_key_user(uint16_t keycode, keyrecord_t* record,\\n uint8_t* remembered_mods) {\\n switch (keycode) {\\n case ALTREP2:\\n case ALTREP3:\\n return false; // Ignore ALTREP keys.\\n }\\n\\n return true; // Other keys can be repeated.\\n}\\n\\nstatic void process_altrep2(uint16_t keycode, uint8_t mods) {\\n switch (keycode) {\\n case KC_A: SEND_STRING(/*a*/\\\"tion\\\"); break;\\n case KC_I: SEND_STRING(/*i*/\\\"tion\\\"); break;\\n case KC_S: SEND_STRING(/*s*/\\\"sion\\\"); break;\\n case KC_T: SEND_STRING(/*t*/\\\"heir\\\"); break;\\n case KC_W: SEND_STRING(/*w*/\\\"hich\\\"); break;\\n }\\n}\\n\\nstatic void process_altrep3(uint16_t keycode, uint8_t mods) {\\n switch (keycode) {\\n case KC_A: SEND_STRING(/*a*/\\\"bout\\\"); break;\\n case KC_I: SEND_STRING(/*i*/\\\"nter\\\"); break;\\n case KC_S: SEND_STRING(/*s*/\\\"tate\\\"); break;\\n case KC_T: SEND_STRING(/*t*/\\\"here\\\"); break;\\n case KC_W: SEND_STRING(/*w*/\\\"ould\\\"); break;\\n }\\n}\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t* record) {\\n switch (keycode) {\\n case ALTREP2: \\n if (record->event.pressed) {\\n process_altrep2(get_last_keycode(), get_last_mods());\\n }\\n return false;\\n\\n case ALTREP3:\\n if (record->event.pressed) {\\n process_altrep3(get_last_keycode(), get_last_mods());\\n }\\n return false;\\n }\\n\\n return true;\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 31]\"}, {\"title\": \"RGB Matrix Lighting {#rgb-matrix-lighting}\", \"description\": null, \"content\": {\"Driver Configuration {#driver-configuration}\": \"RGB Matrix is an abstraction layer on top of an underlying LED driver API. The list of supported LED drivers is below; see the respective documentation for information on how to configure the driver.\\n\\n|Driver |Max LEDs|\\n|-------------------------------------|--------|\\n|[APA102](../drivers/apa102) |? |\\n|[AW20216S](../drivers/aw20216s) |72 |\\n|[IS31FL3218](../drivers/is31fl3218) |6 |\\n|[IS31FL3236](../drivers/is31fl3236) |12 |\\n|[IS31FL3729](../drivers/is31fl3729) |45 |\\n|[IS31FL3731](../drivers/is31fl3731) |48 |\\n|[IS31FL3733](../drivers/is31fl3733) |64 |\\n|[IS31FL3736](../drivers/is31fl3736) |32 |\\n|[IS31FL3737](../drivers/is31fl3737) |48 |\\n|[IS31FL3741](../drivers/is31fl3741) |117 |\\n|[IS31FL3742A](../drivers/is31fl3742a)|60 |\\n|[IS31FL3743A](../drivers/is31fl3743a)|66 |\\n|[IS31FL3745](../drivers/is31fl3745) |48 |\\n|[IS31FL3746A](../drivers/is31fl3746a)|24 |\\n|[SNLED27351](../drivers/snled27351) |64 |\\n|[WS2812](../drivers/ws2812) |? |\\n\\nTo assign the RGB Matrix driver, add the following to your `rules.mk`, for example:\\n\\n```\\nRGB_MATRIX_DRIVER = is31fl3218\\n```\", \"Common Configuration {#common-configuration}\": \"From this point forward the configuration is the same for all the drivers. The `led_config_t` struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:\\n\\n```\\nled_config_t g_led_config = { {\\n // Key Matrix to LED Index\\n { 5, NO_LED, NO_LED, 0 },\\n { NO_LED, NO_LED, NO_LED, NO_LED },\\n { 4, NO_LED, NO_LED, 1 },\\n { 3, NO_LED, NO_LED, 2 }\\n}, {\\n // LED Index to Physical Position\\n { 188, 16 }, { 187, 48 }, { 149, 64 }, { 112, 64 }, { 37, 48 }, { 38, 16 }\\n}, {\\n // LED Index to Flag\\n 1, 4, 4, 4, 4, 1\\n} };\\n```\\n\\nThe first part, `// Key Matrix to LED Index`, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, `// LED Index to Physical Position` represents the LED's physical `{ x, y }` position on the keyboard. The default expected range of values for `{ x, y }` is the inclusive range `{ 0..224, 0..64 }`. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents `{ x, y }` coordinate `{ 0, 0 }` and the bottom right of your keyboard represents `{ 224, 64 }`. Using this as a basis, you can use the following formula to calculate the physical position:\\n\\n```\\nx = 224 / (NUMBER_OF_COLS - 1) * COL_POSITION\\ny = 64 / (NUMBER_OF_ROWS - 1) * ROW_POSITION\\n```\\n\\nWhere NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.\\n\\nAs mentioned earlier, the center of the keyboard by default is expected to be `{ 112, 32 }`, but this can be changed if you want to more accurately calculate the LED's physical `{ x, y }` positions. Keyboard designers can implement `#define RGB_MATRIX_CENTER { 112, 32 }` in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the `{ x, y }` values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.\\n\\n`// LED Index to Flag` is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.\", \"Flags {#flags}\": \"|Define |Value |Description |\\n|----------------------------|------|-------------------------------------------------|\\n|`HAS_FLAGS(bits, flags)` |*n/a* |Evaluates to `true` if `bits` has all `flags` set|\\n|`HAS_ANY_FLAGS(bits, flags)`|*n/a* |Evaluates to `true` if `bits` has any `flags` set|\\n|`LED_FLAG_NONE` |`0x00`|If this LED has no flags |\\n|`LED_FLAG_ALL` |`0xFF`|If this LED has all flags |\\n|`LED_FLAG_MODIFIER` |`0x01`|If the LED is on a modifier key |\\n|`LED_FLAG_UNDERGLOW` |`0x02`|If the LED is for underglow |\\n|`LED_FLAG_KEYLIGHT` |`0x04`|If the LED is for key backlight |\\n|`LED_FLAG_INDICATOR` |`0x08`|If the LED is for keyboard state indication |\", \"Keycodes {#keycodes}\": \"|Key |Aliases |Description |\\n|-------------------------------|---------|-----------------------------------|\\n|`QK_RGB_MATRIX_ON` |`RM_ON` |Turn on RGB Matrix |\\n|`QK_RGB_MATRIX_OFF` |`RM_OFF` |Turn off RGB Matrix |\\n|`QK_RGB_MATRIX_TOGGLE` |`RM_TOGG`|Toggle RGB Matrix on or off |\\n|`QK_RGB_MATRIX_MODE_NEXT` |`RM_NEXT`|Cycle through animations |\\n|`QK_RGB_MATRIX_MODE_PREVIOUS` |`RM_PREV`|Cycle through animations in reverse|\\n|`QK_RGB_MATRIX_HUE_UP` |`RM_HUEU`|Cycle through hue |\\n|`QK_RGB_MATRIX_HUE_DOWN` |`RM_HUED`|Cycle through hue in reverse |\\n|`QK_RGB_MATRIX_SATURATION_UP` |`RM_SATU`|Increase the saturation |\\n|`QK_RGB_MATRIX_SATURATION_DOWN`|`RM_SATD`|Decrease the saturation |\\n|`QK_RGB_MATRIX_VALUE_UP` |`RM_VALU`|Increase the brightness level |\\n|`QK_RGB_MATRIX_VALUE_DOWN` |`RM_VALD`|Decrease the brightness level |\\n|`QK_RGB_MATRIX_SPEED_UP` |`RM_SPDU`|Increase the animation speed |\\n|`QK_RGB_MATRIX_SPEED_DOWN` |`RM_SPDD`|Decrease the animation speed |\", \"RGB Matrix Effects {#rgb-matrix-effects}\": {\"RGB Matrix Effect Typing Heatmap {#rgb-matrix-effect-typing-heatmap}\": \"This effect will color the RGB matrix according to a heatmap of recently pressed keys. Whenever a key is pressed its \\\"temperature\\\" increases as well as that of its neighboring keys. The temperature of each key is then decreased automatically every 25 milliseconds by default.\\n\\nIn order to change the delay of temperature decrease define `RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS`:\\n\\n```\\n#define RGB_MATRIX_TYPING_HEATMAP_DECREASE_DELAY_MS 50\\n```\\n\\nAs heatmap uses the physical position of the leds set in the g_led_config, you may need to tweak the following options to get the best effect for your keyboard. Note the size of this grid is `224x64`.\\n\\nLimit the distance the effect spreads to surrounding keys. \\n\\n```\\n#define RGB_MATRIX_TYPING_HEATMAP_SPREAD 40\\n```\\n\\nLimit how hot surrounding keys get from each press.\\n\\n```\\n#define RGB_MATRIX_TYPING_HEATMAP_AREA_LIMIT 16\\n```\\n\\nRemove the spread effect entirely.\\n\\n```\\n#define RGB_MATRIX_TYPING_HEATMAP_SLIM\\n```\\n\\nIt's also possible to adjust the tempo of *heating up*. It's defined as the number of shades that are\\nincreased on the [HSV scale](https://en.wikipedia.org/wiki/HSL_and_HSV). Decreasing this value increases\\nthe number of keystrokes needed to fully heat up the key.\\n\\n```\\n#define RGB_MATRIX_TYPING_HEATMAP_INCREASE_STEP 32\\n```\", \"RGB Matrix Effect Solid Reactive {#rgb-matrix-effect-solid-reactive}\": \"Solid reactive effects will pulse RGB light on key presses with user configurable hues. To enable gradient mode that will automatically change reactive color, add the following define:\\n\\n```\\n#define RGB_MATRIX_SOLID_REACTIVE_GRADIENT_MODE\\n```\\n\\nGradient mode will loop through the color wheel hues over time and its duration can be controlled with the effect speed keycodes (`RM_SPDU`/`RM_SPDD`).\"}, \"Custom RGB Matrix Effects {#custom-rgb-matrix-effects}\": \"By setting `RGB_MATRIX_CUSTOM_USER = yes` in `rules.mk`, new effects can be defined directly from your keymap or userspace, without having to edit any QMK core files. To declare new effects, create a `rgb_matrix_user.inc` file in the user keymap directory or userspace folder.\\n\\n::: tip\\nHardware maintainers who want to limit custom effects to a specific keyboard can create a `rgb_matrix_kb.inc` file in the root of the keyboard directory, and add `RGB_MATRIX_CUSTOM_KB = yes` to the keyboard level `rules.mk`.\\n:::\\n\\n```\\n// !!! DO NOT ADD #pragma once !!! //\\n\\n// Step 1.\\n// Declare custom effects using the RGB_MATRIX_EFFECT macro\\n// (note the lack of semicolon after the macro!)\\nRGB_MATRIX_EFFECT(my_cool_effect)\\nRGB_MATRIX_EFFECT(my_cool_effect2)\\n\\n// Step 2.\\n// Define effects inside the `RGB_MATRIX_CUSTOM_EFFECT_IMPLS` ifdef block\\n#ifdef RGB_MATRIX_CUSTOM_EFFECT_IMPLS\\n\\n// e.g: A simple effect, self-contained within a single method\\nstatic bool my_cool_effect(effect_params_t* params) {\\n RGB_MATRIX_USE_LIMITS(led_min, led_max);\\n for (uint8_t i = led_min; i < led_max; i++) {\\n rgb_matrix_set_color(i, 0xff, 0xff, 0x00);\\n }\\n return rgb_matrix_check_finished_leds(led_max);\\n}\\n\\n// e.g: A more complex effect, relying on external methods and state, with\\n// dedicated init and run methods\\nstatic uint8_t some_global_state;\\nstatic void my_cool_effect2_complex_init(effect_params_t* params) {\\n some_global_state = 1;\\n}\\nstatic bool my_cool_effect2_complex_run(effect_params_t* params) {\\n RGB_MATRIX_USE_LIMITS(led_min, led_max);\\n for (uint8_t i = led_min; i < led_max; i++) {\\n rgb_matrix_set_color(i, 0xff, some_global_state++, 0xff);\\n }\\n return rgb_matrix_check_finished_leds(led_max);\\n}\\nstatic bool my_cool_effect2(effect_params_t* params) {\\n if (params->init) my_cool_effect2_complex_init(params);\\n return my_cool_effect2_complex_run(params);\\n}\\n\\n#endif // RGB_MATRIX_CUSTOM_EFFECT_IMPLS\\n```\\n\\nTo switch to your custom effect programmatically, simply call `rgb_matrix_mode()` and prepend `RGB_MATRIX_CUSTOM_` to the effect name you specified in `RGB_MATRIX_EFFECT()`. For example, an effect declared as `RGB_MATRIX_EFFECT(my_cool_effect)` would be referenced with:\\n\\n```\\nrgb_matrix_mode(RGB_MATRIX_CUSTOM_my_cool_effect);\\n```\\n\\nFor inspiration and examples, check out the built-in effects under `quantum/rgb_matrix/animations/`.\", \"Colors {#colors}\": \"These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.\\n\\n|RGB |HSV |\\n|---------------------|---------------------|\\n|`RGB_AZURE` |`HSV_AZURE` |\\n|`RGB_BLACK`/`RGB_OFF`|`HSV_BLACK`/`HSV_OFF`|\\n|`RGB_BLUE` |`HSV_BLUE` |\\n|`RGB_CHARTREUSE` |`HSV_CHARTREUSE` |\\n|`RGB_CORAL` |`HSV_CORAL` |\\n|`RGB_CYAN` |`HSV_CYAN` |\\n|`RGB_GOLD` |`HSV_GOLD` |\\n|`RGB_GOLDENROD` |`HSV_GOLDENROD` |\\n|`RGB_GREEN` |`HSV_GREEN` |\\n|`RGB_MAGENTA` |`HSV_MAGENTA` |\\n|`RGB_ORANGE` |`HSV_ORANGE` |\\n|`RGB_PINK` |`HSV_PINK` |\\n|`RGB_PURPLE` |`HSV_PURPLE` |\\n|`RGB_RED` |`HSV_RED` |\\n|`RGB_SPRINGGREEN` |`HSV_SPRINGGREEN` |\\n|`RGB_TEAL` |`HSV_TEAL` |\\n|`RGB_TURQUOISE` |`HSV_TURQUOISE` |\\n|`RGB_WHITE` |`HSV_WHITE` |\\n|`RGB_YELLOW` |`HSV_YELLOW` |\\n\\nThese are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h). Feel free to add to this list!\", \"Additional `config.h` Options {#additional-configh-options}\": \"```\\n#define RGB_MATRIX_KEYRELEASES // reactive effects respond to keyreleases (instead of keypresses)\\n#define RGB_MATRIX_TIMEOUT 0 // number of milliseconds to wait until rgb automatically turns off\\n#define RGB_MATRIX_SLEEP // turn off effects when suspended\\n#define RGB_MATRIX_LED_PROCESS_LIMIT (RGB_MATRIX_LED_COUNT + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)\\n#define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)\\n#define RGB_MATRIX_MAXIMUM_BRIGHTNESS 200 // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255\\n#define RGB_MATRIX_DEFAULT_ON true // Sets the default enabled state, if none has been set\\n#define RGB_MATRIX_DEFAULT_MODE RGB_MATRIX_CYCLE_LEFT_RIGHT // Sets the default mode, if none has been set\\n#define RGB_MATRIX_DEFAULT_HUE 0 // Sets the default hue value, if none has been set\\n#define RGB_MATRIX_DEFAULT_SAT 255 // Sets the default saturation value, if none has been set\\n#define RGB_MATRIX_DEFAULT_VAL RGB_MATRIX_MAXIMUM_BRIGHTNESS // Sets the default brightness value, if none has been set\\n#define RGB_MATRIX_DEFAULT_SPD 127 // Sets the default animation speed, if none has been set\\n#define RGB_MATRIX_HUE_STEP 8 // The value by which to increment the hue per adjustment action\\n#define RGB_MATRIX_SAT_STEP 16 // The value by which to increment the saturation per adjustment action\\n#define RGB_MATRIX_VAL_STEP 16 // The value by which to increment the brightness per adjustment action\\n#define RGB_MATRIX_SPD_STEP 16 // The value by which to increment the animation speed per adjustment action\\n#define RGB_MATRIX_DEFAULT_FLAGS LED_FLAG_ALL // Sets the default LED flags, if none has been set\\n#define RGB_MATRIX_SPLIT { X, Y } // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.\\n // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR\\n#define RGB_TRIGGER_ON_KEYDOWN // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards\\n```\", \"EEPROM storage {#eeprom-storage}\": \"The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time).\", \"Callbacks {#callbacks}\": {\"Indicators {#indicators}\": \"If you want to set custom indicators, such as an LED for Caps Lock, or layer indication, then you can use the `rgb_matrix_indicators_kb` function on the keyboard level source file, or `rgb_matrix_indicators_user` function in the user `keymap.c`.\\n\\n```\\nbool rgb_matrix_indicators_kb(void) {\\n if (!rgb_matrix_indicators_user()) {\\n return false;\\n }\\n rgb_matrix_set_color(index, red, green, blue);\\n return true;\\n}\\n```\\n\\nIn addition, there are the advanced indicator functions. These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive. Such as some of the \\\"drashna\\\" layouts. This includes a special macro to help make this easier to use: `RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b)`.\\n\\n```\\nbool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {\\n RGB_MATRIX_INDICATOR_SET_COLOR(index, red, green, blue);\\n return false;\\n}\\n```\", \"Indicator Examples {#indicator-examples}\": {\"Examples {#indicator-examples-2}\": \"This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).\\n\\n```\\nbool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {\\n hsv_t hsv = {0, 255, 255};\\n\\n if (get_highest_layer(layer_state|default_layer_state) == 2) {\\n hsv = (hsv_t){130, 255, 255};\\n } else {\\n hsv = (hsv_t){30, 255, 255};\\n }\\n\\n if (hsv.v > rgb_matrix_get_val()) {\\n hsv.v = rgb_matrix_get_val();\\n }\\n rgb_t rgb = hsv_to_rgb(hsv);\\n\\n for (uint8_t i = led_min; i < led_max; i++) {\\n if (HAS_FLAGS(g_led_config.flags[i], 0x01)) { // 0x01 == LED_FLAG_MODIFIER\\n rgb_matrix_set_color(i, rgb.r, rgb.g, rgb.b);\\n }\\n }\\n return false;\\n}\\n```\\n\\nIf you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key:\\n\\n```\\nbool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max) {\\n if (host_keyboard_led_state().caps_lock) {\\n RGB_MATRIX_INDICATOR_SET_COLOR(5, 255, 255, 255); // assuming caps lock is at led #5\\n } else {\\n RGB_MATRIX_INDICATOR_SET_COLOR(5, 0, 0, 0);\\n }\\n return false;\\n}\\n```\\n\\n::: tip\\nRGB indicators on split keyboards will require state information synced to the slave half (e.g. `#define SPLIT_LAYER_STATE_ENABLE`). See [data sync options](split_keyboard#data-sync-options) for more details.\\n:::\", \"Indicators without RGB Matrix Effect\": \"If you want to just use RGB indicators without RGB matrix effect, it is not possible to disable the latter because toggling RGB off will disable everything. You can workaround it with solid effect and colors off using this init function:\\n\\n```\\nvoid keyboard_post_init_user(void) {\\n rgb_matrix_mode_noeeprom(RGB_MATRIX_SOLID_COLOR);\\n rgb_matrix_sethsv_noeeprom(HSV_OFF);\\n}\\n```\"}}, \"API {#api}\": {\"`void rgb_matrix_toggle(void)` {#api-rgb-matrix-toggle}\": \"Toggle RGB Matrix on or off.\\n\\n[]\", \"`void rgb_matrix_toggle_noeeprom(void)` {#api-rgb-matrix-toggle-noeeprom}\": \"Toggle RGB Matrix on or off. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_enable(void)` {#api-rgb-matrix-enable}\": \"Turn RGB Matrix on.\\n\\n[]\", \"`void rgb_matrix_enable_noeeprom(void)` {#api-rgb-matrix-enable-noeeprom}\": \"Turn RGB Matrix on. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_disable(void)` {#api-rgb-matrix-disable}\": \"Turn RGB Matrix off.\\n\\n[]\", \"`void rgb_matrix_disable_noeeprom(void)` {#api-rgb-matrix-disable-noeeprom}\": \"Turn RGB Matrix off. New state is not written to EEPROM.\\n\\n[]\", \"`bool rgb_matrix_is_enabled(void)` {#api-rgb-matrix-is-enabled}\": {\"Return Value {#api-rgb-matrix-is-enabled-return}\": \"`true` if RGB Matrix is enabled.\\n\\n[]\"}, \"`void rgb_matrix_set_color(uint8_t index, uint8_t r, uint8_t g, uint8_t b)` {#api-rgb-matrix-set-color}\": {\"Arguments {#api-rgb-matrix-set-color-arguments}\": [\"`uint8_t index` \\nThe LED index, from 0 to `RGB_MATRIX_LED_COUNT - 1`.\", \"`uint8_t r` \\nThe red value to set.\", \"`uint8_t g` \\nThe green value to set.\", \"`uint8_t b` \\nThe blue value to set.\"]}, \"`void rgb_matrix_set_color_all(uint8_t r, uint8_t g, uint8_t b)` {#api-rgb-matrix-set-color-all}\": {\"Arguments {#api-rgb-matrix-set-color-all-arguments}\": [\"`uint8_t r` \\nThe red value to set.\", \"`uint8_t g` \\nThe green value to set.\", \"`uint8_t b` \\nThe blue value to set.\"]}, \"`void rgb_matrix_mode(uint8_t mode)` {#api-rgb-matrix-mode}\": {\"Arguments {#api-rgb-matrix-mode-arguments}\": [\"`uint8_t mode` \\nThe effect to switch to.\"]}, \"`void rgb_matrix_mode_noeeprom(uint8_t mode)` {#api-rgb-matrix-mode-noeeprom}\": {\"Arguments {#api-rgb-matrix-mode-noeeprom-arguments}\": [\"`uint8_t mode` \\nThe effect to switch to.\"]}, \"`void rgb_matrix_step(void)` {#api-rgb-matrix-step}\": \"Move to the next enabled effect.\\n\\n[]\", \"`void rgb_matrix_step_noeeprom(void)` {#api-rgb-matrix-step-noeeprom}\": \"Move to the next enabled effect. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_step_reverse(void)` {#api-rgb-matrix-step-reverse}\": \"Move to the previous enabled effect.\\n\\n[]\", \"`void rgb_matrix_step_reverse_noeeprom(void)` {#api-rgb-matrix-step-reverse-noeeprom}\": \"Move to the previous enabled effect. New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t rgb_matrix_get_mode(void)` {#api-rgb-matrix-get-mode}\": {\"Return Value {#api-rgb-matrix-get-mode-return}\": \"The index of the currently running effect.\\n\\n[]\"}, \"`void rgb_matrix_increase_hue(void)` {#api-rgb-matrix-increase-hue}\": \"Increase the global effect hue.\\n\\n[]\", \"`void rgb_matrix_increase_hue_noeeprom(void)` {#api-rgb-matrix-increase-hue-noeeprom}\": \"Increase the global effect hue. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_decrease_hue(void)` {#api-rgb-matrix-decrease-hue}\": \"Decrease the global effect hue.\\n\\n[]\", \"`void rgb_matrix_decrease_hue_noeeprom(void)` {#api-rgb-matrix-decrease-hue-noeeprom}\": \"Decrease the global effect hue. New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t rgb_matrix_get_hue(void)` {#api-rgb-matrix-get-hue}\": {\"Return Value {#api-rgb-matrix-get-hue-return}\": \"The current hue value, from 0 to 255.\\n\\n[]\"}, \"`void rgb_matrix_increase_sat(void)` {#api-rgb-matrix-increase-sat}\": \"Increase the global effect saturation.\\n\\n[]\", \"`void rgb_matrix_increase_sat_noeeprom(void)` {#api-rgb-matrix-increase-sat-noeeprom}\": \"Increase the global effect saturation. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_decrease_sat(void)` {#api-rgb-matrix-decrease-sat}\": \"Decrease the global effect saturation.\\n\\n[]\", \"`void rgb_matrix_decrease_sat_noeeprom(void)` {#api-rgb-matrix-decrease-sat-noeeprom}\": \"Decrease the global effect saturation. New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t rgb_matrix_get_sat(void)` {#api-rgb-matrix-get-sat}\": {\"Return Value {#api-rgb-matrix-get-sat-return}\": \"The current saturation value, from 0 to 255.\\n\\n[]\"}, \"`void rgb_matrix_increase_val(void)` {#api-rgb-matrix-increase-val}\": \"Increase the global effect value (brightness).\\n\\n[]\", \"`void rgb_matrix_increase_val_noeeprom(void)` {#api-rgb-matrix-increase-val-noeeprom}\": \"Increase the global effect value (brightness). New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_decrease_val(void)` {#api-rgb-matrix-decrease-val}\": \"Decrease the global effect value (brightness).\\n\\n[]\", \"`void rgb_matrix_decrease_val_noeeprom(void)` {#api-rgb-matrix-decrease-val-noeeprom}\": \"Decrease the global effect value (brightness). New state is not written to EEPROM.\\n\\n[]\", \"`uint8_t rgb_matrix_get_val(void)` {#api-rgb-matrix-get-val}\": {\"Return Value {#api-rgb-matrix-get-val-return}\": \"The current brightness value, from 0 to 255.\\n\\n[]\"}, \"`void rgb_matrix_increase_speed(void)` {#api-rgb-matrix-increase-speed}\": \"Increase the effect speed.\\n\\n[]\", \"`void rgb_matrix_increase_speed_noeeprom(void)` {#api-rgb-matrix-increase-speed-noeeprom}\": \"Increase the effect speed. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_decrease_speed(void)` {#api-rgb-matrix-decrease-speed}\": \"Decrease the effect speed.\\n\\n[]\", \"`void rgb_matrix_decrease_speed_noeeprom(void)` {#api-rgb-matrix-decrease-speed-noeeprom}\": \"Decrease the effect speed. New state is not written to EEPROM.\\n\\n[]\", \"`void rgb_matrix_set_speed(uint8_t speed)` {#api-rgb-matrix-set-speed}\": {\"Arguments {#api-rgb-matrix-set-speed-arguments}\": [\"`uint8_t speed` \\nThe new speed to set, from 0 to 255.\"]}, \"`void rgb_matrix_set_speed_noeeprom(uint8_t speed)` {#api-rgb-matrix-set-speed-noeeprom}\": {\"Arguments {#api-rgb-matrix-set-speed-noeeprom-arguments}\": [\"`uint8_t speed` \\nThe new speed to set, from 0 to 255.\"]}, \"`uint8_t rgb_matrix_get_speed(void)` {#api-rgb-matrix-get-speed}\": {\"Return Value {#api-rgb-matrix-get-speed-return}\": \"The current effect speed, from 0 to 255.\\n\\n[]\"}, \"`void rgb_matrix_sethsv(uint8_t h, uint8_t s, uint8_t v)` {#api-rgb-matrix-sethsv}\": \"Set the global effect hue, saturation, and value (brightness).\", \"Arguments {#api-rgb-matrix-sethsv-arguments}\": [\"`uint8_t h` \\nThe hue to set, from 0 to 255.\", \"`uint8_t s` \\nThe saturation to set, from 0 to 255.\", \"`uint8_t v` \\nThe value (brightness) to set, from 0 to 255.\"], \"`void rgb_matrix_sethsv_noeeprom(uint8_t h, uint8_t s, uint8_t v)` {#api-rgb-matrix-sethsv-noeeprom}\": {\"Arguments {#api-rgb-matrix-sethsv-noeeprom-arguments}\": [\"`uint8_t h` \\nThe hue to set, from 0 to 255.\", \"`uint8_t s` \\nThe saturation to set, from 0 to 255.\", \"`uint8_t v` \\nThe value (brightness) to set, from 0 to 255.\"]}, \"`hsv_t rgb_matrix_get_hsv(void)` {#api-rgb-matrix-get-hsv}\": {\"Return Value {#api-rgb-matrix-get-hsv-return}\": \"The current effect HSV as an `hsv_t` struct.\\n\\n[]\"}, \"`void rgb_matrix_reload_from_eeprom(void)` {#api-rgb-matrix-reload-from-eeprom}\": \"Reload the effect configuration (enabled, mode and color) from EEPROM.\\n\\n[]\", \"`bool rgb_matrix_get_suspend_state(void)` {#api-rgb-matrix-get-suspend-state}\": {\"Return Value {#api-rgb-matrix-get-suspend-state-return}\": \"`true` if RGB Matrix is currently in the suspended state.\\n\\n[]\"}, \"`bool rgb_matrix_indicators_kb(void)` {#api-rgb-matrix-indicators-kb}\": {\"Return Value {#api-rgb-matrix-indicators-kb-return}\": \"Currently unused.\\n\\n[]\"}, \"`bool rgb_matrix_indicators_user(void)` {#api-rgb-matrix-indicators-user}\": {\"Return Value {#api-rgb-matrix-indicators-user-return}\": \"`true` to continue running the keyboard-level callback.\\n\\n[]\"}, \"`bool rgb_matrix_indicators_advanced_kb(uint8_t led_min, uint8_t led_max)` {#api-rgb-matrix-indicators-advanced-kb}\": \"Keyboard-level callback, invoked after current animation frame is rendered but before it is flushed to the LEDs.\", \"Arguments {#api-rgb-matrix-indicators-advanced-kb-arguments}\": {\"Return Value {#api-rgb-matrix-indicators-advanced-kb-return}\": \"Currently unused.\\n\\n[]\"}, \"`bool rgb_matrix_indicators_advanced_user(uint8_t led_min, uint8_t led_max)` {#api-rgb-matrix-indicators-advanced-user}\": \"Keymap-level callback, invoked after current animation frame is rendered but before it is flushed to the LEDs.\", \"Arguments {#api-rgb-matrix-indicators-advanced-user-arguments}\": {\"Return Value {#api-rgb-matrix-indicators-advanced-user-return}\": \"`true` to continue running the keyboard-level callback.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 32]\"}, {\"title\": \"RGB Lighting\", \"description\": null, \"content\": {\"Usage\": {\"Color Selection\": \"QMK uses [Hue, Saturation, and Value](https://en.wikipedia.org/wiki/HSL_and_HSV) to select colors rather than RGB. The color wheel below demonstrates how this works.\\n\\n<img src=\\\"../public/color-wheel.svg\\\" alt=\\\"HSV Color Wheel\\\" width=\\\"250\\\"/>\\n\\nChanging the **Hue** cycles around the circle.<br>\\nChanging the **Saturation** moves between the inner and outer sections of the wheel, affecting the intensity of the color.<br>\\nChanging the **Value** sets the overall brightness.<br>\\n\\n\"}, \"Keycodes\": \"::: warning\\nThese keycodes also simultaneously control [RGB Matrix](rgb_matrix), if enabled. This behaviour is in the process of being deprecated, so during this time it is recommended to additionally include the dedicated RGB Matrix keycodes to your keymap, and add `#define RGB_MATRIX_DISABLE_SHARED_KEYCODES` to `config.h`.\\n:::\\n\\n|Key |Aliases |Description |\\n|------------------------------|----------|---------------------------------------------------------------------|\\n|`QK_UNDERGLOW_TOGGLE` |`UG_TOGG` |Toggle RGB lighting on or off |\\n|`QK_UNDERGLOW_MODE_NEXT` |`UG_NEXT` |Cycle through modes, reverse direction when Shift is held |\\n|`QK_UNDERGLOW_MODE_PREVIOUS` |`UG_PREV` |Cycle through modes in reverse, forward direction when Shift is held |\\n|`QK_UNDERGLOW_HUE_UP` |`UG_HUEU` |Increase hue, decrease hue when Shift is held |\\n|`QK_UNDERGLOW_HUE_DOWN` |`UG_HUED` |Decrease hue, increase hue when Shift is held |\\n|`QK_UNDERGLOW_SATURATION_UP` |`UG_SATU` |Increase saturation, decrease saturation when Shift is held |\\n|`QK_UNDERGLOW_SATURATION_DOWN`|`UG_SATD` |Decrease saturation, increase saturation when Shift is held |\\n|`QK_UNDERGLOW_VALUE_UP` |`UG_VALU` |Increase value (brightness), decrease value when Shift is held |\\n|`QK_UNDERGLOW_VALUE_DOWN` |`UG_VALD` |Decrease value (brightness), increase value when Shift is held |\\n|`QK_UNDERGLOW_SPEED_UP` |`UG_SPDU` |Increase effect speed (brightness), decrease speed when Shift is held|\\n|`QK_UNDERGLOW_SPEED_DOWN` |`UG_SPDD` |Decrease effect speed (brightness), increase speed when Shift is held|\\n|`RGB_MODE_PLAIN` |`RGB_M_P `|Static (no animation) mode (deprecated) |\\n|`RGB_MODE_BREATHE` |`RGB_M_B` |Breathing animation mode (deprecated) |\\n|`RGB_MODE_RAINBOW` |`RGB_M_R` |Rainbow animation mode (deprecated) |\\n|`RGB_MODE_SWIRL` |`RGB_M_SW`|Swirl animation mode (deprecated) |\\n|`RGB_MODE_SNAKE` |`RGB_M_SN`|Snake animation mode (deprecated) |\\n|`RGB_MODE_KNIGHT` |`RGB_M_K` |\\\"Knight Rider\\\" animation mode (deprecated) |\\n|`RGB_MODE_XMAS` |`RGB_M_X` |Christmas animation mode (deprecated) |\\n|`RGB_MODE_GRADIENT` |`RGB_M_G` |Static gradient animation mode (deprecated) |\\n|`RGB_MODE_RGBTEST` |`RGB_M_T` |Red, Green, Blue test animation mode (deprecated) |\\n|`RGB_MODE_TWINKLE` |`RGB_M_TW`|Twinkle animation mode (deprecated) |\\n\\n::: tip\\nThese keycodes cannot be used with functions like `tap_code16()` as they are not USB HID keycodes. If you wish to replicate similar behaviour in custom code within your firmware (e.g. inside `encoder_update_user()` or `process_record_user()`), the equivalent [RGB functions](#functions) should be used instead.\\n:::\", \"Configuration\": \"Your RGB lighting can be configured by placing these `#define`s in your `config.h`:\\n\\n|Define |Default |Description |\\n|---------------------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------|\\n|`RGBLIGHT_HUE_STEP` |`8` |The value by which to increment the hue per adjustment action |\\n|`RGBLIGHT_SAT_STEP` |`17` |The value by which to increment the saturation per adjustment action |\\n|`RGBLIGHT_VAL_STEP` |`17` |The value by which to increment the brightness per adjustment action |\\n|`RGBLIGHT_LIMIT_VAL` |`255` |The maximum brightness level |\\n|`RGBLIGHT_SLEEP` |*Not defined* |If defined, the RGB lighting will be switched off when the host goes to sleep |\\n|`RGBLIGHT_SPLIT` |*Not defined* |If defined, synchronization functionality for split keyboards is added |\\n|`RGBLIGHT_DEFAULT_MODE` |`RGBLIGHT_MODE_STATIC_LIGHT`|The default mode to use upon clearing the EEPROM |\\n|`RGBLIGHT_DEFAULT_HUE` |`0` (red) |The default hue to use upon clearing the EEPROM |\\n|`RGBLIGHT_DEFAULT_SAT` |`UINT8_MAX` (255) |The default saturation to use upon clearing the EEPROM |\\n|`RGBLIGHT_DEFAULT_VAL` |`RGBLIGHT_LIMIT_VAL` |The default value (brightness) to use upon clearing the EEPROM |\\n|`RGBLIGHT_DEFAULT_SPD` |`0` |The default speed to use upon clearing the EEPROM |\\n|`RGBLIGHT_DEFAULT_ON` |`true` |Enable RGB lighting upon clearing the EEPROM |\", \"Effects and Animations\": {\"Effect and Animation Toggles\": \"Use these defines to add or remove animations from the firmware. When you are running low on flash space, it can be helpful to disable animations you are not using.\\n\\n|Define |Default |Description |\\n|------------------------------------|-------------|-------------------------------------------------------------------------|\\n|`RGBLIGHT_ANIMATIONS` |*Not defined*|Enable all additional animation modes. (deprecated) |\\n|`RGBLIGHT_EFFECT_ALTERNATING` |*Not defined*|Enable alternating animation mode. |\\n|`RGBLIGHT_EFFECT_BREATHING` |*Not defined*|Enable breathing animation mode. |\\n|`RGBLIGHT_EFFECT_CHRISTMAS` |*Not defined*|Enable christmas animation mode. |\\n|`RGBLIGHT_EFFECT_KNIGHT` |*Not defined*|Enable knight animation mode. |\\n|`RGBLIGHT_EFFECT_RAINBOW_MOOD` |*Not defined*|Enable rainbow mood animation mode. |\\n|`RGBLIGHT_EFFECT_RAINBOW_SWIRL` |*Not defined*|Enable rainbow swirl animation mode. |\\n|`RGBLIGHT_EFFECT_RGB_TEST` |*Not defined*|Enable RGB test animation mode. |\\n|`RGBLIGHT_EFFECT_SNAKE` |*Not defined*|Enable snake animation mode. |\\n|`RGBLIGHT_EFFECT_STATIC_GRADIENT` |*Not defined*|Enable static gradient mode. |\\n|`RGBLIGHT_EFFECT_TWINKLE` |*Not defined*|Enable twinkle animation mode. |\\n\\n::: warning\\n`RGBLIGHT_ANIMATIONS` is being deprecated and animation modes should be explicitly defined.\\n:::\", \"Effect and Animation Settings\": \"The following options are used to tweak the various animations:\\n\\n|Define |Default |Description |\\n|------------------------------------|--------------------|-----------------------------------------------------------------------------------------------|\\n|`RGBLIGHT_EFFECT_BREATHE_CENTER` |*Not defined* |If defined, used to calculate the curve for the breathing animation. Valid values are 1.0 to 2.7 |\\n|`RGBLIGHT_EFFECT_BREATHE_MAX` |`255` |The maximum brightness for the breathing mode. Valid values are 1 to 255 |\\n|`RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL`|`40` |How long (in milliseconds) to wait between animation steps for the \\\"Christmas\\\" animation |\\n|`RGBLIGHT_EFFECT_CHRISTMAS_STEP` |`2` |The number of LEDs to group the red/green colors by for the \\\"Christmas\\\" animation |\\n|`RGBLIGHT_EFFECT_KNIGHT_LED_NUM` |`RGBLIGHT_LED_COUNT`|The number of LEDs to have the \\\"Knight\\\" animation travel |\\n|`RGBLIGHT_EFFECT_KNIGHT_LENGTH` |`3` |The number of LEDs to light up for the \\\"Knight\\\" animation |\\n|`RGBLIGHT_EFFECT_KNIGHT_OFFSET` |`0` |The number of LEDs to start the \\\"Knight\\\" animation from the start of the strip by |\\n|`RGBLIGHT_RAINBOW_SWIRL_RANGE` |`255` |Range adjustment for the rainbow swirl effect to get different swirls |\\n|`RGBLIGHT_EFFECT_SNAKE_LENGTH` |`4` |The number of LEDs to light up for the \\\"Snake\\\" animation |\\n|`RGBLIGHT_EFFECT_TWINKLE_LIFE` |`200` |Adjusts how quickly each LED brightens and dims when twinkling (in animation steps) |\\n|`RGBLIGHT_EFFECT_TWINKLE_PROBABILITY`|`1/127` |Adjusts how likely each LED is to twinkle (on each animation step) |\", \"Example Usage to Reduce Memory Footprint\": [\"Use `#undef` to selectively disable animations. The following would disable two animations and save about 4KiB:\"], \"Animation Speed\": \"You can also modify the speeds that the different modes animate at:\\n\\nHere is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY).\\n\\n```\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Solid color breathing\\\" animations\\nconst uint8_t RGBLED_BREATHING_INTERVALS[] PROGMEM = {30, 20, 10, 5};\\n\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Cycling rainbow\\\" animations\\nconst uint8_t RGBLED_RAINBOW_MOOD_INTERVALS[] PROGMEM = {120, 60, 30};\\n\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Swirling rainbow\\\" animations\\nconst uint8_t RGBLED_RAINBOW_SWIRL_INTERVALS[] PROGMEM = {100, 50, 20};\\n\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Snake\\\" animations\\nconst uint8_t RGBLED_SNAKE_INTERVALS[] PROGMEM = {100, 50, 20};\\n\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Knight\\\" animations\\nconst uint8_t RGBLED_KNIGHT_INTERVALS[] PROGMEM = {127, 63, 31};\\n\\n// How long (in milliseconds) to wait between animation steps for each of the \\\"Twinkle\\\" animations\\nconst uint8_t RGBLED_TWINKLE_INTERVALS[] PROGMEM = {50, 25, 10};\\n\\n// These control which hues are selected for each of the \\\"Static gradient\\\" modes\\nconst uint8_t RGBLED_GRADIENT_RANGES[] PROGMEM = {255, 170, 127, 85, 64};\\n```\"}, \"Lighting Layers\": {\"Defining Lighting Layers {#defining-lighting-layers}\": \"By default, 8 layers are possible. This can be expanded to as many as 32 by overriding the definition of `RGBLIGHT_MAX_LAYERS` in `config.h` (e.g. `#define RGBLIGHT_MAX_LAYERS 32`). Please note, if you use a split keyboard, you will need to flash both sides of the split after changing this. Also, increasing the maximum will increase the firmware size, and will slow sync on split keyboards.\\n\\nTo define a layer, we modify `keymap.c` to list the LED ranges and the colors we want to overlay on them using an array of `rgblight_segment_t` using the `RGBLIGHT_LAYER_SEGMENTS` macro. We can define multiple layers and enable/disable them independently:\\n\\n```\\n// Light LEDs 6 to 9 and 12 to 15 red when caps lock is active. Hard to ignore!\\nconst rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS(\\n {6, 4, HSV_RED}, // Light 4 LEDs, starting with LED 6\\n {12, 4, HSV_RED} // Light 4 LEDs, starting with LED 12\\n);\\n// Light LEDs 9 & 10 in cyan when keyboard layer 1 is active\\nconst rgblight_segment_t PROGMEM my_layer1_layer[] = RGBLIGHT_LAYER_SEGMENTS(\\n {9, 2, HSV_CYAN}\\n);\\n// Light LEDs 11 & 12 in purple when keyboard layer 2 is active\\nconst rgblight_segment_t PROGMEM my_layer2_layer[] = RGBLIGHT_LAYER_SEGMENTS(\\n {11, 2, HSV_PURPLE}\\n);\\n// Light LEDs 13 & 14 in green when keyboard layer 3 is active\\nconst rgblight_segment_t PROGMEM my_layer3_layer[] = RGBLIGHT_LAYER_SEGMENTS(\\n {13, 2, HSV_GREEN}\\n);\\n// etc..\\n```\\n\\nWe combine these layers into an array using the `RGBLIGHT_LAYERS_LIST` macro, and assign it to the `rgblight_layers` variable during keyboard setup. Note that you can only define up to 8 lighting layers. Any extra layers will be ignored. Since the different lighting layers overlap, the order matters in the array, with later layers taking precedence:\\n\\n```\\n// Now define the array of layers. Later layers take precedence\\nconst rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(\\n my_capslock_layer,\\n my_layer1_layer, // Overrides caps lock layer\\n my_layer2_layer, // Overrides other layers\\n my_layer3_layer // Overrides other layers\\n);\\n\\nvoid keyboard_post_init_user(void) {\\n // Enable the LED layers\\n rgblight_layers = my_rgb_layers;\\n}\\n```\\n\\nNote: For split keyboards with two controllers, both sides need to be flashed when updating the contents of rgblight_layers.\", \"Enabling and disabling lighting layers {#enabling-lighting-layers}\": \"Everything above just configured the definition of each lighting layer.\\nWe can now enable and disable the lighting layers whenever the state of the keyboard changes:\\n\\n```\\nbool led_update_user(led_t led_state) {\\n rgblight_set_layer_state(0, led_state.caps_lock);\\n return true;\\n}\\n\\nlayer_state_t default_layer_state_set_user(layer_state_t state) {\\n rgblight_set_layer_state(1, layer_state_cmp(state, _DVORAK));\\n return state;\\n}\\n\\nlayer_state_t layer_state_set_user(layer_state_t state) {\\n rgblight_set_layer_state(2, layer_state_cmp(state, _FN));\\n rgblight_set_layer_state(3, layer_state_cmp(state, _ADJUST));\\n return state;\\n}\\n```\", \"Lighting layer blink {#lighting-layer-blink}\": \"By including `#define RGBLIGHT_LAYER_BLINK` in your `config.h` file you can turn a lighting\\nlayer on for a specified duration. Once the specified number of milliseconds has elapsed\\nthe layer will be turned off. This is useful, e.g., if you want to acknowledge some\\naction (e.g. toggling some setting):\\n\\n```\\nconst rgblight_segment_t PROGMEM _yes_layer[] = RGBLIGHT_LAYER_SEGMENTS( {9, 6, HSV_GREEN} );\\nconst rgblight_segment_t PROGMEM _no_layer[] = RGBLIGHT_LAYER_SEGMENTS( {9, 6, HSV_RED} );\\n\\nconst rgblight_segment_t* const PROGMEM _rgb_layers[] =\\n RGBLIGHT_LAYERS_LIST( _yes_layer, _no_layer );\\n\\nvoid keyboard_post_init_user(void) {\\n rgblight_layers = _rgb_layers;\\n}\\n\\n// Note we user post_process_record_user because we want the state\\n// after the flag has been flipped...\\nvoid post_process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case QK_DEBUG_TOGGLE:\\n rgblight_blink_layer(debug_enable ? 0 : 1, 500);\\n break;\\n\\n case NK_TOGG:\\n case NK_ON:\\n case NK_OFF:\\n rgblight_blink_layer(keymap_config.nkro ? 0 : 1, 500);\\n break;\\n }\\n}\\n```\\n\\nYou can also use `rgblight_blink_layer_repeat` to specify the amount of times the layer is supposed to blink. Using the layers from above,\\n\\n```\\nvoid post_process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case QK_DEBUG_TOGGLE:\\n rgblight_blink_layer_repeat(debug_enable ? 0 : 1, 200, 3);\\n break;\\n }\\n}\\n```\\n\\nwould turn the layer 0 (or 1) on and off again three times when `DB_TOGG` is pressed.\\n\\nBlinking accumulates layers so if multiple layers are set blinking at the same time they will all blink for the duration and repeat times of the last layer to be blinked.\\nTo stop these other layers from blinking use `rgblight_unblink_layer` or `rgblight_unblink_all_but_layer`:\\n\\n```\\nrgblight_blink_layer(1, 500);\\nrgblight_unblink_all_but_layer(1);\\n```\\n\\n```\\nrgblight_unblink_layer(3);\\nrgblight_blink_layer(2, 500);\\n```\\n\\n::: warning\\nLighting layers on split keyboards will require layer state synced to the slave half (e.g. `#define SPLIT_LAYER_STATE_ENABLE`). See [data sync options](split_keyboard#data-sync-options) for more details.\\n:::\", \"Overriding RGB Lighting on/off status\": \"Normally lighting layers are not shown when RGB Lighting is disabled (e.g. with `UG_TOGG` keycode). If you would like lighting layers to work even when the RGB Lighting is otherwise off, add `#define RGBLIGHT_LAYERS_OVERRIDE_RGB_OFF` to your `config.h`.\", \"Retain brightness\": \"Usually lighting layers apply their configured brightness once activated. If you would like lighting layers to retain the currently used brightness (as returned by `rgblight_get_val()`), add `#define RGBLIGHT_LAYERS_RETAIN_VAL` to your `config.h`.\"}, \"Functions\": {\"Low level Functions\": \"|Function |Description |\\n|--------------------------------------------|-------------------------------------------|\\n|`rgblight_set()` |Flush out led buffers to LEDs |\\n|`rgblight_set_clipping_range(pos, num)` |Set clipping Range. see [Clipping Range](#clipping-range) |\", \"Effects and Animations Functions\": {\"effect range setting\": \"|Function |Description |\\n|--------------------------------------------|------------------|\\n|`rgblight_set_effect_range(pos, num)` |Set Effects Range |\", \"direct operation\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_setrgb_at(r, g, b, index)` |Set a single LED to the given RGB value, where `r`/`g`/`b` are between 0 and 255 and `index` is between 0 and `RGBLIGHT_LED_COUNT` (not written to EEPROM) |\\n|`rgblight_sethsv_at(h, s, v, index)` |Set a single LED to the given HSV value, where `h`/`s`/`v` are between 0 and 255, and `index` is between 0 and `RGBLIGHT_LED_COUNT` (not written to EEPROM) |\\n|`rgblight_setrgb_range(r, g, b, start, end)`|Set a continuous range of LEDs to the given RGB value, where `r`/`g`/`b` are between 0 and 255 and `start`(included) and `stop`(excluded) are between 0 and `RGBLIGHT_LED_COUNT` (not written to EEPROM)|\\n|`rgblight_sethsv_range(h, s, v, start, end)`|Set a continuous range of LEDs to the given HSV value, where `h`/`s`/`v` are between 0 and 255, and `start`(included) and `stop`(excluded) are between 0 and `RGBLIGHT_LED_COUNT` (not written to EEPROM)|\\n|`rgblight_setrgb(r, g, b)` |Set effect range LEDs to the given RGB value where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM) |\\n|`rgblight_setrgb_master(r, g, b)` |Set the LEDs on the master side to the given RGB value, where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM) |\\n|`rgblight_setrgb_slave(r, g, b)` |Set the LEDs on the slave side to the given RGB value, where `r`/`g`/`b` are between 0 and 255 (not written to EEPROM) |\\n|`rgblight_sethsv_master(h, s, v)` |Set the LEDs on the master side to the given HSV value, where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |\\n|`rgblight_sethsv_slave(h, s, v)` |Set the LEDs on the slave side to the given HSV value, where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |\\n\\nExample:\\n\\n```\\nrgblight_sethsv_at(HSV_WHITE, 0); // led 0\\nrgblight_sethsv_at(HSV_RED, 1); // led 1\\nrgblight_sethsv_at(HSV_GREEN, 2); // led 2\\n// The above functions automatically calls rgblight_set(), so there is no need to call it explicitly.\\n// Note that it is inefficient to call repeatedly.\\n```\", \"effect mode change\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_mode(x)` |Set the mode, if RGB animations are enabled |\\n|`rgblight_mode_noeeprom(x)` |Set the mode, if RGB animations are enabled (not written to EEPROM) |\\n|`rgblight_step()` |Change the mode to the next RGB animation in the list of enabled RGB animations |\\n|`rgblight_step_noeeprom()` |Change the mode to the next RGB animation in the list of enabled RGB animations (not written to EEPROM) |\\n|`rgblight_step_reverse()` |Change the mode to the previous RGB animation in the list of enabled RGB animations |\\n|`rgblight_step_reverse_noeeprom()` |Change the mode to the previous RGB animation in the list of enabled RGB animations (not written to EEPROM) |\\n|`rgblight_reload_from_eeprom()` |Reload the effect configuration (enabled, mode and color) from EEPROM |\", \"effects mode disable/enable\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_toggle()` |Toggle effect range LEDs between on and off |\\n|`rgblight_toggle_noeeprom()` |Toggle effect range LEDs between on and off (not written to EEPROM) |\\n|`rgblight_enable()` |Turn effect range LEDs on, based on their previous state |\\n|`rgblight_enable_noeeprom()` |Turn effect range LEDs on, based on their previous state (not written to EEPROM) |\\n|`rgblight_disable()` |Turn effect range LEDs off |\\n|`rgblight_disable_noeeprom()` |Turn effect range LEDs off (not written to EEPROM) |\", \"hue, sat, val change\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_increase_hue()` |Increase the hue for effect range LEDs. This wraps around at maximum hue |\\n|`rgblight_increase_hue_noeeprom()` |Increase the hue for effect range LEDs. This wraps around at maximum hue (not written to EEPROM) |\\n|`rgblight_decrease_hue()` |Decrease the hue for effect range LEDs. This wraps around at minimum hue |\\n|`rgblight_decrease_hue_noeeprom()` |Decrease the hue for effect range LEDs. This wraps around at minimum hue (not written to EEPROM) |\\n|`rgblight_increase_sat()` |Increase the saturation for effect range LEDs. This stops at maximum saturation |\\n|`rgblight_increase_sat_noeeprom()` |Increase the saturation for effect range LEDs. This stops at maximum saturation (not written to EEPROM) |\\n|`rgblight_decrease_sat()` |Decrease the saturation for effect range LEDs. This stops at minimum saturation |\\n|`rgblight_decrease_sat_noeeprom()` |Decrease the saturation for effect range LEDs. This stops at minimum saturation (not written to EEPROM) |\\n|`rgblight_increase_val()` |Increase the value for effect range LEDs. This stops at maximum value |\\n|`rgblight_increase_val_noeeprom()` |Increase the value for effect range LEDs. This stops at maximum value (not written to EEPROM) |\\n|`rgblight_decrease_val()` |Decrease the value for effect range LEDs. This stops at minimum value |\\n|`rgblight_decrease_val_noeeprom()` |Decrease the value for effect range LEDs. This stops at minimum value (not written to EEPROM) |\\n|`rgblight_sethsv(h, s, v)` |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 |\\n|`rgblight_sethsv_noeeprom(h, s, v)` |Set effect range LEDs to the given HSV value where `h`/`s`/`v` are between 0 and 255 (not written to EEPROM) |\", \"Speed functions\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_increase_speed()` |Increases the animation speed |\\n|`rgblight_increase_speed_noeeprom()` |Increases the animation speed (not written to EEPROM) |\\n|`rgblight_decrease_speed()` |Decreases the animation speed |\\n|`rgblight_decrease_speed_noeeprom()` |Decreases the animation speed (not written to EEPROM) |\\n|`rgblight_set_speed()` |Sets the speed. Value is between 0 and 255 |\\n|`rgblight_set_speed_noeeprom()` |Sets the speed. Value is between 0 and 255 (not written to EEPROM) |\", \"layer functions\": \"|Function |Description |\\n|--------------------------------------------|-------------|\\n|`rgblight_get_layer_state(i)` |Returns `true` if lighting layer `i` is enabled |\\n|`rgblight_set_layer_state(i, is_on)` |Enable or disable lighting layer `i` based on value of `bool is_on` |\", \"query\": \"|Function |Description |\\n|-----------------------|---------------------------|\\n|`rgblight_is_enabled()`|Gets current on/off status |\\n|`rgblight_get_mode()` |Gets current mode |\\n|`rgblight_get_hue()` |Gets current hue |\\n|`rgblight_get_sat()` |Gets current sat |\\n|`rgblight_get_val()` |Gets current val |\\n|`rgblight_get_speed()` |Gets current speed |\"}}, \"Colors\": \"These are shorthands to popular colors. The `RGB` ones can be passed to the `setrgb` functions, while the `HSV` ones to the `sethsv` functions.\\n\\n|RGB |HSV |\\n|---------------------|---------------------|\\n|`RGB_AZURE` |`HSV_AZURE` |\\n|`RGB_BLACK`/`RGB_OFF`|`HSV_BLACK`/`HSV_OFF`|\\n|`RGB_BLUE` |`HSV_BLUE` |\\n|`RGB_CHARTREUSE` |`HSV_CHARTREUSE` |\\n|`RGB_CORAL` |`HSV_CORAL` |\\n|`RGB_CYAN` |`HSV_CYAN` |\\n|`RGB_GOLD` |`HSV_GOLD` |\\n|`RGB_GOLDENROD` |`HSV_GOLDENROD` |\\n|`RGB_GREEN` |`HSV_GREEN` |\\n|`RGB_MAGENTA` |`HSV_MAGENTA` |\\n|`RGB_ORANGE` |`HSV_ORANGE` |\\n|`RGB_PINK` |`HSV_PINK` |\\n|`RGB_PURPLE` |`HSV_PURPLE` |\\n|`RGB_RED` |`HSV_RED` |\\n|`RGB_SPRINGGREEN` |`HSV_SPRINGGREEN` |\\n|`RGB_TEAL` |`HSV_TEAL` |\\n|`RGB_TURQUOISE` |`HSV_TURQUOISE` |\\n|`RGB_WHITE` |`HSV_WHITE` |\\n|`RGB_YELLOW` |`HSV_YELLOW` |\\n\\n```\\nrgblight_setrgb(RGB_ORANGE);\\nrgblight_sethsv_noeeprom(HSV_GREEN);\\nrgblight_setrgb_at(RGB_GOLD, 3);\\nrgblight_sethsv_range(HSV_WHITE, 0, 6);\\n```\\n\\nThese are defined in [`color.h`](https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h). Feel free to add to this list!\", \"Changing the order of the LEDs\": \"If you want to make the logical order of LEDs different from the electrical connection order, you can do this by defining the `RGBLIGHT_LED_MAP` macro in your `config.h`.\\n\\nNormally, the contents of the LED buffer are output to the LEDs in the same order.\\n<img src=\\\"https://user-images.githubusercontent.com/2170248/55743718-01866c80-5a6e-11e9-8134-25419928327a.JPG\\\" alt=\\\"simple dicrect\\\" width=\\\"50%\\\"/>\\n\\nBy defining `RGBLIGHT_LED_MAP` as in the example below, you can specify the LED with addressing in reverse order of the electrical connection order.\\n\\n```\\n// config.h\\n\\n#define RGBLIGHT_LED_COUNT 4\\n#define RGBLIGHT_LED_MAP { 3, 2, 1, 0 }\\n\\n```\\n\\n<img src=\\\"https://user-images.githubusercontent.com/2170248/55743725-08ad7a80-5a6e-11e9-83ed-126a2b0209fc.JPG\\\" alt=\\\"simple mapped\\\" width=\\\"50%\\\"/>\", \"Clipping Range\": \"Using the `rgblight_set_clipping_range()` function, you can prepare more buffers than the actual number of LEDs, and output some of the buffers to the LEDs. This is useful if you want the split keyboard to treat left and right LEDs as logically contiguous.\\n\\nYou can set the Clipping Range by executing the following code.\\n\\n```\\n// some source\\nrgblight_set_clipping_range(3, 4);\\n```\\n\\n<img src=\\\"https://user-images.githubusercontent.com/2170248/55743785-2bd82a00-5a6e-11e9-9d4b-1b4ffaf4932b.JPG\\\" alt=\\\"clip direct\\\" width=\\\"70%\\\"/>\\n\\nIn addition to setting the Clipping Range, you can use `RGBLIGHT_LED_MAP` together.\\n\\n```\\n// config.h\\n#define RGBLIGHT_LED_COUNT 8\\n#define RGBLIGHT_LED_MAP { 7, 6, 5, 4, 3, 2, 1, 0 }\\n\\n// some source\\nrgblight_set_clipping_range(3, 4);\\n```\\n\\n<img src=\\\"https://user-images.githubusercontent.com/2170248/55743747-119e4c00-5a6e-11e9-91e5-013203ffae8a.JPG\\\" alt=\\\"clip mapped\\\" width=\\\"70%\\\"/>\", \"Hardware Modification\": \"If your keyboard lacks onboard underglow LEDs, you may often be able to solder on an RGB LED strip yourself. You will need to find an unused pin to wire to the data pin of your LED strip. Some keyboards may break out unused pins from the MCU to make soldering easier. The other two pins, VCC and GND, must also be connected to the appropriate power pins.\", \"Velocikey\": {\"Usage\": \"For Velocikey to take effect, there are two steps. First, when compiling your keyboard, you'll need to set `VELOCIKEY_ENABLE=yes` in `rules.mk`, e.g.:\\n\\n```\\nMOUSEKEY_ENABLE = no\\nSTENO_ENABLE = no\\nEXTRAKEY_ENABLE = yes\\nVELOCIKEY_ENABLE = yes\\n```\\n\\nThen, while using your keyboard, you need to also turn it on with the `VK_TOGG` keycode, which toggles the feature on and off.\\n\\nThe following light effects will all be controlled by Velocikey when it is enabled:\\n\\n['RGB Breathing', 'RGB Rainbow Mood', 'RGB Rainbow Swirl', 'RGB Snake', 'RGB Knight']\\n\\nSupport for LED breathing effects is planned but not available yet.\\n\\nAs long as Velocikey is enabled, it will control the speed regardless of any other speed setting that your RGB lights are currently on.\", \"Configuration\": \"Velocikey doesn't currently support any configuration via keyboard settings. If you want to adjust something like the speed increase or decay rate, you would need to edit `velocikey.c` and adjust the values there to achieve the kinds of speeds that you like.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 33]\"}, {\"title\": \"Secure\", \"description\": null, \"content\": {\"Usage\": \"Add the following to your `rules.mk`:\\n\\n```\\nSECURE_ENABLE = yes\\n```\", \"Keycodes\": \"| Key |Aliases | Description |\\n|---------------------|---------|--------------------------------------------------------------------------------|\\n| `QK_SECURE_LOCK` |`SE_LOCK`| Revert back to a locked state |\\n| `QK_SECURE_UNLOCK` |`SE_UNLK`| Forces unlock without performing a unlock sequence |\\n| `QK_SECURE_TOGGLE` |`SE_TOGG`| Toggle directly between locked and unlock without performing a unlock sequence |\\n| `QK_SECURE_REQUEST` |`SE_REQ` | Request that user perform the unlock sequence |\", \"Configuration\": \"| Define | Default | Description |\\n|-------------------------|----------------|---------------------------------------------------------------------------------|\\n|`SECURE_UNLOCK_TIMEOUT` | `5000` | Timeout for the user to perform the configured unlock sequence - `0` to disable |\\n|`SECURE_IDLE_TIMEOUT` | `60000` | Timeout while unlocked before returning to locked - `0` to disable |\\n|`SECURE_UNLOCK_SEQUENCE` | `{ { 0, 0 } }` | Array of matrix locations describing a sequential sequence of keypresses |\", \"Functions\": \"| Function | Description |\\n|---------------------------|----------------------------------------------------------------------------|\\n| `secure_is_locked()` | Check if the device is currently locked |\\n| `secure_is_unlocking()` | Check if an unlock sequence is currently in progress |\\n| `secure_is_unlocked()` | Check if the device is currently unlocked |\\n| `secure_lock()` | Lock down the device |\\n| `secure_unlock()` | Force unlock the device - bypasses user unlock sequence |\\n| `secure_request_unlock()` | Begin listening for an unlock sequence |\\n| `secure_activity_event()` | Flag that user activity has happened and the device should remain unlocked |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 34]\"}, {\"title\": \"Send String {#send-string}\", \"description\": null, \"content\": {\"Usage {#usage}\": \"Send String is enabled by default, so there is usually no need for any special setup. However, if it is disabled, add the following to your `rules.mk`:\\n\\n```\\nSEND_STRING_ENABLE = yes\\n```\", \"Basic Configuration {#basic-configuration}\": \"Add the following to your `config.h`:\\n\\n|Define |Default |Description |\\n|-----------------|----------------|------------------------------------------------------------------------------------------------------------|\\n|`SENDSTRING_BELL`|*Not defined* |If the [Audio](audio) feature is enabled, the `\\\\a` character (ASCII `BEL`) will beep the speaker.|\\n|`BELL_SOUND` |`TERMINAL_SOUND`|The song to play when the `\\\\a` character is encountered. By default, this is an eighth note of C5. |\", \"Keycodes {#keycodes}\": {\"Language Support {#language-support}\": \"By default, Send String assumes your OS keyboard layout is set to US ANSI. If you are using a different keyboard layout, you can [override the lookup tables used to convert ASCII characters to keystrokes](../reference_keymap_extras#sendstring-support).\"}, \"Examples {#examples}\": {\"Hello World {#example-hello-world}\": \"A simple custom keycode which types out \\\"Hello, world!\\\" and the Enter key when pressed.\\n\\nAdd the following to your `keymap.c`:\\n\\n```\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case SS_HELLO:\\n if (record->event.pressed) {\\n SEND_STRING(\\\"Hello, world!\\\\n\\\");\\n }\\n return false;\\n }\\n\\n return true;\\n}\\n```\", \"Keycode Injection {#example-keycode-injection}\": \"This example types out opening and closing curly braces, then taps the left arrow key to move the cursor between the two.\\n\\n```\\nSEND_STRING(\\\"{}\\\" SS_TAP(X_LEFT));\\n```\\n\\nThis example types Ctrl+A, then Ctrl+C, without releasing Ctrl.\\n\\n```\\nSEND_STRING(SS_LCTL(\\\"ac\\\"));\\n```\"}, \"API {#api}\": {\"`void send_string(const char *string)` {#api-send-string}\": {\"Arguments {#api-send-string-arguments}\": [\"`const char *string` \\nThe string to type out.\"]}, \"`void send_string_with_delay(const char *string, uint8_t interval)` {#api-send-string-with-delay}\": {\"Arguments {#api-send-string-with-delay-arguments}\": [\"`const char *string` \\nThe string to type out.\", \"`uint8_t interval` \\nThe amount of time, in milliseconds, to wait before typing the next character.\"]}, \"`void send_string_P(const char *string)` {#api-send-string-p}\": {\"Arguments {#api-send-string-p-arguments}\": [\"`const char *string` \\nThe string to type out.\"]}, \"`void send_string_with_delay_P(const char *string, uint8_t interval)` {#api-send-string-with-delay-p}\": {\"Arguments {#api-send-string-with-delay-p-arguments}\": [\"`const char *string` \\nThe string to type out.\", \"`uint8_t interval` \\nThe amount of time, in milliseconds, to wait before typing the next character.\"]}, \"`void send_char(char ascii_code)` {#api-send-char}\": {\"Arguments {#api-send-char-arguments}\": [\"`char ascii_code` \\nThe character to type.\"]}, \"`void send_dword(uint32_t number)` {#api-send-dword}\": {\"Arguments {#api-send-dword-arguments}\": [\"`uint32_t number` \\nThe value to type, from 0 to 4,294,967,295.\"]}, \"`void send_word(uint16_t number)` {#api-send-word}\": {\"Arguments {#api-send-word-arguments}\": [\"`uint16_t number` \\nThe value to type, from 0 to 65,535.\"]}, \"`void send_byte(uint8_t number)` {#api-send-bytes}\": {\"Arguments {#api-send-byte-arguments}\": [\"`uint8_t number` \\nThe value to type, from 0 to 255.\"]}, \"`void send_nibble(uint8_t number)` {#api-send-nibble}\": {\"Arguments {#api-send-nibble-arguments}\": [\"`uint8_t number` \\nThe value to type, from 0 to 15.\"]}, \"`void tap_random_base64(void)` {#api-tap-random-base64}\": \"Type a pseudorandom character from the set `A-Z`, `a-z`, `0-9`, `+` and `/`.\\n\\n[]\", \"`SEND_STRING(string)` {#api-send-string-macro}\": \"Shortcut macro for `send_string_with_delay_P(PSTR(string), 0)`.\\n\\nOn ARM devices, this define evaluates to `send_string_with_delay(string, 0)`.\\n\\n[]\", \"`SEND_STRING_DELAY(string, interval)` {#api-send-string-delay-macro}\": \"Shortcut macro for `send_string_with_delay_P(PSTR(string), interval)`.\\n\\nOn ARM devices, this define evaluates to `send_string_with_delay(string, interval)`.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 35]\"}, {\"title\": \"Sequencer\", \"description\": null, \"content\": {\"Enable the step sequencer\": \"Add the following line to your `rules.mk`:\\n\\n```\\nSEQUENCER_ENABLE = yes\\n```\\n\\nBy default the sequencer has 16 steps, but you can override this setting in your `config.h`:\\n\\n```\\n#define SEQUENCER_STEPS 32\\n```\", \"Tracks\": \"You can program up to 8 independent tracks with the step sequencer. Select the tracks you want to edit, enable or disable some steps, and start the sequence!\", \"Resolutions\": \"While the tempo defines the absolute speed at which the sequencer goes through the steps, the resolution defines the granularity of these steps (from coarser to finer).\\n\\n|Resolution |Description |\\n|---------- |----------- |\\n|`SQ_RES_2` |Every other beat |\\n|`SQ_RES_2T` |Every 1.5 beats |\\n|`SQ_RES_4` |Every beat |\\n|`SQ_RES_4T` |Three times per 2 beats|\\n|`SQ_RES_8` |Twice per beat |\\n|`SQ_RES_8T` |Three times per beat |\\n|`SQ_RES_16` |Four times per beat |\\n|`SQ_RES_16T` |Six times per beat |\\n|`SQ_RES_32` |Eight times per beat |\", \"Keycodes\": \"|Key |Aliases |Description |\\n|-------------------------------|---------|---------------------------------------------------|\\n|`QK_SEQUENCER_ON` |`SQ_ON` |Start the step sequencer |\\n|`QK_SEQUENCER_OFF` |`SQ_OFF` |Stop the step sequencer |\\n|`QK_SEQUENCER_TOGGLE` |`SQ_TOGG`|Toggle the step sequencer playback |\\n|`QK_SEQUENCER_STEPS_ALL` |`SQ_SALL`|Enable all the steps |\\n|`QK_SEQUENCER_STEPS_CLEAR` |`SQ_SCLR`|Disable all the steps |\\n|`QK_SEQUENCER_TEMPO_DOWN` |`SQ_TMPD`|Decrease the tempo |\\n|`QK_SEQUENCER_TEMPO_UP` |`SQ_TMPU`|Increase the tempo |\\n|`QK_SEQUENCER_RESOLUTION_DOWN` |`SQ_RESD`|Change to the slower resolution |\\n|`QK_SEQUENCER_RESOLUTION_UP` |`SQ_RESU`|Change to the faster resolution |\\n|`SQ_S(n)` | |Toggle the step `n` |\\n|`SQ_R(n)` | |Set the resolution to n |\\n|`SQ_T(n)` | |Set `n` as the only active track or deactivate all |\", \"Functions\": \"|Function |Description |\\n|-------- |----------- |\\n|`bool is_sequencer_on(void);` |Return whether the sequencer is playing |\\n|`void sequencer_toggle(void);` |Toggle the step sequencer playback |\\n|`void sequencer_on(void);` |Start the step sequencer |\\n|`void sequencer_off(void);` |Stop the step sequencer |\\n|`bool is_sequencer_step_on(uint8_t step);` |Return whether the step is currently enabled |\\n|`void sequencer_set_step(uint8_t step, bool value);` |Enable or disable the step |\\n|`void sequencer_set_step_on();` |Enable the step |\\n|`void sequencer_set_step_off();` |Disable the step |\\n|`void sequencer_toggle_step(uint8_t step);` |Toggle the step |\\n|`void sequencer_set_all_steps(bool value);` |Enable or disable all the steps |\\n|`void sequencer_set_all_steps_on();` |Enable all the steps |\\n|`void sequencer_set_all_steps_off();` |Disable all the steps |\\n|`uint8_t sequencer_get_tempo(void);` |Return the current tempo |\\n|`void sequencer_set_tempo(uint8_t tempo);` |Set the tempo to `tempo` (between 1 and 255) |\\n|`void sequencer_increase_tempo(void);` |Increase the tempo |\\n|`void sequencer_decrease_tempo(void);` |Decrease the tempo |\\n|`sequencer_resolution_t sequencer_get_resolution(void);` |Return the current resolution |\\n|`void sequencer_set_resolution(sequencer_resolution_t resolution);` |Set the resolution to `resolution` |\\n|`void sequencer_increase_resolution(void);` |Change to the faster resolution |\\n|`void sequencer_decrease_resolution(void);` |Change to the slower resolution |\\n|`bool is_sequencer_track_active(uint8_t track);` |Return whether the track is active |\\n|`void sequencer_set_track_activation(uint8_t track, bool value);` |Activate or deactivate the `track` |\\n|`void sequencer_toggle_track_activation(uint8_t track);` |Toggle the `track` |\\n|`void sequencer_activate_track(uint8_t track);` |Activate the `track` |\\n|`void sequencer_deactivate_track(uint8_t track);` |Deactivate the `track` |\\n|`void sequencer_toggle_single_active_track(uint8_t track);` |Set `track` as the only active track or deactivate all |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 36]\"}, {\"title\": \"Space Cadet: The Future, Built In\", \"description\": null, \"content\": {\"Usage\": \"Firstly, in your keymap, do one of the following:\\n\\n['Replace the Left Shift key with `SC_LSPO` (Left Shift, Parenthesis Open), and Right Shift with `SC_RSPC` (Right Shift, Parenthesis Close).', 'Replace the Left Control key with `SC_LCPO` (Left Control, Parenthesis Open), and Right Control with `SC_RCPC` (Right Control, Parenthesis Close).', 'Replace the Left Alt key with `SC_LAPO` (Left Alt, Parenthesis Open), and Right Alt with `SC_RAPC` (Right Alt, Parenthesis Close).', 'Replace any Shift key in your keymap with `SC_SENT` (Right Shift, Enter).']\", \"Keycodes\": \"|Keycode |Aliases |Description |\\n|----------------------------------------------|---------|----------------------------------------|\\n|`QK_SPACE_CADET_LEFT_CTRL_PARENTHESIS_OPEN` |`SC_LCPO`|Left Control when held, `(` when tapped |\\n|`QK_SPACE_CADET_RIGHT_CTRL_PARENTHESIS_CLOSE` |`SC_RCPC`|Right Control when held, `)` when tapped|\\n|`QK_SPACE_CADET_LEFT_SHIFT_PARENTHESIS_OPEN` |`SC_LSPO`|Left Shift when held, `(` when tapped |\\n|`QK_SPACE_CADET_RIGHT_SHIFT_PARENTHESIS_CLOSE`|`SC_RSPC`|Right Shift when held, `)` when tapped |\\n|`QK_SPACE_CADET_LEFT_ALT_PARENTHESIS_OPEN` |`SC_LAPO`|Left Alt when held, `(` when tapped |\\n|`QK_SPACE_CADET_RIGHT_ALT_PARENTHESIS_CLOSE` |`SC_RAPC`|Right Alt when held, `)` when tapped |\\n|`QK_SPACE_CADET_RIGHT_SHIFT_ENTER` |`SC_SENT`|Right Shift when held, Enter when tapped|\", \"Caveats\": \"Space Cadet's functionality can conflict with the default Command functionality when both Shift keys are held at the same time. See the [Command feature](command) for info on how to change it, or make sure that Command is disabled in your `rules.mk` with:\\n\\n```\\nCOMMAND_ENABLE = no\\n```\", \"Configuration\": \"By default Space Cadet assumes a US ANSI layout, but if your layout uses different keys for parentheses, you can redefine them in your `config.h`. In addition, you can redefine the modifier to send on tap, or even send no modifier at all. The new configuration defines bundle all options up into a single define of 3 key codes in this order: the `Modifier` when held or when used with other keys, the `Tap Modifer` sent when tapped (no modifier if `KC_TRNS`), finally the `Keycode` sent when tapped. Now keep in mind, mods from other keys will still apply to the `Keycode` if say `KC_RSFT` is held while tapping `SC_LSPO` key with `KC_TRNS` as the `Tap Modifer`.\\n\\n|Define |Default |Description |\\n|----------------|-------------------------------|---------------------------------------------------------------------------------|\\n|`LSPO_KEYS` |`KC_LSFT, LSPO_MOD, LSPO_KEY` |Send `KC_LSFT` when held, the mod and key defined by `LSPO_MOD` and `LSPO_KEY`. |\\n|`RSPC_KEYS` |`KC_RSFT, RSPC_MOD, RSPC_KEY` |Send `KC_RSFT` when held, the mod and key defined by `RSPC_MOD` and `RSPC_KEY`. |\\n|`LCPO_KEYS` |`KC_LCTL, KC_LSFT, KC_9` |Send `KC_LCTL` when held, the mod `KC_LSFT` with the key `KC_9` when tapped. |\\n|`RCPC_KEYS` |`KC_RCTL, KC_RSFT, KC_0` |Send `KC_RCTL` when held, the mod `KC_RSFT` with the key `KC_0` when tapped. |\\n|`LAPO_KEYS` |`KC_LALT, KC_LSFT, KC_9` |Send `KC_LALT` when held, the mod `KC_LSFT` with the key `KC_9` when tapped. |\\n|`RAPC_KEYS` |`KC_RALT, KC_RSFT, KC_0` |Send `KC_RALT` when held, the mod `KC_RSFT` with the key `KC_0` when tapped. |\\n|`SFTENT_KEYS` |`KC_RSFT, KC_TRNS, SFTENT_KEY` |Send `KC_RSFT` when held, no mod with the key `SFTENT_KEY` when tapped. |\\n|`SPACE_CADET_MODIFIER_CARRYOVER` |*Not defined* |Store current modifiers before the hold mod is pressed and use them with the tap mod and keycode. Useful for when you frequently release a modifier before triggering Space Cadet. |\", \"Obsolete Configuration\": \"These defines are used in the above defines internally to support backwards compatibility, so you may continue to use them, however the above defines open up a larger range of flexibility than before. As an example, say you want to not send any modifier when you tap just `SC_LSPO`, with the old defines you had an all or nothing choice of using the `DISABLE_SPACE_CADET_MODIFIER` define. Now you can define that key as: `#define LSPO_KEYS KC_LSFT, KC_TRNS, KC_9`. This tells the system to set Left Shift if held or used with other keys, then on tap send no modifier (transparent) with the `KC_9`.\\n\\n|Define |Default |Description |\\n|------------------------------|-------------|------------------------------------------------------------------|\\n|`LSPO_KEY` |`KC_9` |The keycode to send when Left Shift is tapped |\\n|`RSPC_KEY` |`KC_0` |The keycode to send when Right Shift is tapped |\\n|`LSPO_MOD` |`KC_LSFT` |The modifier to apply to `LSPO_KEY` |\\n|`RSPC_MOD` |`KC_RSFT` |The modifier to apply to `RSPC_KEY` |\\n|`SFTENT_KEY` |`KC_ENT` |The keycode to send when the Shift key is tapped |\\n|`DISABLE_SPACE_CADET_MODIFIER`|*Not defined*|If defined, prevent the Space Cadet from applying a modifier |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 37]\"}, {\"title\": \"Split Keyboard \", \"description\": null, \"content\": {\"Compatibility Overview\": \"| Transport | AVR | ARM |\\n|------------------------------|--------------------|--------------------|\\n| ['serial'](../drivers/serial) | :heavy_check_mark: | :white_check_mark: <sup>1</sup> |\\n| I2C | :heavy_check_mark: | |\\n\\nNotes:\\n\\n['Both hardware and software limitations are detailed within the [driver documentation](../drivers/serial).']\", \"Hardware Configuration\": {\"Required Hardware\": {\"Considerations \": \"The most commonly used connection is a TRRS cable and jacks. These provide 4 wires, making them very useful for split keyboards, and are easy to find. \\n\\nHowever, since one of the wires carries VCC, this means that the boards are not hot pluggable. You should always disconnect the board from USB before unplugging and plugging in TRRS cables, or you can short the controller, or worse. \\n\\nAnother option is to use phone cables (as in, old school RJ-11/RJ-14 cables). Make sure that you use one that actually supports 4 wires/lanes. \\n\\nHowever, USB cables, SATA cables, and even just 4 wires have been known to be used for communication between the controllers. \\n\\n::: warning\\nUsing USB cables for communication between the controllers works just fine, but the connector could be mistaken for a normal USB connection and potentially short out the keyboard, depending on how it's wired. For this reason, they are not recommended for connecting split keyboards. \\n:::\"}, \"Serial Wiring\": \"The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and D0/D1/D2/D3 (aka PD0/PD1/PD2/PD3) between the two Pro Micros. \\n\\n::: tip\\nNote that the pin used here is actually set by `SOFT_SERIAL_PIN` below.\\n:::\\n\\n<img alt=\\\"sk-pd0-connection-mono\\\" src=\\\"https://user-images.githubusercontent.com/2170248/92296488-28e9ad80-ef70-11ea-98be-c40cb48a0319.JPG\\\" width=\\\"48%\\\"/>\\n<img alt=\\\"sk-pd2-connection-mono\\\" src=\\\"https://user-images.githubusercontent.com/2170248/92296490-2d15cb00-ef70-11ea-801f-5ace313013e6.JPG\\\" width=\\\"48%\\\"/>\", \"I<sup>2</sup>C Wiring\": \"The 4 wires of the TRRS cable need to connect GND, VCC, and SCL and SDA (aka PD0/pin 3 and PD1/pin 2, respectively) between the two Pro Micros. \\n\\nThe pull-up resistors may be placed on either half. If you wish to use the halves independently, it is also possible to use 4 resistors and have the pull-ups in both halves.\\nNote that the total resistance for the connected system should be within spec at 2.2k-10kOhm, with an 'ideal' at 4.7kOhm, regardless of the placement and number.\\n\\n<img alt=\\\"sk-i2c-connection-mono\\\" src=\\\"https://user-images.githubusercontent.com/2170248/92297182-92b98580-ef77-11ea-9d7d-d6033914af43.JPG\\\" width=\\\"50%\\\"/>\"}, \"Firmware Configuration\": {\"Layout Macro\": \"Configuring your layout in a split keyboard works slightly differently to a non-split keyboard. Take for example the following layout. The top left numbers refer to the matrix row and column, and the bottom right are the order of the keys in the layout:\\n\\n\\n\\nSince the matrix scanning procedure operates on entire rows, it first populates the left half's rows, then the right half's. Thus, the matrix as QMK views it has double the rows instead of double the columns:\\n\\n\", \"Setting Handedness\": {\"Handedness by Pin\": \"You can configure the firmware to read a pin on the controller to determine handedness. To do this, add the following to your `config.h` file:\\n\\n```\\n#define SPLIT_HAND_PIN B7\\n```\\n\\nThis will read the specified pin. By default, if it's high, then the controller assumes it is the left hand, and if it's low, it's assumed to be the right side. \\n\\nThis behaviour can be flipped by adding this to you `config.h` file:\\n\\n```\\n#define SPLIT_HAND_PIN_LOW_IS_LEFT\\n```\", \"Handedness by Matrix Pin\": \"You can configure the firmware to read key matrix pins on the controller to determine handedness. To do this, add the following to your `config.h` file:\\n\\n```\\n#define SPLIT_HAND_MATRIX_GRID D0, F1\\n```\\n\\nThe first pin is the output pin and the second is the input pin.\\n\\nSome keyboards have unused intersections in the key matrix. This setting uses one of these unused intersections to determine the handedness.\\n\\nNormally, when a diode is connected to an intersection, it is judged to be right. If you add the following definition, it will be judged to be left.\\n\\n```\\n#define SPLIT_HAND_MATRIX_GRID_LOW_IS_LEFT\\n```\\n\\nNote that adding a diode at a previously unused intersection will effectively tell the firmware that there is a key held down at that point. You can instruct qmk to ignore that intersection by defining `MATRIX_MASKED` and then defining a `matrix_row_t matrix_mask[MATRIX_ROWS]` array in your keyboard config. Each bit of a single value (starting form the least-significant bit) is used to tell qmk whether or not to pay attention to key presses at that intersection.\\n\\nWhile `MATRIX_MASKED` isn't necessary to use `SPLIT_HAND_MATRIX_GRID` successfully, without it you may experience issues trying to suspend your computer with your keyboard attached as the matrix will always report at least one key-press.\", \"Handedness by EEPROM\": \"This method sets the keyboard's handedness by setting a flag in the persistent storage (`EEPROM`). This is checked when the controller first starts up, and determines what half the keyboard is, and how to orient the keyboard layout. \\n\\nTo enable this method, add the following to your `config.h` file: \\n\\n```\\n#define EE_HANDS\\n```\\n\\nNext, you will have to flash the correct handedness option to the controller on each halve. You can do this manually with the following bootloader targets using `qmk flash -kb <keyboard> -km <keymap> -bl <bootloader>` command to flash:\\n\\n|Microcontroller Type|Bootloader Parameter|\\n|--------------------|--------------------|\\n|AVR controllers with Caterina bootloader<br>(e.g. Pro Micro)|`avrdude-split-left`<br>`avrdude-split-right`|\\n|AVR controllers with the stock Amtel DFU or DFU compatible bootloader<br>(e.g. Elite-C)|`dfu-split-left`<br>`dfu-split-right`|\\n|ARM controllers with a DFU compatible bootloader<br>(e.g. Proton-C)|`dfu-util-split-left`<br>`dfu-util-split-right`|\\n|ARM controllers with a UF2 compatible bootloader<br>(e.g. RP2040)|`uf2-split-left`<br>`uf2-split-right`|\\n\\nExample for `crkbd/rev1` keyboard with normal AVR Pro Micro MCUs, reset the left controller and run:\\n\\n```\\nqmk flash -kb crkbd/rev1 -km default -bl avrdude-split-left\\n```\\n\\nReset the right controller and run:\\n\\n```\\nqmk flash -kb crkbd/rev1 -km default -bl avrdude-split-right\\n```\\n\\n::: tip\\nSome controllers (e.g. Blackpill with DFU compatible bootloader) will need to be flashed with handedness bootloader parameter every time because it is not retained between flashes.\\n:::\\n\\n::: tip\\n[QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/) can also be used to flash EEPROM handedness files. Place the controller in bootloader mode and select menu option Tools -> EEPROM -> Set Left/Right Hand\\n:::\\n\\nThis setting is not changed when re-initializing the EEPROM using the `EE_CLR` key, or using the `eeconfig_init()` function. However, if you reset the EEPROM outside of the firmware's built in options (such as flashing a file that overwrites the `EEPROM`, like how the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases/)'s \\\"Reset EEPROM\\\" button works), you'll need to re-flash the controller with the `EEPROM` files. \\n\\nYou can find the `EEPROM` files in the QMK firmware repo, [here](https://github.com/qmk/qmk_firmware/tree/master/quantum/split_common).\", \"Handedness by `#define`\": \"You can use this option when USB cable is always connected to just one side of the split keyboard.\\n\\nIf the USB cable is always connected to the right side, add the following to your `config.h` file and flash both sides with this option:\\n\\n```\\n#define MASTER_RIGHT\\n```\\n\\nIf the USB cable is always connected to the left side, add the following to your `config.h` file and flash both sides with this option:\\n\\n```\\n#define MASTER_LEFT\\n```\\n\\n::: tip\\nIf neither options are defined, the handedness defaults to `MASTER_LEFT`.\\n:::\"}, \"Communication Options\": \"Because not every split keyboard is identical, there are a number of additional options that can be configured in your `config.h` file.\\n\\n```\\n#define USE_I2C\\n```\\n\\nThis configures the use of I<sup>2</sup>C support for split keyboard transport (AVR only). \\n\\n```\\n#define SOFT_SERIAL_PIN D0\\n```\\n\\nThis sets the pin to be used for serial communication. If you're not using serial, you shouldn't need to define this. \\n\\nHowever, if you are using serial and I<sup>2</sup>C on the board, you will need to set this, and to something other than D0 and D1 (as these are used for I<sup>2</sup>C communication).\\n\\n```\\n#define SELECT_SOFT_SERIAL_SPEED {#}\\n```\\n\\nIf you're having issues with serial communication, you can change this value, as it controls the communication speed for serial. The default is 1, and the possible values are:\\n\\n['**`0`**: about 189kbps (Experimental only)', '**`1`**: about 137kbps (default)', '**`2`**: about 75kbps', '**`3`**: about 39kbps', '**`4`**: about 26kbps', '**`5`**: about 20kbps']\\n\\n```\\n#define FORCED_SYNC_THROTTLE_MS 100\\n```\\n\\nThis sets the maximum number of milliseconds before forcing a synchronization of data from master to slave. Under normal circumstances this sync occurs whenever the data _changes_, for safety a data transfer occurs after this number of milliseconds if no change has been detected since the last sync. \\n\\n```\\n#define SPLIT_MAX_CONNECTION_ERRORS 10\\n```\\n\\nThis sets the maximum number of failed communication attempts (one per scan cycle) from the master part before it assumes that no slave part is connected. This makes it possible to use a master part without the slave part connected.\\n\\nSet to 0 to disable the disconnection check altogether.\\n\\n```\\n#define SPLIT_CONNECTION_CHECK_TIMEOUT 500\\n```\\n\\nHow long (in milliseconds) the master part should block all connection attempts to the slave after the communication has been flagged as disconnected (see `SPLIT_MAX_CONNECTION_ERRORS` above).\\n\\nOne communication attempt will be allowed everytime this amount of time has passed since the last attempt. If that attempt succeeds, the communication is seen as working again.\\n\\nSet to 0 to disable this throttling of communications while disconnected. This can save you a couple of bytes of firmware size.\", \"Data Sync Options\": \"The following sync options add overhead to the split communication protocol and may negatively impact the matrix scan speed when enabled. These can be enabled by adding the chosen option(s) to your `config.h` file.\\n\\n```\\n#define SPLIT_TRANSPORT_MIRROR\\n```\\n\\nThis mirrors the master side matrix to the slave side for features that react or require knowledge of master side key presses on the slave side. The purpose of this feature is to support cosmetic use of key events (e.g. RGB reacting to keypresses).\\n\\n```\\n#define SPLIT_LAYER_STATE_ENABLE\\n```\\n\\nThis enables syncing of the layer state between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the currently active layer.\\n\\n```\\n#define SPLIT_LED_STATE_ENABLE\\n```\\n\\nThis enables syncing of the Host LED status (caps lock, num lock, etc) between both halves of the split keyboard. The main purpose of this feature is to enable support for use of things like OLED display of the Host LED status.\\n\\n```\\n#define SPLIT_MODS_ENABLE\\n```\\n\\nThis enables transmitting modifier state (normal, weak, oneshot and oneshot locked) to the non primary side of the split keyboard. The purpose of this feature is to support cosmetic use of modifer state (e.g. displaying status on an OLED screen).\\n\\n```\\n#define SPLIT_WPM_ENABLE\\n```\\n\\nThis enables transmitting the current WPM to the slave side of the split keyboard. The purpose of this feature is to support cosmetic use of WPM (e.g. displaying the current value on an OLED screen).\\n\\n```\\n#define SPLIT_OLED_ENABLE\\n```\\n\\nThis enables transmitting the current OLED on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing.\\n\\n```\\n#define SPLIT_ST7565_ENABLE\\n```\\n\\nThis enables transmitting the current ST7565 on/off status to the slave side of the split keyboard. The purpose of this feature is to support state (on/off state only) syncing.\\n\\n```\\n#define SPLIT_POINTING_ENABLE\\n```\\n\\nThis enables transmitting the pointing device status to the master side of the split keyboard. The purpose of this feature is to enable use pointing devices on the slave side. \\n\\n::: warning\\nThere is additional required configuration for `SPLIT_POINTING_ENABLE` outlined in the [pointing device documentation](pointing_device#split-keyboard-configuration).\\n:::\\n\\n```\\n#define SPLIT_HAPTIC_ENABLE\\n```\\n\\nThis enables the triggering of haptic feedback on the slave side of the split keyboard. This will send information to the slave side such as the mode, dwell, and whether buzz is enabled.\\n\\n```\\n#define SPLIT_ACTIVITY_ENABLE\\n```\\n\\nThis synchronizes the activity timestamps between sides of the split keyboard, allowing for activity timeouts to occur.\", \"Custom data sync between sides {#custom-data-sync}\": \"QMK's split transport allows for arbitrary data transactions at both the keyboard and user levels. This is modelled on a remote procedure call, with the master invoking a function on the slave side, with the ability to send data from master to slave, process it slave side, and send data back from slave to master.\\n\\nTo leverage this, a keyboard or user/keymap can define a comma-separated list of _transaction IDs_:\\n\\n```\\n// for keyboard-level data sync:\\n#define SPLIT_TRANSACTION_IDS_KB KEYBOARD_SYNC_A, KEYBOARD_SYNC_B\\n// or, for user:\\n#define SPLIT_TRANSACTION_IDS_USER USER_SYNC_A, USER_SYNC_B, USER_SYNC_C\\n```\\n\\nThese _transaction IDs_ then need a slave-side handler function to be registered with the split transport, for example:\\n\\n```\\ntypedef struct _master_to_slave_t {\\n int m2s_data;\\n} master_to_slave_t;\\n\\ntypedef struct _slave_to_master_t {\\n int s2m_data;\\n} slave_to_master_t;\\n\\nvoid user_sync_a_slave_handler(uint8_t in_buflen, const void* in_data, uint8_t out_buflen, void* out_data) {\\n const master_to_slave_t *m2s = (const master_to_slave_t*)in_data;\\n slave_to_master_t *s2m = (slave_to_master_t*)out_data;\\n s2m->s2m_data = m2s->m2s_data + 5; // whatever comes in, add 5 so it can be sent back\\n}\\n\\nvoid keyboard_post_init_user(void) {\\n transaction_register_rpc(USER_SYNC_A, user_sync_a_slave_handler);\\n}\\n```\\n\\nThe master side can then invoke the slave-side handler - for normal keyboard functionality to be minimally affected, any keyboard- or user-level code attempting to sync data should be throttled:\\n\\n```\\nvoid housekeeping_task_user(void) {\\n if (is_keyboard_master()) {\\n // Interact with slave every 500ms\\n static uint32_t last_sync = 0;\\n if (timer_elapsed32(last_sync) > 500) {\\n master_to_slave_t m2s = {6};\\n slave_to_master_t s2m = {0};\\n if(transaction_rpc_exec(USER_SYNC_A, sizeof(m2s), &m2s, sizeof(s2m), &s2m)) {\\n last_sync = timer_read32();\\n dprintf(\\\"Slave value: %d\\\\n\\\", s2m.s2m_data); // this will now be 11, as the slave adds 5\\n } else {\\n dprint(\\\"Slave sync failed!\\\\n\\\");\\n }\\n }\\n }\\n}\\n```\\n\\n::: warning\\nIt is recommended that any data sync between halves happens during the master side's _housekeeping task_. This ensures timely retries should failures occur.\\n:::\\n\\nIf only one-way data transfer is needed, helper methods are provided:\\n\\n```\\nbool transaction_rpc_exec(int8_t transaction_id, uint8_t initiator2target_buffer_size, const void *initiator2target_buffer, uint8_t target2initiator_buffer_size, void *target2initiator_buffer);\\nbool transaction_rpc_send(int8_t transaction_id, uint8_t initiator2target_buffer_size, const void *initiator2target_buffer);\\nbool transaction_rpc_recv(int8_t transaction_id, uint8_t target2initiator_buffer_size, void *target2initiator_buffer);\\n```\\n\\nBy default, the inbound and outbound data is limited to a maximum of 32 bytes each. The sizes can be altered if required:\\n\\n```\\n// Master to slave:\\n#define RPC_M2S_BUFFER_SIZE 48\\n// Slave to master:\\n#define RPC_S2M_BUFFER_SIZE 48\\n```\", \"Hardware Configuration Options\": \"There are some settings that you may need to configure, based on how the hardware is set up. \\n\\n```\\n#define MATRIX_ROW_PINS_RIGHT { <row pins> }\\n#define MATRIX_COL_PINS_RIGHT { <col pins> }\\n```\\n\\nThis allows you to specify a different set of pins for the matrix on the right side. This is useful if you have a board with differently-shaped halves that requires a different configuration (such as Keebio's Quefrency). The number of pins in the right and left matrices must be the same, if you have a board with a different number of rows or columns on one side, pad out the extra spaces with `NO_PIN` and make sure you add the unused rows or columns to your matrix.\\n\\n```\\n#define DIRECT_PINS_RIGHT { { F1, F0, B0, C7 }, { F4, F5, F6, F7 } }\\n```\\n\\nThis allows you to specify a different set of direct pins for the right side.\\n\\n```\\n#define ENCODER_A_PINS_RIGHT { encoder1a, encoder2a }\\n#define ENCODER_B_PINS_RIGHT { encoder1b, encoder2b }\\n```\\n\\nThis allows you to specify a different set of encoder pins for the right side.\\n\\n```\\n#define RGBLIGHT_SPLIT\\n```\\n\\nThis option enables synchronization of the RGB Light modes between the controllers of the split keyboard. This is for keyboards that have RGB LEDs that are directly wired to the controller (that is, they are not using the \\\"extra data\\\" option on the TRRS cable).\\n\\n```\\n#define RGBLED_SPLIT { 6, 6 }\\n```\\n\\nThis sets how many LEDs are directly connected to each controller. The first number is the left side, and the second number is the right side. \\n\\n::: tip\\nThis setting implies that `RGBLIGHT_SPLIT` is enabled, and will forcibly enable it, if it's not.\\n:::\\n\\n```\\n#define SPLIT_USB_DETECT\\n```\\n\\nEnabling this option changes the startup behavior to listen for an active USB communication to delegate which part is master and which is slave. With this option enabled and active USB communication, then that half assumes it is the master, otherwise it assumes it is the slave.\\n\\nWithout this option, the master is the half that can detect voltage on the physical USB connection (VBUS detection).\\n\\nEnabled by default on ChibiOS/ARM.\\n\\n::: tip\\nThis setting will stop the ability to demo using battery packs.\\n:::\\n\\n```\\n#define SPLIT_USB_TIMEOUT 2000\\n```\\n\\nThis sets the maximum timeout when detecting master/slave when using `SPLIT_USB_DETECT`.\\n\\n```\\n#define SPLIT_USB_TIMEOUT_POLL 10\\n```\\n\\nThis sets the poll frequency when detecting master/slave when using `SPLIT_USB_DETECT`\\n\\n```\\n#define SPLIT_WATCHDOG_ENABLE\\n```\\n\\nThis will enable a software watchdog on any side delegated as slave and will reboot the keyboard if no successful communication occurs within `SPLIT_WATCHDOG_TIMEOUT`. This can be particularly helpful when `SPLIT_USB_DETECT` delegates both sides as slave in some circumstances.\\n\\n```\\n#define SPLIT_WATCHDOG_TIMEOUT 3000\\n```\\n\\nThis set the maximum slave timeout when waiting for communication from master when using `SPLIT_WATCHDOG_ENABLE`\"}, \"Hardware Considerations and Mods\": {\"Teensy boards\": \"Teensy boards lack VBUS detection out of the box and must have `SPLIT_USB_DETECT` defined. With the Teensy 2.0 and Teensy++ 2.0, there is a simple hardware mod that you can perform to add VBUS detection, so you don't need the `SPLIT_USB_DETECT` option.\\n\\nYou'll only need a few things:\\n\\n['A knife (x-acto knife, ideally)', 'A solder station or hot air station', 'An appropriate Schottky diode, such as the [PMEG2005EH](https://www.digikey.com/en/products/detail/nexperia-usa-inc/PMEG2005EH,115/1589924)']\\n\\nYou'll need to cut the small trace between the 5V and center pads on the back of the Teensy.\\n\\nOnce you have done that, you will want to solder the diode from the 5V pad to the center pad.\\n\\nYou may need to use the 5V pad from the regulator block above as the pads were too small and placed too closely together to place the Schottky diode properly.\\n\\n\"}, \"Additional Resources\": \"Nicinabox has a [very nice and detailed guide](https://github.com/nicinabox/lets-split-guide) for the Let's Split keyboard, that covers most everything you need to know, including troubleshooting information. \\n\\nHowever, the RGB Light section is out of date, as it was written long before the RGB Split code was added to QMK Firmware. Instead, wire each strip up directly to the controller.\\n\\n<!-- I may port this information later, but for now ... it's very nice, and covers everything -->\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 38]\"}, {\"title\": \"ST7565 LCD Driver\", \"description\": null, \"content\": {\"Supported Hardware\": \"LCD modules using ST7565 driver IC, communicating over SPI.\\n\\n|Module |IC |Size |Notes |\\n|------------------------------|-------|------|----------------------------------------------------------|\\n|Newhaven Display NHD-C12832A1Z|ST7565R|128x32|Used by Ergodox Infinity; primary consumer of this feature|\\n|Zolentech ZLE12864B |ST7565P|128x64|Requires contrast adjustment |\", \"Usage\": \"To enable the feature, there are three steps. First, when compiling your keyboard, you'll need to add the following to your `rules.mk`:\\n\\n```\\nST7565_ENABLE = yes\\n```\\n\\nThen in your `keymap.c` file, implement the ST7565 task call. This example assumes your keymap has three layers named `_QWERTY`, `_FN` and `_ADJ`:\\n\\n```\\n#ifdef ST7565_ENABLE\\nvoid st7565_task_user(void) {\\n // Host Keyboard Layer Status\\n st7565_write_P(PSTR(\\\"Layer: \\\"), false);\\n\\n switch (get_highest_layer(layer_state)) {\\n case _QWERTY:\\n st7565_write_P(PSTR(\\\"Default\\\\n\\\"), false);\\n break;\\n case _FN:\\n st7565_write_P(PSTR(\\\"FN\\\\n\\\"), false);\\n break;\\n case _ADJ:\\n st7565_write_P(PSTR(\\\"ADJ\\\\n\\\"), false);\\n break;\\n default:\\n // Or use the write_ln shortcut over adding '\\\\n' to the end of your string\\n st7565_write_ln_P(PSTR(\\\"Undefined\\\"), false);\\n }\\n\\n // Host Keyboard LED Status\\n led_t led_state = host_keyboard_led_state();\\n st7565_write_P(led_state.num_lock ? PSTR(\\\"NUM \\\") : PSTR(\\\" \\\"), false);\\n st7565_write_P(led_state.caps_lock ? PSTR(\\\"CAP \\\") : PSTR(\\\" \\\"), false);\\n st7565_write_P(led_state.scroll_lock ? PSTR(\\\"SCR \\\") : PSTR(\\\" \\\"), false);\\n}\\n#endif\\n```\", \"Logo Example\": \"In the default font, certain ranges of characters are reserved for a QMK logo. To render this logo to the screen, use the following code example:\\n\\n```\\nstatic void render_logo(void) {\\n static const char PROGMEM qmk_logo[] = {\\n 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90, 0x91, 0x92, 0x93, 0x94,\\n 0xA0, 0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8, 0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0, 0xB1, 0xB2, 0xB3, 0xB4,\\n 0xC0, 0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8, 0xC9, 0xCA, 0xCB, 0xCC, 0xCD, 0xCE, 0xCF, 0xD0, 0xD1, 0xD2, 0xD3, 0xD4, 0x00\\n };\\n\\n st7565_write_P(qmk_logo, false);\\n}\\n```\", \"Buffer Read Example\": \"For some purposes, you may need to read the current state of the display buffer. The `st7565_read_raw` function can be used to safely read bytes from the buffer.\\n\\nIn this example, calling `fade_display` in the `st7565_task_user` function will slowly fade away whatever is on the screen by turning random pixels off over time.\\n\\n```\\n//Setup some mask which can be or'd with bytes to turn off pixels\\nconst uint8_t single_bit_masks[8] = {127, 191, 223, 239, 247, 251, 253, 254};\\n\\nstatic void fade_display(void) {\\n //Define the reader structure\\n display_buffer_reader_t reader;\\n uint8_t buff_char;\\n if (random() % 30 == 0) {\\n srand(timer_read());\\n // Fetch a pointer for the buffer byte at index 0. The return structure\\n // will have the pointer and the number of bytes remaining from this\\n // index position if we want to perform a sequential read by\\n // incrementing the buffer pointer\\n reader = st7565_read_raw(0);\\n //Loop over the remaining buffer and erase pixels as we go\\n for (uint16_t i = 0; i < reader.remaining_element_count; i++) {\\n //Get the actual byte in the buffer by dereferencing the pointer\\n buff_char = *reader.current_element;\\n if (buff_char != 0) {\\n st7565_write_raw_byte(buff_char & single_bit_masks[rand() % 8], i);\\n }\\n //increment the pointer to fetch a new byte during the next loop\\n reader.current_element++;\\n }\\n }\\n}\\n```\", \"Other Examples\": \"In split keyboards, it is very common to have two displays that each render different content and are oriented or flipped differently. You can do this by switching which content to render by using the return value from `is_keyboard_master()` or `is_keyboard_left()` found in `split_util.h`, e.g:\\n\\n```\\n#ifdef ST7565_ENABLE\\ndisplay_rotation_t st7565_init_user(display_rotation_t rotation) {\\n if (!is_keyboard_master()) {\\n return DISPLAY_ROTATION_180; // flips the display 180 degrees if offhand\\n }\\n\\n return rotation;\\n}\\n\\nvoid st7565_task_user(void) {\\n if (is_keyboard_master()) {\\n render_status(); // Renders the current keyboard state (layer, lock, caps, scroll, etc)\\n } else {\\n render_logo(); // Renders a static logo\\n }\\n}\\n#endif\\n```\", \"Basic Configuration\": \"|Define |Default |Description |\\n|------------------------|--------------|-----------------------------------------------------------------------------------------------------|\\n|`ST7565_A0_PIN` |*Not defined* |(Required) The GPIO connected to the display's A0 (data/command) pin |\\n|`ST7565_RST_PIN` |*Not defined* |(Required) The GPIO connected to the display's reset pin |\\n|`ST7565_SS_PIN` |*Not defined* |(Required) The GPIO connected to the display's slave select pin |\\n|`ST7565_SPI_CLK_DIVISOR`|`4` |The SPI clock divisor to use |\\n|`ST7565_FONT_H` |`\\\"glcdfont.c\\\"`|The font code file to use for custom fonts |\\n|`ST7565_FONT_START` |`0` |The starting character index for custom fonts |\\n|`ST7565_FONT_END` |`223` |The ending character index for custom fonts |\\n|`ST7565_FONT_WIDTH` |`6` |The font width |\\n|`ST7565_FONT_HEIGHT` |`8` |The font height (untested) |\\n|`ST7565_TIMEOUT` |`60000` |Turns off the screen after 60000ms of keyboard inactivity. Helps reduce burn-in. Set to 0 to disable.|\\n|`ST7565_COLUMN_OFFSET` |`0` |Shift output to the right this many pixels. |\\n|`ST7565_CONTRAST` |`32` |The default contrast level of the display, from 0 to 255. |\\n|`ST7565_UPDATE_INTERVAL`|`0` |Set the time interval for updating the display in ms. This will improve the matrix scan rate. |\", \"Custom sized displays\": \"The default display size for this feature is 128x32 and all necessary defines are precalculated with that in mind.\\n\\n|Define |Default |Description |\\n|-----------------------|----------|-----------------------------------------------------------------------------------------------------------|\\n|`ST7565_DISPLAY_WIDTH` |`128` |The width of the display. |\\n|`ST7565_DISPLAY_HEIGHT`|`32` |The height of the display. |\\n|`ST7565_MATRIX_SIZE` |`512` |The local buffer size to allocate.<br>`(ST7565_DISPLAY_HEIGHT / 8 * ST7565_DISPLAY_WIDTH)`. |\\n|`ST7565_BLOCK_TYPE` |`uint16_t`|The unsigned integer type to use for dirty rendering. |\\n|`ST7565_BLOCK_COUNT` |`16` |The number of blocks the display is divided into for dirty rendering.<br>`(sizeof(ST7565_BLOCK_TYPE) * 8)`.|\\n|`ST7565_BLOCK_SIZE` |`32` |The size of each block for dirty rendering<br>`(ST7565_MATRIX_SIZE / ST7565_BLOCK_COUNT)`. |\", \"API\": \"```\\n// Rotation enum values are flags\\ntypedef enum {\\n DISPLAY_ROTATION_0,\\n DISPLAY_ROTATION_180\\n} display_rotation_t;\\n\\n// Initialize the display, rotating the rendered output based on the define passed in.\\n// Returns true if the was initialized successfully\\nbool st7565_init(display_rotation_t rotation);\\n\\n// Called at the start of st7565_init, weak function overridable by the user\\n// rotation - the value passed into st7565_init\\n// Return new display_rotation_t if you want to override default rotation\\ndisplay_rotation_t st7565_init_user(display_rotation_t rotation);\\n\\n// Clears the display buffer, resets cursor position to 0, and sets the buffer to dirty for rendering\\nvoid st7565_clear(void);\\n\\n// Renders the dirty chunks of the buffer to display\\nvoid st7565_render(void);\\n\\n// Moves cursor to character position indicated by column and line, wraps if out of bounds\\n// Max column denoted by 'st7565_max_chars()' and max lines by 'st7565_max_lines()' functions\\nvoid st7565_set_cursor(uint8_t col, uint8_t line);\\n\\n// Advances the cursor to the next page, writing ' ' if true\\n// Wraps to the begining when out of bounds\\nvoid st7565_advance_page(bool clearPageRemainder);\\n\\n// Moves the cursor forward 1 character length\\n// Advance page if there is not enough room for the next character\\n// Wraps to the begining when out of bounds\\nvoid st7565_advance_char(void);\\n\\n// Writes a single character to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Main handler that writes character data to the display buffer\\nvoid st7565_write_char(const char data, bool invert);\\n\\n// Writes a string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\nvoid st7565_write(const char *data, bool invert);\\n\\n// Writes a string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Advances the cursor to the next page, wiring ' ' to the remainder of the current page\\nvoid st7565_write_ln(const char *data, bool invert);\\n\\n// Pans the buffer to the right (or left by passing true) by moving contents of the buffer\\n// Useful for moving the screen in preparation for new drawing\\nvoid st7565_pan(bool left);\\n\\n// Returns a pointer to the requested start index in the buffer plus remaining\\n// buffer length as struct\\ndisplay_buffer_reader_t st7565_read_raw(uint16_t start_index);\\n\\n// Writes a string to the buffer at current cursor position\\nvoid st7565_write_raw(const char *data, uint16_t size);\\n\\n// Writes a single byte into the buffer at the specified index\\nvoid st7565_write_raw_byte(const char data, uint16_t index);\\n\\n// Sets a specific pixel on or off\\n// Coordinates start at top-left and go right and down for positive x and y\\nvoid st7565_write_pixel(uint8_t x, uint8_t y, bool on);\\n\\n// Writes a PROGMEM string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Remapped to call 'void st7565_write(const char *data, bool invert);' on ARM\\nvoid st7565_write_P(const char *data, bool invert);\\n\\n// Writes a PROGMEM string to the buffer at current cursor position\\n// Advances the cursor while writing, inverts the pixels if true\\n// Advances the cursor to the next page, wiring ' ' to the remainder of the current page\\n// Remapped to call 'void st7565_write_ln(const char *data, bool invert);' on ARM\\nvoid st7565_write_ln_P(const char *data, bool invert);\\n\\n// Writes a PROGMEM string to the buffer at current cursor position\\nvoid st7565_write_raw_P(const char *data, uint16_t size);\\n\\n// Can be used to manually turn on the screen if it is off\\n// Returns true if the screen was on or turns on\\nbool st7565_on(void);\\n\\n// Called when st7565_on() turns on the screen, weak function overridable by the user\\n// Not called if the screen is already on\\nvoid st7565_on_user(void);\\n\\n// Can be used to manually turn off the screen if it is on\\n// Returns true if the screen was off or turns off\\nbool st7565_off(void);\\n\\n// Called when st7565_off() turns off the screen, weak function overridable by the user\\n// Not called if the screen is already off\\nvoid st7565_off_user(void);\\n\\n// Returns true if the screen is currently on, false if it is\\n// not\\nbool st7565_is_on(void);\\n\\n// Basically it's st7565_render, but with timeout management and st7565_task_user calling!\\nvoid st7565_task(void);\\n\\n// Called at the start of st7565_task, weak function overridable by the user\\nvoid st7565_task_user(void);\\n\\n// Inverts the display\\n// Returns true if the screen was or is inverted\\nbool st7565_invert(bool invert);\\n\\n// Returns the maximum number of characters that will fit on a line\\nuint8_t st7565_max_chars(void);\\n\\n// Returns the maximum number of lines that will fit on the display\\nuint8_t st7565_max_lines(void);\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 39]\"}, {\"title\": \"Stenography in QMK {#stenography-in-qmk}\", \"description\": null, \"content\": {\"Steno Support in QMK\": \"There are three ways that QMK keyboards can support steno, with varying degrees of configuration required:\\n\\n['Plover with [Arpeggiation](https://plover.wiki/index.php/Glossary#Arpeggiate) requires no changes to any keyboard and is supported by QMK as well as any other QWERTY keyboard.', 'Plover with [NKRO](https://plover.wiki/index.php/Using_a_standard_keyboard_with_Plover#NKRO). If your keyboard supports NKRO in hardware and you have NKRO enabled as a USB endpoint, you can chord with the keyboard. Many devices will arrive stock like this and will require no changes.', 'Steno Machine Protocols. This requires the most configuration, but this has the advantage of allowing you to use your keyboard keys normally (either on another layer or another piece of hardware) without enabling and disabling your steno software.']\", \"Plover with QWERTY Keyboard {#plover-with-qwerty-keyboard}\": \"Plover can work with any standard QWERTY keyboard, although it is more efficient if the keyboard supports NKRO (n-key rollover) to allow Plover to see all the pressed keys at once. An example keymap for Plover can be found in `planck/keymaps/default`. Switching to the `PLOVER` layer adjusts the position of the keyboard to support the number bar.\\n\\nTo enable NKRO, add `NKRO_ENABLE = yes` in your `rules.mk` and make sure to press `NK_ON` to turn it on because `NKRO_ENABLE = yes` merely adds the possibility of switching to NKRO mode but it doesn't automatically switch to it. If you want to automatically switch, add `#define NKRO_DEFAULT_ON true` in your `config.h`.\\n\\nYou may also need to adjust your layout, either in QMK or in Plover, if you have anything other than a standard layout. You may also want to purchase some steno-friendly keycaps to make it easier to hit multiple keys.\", \"Plover with Steno Protocol {#plover-with-steno-protocol}\": {\"TX Bolt {#tx-bolt}\": \"TX Bolt communicates the status of 24 keys over a simple protocol in variable-sized (1–4 bytes) packets.\\n\\nTo select TX Bolt, add the following lines to your `rules.mk`:\\n\\n```\\nSTENO_ENABLE = yes\\nSTENO_PROTOCOL = txbolt\\n```\\n\\nEach byte of the packet represents a different group of steno keys. Determining the group of a certain byte of the packet is done by checking the first two bits, the remaining bits are set if the corresponding steno key was pressed for the stroke. The last set of keys (as indicated by leading `11`) needs to keep track of less keys than there are bits so one of the bits is constantly 0.\\n\\nThe start of a new packet can be detected by comparing the group \\u201cID\\u201d (the two MSBs) of the current byte to that of the previously received byte. If the group \\u201cID\\u201d of the current byte is smaller or equal to that of the previous byte, it means that the current byte is the beginning of a new packet.\\n\\nThe format of TX Bolt packets is shown below.\\n\\n```\\n00HWPKTS 01UE*OAR 10GLBPRF 110#ZDST\\n```\\n\\nExamples of steno strokes and the associated packet:\\n\\n['`EUBG` = `01110000 10101000`', '`WAZ` = `00010000 01000010 11001000`', '`PHAPBGS` = `00101000 01000010 10101100 11000010`']\", \"GeminiPR {#geminipr}\": \"GeminiPR encodes 42 keys into a 6-byte packet. While TX Bolt contains everything that is necessary for standard stenography, GeminiPR opens up many more options, including differentiating between top and bottom `S-`, and supporting non-English theories.\\n\\nTo select GeminiPR, add the following lines to your `rules.mk`:\\n\\n```\\nSTENO_ENABLE = yes\\nSTENO_PROTOCOL = geminipr\\n```\\n\\nAll packets in the GeminiPR protocol consist of exactly six bytes, used as bit-arrays for different groups of keys. The beginning of a packet is indicated by setting the most significant bit (MSB) to 1 while setting the MSB of the remaining five bytes to 0.\\n\\nThe format of GeminiPR packets is shown below.\\n\\n```\\n1 Fn #1 #2 #3 #4 #5 #6\\n0 S1- S2- T- K- P- W- H-\\n0 R- A- O- *1 *2 res1 res2\\n0 pwr *3 *4 -E -U -F -R\\n0 -P -B -L -G -T -S -D\\n0 #7 #8 #9 #A #B #C -Z\\n```\\n\\nExamples of steno strokes and the associated packet:\\n\\n['`EUBG` = `10000000 00000000 00000000 00001100 00101000 00000000`', '`WAZ` = `10000000 00000010 00100000 00000000 00000000 00000001`', '`PHAPBGS` = `10000000 00000101 00100000 00000000 01101010 00000000`']\", \"Switching protocols on the fly {#switching-protocols-on-the-fly}\": \"If you wish to switch the serial protocol used to transfer the steno chords without having to recompile your keyboard firmware every time, you can press the `QK_STENO_BOLT` and `QK_STENO_GEMINI` keycodes in order to switch protocols on the fly.\\n\\nTo enable these special keycodes, add the following lines to your `rules.mk`:\\n\\n```\\nSTENO_ENABLE = yes\\nSTENO_PROTOCOL = all\\n```\\n\\nIf you want to switch protocols programatically, as part of a custom macro for example, don't use `tap_code(QK_STENO_*)`, as `tap_code` only supports [basic keycodes](../keycodes_basic). Instead, you should use `steno_set_mode(STENO_MODE_*)`, whose valid arguments are `STENO_MODE_BOLT` and `STENO_MODE_GEMINI`.\\n\\nThe default protocol is Gemini PR but the last protocol used is stored in non-volatile memory so QMK will remember your choice between reboots of your keyboard — assuming that your keyboard features (emulated) EEPROM.\\n\\nNaturally, this option takes the most amount of firmware space as it needs to compile the code for all the available stenography protocols. In most cases, compiling a single stenography protocol is sufficient.\\n\\nThe default value for `STENO_PROTOCOL` is `all`.\"}, \"Configuring QMK for Steno {#configuring-qmk-for-steno}\": \"After enabling stenography and optionally selecting a protocol, you may also need disable mouse keys, extra keys, or another USB endpoint to prevent conflicts. The builtin USB stack for some processors only supports a certain number of USB endpoints and the virtual serial port needed for steno fills 3 of them.\\n\\n::: warning\\nIf you had *explicitly* set `VIRSTER_ENABLE = no`, none of the serial stenography protocols (GeminiPR, TX Bolt) will work properly. You are expected to either set it to `yes`, remove the line from your `rules.mk` or send the steno chords yourself in an alternative way using the [provided interceptable hooks](#interfacing-with-the-code).\\n:::\\n\\nIn your keymap, create a new layer for Plover, that you can fill in with the [steno keycodes](#keycode-reference). Remember to create a key to switch to the layer as well as a key for exiting the layer.\\n\\nOnce you have your keyboard flashed, launch Plover. Click the 'Configure...' button. In the 'Machine' tab, select the Stenotype Machine that corresponds to your desired protocol. Click the 'Configure...' button on this tab and enter the serial port or click 'Scan'. Baud rate is fine at 9600 (although you should be able to set as high as 115200 with no issues). Use the default settings for everything else (Data Bits: 8, Stop Bits: 1, Parity: N, no flow control).\\n\\nTo test your keymap, you can chord keys on your keyboard and either look at the output of the 'paper tape' (Tools > Paper Tape) or that of the 'layout display' (Tools > Layout Display). If your strokes correctly show up, you are now ready to steno!\", \"Learning Stenography {#learning-stenography}\": [\"[Learn Plover!](https://sites.google.com/site/learnplover/)\", \"[Steno Jig](https://joshuagrams.github.io/steno-jig/)\", \"More resources at the Plover [Learning Stenography](https://github.com/openstenoproject/plover/wiki/Learning-Stenography) wiki\"], \"Interfacing with the code {#interfacing-with-the-code}\": \"The steno code has three interceptable hooks. If you define these functions, they will be called at certain points in processing; if they return true, processing continues, otherwise it's assumed you handled things.\\n\\n```\\nbool send_steno_chord_user(steno_mode_t mode, uint8_t chord[MAX_STROKE_SIZE]);\\n```\\n\\nThis function is called when a chord is about to be sent. Mode will be one of `STENO_MODE_BOLT` or `STENO_MODE_GEMINI`. This represents the actual chord that would be sent via whichever protocol. You can modify the chord provided to alter what gets sent. Remember to return true if you want the regular sending process to happen.\\n\\n```\\nbool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }\\n```\\n\\nThis function is called when a keypress has come in, before it is processed. The keycode should be one of `QK_STENO_BOLT`, `QK_STENO_GEMINI`, or one of the `STN_*` key values.\\n\\n```\\nbool post_process_steno_user(uint16_t keycode, keyrecord_t *record, steno_mode_t mode, uint8_t chord[MAX_STROKE_SIZE], int8_t n_pressed_keys);\\n```\\n\\nThis function is called after a key has been processed, but before any decision about whether or not to send a chord. This is where to put hooks for things like, say, live displays of steno chords or keys.\\n\\nIf `record->event.pressed` is false, and `n_pressed_keys` is 0 or 1, the chord will be sent shortly, but has not yet been sent. This relieves you of the need of keeping track of where a packet ends and another begins.\\n\\nThe `chord` argument contains the packet of the current chord as specified by the protocol in use. This is *NOT* simply a list of chorded steno keys of the form `[STN_E, STN_U, STN_BR, STN_GR]`. Refer to the appropriate protocol section of this document to learn more about the format of the packets in your steno protocol/mode of choice.\\n\\nThe `n_pressed_keys` argument is the number of physical keys actually being held down.\\nThis is not always equal to the number of bits set to 1 (aka the [Hamming weight](https://en.wikipedia.org/wiki/Hamming_weight)) in `chord` because it is possible to simultaneously press down four keys, then release three of those four keys and then press yet another key while the fourth finger is still holding down its key.\\nAt the end of this scenario given as an example, `chord` would have five bits set to 1 but\\n`n_pressed_keys` would be set to 2 because there are only two keys currently being pressed down.\", \"Keycode Reference {#keycode-reference}\": \"::: info\\nTX Bolt does not support the full set of keys. The TX Bolt implementation in QMK will map the GeminiPR keys to the nearest TX Bolt key so that one key map will work for both.\\n:::\\n\\n|GeminiPR|TX Bolt|Steno Key|\\n|--------|-------|-----------|\\n|`STN_N1`|`STN_NUM`|Number bar #1|\\n|`STN_N2`|`STN_NUM`|Number bar #2|\\n|`STN_N3`|`STN_NUM`|Number bar #3|\\n|`STN_N4`|`STN_NUM`|Number bar #4|\\n|`STN_N5`|`STN_NUM`|Number bar #5|\\n|`STN_N6`|`STN_NUM`|Number bar #6|\\n|`STN_N7`|`STN_NUM`|Number bar #7|\\n|`STN_N8`|`STN_NUM`|Number bar #8|\\n|`STN_N9`|`STN_NUM`|Number bar #9|\\n|`STN_NA`|`STN_NUM`|Number bar #A|\\n|`STN_NB`|`STN_NUM`|Number bar #B|\\n|`STN_NC`|`STN_NUM`|Number bar #C|\\n|`STN_S1`|`STN_SL`| `S-` upper|\\n|`STN_S2`|`STN_SL`| `S-` lower|\\n|`STN_TL`|`STN_TL`| `T-`|\\n|`STN_KL`|`STN_KL`| `K-`|\\n|`STN_PL`|`STN_PL`| `P-`|\\n|`STN_WL`|`STN_WL`| `W-`|\\n|`STN_HL`|`STN_HL`| `H-`|\\n|`STN_RL`|`STN_RL`| `R-`|\\n|`STN_A`|`STN_A`| `A` vowel|\\n|`STN_O`|`STN_O`| `O` vowel|\\n|`STN_ST1`|`STN_STR`| `*` upper-left |\\n|`STN_ST2`|`STN_STR`| `*` lower-left|\\n|`STN_ST3`|`STN_STR`| `*` upper-right|\\n|`STN_ST4`|`STN_STR`| `*` lower-right|\\n|`STN_E`|`STN_E`| `E` vowel|\\n|`STN_U`|`STN_U`| `U` vowel|\\n|`STN_FR`|`STN_FR`| `-F`|\\n|`STN_RR`|`STN_RR`| `-R`|\\n|`STN_PR`|`STN_PR`| `-P`|\\n|`STN_BR`|`STN_BR`| `-B`|\\n|`STN_LR`|`STN_LR`| `-L`|\\n|`STN_GR`|`STN_GR`| `-G`|\\n|`STN_TR`|`STN_TR`| `-T`|\\n|`STN_SR`|`STN_SR`| `-S`|\\n|`STN_DR`|`STN_DR`| `-D`|\\n|`STN_ZR`|`STN_ZR`| `-Z`|\\n|`STN_FN`|| (Function)|\\n|`STN_RES1`||(Reset 1)|\\n|`STN_RES2`||(Reset 2)|\\n|`STN_PWR`||(Power)|\\n\\nIf you do not want to hit two keys with one finger combined keycodes can be used. These cause both keys to be reported as pressed or released. To use these keycodes define `STENO_COMBINEDMAP` in your `config.h` file.\\n\\n|Combined key | Key1 | Key 2 |\\n|---------------|--------|----------|\\n|STN_S3 | STN_S1 | STN_S2 |\\n|STN_TKL | STN_TL | STN_KL |\\n|STN_PWL | STN_PL | STN_WL |\\n|STN_HRL | STN_HL | STN_RL |\\n|STN_FRR | STN_FR | STN_RR |\\n|STN_PBR | STN_PR | STN_BR |\\n|STN_LGR | STN_LR | STN_GR |\\n|STN_TSR | STN_TR | STN_SR |\\n|STN_DZR | STN_DR | STN_ZR |\\n|STN_AO | STN_A | STN_O |\\n|STN_EU | STN_E | STN_U |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 40]\"}, {\"title\": \"Swap-Hands Action\", \"description\": null, \"content\": {\"Configuration\": \"The configuration table is a simple 2-dimensional array to map from column/row to new column/row. Example `hand_swap_config` for Planck:\\n\\n```\\nconst keypos_t PROGMEM hand_swap_config[MATRIX_ROWS][MATRIX_COLS] = {\\n {{11, 0}, {10, 0}, {9, 0}, {8, 0}, {7, 0}, {6, 0}, {5, 0}, {4, 0}, {3, 0}, {2, 0}, {1, 0}, {0, 0}},\\n {{11, 1}, {10, 1}, {9, 1}, {8, 1}, {7, 1}, {6, 1}, {5, 1}, {4, 1}, {3, 1}, {2, 1}, {1, 1}, {0, 1}},\\n {{11, 2}, {10, 2}, {9, 2}, {8, 2}, {7, 2}, {6, 2}, {5, 2}, {4, 2}, {3, 2}, {2, 2}, {1, 2}, {0, 2}},\\n {{11, 3}, {10, 3}, {9, 3}, {8, 3}, {7, 3}, {6, 3}, {5, 3}, {4, 3}, {3, 3}, {2, 3}, {1, 3}, {0, 3}},\\n};\\n```\\n\\nNote that the array indices are reversed same as the matrix and the values are of type `keypos_t` which is `{col, row}` and all values are zero-based. In the example above, `hand_swap_config[2][4]` (third row, fifth column) would return `{7, 2}` (third row, eighth column). Yes, this is confusing.\", \"Swap Keycodes\": \"|Key |Aliases |Description |\\n|-----------------------------|---------|----------------------------------------------------|\\n|`SH_T(kc)` | |Momentary swap when held, `kc` when tapped |\\n|`QK_SWAP_HANDS_ON` |`SH_ON` |Turn on hand swap |\\n|`QK_SWAP_HANDS_OFF` |`SH_OFF` |Turn off hand swap |\\n|`QK_SWAP_HANDS_MOMENTARY_ON` |`SH_MON` |Turn on hand swap while held |\\n|`QK_SWAP_HANDS_MOMENTARY_OFF`|`SH_MOFF`|Turn off hand swap while held |\\n|`QK_SWAP_HANDS_TOGGLE` |`SH_TOGG`|Toggle hand swap |\\n|`QK_SWAP_HANDS_TAP_TOGGLE` |`SH_TT` |Momentary swap when held, toggle when tapped |\\n|`QK_SWAP_HANDS_ONE_SHOT` |`SH_OS` |Turn on hand swap while held or until next key press|\\n\\n`SH_TT` swap-hands tap-toggle key is similar to [layer tap-toggle](../feature_layers#switching-and-toggling-layers). Tapping repeatedly (5 taps by default) will toggle swap-hands on or off, like `SH_TOGG`. Tap-toggle count can be changed by defining a value for `TAPPING_TOGGLE`.\", \"Encoder Mapping\": {\"Functions {#functions}\": \"User callback functions to manipulate Swap-Hands:\\n\\n| Function | Description |\\n|-----------------------|---------------------------------------------|\\n| `swap_hands_on()` | Turns Swap-Hands on. |\\n| `swap_hands_off()` | Turns Swap-Hands off. |\\n| `swap_hands_toggle()` | Toggles Swap-Hands. |\\n| `is_swap_hands_on()` | Returns true if Swap-Hands is currently on. |\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 41]\"}, {\"title\": \"Tap Dance: A Single Key Can Do 3, 5, or 100 Different Things\", \"description\": null, \"content\": {\"Introduction {#introduction}\": \"Hit the semicolon key once, send a semicolon. Hit it twice, rapidly -- send a colon. Hit it three times, and your keyboard's LEDs do a wild dance. That's just one example of what Tap Dance can do. It's one of the nicest community-contributed features in the firmware, conceived and created by [algernon](https://github.com/algernon) in [#451](https://github.com/qmk/qmk_firmware/pull/451). Here's how algernon describes the feature:\\n\\nWith this feature one can specify keys that behave differently, based on the amount of times they have been tapped, and when interrupted, they get handled before the interrupter.\", \"How to Use Tap Dance {#how-to-use}\": \"First, you will need `TAP_DANCE_ENABLE = yes` in your `rules.mk`, because the feature is disabled by default. This adds a little less than 1k to the firmware size. \\n\\nOptionally, you might want to set a custom `TAPPING_TERM` time by adding something like this in your `config.h` file:\\n\\n```\\n#define TAPPING_TERM 175\\n#define TAPPING_TERM_PER_KEY\\n```\\n\\nThe `TAPPING_TERM` time is the maximum time allowed between taps of your Tap Dance key, and is measured in milliseconds. For example, if you used the above `#define` statement and set up a Tap Dance key that sends `Space` on single-tap and `Enter` on double-tap, then this key will send `ENT` only if you tap this key twice in less than 175ms. If you tap the key, wait more than 175ms, and tap the key again you'll end up sending `SPC SPC` instead. The `TAPPING_TERM_PER_KEY` definition is only needed if you control the tapping term through a [custom `get_tapping_term` function](../tap_hold#tapping_term), which may be needed because `TAPPING_TERM` affects not just tap-dance keys.\\n\\nNext, you will want to define some tap-dance keys, which is easiest to do with the `TD()` macro. That macro takes a number which will later be used as an index into the `tap_dance_actions` array and turns it into a tap-dance keycode.\\n\\nAfter this, you'll want to use the `tap_dance_actions` array to specify what actions shall be taken when a tap-dance key is in action. Currently, there are five possible options:\\n\\n['`ACTION_TAP_DANCE_DOUBLE(kc1, kc2)`: Sends the `kc1` keycode when tapped once, `kc2` otherwise. When the key is held, the appropriate keycode is registered: `kc1` when pressed and held, `kc2` when tapped once, then pressed and held.', '`ACTION_TAP_DANCE_LAYER_MOVE(kc, layer)`: Sends the `kc` keycode when tapped once, or moves to `layer`. (this functions like the `TO` layer keycode).', '`ACTION_TAP_DANCE_LAYER_TOGGLE(kc, layer)`: Sends the `kc` keycode when tapped once, or toggles the state of `layer`. (this functions like the `TG` layer keycode).', '`ACTION_TAP_DANCE_FN(fn)`: Calls the specified function - defined in the user keymap - with the final tap count of the tap dance action.', '`ACTION_TAP_DANCE_FN_ADVANCED(on_each_tap_fn, on_dance_finished_fn, on_dance_reset_fn)`: Calls the first specified function - defined in the user keymap - on every tap, the second function when the dance action finishes (like the previous option), and the last function when the tap dance action resets.', '`ACTION_TAP_DANCE_FN_ADVANCED_WITH_RELEASE(on_each_tap_fn, on_each_release_fn, on_dance_finished_fn, on_dance_reset_fn)`: This macro is identical to `ACTION_TAP_DANCE_FN_ADVANCED` with the addition of `on_each_release_fn` which is invoked every time the key for the tap dance is released. It is worth noting that `on_each_release_fn` will still be called even when the key is released after the dance finishes (e.g. if the key is released after being pressed and held for longer than the `TAPPING_TERM`).']\\n\\nThe first option is enough for a lot of cases, that just want dual roles. For example, `ACTION_TAP_DANCE_DOUBLE(KC_SPC, KC_ENT)` will result in `Space` being sent on single-tap, `Enter` otherwise. \\n\\n::: warning\\nKeep in mind that only [basic keycodes](../keycodes_basic) are supported here. Custom keycodes are not supported.\\n:::\\n\\nSimilar to the first option, the second and third option are good for simple layer-switching cases.\\n\\nFor more complicated cases, like blink the LEDs, fiddle with the backlighting, and so on, use the fourth or fifth option. Examples of each are listed below.\", \"Implementation Details {#implementation}\": \"Well, that's the bulk of it! You should now be able to work through the examples below, and to develop your own Tap Dance functionality. But if you want a deeper understanding of what's going on behind the scenes, then read on for the explanation of how it all works!\\n\\nLet's go over the three functions mentioned in `ACTION_TAP_DANCE_FN_ADVANCED` in a little more detail. They all receive the same two arguments: a pointer to a structure that holds all dance related state information, and a pointer to a use case specific state variable. The three functions differ in when they are called. The first, `on_each_tap_fn()`, is called every time the tap dance key is *pressed*. Before it is called, the counter is incremented and the timer is reset. The second function, `on_dance_finished_fn()`, is called when the tap dance is interrupted or ends because `TAPPING_TERM` milliseconds have passed since the last tap. When the `finished` field of the dance state structure is set to `true`, the `on_dance_finished_fn()` is skipped. After `on_dance_finished_fn()` was called or would have been called, but no sooner than when the tap dance key is *released*, `on_dance_reset_fn()` is called. It is possible to end a tap dance immediately, skipping `on_dance_finished_fn()`, but not `on_dance_reset_fn`, by calling `reset_tap_dance(state)`.\\n\\nTo accomplish this logic, the tap dance mechanics use three entry points. The main entry point is `process_tap_dance()`, called from `process_record_quantum()` *after* `process_record_kb()` and `process_record_user()`. This function is responsible for calling `on_each_tap_fn()` and `on_dance_reset_fn()`. In order to handle interruptions of a tap dance, another entry point, `preprocess_tap_dance()` is run right at the beginning of `process_record_quantum()`. This function checks whether the key pressed is a tap-dance key. If it is not, and a tap-dance was in action, we handle that first, and enqueue the newly pressed key. If it is a tap-dance key, then we check if it is the same as the already active one (if there's one active, that is). If it is not, we fire off the old one first, then register the new one. Finally, `tap_dance_task()` periodically checks whether `TAPPING_TERM` has passed since the last key press and finishes a tap dance if that is the case.\\n\\nThis means that you have `TAPPING_TERM` time to tap the key again; you do not have to input all the taps within a single `TAPPING_TERM` timeframe. This allows for longer tap counts, with minimal impact on responsiveness.\", \"Examples {#examples}\": {\"Simple Example: Send `ESC` on Single Tap, `CAPS_LOCK` on Double Tap {#simple-example}\": \"Here's a simple example for a single definition:\\n\\n['In your `rules.mk`, add `TAP_DANCE_ENABLE = yes`', 'In your `keymap.c` file, define the variables and definitions, then add to your keymap:']\\n\\n```\\n// Tap Dance declarations\\nenum {\\n TD_ESC_CAPS,\\n};\\n\\n// Tap Dance definitions\\ntap_dance_action_t tap_dance_actions[] = {\\n // Tap once for Escape, twice for Caps Lock\\n [TD_ESC_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),\\n};\\n\\n// Add tap dance item to your keymap in place of a keycode\\nconst uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {\\n // ...\\n TD(TD_ESC_CAPS)\\n // ...\\n};\\n```\", \"Complex Examples {#complex-examples}\": {\"Example 1: Send \\\"Safety Dance!\\\" After 100 Taps {#example-1}\": \"```\\nvoid dance_egg(tap_dance_state_t *state, void *user_data) {\\n if (state->count >= 100) {\\n SEND_STRING(\\\"Safety dance!\\\");\\n reset_tap_dance(state);\\n }\\n}\\n\\ntap_dance_action_t tap_dance_actions[] = {\\n [CT_EGG] = ACTION_TAP_DANCE_FN(dance_egg),\\n};\\n```\", \"Example 2: Turn LED Lights On Then Off, One at a Time {#example-2}\": \"```\\n// On each tap, light up one LED, from right to left\\n// On the fourth tap, turn them off from right to left\\nvoid dance_flsh_each(tap_dance_state_t *state, void *user_data) {\\n switch (state->count) {\\n case 1:\\n ergodox_right_led_3_on();\\n break;\\n case 2:\\n ergodox_right_led_2_on();\\n break;\\n case 3:\\n ergodox_right_led_1_on();\\n break;\\n case 4:\\n ergodox_right_led_3_off();\\n wait_ms(50);\\n ergodox_right_led_2_off();\\n wait_ms(50);\\n ergodox_right_led_1_off();\\n }\\n}\\n\\n// On the fourth tap, set the keyboard on flash state\\nvoid dance_flsh_finished(tap_dance_state_t *state, void *user_data) {\\n if (state->count >= 4) {\\n reset_keyboard();\\n }\\n}\\n\\n// If the flash state didn't happen, then turn off LEDs, left to right\\nvoid dance_flsh_reset(tap_dance_state_t *state, void *user_data) {\\n ergodox_right_led_1_off();\\n wait_ms(50);\\n ergodox_right_led_2_off();\\n wait_ms(50);\\n ergodox_right_led_3_off();\\n}\\n\\n// All tap dances now put together. Example 2 is \\\"CT_FLSH\\\"\\ntap_dance_action_t tap_dance_actions[] = {\\n [TD_ESC_CAPS] = ACTION_TAP_DANCE_DOUBLE(KC_ESC, KC_CAPS),\\n [CT_EGG] = ACTION_TAP_DANCE_FN(dance_egg),\\n [CT_FLSH] = ACTION_TAP_DANCE_FN_ADVANCED(dance_flsh_each, dance_flsh_finished, dance_flsh_reset)\\n};\\n```\", \"Example 3: Send `:` on Tap, `;` on Hold {#example-3}\": \"With a little effort, powerful tap-hold configurations can be implemented as tap dances. To emit taps as early as possible, we need to act on releases of the tap dance key. There is no callback for this in the tap dance framework, so we use `process_record_user()`.\\n\\n```\\ntypedef struct {\\n uint16_t tap;\\n uint16_t hold;\\n uint16_t held;\\n} tap_dance_tap_hold_t;\\n\\nvoid tap_dance_tap_hold_finished(tap_dance_state_t *state, void *user_data) {\\n tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)user_data;\\n\\n if (state->pressed) {\\n if (state->count == 1\\n#ifndef PERMISSIVE_HOLD\\n && !state->interrupted\\n#endif\\n ) {\\n register_code16(tap_hold->hold);\\n tap_hold->held = tap_hold->hold;\\n } else {\\n register_code16(tap_hold->tap);\\n tap_hold->held = tap_hold->tap;\\n }\\n }\\n}\\n\\nvoid tap_dance_tap_hold_reset(tap_dance_state_t *state, void *user_data) {\\n tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)user_data;\\n\\n if (tap_hold->held) {\\n unregister_code16(tap_hold->held);\\n tap_hold->held = 0;\\n }\\n}\\n\\n#define ACTION_TAP_DANCE_TAP_HOLD(tap, hold) \\\\\\n { \\\\\\n .fn = {NULL, tap_dance_tap_hold_finished, tap_dance_tap_hold_reset}, \\\\\\n .user_data = (void *)&((tap_dance_tap_hold_t){tap, hold, 0}), \\\\\\n }\\n\\ntap_dance_action_t tap_dance_actions[] = {\\n [CT_CLN] = ACTION_TAP_DANCE_TAP_HOLD(KC_COLN, KC_SCLN),\\n};\\n\\nbool process_record_user(uint16_t keycode, keyrecord_t *record) {\\n tap_dance_action_t *action;\\n\\n switch (keycode) {\\n case TD(CT_CLN): // list all tap dance keycodes with tap-hold configurations\\n action = &tap_dance_actions[QK_TAP_DANCE_GET_INDEX(keycode)];\\n if (!record->event.pressed && action->state.count && !action->state.finished) {\\n tap_dance_tap_hold_t *tap_hold = (tap_dance_tap_hold_t *)action->user_data;\\n tap_code16(tap_hold->tap);\\n }\\n }\\n return true;\\n}\\n```\", \"Example 4: 'Quad Function Tap-Dance' {#example-4}\": \"By [DanielGGordon](https://github.com/danielggordon)\\n\\nAllow one key to have 4 (or more) functions, depending on number of presses, and if the key is held or tapped.\\nBelow is a specific example:\\n\\n['Tap = Send `x`', 'Hold = Send `Control`', 'Double Tap = Send `Escape`', 'Double Tap and Hold = Send `Alt`']\\n\\nYou will need a few things that can be used for 'Quad Function Tap-Dance'. \\n\\nYou'll need to add these to the top of your `keymap.c` file, before your keymap. \\n\\n```\\ntypedef enum {\\n TD_NONE,\\n TD_UNKNOWN,\\n TD_SINGLE_TAP,\\n TD_SINGLE_HOLD,\\n TD_DOUBLE_TAP,\\n TD_DOUBLE_HOLD,\\n TD_DOUBLE_SINGLE_TAP, // Send two single taps\\n TD_TRIPLE_TAP,\\n TD_TRIPLE_HOLD\\n} td_state_t;\\n\\ntypedef struct {\\n bool is_press_action;\\n td_state_t state;\\n} td_tap_t;\\n\\n// Tap dance enums\\nenum {\\n X_CTL,\\n SOME_OTHER_DANCE\\n};\\n\\ntd_state_t cur_dance(tap_dance_state_t *state);\\n\\n// For the x tap dance. Put it here so it can be used in any keymap\\nvoid x_finished(tap_dance_state_t *state, void *user_data);\\nvoid x_reset(tap_dance_state_t *state, void *user_data);\\n```\\n\\nNow, at the bottom of your `keymap.c` file, you'll need to add the following: \\n\\n```\\n/* Return an integer that corresponds to what kind of tap dance should be executed.\\n *\\n * How to figure out tap dance state: interrupted and pressed.\\n *\\n * Interrupted: If the state of a dance is \\\"interrupted\\\", that means that another key has been hit\\n * under the tapping term. This is typically indicative that you are trying to \\\"tap\\\" the key.\\n *\\n * Pressed: Whether or not the key is still being pressed. If this value is true, that means the tapping term\\n * has ended, but the key is still being pressed down. This generally means the key is being \\\"held\\\".\\n *\\n * One thing that is currently not possible with qmk software in regards to tap dance is to mimic the \\\"permissive hold\\\"\\n * feature. In general, advanced tap dances do not work well if they are used with commonly typed letters.\\n * For example \\\"A\\\". Tap dances are best used on non-letter keys that are not hit while typing letters.\\n *\\n * Good places to put an advanced tap dance:\\n * z,q,x,j,k,v,b, any function key, home/end, comma, semi-colon\\n *\\n * Criteria for \\\"good placement\\\" of a tap dance key:\\n * Not a key that is hit frequently in a sentence\\n * Not a key that is used frequently to double tap, for example 'tab' is often double tapped in a terminal, or\\n * in a web form. So 'tab' would be a poor choice for a tap dance.\\n * Letters used in common words as a double. For example 'p' in 'pepper'. If a tap dance function existed on the\\n * letter 'p', the word 'pepper' would be quite frustrating to type.\\n *\\n * For the third point, there does exist the 'TD_DOUBLE_SINGLE_TAP', however this is not fully tested\\n *\\n */\\ntd_state_t cur_dance(tap_dance_state_t *state) {\\n if (state->count == 1) {\\n if (state->interrupted || !state->pressed) return TD_SINGLE_TAP;\\n // Key has not been interrupted, but the key is still held. Means you want to send a 'HOLD'.\\n else return TD_SINGLE_HOLD;\\n } else if (state->count == 2) {\\n // TD_DOUBLE_SINGLE_TAP is to distinguish between typing \\\"pepper\\\", and actually wanting a double tap\\n // action when hitting 'pp'. Suggested use case for this return value is when you want to send two\\n // keystrokes of the key, and not the 'double tap' action/macro.\\n if (state->interrupted) return TD_DOUBLE_SINGLE_TAP;\\n else if (state->pressed) return TD_DOUBLE_HOLD;\\n else return TD_DOUBLE_TAP;\\n }\\n\\n // Assumes no one is trying to type the same letter three times (at least not quickly).\\n // If your tap dance key is 'KC_W', and you want to type \\\"www.\\\" quickly - then you will need to add\\n // an exception here to return a 'TD_TRIPLE_SINGLE_TAP', and define that enum just like 'TD_DOUBLE_SINGLE_TAP'\\n if (state->count == 3) {\\n if (state->interrupted || !state->pressed) return TD_TRIPLE_TAP;\\n else return TD_TRIPLE_HOLD;\\n } else return TD_UNKNOWN;\\n}\\n\\n// Create an instance of 'td_tap_t' for the 'x' tap dance.\\nstatic td_tap_t xtap_state = {\\n .is_press_action = true,\\n .state = TD_NONE\\n};\\n\\nvoid x_finished(tap_dance_state_t *state, void *user_data) {\\n xtap_state.state = cur_dance(state);\\n switch (xtap_state.state) {\\n case TD_SINGLE_TAP: register_code(KC_X); break;\\n case TD_SINGLE_HOLD: register_code(KC_LCTL); break;\\n case TD_DOUBLE_TAP: register_code(KC_ESC); break;\\n case TD_DOUBLE_HOLD: register_code(KC_LALT); break;\\n // Last case is for fast typing. Assuming your key is `f`:\\n // For example, when typing the word `buffer`, and you want to make sure that you send `ff` and not `Esc`.\\n // In order to type `ff` when typing fast, the next character will have to be hit within the `TAPPING_TERM`, which by default is 200ms.\\n case TD_DOUBLE_SINGLE_TAP: tap_code(KC_X); register_code(KC_X); break;\\n default: break;\\n }\\n}\\n\\nvoid x_reset(tap_dance_state_t *state, void *user_data) {\\n switch (xtap_state.state) {\\n case TD_SINGLE_TAP: unregister_code(KC_X); break;\\n case TD_SINGLE_HOLD: unregister_code(KC_LCTL); break;\\n case TD_DOUBLE_TAP: unregister_code(KC_ESC); break;\\n case TD_DOUBLE_HOLD: unregister_code(KC_LALT); break;\\n case TD_DOUBLE_SINGLE_TAP: unregister_code(KC_X); break;\\n default: break;\\n }\\n xtap_state.state = TD_NONE;\\n}\\n\\ntap_dance_action_t tap_dance_actions[] = {\\n [X_CTL] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, x_finished, x_reset)\\n};\\n```\\n\\nAnd then simply use `TD(X_CTL)` anywhere in your keymap.\\n\\n::: info\\nIn this configuration \\\"hold\\\" takes place **after** tap dance timeout. To achieve instant hold, remove `state->interrupted` checks in conditions. As a result you may use comfortable longer tapping periods to have more time for taps and not to wait too long for holds (try starting with doubled `TAPPING_TERM`).\\n:::\", \"Example 5: Using tap dance for advanced mod-tap and layer-tap keys {#example-5}\": \"Tap dance can be used to emulate `MT()` and `LT()` behavior when the tapped code is not a basic keycode. This is useful to send tapped keycodes that normally require `Shift`, such as parentheses or curly braces\\u2014or other modified keycodes, such as `Control + X`.\\n\\nBelow your layers and custom keycodes, add the following:\\n\\n```\\n// Tap Dance keycodes\\nenum td_keycodes {\\n ALT_LP // Our example key: `LALT` when held, `(` when tapped. Add additional keycodes for each tapdance.\\n};\\n\\n// Define a type containing as many tapdance states as you need\\ntypedef enum {\\n TD_NONE,\\n TD_UNKNOWN,\\n TD_SINGLE_TAP,\\n TD_SINGLE_HOLD,\\n TD_DOUBLE_SINGLE_TAP\\n} td_state_t;\\n\\n// Create a global instance of the tapdance state type\\nstatic td_state_t td_state;\\n\\n// Declare your tapdance functions:\\n\\n// Function to determine the current tapdance state\\ntd_state_t cur_dance(tap_dance_state_t *state);\\n\\n// `finished` and `reset` functions for each tapdance keycode\\nvoid altlp_finished(tap_dance_state_t *state, void *user_data);\\nvoid altlp_reset(tap_dance_state_t *state, void *user_data);\\n```\\n\\nBelow your `LAYOUT`, define each of the tapdance functions:\\n\\n```\\n// Determine the tapdance state to return\\ntd_state_t cur_dance(tap_dance_state_t *state) {\\n if (state->count == 1) {\\n if (state->interrupted || !state->pressed) return TD_SINGLE_TAP;\\n else return TD_SINGLE_HOLD;\\n }\\n\\n if (state->count == 2) return TD_DOUBLE_SINGLE_TAP;\\n else return TD_UNKNOWN; // Any number higher than the maximum state value you return above\\n}\\n\\n// Handle the possible states for each tapdance keycode you define:\\n\\nvoid altlp_finished(tap_dance_state_t *state, void *user_data) {\\n td_state = cur_dance(state);\\n switch (td_state) {\\n case TD_SINGLE_TAP:\\n register_code16(KC_LPRN);\\n break;\\n case TD_SINGLE_HOLD:\\n register_mods(MOD_BIT(KC_LALT)); // For a layer-tap key, use `layer_on(_MY_LAYER)` here\\n break;\\n case TD_DOUBLE_SINGLE_TAP: // Allow nesting of 2 parens `((` within tapping term\\n tap_code16(KC_LPRN);\\n register_code16(KC_LPRN);\\n break;\\n default:\\n break;\\n }\\n}\\n\\nvoid altlp_reset(tap_dance_state_t *state, void *user_data) {\\n switch (td_state) {\\n case TD_SINGLE_TAP:\\n unregister_code16(KC_LPRN);\\n break;\\n case TD_SINGLE_HOLD:\\n unregister_mods(MOD_BIT(KC_LALT)); // For a layer-tap key, use `layer_off(_MY_LAYER)` here\\n break;\\n case TD_DOUBLE_SINGLE_TAP:\\n unregister_code16(KC_LPRN);\\n break;\\n default:\\n break;\\n }\\n}\\n\\n// Define `ACTION_TAP_DANCE_FN_ADVANCED()` for each tapdance keycode, passing in `finished` and `reset` functions\\ntap_dance_action_t tap_dance_actions[] = {\\n [ALT_LP] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, altlp_finished, altlp_reset)\\n};\\n```\\n\\nWrap each tapdance keycode in `TD()` when including it in your keymap, e.g. `TD(ALT_LP)`.\", \"Example 6: Using tap dance for momentary-layer-switch and layer-toggle keys {#example-6}\": \"Tap Dance can be used to mimic MO(layer) and TG(layer) functionality. For this example, we will set up a key to function as `KC_QUOT` on single-tap, as `MO(_MY_LAYER)` on single-hold, and `TG(_MY_LAYER)` on double-tap.\\n\\nThe first step is to include the following code towards the beginning of your `keymap.c`:\\n\\n```\\n// Define a type for as many tap dance states as you need\\ntypedef enum {\\n TD_NONE,\\n TD_UNKNOWN,\\n TD_SINGLE_TAP,\\n TD_SINGLE_HOLD,\\n TD_DOUBLE_TAP\\n} td_state_t;\\n\\ntypedef struct {\\n bool is_press_action;\\n td_state_t state;\\n} td_tap_t;\\n\\nenum {\\n QUOT_LAYR, // Our custom tap dance key; add any other tap dance keys to this enum \\n};\\n\\n// Declare the functions to be used with your tap dance key(s)\\n\\n// Function associated with all tap dances\\ntd_state_t cur_dance(tap_dance_state_t *state);\\n\\n// Functions associated with individual tap dances\\nvoid ql_finished(tap_dance_state_t *state, void *user_data);\\nvoid ql_reset(tap_dance_state_t *state, void *user_data);\\n```\\n\\nTowards the bottom of your `keymap.c`, include the following code:\\n\\n```\\n// Determine the current tap dance state\\ntd_state_t cur_dance(tap_dance_state_t *state) {\\n if (state->count == 1) {\\n if (!state->pressed) return TD_SINGLE_TAP;\\n else return TD_SINGLE_HOLD;\\n } else if (state->count == 2) return TD_DOUBLE_TAP;\\n else return TD_UNKNOWN;\\n}\\n\\n// Initialize tap structure associated with example tap dance key\\nstatic td_tap_t ql_tap_state = {\\n .is_press_action = true,\\n .state = TD_NONE\\n};\\n\\n// Functions that control what our tap dance key does\\nvoid ql_finished(tap_dance_state_t *state, void *user_data) {\\n ql_tap_state.state = cur_dance(state);\\n switch (ql_tap_state.state) {\\n case TD_SINGLE_TAP:\\n tap_code(KC_QUOT);\\n break;\\n case TD_SINGLE_HOLD:\\n layer_on(_MY_LAYER);\\n break;\\n case TD_DOUBLE_TAP:\\n // Check to see if the layer is already set\\n if (layer_state_is(_MY_LAYER)) {\\n // If already set, then switch it off\\n layer_off(_MY_LAYER);\\n } else {\\n // If not already set, then switch the layer on\\n layer_on(_MY_LAYER);\\n }\\n break;\\n default:\\n break;\\n }\\n}\\n\\nvoid ql_reset(tap_dance_state_t *state, void *user_data) {\\n // If the key was held down and now is released then switch off the layer\\n if (ql_tap_state.state == TD_SINGLE_HOLD) {\\n layer_off(_MY_LAYER);\\n }\\n ql_tap_state.state = TD_NONE;\\n}\\n\\n// Associate our tap dance key with its functionality\\ntap_dance_action_t tap_dance_actions[] = {\\n [QUOT_LAYR] = ACTION_TAP_DANCE_FN_ADVANCED(NULL, ql_finished, ql_reset)\\n};\\n\\n// Set a long-ish tapping term for tap-dance keys\\nuint16_t get_tapping_term(uint16_t keycode, keyrecord_t *record) {\\n switch (keycode) {\\n case QK_TAP_DANCE ... QK_TAP_DANCE_MAX:\\n return 275;\\n default:\\n return TAPPING_TERM;\\n }\\n}\\n```\\n\\nThe above code is similar to that used in previous examples. The one point to note is that we need to be able to check which layers are active at any time so we can toggle them if needed. To do this we use the `layer_state_is(layer)` function which returns `true` if the given `layer` is active.\\n\\nThe use of `cur_dance()` and `ql_tap_state` mirrors the above examples.\\n\\nThe `case: TD_SINGLE_TAP` in `ql_finished` is similar to the above examples. The `TD_SINGLE_HOLD` case works in conjunction with `ql_reset()` to switch to `_MY_LAYER` while the tap dance key is held, and to switch away from `_MY_LAYER` when the key is released. This mirrors the use of `MO(_MY_LAYER)`. The `TD_DOUBLE_TAP` case works by checking whether `_MY_LAYER` is the active layer, and toggling it on or off accordingly. This mirrors the use of `TG(_MY_LAYER)`.\\n\\n`tap_dance_actions[]` works similar to the above examples. Note that, additionally, I set a longer tapping term for the tap dance keys. This is because I like my `TAPPING_TERM` to be short (\\\\~175ms) for my non-tap-dance keys but find that this is too quick for me to reliably complete tap dance actions - thus the increased time of 275ms here. In order for the per-key tapping terms to take effect, `TAPPING_TERM_PER_KEY` must be defined in your `config.h`.\\n\\nFinally, to get this tap dance key working, be sure to include `TD(QUOT_LAYR)` in your `keymaps[]`.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 42]\"}, {\"title\": \"Tri Layers {#tri-layers}\", \"description\": null, \"content\": {\"Keycodes {#keycodes}\": \"| Keycode | Alias | Description |\\n|----------------------|-----------|---------------------------------------------------------------------------------------------------------|\\n| `QK_TRI_LAYER_LOWER` | `TL_LOWR` | Momentarily enables the \\\"lower\\\" layer. Enables the \\\"adjust\\\" layer if the \\\"upper\\\" layer is also enabled. |\\n| `QK_TRI_LAYER_UPPER` | `TL_UPPR` | Momentarily enables the \\\"upper\\\" layer. Enables the \\\"adjust\\\" layer if the \\\"lower\\\" layer is also enabled. |\", \"Configuration\": \"To change the default values for the layers, you can change these defines, in your `config.h`\\n\\n| Config name | Default | Description |\\n|--------------------------|---------|------------------------------------------|\\n| `TRI_LAYER_LOWER_LAYER` | `1` | Sets the default for the \\\"lower\\\" layer. |\\n| `TRI_LAYER_UPPER_LAYER` | `2` | Sets the default for the \\\"upper\\\" layer. |\\n| `TRI_LAYER_ADJUST_LAYER` | `3` | Sets the default for the \\\"adjust\\\" layer. |\\n\\nEg, if you wanted to set the \\\"Adjust\\\" layer to be layer 5, you'd add this to your `config.h`: \\n\\n```\\n#define TRI_LAYER_ADJUST_LAYER 5\\n```\", \"Functions\": \"| Function name | Description |\\n|----------------------------------------------|-------------------------------------------------|\\n| `set_tri_layer_lower_layer(layer)` | Changes the \\\"lower\\\" layer*. |\\n| `set_tri_layer_upper_layer(layer)` | Changes the \\\"upper\\\" layer*. |\\n| `set_tri_layer_adjust_layer(layer)` | Changes the \\\"adjust\\\" layer*. |\\n| `set_tri_layer_layers(lower, upper, adjust)` | Sets the \\\"lower\\\", \\\"upper\\\" and \\\"adjust\\\" layers*. |\\n| `get_tri_layer_lower_layer()` | Gets the current \\\"lower\\\" layer. |\\n| `get_tri_layer_upper_layer()` | Gets the current \\\"upper\\\" layer. |\\n| `get_tri_layer_adjust_layer()` | Gets the current \\\"adjust\\\" layer. |\\n\\n::: warning\\nNote: these settings are not persistent, and will be reset to the default on power loss or power cycling of the controller.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 43]\"}, {\"title\": \"Unicode {#unicode}\", \"description\": null, \"content\": {\"Caveats {#caveats}\": \"There are some limitations to this feature. Because there is no \\\"standard\\\" method of Unicode input across all operating systems, each of them require their own setup process on both the host *and* in the firmware, which may involve installation of additional software. This also means Unicode input will not \\\"just work\\\" when the keyboard is plugged into another device.\", \"Usage {#usage}\": \"The core Unicode API can be used purely programmatically. However, there are also additional subsystems which build on top of it and come with keycodes to make things easier. See below for more details.\\n\\nAdd the following to your keymap's `rules.mk`:\\n\\n```\\nUNICODE_COMMON = yes\\n```\", \"Basic Configuration {#basic-configuration}\": {\"Audio Feedback {#audio-feedback}\": \"If you have the [Audio](audio) feature enabled on your board, you can configure it to play sounds when the input mode is changed.\\n\\nAdd the following to your `config.h`:\\n\\n|Define |Default|Description |\\n|-------------------|-------|-----------------------------------------------------------|\\n|`UNICODE_SONG_MAC` |*n/a* |The song to play when the macOS input mode is selected |\\n|`UNICODE_SONG_LNX` |*n/a* |The song to play when the Linux input mode is selected |\\n|`UNICODE_SONG_BSD` |*n/a* |The song to play when the BSD input mode is selected |\\n|`UNICODE_SONG_WIN` |*n/a* |The song to play when the Windows input mode is selected |\\n|`UNICODE_SONG_WINC`|*n/a* |The song to play when the WinCompose input mode is selected|\"}, \"Input Subsystems {#input-subsystems}\": \"Each of these subsystems have their own pros and cons in terms of flexibility and ease of use. Choose the one that best fits your needs.\\n\\n::::tabs\\n\\n=== Basic\\n\\nThis is the easiest to use, albeit somewhat limited. It supports code points up to `U+7FFF`, which covers characters for most modern languages (including East Asian), as well as many symbols, but does not include emoji.\\n\\nTo enable Basic Unicode, add the following to your `rules.mk`:\\n\\n```\\nUNICODE_ENABLE = yes\\n```\\n\\nYou can then add `UC(c)` keycodes to your keymap, where *c* is the code point of the desired character (in hexadecimal - the `U+` prefix will not work). For example, `UC(0x40B)` will output [\\u040b](https://unicode-table.com/en/040B/), and `UC(0x30C4)` will output [\\u30c4](https://unicode-table.com/en/30C4).\\n\\n=== Unicode Map\\n\\nUnicode Map supports all possible code points (up to `U+10FFFF`). Here, the code points are stored in a separate mapping table (which may contain at most 16,384 entries), instead of directly in the keymap.\\n\\nTo enable Unicode Map, add the following to your `rules.mk`:\\n\\n```\\nUNICODEMAP_ENABLE = yes\\n```\\n\\nThen, you will need to create a mapping table in your `keymap.c`, and (optionally) an enum for naming the array indices, like so:\\n\\n```\\nenum unicode_names {\\n BANG,\\n IRONY,\\n SNEK\\n};\\n\\nconst uint32_t PROGMEM unicode_map[] = {\\n [BANG] = 0x203D, // \\u203d\\n [IRONY] = 0x2E2E, // \\u2e2e\\n [SNEK] = 0x1F40D, // \\ud83d\\udc0d\\n};\\n```\\n\\nFinally, add `UM(i)` keycodes to your keymap, where *i* is an index into the `unicode_map[]` array. If you defined the enum above, you can use those names instead, for example `UM(BANG)` or `UM(SNEK)`.\\n\\nLower and Upper Case Pairs {#unicodemap-pairs}\\n\\nSome writing systems have lowercase and uppercase variants of each character, such as \\u00e5 and \\u00c5. To make inputting these characters easier, you can use the `UP(i, j)` keycode in your keymap, where *i* and *j* are the mapping table indices of the lowercase and uppercase characters, respectively. If you're holding down Shift or have Caps Lock turned on when you press the key, the uppercase character will be inserted; otherwise, the lowercase character will be inserted.\\n\\n```\\nconst uint32_t PROGMEM unicode_map[] = {\\n [AE_LOWER] = 0x00E6, // \\u00e6\\n [AE_UPPER] = 0x00C6, // \\u00c6\\n};\\n```\\n\\nThis is most useful when creating a keymap for an international layout with special characters. Instead of having to put the lower and upper case versions of a character on separate keys, you can have them both on the same key. This helps blend Unicode keys in with regular keycodes.\\n\\nDue to keycode size constraints, *i* and *j* can each only refer to one of the first 128 characters in your `unicode_map`. In other words, 0 \\u2264 *i* \\u2264 127 and 0 \\u2264 *j* \\u2264 127.\\n\\n=== UCIS\\n\\nAs with Unicode Map, the UCIS method also supports all possible code points, and requires the use of a mapping table. However, it works much differently - Unicode characters are input by replacing a typed mnemonic.\\n\\nTo enable UCIS, add the following to your keymap's `rules.mk`:\\n\\n```\\nUCIS_ENABLE = yes\\n```\\n\\nThen, create a mapping table in your `keymap.c`:\\n\\n```\\nconst ucis_symbol_t ucis_symbol_table[] = UCIS_TABLE(\\n UCIS_SYM(\\\"poop\\\", 0x1F4A9), // \\ud83d\\udca9\\n UCIS_SYM(\\\"rofl\\\", 0x1F923), // \\ud83e\\udd23\\n UCIS_SYM(\\\"ukr\\\", 0x1F1FA, 0x1F1E6), // \\ud83c\\uddfa\\ud83c\\udde6\\n UCIS_SYM(\\\"look\\\", 0x0CA0, 0x005F, 0x0CA0) // \\u0ca0_\\u0ca0\\n);\\n```\\n\\nBy default, each table entry may be up to three code points long. This can be changed by adding `#define UCIS_MAX_CODE_POINTS n` to your keymap's `config.h`.\\n\\nTo invoke UCIS input, the `ucis_start()` function must first be called (for example, in a custom \\\"Unicode\\\" keycode). Then, type the mnemonic for the mapping table entry (such as \\\"rofl\\\"), and hit Space or Enter. The \\\"rofl\\\" text will be backspaced and the emoji inserted.\\n\\n::::\", \"Input Modes {#input-modes}\": \"Unicode input works by typing a sequence of characters, similar to a macro. However, since this sequence depends on your OS, you will need to prepare both your host machine and QMK to recognise and send the correct Unicode input sequences respectively.\\n\\nTo set the list of enabled input modes, add the `UNICODE_SELECTED_MODES` define to your keymap's `config.h`, for example:\\n\\n```\\n#define UNICODE_SELECTED_MODES UNICODE_MODE_LINUX\\n// or\\n#define UNICODE_SELECTED_MODES UNICODE_MODE_MACOS, UNICODE_MODE_WINCOMPOSE\\n```\\n\\nThese modes can then be cycled through using the `UC_NEXT` and `UC_PREV` keycodes. You can also switch to any input mode, even if it is not specified in `UNICODE_SELECTED_MODES`, using their respective keycodes.\\n\\nIf your keyboard has working EEPROM, it will remember the last used input mode and continue using it on the next power up. This can be disabled by defining `UNICODE_CYCLE_PERSIST` to `false`.\\n\\n:::::tabs\\n\\n==== macOS\\n\\n**Mode Name:** `UNICODE_MODE_MACOS`\\n\\nmacOS has built-in support for Unicode input as its own input source. It supports all possible code points by way of surrogate pairs for code points above `U+FFFF`.\\n\\nTo enable, go to **System Preferences \\u2192 Keyboard \\u2192 Input Sources**, then add Unicode Hex Input to the list (under Other), and activate it from the input dropdown in the menu bar. Note that this may disable some Option-based shortcuts such as Option+Left and Option+Right.\\n\\n==== Linux (IBus)\\n\\n**Mode Name:** `UNICODE_MODE_LINUX`\\n\\nFor Linux distros with IBus, Unicode input is enabled by default, supports all possible code points, and works almost anywhere. Without IBus, it works under GTK apps, but rarely anywhere else.\\n\\nUsers who would like support in non-GTK apps without IBus may need to resort to a more indirect method, such as creating a custom keyboard layout.\\n\\n==== Windows (WinCompose)\\n\\n**Mode Name:** `UNICODE_MODE_WINCOMPOSE`\\n\\nThis mode requires a third-party tool called [WinCompose](https://github.com/samhocevar/wincompose). It supports all possible code points, and is the recommended input mode for Windows.\\n\\nTo enable, install the [latest release from GitHub](https://github.com/samhocevar/wincompose/releases/latest). Once installed, it will automatically run on startup. This works reliably under all versions of Windows supported by WinCompose.\\n\\n==== Windows (HexNumpad)\\n\\n**Mode Name:** `UNICODE_MODE_WINDOWS`\\n\\n::: warning\\nThis input mode is *not* the \\\"Alt code\\\" system. Alt codes are not Unicode; they instead follow [the Windows-1252 character set](https://en.wikipedia.org/wiki/Alt_code).\\n:::\\n\\nThis is Windows' built-in hex numpad Unicode input mode. It only supports code points up to `U+FFFF`, and is not recommended due to reliability and compatibility issues.\\n\\nTo enable, run the following as an administrator, then reboot:\\n\\n```\\nreg add \\\"HKCU\\\\Control Panel\\\\Input Method\\\" -v EnableHexNumpad -t REG_SZ -d 1\\n```\\n\\n==== Emacs\\n\\n**Mode Name:** `UNICODE_MODE_EMACS`\\n\\nEmacs supports code point input with the `insert-char` command.\\n\\n==== BSD\\n\\n**Mode Name:** `UNICODE_MODE_BSD`\\n\\nNot currently implemented. If you're a BSD user and want to contribute support for this input mode, please [feel free](../contributing)!\\n\\n:::::\", \"Keycodes {#keycodes}\": \"|Key |Aliases |Description |\\n|----------------------------|---------|----------------------------------------------------------------|\\n|`UC(c)` | |Send Unicode code point `c`, up to `0x7FFF` |\\n|`UM(i)` | |Send Unicode code point at index `i` in `unicode_map` |\\n|`UP(i, j)` | |Send Unicode code point at index `i`, or `j` if Shift/Caps is on|\\n|`QK_UNICODE_MODE_NEXT` |`UC_NEXT`|Cycle through selected input modes |\\n|`QK_UNICODE_MODE_PREVIOUS` |`UC_PREV`|Cycle through selected input modes in reverse |\\n|`QK_UNICODE_MODE_MACOS` |`UC_MAC` |Switch to macOS input |\\n|`QK_UNICODE_MODE_LINUX` |`UC_LINX`|Switch to Linux input |\\n|`QK_UNICODE_MODE_WINDOWS` |`UC_WIN` |Switch to Windows input |\\n|`QK_UNICODE_MODE_BSD` |`UC_BSD` |Switch to BSD input (not implemented) |\\n|`QK_UNICODE_MODE_WINCOMPOSE`|`UC_WINC`|Switch to Windows input using WinCompose |\\n|`QK_UNICODE_MODE_EMACS` |`UC_EMAC`|Switch to emacs (`C-x-8 RET`) |\", \"API {#api}\": {\"`uint8_t get_unicode_input_mode(void)` {#api-get-unicode-input-mode}\": {\"Return Value {#api-get-unicode-input-mode-return-value}\": \"The currently active Unicode input mode.\\n\\n[]\"}, \"`void set_unicode_input_mode(uint8_t mode)` {#api-set-unicode-input-mode}\": {\"Arguments {#api-set-unicode-input-mode-arguments}\": [\"`uint8_t mode` \\nThe input mode to set.\"]}, \"`void unicode_input_mode_step(void)` {#api-unicode-input-mode-step}\": \"Change to the next Unicode input mode.\\n\\n[]\", \"`void unicode_input_mode_step_reverse(void)` {#api-unicode-input-mode-step-reverse}\": \"Change to the previous Unicode input mode.\\n\\n[]\", \"`void unicode_input_mode_set_user(uint8_t input_mode)` {#api-unicode-input-mode-set-user}\": {\"Arguments {#api-unicode-input-mode-set-user-arguments}\": [\"`uint8_t input_mode` \\nThe new input mode.\"]}, \"`void unicode_input_mode_set_kb(uint8_t input_mode)` {#api-unicode-input-mode-set-kb}\": {\"Arguments {#api-unicode-input-mode-set-kb-arguments}\": [\"`uint8_t input_mode` \\nThe new input mode.\"]}, \"`void unicode_input_start(void)` {#api-unicode-input-start}\": \"Begin the Unicode input sequence. The exact behavior depends on the currently selected input mode:\\n\\n['**macOS**: Hold `UNICODE_KEY_MAC`', '**Linux**: Tap `UNICODE_KEY_LNX`', '**WinCompose**: Tap `UNICODE_KEY_WINC`, then U', '**HexNumpad**: Hold Left Alt, then tap Numpad +', '**Emacs**: Tap Ctrl+X, then 8, then Enter']\\n\\nThis function is weakly defined, and can be overridden in user code.\\n\\n[]\", \"`void unicode_input_finish(void)` {#api-unicode-input-finish}\": \"Complete the Unicode input sequence. The exact behavior depends on the currently selected input mode:\\n\\n['**macOS**: Release `UNICODE_KEY_MAC`', '**Linux**: Tap Space', '**WinCompose**: Tap Enter', '**HexNumpad**: Release Left Alt', '**Emacs**: Tap Enter']\\n\\nThis function is weakly defined, and can be overridden in user code.\\n\\n[]\", \"`void unicode_input_cancel(void)` {#api-unicode-input-cancel}\": \"Cancel the Unicode input sequence. The exact behavior depends on the currently selected input mode:\\n\\n['**macOS**: Release `UNICODE_KEY_MAC`', '**Linux**: Tap Escape', '**WinCompose**: Tap Escape', '**HexNumpad**: Release Left Alt', '**Emacs**: Tap Ctrl+G']\\n\\nThis function is weakly defined, and can be overridden in user code.\\n\\n[]\", \"`void register_unicode(uint32_t code_point)` {#api-register-unicode}\": {\"Arguments {#api-register-unicode-arguments}\": [\"`uint32_t code_point` \\nThe code point of the character to send.\"]}, \"`void send_unicode_string(const char *str)` {#api-send-unicode-string}\": {\"Arguments {#api-send-unicode-string-arguments}\": [\"`const char *str` \\nThe string to send.\"]}, \"`uint8_t unicodemap_index(uint16_t keycode)` {#api-unicodemap-index}\": {\"Arguments {#api-unicodemap-index-arguments}\": [\"`uint16_t keycode` \\nThe Unicode Map keycode to get the index of.\"], \"Return Value {#api-unicodemap-index-return-value}\": \"An index into the `unicode_map` array.\\n\\n[]\"}, \"`uint32_t unicodemap_get_code_point(uint8_t index)` {#api-unicodemap-get-code-point}\": {\"Arguments {#unicodemap-get-code-point-arguments}\": [\"`uint8_t index` \\nThe index into the `unicode_map` array.\"], \"Return Value {#unicodemap-get-code-point-return-value}\": \"A Unicode code point value.\\n\\n[]\"}, \"`void register_unicodemap(uint8_t index)` {#api-register-unicodemap}\": {\"Arguments {#api-register-unicodemap-arguments}\": [\"`uint8_t index` \\nThe index into the `unicode_map` array.\"]}, \"`void ucis_start(void)` {#api-ucis-start}\": \"Begin the input sequence.\\n\\n[]\", \"`bool ucis_active(void)` {#api-ucis-active}\": {\"Return Value {#api-ucis-active-return-value}\": \"`true` if UCIS is active.\\n\\n[]\"}, \"`uint8_t ucis_count(void)` {#api-ucis-count}\": {\"Return Value {#api-ucis-count-return-value}\": \"The current input sequence buffer length.\\n\\n[]\"}, \"`bool ucis_add(uint16_t keycode)` {#api-ucis-add}\": {\"Arguments {#api-ucis-add-arguments}\": [\"`uint16_t keycode` \\nThe keycode to add. Must be between `KC_A` and `KC_Z`, or `KC_1` and `KC_0`.\"], \"Return Value {#api-ucis-add-return-value}\": \"`true` if the keycode was added.\\n\\n[]\"}, \"`bool ucis_remove_last(void)` {#api-ucis-remove-last}\": {\"Return Value {#api-ucis-remove-last-return-value}\": \"`true` if the sequence was not empty.\\n\\n[]\"}, \"`void ucis_finish(void)` {#api-ucis-finish}\": \"Mark the input sequence as complete, and attempt to match.\\n\\n[]\", \"`void ucis_cancel(void)` {#api-ucis-cancel}\": \"Cancel the input sequence.\\n\\n[]\", \"`void register_ucis(void)` {#api-register-ucis}\": {\"Arguments {#api-register-ucis-arguments}\": [\"`uint8_t index` \\nThe index into the UCIS symbol table.\"]}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 44]\"}, {\"title\": \"Wireless / Bluetooth\", \"description\": null, \"content\": {\"Bluetooth Known Supported Hardware\": {\"Adafruit BLE SPI Friend\": \"Currently The only bluetooth chipset supported by QMK is the Adafruit Bluefruit SPI Friend. It's a Nordic nRF51822 based chip running Adafruit's custom firmware. Data is transmitted via Adafruit's SDEP over Hardware SPI. The [Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829) is supported as it's an AVR mcu connected via SPI to the Nordic BLE chip with Adafruit firmware. If Building a custom board with the SPI friend it would be easiest to just use the pin selection that the 32u4 feather uses but you can change the pins in the config.h options with the following defines:\\n\\n['`#define BLUEFRUIT_LE_RST_PIN D4`', '`#define BLUEFRUIT_LE_CS_PIN B4`', '`#define BLUEFRUIT_LE_IRQ_PIN E6`']\\n\\nA Bluefruit UART friend can be converted to an SPI friend, however this [requires](https://github.com/qmk/qmk_firmware/issues/2274) some reflashing and soldering directly to the MDBT40 chip.\\n\\n<!-- FIXME: Document bluetooth support more completely. -->\\n## Bluetooth Rules.mk Options\\n\\nThe currently supported Bluetooth chipsets do not support [N-Key Rollover (NKRO)](../reference_glossary#n-key-rollover-nkro), so `rules.mk` must contain `NKRO_ENABLE = no`.\\n\\nAdd the following to your `rules.mk`:\\n\\n```\\nBLUETOOTH_ENABLE = yes\\nBLUETOOTH_DRIVER = bluefruit_le # or rn42\\n```\"}, \"Bluetooth Keycodes\": \"This is used when multiple keyboard outputs can be selected. Currently this only allows for switching between USB and Bluetooth on keyboards that support both.\\n\\n| Key | Aliases | Description |\\n|-----------------------------|-----------|-----------------------------------------------------------------------------------------------|\\n| `QK_OUTPUT_AUTO` | `OU_AUTO` | Automatically switch to USB when plugged in, otherwise use wireless |\\n| `QK_OUTPUT_NEXT` | `OU_NEXT` | Cycle forwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |\\n| `QK_OUTPUT_PREV` | `OU_PREV` | Cycle backwards through USB, Bluetooth, and 2.4GHz (when available) **(not yet implemented)** |\\n| `QK_OUTPUT_NONE` | `OU_NONE` | Disable all output **(not yet implemented)** |\\n| `QK_OUTPUT_USB` | `OU_USB` | Output to USB only |\\n| `QK_OUTPUT_2P4GHZ` | `OU_2P4G` | Output to 2.4GHz only **(not yet implemented)** |\\n| `QK_OUTPUT_BLUETOOTH` | `OU_BT` | Output to Bluetooth only |\\n| `QK_BLUETOOTH_PROFILE_NEXT` | `BT_NEXT` | Move to the next Bluetooth profile **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE_PREV` | `BT_PREV` | Move to the previous Bluetooth profile **(not yet implemented)** |\\n| `QK_BLUETOOTH_UNPAIR` | `BT_UNPR` | Un-pair the current Bluetooth profile **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE1` | `BT_PRF1` | Swap to Bluetooth profile #1 **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE2` | `BT_PRF2` | Swap to Bluetooth profile #2 **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE3` | `BT_PRF3` | Swap to Bluetooth profile #3 **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE4` | `BT_PRF4` | Swap to Bluetooth profile #4 **(not yet implemented)** |\\n| `QK_BLUETOOTH_PROFILE5` | `BT_PRF5` | Swap to Bluetooth profile #5 **(not yet implemented)** |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 45]\"}, {\"title\": \"Word Per Minute (WPM) Calculation\", \"description\": null, \"content\": {\"Configuration\": \"| Define | Default | Description |\\n|------------------------------|---------------|------------------------------------------------------------------------------------------|\\n| `WPM_ESTIMATED_WORD_SIZE` | `5` | This is the value used when estimating average word size (for regression and normal use) |\\n| `WPM_ALLOW_COUNT_REGRESSION` | _Not defined_ | If defined allows the WPM to be decreased when hitting Delete or Backspace |\\n| `WPM_UNFILTERED` | _Not defined_ | If undefined (the default), WPM values will be smoothed to avoid sudden changes in value |\\n| `WPM_SAMPLE_SECONDS` | `5` | This defines how many seconds of typing to average, when calculating WPM |\\n| `WPM_SAMPLE_PERIODS` | `25` | This defines how many sampling periods to use when calculating WPM |\\n| `WPM_LAUNCH_CONTROL` | _Not defined_ | If defined, WPM values will be calculated using partial buffers when typing begins |\\n\\n'WPM_UNFILTERED' is potentially useful if you're filtering data in some other way (and also because it reduces the code required for the WPM feature), or if reducing measurement latency to a minimum is important for you.\\n\\nIncreasing 'WPM_SAMPLE_SECONDS' will give more smoothly changing WPM values at the expense of slightly more latency to the WPM calculation.\\n\\nIncreasing 'WPM_SAMPLE_PERIODS' will improve the smoothness at which WPM decays once typing stops, at a cost of approximately this many bytes of firmware space.\\n\\nIf 'WPM_LAUNCH_CONTROL' is defined, whenever WPM drops to zero, the next time typing begins WPM will be calculated based only on the time since that typing began, instead of the whole period of time specified by WPM_SAMPLE_SECONDS. This results in reaching an accurate WPM value much faster, even when filtering is enabled and a large WPM_SAMPLE_SECONDS value is specified.\", \"Public Functions\": \"|Function |Description |\\n|--------------------------|--------------------------------------------------|\\n|`get_current_wpm(void)` | Returns the current WPM as a value between 0-255 |\\n|`set_current_wpm(x)` | Sets the current WPM to `x` (between 0-255) |\", \"Callbacks\": \"By default, the WPM score only includes letters, numbers, space and some punctuation. If you want to change the set of characters considered as part of the WPM calculation, you can implement your own `bool wpm_keycode_user(uint16_t keycode)` and return true for any characters you would like included in the calculation, or false to not count that particular keycode.\\n\\nFor instance, the default is:\\n\\n```\\nbool wpm_keycode_user(uint16_t keycode) {\\n if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {\\n keycode = keycode & 0xFF;\\n } else if (keycode > 0xFF) {\\n keycode = 0;\\n }\\n if ((keycode >= KC_A && keycode <= KC_0) || (keycode >= KC_TAB && keycode <= KC_SLSH)) {\\n return true;\\n }\\n\\n return false;\\n}\\n```\\n\\nAdditionally, if `WPM_ALLOW_COUNT_REGRESSION` is defined, there is the `uint8_t wpm_regress_count(uint16_t keycode)` function that allows you to decrease the WPM. This is useful if you want to be able to penalize certain keycodes (or even combinations). \\n\\n```\\n__attribute__((weak)) uint8_t wpm_regress_count(uint16_t keycode) {\\n bool weak_modded = (keycode >= QK_LCTL && keycode < QK_LSFT) || (keycode >= QK_RCTL && keycode < QK_RSFT);\\n \\n if ((keycode >= QK_MOD_TAP && keycode <= QK_MOD_TAP_MAX) || (keycode >= QK_LAYER_TAP && keycode <= QK_LAYER_TAP_MAX) || (keycode >= QK_MODS && keycode <= QK_MODS_MAX)) {\\n keycode = keycode & 0xFF;\\n } else if (keycode > 0xFF) {\\n keycode = 0;\\n }\\n if (((get_mods() | get_oneshot_mods()) & MOD_MASK_CTRL} || weak_modded) && (keycode == KC_DEL || keycode == KC_BSPC)) {\\n return WPM_ESTIMATED_WORD_SIZE;\\n }\\n if (keycode == KC_DEL || keycode == KC_BSPC) {\\n return 1;\\n }\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 108, \\\"subpages\\\", 46]\"}], \"path\": \"[\\\"subpages\\\", 108]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Core Firmware Architecture - The fundamental runtime system orchestrating keyboard operations and execution flow\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Main Execution Loop - The central process that orchestrates all keyboard operations\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Continuously scans the key matrix for state changes\", \"weight\": 3}, {\"requirements\": \"Processes detected key events through the feature pipeline\", \"weight\": 3}, {\"requirements\": \"Manages system tasks and feature-specific periodic tasks\", \"weight\": 2}, {\"requirements\": \"Generates and sends HID reports to the host computer\", \"weight\": 3}]}, {\"requirements\": \"Key Event Processing Pipeline - Multi-stage transformation of raw matrix scans into host-consumable actions\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Matrix Scanning - Detects physical key presses by scanning rows and columns\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Supports standard diode matrices and direct pin configurations\", \"weight\": 2}, {\"requirements\": \"Allows for custom matrix implementations\", \"weight\": 1}]}, {\"requirements\": \"Debouncing - Filters out electrical noise from key switch contacts\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Provides multiple debounce algorithms (symmetric, eager) for different hardware needs\", \"weight\": 2}]}, {\"requirements\": \"Keycode Resolution - Maps matrix position to specific keycode based on active layer\", \"weight\": 3}, {\"requirements\": \"Feature and Callback Hooks - Allows modular features to intercept and modify key events\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Executes user-defined functions at various key processing stages\", \"weight\": 2}]}, {\"requirements\": \"HID Report Generation - Translates processed keycodes into standard USB HID reports\", \"weight\": 3}]}, {\"requirements\": \"Layer Management System - Stack-based system for managing multiple virtual keyboard layouts\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Layer State Management - Dynamic layer activation with stack-based precedence\", \"weight\": 3}, {\"requirements\": \"Transparency System - Key behavior inheritance allowing lower layers to show through\", \"weight\": 3}, {\"requirements\": \"Layer Manipulation Functions - Momentary activation, toggling, and direct layer setting\", \"weight\": 2}, {\"requirements\": \"Advanced layer features such as tri-layer states\", \"weight\": 1}]}, {\"requirements\": \"State Management - Manages keyboard's internal state, both volatile and persistent\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Runtime State Tracking - Manages modifier states, layers, and feature status\", \"weight\": 3}, {\"requirements\": \"Persistent Storage Management - EEPROM/Flash storage for configuration settings\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Implements wear-leveling for EEPROM emulation on flash memory\", \"weight\": 1}]}]}, {\"requirements\": \"Real-Time Operating System Integration - ChibiOS RTOS integration for ARM-based MCUs\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Hardware initialization and startup sequence management\", \"weight\": 2}, {\"requirements\": \"Multitasking support for complex features like audio, RGB lighting, and USB communication\", \"weight\": 2}, {\"requirements\": \"System timer and low-level hardware resource abstraction\", \"weight\": 1}]}]}, {\"requirements\": \"Hardware Abstraction Layer - Standardized interface decoupling firmware logic from specific hardware implementations\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Architecture MCU Support - Cross-platform microcontroller compatibility system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"AVR Architecture Support - Native Atmel AVR microcontroller implementation\", \"weight\": 3}, {\"requirements\": \"ARM Architecture Support - ChibiOS-based ARM microcontroller integration\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"STM32 Family Support - STMicroelectronics ARM Cortex-M implementation\", \"weight\": 3}, {\"requirements\": \"RP2040 Support - Raspberry Pi silicon with PIO capabilities\", \"weight\": 2}, {\"requirements\": \"Alternative ARM Vendors - Kinetis, WestBerry, Artery, and other ARM implementations\", \"weight\": 2}]}, {\"requirements\": \"RISC-V Architecture Support - Emerging architecture compatibility\", \"weight\": 1}]}, {\"requirements\": \"Peripheral Driver System - Standardized drivers for hardware component control\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Communication Protocol Drivers - Low-level hardware communication interfaces\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"I2C Master Driver - Inter-integrated circuit communication protocol\", \"weight\": 2}, {\"requirements\": \"SPI Master Driver - Serial peripheral interface communication\", \"weight\": 2}, {\"requirements\": \"UART and Serial Drivers - Device communication for split keyboards and debugging\", \"weight\": 2}]}, {\"requirements\": \"Lighting and Display Drivers - Visual feedback component management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Addressable RGB LED drivers (WS2812, APA102)\", \"weight\": 2}, {\"requirements\": \"LED Matrix drivers (IS31FL37xx series)\", \"weight\": 2}, {\"requirements\": \"OLED/LCD screen drivers (SSD1306, HD44780)\", \"weight\": 1}]}, {\"requirements\": \"Input Device Drivers - Non-switch input device support\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Rotary Encoder drivers for volume and navigation control\", \"weight\": 2}, {\"requirements\": \"Pointing device sensor drivers (ADNS, PMW series, Cirque trackpads)\", \"weight\": 2}, {\"requirements\": \"Analog-to-Digital Converter driver for joysticks and analog inputs\", \"weight\": 1}]}, {\"requirements\": \"Storage Drivers - Persistent data storage abstraction\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"EEPROM Driver - Non-volatile configuration storage\", \"weight\": 3}, {\"requirements\": \"Flash Driver - Program memory and large data storage\", \"weight\": 2}]}]}, {\"requirements\": \"GPIO Control System - Pin manipulation and configuration abstraction\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Pin State Management - Digital input/output control with atomic operations\", \"weight\": 3}, {\"requirements\": \"ADC Integration - Analog sensor input processing\", \"weight\": 2}]}, {\"requirements\": \"Board Abstraction and Portability - Adaptation system for different PCBs and controllers\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Board-specific configuration in dedicated keyboard folders\", \"weight\": 3}, {\"requirements\": \"Converter system for common controller footprints to different MCUs\", \"weight\": 2}, {\"requirements\": \"Bootloader support for firmware flashing (DFU, UF2, Caterina)\", \"weight\": 2}]}]}, {\"requirements\": \"Configuration Management System - Data-driven keyboard definition and hierarchical customization framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Hierarchical Configuration Model - Layered override system for keyboard customization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Configuration Precedence - Userspace > Keymap > Keyboard > Core override hierarchy\", \"weight\": 3}, {\"requirements\": \"Build System Integration - config.h and rules.mk for preprocessor definitions and feature selection\", \"weight\": 3}, {\"requirements\": \"Userspace Support - Shared code and settings across multiple keymaps\", \"weight\": 2}]}, {\"requirements\": \"Data-Driven Configuration - JSON-based declarative keyboard definition system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Keyboard Definition Schema - Central keyboard.json for hardware description\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Matrix layout, pin assignments, and feature definitions in structured format\", \"weight\": 3}, {\"requirements\": \"Layout Macros - Physical key arrangement to logical key mapping\", \"weight\": 3}, {\"requirements\": \"USB Device Descriptor - HID device identification and capabilities\", \"weight\": 2}]}, {\"requirements\": \"Code Generation - Automatic C header file and build flag generation from JSON\", \"weight\": 2}, {\"requirements\": \"Tool Integration - Enables QMK Configurator and other tools to understand keyboards\", \"weight\": 2}]}, {\"requirements\": \"Keymap System - Hierarchical key behavior definition and layer management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Keycode System - Comprehensive input action definition framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Basic Keycodes - Standard keyboard key definitions\", \"weight\": 3}, {\"requirements\": \"Quantum Keycodes - QMK-specific advanced key behaviors for layers, reset, etc.\", \"weight\": 3}, {\"requirements\": \"Modifier Integration - Key combination and modifier state management\", \"weight\": 3}, {\"requirements\": \"Mod-Tap Keys - Dual-function keys that act as modifiers when held, regular keys when tapped\", \"weight\": 2}, {\"requirements\": \"Specialized feature keycodes for RGB control, Audio, Macros, and Unicode\", \"weight\": 2}]}]}]}, {\"requirements\": \"Feature Framework - Modular functionality system for advanced keyboard behavior enhancement\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Advanced Input Processing - Complex key behavior modification systems\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Tap-Hold Processing - Dual-function key behavior based on timing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Layer-Tap Keys - Layer activation when held, key when tapped\", \"weight\": 2}, {\"requirements\": \"Tap-Hold Configuration - Timing and behavior customization system\", \"weight\": 2}]}, {\"requirements\": \"Multi-Key Interaction Systems - Complex key combination behaviors\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Tap Dance - Multi-tap key behavior sequences based on tap count\", \"weight\": 2}, {\"requirements\": \"Combos - Simultaneous key press combinations triggering actions\", \"weight\": 2}, {\"requirements\": \"Key Overrides - Context-sensitive key behavior modification\", \"weight\": 2}, {\"requirements\": \"Auto Shift - Automatic capitalization based on hold duration\", \"weight\": 1}]}]}, {\"requirements\": \"Lighting and Visual Features - LED control and visual feedback systems\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"RGB Matrix System - Advanced programmable RGB lighting with effects engine\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Effect Engine - Predefined and custom lighting animations\", \"weight\": 2}, {\"requirements\": \"Indicator System - Status-based lighting feedback\", \"weight\": 2}]}, {\"requirements\": \"Basic Lighting Systems - Simple LED control mechanisms\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Backlighting - Uniform keyboard illumination with brightness control\", \"weight\": 1}, {\"requirements\": \"RGB Lighting - Basic addressable RGB strip control with breathing effects\", \"weight\": 2}, {\"requirements\": \"LED Matrix - Monochrome programmable lighting\", \"weight\": 1}]}, {\"requirements\": \"Display Integration - Graphics engine for rendering on displays\", \"weight\": 1}]}, {\"requirements\": \"Input Device Emulation and Extensions - Alternative input method support\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"HID Device Emulation - Keyboard acting as other input devices\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Mouse Keys - Cursor and mouse button control from keyboard\", \"weight\": 2}, {\"requirements\": \"Joystick and Gamepad emulation\", \"weight\": 1}, {\"requirements\": \"MIDI device emulation\", \"weight\": 1}]}, {\"requirements\": \"Pointing Device Support - Mouse and trackpad integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Sensor integration for various pointing device sensors\", \"weight\": 2}, {\"requirements\": \"Split keyboard pointing device support\", \"weight\": 1}]}, {\"requirements\": \"Alternative Input Methods - Non-standard input device support\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Rotary encoder support for volume and navigation\", \"weight\": 2}, {\"requirements\": \"Analog joystick and gamepad functionality\", \"weight\": 1}, {\"requirements\": \"Digitizer and graphics tablet support\", \"weight\": 1}]}]}, {\"requirements\": \"Text Processing and Automation Features - Advanced text input and manipulation\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Macro System - Programmable text and key sequence automation\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Static Macros - Predefined text and key sequences\", \"weight\": 2}, {\"requirements\": \"Dynamic Macros - Runtime-recordable macro sequences\", \"weight\": 1}]}, {\"requirements\": \"Text Enhancement Features - Intelligent text processing\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Autocorrect - Automatic typo correction system\", \"weight\": 1}, {\"requirements\": \"Caps Word - Smart capitalization mode\", \"weight\": 1}, {\"requirements\": \"Unicode Support - International character input system\", \"weight\": 1}]}]}, {\"requirements\": \"Audio System - Audible feedback and musical note generation\", \"weight\": 1}]}, {\"requirements\": \"Communication and Connectivity - Device communication protocols and multi-device support\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"USB HID Implementation - Host computer communication protocol\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Keyboard HID - Standard keyboard input reporting\", \"weight\": 3}, {\"requirements\": \"Extended HID - Mouse, media, and consumer device reporting\", \"weight\": 2}, {\"requirements\": \"Raw HID - Custom application communication channel\", \"weight\": 1}]}, {\"requirements\": \"Split Keyboard Architecture - Multi-part keyboard communication system\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Inter-Half Communication - Data synchronization between keyboard halves\", \"weight\": 3}, {\"requirements\": \"Feature Synchronization - State sharing for lighting, layers, and settings\", \"weight\": 2}]}, {\"requirements\": \"Wireless Communication - Bluetooth and wireless connectivity support\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Bluetooth HID - Wireless keyboard functionality\", \"weight\": 2}, {\"requirements\": \"Power Management - Battery monitoring and power optimization\", \"weight\": 1}]}]}, {\"requirements\": \"Build and Deployment Ecosystem - Tools and services for firmware development, compilation, and deployment\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"QMK Command Line Interface - Comprehensive development and configuration tool\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Development environment setup and management\", \"weight\": 2}, {\"requirements\": \"Firmware compilation orchestration\", \"weight\": 3}, {\"requirements\": \"Flashing tool integration for programming MCUs\", \"weight\": 3}, {\"requirements\": \"Utility functions for scaffolding, diagnostics, and configuration\", \"weight\": 2}]}, {\"requirements\": \"Remote Compilation Service - Web-based firmware compilation as a service\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"RESTful API endpoints for compile job submission\", \"weight\": 3}, {\"requirements\": \"Asynchronous job queue management with Redis/RQ\", \"weight\": 2}, {\"requirements\": \"Job status tracking and firmware artifact distribution\", \"weight\": 2}, {\"requirements\": \"QMK Configurator backend integration\", \"weight\": 2}]}, {\"requirements\": \"Web-Based Configuration Tools - Browser-accessible keyboard customization\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"QMK Configurator - Visual keymap editor with drag-and-drop interface\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Visual keyboard representation based on keyboard.json data\", \"weight\": 3}, {\"requirements\": \"Keycode assignment through graphical interface\", \"weight\": 2}, {\"requirements\": \"Keymap.json generation and API submission\", \"weight\": 3}]}]}, {\"requirements\": \"Firmware Deployment System - Mechanisms for writing firmware to microcontrollers\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Bootloader Support - Multiple bootloader compatibility for flashing\", \"weight\": 3}, {\"requirements\": \"QMK Toolbox - Cross-platform GUI application for firmware flashing\", \"weight\": 2}, {\"requirements\": \"In-System Programming support for bootloader flashing and recovery\", \"weight\": 1}]}]}, {\"requirements\": \"Project Governance and Development Process - Open-source project management and quality assurance\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Contribution and Code Review Workflow - Structured community contribution process\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Coding standards enforcement with automated formatting tools\", \"weight\": 2}, {\"requirements\": \"GitHub pull request workflow with type-specific checklists\", \"weight\": 2}, {\"requirements\": \"Git version control best practices for branching and rebasing\", \"weight\": 1}]}, {\"requirements\": \"Quality Assurance and Testing - Code quality and stability maintenance systems\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Unit testing framework integration with Google Test\", \"weight\": 2}, {\"requirements\": \"Static analysis and linting for error detection\", \"weight\": 2}, {\"requirements\": \"Debugging tools and runtime analysis capabilities\", \"weight\": 1}]}, {\"requirements\": \"Release and Maintenance Strategy - Update management and dependency handling\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Scheduled breaking changes cycle for major refactors and API changes\", \"weight\": 2}, {\"requirements\": \"External dependency management through Git submodules\", \"weight\": 1}]}, {\"requirements\": \"Licensing and Compliance Policy - Legal framework and license enforcement\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"GPLv2 licensing with proprietary code exclusion policies\", \"weight\": 2}, {\"requirements\": \"Commercial vendor license violation handling procedures\", \"weight\": 1}]}]}]}"}}},{"rowIdx":15,"cells":{"repo_name":{"kind":"string","value":"rasa"},"repo_url":{"kind":"string","value":"https://github.com/RasaHQ/rasa"},"commit_id":{"kind":"string","value":"f28c69e4672cd978745f5a73396c79c26017d612"},"docs_tree":{"kind":"string","value":"{\"title\": \"rasa\", \"description\": \"Documentation for rasa\", \"subpages\": [{\"title\": \"Docs\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"Useful commands\": {\"Installation\": \"<detail_content>\", \"Local Development\": \"<detail_content>\", \"Build\": \"<detail_content>\", \"Deployment\": \"<detail_content>\"}, \"Manual steps after a new version\": \"<detail_content>\", \"Handling deadlinks after removal of deprecated features\": \"<detail_content>\"}}, {\"title\": \"Docs\", \"description\": \"Documentation section: docs\", \"path\": \"[\\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"Responses\": \"<detail_content>\", \"Custom Actions\": \"<detail_content>\", \"Forms\": \"<detail_content>\", \"Default Actions\": \"<detail_content>\", \"Slot Validation Actions\": \"<detail_content>\"}}, {\"title\": \"Rasa Architecture Overview\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Rasa Architecture\", \"description\": \"Check the architecture to understand how Rasa uses machine learning, context and state of the conversation to predict the next action of the AI Assistant.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"Message Handling\": \"<detail_content>\"}}, {\"title\": \"Handling Business Logic\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"Step-by-step Guide on Using Forms to Handle Business Logic\": {\"1. Defining the form\": {\"Slot Mappings\": {\"Slot Mappings with Conditions\": \"<detail_content>\"}, \"Validating Slots\": \"<detail_content>\", \"Requesting Slots\": \"<detail_content>\"}, \"2. Updating the configuration\": \"<detail_content>\", \"3. Creating rules\": \"<detail_content>\", \"4. Updating the NLU training data\": {\"Form Activation Intent(s)\": \"<detail_content>\", \"Form Filling Intent(s)\": \"<detail_content>\"}, \"5. Defining the responses\": \"<detail_content>\"}, \"Summary\": \"<detail_content>\"}}, {\"title\": \"Chitchat and FAQs\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 4]\", \"content\": {\"Step-by-step Guide on Using Response Selector for FAQs and Chitchat\": {\"1. Updating the configuration\": \"<detail_content>\", \"2. Defining Retrieval Intents and the ResponseSelector\": \"<detail_content>\", \"3. Creating rules\": \"<detail_content>\", \"4. Updating the NLU Training Data\": \"<detail_content>\", \"5. Defining the responses\": \"<detail_content>\"}, \"Summary\": \"<detail_content>\"}}, {\"title\": \"Command Line Interface\", \"description\": \"Command line interface for open source chatbot framework Rasa. Learn how to train, test and run your machine learning-based conversational AI assistants\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 5]\", \"content\": {\"Cheat Sheet\": \"<detail_content>\", \"Log Level\": \"<detail_content>\", \"Custom logging configuration\": \"<detail_content>\", \"rasa init\": \"<detail_content>\", \"rasa train\": {\"Incremental training\": \"<detail_content>\"}, \"rasa interactive\": \"<detail_content>\", \"rasa shell\": \"<detail_content>\", \"rasa run\": \"<detail_content>\", \"rasa run actions\": \"<detail_content>\", \"rasa visualize\": \"<detail_content>\", \"rasa test\": \"<detail_content>\", \"rasa test e2e\": \"<detail_content>\", \"rasa data split\": \"<detail_content>\", \"rasa data convert nlu\": \"<detail_content>\", \"rasa data migrate\": \"<detail_content>\", \"rasa data validate\": \"<detail_content>\", \"rasa export\": \"<detail_content>\", \"rasa evaluate markers\": \"<detail_content>\", \"rasa markers upload\": \"<detail_content>\", \"rasa license\": \"<detail_content>\"}}, {\"title\": \"Compatibility Matrix\", \"description\": \"Information about compatibility between Rasa Pro Services and Rasa Plus.\\n\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 6]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Components\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 7]\", \"content\": {\"Language Models\": {\"MitieNLP\": \"<detail_content>\", \"SpacyNLP\": \"<detail_content>\"}, \"Tokenizers\": {\"WhitespaceTokenizer\": \"<detail_content>\", \"JiebaTokenizer\": \"<detail_content>\", \"MitieTokenizer\": \"<detail_content>\", \"SpacyTokenizer\": \"<detail_content>\"}, \"Featurizers\": {\"MitieFeaturizer\": \"<detail_content>\", \"SpacyFeaturizer\": \"<detail_content>\", \"ConveRTFeaturizer\": \"<detail_content>\", \"LanguageModelFeaturizer\": \"<detail_content>\", \"RegexFeaturizer\": \"<detail_content>\", \"CountVectorsFeaturizer\": \"<detail_content>\", \"LexicalSyntacticFeaturizer\": \"<detail_content>\"}, \"Intent Classifiers\": {\"MitieIntentClassifier\": \"<detail_content>\", \"LogisticRegressionClassifier\": \"<detail_content>\", \"SklearnIntentClassifier\": \"<detail_content>\", \"KeywordIntentClassifier\": \"<detail_content>\", \"DIETClassifier\": \"<detail_content>\", \"FallbackClassifier\": \"<detail_content>\"}, \"Entity Extractors\": {\"MitieEntityExtractor\": \"<detail_content>\", \"SpacyEntityExtractor\": \"<detail_content>\", \"CRFEntityExtractor\": \"<detail_content>\", \"DucklingEntityExtractor\": \"<detail_content>\", \"DIETClassifier\": \"<detail_content>\", \"RegexEntityExtractor\": \"<detail_content>\", \"EntitySynonymMapper\": \"<detail_content>\"}, \"Combined Intent Classifiers and Entity Extractors\": {\"DIETClassifier\": \"<detail_content>\"}, \"Selectors\": {\"ResponseSelector\": \"<detail_content>\"}, \"Custom Components\": \"<detail_content>\"}}, {\"title\": \"Contextual Conversations\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 8]\", \"content\": {\"Step-by-step Guide on Creating Contextual Conversation Patterns\": {\"1. Defining Slots\": \"<detail_content>\", \"2. Creating Stories\": \"<detail_content>\", \"3. Configuring the TEDPolicy\": {\"Setting `max_history`\": \"<detail_content>\"}}, \"Summary\": \"<detail_content>\"}}, {\"title\": \"Conversation-Driven Development\", \"description\": \"Find out about best practices for conversational AI using Conversation-Driven Development.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 9]\", \"content\": {\"What is CDD?\": \"<detail_content>\", \"CDD in early stages of development\": \"<detail_content>\", \"CDD with a bot in production\": {\"Review\": \"<detail_content>\", \"Annotate\": \"<detail_content>\", \"Test\": \"<detail_content>\", \"Track\": \"<detail_content>\", \"Fix\": \"<detail_content>\"}}}, {\"title\": \"Custom Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 10]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Custom Graph Components\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 11]\", \"content\": {\"Graph Components\": \"<detail_content>\", \"Getting Started\": \"<detail_content>\", \"The `GraphComponent` interface\": {\"`create`\": \"<detail_content>\", \"`load`\": \"<detail_content>\", \"`get_default_config`\": \"<detail_content>\", \"`supported_languages`\": \"<detail_content>\", \"`not_supported_languages`\": \"<detail_content>\", \"`required_packages`\": \"<detail_content>\"}, \"Model Persistence\": {\"Writing to the Model Storage\": \"<detail_content>\", \"Reading from the Model Storage\": \"<detail_content>\"}, \"Registering Graph Components with the Model Configuration\": \"<detail_content>\", \"Using Custom Components in your Model Configuration\": \"<detail_content>\", \"Implementation Hints\": {\"Message Metadata\": \"<detail_content>\", \"Sparse and Dense Message Features\": \"<detail_content>\"}, \"Examples of Custom Components\": {\"Dense Message Featurizer\": \"<detail_content>\", \"Sparse Message Featurizer\": \"<detail_content>\", \"NLU Meta Learners\": \"<detail_content>\"}}}, {\"title\": \"Default Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 12]\", \"content\": {\"action_listen\": \"<detail_content>\", \"action_restart\": \"<detail_content>\", \"action_session_start\": {\"Customization\": \"<detail_content>\"}, \"action_default_fallback\": \"<detail_content>\", \"action_deactivate_loop\": \"<detail_content>\", \"action_two_stage_fallback\": \"<detail_content>\", \"action_default_ask_affirmation\": \"<detail_content>\", \"action_default_ask_rephrase\": \"<detail_content>\", \"action_back\": \"<detail_content>\", \"Form Action\": \"<detail_content>\", \"action_unlikely_intent\": {\"Customization\": \"<detail_content>\"}, \"action_extract_slots\": \"<detail_content>\"}}, {\"title\": \"Domain\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 13]\", \"content\": {\"Multiple Domain Files\": \"<detail_content>\", \"Intents\": {\"Ignoring Entities for Certain Intents\": \"<detail_content>\"}, \"Entities\": \"<detail_content>\", \"Slots\": {\"Slots and Conversation Behavior\": \"<detail_content>\", \"Slot Types\": {\"Text Slot\": \"<detail_content>\", \"Boolean Slot\": \"<detail_content>\", \"Categorical Slot\": \"<detail_content>\", \"Float Slot\": \"<detail_content>\", \"List Slot\": \"<detail_content>\", \"Any Slot\": \"<detail_content>\", \"Custom Slot Types\": \"<detail_content>\"}, \"Slot Mappings\": {\"from_entity\": {\"Unique `from_entity` mapping matching\": \"<detail_content>\"}, \"from_text\": \"<detail_content>\", \"from_intent\": \"<detail_content>\", \"from_trigger_intent\": \"<detail_content>\"}, \"Mapping Conditions\": \"<detail_content>\", \"Custom Slot Mappings\": \"<detail_content>\", \"Initial slot values\": \"<detail_content>\"}, \"Responses\": \"<detail_content>\", \"Forms\": \"<detail_content>\", \"Actions\": {\"Select which actions should receive domain\": \"<detail_content>\"}, \"Session configuration\": \"<detail_content>\", \"Config\": \"<detail_content>\"}}, {\"title\": \"Event Brokers\", \"description\": \"Find out how open source chatbot framework Rasa allows you to stream events to a message broker.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 14]\", \"content\": {\"Format\": \"<detail_content>\", \"Pika Event Broker\": {\"Adding a Pika Event Broker Using the Endpoint Configuration\": \"<detail_content>\", \"Adding SSL options to the Pika Event Broker\": \"<detail_content>\", \"Adding a Pika Event Broker in Python\": \"<detail_content>\", \"Implementing a Pika Event Consumer\": \"<detail_content>\"}, \"Kafka Event Broker\": {\"Partition Key\": \"<detail_content>\", \"Authentication and Authorization\": \"<detail_content>\", \"Adding a Kafka Event Broker Using the Endpoint Configuration\": \"<detail_content>\"}, \"SQL Event Broker\": {\"Adding a SQL Event Broker Using the Endpoint Configuration\": \"<detail_content>\"}, \"FileEventBroker\": \"<detail_content>\", \"Custom Event Broker\": {\"Configuration\": \"<detail_content>\"}}}, {\"title\": \"Fallback and Human Handoff\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 15]\", \"content\": {\"Handling Out-of-scope Messages\": {\"1. Creating an Out-of-scope Intent\": \"<detail_content>\", \"2. Defining the response message\": \"<detail_content>\", \"3. Creating an Out-of-Scope Rule\": \"<detail_content>\", \"Handling Specific Out-of-scope Messages\": \"<detail_content>\"}, \"Fallbacks\": {\"NLU Fallback\": {\"1. Updating the configuration\": \"<detail_content>\", \"2. Defining the response message\": \"<detail_content>\", \"3. Creating an NLU fallback rule\": \"<detail_content>\"}, \"Handling Low Action Confidence\": {\"1. Updating the configuration\": \"<detail_content>\", \"2. Defining the default response message\": \"<detail_content>\", \"3. Customizing the default action (optional)\": \"<detail_content>\"}, \"Two-Stage Fallback\": {\"1. Updating the configuration\": \"<detail_content>\", \"2. Defining the fallback responses\": \"<detail_content>\", \"3. Defining a Two-Stage Fallback rule\": \"<detail_content>\"}, \"4. Defining an ultimate fallback action\": \"<detail_content>\"}, \"Human Handoff\": \"<detail_content>\", \"Summary\": \"<detail_content>\"}}, {\"title\": \"Forms\", \"description\": \"Follow a rule-based process of information gathering using forms in open source bot framework Rasa.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 16]\", \"content\": {\"Usage\": {\"Defining a Form\": \"<detail_content>\", \"Activating a Form\": \"<detail_content>\", \"Deactivating a Form\": \"<detail_content>\", \"Slot Mappings\": \"<detail_content>\", \"Writing Stories / Rules for Unhappy Form Paths\": \"<detail_content>\"}, \"Advanced Usage\": {\"Validating Form Input\": \"<detail_content>\", \"Custom Slot Mappings\": \"<detail_content>\", \"Dynamic Form Behavior\": \"<detail_content>\", \"The requested_slot slot\": \"<detail_content>\", \"Using a Custom Action to Ask For the Next Slot\": \"<detail_content>\"}}}, {\"title\": \"Generating NLU Data\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 17]\", \"content\": {\"Conversation-Driven Development for NLU\": {\"Gather Real Data\": \"<detail_content>\", \"Share with Test Users Early\": \"<detail_content>\"}, \"Avoiding Intent Confusion\": {\"Splitting on Entities vs Intents\": \"<detail_content>\"}, \"Improving Entity Recognition\": {\"Pre-trained Entity Extractors\": \"<detail_content>\", \"Regexes\": \"<detail_content>\", \"Lookup Tables\": \"<detail_content>\", \"Synonyms\": \"<detail_content>\"}, \"Handling Edge Cases\": {\"Misspellings\": \"<detail_content>\", \"Defining an Out-of-scope Intent\": \"<detail_content>\"}, \"Shipping Updates\": \"<detail_content>\"}}, {\"title\": \"Rasa Glossary\", \"description\": \"Glossary for all Rasa-related terms\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 18]\", \"content\": {\"[Action](./actions.mdx)\": \"<detail_content>\", \"[Action Server](./action-server/index.mdx)\": \"<detail_content>\", \"Annotation\": \"<detail_content>\", \"[Anonymization](./pii-management.mdx)\": \"<detail_content>\", \"[Business Logic](./business-logic.mdx)\": \"<detail_content>\", \"[Chitchat](./chitchat-faqs.mdx)\": \"<detail_content>\", \"CMS\": \"<detail_content>\", \"[Conversation-Driven Development (CDD)](./conversation-driven-development.mdx)\": \"<detail_content>\", \"[Conversation Tests](./testing-your-assistant.mdx)\": \"<detail_content>\", \"[Component](./components.mdx)\": \"<detail_content>\", \"[Conditional Response Variation](./responses.mdx#conditional-response-variations)\": \"<detail_content>\", \"[Custom Action](./actions.mdx#custom-actions)\": \"<detail_content>\", \"[Default Action](./actions.mdx#default-actions)\": \"<detail_content>\", \"[DIET](./components.mdx#dietclassifier)\": \"<detail_content>\", \"[Domain](./domain.mdx)\": \"<detail_content>\", \"[Entity](./training-data-format.mdx#entities)\": \"<detail_content>\", \"[Event](./action-server/events.mdx)\": \"<detail_content>\", \"FAQs\": \"<detail_content>\", \"[Form](./forms.mdx)\": \"<detail_content>\", \"Happy / Unhappy Paths\": \"<detail_content>\", \"[Intent](./nlu-training-data.mdx)\": \"<detail_content>\", \"[Interactive Learning](./writing-stories.mdx#using-interactive-learning)\": \"<detail_content>\", \"[Knowledge Base / Knowledge Graph](./action-server/knowledge-base-actions.mdx)\": \"<detail_content>\", \"[Level 3 Assistant](https://blog.rasa.com/5-levels-of-conversational-ai-2020-update/)\": \"<detail_content>\", \"[Messaging Channels](./messaging-and-voice-channels.mdx)\": \"<detail_content>\", \"[Minimum Viable Assistant](./conversation-driven-development.mdx#cdd-in-early-stages-of-development)\": \"<detail_content>\", \"[NLG](./nlg.mdx)\": \"<detail_content>\", \"[NLU](./nlu-training-data.mdx)\": \"<detail_content>\", \"[Pipeline](./tuning-your-model.mdx)\": \"<detail_content>\", \"[Policy](./policies.mdx)\": \"<detail_content>\", \"Rasa Core\": \"<detail_content>\", \"Rasa NLU\": \"<detail_content>\", \"[NLU Component](./components.mdx)\": \"<detail_content>\", \"[Rasa X/Enterprise](https://rasa.com/docs/rasa-enterprise/)\": \"<detail_content>\", \"[Retrieval Intent](./chitchat-faqs.mdx)\": \"<detail_content>\", \"[REST Channel](./connectors/your-own-website.mdx)\": \"<detail_content>\", \"[Response / Template / Utterance](./responses.mdx)\": \"<detail_content>\", \"[Rules](./rules.mdx)\": \"<detail_content>\", \"[Slot](./domain.mdx#slots)\": \"<detail_content>\", \"[Story](./stories.mdx)\": \"<detail_content>\", \"[TED Policy](./policies.mdx#ted-policy)\": \"<detail_content>\", \"[Template / Response / Utterance](./responses.mdx)\": \"<detail_content>\", \"[Tracker](./tracker-stores.mdx)\": \"<detail_content>\", \"User Goal\": \"<detail_content>\", \"Word embedding / Word vector\": \"<detail_content>\", \"Rasa Primitive\": \"<detail_content>\"}}, {\"title\": \"Graph Recipe\", \"description\": \"Learn about Graph Recipe for Rasa.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 19]\", \"content\": {\"Differences with Default Recipe\": \"<detail_content>\", \"Graph Configuration File Structure\": \"<detail_content>\", \"Graph Node Configuration\": \"<detail_content>\"}}, {\"title\": \"Rasa HTTP API\", \"description\": \"Read about Rasa's HTTP API that has endpoints for conversations, training models, and configuring your bot.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 20]\", \"content\": {\"Enabling the HTTP API\": \"<detail_content>\", \"Security Considerations\": {\"Token Based Auth\": \"<detail_content>\", \"JWT Based Auth\": \"<detail_content>\"}}}, {\"title\": \"Introduction to Rasa Open Source & Rasa Pro\", \"description\": \"Learn more about open-source natural language processing library Rasa for conversation handling, intent classification and entity extraction in on premise chatbots.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 21]\", \"content\": {\"Rasa Open Source\": \"<detail_content>\", \"Rasa Pro\": \"<detail_content>\"}}, {\"title\": \"Jupyter Notebooks\", \"description\": \"Learn how to integrate open source chatbot platform Rasa into Jupyter notebooks, alongside all your machine learning code.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 22]\", \"content\": {\"Train a Model\": \"<detail_content>\", \"Chat with your assistant\": \"<detail_content>\", \"Evaluate your model against test data\": \"<detail_content>\"}}, {\"title\": \"Language Support\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 23]\", \"content\": {\"Training a Model in Any Languages\": \"<detail_content>\", \"Using Pre-trained Language Models\": {\"spaCy\": \"<detail_content>\", \"MITIE\": \"<detail_content>\"}}}, {\"title\": \"Lock Stores\", \"description\": \"Messages that are being processed lock Rasa for a given conversation ID to ensure that multiple incoming messages for that conversation do not interfere with each other. Rasa provides multiple implementations to maintain conversation locks.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 24]\", \"content\": {\"InMemoryLockStore (default)\": \"<detail_content>\", \"ConcurrentRedisLockStore\": {\"Description\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Parameters\": \"<detail_content>\", \"Migration Guide\": \"<detail_content>\"}, \"RedisLockStore\": \"<detail_content>\", \"Custom Lock Store\": {\"Configuration\": \"<detail_content>\"}}}, {\"title\": \"Markers\", \"description\": \"Find out how to mark points of interest in dialogues using Marker conditions.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 25]\", \"content\": {\"Overview\": \"<detail_content>\", \"Defining Markers\": {\"Event Conditions\": \"<detail_content>\", \"Operators\": \"<detail_content>\", \"Marker Configuration\": \"<detail_content>\"}, \"Extracting Markers\": {\"Extracted Markers\": \"<detail_content>\", \"Computed Statistics\": \"<detail_content>\"}, \"Configuring the CLI command\": \"<detail_content>\"}}, {\"title\": \"Connecting to Messaging and Voice Channels\", \"description\": \"Check out how to make your Rasa assistant available on platforms like Facebook Messenger, Slack, Telegram or even your very own website.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 26]\", \"content\": {\"Connecting to A Channel\": \"<detail_content>\", \"Testing Channels on Your Local Machine\": \"<detail_content>\"}}, {\"title\": \"Migrate From Other Tools (beta)\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 27]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Version Migration Guide\", \"description\": \"Information about changes between major versions of chatbot framework Rasa Core\\nand how you can migrate from one version to another.\\n\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 28]\", \"content\": {\"Rasa 3.0 to 3.1\": {\"Machine Learning Components\": {\"TensorFlow Upgrade\": \"<detail_content>\"}, \"NLU JSON Format\": \"<detail_content>\"}, \"Rasa 2.x to 3.0\": {\"Markdown Data\": \"<detail_content>\", \"Model Configuration\": \"<detail_content>\", \"Custom Policies and Custom Components\": {\"Changes to Custom NLU Components\": \"<detail_content>\", \"Changes to Custom Policies\": \"<detail_content>\"}, \"Training data\": {\"Upgrading `version` from `2.0` to `3.0`\": \"<detail_content>\", \"`TrainingDataImporter`\": \"<detail_content>\"}, \"Training\": {\"`rasa train --dry-run`\": \"<detail_content>\"}, \"Machine Learning Components\": {\"Normalization of Confidences in `DIETClassifier` and `ResponseSelector`\": \"<detail_content>\", \"Normalization of confidences in `TEDPolicy`\": \"<detail_content>\", \"Removed Policies\": \"<detail_content>\", \"Removed Tokenizers and Featurizers\": \"<detail_content>\"}, \"Slot Mappings\": {\"Automatic migration from 2.0 domain format to the 3.0 format\": \"<detail_content>\", \"Manually migrating from 2.0 domain format to the 3.0 format\": \"<detail_content>\", \"Rasa-SDK Modifications\": \"<detail_content>\"}}, \"Rasa 2.7 to 2.8\": {\"Deprecations\": {\"Tracker Featurizers\": \"<detail_content>\", \"State Featurizer\": \"<detail_content>\"}, \"Incremental Training\": \"<detail_content>\", \"Machine Learning Components\": \"<detail_content>\"}, \"Rasa 2.5 to 2.6\": {\"Forms\": {\"New `ignored_intents` parameter in Forms\": \"<detail_content>\"}}, \"Rasa 2.4 to 2.5\": {\"Machine Learning Components\": {\"`DIET`, `TED`, and `ResponseSelector`\": \"<detail_content>\", \"SpaCy 3.0\": \"<detail_content>\"}}, \"Rasa 2.3 to Rasa 2.4\": {\"Deprecating `template` for `response`\": \"<detail_content>\"}, \"Rasa 2.3.3 to Rasa 2.3.4\": {\"Machine Learning Components\": \"<detail_content>\"}, \"Rasa 2.2 to Rasa 2.3\": {\"General\": \"<detail_content>\", \"Machine Learning Components\": \"<detail_content>\"}, \"Rasa 2.1 to Rasa 2.2\": {\"General\": \"<detail_content>\", \"Deprecations\": {\"Markdown Data\": \"<detail_content>\"}, \"Policies\": {\"Other\": \"<detail_content>\"}}, \"Rasa 2.0 to Rasa 2.1\": {\"Deprecations\": \"<detail_content>\"}, \"Rasa 1.10 to Rasa 2.0\": {\"General\": \"<detail_content>\", \"Training data files\": \"<detail_content>\", \"Policies\": {\"Manually migrating from the Mapping Policy\": \"<detail_content>\", \"Manually migrating from the Fallback Policy\": \"<detail_content>\", \"Manually migrating from the Two-Stage-Fallback Policy\": \"<detail_content>\"}, \"Forms\": \"<detail_content>\", \"Response Selectors\": \"<detail_content>\", \"Unfeaturized Slots\": \"<detail_content>\", \"Conversation sessions\": \"<detail_content>\", \"Dialogue Featurization\": \"<detail_content>\", \"Deprecations\": \"<detail_content>\"}, \"Rasa 1.7 to Rasa 1.8\": {\"General\": \"<detail_content>\"}, \"Rasa 1.6 to Rasa 1.7\": {\"General\": \"<detail_content>\"}, \"Rasa 1.2 to Rasa 1.3\": {\"General\": \"<detail_content>\"}, \"Rasa NLU 0.14.x and Rasa Core 0.13.x to Rasa 1.0\": {\"General\": \"<detail_content>\", \"Script parameters\": \"<detail_content>\", \"HTTP API\": \"<detail_content>\"}}}, {\"title\": \"Model Configuration\", \"description\": \"Learn about model configuration for Rasa.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 29]\", \"content\": {\"Suggested Config\": \"<detail_content>\"}}, {\"title\": \"Model Storage\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 30]\", \"content\": {\"Load Model from Disk\": \"<detail_content>\", \"Load Model from Server\": {\"How to Configure Rasa\": \"<detail_content>\", \"How to Configure Your Server\": \"<detail_content>\"}, \"Load Model from Cloud\": {\"Amazon S3 Storage\": \"<detail_content>\", \"Google Cloud Storage\": \"<detail_content>\", \"Azure Storage\": \"<detail_content>\", \"Other Remote Storages\": \"<detail_content>\"}}}, {\"title\": \"NLG Servers\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 31]\", \"content\": {\"Responding to Requests\": {\"Request Format\": \"<detail_content>\", \"Response Format\": \"<detail_content>\"}, \"Configuring the Server URL\": \"<detail_content>\"}}, {\"title\": \"NLU-Only Server\", \"description\": \"Read about connecting to a Rasa NLU-only server using the HTTP API.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 32]\", \"content\": {\"Connecting to an NLU server\": \"<detail_content>\"}}, {\"title\": \"Using NLU Only\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 33]\", \"content\": {\"Training NLU-only models\": \"<detail_content>\", \"Testing your NLU model on the command line\": \"<detail_content>\", \"Running an NLU server\": \"<detail_content>\"}}, {\"title\": \"NLU Training Data\", \"description\": \"Read more about how to format training data with Rasa NLU for open source natural language processing.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 34]\", \"content\": {\"Training Examples\": \"<detail_content>\", \"Entities\": \"<detail_content>\", \"Synonyms\": \"<detail_content>\", \"Regular Expressions\": {\"Regular Expressions for Intent Classification\": \"<detail_content>\", \"Regular Expressions for Entity Extraction\": {\"Regular Expressions as Features\": \"<detail_content>\", \"Regular Expressions for Rule-based Entity Extraction\": \"<detail_content>\"}}, \"Lookup Tables\": \"<detail_content>\", \"Entities Roles and Groups\": {\"Entity Roles and Groups influencing dialogue predictions\": \"<detail_content>\"}, \"BILOU Entity Tagging\": \"<detail_content>\"}}, {\"title\": \"PII Management\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 35]\", \"content\": {\"Architecture Overview\": {\"Supported Rasa Events\": \"<detail_content>\", \"Supported PII entity types\": \"<detail_content>\"}, \"How to write anonymization rules\": {\"How to populate the metadata section\": {\"How to install the language model\": \"<detail_content>\"}, \"How to populate the rule_lists section\": \"<detail_content>\"}, \"How to update the Kafka event broker configuration\": {\"Streaming anonymized events to Rasa X/Enterprise with Kafka\": \"<detail_content>\"}, \"How to enable anonymization of PII in logs\": \"<detail_content>\"}}, {\"title\": \"Policies\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 36]\", \"content\": {\"Action Selection\": {\"Policy Priority\": \"<detail_content>\"}, \"Machine Learning Policies\": {\"TED Policy\": \"<detail_content>\", \"UnexpecTED Intent Policy\": {\"Prediction of `action_unlikely_intent`\": \"<detail_content>\", \"Tuning the tolerance parameter\": \"<detail_content>\"}, \"Memoization Policy\": \"<detail_content>\", \"Augmented Memoization Policy\": \"<detail_content>\"}, \"Rule-based Policies\": {\"Rule Policy\": \"<detail_content>\"}, \"Configuring Policies\": {\"Max History\": \"<detail_content>\", \"Data Augmentation\": \"<detail_content>\", \"Featurizers\": {\"State Featurizers\": \"<detail_content>\", \"Tracker Featurizers\": {\"1. Full Dialogue\": \"<detail_content>\", \"2. Max History\": \"<detail_content>\", \"3. Intent Max History\": \"<detail_content>\"}}}, \"Custom Policies\": \"<detail_content>\"}}, {\"title\": \"Rasa Pro Change Log\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 37]\", \"content\": {\"Rasa Pro 3.6\": {\"Rasa Plus 3.6\": {\"Features\": \"<detail_content>\"}, \"Improvements\": \"<detail_content>\", \"Bugfixes\": {\"Deprecations and Removal\": \"<detail_content>\"}, \"Rasa Pro Services 3.1\": {\"Features\": \"<detail_content>\"}}, \"Rasa Pro 3.5\": {\"Rasa Plus 3.5\": {\"Features\": \"<detail_content>\"}, \"Rasa Pro Services 3.0\": \"<detail_content>\"}, \"Rasa Pro 3.4\": {\"Rasa Plus 3.4\": {\"Features\": \"<detail_content>\", \"Improvements\": \"<detail_content>\"}, \"Rasa Pro Services 3.0\": \"<detail_content>\"}, \"Rasa Pro 3.3\": {\"Rasa Plus 3.3\": {\"Features\": \"<detail_content>\"}, \"Rasa Pro Services 3.0\": {\"Features\": \"<detail_content>\"}}}}, {\"title\": \"Rasa Pro\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 38]\", \"content\": {\"Rasa Pro Features\": {\"Analytics with Conversational Data Pipeline\": \"<detail_content>\", \"Concurrent Lock Store\": \"<detail_content>\", \"End-to-End Testing\": \"<detail_content>\", \"IVR Voice Connector\": \"<detail_content>\", \"Observability (Tracing)\": \"<detail_content>\", \"PII Handling\": \"<detail_content>\", \"Real-Time Markers\": \"<detail_content>\", \"Secrets Management\": \"<detail_content>\", \"Security Scanning for Vulnerability Protection\": \"<detail_content>\", \"Spaces (Alpha Release)\": \"<detail_content>\"}}}, {\"title\": \"Reaching Out to the User\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 39]\", \"content\": {\"Reaching out first\": {\"1. Update the configuration\": \"<detail_content>\", \"2. Add a rule\": \"<detail_content>\", \"3. Add a response\": \"<detail_content>\"}, \"External Events\": {\"1. Trigger an Intent\": \"<detail_content>\", \"2. Get the Conversation ID\": \"<detail_content>\", \"3. Add NLU Training Data\": \"<detail_content>\", \"4. Update the Domain\": {\"5. Add a Rule\": \"<detail_content>\", \"6. Add a Response\": \"<detail_content>\"}, \"Try it out\": \"<detail_content>\"}, \"Reminders\": {\"Scheduling Reminders\": {\"1. Define a Reminder\": \"<detail_content>\", \"2. Add a Rule\": \"<detail_content>\", \"3. Add Training Data\": \"<detail_content>\", \"4. Update your Pipeline\": \"<detail_content>\"}, \"Reacting to Reminders\": {\"1. Define a Reaction\": \"<detail_content>\", \"2. Add a Rule\": \"<detail_content>\", \"3. Add Training Data\": \"<detail_content>\"}, \"Cancelling Reminders\": {\"1. Define an Action that Cancels a Reminder\": \"<detail_content>\", \"2. Add a Rule\": \"<detail_content>\", \"3. Add Training Data\": \"<detail_content>\"}, \"Try it Out\": \"<detail_content>\"}}}, {\"title\": \"Responses\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 40]\", \"content\": {\"Defining Responses\": {\"Using Variables in Responses\": \"<detail_content>\", \"Response Variations\": {\"IDs for Responses\": \"<detail_content>\"}, \"Channel-Specific Response Variations\": \"<detail_content>\", \"Conditional Response Variations\": \"<detail_content>\"}, \"Rich Responses\": {\"Buttons\": \"<detail_content>\", \"Images\": \"<detail_content>\", \"Custom Output Payloads\": \"<detail_content>\"}, \"Using Responses in Conversations\": {\"Calling Responses as Actions\": \"<detail_content>\", \"Calling Responses from Custom Actions\": \"<detail_content>\"}}}, {\"title\": \"Rules\", \"description\": \"Use Rasa rules to respond to FAQs, fill forms, or handle fallbacks gracefully.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 41]\", \"content\": {\"Writing a Rule\": {\"Rules for the Conversation Start\": \"<detail_content>\", \"Rules with Conditions\": \"<detail_content>\", \"Skip Waiting for User Input at the End of a Rule\": \"<detail_content>\", \"Abort a Rule\": \"<detail_content>\", \"Rules and Forms\": \"<detail_content>\"}}}, {\"title\": \"Rasa SDK Change Log\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 42]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Secrets Managers\", \"description\": \"Safeguard credentials your service uses to authenticate to external resources.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 43]\", \"content\": {\"HashiCorp Vault Secrets Manager\": {\"Authentication\": \"<detail_content>\", \"How to configure access to Vault\": {\"Store access credentials in environment variables\": \"<detail_content>\"}, \"How to configure Tracker Store with Vault Secrets Manager\": \"<detail_content>\"}}}, {\"title\": \"Setting up CI/CD\", \"description\": \"Set up a CI/CD pipeline to ensure that iterative improvements to your assistant are tested and deployed with minimum manual effort\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 44]\", \"content\": {\"Overview\": \"<detail_content>\", \"Continuous Integration (CI)\": {\"CI Pipeline Overview\": \"<detail_content>\", \"GitHub Actions CI Pipeline\": \"<detail_content>\"}, \"Continuous Deployment (CD)\": {\"Deploying Your Rasa Model\": \"<detail_content>\", \"Deploying Your Action Server\": \"<detail_content>\"}, \"Example CI/CD pipelines\": \"<detail_content>\"}}, {\"title\": \"Slot Validation Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 45]\", \"content\": {\"`action_validate_slot_mappings`\": \"<detail_content>\", \"`validate_<form name>`\": \"<detail_content>\", \"Regular Custom Action\": \"<detail_content>\"}}, {\"title\": \"Spaces\", \"description\": \"Learn about Spaces for Rasa.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 46]\", \"content\": {\"When to use Spaces\": \"<detail_content>\", \"When not to use Spaces / Limitations\": \"<detail_content>\", \"An example spaces bot\": \"<detail_content>\", \"How to use spaces\": {\"Training only a specific subspace\": \"<detail_content>\"}, \"How do spaces work?\": {\"What happens during the assembly?\": \"<detail_content>\", \"How is space activation tracked?\": \"<detail_content>\", \"How does filter and rerank work?\": \"<detail_content>\", \"How does entity recognition work differently?\": \"<detail_content>\", \"Custom Actions\": \"<detail_content>\", \"Response Selection\": \"<detail_content>\", \"Lookup tables and Synonyms\": \"<detail_content>\"}}}, {\"title\": \"Stories\", \"description\": \"Stories are used to teach Rasa real conversation designs to learn from providing the basis for a scalable machine learning dialogue management.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 47]\", \"content\": {\"Format\": {\"User Messages\": \"<detail_content>\", \"Actions\": \"<detail_content>\", \"Events\": {\"Slot Events\": \"<detail_content>\", \"Form Events\": \"<detail_content>\"}}, \"Checkpoints and OR statements\": {\"Checkpoints\": \"<detail_content>\", \"Or Statements\": \"<detail_content>\"}, \"Test Conversation Format\": \"<detail_content>\", \"End-to-end Training\": \"<detail_content>\"}}, {\"title\": \"Testing Your Assistant\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 48]\", \"content\": {\"Validating Data and Stories\": \"<detail_content>\", \"Writing Test Stories\": \"<detail_content>\", \"Evaluating an NLU Model\": {\"Using a Held-Out Test Set\": \"<detail_content>\", \"Using Cross-Validation\": \"<detail_content>\", \"Comparing NLU Pipelines\": \"<detail_content>\", \"Interpreting the Output\": {\"Intent Classifiers\": \"<detail_content>\", \"Response Selectors\": \"<detail_content>\", \"Entity Extraction\": \"<detail_content>\", \"Entity Scoring\": \"<detail_content>\"}}, \"Evaluating a Dialogue Model\": {\"Interpreting the generated warnings\": \"<detail_content>\", \"Comparing Policy Configurations\": \"<detail_content>\", \"Testing Action Code\": \"<detail_content>\"}, \"End-To-End Testing\": {\"How to write test cases\": \"<detail_content>\", \"How to run the tests\": {\"Testing custom actions\": \"<detail_content>\"}, \"How to interpret the output\": \"<detail_content>\"}}}, {\"title\": \"Tracker Stores\", \"description\": \"All conversations are stored within a tracker store. Read how Rasa provides implementations for different store types out of the box.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 49]\", \"content\": {\"Switch to root user to install packages\": \"<detail_content>\", \"Copy in oracle instaclient\": \"<detail_content>\", \"https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html\": \"<detail_content>\", \"Install the Python wrapper library for the Oracle drivers\": \"<detail_content>\", \"Install Oracle client libraries\": {\"RedisTrackerStore\": {\"Configuration\": \"<detail_content>\"}, \"MongoTrackerStore\": {\"Configuration\": {\"Configuration Parameters\": \"<detail_content>\"}}, \"DynamoTrackerStore\": {\"Configuration\": {\"Configuration Parameters\": \"<detail_content>\"}}, \"Custom Tracker Store\": {\"Configuration\": \"<detail_content>\"}, \"Fallback Tracker Store\": \"<detail_content>\"}}}, {\"title\": \"Training Data Format\", \"description\": \"Description of the YAML format for training data\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 50]\", \"content\": {\"Overview\": {\"High-Level Structure\": \"<detail_content>\", \"Example\": \"<detail_content>\"}, \"NLU Training Data\": {\"Training Examples\": \"<detail_content>\", \"Entities\": \"<detail_content>\", \"Synonyms\": \"<detail_content>\", \"Regular Expressions\": \"<detail_content>\", \"Lookup Tables\": \"<detail_content>\"}, \"Conversation Training Data\": {\"Stories\": {\"User Messages\": \"<detail_content>\", \"Actions\": \"<detail_content>\", \"Forms\": \"<detail_content>\", \"Slots\": \"<detail_content>\", \"Checkpoints\": \"<detail_content>\", \"OR statement\": \"<detail_content>\"}, \"Rules\": \"<detail_content>\"}, \"Test Stories\": \"<detail_content>\", \"End-to-end Training\": \"<detail_content>\"}}, {\"title\": \"Training Data Importers\", \"description\": \"Change the way Rasa imports training data by replacing the default importer or writing your own importer.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 51]\", \"content\": {\"RasaFileImporter (default)\": \"<detail_content>\", \"MultiProjectImporter (experimental)\": \"<detail_content>\", \"Writing a Custom Importer\": \"<detail_content>\"}}, {\"title\": \"Tuning Your NLU Model\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 52]\", \"content\": {\"How to Choose a Pipeline\": {\"Sensible Starting Pipelines\": \"<detail_content>\", \"Component Lifecycle\": \"<detail_content>\", \"Doing Multi-Intent Classification\": {\"When to Use Multi-Intents\": \"<detail_content>\", \"How to Use Multi-Intents for Dialogue Management\": \"<detail_content>\"}, \"Comparing Pipelines\": \"<detail_content>\"}, \"Choosing the Right Components\": {\"Tokenization\": \"<detail_content>\", \"Featurization\": {\"Pre-trained Embeddings\": \"<detail_content>\", \"Supervised Embeddings\": \"<detail_content>\"}, \"Intent Classification / Response Selectors\": \"<detail_content>\", \"Entity Extraction\": \"<detail_content>\"}, \"Improving Performance\": {\"Handling Class Imbalance\": \"<detail_content>\", \"Accessing Diagnostic Data\": \"<detail_content>\"}, \"Configuring Tensorflow\": {\"Deterministic Operations\": \"<detail_content>\", \"Optimizing CPU Performance\": {\"Parallelizing One Operation\": \"<detail_content>\", \"Parallelizing Multiple Operations\": \"<detail_content>\"}, \"Optimizing GPU Performance\": {\"Limiting GPU Memory Growth\": \"<detail_content>\", \"Restricting Absolute GPU Memory Available\": \"<detail_content>\"}}}}, {\"title\": \"Handling Unexpected Input\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 53]\", \"content\": {\"User Interjections\": {\"Contextual Interjections\": \"<detail_content>\"}, \"Summary\": \"<detail_content>\"}}, {\"title\": \"Writing Conversation Data\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 54]\", \"content\": {\"Designing Stories\": \"<detail_content>\", \"When to Write Stories vs. Rules\": \"<detail_content>\", \"Managing the Conversation Flow\": {\"When to Use Slots to Influence Conversations\": \"<detail_content>\", \"Implementing Branching Logic\": \"<detail_content>\", \"Using OR statements and Checkpoints\": {\"OR statements\": \"<detail_content>\", \"Checkpoints\": \"<detail_content>\"}, \"Creating Logical Breaks in Stories\": \"<detail_content>\"}, \"Handling Context Switching\": {\"Using Rules for Context Switching\": \"<detail_content>\", \"Using Stories for Context Switching\": \"<detail_content>\"}, \"Managing Conversation Data Files\": \"<detail_content>\", \"Using Interactive Learning\": {\"Command-line Interactive Learning\": \"<detail_content>\"}}}, {\"title\": \"Action Server\", \"description\": \"Documentation section: action-server\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55]\", \"subpages\": [{\"title\": \"Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 0]\", \"content\": {\"Custom Action Input\": {\"`next_action`\": \"<detail_content>\", \"`sender_id`\": \"<detail_content>\", \"`tracker`\": \"<detail_content>\", \"`domain`\": \"<detail_content>\", \"`version`\": \"<detail_content>\"}, \"Custom Action Output\": {\"`events`\": \"<detail_content>\", \"`responses`\": \"<detail_content>\"}, \"Special Action Types\": \"<detail_content>\"}}, {\"title\": \"Events\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 1]\", \"content\": {\"Event Types\": {\"`slot`\": \"<detail_content>\", \"`reset_slots`\": \"<detail_content>\", \"`reminder`\": \"<detail_content>\", \"`cancel_reminder`\": \"<detail_content>\", \"`pause`\": \"<detail_content>\", \"`resume`\": \"<detail_content>\", \"`followup`\": \"<detail_content>\", \"`rewind`\": \"<detail_content>\", \"`undo`\": \"<detail_content>\", \"`restart`\": \"<detail_content>\", \"`session_started`\": \"<detail_content>\", \"`user`\": \"<detail_content>\", \"`bot`\": \"<detail_content>\", \"`action`\": \"<detail_content>\"}}}, {\"title\": \"Introduction to Rasa Action Server\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 2]\", \"content\": {\"How it works\": \"<detail_content>\", \"SDKs for Custom Actions\": {\"Rasa SDK (Python)\": \"<detail_content>\", \"Other Action Servers\": \"<detail_content>\"}}}, {\"title\": \"Knowledge Base Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 3]\", \"content\": {\"Using `ActionQueryKnowledgeBase`\": {\"Create a Knowledge Base\": \"<detail_content>\", \"Define the NLU Data\": \"<detail_content>\", \"Create an Action to Query your Knowledge Base\": \"<detail_content>\"}, \"How It Works\": {\"Query the Knowledge Base for Objects\": \"<detail_content>\", \"Query the Knowledge Base for an Attribute of an Object\": \"<detail_content>\", \"Resolve Mentions\": \"<detail_content>\"}, \"Customization\": {\"Customizing `ActionQueryKnowledgeBase`\": \"<detail_content>\", \"Creating Your Own Knowledge Base Actions\": \"<detail_content>\", \"Customizing the `InMemoryKnowledgeBase`\": \"<detail_content>\", \"Creating Your Own Knowledge Base\": \"<detail_content>\"}}}, {\"title\": \"Running a Rasa SDK Action Server\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 4]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Sanic Extensions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 5]\", \"content\": {\"Step-by-step guide on creating your own Sanic extension in rasa_sdk\": {\"Create the rasa_sdk_plugins package\": \"<detail_content>\", \"Register modules containing the hooks\": \"<detail_content>\", \"Implement your hook\": \"<detail_content>\"}}}, {\"title\": \"Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 6]\", \"content\": {\"Methods\": {\"Action.name\": \"<detail_content>\", \"Action.run\": {\"**Parameters**\": \"<detail_content>\", \"**Returns**\": \"<detail_content>\", \"**Return type**\": \"<detail_content>\"}}, \"Example\": \"<detail_content>\"}}, {\"title\": \"Dispatcher\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 7]\", \"content\": {\"CollectingDispatcher\": {\"CollectingDispatcher.utter_message\": {\"**Parameters**\": \"<detail_content>\", \"**Return type**\": \"<detail_content>\"}}}}, {\"title\": \"Events\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 8]\", \"content\": {\"Event Classes\": {\"SlotSet\": \"<detail_content>\", \"AllSlotsReset\": \"<detail_content>\", \"ReminderScheduled\": \"<detail_content>\", \"ReminderCancelled\": \"<detail_content>\", \"ConversationPaused\": \"<detail_content>\", \"ConversationResumed\": \"<detail_content>\", \"FollowupAction\": \"<detail_content>\", \"UserUtteranceReverted\": \"<detail_content>\", \"ActionReverted\": \"<detail_content>\", \"Restarted\": \"<detail_content>\", \"SessionStarted\": \"<detail_content>\", \"UserUttered\": \"<detail_content>\", \"BotUttered\": \"<detail_content>\", \"ActionExecuted\": \"<detail_content>\"}}}, {\"title\": \"Tracker\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 9]\", \"content\": {\"Attributes\": \"<detail_content>\", \"Methods\": {\"Tracker.current_state\": \"<detail_content>\", \"Tracker.is_paused\": \"<detail_content>\", \"Tracker.get_latest_entity_values\": \"<detail_content>\", \"Tracker.get_latest_input_channel\": \"<detail_content>\", \"Tracker.events_after_latest_restart\": \"<detail_content>\", \"Tracker.get_slot\": \"<detail_content>\", \"Tracker.get_intent_of_latest_message\": \"<detail_content>\"}}}, {\"title\": \"Slot Validation Actions\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 10]\", \"content\": {\"`ValidationAction` class\": {\"How to subclass `ValidationAction`\": {\"Validation of Slots with Predefined Mappings\": \"<detail_content>\", \"Extraction of Custom Slot Mappings\": \"<detail_content>\"}, \"`ValidationAction` class implementation\": {\"Methods\": {\"ValidationAction.name\": \"<detail_content>\", \"ValidationAction.run\": {\"**Parameters**\": \"<detail_content>\", \"**Returns**\": \"<detail_content>\", \"**Return type**\": \"<detail_content>\"}, \"ValidationAction.required_slots\": {\"**Returns**\": \"<detail_content>\"}, \"ValidationAction.get_extraction_events\": \"<detail_content>\", \"**Returns**\": \"<detail_content>\", \"ValidationAction.get_validation_events\": {\"**Returns**\": \"<detail_content>\"}}}}, \"`FormValidationAction` class\": {\"`FormValidationAction` class implementation\": {\"Methods\": {\"FormValidationAction.name\": \"<detail_content>\", \"FormValidationAction.required_slots\": \"<detail_content>\", \"FormValidationAction.next_requested_slot\": \"<detail_content>\", \"FormValidationAction.run\": \"<detail_content>\"}}}}}]}, {\"title\": \"Connectors\", \"description\": \"Documentation section: connectors\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56]\", \"subpages\": [{\"title\": \"Audiocodes VoiceAI Connect\", \"description\": \"Build a Rasa Voice Bot on Audiocodes VoiceAI Connect\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 0]\", \"content\": {\"Getting Credentials\": \"<detail_content>\", \"Setting credentials\": \"<detail_content>\", \"Usage\": {\"Receiving messages from a user\": \"<detail_content>\", \"Sending messages to a user\": \"<detail_content>\", \"Handling conversation events\": \"<detail_content>\", \"Configuring calls\": {\"Example: changing a pin code\": \"<detail_content>\"}}}}, {\"title\": \"Cisco Webex Teams\", \"description\": \"Build a Rasa Chat Bot on Cisco Webex\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 1]\", \"content\": {\"Getting Credentials\": \"<detail_content>\", \"Running on Cisco Webex Teams\": \"<detail_content>\"}}, {\"title\": \"Custom Connectors\", \"description\": \"Deploy and Run a Rasa Chat Bot on a custom chat interface\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 2]\", \"content\": {\"The `name` method\": \"<detail_content>\", \"The `blueprint` method\": \"<detail_content>\", \"Metadata on messages\": \"<detail_content>\", \"Credentials for Custom Channels\": \"<detail_content>\", \"Testing the Custom Connector Webhook\": \"<detail_content>\"}}, {\"title\": \"Facebook Messenger\", \"description\": \"Build a Rasa Chat Bot on Facebook Messenger\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 3]\", \"content\": {\"Facebook Setup\": {\"Getting Credentials\": \"<detail_content>\", \"Running On Facebook Messenger\": \"<detail_content>\"}, \"Supported response attachments\": \"<detail_content>\"}}, {\"title\": \"Google Hangouts Chat\", \"description\": \"Build a Rasa Chat Bot on Google Hangouts Chat\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 4]\", \"content\": {\"Hangouts Chat Setup\": {\"Running On Hangouts Chat\": \"<detail_content>\", \"Cards and Interactive Cards\": \"<detail_content>\", \"Other Hangouts Chat Events\": \"<detail_content>\"}}}, {\"title\": \"Mattermost\", \"description\": \"Build a Rasa Chat Bot on Mattermost\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 5]\", \"content\": {\"Getting Credentials\": \"<detail_content>\", \"Running on Mattermost\": \"<detail_content>\"}}, {\"title\": \"Microsoft Bot Framework\", \"description\": \"Build a Rasa Chat Bot on Microsoft Bot Framework\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 6]\", \"content\": {\"Running on Microsoft Bot Framework\": \"<detail_content>\"}}, {\"title\": \"RocketChat\", \"description\": \"Build a Rasa Chat Bot on Rocketchat\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 7]\", \"content\": {\"Getting Credentials\": \"<detail_content>\", \"Running on RocketChat\": \"<detail_content>\"}}, {\"title\": \"Slack\", \"description\": \"Build a Rasa Chat Bot on Slack\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 8]\", \"content\": {\"Sending Messages\": \"<detail_content>\", \"Receiving Messages\": \"<detail_content>\", \"Optional: Interactive Components\": \"<detail_content>\", \"Additional Slack Options\": \"<detail_content>\"}}, {\"title\": \"Telegram\", \"description\": \"Build a Rasa Chat Bot on Telegram\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 9]\", \"content\": {\"Getting Credentials\": \"<detail_content>\", \"Running on Telegram\": \"<detail_content>\", \"Supported Response Attachments\": \"<detail_content>\"}}, {\"title\": \"Twilio Voice\", \"description\": \"Deploy a Rasa IVR assistant via the Twilio Voice connector\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 10]\", \"content\": {\"Running on Twilio\": {\"Connect to a Twilio Phone Number\": \"<detail_content>\", \"Connect to a Twilio SIP Domain\": \"<detail_content>\"}, \"Configure Channel in Rasa\": \"<detail_content>\", \"Parameter Definitions\": {\"Initial Prompt\": \"<detail_content>\", \"Assistant Voice\": \"<detail_content>\", \"Reprompt Fallback Phrase\": \"<detail_content>\", \"Speech Timeout\": \"<detail_content>\", \"Speech Model\": \"<detail_content>\", \"Enhanced\": \"<detail_content>\"}, \"Custom Voice Responses\": \"<detail_content>\"}}, {\"title\": \"Twilio\", \"description\": \"Deploy a Rasa assistant through text message or WhatsApp via the Twilio connector\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 11]\", \"content\": {\"Getting Credentials\": {\"Connecting to WhatsApp\": \"<detail_content>\"}, \"Running on Twilio\": {\"Receiving Location Data from Whatsapp with Twilio connector\": \"<detail_content>\"}}}, {\"title\": \"Your Own Website\", \"description\": \"Deploy and Run a Rasa Chat Bot on a Website\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 12]\", \"content\": {\"REST Channels\": {\"RestInput\": {\"Request and Response Format\": \"<detail_content>\"}, \"CallbackInput\": {\"Request and Response Format\": \"<detail_content>\"}}, \"Websocket Channel\": {\"JWT Authentication\": \"<detail_content>\", \"Chat Widget\": \"<detail_content>\"}}}]}, {\"title\": \"Deploy\", \"description\": \"Documentation section: deploy\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57]\", \"subpages\": [{\"title\": \"Deploy Rasa Action Server\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 0]\", \"content\": {\"Installation Requirements\": \"<detail_content>\", \"1. Installation\": {\"a. Create Namespace\": \"<detail_content>\", \"b. Deploy Rasa Action Server\": \"<detail_content>\", \"c. Access Rasa Action Server\": \"<detail_content>\"}, \"Building an Action Server Image\": {\"Automating your Action Server Image Builds\": {\"Manually Building an Action Server\": \"<detail_content>\"}, \"Using your Custom Action Server Image\": \"<detail_content>\"}, \"Setting a Custom Action Server Image\": \"<detail_content>\", \"2. Connect Rasa Action Server to a Rasa deployment\": \"<detail_content>\"}}, {\"title\": \"Deploy Rasa Pro Services\", \"description\": \"Deploy Rasa Rasa Pro Services in production\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 1]\", \"content\": {\"Rasa Pro Services Setup\": {\"Prerequisites\": {\"System Requirements\": \"<detail_content>\", \"License\": \"<detail_content>\"}, \"Installation and Configuration\": \"<detail_content>\", \"Docker Container Configuration (Reference)\": \"<detail_content>\", \"Healthcheck Endpoint\": \"<detail_content>\", \"Connect to a secured Kafka instance\": \"<detail_content>\", \"Upgrading Versions\": \"<detail_content>\"}}}, {\"title\": \"Deploy Rasa\", \"description\": \"Deploy a Rasa assistant on Kubernetes/Openshift using Helm\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 2]\", \"content\": {\"Installation Requirements\": \"<detail_content>\", \"Installation\": {\"1. Create Namespace\": \"<detail_content>\", \"2. Create Values File\": \"<detail_content>\", \"3. Loading an initial model\": \"<detail_content>\", \"4. Deploy Rasa Assistant\": {\"Security Patch Releases\": \"<detail_content>\", \"Step 1: image pull secret\": \"<detail_content>\", \"Step 2: store license in a secret\": \"<detail_content>\", \"Step 3: update `values.yml`\": \"<detail_content>\"}, \"5. Access Rasa Assistant\": \"<detail_content>\"}, \"Next Steps\": \"<detail_content>\"}}, {\"title\": \"Deploying a Rasa Assistant\", \"description\": \"How to deploy your Rasa Assistant with Kubernetes/Openshift\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 3]\", \"content\": {\"When to Deploy Your Assistant\": \"<detail_content>\", \"Recommended Deployment Method\": {\"Cluster Requirements\": \"<detail_content>\"}, \"Alternative Deployment Methods\": \"<detail_content>\"}}]}, {\"title\": \"Docker\", \"description\": \"Documentation section: docker\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58]\", \"subpages\": [{\"title\": \"Building a Rasa Assistant in Docker\", \"description\": \"Learn how to build a Rasa assistant in Docker.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58, \\\"subpages\\\", 0]\", \"content\": {\"Installing Docker\": \"<detail_content>\", \"Setting up your Rasa Project\": \"<detail_content>\", \"Talking to Your Assistant\": \"<detail_content>\", \"Training a Model\": \"<detail_content>\", \"Customizing your Model\": {\"Choosing a Tag\": \"<detail_content>\", \"Adding Custom Components\": \"<detail_content>\", \"Adding Custom Actions\": \"<detail_content>\"}, \"Deploying your Assistant\": \"<detail_content>\"}}, {\"title\": \"Deploying a Rasa Assistant in Docker Compose\", \"description\": \"Use Docker Compose to deploy a Rasa assistant\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58, \\\"subpages\\\", 1]\", \"content\": {\"Installing Docker\": \"<detail_content>\", \"Configuring Channels\": \"<detail_content>\", \"Using Docker Compose to Run Multiple Services\": \"<detail_content>\", \"Configuring a Tracker Store\": \"<detail_content>\"}}]}, {\"title\": \"Installation\", \"description\": \"Documentation section: installation\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59]\", \"subpages\": [{\"title\": \"Setting up your environment\", \"description\": \"How to set up your environment before installing Rasa\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 0]\", \"content\": {\"1. Python Environment Setup\": \"<detail_content>\", \"2. Virtual Environment Setup\": \"<detail_content>\", \"M1 / M2 (Apple Silicon) Limitations\": \"<detail_content>\"}}, {\"title\": \"Installing Rasa Open Source\", \"description\": \"Install Rasa Open Source on premises to enable local and customizable Natural Language Understanding and Dialogue Management.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 1]\", \"content\": {\"Install Rasa Open Source\": \"<detail_content>\", \"Building from Source\": \"<detail_content>\", \"Additional dependencies\": {\"Python 3.10 requirements\": \"<detail_content>\", \"Dependencies for spaCy\": \"<detail_content>\", \"Dependencies for MITIE\": \"<detail_content>\"}, \"Upgrading Versions\": \"<detail_content>\"}}, {\"title\": \"Rasa Pro\", \"description\": \"Documentation section: rasa-pro\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Rasa Pro Installation\", \"description\": \"Install Rasa Pro in your production environment to create an enterprise ready Rasa deployment.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Rasa Pro Setup\": {\"Python Package Installation\": {\"Authentication Set-Up\": \"<detail_content>\", \"Installing with `pip`\": \"<detail_content>\", \"Installing with `poetry`\": \"<detail_content>\"}, \"Docker Image Installation\": \"<detail_content>\", \"Using An Intermediate Repository\": \"<detail_content>\", \"Runtime Configuration\": \"<detail_content>\"}}}, {\"title\": \"Rasa Pro Artifacts\", \"description\": \"artifacts that ship with Rasa Pro.\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}]}]}, {\"title\": \"Migrate From\", \"description\": \"Documentation section: migrate-from\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60]\", \"subpages\": [{\"title\": \"Rasa as open source alternative to Facebook\\u2019s Wit.ai - Migration Guide\", \"description\": \"Open source alternative to Facebook's Wit.ai for conversational bots and NLP\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 0]\", \"content\": {\"Step 1: Export your Training Data from Wit.ai\": \"<detail_content>\", \"Step 2: Create a Rasa Project\": \"<detail_content>\", \"Step 3: Train your NLU model\": \"<detail_content>\", \"Step 4: Test your NLU model\": \"<detail_content>\", \"Step 5: Start a Server with your NLU Model\": \"<detail_content>\"}}, {\"title\": \"Rasa as open source alternative to Google Dialogflow - Migration Guide\", \"description\": \"Open source alternative to Google Dialogflow for conversational bots and NLP\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 1]\", \"content\": {\"Step 1: Export your data from Dialogflow\": \"<detail_content>\", \"Step 2: Create a Rasa Project\": \"<detail_content>\", \"Step 3: Train your NLU model\": \"<detail_content>\", \"Step 4: Test your NLU model\": \"<detail_content>\", \"Step 5: Start a Server with your NLU Model\": \"<detail_content>\", \"Terminology:\": \"<detail_content>\"}}, {\"title\": \"Rasa as open source alternative to IBM Watson - Migration Tips\", \"description\": \"Open source alternative to IBM Watson for conversational bots and NLP\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 2]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Rasa as open source alternative to Microsoft LUIS - Migration Guide\", \"description\": \"Open source alternative to Microsoft LUIS for conversational bots and NLP\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 3]\", \"content\": {\"Step 1: Export your Training Data from LUIS\": \"<detail_content>\", \"Step 2: Create a Rasa Project\": \"<detail_content>\", \"Step 3: Train your NLU model\": \"<detail_content>\", \"Step 4: Test your NLU model\": \"<detail_content>\", \"Step 5: Start a Server with your NLU Model\": \"<detail_content>\"}}]}, {\"title\": \"Monitoring\", \"description\": \"Documentation section: monitoring\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61]\", \"subpages\": [{\"title\": \"Load Testing Guidelines\", \"description\": \"Information about how best to scale up your bot to support parallel user activity\\nand how you can use tracing to help debug issues.\\n\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 0]\", \"content\": {\"Overview\": {\"Some recommendations to improve latency\": \"<detail_content>\", \"Debugging bot related issues while scaling up\": \"<detail_content>\"}}}, {\"title\": \"Tracing\", \"description\": \"Resolve performance issues faster and identify bottlenecks through OpenTelemetry-based tracing\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 1]\", \"content\": {\"Tracing\": {\"Supported Tracing Backends/Collectors\": \"<detail_content>\", \"Enabling / Disabling\": \"<detail_content>\", \"Action Server\": \"<detail_content>\"}, \"Configuring a Tracing Backend or Collector\": {\"Jaeger\": \"<detail_content>\", \"OTEL Collector\": \"<detail_content>\"}, \"Traced Events\": {\"Model Training\": {\"`GraphTrainer` Attributes\": \"<detail_content>\", \"`GraphNode` Attributes\": \"<detail_content>\"}, \"Message Handling\": {\"`Agent` Attributes\": \"<detail_content>\", \"`MessageProcessor` Attributes\": \"<detail_content>\", \"`TrackerStore` & `LockStore` Attributes\": \"<detail_content>\"}}}}, {\"title\": \"Analytics\", \"description\": \"Documentation section: analytics\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Data structure reference\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Database Table Overview\": \"<detail_content>\", \"Common Terms\": \"<detail_content>\", \"Tables\": {\"rasa_sender\": {\"`id` sender identifier\": \"<detail_content>\", \"`sender_key` Rasa channel sender identifier\": \"<detail_content>\", \"`channel` Rasa channel name\": \"<detail_content>\", \"`first_seen` first contact with this sender\": \"<detail_content>\", \"`last_seen` latest contact with this sender\": \"<detail_content>\"}, \"rasa_session\": {\"`id` session identifier\": \"<detail_content>\", \"`sender_id` sender who started the session\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`start_sequence_number` start of the session\": \"<detail_content>\", \"`end_sequence_number` end of the session\": \"<detail_content>\"}, \"rasa_turn\": {\"`id` session identifier\": \"<detail_content>\", \"`sender_id` sender who started the turn\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`start_sequence_number` start of the turn\": \"<detail_content>\", \"`end_sequence_number` end of the turn\": \"<detail_content>\"}, \"rasa_event\": {\"`id` event identifier\": \"<detail_content>\", \"`sender_id` sender whose conversation the event belongs to\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`event_type` kind of event\": \"<detail_content>\", \"`model_id` model identifier\": \"<detail_content>\", \"`environment` name of the assistant environment\": \"<detail_content>\", \"`sequence_number` start of the event\": \"<detail_content>\"}, \"rasa_bot_message\": {\"`id` bot message identifier\": \"<detail_content>\", \"`event_id` id of the event of this message\": \"<detail_content>\", \"`sender_id` sender whose conversation the message belongs to\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`template_name` name of the template used to generate the message\": \"<detail_content>\", \"`text` message content\": \"<detail_content>\", \"`model_id` model identifier\": \"<detail_content>\", \"`sequence_number` start of the event\": \"<detail_content>\"}, \"rasa_user_message\": {\"`id` user message identifier\": \"<detail_content>\", \"`event_id` id of the event of this message\": \"<detail_content>\", \"`sender_id` sender whose conversation the message belongs to\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`intent` classification of the text\": \"<detail_content>\", \"`retrieval_intent` classification of the text\": \"<detail_content>\", \"`confidence` certainty the model predicted for classifications\": \"<detail_content>\", \"`text` message content\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`model_id` model identifier\": \"<detail_content>\", \"`sequence_number` start of the event\": \"<detail_content>\", \"`message_id` unique id for the message text\": \"<detail_content>\"}, \"rasa_action\": {\"`id` action identifier\": \"<detail_content>\", \"`event_id` id of the event of this action execution\": \"<detail_content>\", \"`sender_id` sender whose conversation triggered this action execution\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`name` name of the executed action\": \"<detail_content>\", \"`confidence` ML models certainty of the predicted action\": \"<detail_content>\", \"`policy` name of the policy that predicted the action\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`model_id` model identifier\": \"<detail_content>\", \"`sequence_number` start of the event\": \"<detail_content>\"}, \"rasa_slot\": {\"`id` slot change identifier\": \"<detail_content>\", \"`event_id` id of the event that triggered this slot change\": \"<detail_content>\", \"`sender_id` sender whose conversation triggered this slot change\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`slot_path` path of the slot\": \"<detail_content>\", \"`name` name of the slot\": \"<detail_content>\", \"`value` new slot value\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\", \"`sequence_number` start of the event\": \"<detail_content>\"}, \"rasa_session_slot_state\": {\"`id` path of the slot\": \"<detail_content>\", \"`sender_id` sender whose conversation this slot is part of\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`name` name of the slot\": \"<detail_content>\", \"`value` last value of the slot in the session\": \"<detail_content>\", \"`timestamp` creation date time\": \"<detail_content>\"}, \"rasa_patterns\": {\"`id` pattern identifier\": \"<detail_content>\", \"`name` pattern name\": \"<detail_content>\", \"`description` pattern description\": \"<detail_content>\", \"`config` pattern configuration\": \"<detail_content>\", \"`is_active` soft-delete flag\": \"<detail_content>\", \"`created_at` creation date time\": \"<detail_content>\", \"`updated_at` update date time\": \"<detail_content>\"}, \"rasa_markers\": {\"`id` marker identifier\": \"<detail_content>\", \"`pattern_id` pattern which was applied in this marker\": \"<detail_content>\", \"`sender_id` sender identifier\": \"<detail_content>\", \"`session_id` session identifier\": \"<detail_content>\", \"`event_id` event identifier\": \"<detail_content>\", \"`num_preceding_user_turns` Number of Proeeding User turns\": \"<detail_content>\", \"`created_at` creation date time\": \"<detail_content>\"}}, \"Internal Tables\": \"<detail_content>\"}}, {\"title\": \"Example queries\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"Number of sessions per month\": \"<detail_content>\", \"Number of sessions per channel\": \"<detail_content>\", \"Top N intents\": \"<detail_content>\", \"Escalation rate\": \"<detail_content>\", \"Abandonment rate\": \"<detail_content>\"}}, {\"title\": \"Getting started with Analytics\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"Types of metrics\": \"<detail_content>\", \"Prerequisites\": \"<detail_content>\", \"1. Connect an assistant\": \"<detail_content>\", \"2. Connect a data warehouse\": {\"PostgreSQL\": \"<detail_content>\", \"Redshift\": {\"Streaming from PostgreSQL to Redshift\": \"<detail_content>\", \"Direct connection\": \"<detail_content>\"}, \"BigQuery\": \"<detail_content>\", \"Snowflake\": \"<detail_content>\"}, \"3. Ingest past conversations (optional)\": \"<detail_content>\", \"4. Connect a BI Solution\": {\"Example: Metabase\": \"<detail_content>\", \"Example: Tableau\": \"<detail_content>\"}}}, {\"title\": \"Real-Time Analysis of Markers\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"Defining Markers\": \"<detail_content>\", \"Enable Real-time Processing\": {\"Configuring the CLI command\": \"<detail_content>\"}, \"How are Markers processed?\": \"<detail_content>\"}}]}]}, {\"title\": \"Telemetry\", \"description\": \"Documentation section: telemetry\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 62]\", \"subpages\": [{\"title\": \"Rasa Telemetry\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 62, \\\"subpages\\\", 0]\", \"content\": {\"How to opt-out\": \"<detail_content>\", \"Why do we use telemetry reporting?\": \"<detail_content>\", \"What about sensitive data?\": \"<detail_content>\", \"What do we report?\": \"<detail_content>\"}}]}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"rasa\", \"description\": \"Documentation for rasa\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs\"}, \"subpages\": [{\"title\": \"Docs\", \"description\": null, \"content\": {\"Useful commands\": {\"Installation\": \"Firstly, install python dependencies for Rasa:\\n\\n```\\n$ make install\\n```\\n\\nThen, install doc dependencies:\\n\\n```\\n$ make install-docs\\n```\", \"Local Development\": \"In order to build the docs, run:\\n\\n```\\n$ make docs\\n```\\n\\nThen, start doc server in watch mode:\\n\\n```\\n$ make livedocs\\n```\\n\\nThis command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.\", \"Build\": \"```\\n$ yarn build\\n```\\n\\nThis command generates static content into the `build` directory and can be served using any static contents hosting service.\", \"Deployment\": \"Deployment is handled by Netlify: it is setup for listening to changes on the `documentation` branch.\"}, \"Manual steps after a new version\": \"When a new docs version has been released, we'll need to do the following manual steps:\\n\\n['Remove all the callouts from previous versions, with the exception of experimental features. You can find\\\\nthose using `:::info` or `:::caution` in all the docs files.', 'Update the wording of the top banner, configured in `docusaurus.config.js` in `announcementBar`: update the Rasa versions\\\\nthat are mentioned and link to the now previous major version documentation.', 'Update Netlify redirects in `netlify.toml`, under `# Redirects for latest version permalinks`, by adjusting the\\\\nversion number to the now new major version.']\", \"Handling deadlinks after removal of deprecated features\": \"When removing deprecated features, it will happen that some links become dead because they now link to\\nparts of the docs that no longer exist. This usually happens in the CHANGELOG or migration links,\\nand thankfully we do have CI checks that alert for dead links.\\n\\nThe trick here is to make these links point to _previous_ versions of the docs. For instance, if the feature\\nyou removed was documented at `./policies#mapping-policy` and the current latest version for the docs is `2.x`\\n(this also means that the next version is `3.x`), then you can update the link to `https://rasa.com/docs/rasa/2.x/policies#mapping-policy`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"Docs\", \"description\": \"Documentation section: docs\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs\"}, \"subpages\": [{\"title\": \"Actions\", \"description\": null, \"content\": {\"Responses\": \"A [response](./responses.mdx) is a message the assistant will send back to the user. This is\\nthe action you will use most often, when you want the assistant to send text, images, buttons\\nor similar to the user.\", \"Custom Actions\": \"A [custom action](./custom-actions.mdx) is an action that can run any code you want. This can be used to make an\\nAPI call, or to query a database for example.\", \"Forms\": \"[Forms](./forms.mdx) are a special type of custom action, designed to handle business logic. If you have\\nany conversation designs where you expect the assistant to ask for a specific set of\\ninformation, you should use forms.\", \"Default Actions\": \"[Default actions](./default-actions.mdx) are actions that are built into the dialogue manager by default. Most of\\nthese are automatically predicted based on certain conversation situations. You may want to\\ncustomize these to personalize your assistant.\", \"Slot Validation Actions\": \"A [slot validation action](./slot-validation-actions.mdx) is a special type of custom action, designed to handle custom extraction and/or validation of slot values.\\nThis can be used to validate slots with predefined mappings or extract slots with custom mappings.\"}, \"metadata\": {\"id\": \"actions\", \"sidebar_label\": \"Overview\", \"title\": \"Actions\", \"abstract\": \"After each user message, the model will predict an action that the assistant should perform next. This page gives you an overview of the different types of actions you can use.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Rasa Architecture Overview\", \"description\": null, \"content\": {\"root\": [\"import useBaseUrl from '@docusaurus/useBaseUrl';\", \"The diagram below provides an overview of the Rasa architecture. The two primary\\ncomponents are Natural Language Understanding (NLU) and dialogue management.\", \"NLU is the part that handles intent classification, entity extraction, and response retrieval.\\nIt's shown below as the *NLU Pipeline* because it processes\\nuser utterances using an NLU model that is generated by the trained pipeline.\", \"The dialogue management component decides the next action in a conversation based on the\\ncontext. This is displayed as the *Dialogue Policies* in the diagram.\\n<img alt=\\\"image\\\" src={useBaseUrl(\\\"/img/architecture.png\\\")} />\"]}, \"metadata\": {\"id\": \"arch-overview\", \"sidebar_label\": \"Overview\", \"title\": \"Rasa Architecture Overview\", \"abstract\": \"Rasa has a scalable architecture. Read about the key components of the Rasa architecture.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"Rasa Architecture\", \"description\": \"Check the architecture to understand how Rasa uses machine learning, context and state of the conversation to predict the next action of the AI Assistant.\", \"content\": {\"Message Handling\": \"This diagram shows the basic steps of how an assistant built with Rasa\\nresponds to a message:\\n\\nimport archImage from './architecture-img.png';\\n\\n<Image img={archImage} caption=\\\"Rasa architecture\\\" alt=\\\"A visual representation of the steps that follow.\\\"/>\\n\\nThe steps are:\\n\\n['The message is received and passed to an `Interpreter`, which\\\\nconverts it into a dictionary including the original text, the intent,\\\\nand any entities that were found. This part is handled by NLU.', 'The message is passed from the `Interpreter` to the `Tracker`.\\\\nThe `Tracker` is the object which keeps track of conversation state.', 'The current state of the tracker is sent to each policy.', 'Each policy chooses which action to take next.', 'The chosen action is logged by the tracker.', 'A response is sent to the user.']\"}, \"metadata\": {\"id\": \"architecture\", \"sidebar_label\": \"Rasa Architecture\", \"title\": \"Rasa Architecture\", \"description\": \"Check the architecture to understand how Rasa uses machine learning, context and state of the conversation to predict the next action of the AI Assistant.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \"Handling Business Logic\", \"description\": null, \"content\": {\"Step-by-step Guide on Using Forms to Handle Business Logic\": {\"1. Defining the form\": {\"Slot Mappings\": {\"Slot Mappings with Conditions\": \"The `outdoor_seating` slot is\\nfilled based on the user's intent: If it is `affirm`, it'll be `true`, if it is\\n`deny`, it'll be `false`. \\n\\nHowever, the slot should only be set to `true` or `false` if the user was responding to the question, `Do you want to sit outside?`.\\nTo enforce this condition, the `conditions` for the `outdoor_seating` slot requires that `restaurant_form` is active and that the requested slot is `outdoor_seating`. \\nIf there were no conditions and the user had sent a message with the `affirm` or `deny` intent earlier in the conversation,\\nthe `outdoor_seating` slot would already be filled when the form was activated. Therefore the form would not prompt the user for their outdoor seating preference. See [mapping conditions](./domain.mdx#mapping-conditions) for more information.\"}, \"Validating Slots\": \"Often, you'll want to validate the user's input before accepting it,\\nfor example by checking if the given cuisine is in your assistant's database\\nof available cuisines.\\nSee the docs on [validating form input](forms.mdx#validating-form-input) for more information\\nabout validation actions.\", \"Requesting Slots\": \"To specify how the bot should ask for the required information,\\nyou define [`responses`](domain.mdx#responses) called `utter_ask_{slotname}` in your domain:\\n\\n```\\nresponses:\\n utter_ask_cuisine:\\n - text: \\\"What cuisine?\\\"\\n utter_ask_num_people:\\n - text: \\\"How many people?\\\"\\n utter_ask_outdoor_seating:\\n - text: \\\"Do you want to sit outside?\\\"\\n```\"}, \"2. Updating the configuration\": \"A form's [happy path](glossary.mdx#happy--unhappy-paths) should be defined as a [rule](rules.mdx) which means you'll need to add the [RulePolicy](policies.mdx#rule-policy)\\nto your policies:\\n\\n```\\npolicies:\\n - name: RulePolicy\\n```\", \"3. Creating rules\": \"The form itself takes care of the logic around asking the user for all\\nthe required information, so\\nyou need only two rules for a form's happy path:\\nOne that defines when it starts, and one that defines what happens when it has been filled.\\nFor the restaurant search example, in real life the assistant would look up\\na restaurant based on the user's preferences.\\nIn this case, the bot will utter a response with the details\\nthat would be used for a search.\\n\\n```\\nrules:\\n - rule: activate restaurant form\\n steps:\\n - intent: request_restaurant # intent that triggers form activation\\n - action: restaurant_form # run the form\\n - active_loop: restaurant_form # this form is active\\n\\n - rule: submit form\\n condition:\\n - active_loop: restaurant_form # this form must be active\\n steps:\\n - action: restaurant_form # run the form\\n - active_loop: null # the form is no longer active because it has been filled\\n - action: utter_submit # action to take after the form is complete\\n - action: utter_slots_values # action to take after the form is complete\\n```\\n\\nBy splitting up the activation and submission of the form,\\nthe rules will still apply if the user provides\\n[unexpected input](unexpected-input.mdx) or interrupts\\nthe form with [chitchat](chitchat-faqs.mdx).\", \"4. Updating the NLU training data\": {\"Form Activation Intent(s)\": \"You need to provide training examples for the\\nintent(s) that should activate the form.\\nAdd examples for the intent `request_restaurant`:\\n\\n```\\nnlu:\\n- intent: request_restaurant\\n examples: |\\n - im looking for a restaurant\\n - can i get [swedish](cuisine) food in any area\\n - a restaurant that serves [caribbean](cuisine) food\\n - id like a restaurant\\n - im looking for a restaurant that serves [mediterranean](cuisine) food\\n - can i find a restaurant that serves [chinese](cuisine)\\n```\\n\\nSlots filled with `from_entity` can by default be filled by any user utterance, regardless of the intent, as\\nlong as the correct entity is extracted. That means that if the user provides the `cuisine` entity as part of\\ntheir first message, the slot will be filled at the beginning of the form and the bot will not\\nask them for the cuisine again.\", \"Form Filling Intent(s)\": \"While the form is filling slots, it will not pay attention to which intent was predicted\\nunless a slot mapping explicitly requires or excludes an intent.\\n\\nFor the restaurant search example, the `outdoor_seating` slot is mapped to two intents,\\nso you need to add training data for these intents.\\n\\nFor the `cuisine` and `number` slots, no intent is specified, so you can add examples to a generic `inform` intent. You need\\nto annotate the `cuisine` entity so that DIETClassifier can\\nlearn to extract it. You don't need to annotate the `number` entity since DucklingEntityExtractor is a rule-based extractors\\nthat isn't trained on your training data. Only a few examples are shown for each intent;\\nfor your bot to work well, you should add more training data than is shown here:\\n\\n```\\nnlu:\\n- intent: affirm\\n examples: |\\n - Yes\\n - yes, please\\n - yup\\n- intent: deny\\n examples: |\\n - no don't\\n - no\\n - no I don't want that\\n\\n- intent: inform\\n examples: |\\n - [afghan](cuisine) food\\n - how bout [asian oriental](cuisine)\\n - what about [indian](cuisine) food\\n - uh how about [turkish](cuisine) type of food\\n - um [english](cuisine)\\n - im looking for [tuscan](cuisine) food\\n - id like [moroccan](cuisine) food\\n - for ten people\\n - 2 people\\n - for three people\\n - just one person\\n - book for seven people\\n - 2 please\\n - nine people\\n```\\n\\nUpdate your domain to include these intents:\\n\\n```\\nintents:\\n - request_restaurant\\n - affirm\\n - deny\\n - inform\\n```\"}, \"5. Defining the responses\": \"Add the responses that are sent after the form has been submitted:\\n\\n```\\nresponses:\\n utter_submit:\\n - text: \\\"All done!\\\"\\n utter_slots_values:\\n - text: \\\"I am going to run a restaurant search using the following parameters:\\\\n\\n - cuisine: {cuisine}\\\\n\\n - num_people: {num_people}\\\\n\\n - outdoor_seating: {outdoor_seating}\\\"\\n```\"}, \"Summary\": \"Forms can simplify the logic of collecting user\\ninformation. To define a minimal form like the restaurant search\\nexample above, this is a summary of what you'll need to do:\\n\\n['[ ] Add the RulePolicy to `config.yml`', '[ ] Define the form with required slots in the domain', '[ ] Add slot mappings for all required slots in the domain', '[ ] Add rules for activating and submitting the form', '[ ] Add examples for the intent(s) to activate your form', '[ ] Add examples for the intent(s) to fill the required slots', '[ ] Define an action or response for the bot to take when the form is completed', \\\"[ ] Update your domain with new intents and actions you've defined\\\"]\\n\\nTo try out your newly defined form, retrain the bot's model by running `rasa train` and start `rasa shell`.\\nBecause the DucklingEntityExtractor is being used to extract\\nentities, you'll need to start Duckling in the background as well\\n(see the [instructions for running Duckling](components.mdx#DucklingEntityExtractor)).\"}, \"metadata\": {\"id\": \"business-logic\", \"sidebar_label\": \"Handling Business Logic\", \"title\": \"Handling Business Logic\", \"abstract\": \"Conversational assistants often need to ask users for information in order to help them. You can use Forms to collect the required user information and fulfill a request.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}, {\"title\": \"Chitchat and FAQs\", \"description\": null, \"content\": {\"Step-by-step Guide on Using Response Selector for FAQs and Chitchat\": {\"1. Updating the configuration\": \"For FAQs and chitchat, you always want the assistant to respond the same way every time\\nthe same type of question is asked. [Rules](rules.mdx) allow you to do exactly that.\\nTo use rules, the you need to add the [RulePolicy](./policies.mdx#rule-policy) to your policies in your configuration file:\\n\\n```\\npolicies:\\n# other policies\\n- name: RulePolicy\\n```\\n\\nNext, include the ResponseSelector in your NLU pipeline in your configuration file.\\nThe ResponseSelector requires a featurizer and intent classifier to work, so\\nit should come after these components in your pipeline, for example:\\n\\n```\\npipeline:\\n - name: WhitespaceTokenizer\\n - name: RegexFeaturizer\\n - name: LexicalSyntacticFeaturizer\\n - name: CountVectorsFeaturizer\\n - name: CountVectorsFeaturizer\\n analyzer: char_wb\\n min_ngram: 1\\n max_ngram: 4\\n - name: DIETClassifier\\n epochs: 100\\n - name: EntitySynonymMapper\\n - name: ResponseSelector\\n epochs: 100\\n```\\n\\nBy default, the ResponseSelector will build a single retrieval model for all retrieval intents.\\nTo retrieve responses for FAQs and chitchat separately, use multiple ResponseSelector components\\nand specify the `retrieval_intent` key:\\n\\n```\\npipeline:\\n# Other components\\n- name: ResponseSelector\\n epochs: 100\\n retrieval_intent: faq\\n- name: ResponseSelector\\n epochs: 100\\n retrieval_intent: chitchat\\n```\", \"2. Defining Retrieval Intents and the ResponseSelector\": \"Consider an example where you have 20 different FAQs. Although each question is represented as an individual intent, all FAQ intents are handled the same way in the dialogue. For each FAQ intent, the assistant **retrieves** the proper response depending on which question has been asked.\\n\\nInstead of writing 20 rules, you can use a single action, e.g. `utter_faq` to handle all FAQs with a single rule by grouping them together under a single [retrieval intent](glossary.mdx#retrieval-intent)\\ncalled e.g. `faq`.\\n\\nThe single action uses the output of the\\n[ResponseSelector](./components.mdx#responseselector) to return\\nthe correct response for the specific FAQ that the user asked.\", \"3. Creating rules\": \"You need to write only one rule for each retrieval intent. All intents\\ngrouped under that retrieval intent will then be handled the same way.\\nThe action name starts with `utter_` and ends with the retrieval intent's name.\\nWrite rules for responding to FAQs and chitchat:\\n\\n```\\nrules:\\n - rule: respond to FAQs\\n steps:\\n - intent: faq\\n - action: utter_faq\\n - rule: respond to chitchat\\n steps:\\n - intent: chitchat\\n - action: utter_chitchat\\n```\\n\\nThe actions `utter_faq` and `utter_chitchat` will use the ResponseSelector's prediction to return the actual response message.\", \"4. Updating the NLU Training Data\": \"NLU training examples for the ResponseSelector look the same as\\nregular training examples, except that their names must refer to the retrieval\\nintent they are grouped under:\\n\\n```\\nnlu:\\n - intent: chitchat/ask_name\\n examples: |\\n - What is your name?\\n - May I know your name?\\n - What do people call you?\\n - Do you have a name for yourself?\\n - intent: chitchat/ask_weather\\n examples: |\\n - What's the weather like today?\\n - Does it look sunny outside today?\\n - Oh, do you mind checking the weather for me please?\\n - I like sunny days in Berlin.\\n```\\n\\nBe sure to update your domain file to include the added `chitchat` intent:\\n\\n```\\nintents:\\n# other intents\\n- chitchat\\n```\", \"5. Defining the responses\": \"Responses for the ResponseSelector follow the same naming convention as\\nretrieval intents. Besides this, they can have all the characteristics of\\nnormal bot [response](domain.mdx#responses). For the chitchat intents\\nlisted above, our responses could look like:\\n\\n```\\nresponses:\\n utter_chitchat/ask_name:\\n - image: \\\"https://i.imgur.com/zTvA58i.jpeg\\\"\\n text: Hello, my name is Retrieval Bot.\\n - text: I am called Retrieval Bot!\\n utter_chitchat/ask_weather:\\n - text: Oh, it does look sunny right now in Berlin.\\n image: \\\"https://i.imgur.com/vwv7aHN.png\\\"\\n - text: I am not sure of the whole week but I can see the sun is out today.\\n```\"}, \"Summary\": \"Once you've done the following, you can train your bot and try it out!\\n\\n['[ ] Add RulePolicy to your policies and ResponseSelector to your pipeline in `config.yml`', '[ ] Add at least one rule for responding to FAQs/chitchat', '[ ] Add examples for your FAQs/chitchat intents', '[ ] Add responses for your FAQs/chitchat intents', '[ ] Update the intents in your domain']\\n\\nNow, your assistant should be able to respond correctly and consistently to FAQs or chitchat, even if these interjections happen while your assistant is helping the user with another task.\"}, \"metadata\": {\"id\": \"chitchat-faqs\", \"sidebar_label\": \"Chitchat and FAQs\", \"title\": \"Chitchat and FAQs\", \"abstract\": \"FAQ assistants are the simplest assistants to build and typically the first kind of assistant anyone builds. This page is a guide to the concepts and training data you need to handle non-contextual questions like FAQs and chitchat.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 4]\"}, {\"title\": \"Command Line Interface\", \"description\": \"Command line interface for open source chatbot framework Rasa. Learn how to train, test and run your machine learning-based conversational AI assistants\", \"content\": {\"Cheat Sheet\": \"| Command | Effect |\\n|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------|\\n|`rasa init` |Creates a new project with example training data, actions, and config files. |\\n|`rasa train` |Trains a model using your NLU data and stories, saves trained model in `./models`. |\\n|`rasa interactive` |Starts an interactive learning session to create new training data by chatting to your assistant. |\\n|`rasa shell` |Loads your trained model and lets you talk to your assistant on the command line. |\\n|`rasa run` |Starts a server with your trained model. |\\n|`rasa run actions` |Starts an action server using the Rasa SDK. |\\n|`rasa visualize` |Generates a visual representation of your stories. |\\n|`rasa test` |Tests a trained Rasa model on any files starting with `test_`. |\\n|`rasa test e2e` |Runs end-to-end testing fully integrated with the action server that serves as acceptance testing. |\\n|`rasa data split nlu` |Performs a 80/20 split of your NLU training data. |\\n|`rasa data split stories` |Do the same as `rasa data split nlu`, but for your stories data. |\\n|`rasa data convert` |Converts training data between different formats. |\\n|`rasa data migrate` |Migrates 2.0 domain to 3.0 format. |\\n|`rasa data validate` |Checks the domain, NLU and conversation data for inconsistencies. |\\n|`rasa export` |Exports conversations from a tracker store to an event broker. |\\n|`rasa evaluate markers` |Extracts markers from an existing tracker store. |\\n|`rasa marker upload` |Upload marker configurations to Analytics Data Pipeline |\\n|`rasa license` |Display licensing information. |\\n|`rasa -h` |Shows all available commands. |\\n\\n:::note\\nIf you run into character encoding issues on Windows like: `UnicodeEncodeError: 'charmap' codec can't encode character ...` or\\nthe terminal is not displaying colored messages properly, prepend `winpty` to the command you would like to run.\\nFor example `winpty rasa init` instead of `rasa init`\\n:::\", \"Log Level\": \"Rasa produces log messages at several different levels (eg. warning, info, error and so on). You can control which level of logs you would like to see with `--verbose` (same as `-v`) or `--debug` (same as `-vv`) as optional command line arguments. See each command below for more explanation on what these arguments mean.\\n\\nIn addition to CLI arguments, several environment variables allow you to control log output in a more granular way. With these environment variables, you can configure log levels for messages created by external libraries such as Matplotlib, Pika, and Kafka. These variables follow [standard logging level in Python](https://docs.python.org/3/library/logging.html#logging-levels). Currently, following environment variables are supported:\\n\\n['LOG_LEVEL_LIBRARIES: This is the general environment variable to configure log level for the main libraries Rasa uses. It covers Tensorflow, `asyncio`, APScheduler, SocketIO, Matplotlib, RabbitMQ, Kafka.', 'LOG_LEVEL_MATPLOTLIB: This is the specialized environment variable to configure log level only for Matplotlib.', 'LOG_LEVEL_RABBITMQ: This is the specialized environment variable to configure log level only for AMQP libraries, at the moment it handles log levels from `aio_pika` and `aiormq`.', 'LOG_LEVEL_KAFKA: This is the specialized environment variable to configure log level only for kafka.', 'LOG_LEVEL_PRESIDIO: This is the specialized environment variable to configure log level only for Presidio, at the moment it handles log levels from `presidio_analyzer` and `presidio_anonymizer`.', 'LOG_LEVEL_FAKER: This is the specialized environment variable to configure log level only for Faker.']\\n\\nGeneral configuration (`LOG_LEVEL_LIBRARIES`) has less priority than library level specific configuration (`LOG_LEVEL_MATPLOTLIB`, `LOG_LEVEL_RABBITMQ` etc); and CLI parameter sets the lowest level log messages which will be handled. This means variables can be used together with a predictable result. As an example:\\n\\n```\\nLOG_LEVEL_LIBRARIES=ERROR LOG_LEVEL_MATPLOTLIB=WARNING LOG_LEVEL_KAFKA=DEBUG rasa shell --debug\\n```\\n\\nThe above command run will result in showing:\\n\\n['messages with `DEBUG` level and higher by default (due to `--debug`)', 'messages with `WARNING` level and higher for Matplotlib', 'messages with `DEBUG` level and higher for kafka', 'messages with `ERROR` level and higher for other libraries not configured']\\n\\nNote that CLI config sets the lowest level log messages to be handled, hence the following command will set the log level to `INFO` (due to `--verbose`) and no debug messages will be seen (library level configuration will not have any effect):\\n\\n```\\nLOG_LEVEL_LIBRARIES=DEBUG LOG_LEVEL_MATPLOTLIB=DEBUG rasa shell --verbose\\n```\\n\\nAs an aside, CLI log level sets the level at the root logger (which has the important handler - `coloredlogs` handler); this means even if an environment variable sets a library logger to a lower level, the root logger will reject messages from that library. If not specified, the CLI log level is set to `INFO`.\", \"Custom logging configuration\": \":::info New in 3.4\\n\\nThe Rasa CLI now includes a new argument `--logging-config-file` which accepts a YAML file as value.\\n\\n:::\\n\\nYou can now configure any logging formatters or handlers in a separate YAML file.\\nThe logging config YAML file must follow the [Python built-in dictionary schema](https://docs.python.org/3/library/logging.config.html#dictionary-schema-details), otherwise it will fail validation.\\nYou can pass this file as argument to the `--logging-config-file` CLI option and use it with any of the rasa commands.\", \"rasa init\": \"This command sets up a complete assistant for you with some example training data:\\n\\n```\\nrasa init\\n```\\n\\nIt creates the following files:\\n\\n```\\n.\\n\\u251c\\u2500\\u2500 actions\\n\\u2502 \\u251c\\u2500\\u2500 __init__.py\\n\\u2502 \\u2514\\u2500\\u2500 actions.py\\n\\u251c\\u2500\\u2500 config.yml\\n\\u251c\\u2500\\u2500 credentials.yml\\n\\u251c\\u2500\\u2500 data\\n\\u2502 \\u251c\\u2500\\u2500 nlu.yml\\n\\u2502 \\u2514\\u2500\\u2500 stories.yml\\n\\u251c\\u2500\\u2500 domain.yml\\n\\u251c\\u2500\\u2500 endpoints.yml\\n\\u251c\\u2500\\u2500 models\\n\\u2502 \\u2514\\u2500\\u2500 <timestamp>.tar.gz\\n\\u2514\\u2500\\u2500 tests\\n \\u2514\\u2500\\u2500 test_stories.yml\\n```\\n\\nIt will ask you if you want to train an initial model using this data.\\nIf you answer no, the `models` directory will be empty.\\n\\nAny of the default CLI commands will expect this project setup, so this is the\\nbest way to get started. You can run `rasa train`, `rasa shell` and `rasa test`\\nwithout any additional configuration.\", \"rasa train\": {\"Incremental training\": \":::info New in 2.2\\nThis feature is experimental.\\nWe introduce experimental features to get feedback from our community, so we encourage you to try it out!\\nHowever, the functionality might be changed or removed in the future.\\nIf you have feedback (positive or negative) please share it with us on the [Rasa Forum](https://forum.rasa.com).\\n\\n:::\\n\\nIn order to improve the performance of an assistant, it's helpful to practice [CDD](./conversation-driven-development.mdx)\\nand add new training examples based on how your users have talked to your assistant. You can use `rasa train --finetune`\\nto initialize the pipeline with an already trained model and further finetune it on the\\nnew training dataset that includes the additional training examples. This will help reduce the\\ntraining time of the new model.\\n\\nBy default, the command picks up the latest model in the `models/` directory. If you have a specific model\\nwhich you want to improve, you may specify the path to this by\\nrunning `rasa train --finetune <path to model to finetune>`. Finetuning a model usually\\nrequires fewer epochs to train machine learning components like `DIETClassifier`, `ResponseSelector` and `TEDPolicy` compared to training from scratch.\\nEither use a model configuration for finetuning\\nwhich defines fewer epochs than before or use the flag\\n`--epoch-fraction`. `--epoch-fraction` will use a fraction of the epochs specified for each machine learning component\\nin the model configuration file. For example, if `DIETClassifier` is configured to use 100 epochs,\\nspecifying `--epoch-fraction 0.5` will only use 50 epochs for finetuning.\\n\\nYou can also finetune an NLU-only or dialogue management-only model by using\\n`rasa train nlu --finetune` and `rasa train core --finetune` respectively.\\n\\nTo be able to fine tune a model, the following conditions must be met:\\n\\n['The configuration supplied should be exactly the same as the\\\\nconfiguration used to train the model which is being finetuned.\\\\nThe only parameter that you can change is `epochs` for the individual machine learning components and policies.', 'The set of labels(intents, actions, entities and slots) for which the base model is trained\\\\nshould be exactly the same as the ones present in the training data used for finetuning. This\\\\nmeans that you cannot add new intent, action, entity or slot labels to your training data\\\\nduring incremental training. You can still add new training examples for each of the existing\\\\nlabels. If you have added/removed labels in the training data, the pipeline needs to be trained\\\\nfrom scratch.', 'The model to be finetuned is trained with `MINIMUM_COMPATIBLE_VERSION` of the currently installed rasa version.']\"}, \"rasa interactive\": \"You can start an interactive learning session by running:\\n\\n```\\nrasa interactive\\n```\\n\\nThis will first train a model and then start an interactive shell session.\\nYou can then correct your assistants predictions as you talk to it.\\nIf [`UnexpecTEDIntentPolicy`](./policies.mdx#unexpected-intent-policy) is\\nincluded in the pipeline, [`action_unlikely_intent`](./default-actions.mdx#action_unlikely_intent)\\ncan be triggered at any conversation turn. Subsequently, the following message will be displayed:\\n\\n```\\n The bot wants to run 'action_unlikely_intent' to indicate that the last user message was unexpected\\n at this point in the conversation. Check out UnexpecTEDIntentPolicy docs to learn more.\\n```\\n\\nAs the message states, this is an indication that you have explored a conversation path\\nwhich is unexpected according to the current set of training stories and hence adding this\\npath to training stories is recommended. Like other bot actions, you can choose to confirm\\nor deny running this action.\\n\\nIf you provide a trained model using the `--model` argument, training is skipped\\nand that model will be loaded instead.\\n\\nDuring interactive learning, Rasa will plot the current conversation\\nand a few similar conversations from the training data to help you\\nkeep track of where you are. You can view the visualization\\nat http://localhost:5005/visualization.html\\nas soon as the session has started. This diagram can take some time to generate.\\nTo skip the visualization, run `rasa interactive --skip-visualization`.\\n\\n:::info Add the `assistant_id` key introduced in 3.5\\n\\nRunning interactive learning with a pre-trained model whose metadata does not include the `assistant_id`\\nwill exit with an error. If this happens, add the required key with a unique identifier value in `config.yml`\\nand re-run training.\\n\\n:::\\n\\nThe following arguments can be used to configure the interactive learning session:\\n\\n```\\n```\", \"rasa shell\": \"You can start a chat session by running:\\n\\n```\\nrasa shell\\n```\\n\\nBy default, this will load up the latest trained model.\\nYou can specify a different model to be loaded by using the `--model` flag.\\n\\nIf you start the shell with an NLU-only model, `rasa shell` will output the\\nintents and entities predicted for any message you enter.\\n\\nIf you have trained a combined Rasa model but only want to see what your model\\nextracts as intents and entities from text, you can use the command `rasa shell nlu`.\\n\\nTo increase the logging level for debugging, run:\\n\\n```\\nrasa shell --debug\\n```\\n\\n:::note\\nIn order to see the typical greetings and/or session start behavior you might see\\nin an external channel, you will need to explicitly send `/session_start`\\nas the first message. Otherwise, the session start behavior will begin as described in\\n[Session configuration](./domain.mdx#session-configuration).\\n:::\\n\\nThe following arguments can be used to configure the command.\\nMost arguments overlap with `rasa run`; see the [following section](#rasa-run) for more info on those arguments.\\n\\nNote that the `--connector` argument will always be set to `cmdline` when running `rasa shell`.\\nThis means all credentials in your credentials file will be ignored,\\nand if you provide your own value for the `--connector` argument it will also be ignored.\\n\\n```\\n```\", \"rasa run\": \"To start a server running your trained model, run:\\n\\n```\\nrasa run\\n```\\n\\nBy default the Rasa server uses HTTP for its communication. To secure the communication with\\nSSL and run the server on HTTPS, you need to provide a valid certificate and the corresponding\\nprivate key file. You can specify these files as part of the `rasa run` command.\\nIf you encrypted your keyfile with a password during creation,\\nyou need to add the `--ssl-password` as well.\\n\\n```\\nrasa run --ssl-certificate myssl.crt --ssl-keyfile myssl.key --ssl-password mypassword\\n```\\n\\nRasa by default listens on each available network interface. You can limit this to a specific\\nnetwork interface using the `-i` command line option.\\n\\n```\\nrasa run -i 192.168.69.150\\n```\\n\\nRasa will by default connect to all channels specified in your credentials file.\\nTo connect to a single channel and ignore all other channels in your credentials file,\\nspecify the name of the channel in the `--connector` argument.\\n\\n```\\nrasa run --connector rest\\n```\\n\\nThe name of the channel should match the name you specify in your credentials file.\\nFor supported channels see [the page about messaging and voice channels](./messaging-and-voice-channels.mdx).\\n\\nThe following arguments can be used to configure your Rasa server:\\n\\n```\\n```\\n\\nFor more information on the additional parameters, see [Model Storage](./model-storage.mdx).\\nSee the Rasa [HTTP API](./http-api.mdx) page for detailed documentation of all the endpoints.\", \"rasa run actions\": \"To start an action server with the Rasa SDK, run:\\n\\n```\\nrasa run actions\\n```\\n\\nThe following arguments can be used to adapt the server settings:\\n\\n```\\n```\", \"rasa visualize\": \"To generate a graph of your stories in the browser, run:\\n\\n```\\nrasa visualize\\n```\\n\\nIf your stories are located somewhere other than the default location `data/`,\\nyou can specify their location with the `--stories` flag.\\n\\nThe following arguments can be used to configure this command:\\n\\n```\\n```\", \"rasa test\": \"To evaluate a model on your test data, run:\\n\\n```\\nrasa test\\n```\\n\\nThis will test your latest trained model on any end-to-end stories you have\\ndefined in files with the `test_` prefix.\\nIf you want to use a different model, you can specify it using the `--model` flag.\\n\\nTo evaluate the dialogue and NLU\\nmodels separately, use the commands below:\\n\\n```\\nrasa test core\\n```\\n\\nand\\n\\n```\\nrasa test nlu\\n```\\n\\nYou can find more details on specific arguments for each testing type in\\n[Evaluating an NLU Model](./testing-your-assistant.mdx#evaluating-an-nlu-model) and\\n[Evaluating a Dialogue Management Model](./testing-your-assistant.mdx#evaluating-a-dialogue-model).\\n\\nThe following arguments are available for `rasa test`:\\n\\n```\\n```\", \"rasa test e2e\": \"<RasaProLabel />\\n\\n<RasaProBanner />\\n\\n:::info New in 3.5\\n\\nYou can now use end-to-end testing to test your assistant as a whole, including dialogue management and custom actions.\\n\\n:::\\n\\nTo run [end-to-end testing](./testing-your-assistant.mdx#end-to-end-testing) on your trained model, run:\\n\\n```\\nrasa test e2e\\n```\\n\\nThis will test your latest trained model on any end-to-end test cases you have.\\nIf you want to use a different model, you can specify it using the `--model` flag.\\n\\nThe following arguments are available for `rasa test e2e`:\\n\\n```\\nusage: rasa test e2e [-h] [-v] [-vv] [--quiet] [--logging-config-file LOGGING_CONFIG_FILE] [--fail-fast] [-o] [--remote-storage REMOTE_STORAGE] [-m MODEL] [--endpoints ENDPOINTS] [path-to-test-cases]\\n\\nRuns end-to-end testing.\\n\\noptional arguments:\\n -h, --help show this help message and exit\\n -o, --e2e-results Results file containing end-to-end testing summary. (default: None)\\n --remote-storage REMOTE_STORAGE\\n Set the remote location where your Rasa model is stored, e.g. on AWS. (default: None)\\n -m MODEL, --model MODEL\\n Path to a trained Rasa model. If a directory is specified, it will use the latest model in this directory. (default: models)\\n --endpoints ENDPOINTS\\n Configuration file for the model server and the connectors as a yml file. (default: endpoints.yml)\\n\\nPython Logging Options:\\n You can control level of log messages printed. In addition to these arguments, a more fine grained configuration can be achieved with environment variables. See online documentation for more info.\\n\\n -v, --verbose Be verbose. Sets logging level to INFO. (default: None)\\n -vv, --debug Print lots of debugging statements. Sets logging level to DEBUG. (default: None)\\n --quiet Be quiet! Sets logging level to WARNING. (default: None)\\n --logging-config-file LOGGING_CONFIG_FILE\\n If set, the name of the logging configuration file will be set to the given name. (default: None)\\n\\nTesting Settings:\\n path-to-test-cases Input file or folder containing end-to-end test cases. (default: tests/e2e_test_cases.yml)\\n --fail-fast Fail the test suite as soon as a unit test fails. (default: False)\\n```\", \"rasa data split\": \"To create a train-test split of your NLU training data, run:\\n\\n```\\nrasa data split nlu\\n```\\n\\nThis will create a 80/20 split of train/test data by default.\\nYou can specify the training data, the fraction, and the output directory using\\nthe following arguments:\\n\\n```\\n```\\n\\nIf you have NLG data for retrieval actions, this will be saved to separate files:\\n\\n```\\nls train_test_split\\n\\n nlg_test_data.yml test_data.yml\\n nlg_training_data.yml training_data.yml\\n```\\n\\nTo split your stories, you can use the following command:\\n\\n```\\nrasa data split stories\\n```\\n\\nIt has the same arguments as `split nlu` command, but loads yaml files with stories and perform random splitting.\\nDirectory `train_test_split` will contain all yaml files processed with prefixes `train_` or `test_` containing\\ntrain and test parts.\", \"rasa data convert nlu\": \"You can convert NLU data from\\n\\n['LUIS data format,', 'WIT data format,', 'Dialogflow data format, or', 'JSON']\\n\\nto\\n\\n['YAML or', 'JSON']\\n\\nYou can start the converter by running:\\n\\n```\\nrasa data convert nlu\\n```\\n\\nYou can specify the input file or directory, output file or directory, and the output format with the following arguments:\\n\\n```\\n```\", \"rasa data migrate\": \"The domain is the only data file whose format changed between 2.0 and 3.0.\\nYou can automatically migrate a 2.0 domain to the 3.0 format.\\n\\nYou can start the migration by running:\\n\\n```\\nrasa data migrate\\n```\\n\\nYou can specify the input file or directory and the output file or directory with the following arguments:\\n\\n```\\nrasa data migrate -d DOMAIN --out OUT_PATH\\n```\\n\\nIf no arguments are specified, the default domain path (`domain.yml`) will be used for both input and output files.\\n\\nThis command will also back-up your 2.0 domain file(s) into a different `original_domain.yml` file or\\ndirectory labeled `original_domain`.\\n\\nNote that the slots in the migrated domain will contain [mapping conditions](./domain.mdx#mapping-conditions) if these\\nslots are part of a form's `required_slots`.\\n\\n:::caution\\nExceptions will be raised and the migration process terminated if invalid domain files are provided or if they are\\nalready in the 3.0 format, if slots or forms are missing from your original files or if the slots or forms sections\\nare spread across multiple domain files.\\nThis is done to avoid duplication of migrated sections in your domain files.\\nPlease make sure all your slots' or forms' definitions are grouped into a single file.\\n\\n:::\\n\\nYou can learn more about this command by running:\\n\\n```\\nrasa data migrate --help\\n```\", \"rasa data validate\": \"You can check your domain, NLU data, or story data for mistakes and inconsistencies.\\nTo validate your data, run this command:\\n\\n```\\nrasa data validate\\n```\\n\\nThe validator searches for errors in the data, e.g. two intents that have some\\nidentical training examples.\\nThe validator also checks if you have any stories where different assistant actions follow from the same\\ndialogue history. Conflicts between stories will prevent a model from learning the correct\\npattern for a dialogue.\\n\\n:::info Searching for the `assistant_id` key introduced in 3.5\\n\\nThe validator will check whether the `assistant_id` key is present in the config file and will issue a warning if this\\nkey is missing or if the default value has not been changed.\\n\\n:::\\n\\nIf you pass a `max_history` value to one or more policies in your `config.yml` file, provide the\\nsmallest of those values in the validator command using the `--max-history <max_history>` flag.\\n\\nYou can also validate only the story structure by running this command:\\n\\n```\\nrasa data validate stories\\n```\\n\\n:::note\\nRunning `rasa data validate` does **not** test if your [rules](./rules.mdx) are consistent with your stories.\\nHowever, during training, the `RulePolicy` checks for conflicts between rules and stories. Any such conflict will abort training.\\n\\nAlso, if you use end-to-end stories, then this might not capture all conflicts. Specifically, if two user inputs\\nresult in different tokens yet exactly the same featurization, then conflicting actions after these inputs\\nmay exist but will not be reported by the tool.\\n:::\\n\\nTo interrupt validation even for minor issues such as unused intents or responses, use the `--fail-on-warnings` flag.\\n\\n:::caution check your story names\\nThe `rasa data validate stories` command assumes that all your story names are unique!\\n:::\\n\\nYou can use `rasa data validate` with additional arguments, e.g. to specify the location of your data and\\ndomain files:\\n\\n```\\n```\", \"rasa export\": \"To export events from a tracker store using an event broker, run:\\n\\n```\\nrasa export\\n```\\n\\nYou can specify the location of the environments file, the minimum and maximum\\ntimestamps of events that should be published, as well as the conversation IDs that\\nshould be published:\\n\\n```\\n```\\n\\n:::tip Import conversations into Rasa X/Enterprise\\nThis command is most commonly used to import old conversations into Rasa X/Enterprise to annotate\\nthem. Read more about [importing conversations into Rasa X/Enterprise](https://rasa.com/docs/rasa-enterprise/installation-and-setup/deploy#1-import-existing-conversations-from-rasa-open-source).\\n:::\", \"rasa evaluate markers\": \":::caution\\n\\nThis feature is currently experimental and might change or be removed in the future. Share your feedback in the forum to help us make it production-ready.\\n\\n:::\\n\\nThe following command applies the [markers](./markers.mdx) you defined in your marker configuration file,\\nto pre-existing dialogues stored in your [tracker store](./tracker-stores.mdx), and produces `.csv` files containing\\nthe extracted markers and summary statistics:\\n\\n```\\nrasa evaluate markers all extracted_markers.csv\\n```\\n\\nUse the following arguments to configure the marker extraction process:\\n\\n```\\nusage: rasa evaluate markers [-h] [-v] [-vv] [--quiet] [--config CONFIG] [--no-stats | --stats-file-prefix [STATS_FILE_PREFIX]] [--endpoints ENDPOINTS] [-d DOMAIN] output_filename {first_n,sample,all} ...\\n\\npositional arguments:\\n output_filename The filename to write the extracted markers to (CSV format).\\n {first_n,sample,all}\\n first_n Select trackers sequentially until N are taken.\\n sample Select trackers by sampling N.\\n all Select all trackers.\\n\\noptional arguments:\\n -h, --help show this help message and exit\\n --config CONFIG The config file(s) containing marker definitions. This can be a single YAML file, or a directory that contains several files with marker definitions in it. The content of these files will be read and\\n merged together. (default: markers.yml)\\n --no-stats Do not compute summary statistics. (default: True)\\n --stats-file-prefix [STATS_FILE_PREFIX]\\n The common file prefix of the files where we write out the compute statistics. More precisely, the file prefix must consist of a common path plus a common file prefix, to which suffixes `-overall.csv` and\\n `-per-session.csv` will be added automatically. (default: stats)\\n --endpoints ENDPOINTS\\n Configuration file for the tracker store as a yml file. (default: endpoints.yml)\\n -d DOMAIN, --domain DOMAIN\\n Domain specification. This can be a single YAML file, or a directory that contains several files with domain specifications in it. The content of these files will be read and merged together. (default:\\n domain.yml)\\n\\nPython Logging Options:\\n -v, --verbose Be verbose. Sets logging level to INFO. (default: None)\\n -vv, --debug Print lots of debugging statements. Sets logging level to DEBUG. (default: None)\\n --quiet Be quiet! Sets logging level to WARNING. (default: None)\\n```\", \"rasa markers upload\": \"<RasaProLabel />\\n\\n<RasaProBanner />\\n\\n:::info New in 3.6\\n\\nThis command is available from Rasa Pro 3.6.0 and requires [Rasa Analytics Data Pipeline](./monitoring/analytics/getting-started-with-analytics.mdx)\\n:::\\n\\nThis command applies to [markers](./markers.mdx) and their [real-time processing](./monitoring/analytics/realtime-markers.mdx).\\nRunning this command validates the marker configuration file against the domain file and uploads the configuration to Analytics Data Pipeline\\n\\n```\\nusage: rasa markers upload [-h] [-v] [-vv] [--quiet]\\n [--logging-config-file LOGGING_CONFIG_FILE]\\n [--config CONFIG]\\n [--rasa-pro-services-url RASA_PRO_SERVICES_URL]\\n [-d DOMAIN]\\n\\noptional arguments:\\n -h, --help show this help message and exit\\n --config CONFIG The marker configuration file(s) containing marker\\n definitions. This can be a single YAML file, or a\\n directory that contains several files with marker\\n definitions in it. The content of these files will be\\n read and merged together. (default: markers.yml)\\n --rasa-pro-services-url RASA_PRO_SERVICES_URL\\n The URL of the Rasa Pro Services instance to upload\\n markers to.Specified URL should not contain a trailing\\n slash. (default: )\\n -d DOMAIN, --domain DOMAIN\\n Domain specification. This can be a single YAML file,\\n or a directory that contains several files with domain\\n specifications in it. The content of these files will\\n be read and merged together. (default: domain.yml)\\n\\nPython Logging Options:\\n You can control level of log messages printed. In addition to these\\n arguments, a more fine grained configuration can be achieved with\\n environment variables. See online documentation for more info.\\n\\n -v, --verbose Be verbose. Sets logging level to INFO. (default:\\n None)\\n -vv, --debug Print lots of debugging statements. Sets logging level\\n to DEBUG. (default: None)\\n --quiet Be quiet! Sets logging level to WARNING. (default:\\n None)\\n --logging-config-file LOGGING_CONFIG_FILE\\n If set, the name of the logging configuration file\\n will be set to the given name. (default: None)\\n\\nDescription:\\n The `rasa markers upload` command allows you to upload markers to the Rasa Pro Services. Markers are custom conversational events that provide additional context for analysis and insights generation. By uploading markers, you can enable real-time analysis and enhance the performance of your Rasa Assistant.\\n\\nExamples:\\n Upload Markers to Rasa Pro Services:\\n rasa markers upload --config markers.yml --rasa-pro-services-url https://example.com/rasa-pro -d domain.yml\\n\\n```\", \"rasa license\": \"<RasaProLabel />\\n\\n<RasaProBanner />\\n\\n:::info New in 3.3\\n\\nThis command was introduced.\\n:::\\n\\nUse `rasa license` to display information about licensing in Rasa Pro, especially information about\\n3rd party dependencies licenses.\\n\\nHere is the list of all possible arguments:\\n\\n```\\nusage: rasa license [-h] [-v] [-vv] [--quiet] [--logging-config-file LOGGING_CONFIG_FILE]\\n\\nDisplay licensing information.\\n\\noptions:\\n -h, --help show this help message and exit\\n\\nPython Logging Options:\\n You can control level of log messages printed. In addition to these arguments, a more fine grained configuration can be achieved with environment variables. See online documentation for more info.\\n\\n -v, --verbose Be verbose. Sets logging level to INFO. (default: None)\\n -vv, --debug Print lots of debugging statements. Sets logging level to DEBUG. (default: None)\\n --quiet Be quiet! Sets logging level to WARNING. (default: None)\\n --logging-config-file LOGGING_CONFIG_FILE\\n If set, the name of the logging configuration file will be set to the given name. (default: None)\\n```\"}, \"metadata\": {\"id\": \"command-line-interface\", \"sidebar_label\": \"Command Line Interface\", \"title\": \"Command Line Interface\", \"description\": \"Command line interface for open source chatbot framework Rasa. Learn how to train, test and run your machine learning-based conversational AI assistants\", \"abstract\": \"The command line interface (CLI) gives you easy-to-remember commands for common tasks. This page describes the behavior of the commands and the parameters you can pass to them.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 5]\"}, {\"title\": \"Compatibility Matrix\", \"description\": \"Information about compatibility between Rasa Pro Services and Rasa Plus.\\n\", \"content\": {\"root\": [\"When choosing a version of Rasa Pro Services to [deploy](./deploy/deploy-rasa-pro-services.mdx), you can refer to the\\ntable below to see which one is compatible with your installation of Rasa Plus.\", \"Rasa Pro Services version is independent of Rasa Plus version, except that they share the same major version number.\", \"| Rasa Pro Services | Rasa Plus |\\n|------------------:|--------------------:|\\n| 3.0.x | 3.3.x, 3.4.x, 3.5.x |\\n| 3.1.x | 3.6.x |\"]}, \"metadata\": {\"id\": \"compatibility-matrix\", \"sidebar_label\": \"Compatibility Matrix\", \"title\": \"Compatibility Matrix\", \"description\": \"Information about compatibility between Rasa Pro Services and Rasa Plus.\\n\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 6]\"}, {\"title\": \"Components\", \"description\": null, \"content\": {\"Language Models\": {\"MitieNLP\": [\"**Short**\", \"MITIE initializer\"], \"SpacyNLP\": [\"**Short**\", \"spaCy language initializer\"]}, \"Tokenizers\": {\"WhitespaceTokenizer\": [\"**Short**\", \"Tokenizer using whitespaces as a separator\"], \"JiebaTokenizer\": [\"**Short**\", \"Tokenizer using Jieba for Chinese language\"], \"MitieTokenizer\": [\"**Short**\", \"Tokenizer using MITIE\"], \"SpacyTokenizer\": [\"**Short**\", \"Tokenizer using spaCy\"]}, \"Featurizers\": {\"MitieFeaturizer\": [\"**Short**\", \"Creates a vector representation of user message and response (if specified) using the MITIE featurizer.\"], \"SpacyFeaturizer\": [\"**Short**\", \"Creates a vector representation of user message and response (if specified) using the spaCy featurizer.\"], \"ConveRTFeaturizer\": [\"**Short**\", \"Creates a vector representation of user message and response (if specified) using\\n[ConveRT](https://github.com/PolyAI-LDN/polyai-models) model.\"], \"LanguageModelFeaturizer\": [\"**Short**\", \"Creates a vector representation of user message and response (if specified) using a pre-trained language model.\"], \"RegexFeaturizer\": [\"**Short**\", \"Creates a vector representation of user message using regular expressions.\"], \"CountVectorsFeaturizer\": [\"**Short**\", \"Creates bag-of-words representation of user messages, intents, and responses.\"], \"LexicalSyntacticFeaturizer\": [\"**Short**\", \"Creates lexical and syntactic features for a user message to support entity extraction.\"]}, \"Intent Classifiers\": {\"MitieIntentClassifier\": [\"**Short**\", \"MITIE intent classifier (using a\\n[text categorizer](https://github.com/mit-nlp/MITIE/blob/master/examples/python/text_categorizer_pure_model.py))\"], \"LogisticRegressionClassifier\": [\"**Short**\", \"Logistic regression intent classifier, using the [scikit-learn implementation](https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html).\"], \"SklearnIntentClassifier\": [\"**Short**\", \"Sklearn intent classifier\"], \"KeywordIntentClassifier\": [\"**Short**\", \"Simple keyword matching intent classifier, intended for small, short-term projects.\"], \"DIETClassifier\": [\"**Short**\", \"Dual Intent Entity Transformer (DIET) used for intent classification and entity extraction\"], \"FallbackClassifier\": [\"**Short**\", \"Classifies a message with the intent `nlu_fallback` if the NLU intent classification\\nscores are ambiguous. The confidence is set to be the same as the `fallback threshold`.\", \"**Outputs**\", \"`entities`, `intent` and `intent_ranking`\", \"**Requires**\", \"`intent` and `intent_ranking` output from a previous intent classifier\", \"**Output-Example**\", \"```\\n\\n {\\n \\\"intent\\\": {\\\"name\\\": \\\"nlu_fallback\\\", \\\"confidence\\\": 0.7183846840434321},\\n \\\"intent_ranking\\\": [\\n {\\n \\\"confidence\\\": 0.7183846840434321,\\n \\\"name\\\": \\\"nlu_fallback\\\"\\n },\\n {\\n \\\"confidence\\\": 0.28161531595656784,\\n \\\"name\\\": \\\"restaurant_search\\\"\\n }\\n ],\\n \\\"entities\\\": [{\\n \\\"end\\\": 53,\\n \\\"entity\\\": \\\"time\\\",\\n \\\"start\\\": 48,\\n \\\"value\\\": \\\"2017-04-10T00:00:00.000+02:00\\\",\\n \\\"confidence\\\": 1.0,\\n \\\"extractor\\\": \\\"DIETClassifier\\\"\\n }]\\n }\\n```\", \"**Description**\", \"The `FallbackClassifier` classifies a user message with the intent `nlu_fallback`\\nin case the previous intent classifier wasn't\\nable to classify an intent with a confidence greater or equal than the `threshold`\\nof the `FallbackClassifier`. It can also predict the fallback intent in the\\ncase when the confidence scores of the two top ranked intents are closer than the the\\n`ambiguity_threshold`.\", \"You can use the `FallbackClassifier` to implement a\\n[Fallback Action](./fallback-handoff.mdx#fallbacks) which handles message with uncertain\\nNLU predictions.\", \"```\\nrules:\\n\\n- rule: Ask the user to rephrase in case of low NLU confidence\\n steps:\\n - intent: nlu_fallback\\n - action: utter_please_rephrase\\n```\", \"**Configuration**\", \"The `FallbackClassifier` will only add its prediction for the `nlu_fallback`\\nintent in case no other intent was predicted with a confidence greater or equal\\nthan `threshold`.\", [\"`threshold`:\\nThis parameter sets the threshold for predicting the `nlu_fallback` intent.\\nIf no intent predicted by a previous\\nintent classifier has a confidence\\nlevel greater or equal than `threshold` the `FallbackClassifier` will add\\na prediction of the `nlu_fallback` intent with a confidence `1.0`.\", \"`ambiguity_threshold`: If you configure an `ambiguity_threshold`, the\\n`FallbackClassifier` will also predict the `nlu_fallback` intent in case\\nthe difference of the confidence scores for the two highest ranked intents is\\nsmaller than the `ambiguity_threshold`.\"]]}, \"Entity Extractors\": {\"MitieEntityExtractor\": [\"**Short**\", \"MITIE entity extraction (using a [MITIE NER trainer](https://github.com/mit-nlp/MITIE/blob/master/mitielib/src/ner_trainer.cpp))\"], \"SpacyEntityExtractor\": [\"**Short**\", \"spaCy entity extraction\"], \"CRFEntityExtractor\": [\"**Short**\", \"Conditional random field (CRF) entity extraction\"], \"DucklingEntityExtractor\": [\"**Short**\", \"Duckling lets you extract common entities like dates,\\namounts of money, distances, and others in a number of languages.\"], \"DIETClassifier\": [\"**Short**\", \"Dual Intent Entity Transformer (DIET) used for intent classification and entity extraction\"], \"RegexEntityExtractor\": [\"**Short**\", \"Extracts entities using the lookup tables and/or regexes defined in the training data\"], \"EntitySynonymMapper\": [\"**Short**\", \"Maps synonymous entity values to the same value.\"]}, \"Combined Intent Classifiers and Entity Extractors\": {\"DIETClassifier\": [\"**Short**\", \"Dual Intent Entity Transformer (DIET) used for intent classification and entity extraction\"]}, \"Selectors\": {\"ResponseSelector\": [\"**Short**\", \"Response Selector\"]}, \"Custom Components\": \":::info New in 3.0\\nRasa 3.0 unified the implementation of NLU components and policies.\\nThis requires changes to custom components written for earlier versions of Rasa Open\\nSource. Please see the\\n[migration guide](migration-guide.mdx#custom-policies-and-custom-components) for a\\nstep-by-step guide for the migration.\\n\\n:::\\n\\nYou can create a custom component to perform a specific task which NLU doesn't currently offer (for example, sentiment analysis).\\n\\nYou can add a custom component to your pipeline by adding the module path.\\nSo if you have a module called `sentiment`\\ncontaining a `SentimentAnalyzer` class:\\n\\n```\\npipeline:\\n- name: \\\"sentiment.SentimentAnalyzer\\\"\\n```\\n\\nSee the [guide on custom graph components](custom-graph-components.mdx) for a complete guide on custom components.\\nAlso be sure to read the section on the [Component Lifecycle](./tuning-your-model.mdx#component-lifecycle).\"}, \"metadata\": {\"id\": \"components\", \"sidebar_label\": \"Pipeline Components\", \"title\": \"Components\", \"abstract\": \"Components make up your NLU pipeline and work sequentially to process user input into structured output. There are components for entity extraction, for intent classification, response selection, pre-processing, and more.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 7]\"}, {\"title\": \"Contextual Conversations\", \"description\": null, \"content\": {\"Step-by-step Guide on Creating Contextual Conversation Patterns\": {\"1. Defining Slots\": \"[Slots](domain.mdx#slots) are your assistant's memory. Slots store pieces of information that your\\nassistant needs to refer to later and can direct the flow of the conversation\\nbased on `slot_was_set` events. There are different [types of slots](domain.mdx#slot-types),\\nand each affects the conversation flow in its own way.\\n\\nIn the concert bot example, the `likes_music` slot is a boolean slot. If it is true, the bot sends an intro message. If it is false, the bot sends a different message.\\nYou define a slot and its type in the domain:\\n\\n```\\nslots:\\n likes_music:\\n type: bool\\n mappings:\\n - type: custom\\n```\", \"2. Creating Stories\": \"[Stories](./stories.mdx) are examples of how conversations should go.\\nIn the example above, the concert bot responds differently for users who like music\\nand users who don't because of these two stories:\\n\\n```\\nstories:\\n - story: User likes music\\n steps:\\n - intent: how_to_get_started\\n - action: utter_get_started\\n - intent: affirm\\n - action: action_set_music_preference\\n - slot_was_set:\\n - likes_music: True\\n - action: utter_awesome\\n\\n - story: User doesn't like music\\n steps:\\n - intent: how_to_get_started\\n - action: utter_get_started\\n - intent: deny\\n - action: action_set_music_preference\\n - slot_was_set:\\n - likes_music: False\\n - action: utter_goodbye\\n```\\n\\nThese stories diverge based on the user's intent (`affirm` or `deny`). Based on\\nthe user's intent, a custom action sets a slot that further directs\\nthe conversation.\", \"3. Configuring the TEDPolicy\": {\"Setting `max_history`\": \"Usually, only a certain amount of context is relevant to your assistant.\\n[`max_history`](policies.mdx#max-history) is a hyperparameter for Rasa dialogue management policies\\nthat controls how many steps in a dialogue the model looks at to decide which\\naction to take next.\\n\\nIn the story below, the user asks for help three times in a row. The first two times,\\nthe bot sends the same message, but the third time, it hands them off to a human\\n\\n```\\nstories:\\n - story: user persists in asking for help\\n steps:\\n - intent: help\\n - action: utter_help\\n - intent: help\\n - action: utter_help\\n - intent: help\\n - action: action_human_handoff\\n```\\n\\nIn order for the model to learn this pattern, it needs to know at least the previous\\nfour steps i.e. `max_history` of four. If `max_history` were 3, the model would not have\\nenough context to see that the user had already sent two help requests, and would never\\npredict the human handoff action.\\n\\nYou can set the `max_history` by passing it to your policy's settings\\nin your config file, for example:\\n\\n```\\npolicies:\\n - name: \\\"TEDPolicy\\\"\\n max_history: 5\\n```\\n\\nYou want to make sure `max_history` is set high enough\\nto account for the most context your assistant will need to make an accurate\\nprediction about what to do next.\\nFor more details see the docs on [featurizers](policies.mdx#featurizers).\"}}, \"Summary\": \"Here's a summary of the concepts you can apply to enable your assistant to have contextual conversations:\\n\\n['[ ] Write stories for contextual conversations', '[ ] Use slots to store contextual information for later use', '[ ] Set the `max_history` for your policies appropriately for the amount of context your bot needs', '[ ] Use the TEDPolicy for generalization to unseen conversation paths']\"}, \"metadata\": {\"id\": \"contextual-conversations\", \"sidebar_label\": \"Contextual Conversations\", \"title\": \"Contextual Conversations\", \"abstract\": \"Taking context into account is often key to providing a good user experience. This page is a guide to creating contextual conversation patterns.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 8]\"}, {\"title\": \"Conversation-Driven Development\", \"description\": \"Find out about best practices for conversational AI using Conversation-Driven Development.\", \"content\": {\"What is CDD?\": \"Conversation-Driven Development (CDD) is the process of listening to your users and using those insights to improve your AI assistant. It is the overarching best practice approach for chatbot development.\\n\\nDeveloping great AI assistants is challenging because users will always say something you didn't anticipate. The principle behind CDD is that in every conversation users are telling you\\u2014in their own words\\u2014exactly what they want. By practicing CDD at every stage of bot development, you orient your assistant towards real user language and behavior.\\n\\nCDD includes the following actions:\\n\\n['**Share** your assistant with users as soon as possible', '**Review** conversations on a regular basis', '**Annotate** messages and use them as NLU training data', '**Test** that your assistant always behaves as you expect', '**Track** when your assistant fails and measure its performance over time', '**Fix** how your assistant handles unsuccessful conversations']\\n\\nCDD is not a linear process; you'll circle back to the same actions over and over as you develop and improve your bot.\\n\\nRead more about these actions and the concept of CDD on the [Rasa Blog](https://blog.rasa.com/conversation-driven-development-a-better-approach-to-building-ai-assistants/).\\n\\nYou can also check out [Rasa X/Enterprise](https://rasa.com/docs/rasa-enterprise/), a purpose-built tool for CDD.\", \"CDD in early stages of development\": \"If you're at the earliest stage of bot development, it might seem like CDD has no role to play - after all, you have no conversations yet! However, there are CDD actions you can take at the very beginning of bot development:\\n\\n['See the best practices for [NLU data](generating-nlu-data.mdx) and [Stories](writing-stories.mdx) for details on creating training data with CDD in mind.', 'Give your bot to test users early on.', 'CDD is all about listening to your users, so the earlier you find some, the better.', \\\"Test users can be anyone who doesn't already know how your bot works from the inside. People on the bot development team should not be test users, since they know exactly what the bot can and can't do. Don't overinstruct your test users; they should have only as much knowledge of the bot's domain as your end users will have.\\\", 'Set up a CI/CD pipeline.', 'CDD leads to frequent, smaller updates to your bot as you gather insights from bot conversations. [Setting up a CI/CD pipeline](setting-up-ci-cd.mdx) early on in development will enable you to act quickly on what you see in conversations.']\", \"CDD with a bot in production\": {\"Review\": \"Look in conversations for what users are really asking for.\\n\\nYour test users had at least some instruction about what the bot was intended to do; real users often either have no idea, or ignore instructions given to them. You can't cater to every unexpected user behavior, but you can try to address the main friction points you notice. Here are some things you could consider looking for:\\n\\n['Look at conversations where an \\u201cout_of_scope\\u201d intent or fallback behavior occurred. These could indicate a potential new skill, or just a misclassified user utterance.', 'Look for user frustration, such as requests for transfer to a human.', 'If the assistant was trained with [`UnexpecTEDIntentPolicy`](./policies.mdx#unexpected-intent-policy) included in the pipeline,\\\\nyou can look for conversations where `action_unlikely_intent` is predicted at any conversation turn.\\\\nAn `action_unlikely_intent` is predicted when the last intent expressed by the user is\\\\nunexpected in the current conversation context. You can also filter out such conversations by\\\\nrunning a [standalone script](https://gist.github.com/alwx/b426b7b573ff963c85c65ea6466528d7) which does the following:', ['Fetch real conversations from a tracker store.', 'Run `rasa test` on the fetched conversations and filter conversations containing `action_unlikely_intent`\\\\nin a separate warnings file. You can read more on [how to interpret these warnings](./testing-your-assistant.mdx#interpreting-the-generated-warnings).'], 'Reviewing this subset of conversations can help you understand if real users have taken a\\\\nconversation path which is not present in the training data and hence \\\"surprising\\\"\\\\nfor machine learning policies like `TEDPolicy`. Adding these conversation paths (with potential\\\\ncorrections if `TEDPolicy` subsequently failed) as training stories will result in more robust action prediction\\\\nby policies such as `TEDPolicy`. Users are encouraged to [adjust the `tolerance` parameter of\\\\n`UnexpecTEDIntentPolicy`](./policies.mdx#tuning-the-tolerance-parameter) to control how\\\\n\\\"surprising\\\" a conversation should be to be included in the warnings file.']\", \"Annotate\": \"Continue to follow [best practices for NLU](generating-nlu-data.mdx) as you add new user utterances from real conversations to your training data. Be careful not to overfit your NLU model to utterances like those already in your training data. This can happen when you continuously add user utterances that were already predicted correctly and with high confidence to your training data. To avoid overfitting and help your model generalize to more diverse user utterances, add only user utterances that the model previously predicted incorrectly or with low confidence.\", \"Test\": \"Add successful user conversations to your [test conversations](testing-your-assistant.mdx). Doing this consistently will help ensure you don't introduce regressions as you make other fixes to your bot.\", \"Track\": \"Look for clues to success and failure to help you track your bot's performance.\\n\\nSome metrics are external to your bot. For example, if you are building a bot to relieve demand on a customer service call center, one metric for success could be the reduction in traffic to the call center. Others you can get directly from conversations, such as whether a user reaches a certain action that represents achieving the user goal.\\n\\nAutomatically tracked metrics are by nature proxy metrics; the only way to get a true measure of success would be to individually review and rate every single conversation with your bot. While this clearly isn't realistic, just keep in mind that no metric is a perfect representation of your bot's performance, so don't rely only on metrics to see where your bot needs improvement.\", \"Fix\": \"Continue to follow [best practices for Stories](writing-stories.mdx) as you expand and improve your bot's skills. Let user demand guide which skills you add and which fixes you make. Make smaller changes frequently rather than making big changes only once in a while. This will help you gauge the effectiveness of changes you're making, since you'll get user feedback more frequently. Your [CI/CD pipeline](setting-up-ci-cd.mdx) should allow you to do so with confidence.\"}}, \"metadata\": {\"id\": \"conversation-driven-development\", \"sidebar_label\": \"Conversation-Driven Development\", \"title\": \"Conversation-Driven Development\", \"description\": \"Find out about best practices for conversational AI using Conversation-Driven Development.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 9]\"}, {\"title\": \"Custom Actions\", \"description\": null, \"content\": {\"root\": [\"For details on how to implement a custom action, see the [SDK documentation](./action-server/running-action-server.mdx).\\nAny custom action that you want to use in your stories should be added into the\\nactions section of your [domain](./domain.mdx).\", \"When the dialogue engine predicts a custom action to be executed, it will call\\nthe action server, with the following information:\", \"```\\n{\\n \\\"next_action\\\": \\\"string\\\",\\n \\\"sender_id\\\": \\\"string\\\",\\n \\\"tracker\\\": {\\n \\\"conversation_id\\\": \\\"default\\\",\\n \\\"slots\\\": {},\\n \\\"latest_message\\\": {},\\n \\\"latest_event_time\\\": 1537645578.314389,\\n \\\"followup_action\\\": \\\"string\\\",\\n \\\"paused\\\": false,\\n \\\"events\\\": [],\\n \\\"latest_input_channel\\\": \\\"rest\\\",\\n \\\"active_loop\\\": {},\\n \\\"latest_action\\\": {}\\n },\\n \\\"domain\\\": {\\n \\\"config\\\": {},\\n \\\"session_config\\\": {},\\n \\\"intents\\\": [],\\n \\\"entities\\\": [],\\n \\\"slots\\\": {},\\n \\\"responses\\\": {},\\n \\\"actions\\\": [],\\n \\\"forms\\\": {},\\n \\\"e2e_actions\\\": []\\n },\\n \\\"version\\\": \\\"version\\\"\\n}\\n```\", \"Your action server should respond with a list of events and responses:\", \"```\\n{\\n \\\"events\\\": [{}],\\n \\\"responses\\\": [{}]\\n}\\n```\"]}, \"metadata\": {\"id\": \"custom-actions\", \"sidebar_label\": \"Custom Actions\", \"title\": \"Custom Actions\", \"abstract\": \"A custom action can run any code you want, including API calls, database queries etc. They can turn on the lights, add an event to a calendar, check a user's bank balance, or anything else you can imagine.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 10]\"}, {\"title\": \"Custom Graph Components\", \"description\": null, \"content\": {\"Graph Components\": \"Rasa uses the passed in [model configuration](model-configuration.mdx) to build a\\n[directed acyclic graph](https://en.wikipedia.org/wiki/Directed_acyclic_graph).\\nThis graph describes the dependencies between the items in your model configuration and\\nhow data flows between them. This has two major benefits:\\n\\n['Rasa can use the computational graph to optimize the execution of your\\\\nmodel. Examples for this are efficient caching of training steps or executing\\\\nindependent steps in parallel.', 'Rasa can represent different model architectures flexibly. As long as the\\\\ngraph remains acyclic Rasa can in theory pass any data to any graph\\\\ncomponent based on the model configuration without having to tie the underlying\\\\nsoftware architecture to the used model architecture.']\\n\\nWhen translating the model configuration to the computational graph\\n[policies](policies.mdx) and [NLU components](components.mdx) become nodes within this graph.\\nWhile there is a distinction between policies and NLU components in your model\\nconfiguration, the distinction is abstracted away when they are placed within the graph.\\nAt this point policies and NLU components become abstract *graph components*.\\nIn practice this is represented by the\\n[`GraphComponent`](custom-graph-components.mdx#the-graphcomponent-interface)\\ninterface: Both policies and NLU components have to inherit from this interface to\\nbecome compatible and executable for Rasa's graph.\\n\\n<div align=\\\"center\\\">\\n <img alt=\\\"Visualization of the Rasa Graph Architecture\\\" src={useBaseUrl(\\\"/img/graph_architecture.png\\\")} width=\\\"100%\\\" />\\n</div>\", \"Getting Started\": \"Before you get started, you have to decide whether you want to implement a custom\\n[NLU component](components.mdx) or a [policy](policies.mdx). If you are implementing\\na custom policy, then we recommend extending the existing\\n`rasa.core.policies.policy.Policy` class which already implements the `GraphComponent`\\ninterface.\\n\\n```\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.engine.recipes.default_recipe import DefaultV1Recipe\\n\\n# TODO: Correctly register your graph component\\n@DefaultV1Recipe.register(\\n [DefaultV1Recipe.ComponentType.POLICY_WITHOUT_END_TO_END_SUPPORT], is_trainable=True\\n)\\nclass MyPolicy(Policy):\\n ...\\n```\\n\\nIf you want to implement a custom NLU component then start out with the following\\nskeleton:\\n\\n```\\n```\\n\\nRead the following sections to find out how to solve the `TODO`s in the example above\\nand what other methods need to be implemented in your custom component.\\n\\n:::note custom tokenizers\\nIf you create a custom tokenizer, you should extend the\\n`rasa.nlu.tokenizers.tokenizer.Tokenizer` class. The `train` and `process` methods are\\nalready implemented so you only need to overwrite the `tokenize` method.\\n\\n:::\", \"The `GraphComponent` interface\": {\"`create`\": \"The `create` method is used to instantiate your graph component during training and has to be\\noverridden. Rasa passes the following parameters when calling the method:\\n\\n[\\\"`config`: This is your component's default configuration merged with the\\\\nconfiguration provided to the graph component in the model configuration file.\\\", '`model_storage`: You can use this to persist and load your graph component. See the\\\\n[model persistence](#model-persistence) section for further details on its usage.', '`resource`: The unique identifier of your component within the `model_storage`.\\\\nSee the [model persistence](#model-persistence) section for further\\\\ndetails on its usage.', '`execution_context`: This provides additional information about the current\\\\nmode of execution:', ['`model_id`: A unique identifier for the model used during inference. This\\\\nparameter is `None` during training.', \\\"`should_add_diagnostic_data`: If `True` then additional diagnostic metadata\\\\nshould be added to your graph component's predictions on top of the actual prediction.\\\", '`is_finetuning`: If `True` then the graph component can be trained using\\\\n[finetuning](command-line-interface.mdx#incremental-training).', '`graph_schema`: The `graph_schema` describes the computational graph which is used\\\\nto train your assistant or to make predictions with it.', '`node_name`: The `node_name` is a unique identifier for the step in the graph\\\\nschema which is fulfilled by the called graph component']]\", \"`load`\": \"The `load` method is used to instantiate your graph component during inference. The default\\nimplementation of this method calls your `create` method. It is recommended to override\\nthis if your graph component\\n[persists data as part of the training](#model-persistence).\\nSee [`create`](#create) for a description of the individual parameters.\", \"`get_default_config`\": \"The method `get_default_config` returns the default configuration for your graph\\ncomponent. Its default implementation returns an empty dictionary which implies that\\nthe graph component\\ndoes not have any configuration. Rasa will update the default configuration with the given\\nin the configuration file at runtime.\", \"`supported_languages`\": \"The method `supported_languages` specifies which\\n[languages](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)\\na graph component supports.\\nRasa will use the `language` key in the model configuration file to\\nvalidate that the graph component is valid for usage with the specified language.\\nIf a graph component returns `None` (this is the default implementation), it indicates\\nthat the graph component supports all languages which are not part of\\n`not_supported_languages`.\\n\\nExamples:\\n\\n['`[]`: The graph component does not support any language', '`None`: All languages are supported expect the languages defined in\\\\n`not_supported_languages`', '`[\\\"en\\\"]`: The graph component can only be used with English conversations.']\", \"`not_supported_languages`\": \"The method `not_supported_languages` specifies which [languages](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) your\\ngraph component does not support. Rasa will use the `language` key in the\\nmodel configuration file to validate that your graph component is valid for usage with\\nthe specified language. If your graph component returns `None` (this is the default\\nimplementation), you indicate that it supports all languages which are specified in\\n`supported_languages`.\\n\\nExamples:\\n\\n['`None` or `[]`: All languages specified in `supported_languages` are supported.', '`[\\\"en\\\"]`: The graph component can be used with any language except English.']\", \"`required_packages`\": \"The `required_packages` method indicates which extra Python packages need to\\nbe installed to use this graph component. Rasa will raise an error\\nduring execution if the required libraries are not found at runtime. By default, this method returns an empty list which implies that your graph\\ncomponent does not have any extra dependencies.\\n\\nExamples:\\n\\n['`[]`: No extra packages are required to use this graph component', '`[\\\"spacy\\\"]`: The Python package `spacy` needs to be installed to use\\\\nthis graph component.']\"}, \"Model Persistence\": {\"Writing to the Model Storage\": \"The snippet below illustrates how to write your graph component's data to the model\\nstorage.\\nTo persist your graph component after training, the `train` method will need to access\\nto the values of `model_storage` and `resource`. Therefore, you should store the values\\nof `model_storage` and `resource` at initialization time.\\n\\nYour graph component's train method must return the value of `resource` so that Rasa can cache\\nthe training results between trainings.\\nThe `self._model_storage.write_to(self._resource)` context manager provides a path to\\na directory where you can persist any data required by your\\ngraph component.\\n\\n```\\nfrom __future__ import annotations\\nimport json\\nfrom typing import Optional, Dict, Any, Text\\n\\nfrom rasa.engine.graph import GraphComponent, ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyComponent(GraphComponent):\\n\\n def __init__(\\n self,\\n model_storage: ModelStorage,\\n resource: Resource,\\n training_artifact: Optional[Dict],\\n ) -> None:\\n # Store both `model_storage` and `resource` as object attributes to be able\\n # to utilize them at the end of the training\\n self._model_storage = model_storage\\n self._resource = resource\\n\\n @classmethod\\n def create(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n ) -> MyComponent:\\n return cls(model_storage, resource, training_artifact=None)\\n\\n def train(self, training_data: TrainingData) -> Resource:\\n # Train your graph component\\n ...\\n\\n # Persist your graph component\\n with self._model_storage.write_to(self._resource) as directory_path:\\n with open(directory_path / \\\"artifact.json\\\", \\\"w\\\") as file:\\n json.dump({\\\"my\\\": \\\"training artifact\\\"}, file)\\n\\n # Return resource to make sure the training artifacts\\n # can be cached.\\n return self._resource\\n\\n```\", \"Reading from the Model Storage\": \"Rasa will call the `load` method of your graph component to instantiate it for inference. You can use the context manager `self._model_storage.read_from(resource)` to get a path to the directory where your graph component's data was persisted. Using the provided path you can then load the\\npersisted data and initialize your graph component with it. Note that the `model_storage`\\nwill throw a `ValueError` in case no persisted data was found for the given `resource`.\\n\\n```\\nfrom __future__ import annotations\\nimport json\\nfrom typing import Optional, Dict, Any, Text\\n\\nfrom rasa.engine.graph import GraphComponent, ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\n\\nclass MyComponent(GraphComponent):\\n\\n def __init__(\\n self,\\n model_storage: ModelStorage,\\n resource: Resource,\\n training_artifact: Optional[Dict],\\n ) -> None:\\n self._model_storage = model_storage\\n self._resource = resource\\n\\n @classmethod\\n def load(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n **kwargs: Any,\\n ) -> MyComponent:\\n try:\\n with model_storage.read_from(resource) as directory_path:\\n with open(directory_path / \\\"artifact.json\\\", \\\"r\\\") as file:\\n training_artifact = json.load(file)\\n return cls(\\n model_storage, resource, training_artifact=training_artifact\\n )\\n except ValueError:\\n # This allows you to handle the case if there was no\\n # persisted data for your component\\n ...\\n```\"}, \"Registering Graph Components with the Model Configuration\": \"To make your graph component available to Rasa you may have to register your\\ngraph component with a recipe. Rasa uses recipes to translate the content\\nof your model configuration to executable\\n[graphs](custom-graph-components.mdx#graph-components).\\nCurrently, Rasa supports the `default.v1` and the experimental `graph.v1` recipes.\\nFor `default.v1` recipe, you need to register your graph component by using the `DefaultV1Recipe.register`\\ndecorator:\\n\\n```\\n```\\n\\nRasa uses the information provided in the `register` decorator and the\\nposition of your graph component within the configuration file to schedule the execution\\nof your graph component with its required data. The `DefaultV1Recipe.register` decorator allows you\\nto specify the following details:\\n\\n['`component_types`: This specifies what purpose your graph component fulfills within the\\\\nassistant. It is possible to specify multiple types (e.g. if your graph component is both\\\\nintent classifier and entity extractor):', [\\\"`ComponentType.MODEL_LOADER`: Component type for\\\\n[language models](components.mdx#language-models). Graph components of this type provide\\\\npretrained models to other graph components' `train`, `process_training_data` and\\\\n`process` methods if they have specified `model_from=<model loader name>`.\\\\nThis graph component is run during training and\\\\ninference. Rasa will use the graph component's `provide` method to\\\\nretrieve the model which should be provided to dependent graph components.\\\", \\\"`ComponentType.MESSAGE_TOKENIZER`: Component type for\\\\n[tokenizers](components.mdx#tokenizers). This graph component is run during training and\\\\ninference. Rasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\n`process_training_data` for tokenizing training data examples and `process`\\\\nto tokenize messages during inference.\\\", \\\"`ComponentType.MESSAGE_FEATURIZER`: Component type for\\\\n[featurizers](components.mdx#featurizers). This graph component is run during training and\\\\ninference. Rasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\n`process_training_data` for featurizing training data examples and `process`\\\\nto featurize messages during inference.\\\", \\\"`ComponentType.INTENT_CLASSIFIER`: Component type for\\\\n[intent classifiers](components.mdx#intent-classifiers). This graph component is run only\\\\nduring training if `is_trainable=True`. The graph component is always run during\\\\ninference.\\\\nRasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\nthe graph component's `process` method to classify the intent of messages during\\\\ninference.\\\", \\\"`ComponentType.ENTITY_EXTRACTOR`: Component type for\\\\n[entity extractors](components.mdx#entity-extractors). This graph component is run only\\\\nduring training if `is_trainable=True`. The graph component is always run during\\\\ninference.\\\\nRasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\nthe graph component's `process` method to extract entities during inference.\\\", \\\"`ComponentType.POLICY_WITHOUT_END_TO_END_SUPPORT`: Component type for\\\\n[policies](policies.mdx) which don't require additional end-to-end features\\\\n(see [end-to-end training](stories.mdx#end-to-end-training) for more information).\\\\nThis graph component is run only during training if `is_trainable=True`.\\\\nThe graph component is always run during inference.\\\\nRasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\nthe graph component's `predict_action_probabilities` to make predictions for the\\\\nnext action which should be run within a conversation.\\\", \\\"`ComponentType.POLICY_WITH_END_TO_END_SUPPORT`: Component type for\\\\n[policies](policies.mdx) which require additional end-to-end features\\\\n(see [end-to-end training](stories.mdx#end-to-end-training) for more information).\\\\nThe end-to-end features are passed into the graph component's `train` and\\\\n`predict_action_probabilities` as `precomputations` parameter.\\\\nThis graph component is run only during training if `is_trainable=True`.\\\\nThe graph component is always run during inference.\\\\nRasa will use the graph component's `train` method if\\\\n`is_trainable=True` is specified. Rasa will use\\\\nthe graph component's `predict_action_probabilities` to make predictions for the\\\\nnext action which should be run within a conversation.\\\"], '`is_trainable`: Specifies if the graph component is required to train itself before it can\\\\nprocess training data for other dependent graph components or before it can make\\\\npredictions', '`model_from`: Specifies if a pretrained\\\\n[language model](components.mdx#language-models) needs to be provided to the `train`,\\\\n`process_training_data` and `process` methods of the graph component. These methods\\\\nhave to support the parameter `model` to receive the language model. Note that you\\\\nstill need to make sure that the graph component which provides this model is part\\\\nof your model configuration. A common use case for this is if you want to expose the\\\\n[SpacyNLP](components.mdx#spacynlp) language model to your other NLU components.']\", \"Using Custom Components in your Model Configuration\": \"You can use custom graph components like any other NLU component or policy within your\\n[model configuration](model-configuration.mdx). The only change is that you have to specify\\nthe full module name instead of the class name only. The full module name depends on\\nyour module's location in relation to the specified\\n[PYTHONPATH](https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH).\\nBy default, Rasa adds the directory from where you run the CLI to the\\n`PYTHONPATH`. If you e.g. run the CLI from `/Users/<user>/my-rasa-project`\\nand your module `MyComponent` is in `/Users/<user>/my-rasa-project/custom_components/my_component.py`\\nthen the module path is `custom_components.my_component.MyComponent`. Everything except\\nthe `name` entry will be passed as `config` to your component.\\n\\n```\\nrecipe: default.v1\\nlanguage: en\\npipeline:\\n# other NLU components\\n- name: your.custom.NLUComponent\\n setting_a: 0.01\\n setting_b: string_value\\n\\npolicies:\\n# other dialogue policies\\n- name: your.custom.Policy\\n```\", \"Implementation Hints\": {\"Message Metadata\": \"When you [define metadata for your intent examples in your training data](./training-data-format.mdx#training-examples),\\nyour NLU component can access both the intent metadata and the intent example metadata during processing:\\n\\n```\\n# in your component class\\n\\n def process(self, message: Message, **kwargs: Any) -> None:\\n metadata = message.get(\\\"metadata\\\")\\n print(metadata.get(\\\"intent\\\"))\\n print(metadata.get(\\\"example\\\"))\\n```\", \"Sparse and Dense Message Features\": \"If you create a custom message featurizer, you can return two different kind of\\nfeatures: sequence features and sentence\\nfeatures. The sequence features are a matrix of size `(number-of-tokens x\\nfeature-dimension)`, i.e.\\nthe matrix contains a feature vector for every token in the sequence.\\nThe sentence features are represented by a matrix of size `(1 x feature-dimension)`.\"}, \"Examples of Custom Components\": {\"Dense Message Featurizer\": \"The following is the example of a dense [message featurizer](components.mdx#featurizers)\\nwhich uses a pretrained model:\\n\\n```\\n```\", \"Sparse Message Featurizer\": \"The following is the example of a dense [message featurizer](components.mdx#featurizers)\\nwhich trains a new model:\\n\\n```\\n```\", \"NLU Meta Learners\": \":::info Advanced use case\\n\\nNLU Meta learners are an advanced use case. The following section is only relevant\\nif you have a component that learns parameters based on the output of previous\\nclassifiers. For components that have manually set parameters or logic, you can create\\na component with `is_trainable=False` and not worry about the preceding classifiers.\\n\\n:::\\n\\nNLU Meta learners are intent classifiers or entity extractors that use the predictions\\nof other trained intent classifiers or entity extractors and try to improve upon their\\nresults. An example for a meta learner would be a component that averages the output\\nof two previous intent classifiers or a fallback classifier that sets it's threshold\\naccording to the confidence of the intent classifier on training examples.\\n\\nConceptually, to built a trainable fallback classifier you first need to create that\\nfallback classifier as a custom component:\\n\\n```\\n```\\n\\nNext, you will need to create a custom intent classifier that is also a featurizer,\\nas the classifiers' output needs to be consumed by another component downstream.\\nFor the custom intent classifier component you also need to define how its predictions\\nshould be added to the message data specifying the `process_training_data` method.\\nMake sure to not overwrite the true labels for the intents. Here's a template that\\nshows how to subclass DIET for this purpose:\\n\\n```\\n```\"}}, \"metadata\": {\"id\": \"custom-graph-components\", \"sidebar_label\": \"Custom Graph Components\", \"title\": \"Custom Graph Components\", \"abstract\": \"You can extend Rasa with custom NLU components and policies. This page provides a guide on how to develop your own custom graph components.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 11]\"}, {\"title\": \"Default Actions\", \"description\": null, \"content\": {\"action_listen\": \"This action is predicted to signal that the assistant should do nothing and wait\\nfor the next user input.\", \"action_restart\": \"This action resets the whole conversation history, including any slots that were\\nset during it.\\n\\nIt can be triggered by the user in a conversation by sending a\\n\\\"/restart\\\" message, if the [RulePolicy](./rules.mdx) is included in the model configuration.\\nIf you define an `utter_restart` response in your domain, this will be sent to the user as well.\", \"action_session_start\": {\"Customization\": \"The default behavior of the session start action is to take all existing slots and to\\ncarry them over into the next session. Let's say you do not want to carry over all\\nslots, but only a user's name and their phone number. To do that, you'd override the\\n`action_session_start` with a custom action that might look like this:\\n\\n```\\nfrom typing import Any, Text, Dict, List\\nfrom rasa_sdk import Action, Tracker\\nfrom rasa_sdk.events import SlotSet, SessionStarted, ActionExecuted, EventType\\n\\n\\nclass ActionSessionStart(Action):\\n def name(self) -> Text:\\n return \\\"action_session_start\\\"\\n\\n @staticmethod\\n def fetch_slots(tracker: Tracker) -> List[EventType]:\\n \\\"\\\"\\\"Collect slots that contain the user's name and phone number.\\\"\\\"\\\"\\n\\n slots = []\\n for key in (\\\"name\\\", \\\"phone_number\\\"):\\n value = tracker.get_slot(key)\\n if value is not None:\\n slots.append(SlotSet(key=key, value=value))\\n return slots\\n\\n async def run(\\n self, dispatcher, tracker: Tracker, domain: Dict[Text, Any]\\n ) -> List[Dict[Text, Any]]:\\n\\n # the session should begin with a `session_started` event\\n events = [SessionStarted()]\\n\\n # any slots that should be carried over should come after the\\n # `session_started` event\\n events.extend(self.fetch_slots(tracker))\\n\\n # an `action_listen` should be added at the end as a user message follows\\n events.append(ActionExecuted(\\\"action_listen\\\"))\\n\\n return events\\n```\\n\\nIf you want to access the metadata which was sent with the user message which triggered\\nthe session start, you can access the special slot `session_started_metadata`:\\n\\n```\\nfrom typing import Any, Text, Dict, List\\nfrom rasa_sdk import Action, Tracker\\nfrom rasa_sdk.events import SessionStarted, ActionExecuted\\n\\n\\nclass ActionSessionStart(Action):\\n def name(self) -> Text:\\n return \\\"action_session_start\\\"\\n\\n async def run(\\n self, dispatcher, tracker: Tracker, domain: Dict[Text, Any]\\n ) -> List[Dict[Text, Any]]:\\n metadata = tracker.get_slot(\\\"session_started_metadata\\\")\\n\\n # Do something with the metadata\\n print(metadata)\\n\\n # the session should begin with a `session_started` event and an `action_listen`\\n # as a user message follows\\n return [SessionStarted(), ActionExecuted(\\\"action_listen\\\")]\\n```\"}, \"action_default_fallback\": \"This action undoes the last user-bot interaction and sends the `utter_default` response if it is defined.\\nIt is triggered by low action prediction confidence, if you have this [fallback mechanism](./fallback-handoff.mdx) enabled.\", \"action_deactivate_loop\": \"This action deactivates the active loop and resets the requested slot. This is used when\\n[handling unhappy paths in forms](./forms.mdx#writing-stories--rules-for-unhappy-form-paths).\\n\\n:::note\\nIf you wish to reset all slots, we recommend using a custom action\\nthat returns the [`AllSlotsReset`](https://rasa.com/docs/rasa/reference/rasa/shared/core/events#allslotsreset-objects) event after form deactivation.\\n:::\", \"action_two_stage_fallback\": \"This is a fallback loop that can be used to handle low NLU confidence. Read more about\\n[handling low NLU confidence](./fallback-handoff.mdx#nlu-fallback).\", \"action_default_ask_affirmation\": \"This action is used by the `action_two_stage_fallback` loop. It asks the user to confirm\\nthe intent of their message. This action can be customized to be more personalized\\nto your specific use case.\", \"action_default_ask_rephrase\": \"This action is used by the `action_two_stage_fallback` loop if the user denies the\\nintent `action_default_ask_affirmation` displays. It asks the user to rephrase\\ntheir message.\", \"action_back\": \"This action undoes the last user-bot interaction. It can be triggered by the user\\nby sending a \\\"/back\\\" message to the assistant if the [RulePolicy](./policies.mdx#rule-policy) is configured.\\n|\", \"Form Action\": \"By default Rasa uses `FormAction` for processing any\\n[form logic](forms.mdx). You can override this default action with a custom action by\\nadding a custom action with the form's name to the domain.\\nOverriding the default action for forms should **only** be used during the process of\\nmigrating from Rasa 1.0 to 2.0.\", \"action_unlikely_intent\": {\"Customization\": \"You can customize your assistant's behaviour to configure what should happen once `action_unlikely_intent`\\nis triggered. For example, as a follow up you can trigger a hand-off to a human agent with a rule:\\n\\n```\\n- rule: trigger human handoff with action_unlikely_intent\\n steps:\\n - action: action_unlikely_intent\\n - action: ask_human_handoff\\n - intent: affirm\\n - action: trigger_human_handoff\\n```\\n\\nAlternatively, you can also override it's behaviour as a [`custom action`](./custom-actions.mdx) by\\nadding `action_unlikely_intent` to the list of actions in the domain and implementing the custom behaviour:\\n\\n```\\nclass ActionUnlikelyIntent(Action):\\n\\n def name(self) -> Text:\\n return \\\"action_unlikely_intent\\\"\\n\\n async def run(\\n self, dispatcher, tracker: Tracker, domain: Dict[Text, Any],\\n ) -> List[Dict[Text, Any]]:\\n\\n # Implement custom logic here\\n return []\\n```\\n\\n:::note\\nSince `action_unlikely_intent` can be triggered at any conversation step during inference,\\nall policies which are trained on only story data, for example - `TEDPolicy`, `UnexpecTEDIntentPolicy`,\\n`MemoizationPolicy` ignore its presence in the tracker when making a prediction. However, `RulePolicy`\\ntakes its presence into account so that [conversation behaviour is customizable](./default-actions.mdx#customization-1).\\n\\n:::\\n\\n:::note\\n`action_unlikely_intent` cannot be included in the training stories. It can **only** be added to rules.\\n\\n:::\"}, \"action_extract_slots\": \"This action runs after each user turn, before the next assistant action prediction and execution.\\n`action_extract_slots` loops through the [slot mappings](./domain.mdx#slot-mappings) of each domain slot in order to set or update\\nslots throughout the conversation with information extracted from the latest user message.\\n\\nIf `action_extract_slots` finds a [custom slot mapping](./domain.mdx#custom-slot-mappings), it will check first if a custom action was defined in the\\nmapping via the `action` key and then run it.\\n\\nAfter applying all the slot mappings, `action_extract_slots` will run the custom validation action\\n`action_validate_slot_mappings` if it is present in the domain actions. Otherwise it will immediately return the already\\nextracted slots.\\n\\nNote that custom actions used by slot mappings or slot mapping validation should only return events of type `SlotSet` or\\n`BotUttered`. Events of any other type are not permitted and will be ignored when updating the tracker.\\n\\nThe default action `action_extract_slots` replaces the slot extraction previously executed by `FormAction`.\\nIf you wish to set a slot based on information extracted from intents that trigger forms, you must explicitly specify a\\nmapping that does not contain the `conditions` key. A slot mapping with `conditions` applies only once the specified form is active.\\n`action_extract_slots` runs directly after each user message, and thus before the activation of the form.\\nTherefore a mapping that should apply to user messages that trigger a form must not specify `conditions`, or the form\\nwill re-ask for the slot once it is activated.\\n\\n:::note\\nIf `action_default_fallback` is the next action predicted and executed by the assistant, this will result in a\\n`UserUtteranceReverted` event which will unset the slots previously filled in the last user turn.\\n\\n:::\"}, \"metadata\": {\"id\": \"default-actions\", \"sidebar_label\": \"Default Actions\", \"title\": \"Default Actions\", \"abstract\": \"Default actions are actions that are built into the dialogue manager by default. Most of these are automatically predicted based on certain conversation situations. You may want to customize these to personalize your assistant.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 12]\"}, {\"title\": \"Domain\", \"description\": null, \"content\": {\"Multiple Domain Files\": \"The domain can be defined as a single YAML file or split across multiple files in a directory.\\nWhen split across multiple files, the domain contents will be read and automatically merged together.\\n\\nUsing the [command line interface](./command-line-interface.mdx#rasa-train),\\nyou can train a model with split domain files by running:\\n\\n```\\nrasa train --domain path_to_domain_directory\\n```\", \"Intents\": {\"Ignoring Entities for Certain Intents\": \"To ignore all entities for certain intents, you can\\nadd the `use_entities: []` parameter to the intent in your domain\\nfile like this:\\n\\n```\\nintents:\\n - greet:\\n use_entities: []\\n```\\n\\nTo ignore some entities or explicitly take only certain entities\\ninto account you can use this syntax:\\n\\n```\\nintents:\\n- greet:\\n use_entities:\\n - name\\n - first_name\\n- farewell:\\n ignore_entities:\\n - location\\n - age\\n - last_name\\n```\\n\\nYou can only `use_entities` _or_ `ignore_entities` for any single intent.\\n\\nExcluded entities for those intents will be unfeaturized and therefore\\nwill not impact the next action predictions. This is useful when you have\\nan intent where you don't care about the entities being picked up.\\n\\nIf you list your intents without a `use_entities` or `ignore_entities` \\nparameter, the entities will be featurized as normal.\\n\\nIt is also possible to ignore an entity for all intents\\nby setting the `influence_conversation` flag to `false` for the entity itself.\\nSee [the entities section](#entities) for details.\\n\\nExcluded entities for intents will be unfeaturized and therefore\\nwill not impact the next action predictions. This is useful when you have\\nan intent where you don't care about the entities being picked up.\\n\\nIf you list your intents without this parameter, and without setting \\n`influence_conversation` to `false` for any entities, all entities will be\\nfeaturized as normal.\\n\\n:::note\\nIf you want these entities not to influence action prediction via slots either,\\nset the [`influence_conversation: false`](./domain.mdx#slots-and-conversation-behavior)\\nparameter for slots with the same name.\\n\\n:::\"}, \"Entities\": \":::info New in 3.1\\n\\nAs of 3.1, you can use the `influence_conversation` flag under entities.\\nThe flag can be set to `false` to declare that an entity should not\\nbe featurized for any intents. It is a shorthand syntax for adding an entity to\\nthe `ignore_entities` list of every intent in the domain. The flag is optional \\nand default behaviour remains unchanged.\\n\\n:::\\n\\nThe `entities` section lists all entities that can be\\nextracted by any [entity extractor](./components.mdx) in your\\nNLU pipeline.\\n\\nFor example:\\n\\n```\\nentities:\\n - PERSON # entity extracted by SpacyEntityExtractor\\n - time # entity extracted by DucklingEntityExtractor\\n - membership_type # custom entity extracted by DIETClassifier\\n - priority # custom entity extracted by DIETClassifier\\n```\\n\\nWhen using multiple domain files, entities can be specified in any domain file, \\nand can be used or ignored by any intent in any domain file.\\n\\nIf you are using the feature [Entity Roles and Groups](./nlu-training-data.mdx#entities-roles-and-groups) you also\\nneed to list the roles and groups of an entity in this section.\\n\\nFor example:\\n\\n```\\nentities:\\n - city: # custom entity extracted by DIETClassifier\\n roles:\\n - from\\n - to\\n - topping: # custom entity extracted by DIETClassifier\\n groups:\\n - 1\\n - 2\\n - size: # custom entity extracted by DIETClassifier\\n groups:\\n - 1\\n - 2\\n```\\n\\nBy default, entities influence action prediction. To prevent extracted entities from\\ninfluencing the conversation for specific intents you can [ignore entities for certain intents](#ignoring-entities-for-certain-intents).\\nTo ignore an entity for all intents, without having to list it under the `ignore_entities` flag of each intent, \\nyou can set the flag `influence_conversation` to `false` under the entity:\\n\\n```\\nentities:\\n- location:\\n influence_conversation: false\\n```\\n\\nThis syntax has the same effect as adding the entity to the `ignore_entities` \\nlist for every intent in the domain.\\n\\nExplicitly setting `influence_conversation: true` does not change any behaviour. This is the default setting.\", \"Slots\": {\"Slots and Conversation Behavior\": \"You can specify whether or not a slot influences the conversation with the\\n`influence_conversation` property. \\n\\nIf you want to store information in a slot without it influencing the conversation,\\nset `influence_conversation: false` when defining your slot. \\n\\nThe following example defines a slot `age` which will store information about the\\nuser's age, but which will *not* influence the flow of the conversation. This means\\nthat the assistant will ignore the value of the slot each time it predicts the next action.\\n\\n```\\nslots:\\n age:\\n type: text\\n # this slot will not influence the predictions\\n # of the dialogue policies\\n influence_conversation: false\\n```\\n\\nWhen defining a slot, if you leave out `influence_conversation` or set it to `true`,\\nthat slot will influence the next action prediction, unless it has slot type `any`.\\nThe way the slot influences the conversation\\nwill depend on its [slot type](./domain.mdx#slot-types).\\n\\nThe following example defines a slot `home_city` that influences the conversation. \\nA [`text` slot](domain.mdx#text-slot) will\\ninfluence the assistant's behavior depending on whether the slot has a value.\\nThe specific value of a `text` slot (e.g. *Bangalore* or *New York* or *Hong Kong*)\\ndoesn't make any difference. \\n\\n```\\nslots:\\n # this slot will influence the conversation depending on\\n # whether the slot is set or not\\n home_city:\\n type: text\\n influence_conversation: true\\n```\\n\\nAs an example, consider the two inputs \\\"What is the weather like?\\\" and \\\"What is the\\nweather like in Bangalore?\\\" The conversation should diverge based on whether\\nthe `home_city` slot was set automatically by the NLU. If the slot is already set, the bot\\ncan predict the `action_forecast` action. If the slot is not set, it needs to get the `home_city`\\ninformation before it is able to predict the weather.\", \"Slot Types\": {\"Text Slot\": [\"**Type**\", \"`text`\", \"**Use For**\", \"Storing text values.\", \"**Example**\", \"```\\nslots:\\n cuisine:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: cuisine\\n```\", \"**Description**\", \"If `influence_conversation` is set to `true`, the assistant's behavior will change\\ndepending on whether the slot is set or not. Different texts do not influence the\\nconversation any further. This means the following two stories are equal:\", \"```\\nstories:\\n- story: French cuisine\\n steps:\\n - intent: inform\\n - slot_was_set:\\n - cuisine: french\\n\\n- story: Vietnamese cuisine\\n steps:\\n - intent: inform\\n - slot_was_set:\\n - cuisine: vietnamese\\n```\"], \"Boolean Slot\": [\"**Type**\", \"`bool`\", \"**Use For**\", \"Storing `true` or `false` values.\", \"**Example**\", \"```\\nslots:\\n is_authenticated:\\n type: bool\\n mappings:\\n - type: custom\\n```\", \"**Description**\", \"If `influence_conversation` is set to `true`, the assistant's behavior will change\\ndepending on whether the slot is empty, set to `true` or set to `false`. Note that an\\nempty `bool` slot influences the conversation differently than if the slot was set to\\n`false`.\"], \"Categorical Slot\": [\"**Type**\", \"`categorical`\", \"**Use For**\", \"Storing slots which can take one of N values.\", \"**Example**\", \"```\\nslots:\\n risk_level:\\n type: categorical\\n values:\\n - low\\n - medium\\n - high\\n mappings:\\n - type: custom\\n```\", \"**Description**\", \"If `influence_conversation` is set to `true`, the assistant's behavior will change\\ndepending on the concrete value of the slot. This means the assistant's behavior is\\ndifferent depending on whether the slot in the above example has the value `low`,\\n`medium`, or `high`.\", \"A default value `__other__` is automatically added to the user-defined\\nvalues. All values encountered which are not explicitly defined in the slot's `values`\\nare mapped to `__other__`.\\n`__other__` should not be used as a user-defined value; if it is, it\\nwill still behave as the default to which all unseen values are mapped.\"], \"Float Slot\": [\"**Type**\", \"`float`\", \"**Use For**\", \"Storing real numbers.\", \"**Example**\", \"```\\nslots:\\n temperature:\\n type: float\\n min_value: -100.0\\n max_value: 100.0\\n mappings:\\n - type: custom\\n```\", \"**Defaults**\", \"`max_value=1.0`, `min_value=0.0`\", \"**Description**\", \"If `influence_conversation` is set to `true`, the assistant's behavior will change\\ndepending on the value of the slot. If the value is between `min_value` and\\n`max_value`, the specific value of the number is used.\\nAll values below `min_value` will be treated as `min_value`, and all values above\\n`max_value` will be treated as `max_value`. Hence, if `max_value` is set to `1`,\\nthere is no difference between the slot values `2` and `3.5`.\"], \"List Slot\": [\"**Type**\", \"`list`\", \"**Use For**\", \"Storing lists of values.\", \"**Example**\", \"```\\nslots:\\n shopping_items:\\n type: list\\n mappings:\\n - type: from_entity\\n entity: shopping_item\\n```\", \"**Description**\", \"If `influence_conversation` is set to `true`, the assistant's behavior will change\\ndepending on whether the list is empty or not. The length of the list stored in\\nthe slot does not influence the dialogue. It only matters whether list length is zero or non-zero.\"], \"Any Slot\": [\"**Type**\", \"`any`\", \"**Use For**\", \"Storing arbitrary values (they can be of any type, such as dictionaries or lists).\", \"**Example**\", \"```\\nslots:\\n shopping_items:\\n type: any\\n mappings:\\n - type: custom\\n```\", \"**Description**\", \"Slots of type `any` are always ignored during conversations. The property\\n`influence_conversation` cannot be set to `true` for this slot type. If you want to\\nstore a custom data structure which should influence the conversation, use a\\n[custom slot type](domain.mdx#custom-slot-types).\"], \"Custom Slot Types\": \"Maybe your restaurant booking system can only handle bookings\\nfor up to 6 people. In this case you want the *value* of the\\nslot to influence the next selected action (and not just whether\\nit's been specified). You can do this by defining a custom slot class.\\n\\nThe code below defines a custom slot class called `NumberOfPeopleSlot`. \\nThe featurization defines how the value of this slot gets converted to a vector\\nso Rasa machine learning model can deal with it.\\nThe `NumberOfPeopleSlot` has three possible \\u201cvalues\\u201d, which can be represented with\\na vector of length `2`.\\n\\n| | |\\n|--------|----------------|\\n|`(0,0)` |not yet set |\\n|`(1,0)` |between 1 and 6 |\\n|`(0,1)` |more than 6 |\\n\\n```\\nfrom rasa.shared.core.slots import Slot\\n\\nclass NumberOfPeopleSlot(Slot):\\n\\n def feature_dimensionality(self):\\n return 2\\n\\n def as_feature(self):\\n r = [0.0] * self.feature_dimensionality()\\n if self.value:\\n if self.value <= 6:\\n r[0] = 1.0\\n else:\\n r[1] = 1.0\\n return r\\n```\\n\\nYou can implement a custom slot class as an independent python module, \\nseparate from custom action code. Save the code for your custom slot in a directory \\nalongside an empty file called \\\"\\\\_\\\\_init\\\\_\\\\_.py\\\" so that it will be recognized as a python module.\\nYou can then refer to the custom slot class by it's module path.\\n\\nFor example, say you have saved the code above in \\\"addons/my_custom_slots.py\\\", a directory relative to your bot project:\\n\\n```\\n\\u2514\\u2500\\u2500 rasa_bot\\n \\u251c\\u2500\\u2500 addons\\n \\u2502 \\u251c\\u2500\\u2500 __init__.py\\n \\u2502 \\u2514\\u2500\\u2500 my_custom_slots.py\\n \\u251c\\u2500\\u2500 config.yml\\n \\u251c\\u2500\\u2500 credentials.yml\\n \\u251c\\u2500\\u2500 data\\n \\u251c\\u2500\\u2500 domain.yml\\n \\u251c\\u2500\\u2500 endpoints.yml\\n```\\n\\nYour custom slot type's module path\\nis then `addons.my_custom_slots.NumberOfPeopleSlot`.\\nUse the module path to refer to the custom slot type in your domain file:\\n\\n```\\nslots:\\n people:\\n type: addons.my_custom_slots.NumberOfPeopleSlot\\n influence_conversation: true\\n mappings:\\n - type: custom\\n```\\n\\nNow that your custom slot class can be used by Rasa, add training stories that diverge based on the value of the `people` slot.\\nYou could write one story for the case where `people` has a value between 1 and 6, and one for a value greater than six. You can choose any value within these ranges to put in your stories, since they are all featurized the same way (see the featurization table above).\\n\\n```\\nstories:\\n- story: collecting table info\\n steps:\\n # ... other story steps\\n - intent: inform\\n entities:\\n - people: 3\\n - slot_was_set:\\n - people: 3\\n - action: action_book_table\\n\\n- story: too many people at the table\\n steps:\\n # ... other story steps\\n - intent: inform\\n entities:\\n - people: 9\\n - slot_was_set:\\n - people: 9\\n - action: action_explain_table_limit\\n```\"}, \"Slot Mappings\": {\"from_entity\": {\"Unique `from_entity` mapping matching\": \"There is an intentional limitation on applying `from_entity` slot mappings in the context of a form.\\nWhen a form is active, a `from_entity` slot mapping will be applied only if one or more of the following conditions are met:\\n\\n['The slot with the `from_entity` mapping has just been requested by the form', \\\"Only one of the active form's `required_slots` has that specific `from_entity` mapping,\\\\nincluding all the attributes of the extracted entity (i.e, entity name, role, group). This is known as a **unique entity mapping** for the form. \\\\nThe extracted entity will be ignored if the mapping is not unique within the list of `required_slots`.\\\"]\\n\\nThis limitation exists to prevent a form from filling multiple required slots with the same extracted entity value.\\n\\nFor example, in the example below, an entity `date` uniquely sets the slot `arrival_date`,\\nan entity `city` with a role `from` uniquely sets the slot `departure_city` and\\nan entity `city` with a role `to` uniquely sets the slot `arrival_city`,\\ntherefore they can be used to fit corresponding slots\\neven if these slots were not requested.\\nHowever, entity `city` without a role can fill both `departure_city` and `arrival_city`\\nslots, depending which one is requested, so if an entity `city` is extracted when\\nslot `arrival_date` is requested, it'll be ignored by the form.\\n\\n```\\nslots:\\n departure_city:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: city\\n role: from\\n - type: from_entity\\n entity: city\\n arrival_city:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: city\\n role: to\\n - type: from_entity\\n entity: city\\n arrival_date:\\n type: any\\n mappings:\\n - type: from_entity\\n entity: date\\nforms:\\n your_form:\\n required_slots:\\n - departure_city\\n - arrival_city\\n - arrival_date\\n```\\n\\nNote that the unique `from_entity` mapping constraint will **not** prevent filling slots which are not in the active form's `required_slots`;\\nthose mappings will apply as usual, regardless of the uniqueness of the mapping. To limit applicability of a slot mapping to\\na specific form, see [Mapping Conditions](./domain.mdx#mapping-conditions).\"}, \"from_text\": \"The `from_text` mapping will use the text of the last user utterance to fill the slot\\n`slot_name`. If `intent_name` is `None`, the slot will be filled regardless of intent name.\\nOtherwise, the slot will only be filled if the user's intent is `intent_name`.\\n\\nThe slot mapping will not apply if the intent of the message is `excluded_intent`.\\n\\n```\\nslots:\\n slot_name:\\n type: text\\n mappings:\\n - type: from_text\\n intent: intent_name\\n not_intent: excluded_intent\\n```\\n\\n:::note\\nTo maintain the 2.x form behavior when using `from_text` slot mappings, you must use [mapping conditions](./domain.mdx#mapping-conditions),\\nwhere both `active_loop` and `requested_slot` keys are defined.\\n:::\", \"from_intent\": \"The `from_intent` mapping will fill slot `slot_name` with value `my_value` if\\nuser intent is `intent_name`. If you choose not to specify the parameter `intent`,\\nthe slot mapping will apply regardless of the intent of the message as long as\\nthe intent is not listed under `not_intent` parameter.\\n\\nThe following parameter is required:\\n\\n['`value`: the value that fills the slot `slot_name`']\\n\\nThe following parameters are optional and can be used to further specify when the mapping applies:\\n\\n['`intent`: Only applies the mapping when this intent is predicted.', '`not_intent`: Does not apply the mapping when this intent is predicted']\\n\\nNote that if you choose not to define the parameter `intent`, the slot mapping will apply regardless of the intent\\nof the message as long as the intent is not listed under the `not_intent` parameter.\\n\\n```\\nslots:\\n slot_name:\\n type: any\\n mappings:\\n - type: from_intent\\n value: my_value\\n intent: intent_name\\n not_intent: excluded_intent\\n```\", \"from_trigger_intent\": \"The `from_trigger_intent` mapping will fill slot `slot_name` with value `my_value`\\nif a form is activated by a user message with intent `intent_name`.\\nThe slot mapping will not apply if the intent of the message is\\n`excluded_intent`.\\n\\n```\\nslots:\\n slot_name:\\n type: any\\n mappings:\\n - type: from_trigger_intent\\n value: my_value\\n intent: intent_name\\n not_intent: excluded_intent\\n```\"}, \"Mapping Conditions\": \"To apply a slot mapping only within the context of a form, specify\\nthe name of the form in the `conditions` key of a slot mapping. Conditions list the form name(s)\\nfor which the mapping is applicable in the `active_loop` key.\\n\\n:::info New in 3.6\\nSlot mappings can now specify `null` as the value of `active_loop` to indicate that the slot should only be filled when\\nno form is active. Note that `requested_slot` cannot be used in conjunction with `active_loop: null`.\\n:::\\n\\nConditions can also include the name of the `requested_slot`. If `requested_slot` is not mentioned,\\nthen the slot will be set if relevant information is extracted, regardless of which slot is being\\nrequested by the form.\\n\\n```\\nslots:\\n slot_name:\\n type: text\\n mappings:\\n - type: from_text\\n intent: intent_name\\n conditions:\\n - active_loop: your_form\\n requested_slot: slot_name\\n - active_loop: another_form\\n```\\n\\n:::note\\nIf `conditions` are not included in a slot mapping, the slot mapping will be applicable regardless of whether\\nany form is active. As long as a slot is listed in a form's `required_slots`, the form will prompt for the slot\\nif it is empty when the form is activated.\\n:::\", \"Custom Slot Mappings\": \"You can define custom slot mappings using [slot validation actions](./slot-validation-actions.mdx) when none of the\\npredefined mappings fit your use case. You must define this slot mapping to be of type `custom`, for example:\\n\\n```\\nslots:\\n day_of_week:\\n type: text\\n mappings:\\n - type: custom\\n action: action_calculate_day_of_week\\n```\\n\\nYou can also use the `custom` slot mapping to list slots that will be filled by arbitrary custom actions in the course\\nof a conversation, by listing the type and no specific action. For example:\\n\\n```\\nslots:\\n handoff_completed:\\n type: boolean\\n mappings:\\n - type: custom\\n```\\n\\nThis slot will not be updated on every user turn, but only once a custom action that returns a `SlotSet` event for it is predicted.\", \"Initial slot values\": \"You can provide an initial value for a slot in your domain file:\\n\\n```\\nslots:\\n num_fallbacks:\\n type: float\\n initial_value: 0\\n mappings:\\n - type: custom\\n```\"}, \"Responses\": \"Responses are actions that send a message to a user without running any custom code or\\nreturning events. These responses can be defined directly in the domain file under the `responses` key\\nand can include rich content such as buttons and attachments. For more information on responses and how to define them,\\nsee [Responses](./responses.mdx).\", \"Forms\": \"Forms are a special type of action meant to help your assistant collect information from a user.\\nDefine forms under the `forms` key in your domain file.\\nFor more information on form and how to define them, see [Forms](./forms.mdx).\", \"Actions\": {\"Select which actions should receive domain\": \":::info New in 3.4.3\\nYou can control if an action should receive a domain or not.\\n:::\\n\\nTo do this you must first enable selective domain in you endpoint configuration for\\n`action_endpoint` in `endpoints.yml`.\\n\\n```\\n# endpoints.yml\\naction_endpoint:\\n url: \\\"http://localhost:5055/webhook\\\" # URL to your action server\\n enable_selective_domain: true\\n```\\n\\n**After selective domain for custom actions is enabled, domain will be sent only to\\nthose custom actions which have specifically stated that they need it.**\\nCustom actions inheriting from rasa-sdk [`FormValidationAction`](./action-server/validation-action.mdx#formvalidationaction-class)\\nparent class are an exception to this rule as they will always have the domain sent to them.\\nTo specify if an action needs the domain add `{send_domain: true}` to custom action in the list\\nof actions in `domain.yml`:\\n\\n```\\n# domain.yml\\nactions:\\n - action_hello_world: {send_domain: True} # will receive domain\\n - action_calculate_mass_of_sun # will not receive domain\\n - validate_my_form # will receive domain\\n```\"}, \"Session configuration\": \"A conversation session represents the dialogue between the assistant and the user.\\nConversation sessions can begin in three ways:\\n\\n['the user begins the conversation with the assistant,', 'the user sends their first message after a configurable period of inactivity, or', 'a manual session start is triggered with the `/session_start` intent message.']\\n\\nYou can define the period of inactivity after which a new conversation\\nsession is triggered in the domain under the `session_config` key.\\n\\nAvailable parameters are:\\n\\n['`session_expiration_time` defines the time of inactivity in minutes after which a\\\\nnew session will begin.', '`carry_over_slots_to_new_session` determines whether\\\\nexisting set slots should be carried over to new sessions.']\\n\\nThe default session configuration looks as follows:\\n\\n```\\nsession_config:\\n session_expiration_time: 60 # value in minutes, 0 means infinitely long\\n carry_over_slots_to_new_session: true # set to false to forget slots between sessions\\n```\\n\\nThis means that if a user sends their first message after 60 minutes of inactivity, a\\nnew conversation session is triggered, and that any existing slots are carried over\\ninto the new session. Setting the value of `session_expiration_time` to `0` means\\nthat sessions will not end (note that the `action_session_start` action will still\\nbe triggered at the very beginning of conversations).\\n\\n:::note\\nA session start triggers the default action `action_session_start`. Its default\\nimplementation moves all existing slots into the new session. Note that all\\nconversations begin with an `action_session_start`. Overriding this action could\\nfor instance be used to initialize the tracker with slots from an external API\\ncall, or to start the conversation with a bot message. The docs on\\n[Customizing the session start action](./default-actions.mdx#customization) shows you how to do that.\\n\\n:::\", \"Config\": \"The `config` key in the domain file maintains the `store_entities_as_slots` parameter.\\nThis parameter is used only in the context of reading stories and turning them into trackers. If the parameter is set\\nto `True`, this will result in slots being implicitly set from entities if applicable entities are present in the story.\\nWhen an entity matches the `from_entity` slot mapping, `store_entities_as_slots` defines whether the entity value should\\nbe placed in that slot. Therefore, this parameter skips adding an explicit `slot_was_set` step manually in the story.\\nBy default, this behaviour is switched on.\\n\\nYou can turn off this functionality by setting the `store_entities_as_slots` parameter to `false`:\\n\\n```\\nconfig:\\n store_entities_as_slots: false\\n```\\n\\n:::note looking for config.yml?\\nIf you're looking for information on the `config.yml` file, check out the docs on\\n[Model Configuration](./model-configuration.mdx).\\n:::\"}, \"metadata\": {\"id\": \"domain\", \"sidebar_label\": \"Domain\", \"title\": \"Domain\", \"abstract\": \"The domain defines the universe in which your assistant operates. It specifies the intents, entities, slots, responses, forms, and actions your bot should know about. It also defines a configuration for conversation sessions.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 13]\"}, {\"title\": \"Event Brokers\", \"description\": \"Find out how open source chatbot framework Rasa allows you to stream events to a message broker.\", \"content\": {\"Format\": \"All events are streamed to the broker as serialized dictionaries every time\\nthe tracker updates its state. An example event emitted from the `default`\\ntracker looks like this:\\n\\n```\\n{\\n \\\"sender_id\\\": \\\"default\\\",\\n \\\"timestamp\\\": 1528402837.617099,\\n \\\"event\\\": \\\"bot\\\",\\n \\\"text\\\": \\\"what your bot said\\\",\\n \\\"data\\\": \\\"some data about e.g. attachments\\\"\\n \\\"metadata\\\" {\\n \\\"a key\\\": \\\"a value\\\",\\n }\\n}\\n```\\n\\nThe `event` field takes the event's `type_name` (for more on event\\ntypes, check out the [events](./action-server/events.mdx) docs).\", \"Pika Event Broker\": {\"Adding a Pika Event Broker Using the Endpoint Configuration\": \"You can instruct Rasa to stream all events to your Pika event broker by adding an `event_broker` section to your\\n`endpoints.yml`:\\n\\n```\\n```\\n\\nA comprehensive list of all arguments that can be customized in the `endpoints.yml` file can be found in the [reference documentation](https://rasa.com/docs/rasa/reference/rasa/core/brokers/pika/#__init__).\\nRasa will automatically start streaming events when you restart the Rasa server.\", \"Adding SSL options to the Pika Event Broker\": \"You can create RabbitMQ SSL options by setting the following required environment variables:\\n\\n['`RABBITMQ_SSL_CLIENT_CERTIFICATE`: path to the SSL client certificate', '`RABBITMQ_SSL_CLIENT_KEY`: path to the SSL client key']\\n\\nPlease note that specifying 'RABBITMQ_SSL_CA_FILE' via environment variables is no longer supported, as well as\\nspecifying `RABBITMQ_SSL_KEY_PASSWORD` environment variable - please use a key file that is not encrypted instead.\", \"Adding a Pika Event Broker in Python\": \"Here is how you add it using Python code:\\n\\n```\\nimport asyncio\\n\\nfrom rasa.core.brokers.pika import PikaEventBroker\\nfrom rasa.core.tracker_store import InMemoryTrackerStore\\n\\npika_broker = PikaEventBroker('localhost',\\n 'username',\\n 'password',\\n queues=['rasa_events'],\\n event_loop=event_loop\\n )\\nasyncio.run(pika_broker.connect())\\n\\ntracker_store = InMemoryTrackerStore(domain=domain, event_broker=pika_broker)\\n```\", \"Implementing a Pika Event Consumer\": \"You need to have a RabbitMQ server running, as well as another application\\nthat consumes the events. This consumer to needs to implement Pika's\\n`start_consuming()` method with a `callback` action. Here's a simple\\nexample:\\n\\n```\\nimport json\\nimport pika\\n\\n\\ndef _callback(ch, method, properties, body):\\n # Do something useful with your incoming message body here, e.g.\\n # saving it to a database\\n print(\\\"Received event {}\\\".format(json.loads(body)))\\n\\nif __name__ == \\\"__main__\\\":\\n\\n # RabbitMQ credentials with username and password\\n credentials = pika.PlainCredentials(\\\"username\\\", \\\"password\\\")\\n\\n # Pika connection to the RabbitMQ host - typically 'rabbit' in a\\n # docker environment, or 'localhost' in a local environment\\n connection = pika.BlockingConnection(\\n pika.ConnectionParameters(\\\"rabbit\\\", credentials=credentials)\\n )\\n\\n # start consumption of channel\\n channel = connection.channel()\\n channel.basic_consume(queue=\\\"rasa_events\\\", on_message_callback=_callback, auto_ack=True)\\n channel.start_consuming()\\n```\"}, \"Kafka Event Broker\": {\"Partition Key\": \"Rasa's Kafka producer can optionally be configured to partition messages by conversation ID.\\nThis can be configured by setting `partition_by_sender` in the `endpoints.yml` file to True.\\nBy default, this parameter is set to `False` and the producer will randomly assign a partition to each message. \\n\\n```\\nevent_broker:\\n type: kafka\\n partition_by_sender: True\\n security_protocol: PLAINTEXT\\n topic: topic\\n url: localhost\\n client_id: kafka-python-rasa\\n```\", \"Authentication and Authorization\": \"Rasa's Kafka producer accepts the following types of security protocols: `SASL_PLAINTEXT`, `SSL`, `PLAINTEXT`\\nand `SASL_SSL`.\\n\\nFor development environments, or if the brokers servers and clients are located\\ninto the same machine, you can use simple authentication with `SASL_PLAINTEXT` or `PLAINTEXT`.\\nBy using this protocol, the credentials and messages exchanged between the clients and servers\\nwill be sent in plaintext. Thus, this is not the most secure approach, but since it's simple\\nto configure, it is useful for simple cluster configurations.\\n`SASL_PLAINTEXT` protocol requires the setup of the `username` and `password`\\npreviously configured in the broker server.\\n\\nIf the clients or the brokers in the kafka cluster are located in different\\nmachines, it's important to use the `SSL` or `SASL_SSL` protocol to ensure encryption of data\\nand client authentication. After generating valid certificates for the brokers and the\\nclients, the path to the certificate and key generated for the producer must\\nbe provided as arguments, as well as the CA's root certificate.\\n\\nWhen using the `SASL_PLAINTEXT` and `SASL_SSL` protocols, the `sasl_mechanism` can be\\noptionally configured and is set to `PLAIN` by default. Valid values for `sasl_mechanism`\\nare: `PLAIN`, `GSSAPI`, `OAUTHBEARER`, `SCRAM-SHA-256`, and `SCRAM-SHA-512`.\\n\\nIf `GSSAPI` is used for the `sasl_mechanism`, you will need to additionally install\\n[python-gssapi](https://pypi.org/project/python-gssapi/) and the necessary C library\\nKerberos dependencies.\\n\\nIf the `ssl_check_hostname` parameter is enabled, the clients will verify\\nif the broker's hostname matches the certificate. It's used on client's connections\\nand inter-broker connections to prevent man-in-the-middle attacks.\", \"Adding a Kafka Event Broker Using the Endpoint Configuration\": \"You can instruct Rasa to stream all events to your Kafka event broker by adding an `event_broker` section to your\\n`endpoints.yml`.\\n\\nUsing the `SASL_PLAINTEXT` protocol the endpoints file must have the following entries:\\n\\n```\\n```\\n\\nUsing the `PLAINTEXT` protocol the endpoints file must have the following entries:\\n\\n```\\n```\\n\\nIf using the `SSL` protocol, the endpoints file should look like:\\n\\n```\\n```\\n\\nIf using the `SASL_SSL` protocol, the endpoints file should look like:\\n\\n```\\n```\"}, \"SQL Event Broker\": {\"Adding a SQL Event Broker Using the Endpoint Configuration\": \"To instruct Rasa to save all events to your SQL event broker, add an `event_broker` section to your\\n`endpoints.yml`. For example, a valid SQLite configuration\\ncould look like this:\\n\\n```\\nevent_broker:\\n type: SQL\\n dialect: sqlite\\n db: events.db\\n```\\n\\nPostgreSQL databases can be used as well:\\n\\n```\\nevent_broker:\\n type: SQL\\n url: 127.0.0.1\\n port: 5432\\n dialect: postgresql\\n username: myuser\\n password: mypassword\\n db: mydatabase\\n```\\n\\nWith this configuration applied, Rasa will create a table called `events` on the database,\\nwhere all events will be added.\"}, \"FileEventBroker\": \"It is possible to use the `FileEventBroker` as an event broker. This implementation will log events to a file in json format.\\nYou can provide a path key in the `endpoints.yml` file if you wish to override the default file name: `rasa_event.log`.\", \"Custom Event Broker\": {\"Configuration\": \"Put the module path to your custom event broker and the parameters you require in your `endpoints.yml`:\\n\\n```\\nevent_broker:\\n type: path.to.your.module.Class\\n url: localhost\\n a_parameter: a value\\n another_parameter: another value\\n```\"}}, \"metadata\": {\"id\": \"event-brokers\", \"sidebar_label\": \"Event Brokers\", \"title\": \"Event Brokers\", \"description\": \"Find out how open source chatbot framework Rasa allows you to stream events to a message broker.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 14]\"}, {\"title\": \"Fallback and Human Handoff\", \"description\": null, \"content\": {\"Handling Out-of-scope Messages\": {\"1. Creating an Out-of-scope Intent\": \"You will need to define an `out_of_scope` intent in your NLU training data and add any known\\nout-of-scope requests as training examples, for example:\\n\\n```\\nnlu:\\n- intent: out_of_scope\\n examples: |\\n - I want to order food\\n - What is 2 + 2?\\n - Who's the US President?\\n```\\n\\nAs with every intent, you should source the majority of your examples\\n[from real conversations](conversation-driven-development.mdx \\\"Learning from real conversations via conversation-driven development\\\").\", \"2. Defining the response message\": \"You'll need to define an out-of-scope response in the domain file.\\nUsing the utterance `utter_out_of_scope` as the default response, that would look like:\\n\\n```\\nresponses:\\n utter_out_of_scope:\\n - text: Sorry, I can't handle that request.\\n```\", \"3. Creating an Out-of-Scope Rule\": \"Finally, you will need to write a rule for what should happen for in out-of-scope request:\\n\\n```\\nrules:\\n- rule: out-of-scope\\n steps:\\n - intent: out_of_scope\\n - action: utter_out_of_scope\\n```\", \"Handling Specific Out-of-scope Messages\": \"If you observe your users asking for certain things that you'll\\nwant to turn into a user goal in future, you can handle these as separate intents, to let\\nthe user know you've understood their message, but don't have a solution quite yet. For example,\\nif the user asks \\u201cI want to apply for a job at Rasa\\u201d, we can then reply with\\n\\u201cI understand you're looking for a job, but I'm afraid I can't handle that skill yet.\\u201d\\n\\nSimilar to the `out_of_scope` intent example, you'll need to create a new intent with\\ntraining examples, define the response message, and create a rule.\"}, \"Fallbacks\": {\"NLU Fallback\": {\"1. Updating the configuration\": \"To use the FallbackClassifier, add it to your NLU pipeline:\\n\\n```\\npipeline:\\n# other components\\n- name: FallbackClassifier\\n threshold: 0.7\\n```\", \"2. Defining the response message\": \"Define the message the bot should send when a message is classified with low confidence\\nby adding a response:\\n\\n```\\nresponses:\\n utter_please_rephrase:\\n - text: I'm sorry, I didn't quite understand that. Could you rephrase?\\n```\", \"3. Creating an NLU fallback rule\": \"The following\\n[Rule](./rules.mdx) will ask the user to rephrase when they send a message that is\\nclassified with low confidence:\\n\\n```\\nrules:\\n- rule: Ask the user to rephrase whenever they send a message with low NLU confidence\\n steps:\\n - intent: nlu_fallback\\n - action: utter_please_rephrase\\n```\"}, \"Handling Low Action Confidence\": {\"1. Updating the configuration\": \"You will need to add the RulePolicy to your policies in config.yml.\\nBy default, the rule policy comes with the settings below:\\n\\n```\\npolicies:\\n- name: RulePolicy\\n # Confidence threshold for the `core_fallback_action_name` to apply.\\n # The action will apply if no other action was predicted with\\n # a confidence >= core_fallback_threshold\\n core_fallback_threshold: 0.4\\n core_fallback_action_name: \\\"action_default_fallback\\\"\\n enable_fallback_prediction: True\\n```\", \"2. Defining the default response message\": \"To define what your bot will say when action confidence is below the threshold,\\ndefine a response `utter_default`:\\n\\n```\\nresponses:\\n utter_default:\\n - text: Sorry I didn't get that. Can you rephrase?\\n```\\n\\nWhen an action confidence is below the threshold, Rasa will run the action\\n`action_default_fallback`. This will send the response `utter_default` and revert back to the\\nstate of the conversation before the user message that caused the\\nfallback, so it will not influence the prediction of future actions.\", \"3. Customizing the default action (optional)\": \"`action_default_fallback` is a default action in Rasa that sends the\\n`utter_default` response to the user. You can create your own custom action to use as a\\nfallback (see [Custom Actions](./actions.mdx#custom-actions) for more info on custom actions).\\nThe following snippet is an implementation of a custom action which does the same as\\n`action_default_fallback` but dispatches a different template\\n`utter_fallback_template`:\\n\\n```\\nfrom typing import Any, Text, Dict, List\\n\\nfrom rasa_sdk import Action, Tracker\\nfrom rasa_sdk.events import UserUtteranceReverted\\nfrom rasa_sdk.executor import CollectingDispatcher\\n\\nclass ActionDefaultFallback(Action):\\n \\\"\\\"\\\"Executes the fallback action and goes back to the previous state\\n of the dialogue\\\"\\\"\\\"\\n\\n def name(self) -> Text:\\n return ACTION_DEFAULT_FALLBACK_NAME\\n\\n async def run(\\n self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> List[Dict[Text, Any]]:\\n dispatcher.utter_message(template=\\\"my_custom_fallback_template\\\")\\n\\n # Revert user message which led to fallback.\\n return [UserUtteranceReverted()]\\n```\"}, \"Two-Stage Fallback\": {\"1. Updating the configuration\": \"Add FallbackClassifier to your pipeline and the [RulePolicy](./policies.mdx#rule-policy)\\nto your policy configuration:\\n\\n```\\nrecipe: default.v1\\npipeline:\\n# other components\\n- name: FallbackClassifier\\n threshold: 0.7\\n\\npolicies:\\n# other policies\\n- RulePolicy\\n```\", \"2. Defining the fallback responses\": \"To define how your bot asks the user to rephrase their message,\\ndefine the response `utter_ask_rephrase`:\\n\\n```\\nresponses:\\n utter_ask_rephrase:\\n - text: I'm sorry, I didn't quite understand that. Could you rephrase?\\n```\\n\\nRasa provides default implementations for asking which intent the user\\nmeant and for asking the user to rephrase. To customize the behavior of these actions,\\nsee the documentation on [default actions](default-actions.mdx).\", \"3. Defining a Two-Stage Fallback rule\": \"Add the following [Rule](./rules.mdx) to your training data. This rule will make sure\\nthat the Two-Stage-Fallback will be activated whenever a message is received with\\nlow classification confidence:\\n\\n```\\nrules:\\n- rule: Implementation of the Two-Stage-Fallback\\n steps:\\n - intent: nlu_fallback\\n - action: action_two_stage_fallback\\n - active_loop: action_two_stage_fallback\\n```\"}, \"4. Defining an ultimate fallback action\": \"To define the bot's response when the user denies the rephrased intent, define the response `utter_default`:\\n\\n```\\nresponses:\\n utter_default:\\n - text: I'm sorry, I can't help you.\\n```\\n\\nOr, you can customize `action_default_fallback` for more complex behavior by writing a [Custom Action](./actions.mdx#custom-actions). \\nFor example, if you want the bot to call a human and stop interacting with the user:\\n\\n```\\nfrom typing import Any, Dict, List, Text\\n\\nfrom rasa_sdk import Action, Tracker\\nfrom rasa_sdk.events import UserUtteranceReverted\\nfrom rasa_sdk.executor import CollectingDispatcher\\n\\nclass ActionDefaultFallback(Action):\\n def name(self) -> Text:\\n return \\\"action_default_fallback\\\"\\n\\n def run(\\n self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> List[Dict[Text, Any]]:\\n\\n # tell the user they are being passed to a customer service agent\\n dispatcher.utter_message(text=\\\"I am passing you to a human...\\\")\\n \\n # assume there's a function to call customer service\\n # pass the tracker so that the agent has a record of the conversation between the user\\n # and the bot for context\\n call_customer_service(tracker)\\n \\n # pause the tracker so that the bot stops responding to user input\\n return [ConversationPaused(), UserUtteranceReverted()]\\n```\\n\\n:::caution Events Returned By A Custom Ultimate Fallback Action\\nYou should include `UserUtteranceReverted()` as one of the events returned by your custom\\n`action_default_fallback`. Not including this event will cause the tracker to include all events that happened\\nduring the Two-Stage Fallback process which could interfere with subsequent action predictions from the bot's policy\\npipeline. It is better to treat events that occurred during the Two-Stage Fallback process as if they did not happen\\nso that your bot can apply its rules or memorized stories to correctly predict the next action.\\n:::\"}, \"Human Handoff\": \"As part of your fallback action, you may want the bot to hand over to a human agent\\ne.g. as the final action in Two-Stage-Fallback, or when the user explicitly asks\\nfor a human. A straightforward way to achieve human handoff is to configure your\\n[messaging or voice channel](messaging-and-voice-channels.mdx) to switch\\nwhich host it listens to based on a specific bot or user message.\\n\\nFor example, as the final action of Two-Stage-Fallback, the bot could ask the user,\\n\\\"Would you like to be transferred to a human assistant?\\\" and if they say yes, the\\nbot sends a message with a specific payload like\\ne.g. \\\"handoff_to_human\\\" to the channel. When the channel sees this message, it stops listening\\nto the Rasa server, and sends a message to the human channel with the transcript\\nof the chat conversation up to that point.\\n\\nThe implementation for handing off to a human from the front end will depend on which\\nchannel you're using. You can\\nsee an example implementation using an adaption of the [chatroom](https://github.com/scalableminds/chatroom) channel\\nin the [Financial Demo](https://github.com/RasaHQ/financial-demo) and\\n[Helpdesk-Assistant](https://github.com/RasaHQ/helpdesk-assistant)\\nstarterpacks.\", \"Summary\": \"To let your assistant gracefully handle failures, you should handle known\\nout-of-scope messages and add a form of fallback behavior. If you want to add human\\nhandoff, you can add it in addition or as a final step in your fallback\\nset up.\\nHere's a summary of changes you need to make for each method:\\n\\nFor out-of-scope intents:\\n\\n['[ ] Add training examples for each out-of-scope intent to your NLU data', '[ ] Define the out-of-scope response or action', '[ ] Define rules for each out-of-scope intent', '[ ] Add the RulePolicy to config.yml']\\n\\nFor single stage NLU fallback:\\n\\n['[ ] Add FallbackClassifier to your pipeline in config.yml', '[ ] Define the fallback response or action', '[ ] Define a rule for the `nlu_fallback` intent', '[ ] Add the RulePolicy to config.yml']\\n\\nFor handling low core confidence:\\n\\n['[ ] Configure the RulePolicy for core fallback in config.yml', '[ ] Optionally customize the fallback action you configure', '[ ] Define an `utter_default` response']\\n\\nFor Two-Stage Fallback:\\n\\n['[ ] Add FallbackClassifier to your pipeline in `config.yml`', '[ ] Define a rule for the `nlu_fallback` intent that triggers the `action_two_stage_fallback` action', '[ ] Define an out-of-scope intent in your domain', '[ ] Add RulePolicy to config.yml']\\n\\nFor handing off to a human:\\n\\n['[ ] Configure your front end to switch hosts', '[ ] Write a custom action (which could be your fallback action) to send the handoff payload', '[ ] Add a rule for triggering handoff (if not part of fallback)', '[ ] Add RulePolicy to config.yml']\"}, \"metadata\": {\"id\": \"fallback-handoff\", \"sidebar_label\": \"Fallback and Human Handoff\", \"title\": \"Fallback and Human Handoff\", \"abstract\": \"This is a guide on how to handle various failures of your assistant.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 15]\"}, {\"title\": \"Forms\", \"description\": \"Follow a rule-based process of information gathering using forms in open source bot framework Rasa.\", \"content\": {\"Usage\": {\"Defining a Form\": \"Define a form by adding it to the `forms` section in your [domain](./domain.mdx).\\nThe name of the form is also the name of the action which you can use in\\n[stories](./stories.mdx) or [rules](./rules.mdx) to handle form executions.\\nYou will need to specify a list of slot names to the mandatory `required_slots` key.\\n\\nThe following example form `restaurant_form` will fill the slot\\n`cuisine` and slot `num_people`.\\n\\n```\\nentities:\\n- cuisine\\n- number\\nslots:\\n cuisine:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: cuisine\\n num_people:\\n type: any\\n mappings:\\n - type: from_entity\\n entity: number\\nforms:\\n restaurant_form:\\n required_slots:\\n - cuisine\\n - num_people\\n```\\n\\nYou can define a list of intents to ignore for the whole form under the \\n`ignored_intents` key. Intents listed under `ignored_intents` will be added to the\\n`not_intent` key of each slot mapping.\\n\\nFor example, if you do not want any of the required slots of a form to be filled when\\nthe intent is `chitchat`, then you would need to define the following (after the form\\nname and under the `ignored_intents` keyword):\\n\\n```\\nentities:\\n- cuisine\\n- number\\nslots:\\n cuisine:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: cuisine\\n num_people:\\n type: any\\n mappings:\\n - type: from_entity\\n entity: number\\nforms:\\n restaurant_form:\\n ignored_intents: \\n - chitchat\\n required_slots:\\n - cuisine\\n - num_people\\n```\\n\\nOnce the form action gets called for the first time, the form gets activated and will\\nprompt the user for the next required slot value. It does this by\\nlooking for a [response](./responses.mdx) called\\n`utter_ask_<form_name>_<slot_name>` or `utter_ask_<slot_name>` if the former isn't\\nfound. Make sure to define these responses in your domain file for\\neach required slot.\", \"Activating a Form\": \"To activate a form you need to add a [story](./stories.mdx) or [rule](./rules.mdx),\\nwhich describes when the assistant should run the form. In the case a specific intent\\ntriggering a form, you can for example use the following rule:\\n\\n```\\nrules:\\n- rule: Activate form\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n```\\n\\n:::note\\nThe `active_loop: restaurant_form` step indicates that the form should be activated after\\n`restaurant_form` was run.\\n:::\", \"Deactivating a Form\": \"A form will automatically deactivate itself once all required slots are filled.\\nYou can describe your assistant's behavior for the end of a form with a rule or a story.\\nIf you don't add an applicable story or rule, the assistant will automatically listen\\nfor the next user message after the form is finished.\\nThe following example runs the utterances `utter_submit` and `utter_slots_values` as soon as the form\\n`your_form` filled all required slots.\\n\\n```\\nrules:\\n- rule: Submit form\\n condition:\\n # Condition that form is active.\\n - active_loop: restaurant_form\\n steps:\\n # Form is deactivated\\n - action: restaurant_form\\n - active_loop: null\\n - slot_was_set:\\n - requested_slot: null\\n # The actions we want to run when the form is submitted.\\n - action: utter_submit\\n - action: utter_slots_values\\n```\\n\\nUsers might want to break out of a form early. Please see\\n[Writing Stories / Rules for Unhappy Form Paths](./forms.mdx#writing-stories--rules-for-unhappy-form-paths) on how to\\nwrite stories or rules for this case.\", \"Slot Mappings\": \":::caution Changed in 3.0\\nAs of 3.0, [slot mappings](./domain.mdx#slot-mappings) are defined in the `slots` section of the domain.\\nThis change allows the same slot mapping to be reused across multiple forms, removing any unnecessary duplication.\\nPlease follow the [migration guide](./migration-guide.mdx#slot-mappings) to update your assistant.\\n\\nNote specifically the role of [Mapping Conditions](./domain.mdx#mapping-conditions) and the\\n[unique entity mapping](./domain.mdx#unique-from_entity-mapping-matching) constraint.\\n:::\", \"Writing Stories / Rules for Unhappy Form Paths\": \"Your users will not always respond with the information you ask of them.\\nTypically, users will ask questions, make chitchat, change their mind, or otherwise\\nstray from the happy path. \\n\\nWhile a form is active, if a user's input does not fill the requested slot, the execution of \\nthe form action will be rejected i.e. the form will automatically raise an `ActionExecutionRejection`. \\nThese are the specific scenarios in which a form will raise an `ActionExecutionRejection`:\\n\\n[\\\"a slot was requested, but the user didn't fill the slot with their last message and\\\\nyou didn't define a custom action for\\\\n[validating slots](forms.mdx#validating-form-input) or\\\\n[extracting slots](forms.mdx#custom-slot-mappings).\\\", \\\"a slot was requested, but your custom action for\\\\n[validating slots](forms.mdx#validating-form-input) or\\\\n[extracting slots](forms.mdx#custom-slot-mappings) didn't return any `SlotSet` events.\\\"]\\n\\nTo intentionally reject the form execution, you can also return an `ActionExecutionRejected` event as part of your\\ncustom validations or slot mappings.\\n\\nTo handle situations that might cause a form's execution to be rejected, you can write rules\\nor stories that include the expected interruptions. For example, if you expect your users to chitchat with your bot,\\nyou could add a rule to handle this:\\n\\n```\\nrules:\\n- rule: Example of an unhappy path\\n condition:\\n # Condition that form is active.\\n - active_loop: restaurant_form\\n steps:\\n # This unhappy path handles the case of an intent `chitchat`.\\n - intent: chitchat\\n - action: utter_chitchat\\n # Return to form after handling the `chitchat` intent\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n```\\n\\nIn some situations, users may change their mind in the middle of the form action\\nand decide not to go forward with their initial request. In cases like this, the\\nassistant should stop asking for the requested slots.\\n\\nYou can handle such situations\\ngracefully using a default action `action_deactivate_loop` which will deactivate\\nthe form and reset the requested slot. An example story of such conversation could\\nlook as follows:\\n\\n```\\nstories:\\n- story: User interrupts the form and doesn't want to continue\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - intent: stop\\n - action: utter_ask_continue\\n - intent: stop\\n - action: action_deactivate_loop\\n - active_loop: null\\n```\\n\\nIt is **strongly** recommended that you build these rules or stories using\\n[interactive learning](./writing-stories.mdx#using-interactive-learning).\\nIf you write these rules / stories by hand you will likely miss important\\nthings.\"}, \"Advanced Usage\": {\"Validating Form Input\": \"After extracting a slot value from user input, you can validate the extracted slots.\\nBy default Rasa only validates if any slot was filled after requesting\\na slot.\\n\\nYou can implement a [Custom Action](./actions.mdx#custom-actions) `validate_<form_name>`\\nto validate any extracted slots. Make sure to add this action to the `actions`\\nsection of your domain:\\n\\n```\\nactions:\\n- validate_restaurant_form\\n```\\n\\nWhen the form is executed it will run your custom action after every user turn to validate the latest filled slots.\\n\\nThis custom action can extend `FormValidationAction` class to simplify\\nthe process of validating extracted slots. In this case, you need to write functions\\nnamed `validate_<slot_name>` for every extracted slot.\\n\\nThe following example shows the implementation of a custom action\\nwhich validates that the slot named `cuisine` is valid.\\n\\n```\\nfrom typing import Text, List, Any, Dict\\n\\nfrom rasa_sdk import Tracker, FormValidationAction\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk.types import DomainDict\\n\\n\\nclass ValidateRestaurantForm(FormValidationAction):\\n def name(self) -> Text:\\n return \\\"validate_restaurant_form\\\"\\n\\n @staticmethod\\n def cuisine_db() -> List[Text]:\\n \\\"\\\"\\\"Database of supported cuisines\\\"\\\"\\\"\\n\\n return [\\\"caribbean\\\", \\\"chinese\\\", \\\"french\\\"]\\n\\n def validate_cuisine(\\n self,\\n slot_value: Any,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: DomainDict,\\n ) -> Dict[Text, Any]:\\n \\\"\\\"\\\"Validate cuisine value.\\\"\\\"\\\"\\n\\n if slot_value.lower() in self.cuisine_db():\\n # validation succeeded, set the value of the \\\"cuisine\\\" slot to value\\n return {\\\"cuisine\\\": slot_value}\\n else:\\n # validation failed, set this slot to None so that the\\n # user will be asked for the slot again\\n return {\\\"cuisine\\\": None}\\n```\\n\\nYou can also extend the `Action` class and retrieve extracted slots with `tracker.slots_to_validate`\\nto fully customize the validation process.\", \"Custom Slot Mappings\": \":::caution Changed in 3.0\\nThe `slots_mapped_in_domain` argument provided to the `required_slots` method of `FormValidationAction`\\nhas been replaced by the `domain_slots` argument, please update your custom actions to the new argument name.\\n:::\\n\\nIf none of the predefined [Slot Mappings](./domain.mdx#slot-mappings) fit your use\\ncase, you can use the\\n[Custom Action](./actions.mdx#custom-actions) `validate_<form_name>` to write your own\\nextraction code. Rasa will trigger this action when the form is run.\\n\\nIf you're using the Rasa SDK we recommend you to extend the provided\\n`FormValidationAction`. When using the `FormValidationAction`, three steps are required\\nto extract customs slots:\\n\\n['Define a method `extract_<slot_name>` for every slot that should be mapped in a custom way.\\\\nEach slot which has been defined in the `domain.yml` file with a custom mapping **must** have its own independent\\\\nimplementation of an `extract_<slot_name>` method.', \\\"In your domain file, for your form's `required_slots`, list all required slots, with both predefined and custom mappings.\\\"]\\n\\nIn addition, you can override the `required_slots` method to add dynamically requested slots: you can read more in the\\n[Dynamic Form Behavior](./forms.mdx#dynamic-form-behavior) section.\\n\\n:::note\\nIf you have added a slot with a custom mapping in the `slots` section of the domain file which you only\\nwant to be validated within the context of a form by a custom action extending `FormValidationAction`,\\nplease make sure that this slot has a mapping of type `custom` and that the slot name is included in the\\nform's `required_slots`.\\n:::\\n\\nThe following example shows the implementation of a form which extracts a slot\\n`outdoor_seating` in a custom way, in addition to the slots which use predefined mappings.\\nThe method `extract_outdoor_seating` sets the slot `outdoor_seating` based on whether\\nthe keyword `outdoor` was present in the last user message.\\n\\n```\\nfrom typing import Dict, Text, List, Optional, Any\\n\\nfrom rasa_sdk import Tracker\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk.forms import FormValidationAction\\n\\n\\nclass ValidateRestaurantForm(FormValidationAction):\\n def name(self) -> Text:\\n return \\\"validate_restaurant_form\\\"\\n\\n async def extract_outdoor_seating(\\n self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict\\n ) -> Dict[Text, Any]:\\n text_of_last_user_message = tracker.latest_message.get(\\\"text\\\")\\n sit_outside = \\\"outdoor\\\" in text_of_last_user_message\\n\\n return {\\\"outdoor_seating\\\": sit_outside}\\n```\\n\\nBy default the `FormValidationAction`\\nwill automatically set the [`requested_slot`](forms.mdx#the-requested_slot-slot) to the\\nfirst slot specified in `required_slots` which is not filled.\", \"Dynamic Form Behavior\": \"By default, Rasa will ask for the next empty slot from the slots\\nlisted for your form in the domain file. If you use\\n[custom slot mappings](forms.mdx#custom-slot-mappings) and the `FormValidationAction`,\\nit will ask for the first empty slot returned by the `required_slots` method. If all\\nslots in `required_slots` are filled the form will be deactivated.\\n\\nYou can update the required slots of your form dynamically.\\nThis is, for example, useful when you need to fill additional slots based on how\\na previous slot was filled or when you want to change the order in which slots are requested.\\n\\nIf you are using the Rasa SDK, we strongly recommend that you use the `FormValidationAction` and\\noverride `required_slots` to fit your dynamic behavior. You must implement\\na method `extract_<slot name>` for every slot which doesn't use a predefined mapping,\\nas described in [Custom Slot Mappings](forms.mdx#custom-slot-mappings).\\nThe example below will ask the user if they want to sit in\\nthe shade or in the sun in case they said they want to sit outside.\\n\\n```\\nfrom typing import Text, List, Optional\\n\\nfrom rasa_sdk.forms import FormValidationAction\\n\\nclass ValidateRestaurantForm(FormValidationAction):\\n def name(self) -> Text:\\n return \\\"validate_restaurant_form\\\"\\n\\n async def required_slots(\\n self,\\n domain_slots: List[Text],\\n dispatcher: \\\"CollectingDispatcher\\\",\\n tracker: \\\"Tracker\\\",\\n domain: \\\"DomainDict\\\",\\n ) -> List[Text]:\\n additional_slots = [\\\"outdoor_seating\\\"]\\n if tracker.slots.get(\\\"outdoor_seating\\\") is True:\\n # If the user wants to sit outside, ask\\n # if they want to sit in the shade or in the sun.\\n additional_slots.append(\\\"shade_or_sun\\\")\\n\\n return additional_slots + domain_slots\\n```\\n\\nIf conversely, you want to remove a slot from the form's `required_slots` defined in the domain file under certain conditions,\\nyou should copy the `domain_slots` over to a new variable and apply changes to that new variable instead of directly modifying\\n`domain_slots`. Directly modifying `domain_slots` can cause unexpected behaviour. For example:\\n\\n```\\nfrom typing import Text, List, Optional\\n\\nfrom rasa_sdk.forms import FormValidationAction\\n\\nclass ValidateBookingForm(FormValidationAction):\\n def name(self) -> Text:\\n return \\\"validate_booking_form\\\"\\n\\n async def required_slots(\\n self,\\n domain_slots: List[Text],\\n dispatcher: \\\"CollectingDispatcher\\\",\\n tracker: \\\"Tracker\\\",\\n domain: \\\"DomainDict\\\",\\n ) -> List[Text]:\\n updated_slots = domain_slots.copy()\\n if tracker.slots.get(\\\"existing_customer\\\") is True:\\n # If the user is an existing customer,\\n # do not request the `email_address` slot\\n updated_slots.remove(\\\"email_address\\\")\\n\\n return updated_slots\\n```\", \"The requested_slot slot\": \"The slot `requested_slot` is automatically added to the domain as a\\nslot of type [`text`](domain.mdx#text-slot). The value of the `requested_slot` will be\\nignored during conversations. If you want to change this behavior, you need to add\\nthe `requested_slot` to your domain file as a categorical slot with\\n`influence_conversation` set to `true`.\\nYou might want to do this if you\\nwant to handle your unhappy paths differently, depending on what slot is\\ncurrently being asked from the user. For example, if your users respond\\nto one of the bot's questions with another question, like *why do you need to know that?*\\nThe response to this `explain` intent depends on where we are in the story.\\nIn the restaurant case, your stories would look something like this:\\n\\n```\\nstories:\\n- story: explain cuisine slot\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant\\n - slot_was_set:\\n - requested_slot: cuisine\\n - intent: explain\\n - action: utter_explain_cuisine\\n - action: restaurant_form\\n - active_loop: null\\n\\n- story: explain num_people slot\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant\\n - slot_was_set:\\n - requested_slot: cuisine\\n - slot_was_set:\\n - requested_slot: num_people\\n - intent: explain\\n - action: utter_explain_num_people\\n - action: restaurant_form\\n - active_loop: null\\n```\\n\\nAgain, it is **strongly** recommended that you use\\n[interactive learning](./writing-stories.mdx#using-interactive-learning) to build these stories.\", \"Using a Custom Action to Ask For the Next Slot\": \"As soon as the form determines which slot has to be filled next by the user, it will\\nexecute the action `utter_ask_<form_name>_<slot_name>` or `utter_ask_<slot_name>`\\nto ask the user to provide the necessary information. If a regular utterance is not\\nenough, you can also use a custom action `action_ask_<form_name>_<slot_name>` or\\n`action_ask_<slot_name>` to ask for the next slot.\\n\\n```\\nfrom typing import Dict, Text, List\\n\\nfrom rasa_sdk import Tracker\\nfrom rasa_sdk.events import EventType\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk import Action\\n\\n\\nclass AskForSlotAction(Action):\\n def name(self) -> Text:\\n return \\\"action_ask_cuisine\\\"\\n\\n def run(\\n self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict\\n ) -> List[EventType]:\\n dispatcher.utter_message(text=\\\"What cuisine?\\\")\\n return []\\n```\\n\\nIf there is more than one asking option for the slot, Rasa prioritizes in the following order:\\n\\n['`action_ask_<form_name>_<slot_name>`', '`utter_ask_<form_name>_<slot_name>`', '`action_ask_<slot_name>`', '`utter_ask_<slot_name>`']\"}}, \"metadata\": {\"id\": \"forms\", \"sidebar_label\": \"Forms\", \"title\": \"Forms\", \"description\": \"Follow a rule-based process of information gathering using forms in open source bot framework Rasa.\", \"abstract\": \"One of the most common conversation patterns is to collect a few pieces of information from a user in order to do something (book a restaurant, call an API, search a database, etc.). This is also called **slot filling**.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 16]\"}, {\"title\": \"Generating NLU Data\", \"description\": null, \"content\": {\"Conversation-Driven Development for NLU\": {\"Gather Real Data\": \"When it comes to building out NLU training data, developers are sometimes tempted\\nto use text generation tools or templates to quickly increase the number of training examples.\\nThis is a bad idea for two reasons:\\n\\n[\\\"First, your synthetic data won't look like the messages\\\\nthat users actually send to your assistant, so your model will underperform.\\\", \\\"Second, by training and testing on synthetic data, you trick yourself into thinking that your\\\\nmodel *is* actually performing well, and you won't notice major issues.\\\"]\\n\\nRemember that if you use a script to generate training data, the only thing your model can\\nlearn is how to reverse-engineer the script. \\n\\nTo avoid these problems, it is always a good idea to collect as much real user data\\nas possible to use as training data. Real user messages can be messy, contain typos,\\nand be far from 'ideal' examples of your intents. But keep in mind that those are the\\nmessages you're asking your model to make predictions about!\\nYour assistant will always make mistakes initially, but\\nthe process of training & evaluating on user data will set your model up to generalize\\nmuch more effectively in real-world scenarios.\", \"Share with Test Users Early\": \"In order to gather real data, you\\u2019re going to need real user messages. A bot developer\\ncan only come up with a limited range of examples, and users will always surprise you\\nwith what they say. This means you should share your bot with test users outside the\\ndevelopment team as early as possible.\\nSee the full [CDD guidelines](./conversation-driven-development.mdx) for more details.\"}, \"Avoiding Intent Confusion\": {\"Splitting on Entities vs Intents\": \"Intent confusion often occurs when you want your assistant's response to be conditioned on\\ninformation provided by the user. For example,\\n\\\"How do I migrate to Rasa from IBM Watson?\\\" versus \\\"I want to migrate from Dialogflow.\\\"\\n\\nSince each of these messages will lead to a different response, your initial approach might be to create\\nseparate intents for each migration type, e.g. `watson_migration` and `dialogflow_migration`.\\nHowever, these intents are trying to achieve the same goal (migrating to Rasa) and will\\nlikely be phrased similarly, which may cause the model to confuse these intents.\\n\\nTo avoid intent confusion, group these training examples into single `migration` intent and make\\nthe response depend on the value of a categorical `product` slot that comes from an entity.\\nThis also makes it easy to handle the case when no entity is provided,\\ne.g. \\\"How do I migrate to Rasa?\\\" For example:\\n\\n```\\nstories:\\n- story: migrate from IBM Watson\\n steps:\\n - intent: migration\\n entities:\\n - product\\n - slot_was_set:\\n - product: Watson\\n - action: utter_watson_migration\\n\\n- story: migrate from Dialogflow\\n steps:\\n - intent: migration\\n entities:\\n - product\\n - slot_was_set:\\n - product: Dialogflow\\n - action: utter_dialogflow_migration\\n\\n- story: migrate from unspecified\\n steps:\\n - intent: migration\\n - action: utter_ask_migration_product\\n```\"}, \"Improving Entity Recognition\": {\"Pre-trained Entity Extractors\": \"Common entities such as names, addresses, and cities require a large amount of training\\ndata for an NLU model to generalize effectively.\\n\\nRasa provides two great options for\\npre-trained extraction: [SpacyEntityExtractor](./components.mdx#SpacyEntityExtractor)\\nand [DucklingEntityExtractor](./components.mdx#DucklingEntityExtractor).\\nBecause these extractors have been pre-trained on a large corpus of data, you can use them\\nto extract the entities they support without annotating them in your training data.\", \"Regexes\": \"Regexes are useful for performing entity extraction on structured patterns such as 5-digit\\nU.S. zip codes. Regex patterns can be used to generate features for the NLU model to learn,\\nor as a method of direct entity matching.\\nSee [Regular Expression Features](./training-data-format.mdx#regular-expressions)\\nfor more information.\", \"Lookup Tables\": \"Lookup tables are processed as a regex pattern that checks if any of the lookup table\\nentries exist in the training example. Similar to regexes, lookup tables can be used\\nto provide features to the model to improve entity recognition, or used to perform\\nmatch-based entity recognition. Examples of useful applications of lookup tables are\\nflavors of ice cream, brands of bottled water, and even sock length styles\\n(see [Lookup Tables](./training-data-format.mdx#lookup-tables)).\", \"Synonyms\": \"Adding synonyms to your training data is useful for mapping certain entity values to a\\nsingle normalized entity. Synonyms, however, are not meant for improving your model's\\nentity recognition and have no effect on NLU performance.\\n\\nA good use case for synonyms is when normalizing entities belonging to distinct groups.\\nFor example, in an assistant that asks users what insurance policies they're interested\\nin, they might respond with \\\"my truck,\\\" \\\"a car,\\\" or \\\"I drive a batmobile.\\\"\\nIt would be a good idea to map `truck`, `car`, and `batmobile` to the normalized value\\n`auto` so that the processing logic will only need to account for a narrow set of\\npossibilities (see [synonyms](./training-data-format.mdx#synonyms)).\\n\\nSynonyms can also be used to standardize the extracted entities. A synonym for `iPhone` can \\nmap `iphone` or `IPHONE` to the synonym without adding these options in the synonym examples.\"}, \"Handling Edge Cases\": {\"Misspellings\": \"Coming across misspellings is inevitable, so your bot needs an effective way to\\nhandle this. Keep in mind that the goal is not to correct misspellings, but to\\ncorrectly identify intents and entities. For this reason, while a spellchecker may\\nseem like an obvious solution, adjusting your featurizers and training data is often\\nsufficient to account for misspellings.\\n\\nAdding a character-level featurizer provides\\nan effective defense against spelling errors by accounting for parts of words, instead\\nof only whole words. You can add character level featurization to your pipeline by\\nusing the `char_wb` analyzer for the `CountVectorsFeaturizer`, for example:\\n\\n```\\npipeline:\\n# <other components>\\n- name: CountVectorsFeaturizer\\n analyze: char_wb\\n min_ngram: 1\\n max_ngram: 4\\n# <other components>\\n```\\n\\nIn addition to character-level featurization, you can add common misspellings to\\nyour training data.\", \"Defining an Out-of-scope Intent\": \"It is always a good idea to define an `out_of_scope` intent in your bot to capture\\nany user messages outside of your bot's domain. When an `out_of_scope` intent is\\nidentified, you can respond with messages such as \\\"I'm not sure how to handle that,\\nhere are some things you can ask me...\\\" to gracefully guide the user towards a\\nsupported skill.\"}, \"Shipping Updates\": \"Treat your data like code. In the same way that you would never ship code updates\\nwithout reviews, updates to your training data should be carefully reviewed because\\nof the significant influence it can have on your model's performance.\\n\\nUse a version control system such as Github or Bitbucket to track changes to your\\ndata and rollback updates when necessary.\\n\\nBe sure to build tests for your NLU models to [evaluate performance](./testing-your-assistant.mdx) as training data\\nand hyper-parameters change. Automate these tests in a [CI pipeline](./setting-up-ci-cd.mdx) such as Jenkins\\nor Git Workflow to streamline your development process and ensure that only\\nhigh-quality updates are shipped.\"}, \"metadata\": {\"id\": \"generating-nlu-data\", \"sidebar_label\": \"Generating NLU Data\", \"title\": \"Generating NLU Data\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 17]\"}, {\"title\": \"Rasa Glossary\", \"description\": \"Glossary for all Rasa-related terms\", \"content\": {\"[Action](./actions.mdx)\": \"A single step that a bot takes in a conversation (e.g. calling an API or sending a response back to the user).\", \"[Action Server](./action-server/index.mdx)\": \"The server that runs custom action code, separate from Rasa. Rasa maintains the Rasa SDK in Python for implementing custom actions, although it's also possible to write custom actions in other languages.\", \"Annotation\": \"Adding labels to messages and conversations so that they can be used to train a model.\", \"[Anonymization](./pii-management.mdx)\": \"The process of replacing personally identifiable information (PII) with masked, artificial or constant text values.\\nThis is done to protect the privacy of users.\", \"[Business Logic](./business-logic.mdx)\": \"Conditions that need to be fulfilled due to business requirements. For example: requiring a first and last name, an address, and a password before an account can be created. In a Rasa assistant, business logic is implemented using rule-based actions like [forms](./forms.mdx).\", \"[Chitchat](./chitchat-faqs.mdx)\": \"A conversation pattern where the user says something that isn't directly related to their goal.\\nThis can include things like greetings, asking how you are etc.\\nRead about handling [Chitchat and FAQs](./chitchat-faqs.mdx) to learn how to implement this with Rasa.\", \"CMS\": \"A way to store bot responses externally instead of including them directly in the domain. Content Management Systems decouple response text from training data. For more information, see [NLG Servers](./nlg.mdx).\", \"[Conversation-Driven Development (CDD)](./conversation-driven-development.mdx)\": \"The process of using user messages and conversation data to influence the design of an assistant and train the model, combined with engineering best practices. There are 6 steps that make up CDD: Share, Review, Annotate, Fix, Track, and Test.\", \"[Conversation Tests](./testing-your-assistant.mdx)\": \"Modified story format that includes the full text of the user message in addition to the intent label. Test conversations are saved to a test set file (conversation_tests.md), which is used to evaluate the model\\u2019s predictions across an entire conversation.\", \"[Component](./components.mdx)\": \"An element in the an assistant's [NLU pipeline](./tuning-your-model.mdx#how-to-choose-a-pipeline) in the [Model Configuration](./model-configuration.mdx).\\n\\nIncoming messages are processed by a sequence of components called a pipeline. A component can perform tasks ranging from entity extraction to intent classification to pre-processing.\", \"[Conditional Response Variation](./responses.mdx#conditional-response-variations)\": \"Response variation that can only be used when the current dialogue state satisfies some constraints as defined in the domain or responses files. If there's a match between the constraints and the dialogue state, Rasa can use this variation.\", \"[Custom Action](./actions.mdx#custom-actions)\": \"An action written by a bot developer that can run arbitrary code, mainly to interact with external systems and APIs.\", \"[Default Action](./actions.mdx#default-actions)\": \"A built-in action that comes with predefined functionality.\", \"[DIET](./components.mdx#dietclassifier)\": \"Dual Intent and Entity Transformer. The default NLU architecture used by Rasa, which performs both intent classification and entity extraction.\", \"[Domain](./domain.mdx)\": \"Defines the inputs and outputs of an assistant.\\n\\nIt includes a list of all the intents, entities, slots, actions, and forms that the assistant knows about.\", \"[Entity](./training-data-format.mdx#entities)\": \"Keywords that can be extracted from a user message. For example: a telephone number, a person's name, a location, the name of a product\", \"[Event](./action-server/events.mdx)\": \"Something that happens in a conversation. For instance, a `UserUttered` event represents a user entering a message, and an `ActionExecuted` event represents the assistant executing an action. All conversations in Rasa are represented as a sequence of events.\", \"FAQs\": \"Frequently asked questions (FAQs) are common questions that your users ask. In the context of building an assistant,\\nthis typically means the user sends a message and the assistant send a response without needing to consider the context of the conversation.\\nRead about handling [Chitchat and FAQs](./chitchat-faqs.mdx) to learn how to implement this with Rasa.\", \"[Form](./forms.mdx)\": \"A type of custom action that asks the user for multiple pieces of information.\\n\\nFor example, if you need a city, a cuisine, and a price range to recommend a restaurant, you can create a restaurant form to collect the information. You can describe [business logic](#business-logic) inside a form, like offering the customer a different set of menu options if they mention a food allergy.\", \"Happy / Unhappy Paths\": \"Terms used to describe whether the user\\u2019s input is expected or unexpected. If your assistant asks a user for some information and the user provides it, we call that a happy path. Unhappy paths are all possible edge cases. For example, the user refusing to give the requested input, changing the topic of conversation, or correcting something they said earlier.\", \"[Intent](./nlu-training-data.mdx)\": \"In a given user message, the thing that a user is trying to convey or accomplish (e,g., greeting, specifying a location).\", \"[Interactive Learning](./writing-stories.mdx#using-interactive-learning)\": \"In the Rasa CLI, a training mode where the developer corrects and validates the assistant\\u2019s predictions at every step of the conversation. The conversation can be saved to the story format and added to the assistant\\u2019s training data.\", \"[Knowledge Base / Knowledge Graph](./action-server/knowledge-base-actions.mdx)\": \"A queryable database that represents complex relationships and hierarchies between objects. Knowledge Base Actions allow Rasa to fetch information from a knowledge base and use it in responses.\", \"[Level 3 Assistant](https://blog.rasa.com/5-levels-of-conversational-ai-2020-update/)\": \"An assistant that can handle conversations more complex than simple back-and-forth exchanges. Level 3 assistants are capable of using the context of previous conversation turns to choose the appropriate next action.\", \"[Messaging Channels](./messaging-and-voice-channels.mdx)\": \"Connectors that integrate Rasa with external messaging platforms, where end-users can send and receive messages. Rasa includes built-in messaging channels like Slack, Facebook Messenger, and web chat, as well as the ability to create custom connectors.\", \"[Minimum Viable Assistant](./conversation-driven-development.mdx#cdd-in-early-stages-of-development)\": \"A basic assistant that can handle the most important happy path stories.\", \"[NLG](./nlg.mdx)\": \"Natural Language Generation (NLG) is the process of generating natural language messages to send to a user.\\n\\nRasa uses a simple template-based approach for NLG. Data-driven approaches (such as neural NLG) can be implemented by creating a custom NLG component.\", \"[NLU](./nlu-training-data.mdx)\": \"Natural Language Understanding (NLU) deals with parsing and understanding human language into a structured format.\", \"[Pipeline](./tuning-your-model.mdx)\": \"The list of NLU components (see [NLU Component](#nlu-component)) that defines a Rasa assistant\\u2019s NLU system. A user message is processed by each component one by one, before returning the final structured output.\", \"[Policy](./policies.mdx)\": \"Rasa components that predict the dialogue system\\u2019s next actionPolicies make decisions about how the conversation flow should proceed. A typical configuration includes multiple policies, and the policy with the highest confidence decides the next action to be taken in the conversation.\", \"Rasa Core\": \"(Outdated - Rasa Core and Rasa NLU were merged into one package in 1.x. The functionality of Core is now referred to as dialogue management)\\n\\nThe dialogue engine that decides what to do next in a conversation based on the context. Part of the Rasa library.\", \"Rasa NLU\": \"(Outdated - Rasa Core and Rasa NLU were merged into one package in 1.x. The functionality of Rasa NLU is now referred to as NLU)\\n\\nRasa NLU is the part of Rasa that performs Natural Language Understanding ([NLU](#nlu)), including intent classification and entity extraction.\", \"[NLU Component](./components.mdx)\": \"An element in the Rasa NLU pipeline (see [Pipeline](#pipeline)) that processes incoming messages. Components perform tasks ranging from entity extraction to intent classification to pre-processing.\", \"[Rasa X/Enterprise](https://rasa.com/docs/rasa-enterprise/)\": \"A tool for [conversation-driven development](./conversation-driven-development.mdx). Rasa X/Enterprise helps teams share and test an assistant built with Rasa, annotate user messages, and view conversations.\", \"[Retrieval Intent](./chitchat-faqs.mdx)\": \"A special type of intent that can be divided into smaller sub-intents. For example, an FAQ retrieval intent has sub-intents that represent each individual question the assistant knows how to answer.\", \"[REST Channel](./connectors/your-own-website.mdx)\": \"A messaging channel used to build custom connectors. Includes an input channel, where user messages can be posted to Rasa, and the ability to specify a callback URL, where the bot\\u2019s response actions will be sent.\", \"[Response / Template / Utterance](./responses.mdx)\": \"A message that an assistant sends to a user. This can include text, buttons, images, and other content.\", \"[Rules](./rules.mdx)\": \"Special training data to specify rule-like behavior, where a specific condition always predicts a specific next action. Examples include\\nanswering FAQs, filling [Forms](./forms.mdx), or handling\\n[Fallbacks](./fallback-handoff.mdx#fallbacks).\", \"[Slot](./domain.mdx#slots)\": \"A key-value store that Rasa uses to track information over the course of a conversation.\", \"[Story](./stories.mdx)\": \"Training data format for the dialogue model, consisting of a conversation between a user and a bot. The user's messages are represented as annotated intents and entities, and the bot\\u2019s responses are represented as a sequence of actions.\", \"[TED Policy](./policies.mdx#ted-policy)\": \"Transformer Embedding Dialogue Policy. TED is the default machine learning-based dialogue policy used by Rasa. TED complements rule-based policies by handling previously unseen situations, where no rule exists to determine the next action.\", \"[Template / Response / Utterance](./responses.mdx)\": \"A message template used to respond to a user. Can include text, buttons, images, and other attachments.\", \"[Tracker](./tracker-stores.mdx)\": \"Rasa component that maintains the state of the dialogue, which is represented as a JSON object listing the events from the current session.\", \"User Goal\": \"The overall goal that a user wants to achieve, e.g. looking up the answer to a question, booking an appointment, or purchasing an insurance policy.\\n\\nSome tools refer to the user goal as the \\u201cintent,\\u201d but in Rasa terminology, an intent is associated with each individual user message.\", \"Word embedding / Word vector\": \"A vector of floating point numbers that represent the meaning of a word. Words that have similar meanings tend to have similar vectors. Word embeddings are often used as an input to machine learning algorithms.\", \"Rasa Primitive\": \"A foundational component used for structuring conversations within Rasa, such as an intent, entity, slot, form, response, action, rule, or story.\"}, \"metadata\": {\"id\": \"glossary\", \"sidebar_label\": \"Rasa Glossary\", \"title\": \"Rasa Glossary\", \"description\": \"Glossary for all Rasa-related terms\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 18]\"}, {\"title\": \"Graph Recipe\", \"description\": \"Learn about Graph Recipe for Rasa.\", \"content\": {\"Differences with Default Recipe\": \"There are some differences between the default recipe and the new graph recipe. Main differences are:\\n\\n['Default recipe is named `default.v1` in the config file whereas graph recipes are named `graph.v1`.', 'Default recipes provide an easy to use recipe structure whereas graph recipes are more advanced and powerful.', 'Default recipes are very opinionated and provide various defaults whereas graph recipes are more explicit.', 'Default recipes can auto-configure themselves and dump the defaults used to the file if some sections in `config.yml` are missing, whereas graph recipes do none of this and assume what you see is what you get. There are no surprises with graph recipes.', 'Default recipe divides graph configuration into mainly two parts: `pipeline` and `policies`. These can also be described as NLU and core (dialogue management) parts. For graph recipe on the other hand, the separation is between training (ie. `train_schema`) and prediction (ie. `predict_schema`).']\\n\\n:::tip Starting from scratch?\\n\\nIf you don't know which recipe to choose, use the default recipe to bootstrap your project fast. If later you find that you need more fine-grained control, you can always change your recipe to be a graph recipe.\\n\\n:::\", \"Graph Configuration File Structure\": \"Graph recipes share `recipe` and `language` keys with the same meaning. Similarities end there as graph recipes do not have `pipeline` or `policies` keys but they do have `train_schema` and `predict_schema` keys for determining the graph nodes during train and predict runs respectively. In addition to this, target nodes for NLU and core can be specified explicitly with graph recipes, these can be declared with `nlu_target` and `core_target`. If targets are omitted, node names used by default recipe will take over, and these are `run_RegexMessageHandler` and `select_prediction` for nlu and core respectively.\\n\\nHere's an example graph recipe:\\n\\n```\\n```\\n\\n:::note graph targets\\nFor NLU, default target name of `run_RegexMessageHandler` will be used, while for core (dialogue management) the target will be called `select_prediction` if omitted. Make sure you have graph nodes with relevant names in your schema definitions.\\n\\nIn a similar fashion, note that the default resource needed by the first graph node is fixed to be `__importer__` (representing configuration, training data etc.) for training task and it is `__message__` (representing the message received) for prediction task. Make sure your first nodes make use of these dependencies.\\n\\n:::\", \"Graph Node Configuration\": \"As you can see in the example above, graph recipes are very much explicit and you can configure each graph node as you would like. Here is an explanation of what some of the keys mean:\\n\\n['`needs`: You can define here what data your graph node requires and from which parent node. Key is the data name, whereas the value would refer to the node name.']\\n\\n```\\nneeds:\\n messages: nlu_message_converter\\n```\\n\\nCurrent graph node needs `messages` which is provided by `nlu_message_converter` node.\\n\\n['`uses`: You can provide the class used to instantiate this node with this key. Please provide the full path in Python path syntax, eg.']\\n\\n```\\nuses: rasa.graph_components.converters.nlu_message_converter.NLUMessageConverter\\n```\\n\\nYou are not required to use Rasa internal graph component classes and you\\ncan use your own components here. Refer to [custom graph\\ncomponents](custom-graph-components.mdx) pages to find out how to write your\\nown graph components.\\n\\n['`constructor_name`: This is the constructor used to instantiate your component. Example:']\\n\\n```\\nconstructor_name: load\\n```\\n\\n['`fn`: This is the function used in executing the graph component. Example:']\\n\\n```\\nfn: combine_predictions_from_kwargs\\n```\\n\\n['`config`: You can provide any configuration parameters for your components using this key.']\\n\\n```\\nconfig:\\n language: en\\n persist: false\\n```\\n\\n['`eager`: This determines if your component should be eagerly loaded\\\\nwhen the graph is constructed or if it should wait until the\\\\nruntime (this is called lazy instantiation). Usually we always\\\\ninstantiate lazily during training and eagerly during inference (to\\\\navoid slow first prediction).']\\n\\n```\\neager: true\\n```\\n\\n['`resource`: If given, graph node is loaded from this resource instead of instantiated from scratch. This is e.g. used to load a trained component for predictions.']\\n\\n```\\nresource:\\n name: train_RulePolicy1\\n```\\n\\n[\\\"`is_target`: Boolean value, if `True` then this node can't be pruned\\\\nduring fingerprinting (it might be replaced with a cached value\\\\nthough). This\\\\nis e.g. used for all components which train as their result always needs\\\\nto be added to the model archive so that the data is available during\\\\ninference.\\\"]\\n\\n```\\nis_target: false\\n```\\n\\n['`is_input`: Boolean value; nodes with `is_input` are _always_ run (also during the\\\\nfingerprint run). This makes sure that we e.g. detect changes in file\\\\ncontents.']\\n\\n```\\n is_input: false\\n```\"}, \"metadata\": {\"id\": \"graph-recipe\", \"sidebar_label\": \"Graph Recipe\", \"title\": \"Graph Recipe\", \"description\": \"Learn about Graph Recipe for Rasa.\", \"abstract\": \"Graph recipes provide a more fine tuned configuration for your executable graphs.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 19]\"}, {\"title\": \"Rasa HTTP API\", \"description\": \"Read about Rasa's HTTP API that has endpoints for conversations, training models, and configuring your bot.\", \"content\": {\"Enabling the HTTP API\": \"By default, running a Rasa server does not enable the API endpoints. Interactions\\nwith the bot can happen over the exposed `webhooks/<channel>/webhook` endpoints.\\n\\nTo enable the API for direct interaction with conversation trackers and other\\nbot endpoints, add the `--enable-api` parameter to your run command:\\n\\n```\\nrasa run --enable-api\\n```\\n\\nNote that you start the server with an NLU-only model, not all the available endpoints\\ncan be called. Some endpoints will return a 409 status code, as a trained\\ndialogue model is needed to process the request.\\n\\n:::caution\\nMake sure to secure your server, either by restricting access to the server (e.g. using firewalls), or\\nby enabling an authentication method. See [Security Considerations](./http-api.mdx#security-considerations).\\n\\n:::\\n\\nBy default, the HTTP server runs as a single process. You can change the number\\nof worker processes using the `SANIC_WORKERS` environment variable. It is\\nrecommended that you set the number of workers to the number of available CPU cores\\n(check out the\\n[Sanic docs](https://sanicframework.org/en/guide/deployment/running.html#workers)\\nfor more details). This will only work in combination with the\\n`RedisLockStore` (see [Lock Stores](./lock-stores.mdx).\\n\\n:::caution\\nThe [SocketIO channel](./connectors/your-own-website.mdx#websocket-channel) does not support multiple worker processes. \\n\\n:::\", \"Security Considerations\": {\"Token Based Auth\": \"To use a plaintext token to secure your server, specify the token in the argument `--auth-token thisismysecret` when starting\\nthe server:\\n\\n```\\nrasa run \\\\\\n --enable-api \\\\\\n --auth-token thisismysecret\\n```\\n\\nAny clients sending requests to the server must pass the token\\nas a query parameter, or the request will be rejected. For example, to fetch a tracker from the server:\\n\\n```\\ncurl -XGET localhost:5005/conversations/default/tracker?token=thisismysecret\\n```\", \"JWT Based Auth\": \"To use JWT based authentication, specify the JWT secret in the argument `--jwt-secret thisismysecret`\\non startup of the server:\\n\\n```\\nrasa run \\\\\\n --enable-api \\\\\\n --jwt-secret thisismysecret\\n```\\n\\nIf you want to sign a JWT token with asymmetric algorithms, you can specify the JWT private key to the `--jwt-private-key`\\nCLI argument. You must pass the public key to the `--jwt-secret` argument, and also specify the algorithm to the\\n`--jwt-method` argument:\\n\\n```\\nrasa run \\\\\\n --enable-api \\\\\\n --jwt-secret <public_key> \\\\\\n --jwt-private-key <private_key> \\\\\\n --jwt-method RS512\\n```\\n\\nClient requests to the server will need to contain a valid JWT token in\\nthe `Authorization` header that is signed using this secret\\nand the `HS256` algorithm e.g.\\n\\n```\\n\\\"Authorization\\\": \\\"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ\\\"\\n \\\"zdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIi\\\"\\n \\\"wiaWF0IjoxNTE2MjM5MDIyfQ.qdrr2_a7Sd80gmCWjnDomO\\\"\\n \\\"Gl8eZFVfKXA6jhncgRn-I\\\"\\n```\\n\\nThe token's payload must contain an object under the `user` key,\\nwhich in turn must contain the `username` and `role` attributes.\\nThe following is an example payload for a JWT token:\\n\\n```\\n{\\n \\\"user\\\": {\\n \\\"username\\\": \\\"<sender_id>\\\",\\n \\\"role\\\": \\\"user\\\"\\n }\\n}\\n```\\n\\nIf the `role` is `admin`, all endpoints are accessible.\\nIf the `role` is `user`, endpoints with a `sender_id` parameter are only accessible\\nif the `sender_id` matches the payload's `username` property.\\n\\n```\\nrasa run \\\\\\n -m models \\\\\\n --enable-api \\\\\\n --jwt-secret thisismysecret\\n```\\n\\nTo create and encode the token, you can use tools such as the [JWT Debugger](https://jwt.io/), or a Python module such as [PyJWT](https://pyjwt.readthedocs.io/en/latest/).\"}}, \"metadata\": {\"id\": \"http-api\", \"sidebar_label\": \"HTTP API\", \"title\": \"Rasa HTTP API\", \"description\": \"Read about Rasa's HTTP API that has endpoints for conversations, training models, and configuring your bot.\", \"abstract\": \"You can use the HTTP API to interact with a running Rasa server. With the API, you can train models, send messages, run tests, and more.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 20]\"}, {\"title\": \"Introduction to Rasa Open Source & Rasa Pro\", \"description\": \"Learn more about open-source natural language processing library Rasa for conversation handling, intent classification and entity extraction in on premise chatbots.\", \"content\": {\"Rasa Open Source\": \"Rasa Open Source is an open source conversational AI platform that allows you to understand and hold conversations, and connect to messaging channels and third party systems through a set of APIs. It supplies the building blocks for creating virtual (digital) assistants or chatbots.\", \"Rasa Pro\": \"<RasaProBanner/>\\n\\nRasa Pro is the commercial, pro-code offering of Rasa that\\u2019s built to address enterprise needs\\naround security, observability and scale. [Read more here](./rasa-pro.mdx).\\n\\nWhen the content is only applicable to Rasa Pro, you will see the below label:\\n\\n<RasaProLabel />\\n\\nThis means you need to have a Rasa Pro License in order to access the capabilities detailed in that section.\"}, \"metadata\": {\"slug\": \"/\", \"sidebar_label\": \"Introduction\", \"title\": \"Introduction to Rasa Open Source & Rasa Pro\", \"hide_table_of_contents\": true, \"description\": \"Learn more about open-source natural language processing library Rasa for conversation handling, intent classification and entity extraction in on premise chatbots.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 21]\"}, {\"title\": \"Jupyter Notebooks\", \"description\": \"Learn how to integrate open source chatbot platform Rasa into Jupyter notebooks, alongside all your machine learning code.\", \"content\": {\"Train a Model\": \"Now we can train a model by passing in the paths to the `rasa.train` function.\\nNote that the training files are passed as a list.\\nWhen training has finished, `rasa.train` returns the path where the trained model has been saved.\\n\\n```\\nimport rasa\\n\\nmodel_path = rasa.train(domain, config, [training_files], output)\\nprint(model_path)\\n```\", \"Chat with your assistant\": \"To start chatting to an assistant, call the `chat` function, passing\\nin the path to your saved model. If you do not have custom actions you can set `endpoints = None` or omit it:\\n\\n```\\nfrom rasa.jupyter import chat\\n\\nendpoints = \\\"endpoints.yml\\\"\\nchat(model_path, endpoints)\\n```\", \"Evaluate your model against test data\": \"Rasa has a convenience function for getting your training data.\\nRasa's `get_core_directory` and `get_nlu_directory` are functions which\\nrecursively find all the stories or NLU data files\\nand copies them into temporary directories.\\nThe return values are the paths to these newly created directories.\\n\\n```\\nimport rasa.shared.data as data\\nnlu_data_directory = data.get_nlu_directory(training_files)\\nstories_directory = data.get_core_directory(training_files)\\nprint(stories_directory, nlu_data_directory)\\n```\\n\\nTo test your model, call the `test` function, passing in the path\\nto your saved model and directories containing the stories and nlu data\\nto evaluate on.\\n\\n```\\nrasa.test(model_path, stories_directory, nlu_data_directory)\\nprint(\\\"Done testing.\\\")\\n```\\n\\nThe results of the core evaluation will be written to a file called `results`.\\nNLU errors will be reported to `errors.json`.\\nTogether, they contain information about the accuracy of your model's\\npredictions and other metrics.\\n\\n```\\nif os.path.isfile(\\\"errors.json\\\"):\\n print(\\\"NLU Errors:\\\")\\n print(open(\\\"errors.json\\\").read())\\nelse:\\n print(\\\"No NLU errors.\\\")\\n\\nif os.path.isdir(\\\"results\\\"):\\n print(\\\"\\\\n\\\")\\n print(\\\"Core Errors:\\\")\\n print(open(\\\"results/failed_test_stories.yml\\\").read())\\n```\"}, \"metadata\": {\"id\": \"jupyter-notebooks\", \"sidebar_label\": \"Jupyter Notebooks\", \"title\": \"Jupyter Notebooks\", \"description\": \"Learn how to integrate open source chatbot platform Rasa into Jupyter notebooks, alongside all your machine learning code.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 22]\"}, {\"title\": \"Language Support\", \"description\": null, \"content\": {\"Training a Model in Any Languages\": \"The following pipeline can be used to train models in whitespace tokenizable languages:\\n\\n```\\n```\\n\\nTo train a Rasa model in your preferred language, define the pipeline in your ``config.yml``.\\nAfter you define the pipeline and generate some [NLU training data](./training-data-format.mdx)\\nin your chosen language, train the model by running the command:\\n\\n```\\nrasa train nlu\\n```\\n\\nOnce the training is finished, you can test your model's language skills.\\nSee how your model interprets different input messages by running:\\n\\n```\\nrasa shell nlu\\n```\\n\\n:::note\\nEven more so when training word embeddings from scratch, more training data will lead to a\\nbetter model! If you find your model is having trouble discerning your inputs, try training\\nwith more example sentences.\\n:::\", \"Using Pre-trained Language Models\": {\"spaCy\": \"With the [Pre-trained Spacy Embeddings](./components.mdx#spacynlp), you can use spaCy's\\n[pre-trained language models](https://spacy.io/usage/models#languages) or load fastText vectors, which are available\\nfor [hundreds of languages](https://github.com/facebookresearch/fastText/blob/master/docs/crawl-vectors.md). If you want\\nto incorporate a custom model you've found into spaCy, check out their page on\\n[adding languages](https://spacy.io/docs/usage/adding-languages). As described in the documentation, you need to\\nregister your language model and link it to the language identifier, which will allow Rasa to load and use your new language\\nby passing in your language identifier as the ``language`` option.\", \"MITIE\": \"You can also pre-train your own word vectors from a language corpus using [MITIE](./components.mdx#mitienlp). To do so:\\n\\n['Get a clean language corpus (a Wikipedia dump works) as a set of text files.', \\\"Build and run `MITIE Wordrep Tool`_ on your corpus.\\\\nThis can take several hours/days depending on your dataset and your workstation.\\\\nYou'll need something like 128GB of RAM for wordrep to run -- yes, that's a lot: try to extend your swap.\\\", 'Set the path of your new ``total_word_feature_extractor.dat`` as the ``model`` parameter in your\\\\n[configuration](./components.mdx#mitienlp).']\\n\\nFor a full example of how to train MITIE word vectors, check out\\n[this blogpost](http://www.crownpku.com/2017/07/27/%E7%94%A8Rasa_NLU%E6%9E%84%E5%BB%BA%E8%87%AA%E5%B7%B1%E7%9A%84%E4%B8%AD%E6%96%87NLU%E7%B3%BB%E7%BB%9F.html)\\nof creating a MITIE model from a Chinese Wikipedia dump.\"}}, \"metadata\": {\"id\": \"language-support\", \"sidebar_label\": \"Language Support\", \"title\": \"Language Support\", \"abstract\": \"You can use Rasa to build assistants in any language you want.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 23]\"}, {\"title\": \"Lock Stores\", \"description\": \"Messages that are being processed lock Rasa for a given conversation ID to ensure that multiple incoming messages for that conversation do not interfere with each other. Rasa provides multiple implementations to maintain conversation locks.\", \"content\": {\"InMemoryLockStore (default)\": [\"**Description**\", \"`InMemoryLockStore` is the default lock store. It maintains conversation locks\\nwithin a single process.\", \":::note\\nThis lock store should not be used when multiple Rasa servers are run\\nparallel.\", \":::\", \"**Configuration**\", \"To use the `InMemoryTrackerStore` no configuration is needed.\"], \"ConcurrentRedisLockStore\": {\"Description\": \"The `ConcurrentRedisLockStore` uses Redis as a persistence layer for instances of issued [tickets](https://rasa.com/docs/rasa/reference/rasa/core/lock/#ticket-objects) and the last issued ticket number.\\n\\nThe ticket number initialization begins at 1, in contrast to that of the`RedisLockStore` which begins at 0.\\nIf the ticket expires, the ticket number will not be reassigned to future tickets; as a result ticket numbers are unique to ticket instances.\\nTicket numbers are incremented using the Redis atomic transaction INCR on the persisted last issued ticket number.\\n\\nThe `ConcurrentRedisLockStore` ensures that only one Rasa instance can handle a conversation at any point in time.\\nTherefore, this Redis implementation of the `LockStore` can handle messages received in parallel for the same conversation by different Rasa servers\\nThis is the recommended lock store for running a replicated set of Rasa servers.\", \"Configuration\": \"To set up Rasa with Redis the following steps are required:\\n\\n['Start your Redis instance', 'Add required configuration to your `endpoints.yml`']\\n\\n```\\nlock_store:\\n type: rasa_plus.components.concurrent_lock_store.ConcurrentRedisLockStore\\n host: <host of the redis instance, e.g. localhost>\\n port: <port of your redis instance, usually 6379>\\n password: <password used for authentication>\\n db: <number of your database within redis, e.g. 0>\\n key_prefix: <alphanumeric value to prepend to lock store keys>\\n```\\n\\n['To start the Rasa Core server using your Redis backend, add the `--endpoints`\\\\nflag, e.g.:', '```\\\\nrasa run -m models --endpoints endpoints.yml\\\\n```']\", \"Parameters\": [\"`url` (default: `localhost`): The url of your redis instance\", \"`port` (default: `6379`): The port which redis is running on\", \"`db` (default: `1`): The number of your redis database\", \"`key_prefix` (default: `None`): The prefix to prepend to lock store keys. Must\\nbe alphanumeric\", \"`password` (default: `None`): Password used for authentication\\n(`None` equals no authentication)\", \"`use_ssl` (default: `False`): Whether or not the communication is encrypted -`socket_timeout` (default: `10`): Time in seconds after which an\\nerror is raised if Redis doesn't answer\"], \"Migration Guide\": \"To switch from the `RedisLockStore` to the `ConcurrentRedisLockStore`, specify the complete module path to the `ConcurrentRedisLockStore` class as `type` in `endpoints.yml`:\\n\\n```\\nlock_store:\\n type: rasa_plus.components.concurrent_lock_store.ConcurrentRedisLockStore\\n host: <host of the redis instance, e.g. localhost>\\n port: <port of your redis instance, usually 6379>\\n password: <password used for authentication>\\n db: <number of your database within redis, e.g. 0>\\n key_prefix: <alphanumeric value to prepend to lock store keys>\\n```\\n\\nYou must replace the `url` field in the redis lock store configuration with a field `host` containing the hostname of the redis instance.\\n\\nNo database migration is required when switching to the `ConcurrentRedisLockStore`. You can use the same Redis instance and database number as you did previously when using the `RedisLockStore`.\\nYou may want to delete all the preexisting keys if using the same Redis database number.\\nThese former key-value items are no longer required by the `ConcurrentRedisLockStore` and the database can be cleared.\\n\\nThere is no overlap in key-value items stored when using the `RedisLockStore` and the `ConcurrentRedisLockStore`, because the `RedisLockStore` persists serialized [TicketLock](https://rasa.com/docs/rasa/reference/rasa/core/lock/#ticketlock-objects) instances while the `ConcurrentRedisLockStore` instead stores individual [`Ticket`](https://rasa.com/docs/rasa/reference/rasa/core/lock/#ticket-objects) instances, as well as the last issued ticket number.\\nThe `ConcurrentRedisLockStore` recreates the `TicketLock` from the persisted `Ticket` instances, which allows it to handle concurrent messages for the same conversation ID.\"}, \"RedisLockStore\": [\"**Description**\", \"`RedisLockStore` maintains conversation locks using Redis as a persistence layer.\\nThis is the recommended lock store for running a replicated set of Rasa servers.\", \"**Configuration**\", \"To set up Rasa with Redis the following steps are required:\", [\"Start your Redis instance\", \"Add required configuration to your `endpoints.yml`\", \"```\\nlock_store:\\n type: \\\"redis\\\"\\n url: <url of the redis instance, e.g. localhost>\\n port: <port of your redis instance, usually 6379>\\n password: <password used for authentication>\\n db: <number of your database within redis, e.g. 0>\\n key_prefix: <alphanumeric value to prepend to lock store keys>\\n```\", \"To start the Rasa Core server using your Redis backend, add the `--endpoints`\\nflag, e.g.:\"], \"```\\nrasa run -m models --endpoints endpoints.yml\\n```\", \"**Parameters**\", [\"`url` (default: `localhost`): The url of your redis instance\", \"`port` (default: `6379`): The port which redis is running on\", \"`db` (default: `1`): The number of your redis database\", \"`key_prefix` (default: `None`): The prefix to prepend to lock store keys. Must\\nbe alphanumeric\", \"`username` (default: `None`): Username used for authentication\", \"`password` (default: `None`): Password used for authentication\\n(`None` equals no authentication)\", \"`use_ssl` (default: `False`): Whether or not the communication is encrypted\", \"`ssl_keyfile` (default: `None`): Path to an ssl private key\", \"`ssl_certfile` (default: `None`): Path to an ssl certificate\", \"`ssl_ca_certs` (default: `None`): The path to a file of concatenated CA certificates in PEM format\", \"`socket_timeout` (default: `10`): Time in seconds after which an\\nerror is raised if Redis doesn't answer\"]], \"Custom Lock Store\": {\"Configuration\": \"Put the module path to your custom event broker and the parameters you require in your `endpoints.yml`:\\n\\n```\\nlock_store:\\n type: path.to.your.module.Class\\n url: localhost\\n a_parameter: a value\\n another_parameter: another value\\n```\"}}, \"metadata\": {\"id\": \"lock-stores\", \"sidebar_label\": \"Lock Stores\", \"title\": \"Lock Stores\", \"description\": \"Messages that are being processed lock Rasa for a given conversation ID to ensure that multiple incoming messages for that conversation do not interfere with each other. Rasa provides multiple implementations to maintain conversation locks.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 24]\"}, {\"title\": \"Markers\", \"description\": \"Find out how to mark points of interest in dialogues using Marker conditions.\", \"content\": {\"Overview\": \"Markers are conditions that allow you to describe and mark points of interest in dialogues for evaluating your bot.\\n\\nIn Rasa, a dialogue is represented as a sequence of events,\\nwhich include bot actions that were executed, intents that were detected, and slots that were set.\\nMarkers allow you to describe conditions over such events. When the conditions are met, the relevant events are marked for further analysis or inspection.\\n\\nThere are several downstream applications for Markers. For example, they can be used to define and measure your bot's **Key Performance Indicators (KPIs)**,\\nsuch as **dialogue completion** or **task success**. Take [Carbon Bot](https://rasa.com/blog/using-conversation-tags-to-measure-carbon-bots-success-rate/)\\nfor example, which helps users offset their carbon emissions from flying. For Carbon Bot, you can define dialogue completion as \\\"all mandatory slots have been filled\\\",\\nand task success as \\\"all mandatory slots have been filled and a carbon estimate has been successfully computed\\\".\\nMarking when these important events occur allows you to measure Carbon Bot's success rate.\\n\\nMarkers also allow you to **diagnose your dialogues** by surfacing important events for further inspection.\\nFor example, you might observe that Carbon Bot tends to successfully set the `travel_departure` and `travel_destination` slots,\\nbut fails to set the `travel_flight_class` slot. You can define a marker to quantify how often this behavior occurs\\nand surface relevant dialogues for review as part of\\n[Conversation Driven Development (CDD)](./conversation-driven-development.mdx).\\n\\nMarker definitions are written in `YAML` in a marker configuration file. For example, here are the markers that define dialogue completion and task success for Carbon Bot:\\n\\n```\\nmarker_dialogue_completion:\\n and:\\n - slot_was_set: travel_departure\\n - slot_was_set: travel_destination\\n - slot_was_set: travel_flight_class\\n\\nmarker_task_success:\\n description: \\\"Measure task success where all required slots are set and the custom action was triggered\\\"\\n and:\\n - slot_was_set: travel_departure\\n - slot_was_set: travel_destination\\n - slot_was_set: travel_flight_class\\n - action: provide_carbon_estimate\\n```\\n\\nAnd here is the marker for surfacing dialogues where all mandatory slots are set except `travel_flight_class`:\\n\\n```\\nmarker_dialogue_mandatory_slot_failure:\\n and:\\n - slot_was_set: travel_departure\\n - slot_was_set: travel_destination\\n - not:\\n - slot_was_set: travel_flight_class\\n```\\n\\nThe next sections explain how to write marker definitions, how to apply them to your existing dialogues, and what the output format looks like.\", \"Defining Markers\": {\"Event Conditions\": \"The following event condition labels are supported:\\n\\n['`action`: the specified bot action was executed.', '`intent`: the specified user intent was detected.', '`slot_was_set`: the specified slot was set.']\\n\\nThe negated forms of the labels are also supported:\\n\\n['`not_action`: the event is not the specified bot action.', '`not_intent`: the event is not the specified user intent.', '`slot_was_not_set`: the specified slot has not been set.']\", \"Operators\": \"The following operators are supported:\\n\\n['`and`: all listed conditions applied.', '`or`: any of the listed conditions applied.', '`not`: the condition did not apply. This operator only accepts 1 condition.', '`seq`: the list of conditions applied in the specified order, with any number of events occurring in-between.', '`at_least_once`: the listed marker definitions occurred at least once. Only the first occurrence will be marked.', '`never`: the listed marker definitions never occurred.']\", \"Marker Configuration\": \"Here is an example of a marker configuration file containing several marker definitions. The example is created for mood bot,\\nwith a new slot `name` to illustrate the use of the label `slot_was_set`:\\n\\n```\\nmarker_name_provided:\\n description: \\\"slot `name` was provided\\\"\\n slot_was_set: name\\n\\nmarker_mood_expressed:\\n or:\\n - intent: mood_unhappy\\n - intent: mood_great\\n\\nmarker_cheer_up_failed:\\n seq:\\n - intent: mood_unhappy\\n - action: utter_cheer_up\\n - action: utter_did_that_help\\n - intent: deny\\n\\nmarker_bot_not_challenged:\\n description: \\\"Example of a negated marker, it can be used to surface conversations without bot_challenge intent\\\"\\n never:\\n - intent: bot_challenge\\n\\nmarker_cheer_up_attempted:\\n at_least_once:\\n - action: utter_cheer_up\\n\\nmarker_mood_expressed_and_name_not_provided:\\n and:\\n - or:\\n - intent: mood_unhappy\\n - intent: mood_great\\n - not:\\n - slot_was_set: name\\n```\\n\\nNote the following:\\n\\n['Each marker has a unique identifier (or name) such as `marker_name_provided`.', 'Each marker can have an optional `description` key that can be used for documentation.', 'A marker definition can contain a single condition, as shown in `marker_name_provided`.', 'A marker definition can contain a single operator with a list of conditions, as shown in `marker_mood_expressed`,\\\\n`marker_cheer_up_failed`, `marker_bot_not_challenged`, and `marker_cheer_up_attempted`.', 'A marker definition can contain nested operators, as shown in `marker_mood_expressed_and_name_not_provided`.', \\\"The values assigned to event conditions must be valid according to your bot's `domain.yml` file. For example, in\\\\n`marker_mood_expressed`, the intents `mood_unhappy` and `mood_unhappy` are both intents listed in the mood bot's `domain.yml` file.\\\"]\\n\\n:::note\\nYou cannot reuse an existing marker name in the definition of another marker.\\n:::\"}, \"Extracting Markers\": {\"Extracted Markers\": \"For each marker defined in your marker configuration file, the following information is extracted:\\n\\n['**The index of the event** at which the marker applied.', '**The number of user turns preceding the event** at which the marker applied. Each `UserUttered` event is treated as a user turn.']\\n\\nThe **index of the event** and the **number of preceding user turns** both give an indication of how\\nlong it took to reach an important event, such as task success.\\nThe index of the event will count all events, including ones that are not part of the dialogue,\\nsuch as starting a new session or executing a custom action.\\nThe number of preceding user turns, on the other hand, gives you a more intuitive indication of the dialogue length,\\nand in particular from the perspective of your end user.\\n\\nThe number of preceding user turns can be used to evaluate and improve your bot.\\nFor example, suppose a user had to rephrase their utterances multiple times, which caused their dialogue to become longer.\\nThe dialogue may eventually reach task success, however, surfacing it would allow you identify utterances that your bot failed to understand.\\nYou can then use these challenging utterances as additional training data to further improve your bot as part of\\n[Conversation Driven Development (CDD)](./conversation-driven-development.mdx).\\n\\n:::note\\nFor markers defined using the `at_least_once` operator, the information above will only be extracted for the first occurrence.\\n:::\\n\\nThe extracted markers are stored in a tabular format in the `.csv` file you specify in the script, for example, `extracted_markers.csv`.\\nThe extracted markers output file contains the following columns:\\n\\n['`sender_id`: taken from the trackers.', '`session_idx`: an integer indexing sessions, starting with `0`.', '`marker`: the unique marker identifier.', '`event_idx`: an integer indexing events, starting with `0`.', '`num_preceding_user_turns`: an integer indicating the number of user turns preceding the event at which the marker applied.']\\n\\nHere is an example of the extracted markers output file (for a marker configuration file containing two markers: `marker_mood_expressed` and `marker_cheer_up_failed`):\\n\\n```\\nsender_id,session_idx,marker,event_idx,num_preceding_user_turns\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,2,0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,7,1\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,14,2\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,2,0\\n```\\n\\nEach row represents an occurrence of the marker specified under the `marker` column, for each `sender_id` and `session_idx`.\", \"Computed Statistics\": \"By default, the command computes summary statistics about the information gathered. To disable the statistics computation, use the optional flag `--no-stats`.\\n\\nThe script computes the following statistics:\\n\\n['**For each session and each marker**: \\\"per-session statistics\\\" which include the arithmetic mean, median, minimum, and maximum number of user turns preceding the event at which the marker applied.', '**For all sessions and for each marker**:', ['Overall statistics including the arithmetic mean, median, minimum, and maximum number of user turns preceding the event where the marker applied in any session.', 'The number of sessions and the percentage of sessions where each marker applied at least once.']]\\n\\nThe results are stored in a tabular format in `stats-overall.csv` and `stats-per-session.csv`. You can change prefix `stats` in the file names using the optional argument `--stats-file-prefix `.\\nFor example, the following script will produce the files: `my-statistics-overall.csv` and `my-statistics-per-session.csv`:\\n\\n```\\nrasa evaluate markers all --stats-file-prefix \\\"my-statistics\\\" extracted_markers.csv\\n```\\n\\nThe two statistics files contain the following columns:\\n\\n['`sender_id`: taken from the trackers. If the statistic is computed over all sessions this will be equal to `all`.', '`session_idx`: an integer indexing sessions, starting with `0`. If the statistic is computed over all sessions, this will be equal to `nan` (not a number).', '`marker`: the unique marker identifier.', '`statistic`: a description of the statistic computed.', '`value`: an integer or float value of the computed statistic. If the statistic is not available then `value` will be equal to `nan` (not a number).']\\n\\nHere is a sample `stats-per-session.csv` output:\\n\\n```\\nsender_id,session_idx,marker,statistic,value\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_cheer_up_failed,count(number of preceding user turns),0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,count(number of preceding user turns),1\\nc00b3de97713427d85524c4374125db1,0,marker_cheer_up_failed,count(number of preceding user turns),0\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_cheer_up_failed,max(number of preceding user turns),nan\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,max(number of preceding user turns),2\\nc00b3de97713427d85524c4374125db1,0,marker_cheer_up_failed,max(number of preceding user turns),nan\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_cheer_up_failed,mean(number of preceding user turns),nan\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,mean(number of preceding user turns),2.0\\nc00b3de97713427d85524c4374125db1,0,marker_cheer_up_failed,mean(number of preceding user turns),nan\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_cheer_up_failed,median(number of preceding user turns),nan\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,median(number of preceding user turns),2.0\\nc00b3de97713427d85524c4374125db1,0,marker_cheer_up_failed,median(number of preceding user turns),nan\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_cheer_up_failed,min(number of preceding user turns),nan\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_cheer_up_failed,min(number of preceding user turns),2\\nc00b3de97713427d85524c4374125db1,0,marker_cheer_up_failed,min(number of preceding user turns),nan\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,count(number of preceding user turns),1\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,count(number of preceding user turns),1\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,count(number of preceding user turns),1\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,max(number of preceding user turns),0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,max(number of preceding user turns),1\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,max(number of preceding user turns),0\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,mean(number of preceding user turns),0.0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,mean(number of preceding user turns),1.0\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,mean(number of preceding user turns),0.0\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,median(number of preceding user turns),0.0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,median(number of preceding user turns),1.0\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,median(number of preceding user turns),0.0\\n3c1afa1ed72c4116ba6670a1668f1b4a,0,marker_mood_expressed,min(number of preceding user turns),0\\n4d55093e9696452c8d1157fa33fd54b2,0,marker_mood_expressed,min(number of preceding user turns),1\\nc00b3de97713427d85524c4374125db1,0,marker_mood_expressed,min(number of preceding user turns),0\\n```\\n\\nNote that the value for unavailable statistics is `nan`. For example, because `marker_cheer_up_failed` never occurred in\\ntracker `3c1afa1ed72c4116ba6670a1668f1b4a` session `0`, then the `min`, `max`, `median`, and `mean` number of preceding user turns\\nare equal to `nan`.\\n\\nHere is a sample `stats-overall.csv` output:\\n\\n```\\nsender_id,session_idx,marker,statistic,value\\nall,nan,-,total_number_of_sessions,3\\nall,nan,marker_cheer_up_failed,number_of_sessions_where_marker_applied_at_least_once,1\\nall,nan,marker_cheer_up_failed,percentage_of_sessions_where_marker_applied_at_least_once,33.333\\nall,nan,marker_mood_expressed,number_of_sessions_where_marker_applied_at_least_once,3\\nall,nan,marker_mood_expressed,percentage_of_sessions_where_marker_applied_at_least_once,100.0\\nall,nan,marker_cheer_up_failed,count(number of preceding user turns),1\\nall,nan,marker_cheer_up_failed,mean(number of preceding user turns),2.0\\nall,nan,marker_cheer_up_failed,median(number of preceding user turns),2.0\\nall,nan,marker_cheer_up_failed,min(number of preceding user turns),2\\nall,nan,marker_cheer_up_failed,max(number of preceding user turns),2\\nall,nan,marker_mood_expressed,count(number of preceding user turns),3\\nall,nan,marker_mood_expressed,mean(number of preceding user turns),0.333\\nall,nan,marker_mood_expressed,median(number of preceding user turns),0.0\\nall,nan,marker_mood_expressed,min(number of preceding user turns),0\\nall,nan,marker_mood_expressed,max(number of preceding user turns),1\\n```\\n\\nNote that because each row computes a statistic over all sessions, the `sender_id` is equal to `all`,\\nand the `session_idx` is equal to `nan`.\"}, \"Configuring the CLI command\": \"Visit our [CLI page](./command-line-interface.mdx#rasa-evaluate-markers) for more information on configuring the marker extraction and statistics computation process.\"}, \"metadata\": {\"id\": \"markers\", \"sidebar_label\": \"Markers\", \"title\": \"Markers\", \"description\": \"Find out how to mark points of interest in dialogues using Marker conditions.\", \"abstract\": \"Markers are conditions used to describe and mark points of interest in dialogues.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 25]\"}, {\"title\": \"Connecting to Messaging and Voice Channels\", \"description\": \"Check out how to make your Rasa assistant available on platforms like Facebook Messenger, Slack, Telegram or even your very own website.\", \"content\": {\"Connecting to A Channel\": \"Learn how to make your assistant available on:\\n\\n['[Your Own Website](./connectors/your-own-website.mdx)', '[Facebook Messenger](./connectors/facebook-messenger.mdx)', '[Slack](./connectors/slack.mdx)', '[Telegram](./connectors/telegram.mdx)', '[Twilio](./connectors/twilio.mdx)', '[Microsoft Bot Framework](./connectors/microsoft-bot-framework.mdx)', '[Cisco Webex Teams](./connectors/cisco-webex-teams.mdx)', '[RocketChat](./connectors/rocketchat.mdx)', '[Mattermost](./connectors/mattermost.mdx)', '[Google Hangouts Chat](./connectors/hangouts.mdx)', '[Custom Connectors](./connectors/custom-connectors.mdx)']\", \"Testing Channels on Your Local Machine\": \"If you're running a Rasa server on `localhost`, \\nmost external channels won't be able to find your server URL, since `localhost` is not open to the internet. \\n\\nTo make a port on your local machine publicly available on the internet, \\nyou can use [ngrok](https://ngrok.com/). Alternatively, see this [list](https://github.com/anderspitman/awesome-tunneling)\\ntracking and comparing other tunneling solutions.\\n\\nAfter installing ngrok, run:\\n\\n```\\nngrok http 5005; rasa run\\n```\\n\\nWhen you follow the instructions to make your assistant available on a channel, use the ngrok URL.\\nSpecifically, wherever the instructions say to use `https://<host>:<port>/webhooks/<CHANNEL>/webhook`,\\nuse `<ngrok_url>/webhooks/<CHANNEL>/webhook`, replacing `<ngrok_url>` with the randomly generated\\nURL displayed in your ngrok terminal window. For example, if connecting your bot to Slack, \\nyour URL should resemble `https://26e7e7744191.ngrok.io/webhooks/slack/webhook`.\\n\\n:::caution\\nWith the free-tier of ngrok, you can run into limits on how many connections you can make per minute.\\nAs of writing this, it is set to 40 connections / minute.\\n\\n:::\\n\\nAlternatively you can make your assistant listen on a specific address using the `-i` command line\\noption:\\n\\n```\\nrasa run -p 5005 -i 192.168.69.150\\n```\\n\\nThis is particularly useful when your internet facing machines connect to backend servers using a VPN \\ninterface.\"}, \"metadata\": {\"id\": \"messaging-and-voice-channels\", \"sidebar_label\": \"Connecting to a Channel\", \"title\": \"Connecting to Messaging and Voice Channels\", \"description\": \"Check out how to make your Rasa assistant available on platforms like Facebook Messenger, Slack, Telegram or even your very own website.\", \"abstract\": \"Rasa provides many built-in connectors to connect to common messaging and voice channels. You can also connect to your website or app with pre-configured REST channels or build your own custom connector.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 26]\"}, {\"title\": \"Migrate From Other Tools (beta)\", \"description\": null, \"content\": {\"root\": [\"Here are a few reasons why we see developers switching from other tools to Rasa:\", [\"**Faster**: Runs locally - no HTTP requests or server round trips required\", \"**Customizable**: Tune models and get higher accuracy with your data set\", \"**Open source**: No risk of vendor lock-in - Rasa is under the Apache 2.0 license and you can \\nuse it in commercial projects\"], \"In addition, our open source tools allow developers to build contextual AI assistants and manage dialogues \\nwith machine learning instead of rules - check it out in <a className=\\\"reference external\\\" href=\\\"http://blog.rasa.com/a-new-approach-to-conversational-software/\\\" target=\\\"_blank\\\">this blog post</a>.\", \"Learn how to migrate from:\", [\"[Google Dialogflow](./migrate-from/google-dialogflow-to-rasa.mdx)\", \"[Wit.ai](./migrate-from/facebook-wit-ai-to-rasa.mdx)\", \"[Microsoft LUIS](./migrate-from/microsoft-luis-to-rasa.mdx)\", \"[IBM Watson](./migrate-from/ibm-watson-to-rasa.mdx)\"]]}, \"metadata\": {\"id\": \"migrate-from\", \"sidebar_label\": \"Migrate From (beta)\", \"title\": \"Migrate From Other Tools (beta)\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 27]\"}, {\"title\": \"Version Migration Guide\", \"description\": \"Information about changes between major versions of chatbot framework Rasa Core\\nand how you can migrate from one version to another.\\n\", \"content\": {\"Rasa 3.0 to 3.1\": {\"Machine Learning Components\": {\"TensorFlow Upgrade\": \"Due to the TensorFlow upgrade, we can't guarantee the exact same output and hence\\nmodel performance if your configuration uses `LanguageModelFeaturizer`.\\nThis applies to the case where the model is re-trained with the new Rasa\\nversion without changing the configuration, random seeds, and data as well as to the\\ncase where a model trained with a previous version of Rasa is loaded with\\nthis new version for inference.\\n\\nPlease check whether your trained model still performs as expected and retrain if needed.\"}, \"NLU JSON Format\": \"[NLU training data](nlu-training-data.mdx) in JSON format is deprecated and will be\\nremoved in Rasa 4.0.\\nPlease use `rasa data convert nlu -f yaml --data <path to NLU data>` to convert your\\nNLU JSON data to YAML format before support for NLU JSON data is removed.\"}, \"Rasa 2.x to 3.0\": {\"Markdown Data\": \"Markdown is no longer supported \\u2014 all the supporting code that was previously deprecated is\\nnow removed, and the convertors are removed as well.\\n\\nThe related CLI commands `rasa data convert responses` and `rasa data convert config`\\nwere removed.\\n\\nIf you still have training data in Markdown format then the recommended approach is to use Rasa 2.x\\nto convert your data from Markdown to YAML. Please use the commands described\\n[here](./migration-guide.mdx#training-data-files).\", \"Model Configuration\": \"It is required to specify the used `recipe` within the\\n[model configuration](model-configuration.mdx). As of now Rasa only supports\\nthe `default.v1` recipe and will continue using it even if you don't specify a recipe\\nin the model configuration. To avoid breaking changes in the future you should\\nto specify `recipe: \\\"default.v1\\\"` at the top of your model configuration:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-config\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nlanguage: en\\n\\npipeline:\\n ...\\npolicies:\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nrecipe: default.v1\\n\\nlanguage: en\\n\\npipeline:\\n ...\\npolicies:\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\", \"Custom Policies and Custom Components\": {\"Changes to Custom NLU Components\": \"**Inheriting from `GraphComponent`**\\n\\nNLU components which previously inherited from one of the following classes additionally\\nneed to inherit from the\\n[`GraphComponent` interface](custom-graph-components.mdx#the-graphcomponent-interface):\\n\\n['`SparseFeaturizer`', '`DenseFeaturizer`', '`IntentClassifier`', '`EntityExtractor`', '`Component`']\\n\\nThis snippet shows the required changes:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-parent-class\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.nlu.featurizers.sparse_featurizer.sparse_featurizer import SparseFeaturizer\\n\\nclass MyNLUComponent(SparseFeaturizer):\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.nlu.featurizers.sparse_featurizer.sparse_featurizer import SparseFeaturizer\\n\\nclass MyNLUComponent(GraphComponent, SparseFeaturizer):\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n** Inheriting from `EntityExtractorMixin` instead of `EntityExtractor`**\\n\\nThe `EntityExtractor` class was renamed to `EntityExtractorMixin`:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-entity-extractor\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.nlu.extractors.extractor import EntityExtractor\\n\\nclass MyNLUComponent(EntityExtractor):\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.nlu.extractors.extractor import EntityExtractorMixin\\n\\nclass MyNLUComponent(GraphComponent, EntityExtractorMixin):\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Instantiating a NLU Component for Training**\\n\\nNLU components are no longer instantiated via their constructor. Instead, all NLU\\ncomponents have to override the `create` method of the\\n[`GraphComponent` interface](custom-graph-components.mdx#the-graphcomponent-interface). The\\npassed in configuration is your NLU component's default configuration including any updates\\nfrom your model configuration file.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-init\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Optional, Dict, Text, Any\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\n\\nclass MyNLUComponent(IntentClassifier):\\n\\n def __init__(self, component_config: Optional[Dict[Text, Any]] = None) -> None:\\n super().__init__(component_config)\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import Dict, Text, Any\\n\\nfrom rasa.engine.graph import GraphComponent, ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\n\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n\\n def __init__(self, component_config: Dict[Text, Any]) -> None:\\n self.component_config = component_config\\n ...\\n\\n @classmethod\\n def create(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n ) -> GraphComponent:\\n return cls(config)\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Persisting a Trained NLU Component**\\n\\nNLU components used to be persisted by a call to the NLU component's `persist` method\\nfrom outside the NLU component itself.\\nWith Rasa 3.0 NLU components are responsible for persisting themselves.\\nUse the provided `model_storage` and `resource` parameters\\nto persist your NLU component at the end of the training and then return the `resource`\\nas result of your NLU component's `train` method.\\nSee [component persistence](custom-graph-components.mdx#model-persistence) for more details.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-persistence\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom pathlib import Path\\nfrom typing import Optional, Any, Text, Dict\\n\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.nlu.config import RasaNLUModelConfig\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyNLUComponent(IntentClassifier):\\n def train(\\n self,\\n training_data: TrainingData,\\n config: Optional[RasaNLUModelConfig] = None,\\n **kwargs: Any,\\n ) -> None:\\n ...\\n\\n def persist(self, file_name: Text, model_dir: Text) -> Dict[Text, Any]:\\n file_path = Path(model_dir) / \\\"{file_name}.model_data.json\\\"\\n rasa.shared.utils.io.create_directory_for_file(file_path)\\n rasa.shared.utils.io.dump_obj_as_json_to_file(file_path,\\n self.get_model_data())\\n\\n return {\\\"file\\\": file_name}\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n def train(self, training_data: TrainingData) -> Resource:\\n ...\\n self.persist()\\n return self._resource\\n\\n def persist(self) -> None:\\n with self._model_storage.write_to(self._resource) as directory:\\n model_data_file = directory / \\\"model_data.json\\\"\\n rasa.shared.utils.io.dump_obj_as_json_to_file(model_data_file,\\n self.get_model_data())\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Instantiating a Trained NLU Component**\\n\\nPreviously NLU components had to persist their own configuration. Now the config passed\\ninto `load` will automatically contain the configuration which your model was trained with.\\nTo instantiate a persisted NLU component, you need to use `model_storage` and `resource` in your NLU component's\\n`load` method.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-loading\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nimport json\\nfrom pathlib import Path\\nfrom typing import Text, Dict, Any, Optional\\n\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.nlu.model import Metadata\\n\\nclass MyNLUComponent(IntentClassifier):\\n @classmethod\\n def load(\\n cls,\\n meta: Dict[Text, Any],\\n model_dir: Text,\\n model_metadata: Metadata = None,\\n cached_component: Optional[\\\"DIETClassifier\\\"] = None,\\n should_finetune: bool = False,\\n **kwargs: Any,\\n ) -> \\\"MyNLUComponent\\\":\\n file_name = meta.get(\\\"file\\\")\\n file_path = Path(model_dir) / \\\"{file_name}.model_data.json\\\"\\n model_data = json.loads(rasa.shared.utils.io.read_file(file_path))\\n\\n return cls(model_data)\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom __future__ import annotations\\nimport json\\nfrom typing import Any, Text, Dict\\n\\nfrom rasa.engine.graph import GraphComponent, ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.shared.exceptions import FileIOException\\n\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n @classmethod\\n def load(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n **kwargs: Any,\\n ) -> MyNLUComponent:\\n model_data = {}\\n\\n try:\\n with model_storage.read_from(resource) as path:\\n\\n model_data_file = path / \\\"model_data.json\\\"\\n model_data = json.loads(rasa.shared.utils.io.read_file(model_data_file))\\n\\n except (ValueError, FileNotFoundError, FileIOException):\\n logger.debug(\\n f\\\"Couldn't load metadata for component '{cls.__name__}' as the persisted \\\"\\n f\\\"model data couldn't be loaded.\\\"\\n )\\n\\n return cls(\\n config, model_data=model_data\\n )\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Providing a Default Configuration for an NLU Component**\\n\\nThe default configuration is no longer a static class property but instead returned\\nby the static method `get_default_config`:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-default-config\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\n\\nclass MyNLUComponent(IntentClassifier):\\n ...\\n defaults = {\\\"key1\\\": \\\"value1\\\"}\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import Text, Any, Dict\\n\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\n\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n ...\\n @staticmethod\\n def get_default_config() -> Dict[Text, Any]:\\n return {\\\"key1\\\": \\\"value1\\\"}\\n\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Augmenting Training Data in an NLU Component**\\n\\nNLU Components like [tokenizers](components.mdx#tokenizers) or\\n[featurizers](components.mdx#featurizers) augment the training data with their\\noutput during the model training. Their output is required by NLU components later in the\\npipeline. Typically, featurizers require *tokenized* messages and intent\\nclassifiers require *featurized* training data to train themselves. Rasa\\n3.0 makes these different purposes explicit. Previously both NLU component training and\\ntraining data augmentation were done as part of the `train` method. In Rasa\\n3.0 they are split into `train` and `process_training_data`:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-component-train-process-split\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Optional, Any\\n\\nfrom rasa.nlu.featurizers.sparse_featurizer.sparse_featurizer import SparseFeaturizer\\nfrom rasa.nlu.config import RasaNLUModelConfig\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyNLUComponent(SparseFeaturizer):\\n def train(\\n self,\\n training_data: TrainingData,\\n config: Optional[RasaNLUModelConfig] = None,\\n **kwargs: Any,\\n ) -> None:\\n self.train_featurizer(training_data)\\n\\n for message in training_data.training_examples:\\n self.add_features(message)\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.nlu.featurizers.sparse_featurizer.sparse_featurizer import SparseFeaturizer\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyNLUComponent(GraphComponent, SparseFeaturizer):\\n def train(self, training_data: TrainingData) -> Resource:\\n self.train_featurizer(training_data)\\n\\n self.persist()\\n return self._resource\\n\\n def process_training_data(self, training_data: TrainingData) -> TrainingData:\\n for message in training_data.training_examples:\\n self.add_features(message)\\n\\n return training_data\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Handling Lists of Messages During Inference in an NLU Component**\\n\\nNLU components used to receive a single `Message` object during inference.\\nStarting with Rasa 3.0 all NLU components have to support a list of\\nmessages during inference. Unless your component supports batch predictions the easiest\\nway to handle this is to loop over the messages. It is also required to return the\\nmessage objects at the end of the `process` method.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-component-process-messages-split\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Any\\n\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.shared.nlu.training_data.message import Message\\n\\nclass MyNLUComponent(IntentClassifier):\\n def process(self, message: Message, **kwargs: Any) -> None:\\n self.predict(message)\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import List\\n\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.shared.nlu.training_data.message import Message\\n\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n def process(self, messages: List[Message]) -> List[Message]:\\n for message in messages:\\n self.predict(message)\\n\\n return messages\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Registering your NLU Component**\\n\\nBefore you can use your custom NLU component you have to register your NLU component using the\\n`DefaultV1Recipe.register` decorator. The NLU component types correspond to the existing\\nparent classes:\\n\\n['`Tokenizer`: `ComponentType.MESSAGE_TOKENIZER`', '`SparseFeaturizer` / `DenseFeaturizer`: `ComponentType.MESSAGE_FEATURIZER`', '`IntentClassifier`: `ComponentType.INTENT_CLASSIFIER`', '`EntityExtractor`: `ComponentType.ENTITY_EXTRACTOR`', 'If your NLU component provides a pretrained model which should be used by other\\\\nNLU components during training and inference use `ComponentType.MODEL_LOADER`']\\n\\nSpecify `is_trainable=True` if the `train` method of your component should be called\\nduring training.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-register\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\n\\nclass MyNLUComponent(IntentClassifier):\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.engine.recipes.default_recipe import DefaultV1Recipe\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.engine.graph import GraphComponent\\n\\n@DefaultV1Recipe.register(\\n DefaultV1Recipe.ComponentType.INTENT_CLASSIFIER, is_trainable=True\\n)\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Using a Model Provider with your NLU Component**\\n\\nIf your NLU component requires a pretrained model such as a [Spacy](components.mdx#spacynlp) or\\n[Mitie](components.mdx#mitienlp) language model you have to specify the NLU component which\\nprovides this model in your model's pipeline before the NLU component which requires\\nthe model. In addition to this you now also need to specify the model loading component in the `model_from`\\nparameter in the `register` decorator. The model will then be passed to your model's\\n`train`, `process_training_data` and `process` methods:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-nlu-model-provider\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Optional, Any\\n\\nfrom rasa.nlu.config import RasaNLUModelConfig\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.shared.nlu.training_data.message import Message\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\nclass MyNLUComponent(IntentClassifier):\\n def train(\\n self,\\n training_data: TrainingData,\\n cfg: Optional[RasaNLUModelConfig] = None,\\n **kwargs: Any,\\n ) -> None:\\n \\\"\\\"\\\"Train the featurizer.\\\"\\\"\\\"\\n spacy_nlp = kwargs.get(\\\"spacy_nlp\\\")\\n ...\\n\\n def process(self, message: Message, **kwargs: Any) -> None:\\n spacy_nlp = kwargs.get(\\\"spacy_nlp\\\", None)\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import List\\n\\nfrom rasa.engine.graph import GraphComponent\\nfrom rasa.engine.recipes.default_recipe import DefaultV1Recipe\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.nlu.classifiers.classifier import IntentClassifier\\nfrom rasa.nlu.utils.spacy_utils import SpacyModel\\nfrom rasa.shared.nlu.training_data.message import Message\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\n@DefaultV1Recipe.register(\\n DefaultV1Recipe.ComponentType.INTENT_CLASSIFIER, is_trainable=True, model_from=\\\"SpacyNLP\\\"\\n)\\nclass MyNLUComponent(GraphComponent, IntentClassifier):\\n def train(\\n self, training_data: TrainingData, model: SpacyModel) -> Resource:\\n spacy_nlp = model.model\\n ...\\n\\n def process(self, messages: List[Message], model: SpacyModel) -> List[Message]:\\n spacy_nlp = model.model\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\", \"Changes to Custom Policies\": \"This guide leads you through the migration of a custom policy step by step.\\n\\n**Instantiating a Policy for Training**\\n\\nPolicies are no longer instantiated via their constructor. Instead, all policies have\\nto implement a `create` method. During the policy instantiation the configuration from\\nthe [model configuration](model-configuration.mdx) is passed in as a dictionary instead\\nof as separate parameters. Similarly, the`featurizers` are no longer instantiated\\noutside of policies.\\nInstead, the super class `rasa.core.policies.policy.Policy` instantiates the\\nfeaturizers itself.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-init\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Optional, Any\\n\\nfrom rasa.core.constants import DEFAULT_POLICY_PRIORITY\\nfrom rasa.core.featurizers.tracker_featurizers import TrackerFeaturizer\\nfrom rasa.core.policies.policy import Policy\\n\\nclass MyPolicy(Policy):\\n def __init__(\\n self,\\n featurizer: Optional[TrackerFeaturizer] = None,\\n priority: int = DEFAULT_POLICY_PRIORITY,\\n max_history: Optional[int] = None,\\n **kwargs: Any\\n ) -> None:\\n super().__init__(featurizer, priority, **kwargs)\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import Optional, Dict, Text, Any\\n\\nfrom rasa.core.featurizers.tracker_featurizers import TrackerFeaturizer\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.engine.graph import ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\n\\nclass MyPolicy(Policy):\\n def __init__(\\n self,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n featurizer: Optional[TrackerFeaturizer] = None,\\n ) -> None:\\n super().__init__(\\n config, model_storage, resource, execution_context, featurizer\\n )\\n ...\\n ...\\n\\n @classmethod\\n def create(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n ) -> MyPolicy:\\n return cls(config, model_storage, resource, execution_context)\\n\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Persisting a Trained Policy**\\n\\nPolicies used to be persisted by a call to the policy's `persist` method from outside the policy itself.\\nWith Rasa 3.0 policies are responsible for persisting themselves.\\nUse the provided `model_storage` and `resource` parameters\\nto persist your graph component at the end of the training and then return the `resource`\\nas result of your policy's `train` method. See [graph component persistence](custom-graph-components.mdx#model-persistence) for more details.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-persistence\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom pathlib import Path\\nfrom typing import List, Any, Union, Text\\n\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.core.generator import TrackerWithCachedStates\\nfrom rasa.shared.nlu.interpreter import NaturalLanguageInterpreter\\n\\nclass MyPolicy(Policy):\\n def train(\\n self,\\n training_trackers: List[TrackerWithCachedStates],\\n domain: Domain,\\n interpreter: NaturalLanguageInterpreter,\\n **kwargs: Any,\\n ) -> None:\\n ...\\n\\n def persist(self, path: Union[Text, Path]) -> None:\\n if self.featurizer is not None:\\n self.featurizer.persist(path)\\n\\n file_path = Path(path) / \\\"model_data.json\\\"\\n rasa.shared.utils.io.create_directory_for_file(file_path)\\n rasa.shared.utils.io.dump_obj_as_json_to_file(file_path,\\n self.get_model_data())\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import List, Any\\n\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.core.generator import TrackerWithCachedStates\\n\\nclass MyPolicy(Policy):\\n def train(\\n self,\\n training_trackers: List[TrackerWithCachedStates],\\n domain: Domain,\\n **kwargs: Any,\\n ) -> Resource:\\n ...\\n self.persist()\\n return self._resource\\n\\n def persist(self) -> None:\\n with self._model_storage.write_to(self._resource) as directory:\\n if self.featurizer is not None:\\n self.featurizer.persist(directory)\\n\\n file_path = directory / \\\"model_data.json\\\"\\n rasa.shared.utils.io.dump_obj_as_json_to_file(file_path,\\n self.get_model_data())\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Instantiating a Trained Policy**\\n\\nPreviously policies had to persist their own configuration. Now the config passed\\ninto `load` will automatically contain the configuration which your model was trained with.\\n\\nTo instantiate a persisted policy, you need to use `model_storage` and `resource` in your policy's\\n`load` method.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-loading\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nimport json\\nfrom pathlib import Path\\nfrom types import Union\\nfrom typing import Text, Any\\n\\nfrom rasa.core.policies.policy import Policy\\n\\nclass MyPolicy(Policy):\\n @classmethod\\n def load(cls, path: Union[Text, Path], **kwargs: Any) -> \\\"Policy\\\":\\n featurizer = None\\n if (Path(path) / FEATURIZER_FILE).is_file():\\n featurizer = TrackerFeaturizer.load(path)\\n\\n model_data = {}\\n model_data_file = Path(path) / \\\"model_data.json\\\"\\n if metadata_file.is_file():\\n model_data = json.loads(rasa.shared.utils.io.read_file(model_data_file))\\n\\n return cls(model_data, featurizer)\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nimport json\\nfrom typing import Dict, Text, Any\\n\\nfrom rasa.core.featurizers.tracker_featurizers import TrackerFeaturizer\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.engine.graph import ExecutionContext\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.engine.storage.storage import ModelStorage\\nfrom rasa.shared.exceptions import FileIOException\\n\\nclass MyPolicy(Policy):\\n @classmethod\\n def load(\\n cls,\\n config: Dict[Text, Any],\\n model_storage: ModelStorage,\\n resource: Resource,\\n execution_context: ExecutionContext,\\n **kwargs: Any,\\n ) -> MyPolicy:\\n featurizer = None\\n model_data = {}\\n\\n try:\\n with model_storage.read_from(resource) as path:\\n if (Path(path) / FEATURIZER_FILE).is_file():\\n featurizer = TrackerFeaturizer.load(path)\\n\\n model_data_file = path / \\\"model_data.json\\\"\\n model_data = json.loads(rasa.shared.utils.io.read_file(model_data_file))\\n\\n except (ValueError, FileNotFoundError, FileIOException):\\n logger.debug(\\n f\\\"Couldn't load metadata for policy '{cls.__name__}' as the persisted \\\"\\n f\\\"metadata couldn't be loaded.\\\"\\n )\\n\\n return cls(\\n config, model_storage, resource, execution_context,\\n featurizer=featurizer, model_data=model_data\\n )\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Providing a Default Configuration for a Policy**\\n\\nThe default configuration is no longer provided via default values in your policy's\\nconstructor but instead returned by the static method `get_default_config`:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-default-config\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import Text\\nfrom rasa.core.policies.policy import Policy\\n\\nclass MyPolicy(Policy):\\n\\n def __init__(key1: Text = \\\"value1\\\") -> None:\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import Dict, Text, Any\\nfrom rasa.core.policies.policy import Policy\\n\\nclass MyPolicy(Policy):\\n\\n def __init__(self, config: Dict[Text, Any]) -> None:\\n ...\\n\\n @staticmethod\\n def get_default_config() -> Dict[Text, Any]:\\n return {\\\"key1\\\": \\\"value1\\\"}\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Using End-To-End Features in a Policy**\\n\\nTo use a custom [end-to-end policy](stories.mdx#end-to-end-training) in Rasa\\nOpen Source 2, you had to use the `interpreter` parameter to featurize the tracker\\nevents manually. In Rasa 3.0,\\nyou need to [register](custom-graph-components.mdx#registering-graph-components-with-the-model-configuration) a policy that requires end-to-end features with type `ComponentType.POLICY_WITH_END_TO_END_SUPPORT`. The features\\nwill be precomputed and passed into your policy during training and inference.\\n\\n:::caution\\nEnd-To-End features will only be computed and provided to your policy if your training\\ndata actually contains [end-to-end training data](stories.mdx#end-to-end-training).\\n:::\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-end-to-end-features\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom typing import List, Any\\n\\nfrom rasa.core.policies.policy import Policy, PolicyPrediction\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.core.generator import TrackerWithCachedStates\\nfrom rasa.shared.core.trackers import DialogueStateTracker\\nfrom rasa.shared.nlu.interpreter import NaturalLanguageInterpreter\\n\\nclass MyPolicy(Policy):\\n def train(\\n self,\\n training_trackers: List[TrackerWithCachedStates],\\n domain: Domain,\\n interpreter: NaturalLanguageInterpreter,\\n **kwargs: Any,\\n ) -> None:\\n ...\\n model_data, label_ids = self._prepare_for_training(\\n training_trackers, domain, interpreter, **kwargs\\n )\\n ...\\n\\n def predict_action_probabilities(\\n self,\\n tracker: DialogueStateTracker,\\n domain: Domain,\\n interpreter: NaturalLanguageInterpreter,\\n **kwargs: Any,\\n ) -> PolicyPrediction:\\n ...\\n tracker_state_features = self._featurize_tracker_for_e2e(\\n tracker, domain, interpreter\\n )\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import List, Optional, Dict, Text, Any\\n\\nfrom rasa.core.featurizers.precomputation import MessageContainerForCoreFeaturization\\nfrom rasa.core.policies.policy import PolicyPrediction, Policy\\nfrom rasa.engine.recipes.default_recipe import DefaultV1Recipe\\nfrom rasa.engine.storage.resource import Resource\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.core.generator import TrackerWithCachedStates\\nfrom rasa.shared.core.trackers import DialogueStateTracker\\n\\n@DefaultV1Recipe.register(\\n DefaultV1Recipe.ComponentType.POLICY_WITH_END_TO_END_SUPPORT, is_trainable=True\\n)\\nclass MyPolicy(Policy):\\n def train(\\n self,\\n training_trackers: List[TrackerWithCachedStates],\\n domain: Domain,\\n precomputations: Optional[MessageContainerForCoreFeaturization] = None,\\n ) -> Resource:\\n ...\\n model_data, label_ids = self._prepare_for_training(\\n training_trackers, domain, precomputations,\\n )\\n ...\\n\\n def predict_action_probabilities(\\n self,\\n tracker: DialogueStateTracker,\\n domain: Domain,\\n precomputations: Optional[MessageContainerForCoreFeaturization] = None,\\n rule_only_data: Optional[Dict[Text, Any]] = None,\\n **kwargs: Any,\\n ) -> PolicyPrediction:\\n ...\\n tracker_state_features = self._featurize_tracker(\\n tracker, domain, precomputations, rule_only_data=rule_only_data\\n )\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Registering a Policy**\\n\\nBefore you can use your custom policy you have to register your policy using the\\n`DefaultV1Recipe.register` decorator. If your policy requires end-to-end features\\nspecify the graph component type `POLICY_WITH_END_TO_END_SUPPORT`. Otherwise, use\\n`POLICY_WITHOUT_END_TO_END_SUPPORT`. Specify `is_trainable=True` if the `train`\\nmethod of your policy should be called during the training. If your policy is only\\nused during inference use `is_trainable=False`.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-register\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.core.policies.policy import Policy\\n\\nclass MyPolicy(Policy):\\n ...\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom rasa.core.policies.policy import Policy\\nfrom rasa.engine.recipes.default_recipe import DefaultV1Recipe\\n\\n@DefaultV1Recipe.register(\\n DefaultV1Recipe.ComponentType.POLICY_WITH_END_TO_END_SUPPORT,\\n is_trainable=True\\n)\\nclass MyPolicy(Policy):\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n**Providing Rule-only Data to a Policy**\\n\\nRasa allows excluding [forms](forms.mdx) or [slots](domain.mdx#slots) which\\nare completely handled by\\n[rules](rules.mdx) from becoming features in other policies.\\nIn Rasa 2 this information was passed onto the\\npolicies using the `set_shared_policy_states` method which set the policy attribute\\n`_rule_only_data`. Rasa passes the names of rule-only slots and forms via the\\n`predict_action_probabilities` method. The passed `rule_only_data` can be `None`\\nin case the [`RulePolicy`](policies.mdx#rule-policy) is not part of your model\\nconfiguration.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Rasa 2.0 (old)\\\", \\\"value\\\": \\\"old\\\"}, {\\\"label\\\": \\\"Rasa 3.0 (new)\\\", \\\"value\\\": \\\"new\\\"}]} groupId=\\\"3-0-policy-rule-only-data\\\" defaultValue=\\\"new\\\">\\n<TabItem value=\\\"old\\\">\\n\\n```\\nfrom rasa.core.policies.policy import Policy\\nfrom typing import Any\\n\\nclass MyPolicy(Policy):\\n\\n def set_shared_policy_states(self, **kwargs: Any) -> None:\\n \\\"\\\"\\\"Sets policy's shared states for correct featurization.\\\"\\\"\\\"\\n self._rule_only_data = kwargs.get(\\\"rule_only_data\\\", {})\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"new\\\">\\n\\n```\\nfrom typing import Optional, Dict, Text, Any\\n\\nfrom rasa.core.policies.policy import Policy, PolicyPrediction\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.core.trackers import DialogueStateTracker\\n\\nclass MyPolicy(Policy):\\n def predict_action_probabilities(\\n self,\\n tracker: DialogueStateTracker,\\n domain: Domain,\\n rule_only_data: Optional[Dict[Text, Any]] = None,\\n ) -> PolicyPrediction:\\n ...\\n```\\n\\n</TabItem>\\n</Tabs>\"}, \"Training data\": {\"Upgrading `version` from `2.0` to `3.0`\": \"At the top of your training data files, you need to change `version: \\\"2.0\\\"` to `version: \\\"3.1\\\"`.\\n\\nWe follow semantic versioning for training data versions. This means breaking changes result in a new\\nmajor version, while new features result in a new minor version. The latest training data version is 3.1.\\n\\nThe improvements to `slot mappings` in Rasa 3.0 were breaking changes, so we needed to upgrade\\nfrom major version `2.0` to major version `3.0`.\", \"`TrainingDataImporter`\": \"`TrainingDataImporter` and all its implementations are updated to contain only synchronous methods.\\nIf you have a custom data importer or rely on some functions provided by `TrainingDataImporter`, you need\\nto update your implementation and function calls.\\n\\nFor example, this is how data loading should look like in Rasa 3.0:\\n\\n```\\nfrom typing import Text\\nfrom rasa.shared.importers.importer import TrainingDataImporter\\n\\ndef load_data(domain_path: Text, config_path: Text):\\n file_importer = TrainingDataImporter.load_from_config(\\n config_path, domain_path\\n )\\n # note that all the functions below were async before:\\n config = file_importer.get_config()\\n domain = file_importer.get_domain()\\n stories = file_importer.get_stories()\\n nlu_data = file_importer.get_nlu_data()\\n```\\n\\nSince any custom importer implements `TrainingDataImporter`, you should update your custom\\nimporter to contain only sync methods as well:\\n\\n```\\nfrom typing import Dict\\n\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.importers.importer import TrainingDataImporter\\n\\n\\nclass MyImporter(TrainingDataImporter):\\n \\\"\\\"\\\"Example partial implementation of a custom importer component.\\\"\\\"\\\"\\n\\n # this function was async before\\n def get_domain(self) -> Domain:\\n pass\\n\\n # this function was also async before\\n def get_config(self) -> Dict:\\n pass\\n\\n # ...\\n```\\n\\n`template_variables` and `e2e` arguments also got removed from `get_stories` method of `TrainingDataImporter`.\\nIts new signature looks this way:\\n\\n```\\nfrom typing import Optional\\n\\nfrom rasa.shared.nlu.interpreter import RegexInterpreter\\nfrom rasa.shared.core.training_data.structures import StoryGraph\\n\\nclass TrainingDataImporter:\\n # ...\\n\\n def get_stories(\\n self,\\n interpreter: \\\"NaturalLanguageInterpreter\\\" = RegexInterpreter(),\\n exclusion_percentage: Optional[int] = None,\\n ) -> StoryGraph:\\n pass\\n\\n # ...\\n```\"}, \"Training\": {\"`rasa train --dry-run`\": \"Due to changes in the model architecture the behavior of `rasa train --dry-run` changed.\\nThe exit codes now have the following meaning:\\n\\n['`0` means that the model does not require an expensive retraining. However, the\\\\nresponses might still require updating by running `rasa train`', '`1` means that one or multiple components require to be retrained.', '`8` means that the `--force` flag was used and hence any cached results are ignored\\\\nand the entire model is retrained.']\"}, \"Machine Learning Components\": {\"Normalization of Confidences in `DIETClassifier` and `ResponseSelector`\": \"`DIETClassifier` and `ResponseSelector` will no longer automatically report\\nre-normalized confidences when `ranking_length` is set to a value greater than `0`.\\nThis change affects the reported confidences but does not influence the final\\npredicted intent, which might be used by policies.\\nHowever, since the reported confidences are affected you might have to tune the\\nthresholds for fallback mechanisms again.\\nThe previous behavior can still be enforced by setting `renormalize_confidences=True`\\nwhen using `model_confidence=softmax`.\", \"Normalization of confidences in `TEDPolicy`\": \"Predictions of `TEDPolicy` will no longer be modified by masking and renormalizing\\nconfidences. This change can affect the maximum confidence predicted by the\\n`TEDPolicy` and thereby affect the final result of the policy ensemble.\\nHowever, the previous behavior can still be enforced by setting\\n`ranking_length=10` and `renormalize_confidences=True`.\", \"Removed Policies\": \"Several dialogue policies that were deprecated in Rasa 2.x have been removed in Rasa 3.0.\\nIf you are migrating a config file with a removed policy,\\nconsult the following migration guides for the individual policies:\\n\\n['`FallbackPolicy` [migration guide](#manually-migrating-from-the-fallback-policy)', '`TwoStageFallbackPolicy` [migration guide](#manually-migrating-from-the-two-stage-fallback-policy)', '`MappingPolicy` [migration guide](#manually-migrating-from-the-mapping-policy)', '`FormPolicy` [migration guide](#forms)', '`SklearnPolicy` should be replaced with [TEDPolicy](/policies#ted-policy).\\\\nIt is recommended to use the [default TEDPolicy config](/model-configuration#suggested-config) as a starting point.']\", \"Removed Tokenizers and Featurizers\": \"The `ConveRTTokenizer`, `LanguageModelTokenizer`, and `HFTransformersNLP` featurizer\\ncomponents were deprecated in Rasa 2.x and have been removed in Rasa 3.0. See the\\n[migration guide for Rasa 2.x](#deprecations-2) for replacing these components in your pipeline.\"}, \"Slot Mappings\": {\"Automatic migration from 2.0 domain format to the 3.0 format\": \"The only data file that has changed in format is the domain file.\\nTo migrate automatically to the 3.0 domain format, you can run the following command:\\n\\n```\\nrasa data migrate -d DOMAIN --out OUT_PATH\\n```\\n\\nIn addition to creating a valid 3.0 domain in the indicated out path, this command will automatically backup your\\noriginal domain file(s) in a file labeled `original_domain.yml` or `original_domain` directory if a directory was\\nprovided instead.\\n\\nTo maintain the behavior of forms in the 2.0 format, all migrated slot mappings will include mapping conditions for\\neach form. This can be changed manually according to your use case.\\nSee the docs on [mapping conditions](./domain.mdx#mapping-conditions) for more information.\", \"Manually migrating from 2.0 domain format to the 3.0 format\": \"Each slot in the `slots` section of the domain will need a new key `mappings`.\\nThis key is a list of mappings moved from forms, while the `required_slots` field collapses to a list of slot names.\\n\\nLet's consider the following 2.0 domain file:\\n\\n```\\nentities:\\n - cuisine\\n - number\\nslots:\\n cuisine:\\n type: text\\n num_people:\\n type: float\\n outdoor_seating:\\n type: bool\\nforms:\\n restaurant_form:\\n required_slots:\\n cuisine:\\n - type: from_entity\\n entity: cuisine\\n num_people:\\n - type: from_entity\\n entity: number\\n outdoor_seating:\\n - type: from_intent\\n intent: affirm\\n value: true\\n - type: from_intent\\n intent: deny\\n value: false\\n```\\n\\nThe initial result of migrating this domain to 3.0 format would look like this:\\n\\n```\\nentities:\\n - cuisine\\n - number\\nslots:\\n cuisine:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: cuisine\\n num_people:\\n type: float\\n mappings:\\n - type: from_entity\\n entity: number\\n outdoor_seating:\\n type: bool\\n mappings:\\n - type: from_intent\\n intent: affirm\\n value: true\\n - type: from_intent\\n intent: deny\\n value: false\\nforms:\\n restaurant_form:\\n required_slots:\\n - cuisine\\n - num_people\\n - outdoor_seating\\n```\\n\\nFor slots that should be filled only in the context of a form, add [mapping conditions](./domain.mdx#mapping-conditions)\\nto specify which form(s) should be active, as well as indicate if the `requested_slot` should be the same slot.\\nAdding `conditions` is required to preserve the behavior of slot mappings from 2.0, since without them\\nthe mappings will be applied on each user turn regardless of whether a form is active or not.\\n\\n```\\n slots:\\n outdoor_seating:\\n type: bool\\n mappings:\\n - type: from_intent\\n intent: affirm\\n value: true\\n conditions:\\n - active_loop: restaurant_form\\n requested_slot: outdoor_seating\\n - type: from_intent\\n intent: deny\\n value: false\\n conditions:\\n - active_loop: restaurant_form\\n requested_slot: outdoor_seating\\n```\", \"Rasa-SDK Modifications\": \"If you have used `FormValidationAction` to define custom extraction and validation code in which you override the\\n`required_slots` method, note that `slots_mapped_in_domain` argument has been replaced by the `domain_slots` argument.\\nYou must make this replacement to continue using your custom code.\\n\\nIf you have been dynamically filling slots not present in the form's `required_slots` defined in the `domain.yml`\\nfile, note that this behaviour is no longer supported in 3.x. Any dynamic slots with custom mappings, which are set in\\nthe last user turn, will be filled **only if** they are returned by the `required_slots` method of the custom action\\ninheriting from `FormValidationAction`. To maintain the 2.x behaviour, you must now override the `required_slots` method\\nof this custom action as per the strong recommendation listed in the [dynamic form documentation](./forms.mdx#dynamic-form-behavior).\\n\\nTo extract custom slots that are not defined in any form's `required_slots`, you should now use a global [custom slot mapping](./domain.mdx#custom-slot-mappings)\\nand extend the [ValidationAction class](./action-server/validation-action.mdx#validationaction-class).\\n\\n:::note\\nIf you have custom validation actions extending `FormValidationAction` which override `required_slots` method, you should\\ndouble-check the dynamic form behavior of your migrated assistant. Slots set by the default action\\n[`action_extract_slots`](./default-actions.mdx#action_extract_slots) may need to be reset within the context of your\\nform by the custom validation actions for the form's required slots. For example, if your form dynamically adds a required\\nslot after the first slot is filled, you may want to reset the potential required slot as part of the first required slot's\\nvalidation method to ensure it will be empty when added.\\n\\n:::\"}}, \"Rasa 2.7 to 2.8\": {\"Deprecations\": {\"Tracker Featurizers\": \"`training_states_actions_and_entities` method of `TrackerFeaturizer`, `FullDialogueTrackerFeaturizer` and\\n`MaxHistoryTrackerFeaturizer` classes is deprecated and will be removed in Rasa 3.0 .\\nIf you had a custom tracker featurizer which relied on this method from any of the above classes, please use\\n`training_states_labels_and_entities` instead.\\n\\n`training_states_and_actions` method of `TrackerFeaturizer`, `FullDialogueTrackerFeaturizer` and\\n`MaxHistoryTrackerFeaturizer` classes is deprecated and will be removed in Rasa 3.0 .\\nIf you had a custom tracker featurizer which relied on this method from any of the above classes, please use\\n`training_states_and_labels` instead.\", \"State Featurizer\": \"`encode_all_actions` method of `SingleStateFeaturizer` class is deprecated and will be removed in Rasa 3.0 .\\nIt is recommended to use the method `encode_all_labels` instead.\"}, \"Incremental Training\": \"Users don't need to specify an additional buffer size for sparse featurizers anymore during incremental training.\\n\\nSpace for new sparse features are created dynamically inside the downstream machine learning\\nmodels - `DIETClassifier`, `ResponseSelector`. In other words, no extra buffer is created in\\nadvance for additional vocabulary items and space will be dynamically allocated for them inside the model.\\n\\nThis means there's no need to specify `additional_vocabulary_size` for\\n[`CountVectorsFeaturizer`](./components.mdx#countvectorsfeaturizer) or\\n`number_additional_patterns` for [`RegexFeaturizer`](./components.mdx#regexfeaturizer).\\nThese parameters are now deprecated.\\n\\n**Before**\\n\\n```\\npipeline:\\n - name: \\\"WhitespaceTokenizer\\\"\\n - name: \\\"RegexFeaturizer\\\"\\n number_additional_patterns: 100\\n - name: \\\"CountVectorsFeaturizer\\\"\\n additional_vocabulary_size: {text: 100, response: 20}\\n```\\n\\n**Now**\\n\\n```\\npipeline:\\n - name: \\\"WhitespaceTokenizer\\\"\\n - name: \\\"RegexFeaturizer\\\"\\n - name: \\\"CountVectorsFeaturizer\\\"\\n```\", \"Machine Learning Components\": \"The option `model_confidence=linear_norm` is deprecated and will be removed in Rasa `3.0.0`.\\n\\nRasa `2.3.0` introduced `linear_norm` as a possible value for `model_confidence`\\nparameter in machine learning components such as `DIETClassifier`, `ResponseSelector` and `TEDPolicy`.\\nBased on user feedback, we have identified multiple problems with this option.\\nTherefore, `model_confidence=linear_norm` is now deprecated and\\nwill be removed in Rasa `3.0.0`. If you were using `model_confidence=linear_norm` for any of the mentioned components,\\nwe recommend to revert it back to `model_confidence=softmax` and re-train the assistant. After re-training,\\nwe also recommend to [re-tune the thresholds for fallback components](./fallback-handoff.mdx#fallbacks).\"}, \"Rasa 2.5 to 2.6\": {\"Forms\": {\"New `ignored_intents` parameter in Forms\": \"There is a new parameter under Forms called `ignored_intents`. This parameter\\ncan be used to prevent any required slots in a form from being filled with the specified\\nintent or intents. Please see the [Forms documentation](forms.mdx) for examples and more\\ninformation on how to use it in your `domain.yml` file.\\n\\nBefore, if a user did not want to fill any slots of a form with a specified intent\\nthey would have to define it under the `not_intent` parameter for every slot mapping\\nas shown in the following example :\\n\\n```\\nforms:\\n restaurant_form:\\n cuisine:\\n - type: from_entity\\n entity: cuisine\\n not_intent: chitchat\\n num_people:\\n - type: from_entity\\n entity: number\\n intent: [inform, request_restaurant]\\n not_intent: chitchat\\n feedback:\\n - type: from_entity\\n entity: feedback\\n not_intent: chitchat\\n```\\n\\nBy introducing the `ignored_intents` parameter, we now only need to define it\\nin one place and it will affect all the slots of the form :\\n\\n```\\nforms:\\n restaurant_form:\\n ignored_intents: chitchat\\n required_slots:\\n cuisine:\\n - type: from_entity\\n entity: cuisine\\n num_people:\\n - type: from_entity\\n entity: number\\n intent: [inform, request_restaurant]\\n feedback:\\n - type: from_entity\\n entity: feedback\\n - type: from_text\\n```\"}}, \"Rasa 2.4 to 2.5\": {\"Machine Learning Components\": {\"`DIET`, `TED`, and `ResponseSelector`\": \"The former `weight_sparsity` parameter of the `DIETClassifier`, `TEDPolicy`, and the `ResponseSelector`,\\nis now deprecated and superseded by the new `connection_density` parameter.\\nThe old `weight_sparsity` is roughly equivalent to `1 - connection_density`, except at very low densities\\n(high sparsities).\\n\\nTo avoid deprecation issues, you should set `connection_density` to\\n`1 - your former weight_sparsity setting` throughout the config file. (If you left\\n`weight_sparsity` at its default setting, you don't need to do anything.)\", \"SpaCy 3.0\": \"Rasa now supports spaCy 3.0. This means that we can support more features for more\\nlanguages but this also introduced a breaking change. SpaCy 3.0 deprecated the\\n`spacy link <language model>` command. So from now on you need to use the\\n[the full model name](https://spacy.io/models) in the `config.yml` file.\\n\\n**Before**\\n\\nBefore you could run `spacy link en en_core_web_md` and then we would be able\\nto pick up the correct model from the `language` parameter.\\n\\n```\\nlanguage: en\\n\\npipeline:\\n - name: SpacyNLP\\n```\\n\\n**Now**\\n\\nThis behavior will be deprecated and instead you'll want to be explicit in `config.yml`.\\n\\n```\\nlanguage: en\\n\\npipeline:\\n - name: SpacyNLP\\n model: en_core_web_md\\n```\\n\\n**Fallback**\\n\\nTo make the transition easier, Rasa will try to fall back to a medium spaCy model whenever\\na compatible language is configured for the entire pipeline in `config.yml`, even if you don't\\nspecify a `model`. This fallback behavior is temporary and will be deprecated in Rasa 3.0.0.\\n\\nWe've updated our docs to reflect these changes. All examples now show a direct link to the\\ncorrect spaCy model. We've also added a warning to the [SpaCyNLP](components.mdx#spacynlp)\\ndocs that explains the fallback behavior.\"}}, \"Rasa 2.3 to Rasa 2.4\": {\"Deprecating `template` for `response`\": \"NLG Server\\n\\n['Changed request format to send `response` as well as `template` as a field. The `template` field will be removed in Rasa 3.0.0.']\\n\\n`rasa.core.agent`\\n\\n['The terminology `template` is deprecated and replaced by `response`. Support for `template` from the NLG response will be removed in Rasa 3.0.0. Please see [here](./nlg.mdx) for more details.']\\n\\n`rasa.core.nlg.generator`\\n\\n['`generate()` now takes in `utter_action` as a parameter.', 'The terminology `template` is deprecated and replaced by `response`. Support for `template` in the `NaturalLanguageGenerator` will be removed in Rasa 3.0.0.']\\n\\n`rasa.shared.core.domain`\\n\\n['The property `templates` is deprecated. Use `responses` instead. It will be removed in Rasa 3.0.0.', '`retrieval_intent_templates` will be removed in Rasa 3.0.0. Please use `retrieval_intent_responses` instead.', '`is_retrieval_intent_template` will be removed in Rasa 3.0.0. Please use `is_retrieval_intent_response` instead.', '`check_missing_templates` will be removed in Rasa 3.0.0. Please use `check_missing_responses` instead.']\\n\\nResponse Selector\\n\\n['The field `template_name` will be deprecated in Rasa 3.0.0. Please use `utter_action` instead. Please see [here](./components.mdx#selectors) for more details.', 'The field `response_templates` will be deprecated in Rasa 3.0.0. Please use `responses` instead. Please see [here](./components.mdx#selectors) for more details.']\"}, \"Rasa 2.3.3 to Rasa 2.3.4\": {\"Machine Learning Components\": \"Rasa `2.3.0` introduced the option of using cosine similarities for model confidences by setting `model_confidence=cosine`. Some post-release experiments revealed that using `model_confidence=cosine` is wrong as it can change the order of predicted labels. That's why this option was removed in Rasa version `2.3.4`.\\n\\n`model_confidence=inner` is deprecated as it produces an unbounded range of confidences which can break\\nthe logic of assistants in various other places.\\n\\nWe encourage you to try `model_confidence=linear_norm` which will produce a linearly normalized version of dot product similarities with each value in the range `[0,1]`. This can be done with the following config:\\n\\n```\\n- name: DIETClassifier\\n model_confidence: linear_norm\\n constrain_similarities: True\\n```\\n\\nIf you trained a model with `model_confidence=cosine` or `model_confidence=inner` setting using previous versions of Rasa, please re-train by either removing the `model_confidence` option from the configuration or setting it to `linear_norm`.\"}, \"Rasa 2.2 to Rasa 2.3\": {\"General\": \"If you want to use Tensorboard for `DIETClassifier`, `ResponseSelector`, or `TEDPolicy` and log metrics after\\nevery (mini)batch, please use 'batch' instead of 'minibatch' as 'tensorboard_log_level'.\", \"Machine Learning Components\": \"A few changes have been made to the loss function inside machine learning (ML)\\ncomponents `DIETClassifier`, `ResponseSelector` and `TEDPolicy`. These include:\\n\\n['Configuration option `loss_type=softmax` is now deprecated and will be removed in Rasa 3.0.0. Use `loss_type=cross_entropy` instead.', 'The default loss function (`loss_type=cross_entropy`) can add an optional sigmoid cross-entropy loss of all similarity values to constrain\\\\nthem to an approximate range. You can turn on this option by setting `constrain_similarities=True`. This should help the models to perform better on real world test sets.']\\n\\nA new option `model_confidence` has been added to each ML component. It affects how the model's confidence for each label is computed during inference. It can take one of three values:\\n\\n['`softmax` - Dot product similarities between input and label embeddings are post-processed with a softmax function, as a result of which confidence for all labels sum up to 1.', '`cosine` - Cosine similarity between input and label embeddings. Confidence for each label will be in the range `[-1,1]`.', '`linear_norm` - Dot product similarities between input and label embeddings are post-processed with a linear normalization function. Confidence for each label will be in the range `[0,1]`.']\\n\\nThe default value is `softmax`, but we recommend trying `linear_norm`. This should make it easier to [tune thresholds for triggering fallback](./fallback-handoff.mdx#fallbacks).\\nThe value of this option does not affect how confidences are computed for entity predictions in `DIETClassifier`.\\n\\nWe encourage you to try both the above recommendations. This can be done with the following config:\\n\\n```\\n- name: DIETClassifier\\n model_confidence: linear_norm\\n constrain_similarities: True\\n ...\\n```\\n\\nOnce the assistant is re-trained with the above configuration, users should also [tune fallback confidence thresholds](./fallback-handoff.mdx#fallbacks).\\n\\n**EDIT**: Some post-release experiments revealed that using `model_confidence=cosine` is wrong as it can change the order of predicted labels. That's why this option was removed in Rasa version `2.3.4`.\"}, \"Rasa 2.1 to Rasa 2.2\": {\"General\": \"`TEDPolicy`'s `transformer_size`, `number_of_transformer_layers`,\\nand `dense_dimensions` parameters have been renamed.\\nPlease update your configuration files using the following mapping:\\n\\n| Old Model Parameter | New Model Parameter |\\n|-----------------------------|--------------------------------------------------------|\\n|`transformer_size` |dictionary `transformer_size` with keys |\\n| |`text`, `action_text`, `label_action_text`, `dialogue` |\\n|`number_of_transformer_layers`|dictionary `number_of_transformer_layers` with keys |\\n| |`text`, `action_text`, `label_action_text`, `dialogue` |\\n|`dense_dimension` |dictionary `dense_dimension` with keys |\\n| |`text`, `action_text`, `label_action_text`, `intent`, |\\n| |`action_name`, `label_action_name`, `entities`, `slots`,|\\n| |`active_loop` |\\n\\nFor example:\\n\\n```\\npolicies:\\n - name: TEDPolicy\\n transformer_size:\\n text: 128\\n action_text: 128\\n label_action_text: 128\\n dialogue: 128\\n number_of_transformer_layers:\\n text: 1\\n action_text: 1\\n label_action_text: 1\\n dialogue: 1\\n dense_dimension:\\n text: 128\\n action_text: 128\\n label_action_text: 128\\n intent: 20\\n action_name: 20\\n label_action_name: 20\\n entities: 20\\n slots: 20\\n active_loop: 20\\n```\", \"Deprecations\": {\"Markdown Data\": \"Training and test data in Markdown format is now deprecated. This includes:\\n\\n['reading and writing of story files in Markdown format', 'reading and writing of NLU data in Markdown format', 'reading and writing of retrieval intent data in Markdown format']\\n\\nSupport for Markdown data will be removed entirely in Rasa 3.0.0.\\n\\nPlease convert your existing Markdown data by using the commands\\ndescribed [here](./migration-guide.mdx#training-data-files).\"}, \"Policies\": {\"Other\": [\"`Domain.random_template_for` is deprecated and will be removed in Rasa\\n3.0.0. You can alternatively use the `TemplatedNaturalLanguageGenerator`.\", \"`Domain.action_names` is deprecated and will be removed in Rasa\\n3.0.0. Please use `Domain.action_names_or_texts` instead.\"]}}, \"Rasa 2.0 to Rasa 2.1\": {\"Deprecations\": \"`ConveRTTokenizer` is now deprecated. [ConveRTFeaturizer](./components.mdx#convertfeaturizer) now implements\\nits behaviour. To migrate, replace `ConveRTTokenizer` with any other tokenizer, for e.g.:\\n\\n```\\npipeline:\\n - name: WhitespaceTokenizer\\n - name: ConveRTFeaturizer\\n model_url: <Remote/Local path to model files>\\n ...\\n```\\n\\n`HFTransformersNLP` and `LanguageModelTokenizer` components are now deprecated.\\n[LanguageModelFeaturizer](./components.mdx#languagemodelfeaturizer) now implements their behaviour.\\nTo migrate, replace both the above components with any tokenizer and specify the model architecture and model weights\\nas part of `LanguageModelFeaturizer`, for e.g.:\\n\\n```\\npipeline:\\n - name: WhitespaceTokenizer\\n - name: LanguageModelFeaturizer\\n model_name: \\\"bert\\\"\\n model_weights: \\\"rasa/LaBSE\\\"\\n ...\\n```\"}, \"Rasa 1.10 to Rasa 2.0\": {\"General\": \"A lot has changed in version 2.0. Make sure you read\\nthrough this guide thoroughly, to make sure all parts of your bot are updated.\\nA lot of updates can be done automatically with inbuilt commands, others will need\\nsome manual conversion. If you have any feedback about these updates or the migration process, please post it\\nin the [forum](https://forum.rasa.com/t/rasa-open-source-2-0-is-out-now-internal-draft/35577).\", \"Training data files\": \"As of version 2.0, the new default training data format is yaml. Markdown is still supported,\\nbut this will be deprecated in Rasa 3.0.0.\\n\\nYou can convert existing NLU, Stories, and NLG (i.e. `responses.md`) training data\\nfiles in the Markdown format to the new YAML format using following commands:\\n\\n```\\nrasa data convert nlu -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}\\nrasa data convert nlg -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}\\nrasa data convert core -f yaml --data={SOURCE_DIR} --out={TARGET_DIR}\\n```\\n\\nConverted files will have the same names as the original ones but with a\\n`_converted.yml` suffix.\\n\\nIf you are using [forms](./migration-guide.mdx#forms) or [response selectors](./migration-guide.mdx#response-selectors),\\nsome additional changes will need to be made as described in their respective sections.\", \"Policies\": {\"Manually migrating from the Mapping Policy\": \"If you previously used the [Mapping Policy](https://rasa.com/docs/rasa/2.x/policies#mapping-policy), you\\ncan follow the documentation on [FAQs](./chitchat-faqs.mdx) to convert your mapped\\nintents to rules. Suppose you previously mapped an intent `ask_is_bot` as follows:\\n\\n```\\nintents:\\n - ask_is_bot:\\n triggers: action_is_bot\\n```\\n\\nThis becomes the following rule:\\n\\n```\\nrules:\\n- rule: Rule to map `ask_is_bot` intent\\n steps:\\n - intent: ask_is_bot\\n - action: action_is_bot\\n```\\n\\nAnd you can safely remove any `triggers:` from your domain:\\n\\n```\\nintents:\\n - ask_is_bot\\n```\\n\\nFinally, you can replace the Mapping Policy with the\\n[Rule Policy](./policies.mdx#rule-policy) in your model configuration:\\n\\n```\\npolicies:\\n # Other policies\\n - name: RulePolicy\\n```\", \"Manually migrating from the Fallback Policy\": \"If you previously used the [Fallback Policy](https://rasa.com/docs/rasa/2.x/policies#fallback-policy), the following model\\nconfiguration would translate as follows given a previous configuration like this:\\n\\n```\\npolicies:\\n - name: \\\"FallbackPolicy\\\"\\n nlu_threshold: 0.4\\n core_threshold: 0.3\\n fallback_action_name: \\\"action_default_fallback\\\"\\n ambiguity_threshold: 0.1\\n```\\n\\nThe new configuration would then look like:\\n\\n```\\nrecipe: default.v1\\npipeline:\\n # Other components\\n - name: FallbackClassifier\\n threshold: 0.4\\n ambiguity_threshold: 0.1\\n\\npolicies:\\n # Other policies\\n - name: RulePolicy\\n core_fallback_threshold: 0.3\\n core_fallback_action_name: \\\"action_default_fallback\\\"\\n```\\n\\nIn addition, you need to add a [rule](./rules.mdx) to specify which action to run\\nin case of low NLU confidence:\\n\\n```\\nrules:\\n - rule: Ask the user to rephrase whenever they send a message with low NLU confidence\\n steps:\\n - intent: nlu_fallback\\n - action: utter_please_rephrase\\n```\\n\\nSee the documentation on [fallback](./fallback-handoff.mdx#fallbacks) for more\\ninformation.\", \"Manually migrating from the Two-Stage-Fallback Policy\": \"If you previously used the\\n[Two-Stage Fallback Policy](https://rasa.com/docs/rasa/2.x/policies#two-stage-fallback-policy), with a configuration\\nlike this for example:\\n\\n```\\npolicies:\\n - name: TwoStageFallbackPolicy\\n nlu_threshold: 0.4\\n ambiguity_threshold: 0.1\\n core_threshold: 0.3\\n fallback_core_action_name: \\\"action_default_fallback\\\"\\n fallback_nlu_action_name: \\\"action_default_fallback\\\"\\n deny_suggestion_intent_name: \\\"out_of_scope\\\"\\n```\\n\\nThe new configuration would look like this:\\n\\n```\\nrecipe: default.v1\\npipeline:\\n # Other components\\n - name: FallbackClassifier\\n threshold: 0.4\\n ambiguity_threshold: 0.1\\n\\npolicies:\\n # Other policies\\n - name: RulePolicy\\n core_fallback_threshold: 0.3\\n core_fallback_action_name: \\\"action_default_fallback\\\"\\n```\\n\\nIn addition you need to add a [rule](./rules.mdx) to activate the Two-Stage Fallback for\\nmessages with low NLU confidence.\\n\\n```\\nrules:\\n - rule: Implementation of the TwoStageFallbackPolicy\\n steps:\\n # This intent is automatically triggered by the `FallbackClassifier` in the NLU\\n # pipeline in case the intent confidence was below the specified threshold.\\n - intent: nlu_fallback\\n # The Fallback is now implemented as a form.\\n - action: action_two_stage_fallback\\n - active_loop: action_two_stage_fallback\\n```\\n\\nNote that the previous parameters `fallback_nlu_action_name` and\\n`deny_suggestion_intent_name` are no longer configurable and have the fixed values\\n`action_default_fallback` and `out_of_scope`.\\n\\nSee the [fallback](./fallback-handoff.mdx#fallbacks) documentation for more\\ninformation.\"}, \"Forms\": \"As of version 2.0 the logic for [forms](./forms.mdx) has been moved from the\\nRasa SDK to Rasa to simplify implementation and make it easier to write\\naction servers in other languages.\\n\\nThis means that forms are no longer implemented using a `FormAction`, but instead\\ndefined in the domain. Any customizations around requesting slots or\\n[slot validation](./forms.mdx#validating-form-input) can be handled with a `FormValidationAction`.\\n\\nConsider a custom form action from 1.x like this:\\n\\n```\\nfrom typing import Text, List, Any, Dict, Union\\nfrom rasa_sdk import Tracker\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk.forms import FormAction\\n\\nclass RestaurantForm(FormAction):\\n def name(self) -> Text:\\n return \\\"restaurant_form\\\"\\n\\n @staticmethod\\n def required_slots(tracker: Tracker) -> List[Text]:\\n return [\\\"cuisine\\\"]\\n\\n def slot_mappings(self) -> Dict[Text, Union[Dict, List[Dict]]]:\\n return {\\n \\\"cuisine\\\": self.from_entity(entity=\\\"cuisine\\\", not_intent=\\\"chitchat\\\"),\\n }\\n\\n @staticmethod\\n def cuisine_db() -> List[Text]:\\n \\\"\\\"\\\"Database of supported cuisines\\\"\\\"\\\"\\n\\n return [\\\"caribbean\\\", \\\"chinese\\\", \\\"french\\\"]\\n\\n def validate_cuisine(\\n self,\\n value: Text,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> Dict[Text, Any]:\\n \\\"\\\"\\\"Validate cuisine value.\\\"\\\"\\\"\\n\\n if value.lower() in self.cuisine_db():\\n # validation succeeded, set the value of the \\\"cuisine\\\" slot to value\\n return {\\\"cuisine\\\": value}\\n else:\\n dispatcher.utter_message(template=\\\"utter_wrong_cuisine\\\")\\n # validation failed, set this slot to None, meaning the\\n # user will be asked for the slot again\\n return {\\\"cuisine\\\": None}\\n\\n def submit(\\n self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> List[Dict]:\\n \\\"\\\"\\\"Define what the form has to do\\n after all required slots are filled\\\"\\\"\\\"\\n\\n # utter submit template\\n dispatcher.utter_message(template=\\\"utter_submit\\\")\\n return []\\n```\\n\\nStart the migration by removing the FormPolicy and adding the [RulePolicy](./policies.mdx#rule-policy)\\n(if not there already) to your model configuration:\\n\\n```\\npolicies:\\n # Other policies\\n # ...\\n - name: RulePolicy\\n```\\n\\nThen you need to define the form, required slots and their slot mappings\\nin the domain as described in the documentation on [forms](./forms.mdx#defining-a-form):\\n\\n```\\nforms:\\n restaurant_form:\\n cuisine:\\n - type: from_entity\\n entity: cuisine\\n not_intent: chitchat\\n```\\n\\nIf you ran the command to [convert your stories](./migration-guide.mdx#training-data-Files),\\nyou will have a story that handles form activation and deactivation like this:\\n\\n```\\nstories:\\n - story: cuisine form\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - active_loop: null\\n - action: utter_submit\\n```\\n\\nThis will work fine, but the best way to handle form behavior is to remove this story and instead\\ndefine two separate rules for form activation and submission:\\n\\n```\\nrules:\\n - rule: Activate form\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n\\n - rule: Submit form\\n condition:\\n # Condition that form is active.\\n - active_loop: restaurant_form\\n steps:\\n - action: restaurant_form\\n - active_loop: null\\n # The action we want to run when the form is submitted.\\n - action: utter_submit\\n```\\n\\nThe last step is to implement a custom action to validate the form slots. Start by\\nadding the custom action to your domain:\\n\\n```\\nactions:\\n # Other actions\\n # ...\\n - validate_restaurant_form\\n```\\n\\nThen add a custom action which validates the `cuisine` slot:\\n\\n```\\nfrom typing import Text, List, Any, Dict, Union\\nfrom rasa_sdk import Tracker\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk import FormValidationAction\\nfrom rasa_sdk.types import DomainDict\\n\\nclass RestaurantFormValidator(FormValidationAction):\\n def name(self) -> Text:\\n return \\\"validate_restaurant_form\\\"\\n\\n @staticmethod\\n def cuisine_db() -> List[Text]:\\n \\\"\\\"\\\"Database of supported cuisines\\\"\\\"\\\"\\n\\n return [\\\"caribbean\\\", \\\"chinese\\\", \\\"french\\\"]\\n\\n def validate_cuisine(\\n self,\\n slot_value: Any,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: DomainDict,\\n ) -> Dict[Text, Any]:\\n \\\"\\\"\\\"Validate cuisine value.\\\"\\\"\\\"\\n\\n if slot_value.lower() in self.cuisine_db():\\n # validation succeeded, set the value of the \\\"cuisine\\\" slot to value\\n return {\\\"cuisine\\\": slot_value}\\n else:\\n # validation failed, set this slot to None, meaning the\\n # user will be asked for the slot again\\n return {\\\"cuisine\\\": None}\\n```\\n\\nYou can also migrate forms from Rasa SDK to Rasa 2 iteratively. You can for\\nexample migrate one form to the Rasa 2 implementation while continue using\\nthe deprecated Rasa SDK implementation for another form. To continue to use\\nthe deprecated Rasa SDK `FormAction`s, add a custom action with the name of your form to your domain. Note that you should complete the migration as soon as possible as the deprecated `FormAction`\\nwill be removed from the Rasa SDK in Rasa 3.\\n\\n```\\nactions:\\n# Adding a custom action for a form will\\n# instruct Rasa to use the\\n# deprecated Rasa SDK implementation of forms.\\n- my_form\\n\\nforms:\\n my_form:\\n```\\n\\nSee the [forms](./forms.mdx) documentation for more details.\", \"Response Selectors\": \"Response Selectors are a stable feature as of version 2.0.\\n\\nThe [conversion command](./migration-guide.mdx#training-data-files) will automatically\\nconvert your `responses.md` file, stories and nlu training data to the new yaml format.\\nIt will also take care of adding the `utter_` prefix to your responses.\\nAdditionally you will need to rename the `respond_` actions in your stories files to use the\\n`utter_` prefix instead. Run the following command to apply these changes:\\n\\n```\\nrasa data convert responses --data {SOURCE_DIR} --out={TARGET_DIR}\\n```\\n\\nYou can also apply these changes manually. For example:\\n\\n```\\nstories:\\n - story: chitchat\\n steps:\\n - intent: chitchat\\n - action: respond_chitchat\\n```\\n\\nbecomes\\n\\n```\\nstories:\\n - story: chitchat\\n steps:\\n - intent: chitchat\\n - action: utter_chitchat\\n```\\n\\nand you will need to add the `utter_` prefix to the response names in your `responses.md`\\nas well. For example:\\n\\n```\\nresponses:\\n chitchat/ask_name:\\n - text: Oh yeah, I am called the retrieval bot.\\n\\n chitchat/ask_weather:\\n - text: Oh, it does look sunny right now in Berlin.\\n```\\n\\nbecomes\\n\\n```\\nresponses:\\n utter_chitchat/ask_name:\\n - text: Oh yeah, I am called the retrieval bot.\\n\\n utter_chitchat/ask_weather:\\n - text: Oh, it does look sunny right now in Berlin.\\n```\\n\\nFinally, you should remove any actions with the `respond_` prefix from the actions\\nlist in your domain.\\n\\nThis behavior will work fine when defined as a story, but even better when defined\\nas a rule. You should consider transferring your retrieval stories to rules. More information\\non what that looks like in the [chitchat and FAQs documentation](./chitchat-faqs.mdx).\\n\\nResponse Selectors are now trained on retrieval intent labels by default instead\\nof the actual response text. For most models, this should improve training time\\nand accuracy of the `ResponseSelector`.\\n\\nIf you want to revert to the pre-2.0 default behavior, add the `use_text_as_label: true`\\nparameter to your `ResponseSelector` component:\\n\\n```\\npipeline:\\n # other components\\n - name: ResponseSelector\\n use_text_as_label: true\\n```\\n\\nThe output schema of `ResponseSelector` has changed. An example output looks like this:\\n\\n```\\n{\\n \\\"response_selector\\\": {\\n \\\"all_retrieval_intents\\\": [\\n \\\"faq\\\"\\n ],\\n \\\"default\\\": {\\n \\\"response\\\": {\\n \\\"id\\\": 1388783286124362000,\\n \\\"confidence\\\": 1,\\n \\\"intent_response_key\\\": \\\"faq/is_legit\\\",\\n \\\"response_templates\\\": [\\n {\\n \\\"text\\\": \\\"absolutely\\\",\\n \\\"image\\\": \\\"https://i.imgur.com/nGF1K8f.jpg\\\"\\n },\\n {\\n \\\"text\\\": \\\"I think so.\\\"\\n }\\n ]\\n \\\"template_name\\\": \\\"utter_faq/is_legit\\\"\\n },\\n \\\"ranking\\\": [\\n {\\n \\\"id\\\": 1388783286124362000,\\n \\\"confidence\\\": 1,\\n \\\"intent_response_key\\\": \\\"faq/is_legit\\\"\\n }\\n ]\\n }\\n }\\n}\\n```\\n\\nAs a result of this, if you were previously querying for the key `full_retrieval_intent` as:\\n\\n```\\nresponse_selector_output.get(\\\"default\\\")\\n .get(\\\"full_retrieval_intent\\\")\\n```\\n\\nyou should instead now do this:\\n\\n```\\nresponse_selector_output.get(\\\"default\\\")\\n .get(\\\"response\\\")\\n .get(\\\"intent_response_key\\\")\\n```\", \"Unfeaturized Slots\": \"[Slots](domain.mdx#slots) of type `unfeaturized` are\\ndeprecated and will be removed in version 3.0. To ignore slot values during\\na conversation, set the `influence_conversation` property of the slot to `false`.\\n\\nThe following snippet is an example of the deprecated unfeaturized slot usage:\\n\\n```\\nslots:\\n username:\\n type: unfeaturized\\n```\\n\\nTo update this to the new format, you can specify the expected data type `text` and\\ndefine that the slot should be ignored during the conversation.\\n\\n```\\nslots:\\n username:\\n type: text\\n # Set `influence_conversation` to `false`\\n # to ignore the slot value during the conversation.\\n influence_conversation: false\\n```\\n\\nIf you don't require the slot to have a specific data type, you can use the new slot\\ntype [any](domain.mdx#any-slot). This slot type is always ignored during a conversation\\nand does not make any assumptions regarding the data type of the slot value.\\n\\n```\\nslots:\\n username:\\n type: any\\n```\\n\\nPlease see the updated [slots documentation](domain.mdx#slots) for more information.\", \"Conversation sessions\": \"[Conversation sessions](domain.mdx#session-configuration) are now enabled by default\\nif your [Domain](domain.mdx) does not contain a session configuration. Previously a\\nmissing session configuration was treated as if conversation sessions were disabled.\\nYou can explicitly disable conversation sessions using the following snippet:\\n\\n```\\nsession_config:\\n # A session expiration time of `0`\\n # disables conversation sessions\\n session_expiration_time: 0\\n```\", \"Dialogue Featurization\": \"This section is only relevant if you explicitly defined [featurizers](./policies.mdx#featurizers)\\nin your policy configuration.\\n\\nLabelTokenizerSingleStateFeaturizer is deprecated and will be removed in the future.\\nIt should be replaced with SingleStateFeaturizer and some changes should be made to the NLU pipeline.\\nAdd a `Tokenizer` with the option `intent_tokenization_flag: True` and `CountVectorsFeaturizer`\\nto the NLU pipeline.\\n\\nFor example:\\n\\n```\\nlanguage: en\\npipeline:\\n - name: WhitespaceTokenizer\\n intent_tokenization_flag: True\\n - name: CountVectorsFeaturizer\\n # other components\\npolicies:\\n # other policies\\n - name: TEDPolicy\\n featurizer:\\n - name: SingleStateFeaturizer\\n\\n```\\n\\nBinarySingleStateFeaturizer is deprecated and will be removed in the future.\\nYou should replace it with `SingleStateFeaturizer` and a NLU pipeline\\nwhere `intent_tokenization_flag` of a Tokenizer is set to `False`.\\n\\nFor example:\\n\\n```\\nlanguage: en\\npipeline:\\n - name: WhitespaceTokenizer\\n intent_tokenization_flag: False\\n # other components\\npolicies:\\n # other policies\\n - name: TEDPolicy\\n featurizer:\\n - name: SingleStateFeaturizer\\n\\n```\", \"Deprecations\": \"The deprecated [event brokers](./event-brokers.mdx) FileProducer, KafkaProducer, PikaProducer\\nand SQLProducer have been removed. If you used these brokers in your\\n`endpoints.yml` make sure to use the renamed variants instead:\\n\\n['FileProducer became FileEventBroker', 'KafkaProducer became KafkaEventBroker', 'PikaProducer became PikaEventBroker', 'SQLProducer became SQLEventBroker']\\n\\nThe deprecated EmbeddingIntentClassifier has been removed. If you used this\\ncomponent in your pipeline configuration (`config.yml`) you can replace it\\nwith [DIETClassifier](./components.mdx#dietclassifier).\\nIt accepts the same configuration parameters.\\n\\nThe deprecated KerasPolicy has been removed. If you used this\\ncomponent in your policies configuration (`config.yml`) you can replace it\\nwith [TEDPolicy](./policies.mdx#ted-policy). It accepts the same configuration parameters.\"}, \"Rasa 1.7 to Rasa 1.8\": {\"General\": [\"The [TED Policy](./policies.mdx#ted-policy) replaced the `keras_policy` as recommended machine\\nlearning policy. New projects generated with `rasa init` will automatically use\\nthis policy. In case you want to change your existing model configuration to use the\\n[TED Policy](./policies.mdx#ted-policy) add this to the `policies` section in your `config.yml`\\nand remove potentially existing `KerasPolicy` entries:\", \"```\\npolicies:\\n# - ... other policies\\n- name: TEDPolicy\\n max_history: 5\\n epochs: 100\\n```\", \"The given snippet specifies default values for the parameters `max_history` and\\n`epochs`. `max_history` is particularly important and strongly depends on your stories.\\nPlease see the docs of the [TED Policy](./policies.mdx#ted-policy) if you want to customize them.\", \"All pre-defined pipeline templates are deprecated. **Any templates you use will be\\nmapped to the new configuration, but the underlying architecture is the same**.\\nTake a look at [Tuning Your Model](./tuning-your-model.mdx) to decide on what components you should use\\nin your configuration file.\", \"The Embedding Policy was renamed to [TED Policy](./policies.mdx#ted-policy). The functionality of the policy stayed the same.\\nPlease update your configuration files to use `TEDPolicy` instead of `EmbeddingPolicy`.\", \"Most of the model options for `EmbeddingPolicy`, `EmbeddingIntentClassifier`, and `ResponseSelector` got\\nrenamed. Please update your configuration files using the following mapping:\", \"| Old model option | New model option |\\n|-----------------------------|-----------------------------------------------------|\\n|hidden_layers_sizes_a |dictionary \\u201chidden_layers_sizes\\u201d with key \\u201ctext\\u201d |\\n|hidden_layers_sizes_b |dictionary \\u201chidden_layers_sizes\\u201d with key \\u201clabel\\u201d |\\n|hidden_layers_sizes_pre_dial |dictionary \\u201chidden_layers_sizes\\u201d with key \\u201cdialogue\\u201d |\\n|hidden_layers_sizes_bot |dictionary \\u201chidden_layers_sizes\\u201d with key \\u201clabel\\u201d |\\n|num_transformer_layers |number_of_transformer_layers |\\n|num_heads |number_of_attention_heads |\\n|max_seq_length |maximum_sequence_length |\\n|dense_dim |dense_dimension |\\n|embed_dim |embedding_dimension |\\n|num_neg |number_of_negative_examples |\\n|mu_pos |maximum_positive_similarity |\\n|mu_neg |maximum_negative_similarity |\\n|use_max_sim_neg |use_maximum_negative_similarity |\\n|C2 |regularization_constant |\\n|C_emb |negative_margin_scale |\\n|droprate_a |droprate_dialogue |\\n|droprate_b |droprate_label |\\n|evaluate_every_num_epochs |evaluate_every_number_of_epochs |\\n|evaluate_on_num_examples |evaluate_on_number_of_examples |\", \"Old configuration options will be mapped to the new names, and a warning will be thrown.\\nHowever, these will be deprecated in a future release.\", \"The Embedding Intent Classifier is now deprecated and will be replaced by [DIETClassifier](./components.mdx#dietclassifier)\\nin the future.\\n`DIETClassfier` performs intent classification as well as entity recognition.\\nIf you want to get the same model behavior as the current `EmbeddingIntentClassifier`, you can use\\nthe following configuration of `DIETClassifier`:\", \"```\\npipeline:\\n# - ... other components\\n- name: DIETClassifier\\n hidden_layers_sizes:\\n text: [256, 128]\\n number_of_transformer_layers: 0\\n weight_sparsity: 0\\n intent_classification: True\\n entity_recognition: False\\n use_masked_language_model: False\\n BILOU_flag: False\\n scale_loss: True\\n use_sparse_input_dropout: False\\n use_dense_input_dropout: False\\n # ... any other parameters\\n```\", \"See [DIETClassifier](./components.mdx#dietclassifier) for more information about the new component.\\nSpecifying `EmbeddingIntentClassifier` in the configuration maps to the above component definition, and results in\\nthe same behaviour within the same Rasa version.\", \"`CRFEntityExtractor` is now deprecated and will be replaced by `DIETClassifier` in the future. If you want to\\nget the same model behavior as the current `CRFEntityExtractor`, you can use the following configuration:\", \"```\\npipeline:\\n# - ... other components\\n- name: LexicalSyntacticFeaturizer\\n features: [\\n [\\\"low\\\", \\\"title\\\", \\\"upper\\\"],\\n [\\n \\\"BOS\\\",\\n \\\"EOS\\\",\\n \\\"low\\\",\\n \\\"prefix5\\\",\\n \\\"prefix2\\\",\\n \\\"suffix5\\\",\\n \\\"suffix3\\\",\\n \\\"suffix2\\\",\\n \\\"upper\\\",\\n \\\"title\\\",\\n \\\"digit\\\",\\n ],\\n [\\\"low\\\", \\\"title\\\", \\\"upper\\\"],\\n ]\\n- name: DIETClassifier\\n intent_classification: False\\n entity_recognition: True\\n use_masked_language_model: False\\n number_of_transformer_layers: 0\\n # ... any other parameters\\n```\", \"`CRFEntityExtractor` featurizes user messages on its own, it does not depend on any featurizer.\\nWe extracted the featurization from the component into the new featurizer [LexicalSyntacticFeaturizer](./components.mdx#lexicalsyntacticfeaturizer). Thus,\\nin order to obtain the same results as before, you need to add this featurizer to your pipeline before the\\n[DIETClassifier](./components.mdx#dietclassifier).\\nSpecifying `CRFEntityExtractor` in the configuration maps to the above component definition, the behavior\\nis unchanged from previous versions.\", \"If your pipeline contains `CRFEntityExtractor` and `EmbeddingIntentClassifier` you can substitute both\\ncomponents with [DIETClassifier](./components.mdx#dietclassifier). You can use the following pipeline for that:\", \"```\\npipeline:\\n# - ... other components\\n- name: LexicalSyntacticFeaturizer\\n features: [\\n [\\\"low\\\", \\\"title\\\", \\\"upper\\\"],\\n [\\n \\\"BOS\\\",\\n \\\"EOS\\\",\\n \\\"low\\\",\\n \\\"prefix5\\\",\\n \\\"prefix2\\\",\\n \\\"suffix5\\\",\\n \\\"suffix3\\\",\\n \\\"suffix2\\\",\\n \\\"upper\\\",\\n \\\"title\\\",\\n \\\"digit\\\",\\n ],\\n [\\\"low\\\", \\\"title\\\", \\\"upper\\\"],\\n ]\\n- name: DIETClassifier\\n number_of_transformer_layers: 0\\n # ... any other parameters\\n```\"]}, \"Rasa 1.6 to Rasa 1.7\": {\"General\": [\"By default, the `EmbeddingIntentClassifier`, `EmbeddingPolicy`, and `ResponseSelector` will\\nnow normalize the top 10 confidence results if the `loss_type` is `\\\"softmax\\\"` (which has been\\ndefault since 1.3, see [Rasa 1.2 to Rasa 1.3](./migration-guide.mdx#rasa-12-to-rasa-13)). This is configurable via the `ranking_length`\\nconfiguration parameter; to turn off normalization to match the previous behavior, set `ranking_length: 0`.\"]}, \"Rasa 1.2 to Rasa 1.3\": {\"General\": [\"Default parameters of `EmbeddingIntentClassifier` are changed. See\\nthe Components page for details.\\nArchitecture implementation is changed as well, so **old trained models cannot be loaded**.\\nDefault parameters and architecture for `EmbeddingPolicy` are changed. See [Policies](./policies.mdx) for details.\\nIt uses transformer instead of lstm. **Old trained models cannot be loaded**.\\nThey use `inner` similarity and `softmax` loss by default instead of\\n`cosine` similarity and `margin` loss (can be set in config file).\\nThey use `balanced` batching strategy by default to counteract class imbalance problem.\\nThe meaning of `evaluate_on_num_examples` is changed. If it is non zero, random examples will be\\npicked by stratified split and used as **hold out** validation set, so they will be excluded from training data.\\nWe suggest to set it to zero (default) if data set contains a lot of unique examples of dialogue turns.\\nRemoved `label_tokenization_flag` and `label_split_symbol` from component. Instead moved intent splitting to `Tokenizer` components via `intent_tokenization_flag` and `intent_split_symbol` flag.\", \"Default `max_history` for `EmbeddingPolicy` is `None` which means it'll use\\nthe `FullDialogueTrackerFeaturizer`. We recommend to set `max_history` to\\nsome finite value in order to use `MaxHistoryTrackerFeaturizer`\\nfor **faster training**. See [Featurizers](./policies.mdx#featurizers) for details.\\nWe recommend to increase `batch_size` for `MaxHistoryTrackerFeaturizer`\\n(e.g. `\\\"batch_size\\\": [32, 64]`)\", \"**Compare** mode of `rasa train core` allows the whole core config comparison.\\nTherefore, we changed the naming of trained models. They are named by config file\\nname instead of policy name. Old naming style will not be read correctly when\\ncreating **compare** plots (`rasa test core`). Please remove old trained models\\nin comparison folder and retrain. Normal core training is unaffected.\", \"We updated the **evaluation metric** for our **NER**. We report the weighted precision and f1-score.\\nSo far we included `no-entity` in this report. However, as most of the tokens actually don't have\\nan entity set, this will influence the weighted precision and f1-score quite a bit. From now on we\\nexclude `no-entity` from the evaluation. The overall metrics now only include proper entities. You\\nmight see a drop in the performance scores when running the evaluation again.\", \"`/` is reserved as a delimiter token to distinguish between retrieval intent and the corresponding response text\\nidentifier. Make sure you don't include `/` symbol in the name of your intents.\"]}, \"Rasa NLU 0.14.x and Rasa Core 0.13.x to Rasa 1.0\": {\"General\": [\"The scripts in `rasa.core` and `rasa.nlu` can no longer be executed. To train, test, run, \\u2026 an NLU or Core\\nmodel, you should now use the command line interface `rasa`. The functionality is, for the most part, the same as before.\\nSome changes in commands reflect the combined training and running of NLU and Core models, but NLU and Core can still\\nbe trained and used individually. If you attempt to run one of the old scripts in `rasa.core` or `rasa.nlu`,\\nan error is thrown that points you to the command you\\nshould use instead. See all the new commands at [Command Line Interface](./command-line-interface.mdx).\", \"If you have written a custom output channel, all `send_` methods subclassed\\nfrom the `OutputChannel` class need to take an additional `\\\\*\\\\*kwargs`\\nargument. You can use these keyword args from your custom action code or the\\ntemplates in your domain file to send any extra parameters used in your\\nchannel's send methods.\", \"If you were previously importing the `Button` or `Element` classes from\\n`rasa_core.dispatcher`, these are now to be imported from `rasa_sdk.utils`.\", \"Rasa NLU and Core previously used <a href=\\\"https://legacy-docs.rasa.com/docs/nlu/0.15.1/migrations/?&_ga=2.218966814.608734414.1560704810-314462423.1543594887#id1\\\" target=\\\"_blank\\\" rel=\\\"nofollow noopener noreferrer\\\">separate configuration files</a>.\\nThese two files should be merged into a single file either named `config.yml`, or passed via the `--config` parameter.\"], \"Script parameters\": [\"All script parameter names have been unified to follow the same schema.\\nAny underscores (`_`) in arguments have been replaced with dashes (`-`).\\nFor example: `--max_history` has been changed to `--max-history`. You can\\nsee all of the script parameters in the `--help` output of the commands\\nin the [Command Line Interface](./command-line-interface.mdx).\", \"The `--num_threads` parameter was removed from the `run` command. The\\nserver will always run single-threaded, but will now run asynchronously. If you want to\\nmake use of multiple processes, feel free to check out the [Sanic server\\ndocumentation](https://sanicframework.org/en/guide/deployment/running.html#gunicorn).\", \"To avoid conflicts in script parameter names, connectors in the `run` command now need to be specified with\\n`--connector`, as `-c` is no longer supported. The maximum history in the `rasa visualize` command needs to be\\ndefined with `--max-history`. Output paths and log files cannot be specified with `-o` anymore; `--out` and\\n`--log-file` should be used. NLU data has been standarized to be `--nlu` and the name of\\nany kind of data files or directory to be `--data`.\"], \"HTTP API\": [\"There are numerous HTTP API endpoint changes which can be found [here](./http-api.mdx).\"]}}, \"metadata\": {\"id\": \"migration-guide\", \"sidebar_label\": \"Version Migration Guide\", \"title\": \"Version Migration Guide\", \"description\": \"Information about changes between major versions of chatbot framework Rasa Core\\nand how you can migrate from one version to another.\\n\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 28]\"}, {\"title\": \"Model Configuration\", \"description\": \"Learn about model configuration for Rasa.\", \"content\": {\"Suggested Config\": \"You can leave the pipeline and/or policies key out of your configuration file.\\nWhen you run `rasa train`, the Suggested Config feature will select a default configuration\\nfor the missing key(s) to train the model.\\n\\nMake sure to specify the language key in your `config.yml` file with the\\n2-letter ISO language code.\\n\\nExample `config.yml` file:\\n\\n```\\n```\\n\\nThe selected configuration will also be written as comments into the `config.yml` file,\\nso you can see which configuration was used. For the example above, the resulting file\\nmight look e.g. like this:\\n\\n```\\n```\\n\\nIf you like, you can then un-comment the suggested configuration for one or both of the\\nkeys and make modifications. Note that this will disable automatic suggestions for this\\nkey when training again.\\nAs long as you leave the configuration commented out and don't specify any configuration\\nfor a key yourself, a default configuration will be suggested whenever you train a new\\nmodel.\\n\\n:::note nlu- or dialogue- only models\\n\\nOnly the default configuration for `pipeline` will be automatically selected\\nif you run `rasa train nlu`, and only the default configuration for `policies`\\nwill be selected if you run `rasa train core`.\\n:::\"}, \"metadata\": {\"id\": \"model-configuration\", \"sidebar_label\": \"Overview\", \"title\": \"Model Configuration\", \"description\": \"Learn about model configuration for Rasa.\", \"abstract\": \"The configuration file defines the components and policies that your model will use to make predictions based on user input.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 29]\"}, {\"title\": \"Model Storage\", \"description\": null, \"content\": {\"Load Model from Disk\": \"By default models will be loaded from your local disk. You can specify the path\\nto your model with the `--model` parameter:\\n\\n```\\nrasa run --model models/20190506-100418.tar.gz\\n```\\n\\nIf you want to load the latest model in a directory, you can specify\\na directory instead of a file:\\n\\n```\\nrasa run --model models/\\n```\\n\\nRasa will check all the models in that directory and load the one that was trained\\nmost recently.\\n\\nIf you don't specify a `--model` argument, Rasa will look for models in the `models/` directory. The two following calls\\nwill load the same model:\\n\\n```\\n# this command will load the same model\\nrasa run --model models/\\n# ... as this command (using defaults)\\nrasa run\\n```\", \"Load Model from Server\": {\"How to Configure Rasa\": \"You can configure the HTTP server to fetch models from another URL\\nby adding it to your `endpoints.yml`:\\n\\n```\\nmodels:\\n url: http://my-server.com/models/default\\n wait_time_between_pulls: 10 # In seconds, optional, default: 100\\n```\\n\\nThe server will query the `url` for a zipped model every `wait_time_between_pulls`\\nseconds.\\n\\nIf you want to pull the model only when starting up the server, you can set the time\\nbetween pulls to `null`:\\n\\n```\\nmodels:\\n url: http://my-server.com/models/default\\n wait_time_between_pulls: null # fetches model only once\\n```\", \"How to Configure Your Server\": \"Rasa will send a `GET` request to the URL you specified in the\\n`endpoints.yml`, e.g. `http://my-server.com/models/default` in the above examples.\\nYou can use any URL.\\nThe `GET` request will contain an `If-None-Match` header that contains the\\nmodel hash of the last model it downloaded. An example request from Rasa Open\\nSource to your server would look like this:\\n\\n```\\ncurl --header \\\"If-None-Match: d41d8cd98f00b204e9800998ecf8427e\\\" http://my-server.com/models/default\\n```\\n\\nThe response of your server to this `GET` request should be one of these:\\n\\n['a status code of `200`, a zipped Rasa Model and set the `ETag` header in\\\\nthe response to the hash of the model.', 'a status code of `304` and an empty response if the `If-None-Match`\\\\nheader of the request matches the model you want your server to return.']\\n\\nRasa uses the `If-None-Match` and `ETag` headers for caching. Setting\\nthe headers will avoid re-downloading the same model over and over, saving\\nbandwidth and compute resources.\"}, \"Load Model from Cloud\": {\"Amazon S3 Storage\": \"Amazon S3 is supported using the `boto3` package which you need to install\\nas an additional dependency using `pip3`:\\n\\n```\\npip3 install boto3\\n```\\n\\nFor Rasa to be able to authenticate and download the model, you need to set the\\nfollowing environment variables before running any command requiring the storage:\\n\\n['`AWS_SECRET_ACCESS_KEY`: environment variable containing your AWS S3 secret access key', '`AWS_ACCESS_KEY_ID`: environment variable containing your AWS S3 access key ID', '`AWS_DEFAULT_REGION`: environment variable specifying the region of your AWS S3 bucket', '`BUCKET_NAME`: environment variable specifying the S3 bucket', '`AWS_ENDPOINT_URL`: The complete URL to use for the AWS S3 requests. You need to\\\\nspecify a complete URL (including the \\\"http/https\\\" scheme), for example: `https://s3.amazonaws.com`.\\\\nNote that by setting the bucket name to `BUCKET_NAME` environment variable, you should not provide the bucket or\\\\nobject URL to `AWS_ENDPOINT_URL`.']\\n\\nOnce all environment variables are set, you can start the Rasa server with\\n`remote-storage` option set to `aws`:\\n\\n```\\nrasa run --model 20190506-100418.tar.gz --remote-storage aws\\n```\", \"Google Cloud Storage\": \"Google Cloud Storage (GCS) is supported using the `google-cloud-storage` package\\nwhich you need to install as an additional dependency using `pip3`:\\n\\n```\\npip3 install google-cloud-storage\\n```\\n\\nIf you are running Rasa on Google App Engine or Compute Engine, the auth\\ncredentials are already set up (for the GCS in the same project). In this case,\\nyou can skip setting any additional environment variables.\\n\\nIf you are running locally or on a machine outside of GAE or GCE you need to\\nprovide the authentication details to Rasa manually:\\n\\n['Check out the [GCS documentation](https://cloud.google.com/docs/authentication/getting-started#auth-cloud-implicit-python)\\\\nand follow the descriptions on \\\"Creating a service account\\\" and\\\\n\\\"Setting the environment variable.\\\"', 'After you have completed the GCS instructions, you should have set an environment\\\\nvariable called `GOOGLE_APPLICATION_CREDENTIALS` to the path of a service account\\\\nkey file with access to your GCS.']\\n\\nOnce all environment variable is set, you can start the Rasa server with\\n`remote-storage` option set to `gcs`:\\n\\n```\\nrasa run --model 20190506-100418.tar.gz --remote-storage gcs\\n```\", \"Azure Storage\": \"Azure Storage is supported using the `azure-storage-blob` package which you need\\nto install as an additional dependency using `pip3`:\\n\\n```\\npip3 install azure-storage-blob\\n```\\n\\nFor Rasa to be able to authenticate and download the model, you need to set the\\nfollowing environment variables before running any command requiring the storage:\\n\\n['`AZURE_CONTAINER`: environment variable containing your azure container name', '`AZURE_ACCOUNT_NAME`: environment variable containing your azure account name', '`AZURE_ACCOUNT_KEY`: environment variable containing your account key']\\n\\nOnce all environment variables are set, you can start the Rasa server with\\n`remote-storage` option set to `azure`:\\n\\n```\\nrasa run --model 20190506-100418.tar.gz --remote-storage azure\\n```\", \"Other Remote Storages\": \"If you want to use any other Cloud Storage, you can provide your own python\\nimplementation of the [`rasa.nlu.persistor.Persistor`](/reference/rasa/nlu/persistor) class.\\n\\nYou can start the Rasa server with `remote-storage` option set to\\nthe module path of your persistor implementation:\\n\\n```\\nrasa run --remote-storage <your module>.<class name>\\n```\"}}, \"metadata\": {\"id\": \"model-storage\", \"sidebar_label\": \"Model Storage\", \"title\": \"Model Storage\", \"abstract\": \"Models can be stored in different places after you trained your assistant. This\\npage explains how to configure Rasa to load your models.\\n\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 30]\"}, {\"title\": \"NLG Servers\", \"description\": null, \"content\": {\"Responding to Requests\": {\"Request Format\": \"When your model predicts that your bot should send a response to the user,\\nit will send a request to your server, giving you the information\\nrequired to select or generate a response.\\n\\nThe body of the `POST` request sent to your NLG endpoint will be structured\\nlike this:\\n\\n:::info New in 3.6\\nWe have added an `id` field to the request body.\\nThis field contains the ID of the response variation.\\nYou can use this information to compose/select a proper response variation on your NLG server.\\n\\n:::\\n\\n```\\n{\\n \\\"response\\\":\\\"utter_what_can_do\\\",\\n \\\"arguments\\\":{\\n \\n },\\n \\\"id\\\": \\\"<response_variation_id>\\\",\\n \\\"tracker\\\":{\\n \\\"sender_id\\\":\\\"user_0\\\",\\n \\\"slots\\\":{\\n \\n },\\n \\\"latest_message\\\":{\\n \\\"intent\\\":{\\n \\\"id\\\":3014457480322877053,\\n \\\"name\\\":\\\"greet\\\",\\n \\\"confidence\\\":0.9999994039535522\\n },\\n \\\"entities\\\":[\\n \\n ],\\n \\\"text\\\":\\\"Hello\\\",\\n \\\"message_id\\\":\\\"94838d6f49ff4366b254b6f6d23a90cf\\\",\\n \\\"metadata\\\":{\\n \\n },\\n \\\"intent_ranking\\\":[\\n {\\n \\\"id\\\":3014457480322877053,\\n \\\"name\\\":\\\"greet\\\",\\n \\\"confidence\\\":0.9999994039535522\\n },\\n {\\n \\\"id\\\":8842445304628198686,\\n \\\"name\\\":\\\"ask_forget_reminders\\\",\\n \\\"confidence\\\":5.675940428773174e-07\\n },\\n {\\n \\\"id\\\":-2566831912141022859,\\n \\\"name\\\":\\\"bye\\\",\\n \\\"confidence\\\":3.418941929567154e-08\\n },\\n {\\n \\\"id\\\":8340513453672591403,\\n \\\"name\\\":\\\"ask_id\\\",\\n \\\"confidence\\\":2.5274500714544956e-08\\n },\\n {\\n \\\"id\\\":5822154213939471096,\\n \\\"name\\\":\\\"ask_remind_call\\\",\\n \\\"confidence\\\":2.4177523982871207e-08\\n }\\n ]\\n },\\n \\\"latest_event_time\\\":1599476297.694504,\\n \\\"followup_action\\\":null,\\n \\\"paused\\\":false,\\n \\\"events\\\":[\\n {\\n \\\"event\\\":\\\"action\\\",\\n \\\"timestamp\\\":1599476297.68784,\\n \\\"name\\\":\\\"action_session_start\\\",\\n \\\"policy\\\":null,\\n \\\"confidence\\\":null\\n },\\n {\\n \\\"event\\\":\\\"session_started\\\",\\n \\\"timestamp\\\":1599476297.6878452\\n },\\n {\\n \\\"event\\\":\\\"action\\\",\\n \\\"timestamp\\\":1599476297.6878562,\\n \\\"name\\\":\\\"action_listen\\\",\\n \\\"policy\\\":null,\\n \\\"confidence\\\":null\\n },\\n {\\n \\\"event\\\":\\\"user\\\",\\n \\\"timestamp\\\":1599476297.694504,\\n \\\"text\\\":\\\"Hello\\\",\\n \\\"parse_data\\\":{\\n \\\"intent\\\":{\\n \\\"id\\\":3014457480322877053,\\n \\\"name\\\":\\\"greet\\\",\\n \\\"confidence\\\":0.9999994039535522\\n },\\n \\\"entities\\\":[\\n \\n ],\\n \\\"text\\\":\\\"Hello\\\",\\n \\\"message_id\\\":\\\"94838d6f49ff4366b254b6f6d23a90cf\\\",\\n \\\"metadata\\\":{\\n \\n },\\n \\\"intent_ranking\\\":[\\n {\\n \\\"id\\\":3014457480322877053,\\n \\\"name\\\":\\\"greet\\\",\\n \\\"confidence\\\":0.9999994039535522\\n },\\n {\\n \\\"id\\\":8842445304628198686,\\n \\\"name\\\":\\\"ask_forget_reminders\\\",\\n \\\"confidence\\\":5.675940428773174e-07\\n },\\n {\\n \\\"id\\\":-2566831912141022859,\\n \\\"name\\\":\\\"bye\\\",\\n \\\"confidence\\\":3.418941929567154e-08\\n },\\n {\\n \\\"id\\\":8340513453672591403,\\n \\\"name\\\":\\\"ask_id\\\",\\n \\\"confidence\\\":2.5274500714544956e-08\\n },\\n {\\n \\\"id\\\":5822154213939471096,\\n \\\"name\\\":\\\"ask_remind_call\\\",\\n \\\"confidence\\\":2.4177523982871207e-08\\n }\\n ]\\n },\\n \\\"input_channel\\\":\\\"rest\\\",\\n \\\"message_id\\\":\\\"94838d6f49ff4366b254b6f6d23a90cf\\\",\\n \\\"metadata\\\":{\\n \\n }\\n }\\n ],\\n \\\"latest_input_channel\\\":\\\"rest\\\",\\n \\\"active_loop\\\":{\\n \\n },\\n \\\"latest_action_name\\\":\\\"action_listen\\\"\\n },\\n \\\"channel\\\":{\\n \\\"name\\\":\\\"collector\\\"\\n }\\n}\\n```\\n\\nHere is an overview of the high-level keys in the post request: \\n\\nKey | Description\\n---|---\\n`response` | The name of the response predicted by Rasa.\\n`id` | An optional string representing the response variation ID, can be null.\\n`arguments` | Optional keyword arguments that can be provided by custom actions.\\n`tracker` | A dictionary containing the entire conversation history.\\n`channel` | The output channel this message will be sent to.\\n\\nYou can use any or all of this information to decide\\nhow to generate your response.\", \"Response Format\": \"The endpoint needs to respond with the generated response. \\nRasa will then send this response back to the user.\\n\\nBelow are the possible keys of a response and their (empty) types: \\n\\n```\\n{\\n \\\"text\\\": \\\"Some text\\\",\\n \\\"buttons\\\": [],\\n \\\"image\\\": null, # string of image URL\\n \\\"elements\\\": [],\\n \\\"attachments\\\": [], \\n \\\"custom\\\": {}\\n}\\n```\\n\\nYou can choose to provide just text, or a combination of different types of rich responses. \\nJust like [the responses defined in the domain file](./responses.mdx), a response needs to contain at the very least\\neither `text` or `custom` to be a valid response. \\n\\n:::caution Calling responses from stories\\nIf you use an external NLG service, you don't need to specify the\\nresponses under `responses` in the domain. However, you still need to add the response names\\nto the `actions` list of the domain if you want to call them directly from\\nyour stories.\\n\\n:::\"}, \"Configuring the Server URL\": \"To tell Rasa where to find your NLG server, add the URL to your `endpoints.yml`: \\n\\n```\\nnlg:\\n url: http://localhost:5055/nlg\\n```\\n\\nIf your NLG server is protected and Rasa will need authentication to\\naccess it, you can configure authentication in the endpoints:\\n\\n```\\nnlg:\\n url: http://localhost:5055/nlg\\n # \\n # You can also specify additional parameters, if you need them:\\n # headers:\\n # my-custom-header: value\\n # token: \\\"my_authentication_token\\\" # will be passed as a GET parameter\\n # basic_auth:\\n # username: user\\n # password: pass\\n```\"}, \"metadata\": {\"id\": \"nlg\", \"sidebar_label\": \"NLG\", \"title\": \"NLG Servers\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 31]\"}, {\"title\": \"NLU-Only Server\", \"description\": \"Read about connecting to a Rasa NLU-only server using the HTTP API.\", \"content\": {\"Connecting to an NLU server\": \"You can connect a [Rasa NLU-only server](./nlu-only.mdx#running-an-nlu-server) to a separately running Rasa dialogue management only server\\nby adding the connection details to the dialogue management server's endpoint configuration file:\\n\\n```\\nnlu:\\n url: \\\"http://<your nlu host>:<your nlu port>\\\"\\n token: <token> # [optional]\\n token_name: <name of the token> # [optional] (default: token)\\n```\\n\\nThe `token` and `token_name` refer to optional [authentication parameters](./http-api.mdx#token-based-auth).\\n\\nThe dialogue management server should serve a model that does not include an NLU model.\\nTo obtain a dialogue management only model, train a model with `rasa train core` or use \\n`rasa train` but exclude all NLU data.\\n\\nWhen the dialogue management server receives a message, it will [send a request](https://rasa.com/docs/rasa/pages/http-api#operation/parseModelMessage) to \\n`http://<your nlu host>:<your nlu port>/model/parse` and use the parsing information returned.\\n\\n:::note endpoint configuration\\nThe endpoint configuration for the dialogue management server will include an `nlu` endpoint that refers to your NLU only server. Therefore you should **use a separate endpoint configuration file** for the NLU server, excluding the `nlu` endpoint.\\n:::\\n\\nIf you are implementing a custom NLU server (i.e. not Rasa NLU), your server should provide a `/model/parse` endpoint that responds to requests in the same \\nformat as a Rasa NLU server does.\"}, \"metadata\": {\"id\": \"nlu-only-server\", \"sidebar_label\": \"NLU-Only Server\", \"title\": \"NLU-Only Server\", \"description\": \"Read about connecting to a Rasa NLU-only server using the HTTP API.\", \"abstract\": \"You can run an NLU-only server and use the HTTP API to connect to it.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 32]\"}, {\"title\": \"Using NLU Only\", \"description\": null, \"content\": {\"Training NLU-only models\": \"To train an NLU model only, run:\\n\\n```\\nrasa train nlu\\n```\\n\\nThis will look for NLU training data files in the ``data/`` directory\\nand saves a trained model in the ``models/`` directory.\\nThe name of the model will start with ``nlu-``.\", \"Testing your NLU model on the command line\": \"To try out your NLU model on the command line, run the following command:\\n\\n```\\nrasa shell nlu\\n```\\n\\nThis will start the rasa shell and ask you to type in a message to test.\\nYou can keep typing in as many messages as you like.\\n\\nAlternatively, you can leave out the ``nlu`` argument and pass in a nlu-only model directly:\\n\\n```\\nrasa shell -m models/nlu-20190515-144445.tar.gz\\n```\", \"Running an NLU server\": \"To start a server with your NLU model, pass in the model name at runtime:\\n\\n```\\nrasa run --enable-api -m models/nlu-20190515-144445.tar.gz\\n```\\n\\nYou can then request predictions from your model using the ``/model/parse`` endpoint.\\nTo do this, run:\\n\\n```\\ncurl localhost:5005/model/parse -d '{\\\"text\\\":\\\"hello\\\"}'\\n```\"}, \"metadata\": {\"id\": \"nlu-only\", \"sidebar_label\": \"Using NLU Only\", \"title\": \"Using NLU Only\", \"abstract\": \"Find out how to use only Rasa NLU as a standalone NLU service for your chatbot or virtual assistant.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 33]\"}, {\"title\": \"NLU Training Data\", \"description\": \"Read more about how to format training data with Rasa NLU for open source natural language processing.\", \"content\": {\"Training Examples\": \"NLU training data consists of example user utterances categorized by\\nintent. \\nTo make it easier to use your intents, give them names that relate to what the user wants to accomplish with that intent, keep them in lowercase, and avoid spaces and special characters. \\n\\n:::note\\nThe `/` symbol is reserved as a delimiter to separate [retrieval intents](glossary.mdx#retrieval-intent) from response text identifiers. Make sure not\\nto use it in the name of your intents.\\n\\n:::\", \"Entities\": \"[Entities](glossary.mdx#entity) are structured pieces of information inside a user message. \\nFor entity extraction to work, you need to either specify training data to train an ML model or you need to define [regular expressions](#regular-expressions-for-entity-extraction) to extract entities using the [`RegexEntityExtractor`](components.mdx#regexentityextractor) based on a character pattern.\\n\\nWhen deciding which entities you need to extract, think about what information your assistant needs for its user goals. The user might provide additional pieces of information that you don't need for any user goal; you don't need to extract these as entities.\\n\\nSee the [training data format](./training-data-format.mdx) for details on how to annotate entities in your training data.\", \"Synonyms\": \"Synonyms map extracted entities to a value other than the literal text extracted in a case-insensitive manner. \\nYou can use synonyms when there are multiple ways users refer to the same\\nthing. Think of the end goal of extracting an entity, and figure out from there which values should be considered equivalent. \\n\\nLet's say you had an entity `account` that you use to look up the user's balance. One of the possible account types is \\\"credit\\\". Your users also refer to their \\\"credit\\\" account as \\\"credit\\naccount\\\" and \\\"credit card account\\\".\\n\\nIn this case, you could define \\\"credit card account\\\" and \\\"credit account\\\" as\\nsynonyms to \\\"credit\\\":\\n\\n```\\nnlu:\\n- synonym: credit\\n examples: |\\n - credit card account\\n - credit account\\n```\\n\\nThen, if either of these phrases is extracted as an entity, it will be\\nmapped to the value `credit`. Any alternate casing of these phrases (e.g. `CREDIT`, `credit ACCOUNT`) will also be mapped to the synonym.\\n\\n:::note Provide Training Examples\\nSynonym mapping only happens **after** entities have been extracted.\\nThat means that your training examples should include the synonym examples\\n(`credit card account` and `credit account`) so that the model will learn to\\nrecognize these as entities and replace them with `credit`.\\n:::\\n\\nSee the [training data format](./training-data-format.mdx) for details on how to include synonyms in your training data.\", \"Regular Expressions\": {\"Regular Expressions for Intent Classification\": \"You can use regular expressions to improve intent classification by including the `RegexFeaturizer` component in your pipeline. When using the `RegexFeaturizer`, a regex does not act as a rule for classifying an intent. It only provides a feature that the intent classifier will use\\nto learn patterns for intent classification.\\nCurrently, all intent classifiers make use of available regex features.\\n\\nThe name of a regex in this case is a human readable description. It can help you remember what a regex is used for, and it is the title of the corresponding pattern feature. It does not have to match any intent or entity name. A regex for a \\\"help\\\" request might look like this:\\n\\n```\\nnlu:\\n- regex: help\\n examples: |\\n - \\\\bhelp\\\\b\\n```\\n\\nThe intent being matched could be `greet`,`help_me`, `assistance` or anything else.\\n\\nTry to create your regular expressions in a way that they match as few\\nwords as possible. E.g. using `\\\\bhelp\\\\b` instead of `help.*`, as the\\nlater one might match the whole message whereas the first one only\\nmatches a single word.\\n\\n:::note Provide Training Examples\\nThe `RegexFeaturizer` provides features to the intent classifier, but it doesn't predict the intent directly. Include enough examples containing the regular expression so that the intent classifier can learn to use the regular expression feature.\\n:::\", \"Regular Expressions for Entity Extraction\": {\"Regular Expressions as Features\": \"You can use regular expressions to create features for the [`RegexFeaturizer`](components.mdx#regexfeaturizer) component in your NLU pipeline.\\n\\nWhen using a regular expression with the `RegexFeaturizer`, the\\nname of the regular expression does not matter.\\nWhen using the `RegexFeaturizer`, a regular expression provides a feature\\nthat helps the model learn an association between intents/entities and inputs\\nthat fit the regular expression. \\n\\n:::note Provide Training Examples\\nThe `RegexFeaturizer` provides features to the entity extractor, but it doesn't predict the entity directly. Include enough examples containing the regular expression so that the entity extractor can learn to use the regular expression feature.\\n\\n:::\\n\\nRegex features for entity extraction\\nare currently only supported by the `CRFEntityExtractor` and `DIETClassifier` components. Other entity extractors, like\\n`MitieEntityExtractor` or `SpacyEntityExtractor`, won't use the generated\\nfeatures and their presence will not improve entity recognition for\\nthese extractors.\", \"Regular Expressions for Rule-based Entity Extraction\": \"You can use regular expressions for rule-based entity extraction using the [`RegexEntityExtractor`](components.mdx#regexentityextractor) component in your NLU pipeline.\\n\\nWhen using the `RegexEntityExtractor`, the name of the regular expression should\\nmatch the name of the entity you want to extract.\\nFor example, you could extract account numbers of 10-12 digits by including this regular expression and at least two annotated examples in your training data:\\n\\n```\\nnlu:\\n- regex: account_number\\n examples: |\\n - \\\\d{10,12}\\n- intent: inform\\n examples: |\\n - my account number is [1234567891](account_number)\\n - This is my account number [1234567891](account_number)\\n```\\n\\nWhenever a user message contains a sequence of 10-12 digits, it will be extracted as an `account_number` entity. `RegexEntityExtractor` doesn't require training examples to learn to extract the entity, but you do need at least two annotated examples of the entity so that the NLU model can register it as an entity at training time.\"}}, \"Lookup Tables\": \"Lookup tables are lists of words used to generate\\ncase-insensitive regular expression patterns. They can be used in the same ways as [regular expressions](#regular-expressions) are used, in combination with the [`RegexFeaturizer`](components.mdx#regexfeaturizer) and [`RegexEntityExtractor`](components.mdx#regexentityextractor) components in the pipeline.\\n\\nYou can use lookup tables to help extract entities which have a known set of possible values. Keep your lookup tables as specific as possible. For example, to extract country names, you could add a lookup table of all countries in the world:\\n\\n```\\nnlu:\\n- lookup: country\\n examples: |\\n - Afghanistan\\n - Albania\\n - ...\\n - Zambia\\n - Zimbabwe\\n```\\n\\nWhen using lookup tables with `RegexFeaturizer`, provide enough examples for the intent or entity you want to match so that the model can learn to use the generated regular expression as a feature. When using lookup tables with `RegexEntityExtractor`, provide at least two annotated examples of the entity so that the NLU model can register it as an entity at training time.\", \"Entities Roles and Groups\": {\"Entity Roles and Groups influencing dialogue predictions\": \"If you want to influence the dialogue predictions by roles or groups, you need to modify your stories to contain\\nthe desired role or group label. You also need to list the corresponding roles and groups of an entity in your\\n[domain file](./domain.mdx#entities).\\n\\nLet's assume you want to output a different sentence depending on what the user's location is. E.g.\\nif the user just arrived from London, you might want to ask how the trip to London was. But if the user is on the way\\nto Madrid, you might want to wish the user a good stay. You can achieve this with the\\nfollowing two stories:\\n\\n```\\nstories:\\n- story: The user just arrived from another city.\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: inform_location\\n entities:\\n - city: London\\n role: from\\n - action: utter_ask_about_trip\\n\\n- story: The user is going to another city.\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: inform_location\\n entities:\\n - city: Madrid\\n role: to\\n - action: utter_wish_pleasant_stay\\n```\"}, \"BILOU Entity Tagging\": \"The [DIETClassifier](./components.mdx#dietclassifier) and [CRFEntityExtractor](./components.mdx#crfentityextractor)\\nhave the option `BILOU_flag`, which refers to a tagging schema that can be\\nused by the machine learning model when processing entities.\\n`BILOU` is short for Beginning, Inside, Last, Outside, and Unit-length.\\n\\nFor example, the training example\\n\\n```\\n[Alex]{\\\"entity\\\": \\\"person\\\"} is going with [Marty A. Rick]{\\\"entity\\\": \\\"person\\\"} to [Los Angeles]{\\\"entity\\\": \\\"location\\\"}.\\n```\\n\\nis first split into a list of tokens. Then the machine learning model applies the tagging schema\\nas shown below depending on the value of the option `BILOU_flag`:\\n\\n| token | `BILOU_flag = true` | `BILOU_flag = false` |\\n|---------|----------------------|-----------------------|\\n| alex | U-person | person |\\n| is | O | O |\\n| going | O | O |\\n| with | O | O |\\n| marty | B-person | person |\\n| a | I-person | person |\\n| rick | L-person | person |\\n| to | O | O |\\n| los | B-location | location |\\n| angeles | L-location | location |\\n\\nThe BILOU tagging schema is richer compared to the normal tagging schema. It may help to improve the\\nperformance of the machine learning model when predicting entities.\\n\\n:::note inconsistent BILOU tags\\nWhen the option `BILOU_flag` is set to `True`, the model may predict inconsistent BILOU tags, e.g.\\n`B-person I-location L-person`. Rasa uses some heuristics to clean up the inconsistent BILOU tags.\\nFor example, `B-person I-location L-person` would be changed into `B-person I-person L-person`.\\n:::\"}, \"metadata\": {\"id\": \"nlu-training-data\", \"sidebar_label\": \"NLU Training Data\", \"title\": \"NLU Training Data\", \"description\": \"Read more about how to format training data with Rasa NLU for open source natural language processing.\", \"abstract\": \"NLU training data stores structured information about user messages.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 34]\"}, {\"title\": \"PII Management\", \"description\": null, \"content\": {\"Architecture Overview\": {\"Supported Rasa Events\": \"The Rasa events that are anonymized include the following:\\n\\n['`user`', '`bot`', '`slot`', '`entities`']\", \"Supported PII entity types\": \"The anonymization pipeline uses [Microsoft Presidio](https://microsoft.github.io/presidio/text_anonymization/) as both entity recognizer and\\nanonymizer. Presidio is an open-source library that supports a wide range of entity types and anonymization methods.\\n\\nYou can specify any of the out-of-the-box [supported Presidio entity types](https://microsoft.github.io/presidio/supported_entities/) in the anonymization rules.\\nNote that it is currently not possible to add custom entity types for the Rasa Pro anonymization pipeline.\"}, \"How to write anonymization rules\": {\"How to populate the metadata section\": {\"How to install the language model\": \"You must install the model you declare to the `model_name` field in your Rasa Pro environment.\\nFor example, if you declare `model_name: en_core_web_lg`, you must install the spaCy `en_core_web_lg` model in your Rasa Pro environment.\\nYou can follow model installation instructions for spaCy and stanza models in the [Presidio official documentation](https://microsoft.github.io/presidio/analyzer/nlp_engines/spacy_stanza/).\\n\\nIn the case of the `transformers` model provider, you must install _both_ models that you declare in the `model_name` field\\nin your Rasa Pro environment. For example, if you declare `transformers: dslim/bert-base-NER` in `endpoints.yml`, you must\\ninstall the `dslim/bert-base-NER` model in your Rasa Pro environment. You can find model download instructions for\\n`HuggingFace` in the [Presidio official documentation](https://microsoft.github.io/presidio/analyzer/nlp_engines/transformers/).\\n\\n:::note\\nNot all languages have a pre-trained language model available. If you want to use a language that does not have\\na pre-trained language model available, you must train your own [spaCy](https://spacy.io/usage/training), [stanza](https://stanfordnlp.github.io/stanza/training.html)\\nor [huggingface](https://huggingface.co/docs/transformers/training) model and install it in your Rasa Pro environment.\\n:::\"}, \"How to populate the rule_lists section\": \"The `rule_lists` section contains a list of anonymization rule lists. Each rule list must have a unique `id` of type\\nstring and a list of `rules`. Each rule must have an `entity` field and a `substitution` field. The `entity` field\\nspecifies the Presidio entity type to be anonymized and must be in uppercase. Note that regular expressions are currently\\nnot supported for identifying entities.\\n\\nThe `substitution` field specifies the anonymization method to be used. Currently, the\\nfollowing anonymization methods are supported: `text`, `mask`, and `faker`:\\n\\n['The `text` anonymization method replaces the original entity value with the value specified in the `value` field.\\\\nIn the following example, the `PERSON` entity value will be replaced with `John Doe`.']\\n\\n```\\nanonymization:\\n metadata:\\n language: en\\n model_name: en_core_web_lg\\n model_provider: spacy\\n rule_lists:\\n - id: rules_1\\n rules:\\n - entity: PERSON\\n substitution: text\\n value: John Doe\\n```\\n\\n[\\\"The `mask` anonymization method replaces the original entity value with a mask of the same length using the character '*'.\\\\nFor example, if the original entity value is `John Doe`, the anonymized value will be `********`.\\\"]\\n\\n```\\nanonymization:\\n metadata:\\n language: en\\n model_name: en_core_web_lg\\n model_provider: spacy\\n rule_lists:\\n - id: rules_1\\n rules:\\n - entity: PERSON\\n substitution: mask\\n```\\n\\n['The `faker` anonymization method replaces the original entity value with a fake value generated by the [Faker](https://faker.readthedocs.io/en/stable/) library.\\\\nFor example, if the original entity value is `John Doe`, the anonymized value will be replaced with a fake name generated by the Faker library.']\\n\\n```\\nanonymization:\\n metadata:\\n language: en\\n model_name: en_core_web_lg\\n model_provider: spacy\\n rule_lists:\\n - id: rules_1\\n rules:\\n - entity: PERSON\\n substitution: faker\\n```\\n\\nIf no substitution method is specified, the default substitution method is `mask`.\\n\\nThe `value` field is only required for the `text` anonymization method. It specifies the text to be used as the anonymized value.\\nIf the `value` field is not specified, the original entity value to be anonymized will be replaced with the entity type\\nname between brackets. For example, if the `value` field is not specified for the `PERSON` entity type, the anonymized\\nvalue will be `<PERSON>`.\\n\\nThe `faker` anonymization method uses the [Faker](https://faker.readthedocs.io/en/stable/) library to generate fake data.\\nBy default, the `faker` anonymization method will generate fake data in English unless a localized Presidio\\nentity type is used. For example, if you use the `faker` substitution method for the `ES_NIF` entity type, the generated\\nfake data will match the format of a Spanish NIF.\\n\\nThe `faker` substitution method does not support the following Presidio entity types:\\n\\n['`CRYPTO`, `NRP`, `MEDICAL_LICENSE`', '`US_BANK_NUMBER`, `US_DRIVER_LICENSE`', '`UK_NHS`', '`IT_FISCAL_CODE`, `IT_DRIVER_LICENSE`, `IT_PASSPORT`, `IT_IDENTITY_CARD`', '`SG_NRIC_FIN`', '`AU_ABN`, `AU_ACN`, `AU_TFN`, `AU_MEDICARE`']\\n\\nIf any of the above entities is used together with the `faker` substitution method, the anonymization pipeline will default\\nto the `mask` substitution method.\"}, \"How to update the Kafka event broker configuration\": {\"Streaming anonymized events to Rasa X/Enterprise with Kafka\": \"Streaming anonymized events to Rasa X/Enterprise is only supported for Rasa X/Enterprise versions `1.3.0` and above.\\nIn addition, you must use the Kafka event broker, other event broker types are not supported.\\n\\nYou can stream anonymized events to Rasa X/Enterprise via Kafka by adding the `rasa_x_consumer: true` key-value pair to\\nthe `anonymization_topics` section:\\n\\n```\\nevent_broker:\\n type: kafka\\n partition_by_sender: True\\n url: localhost\\n anonymization_topics:\\n - name: topic_1\\n anonymization_rules: rules_1\\n rasa_x_consumer: true\\n - name: topic_2\\n anonymization_rules: rules_2\\n```\\n\\nIf multiple Kafka anonymization topics contain the `rasa_x_consumer` key-value pair, the anonymized events will be streamed\\nto the Kafka topic that is mapped to the first topic in the `anonymization_topics` list that contains the `rasa_x_consumer`\\nkey-value pair.\\n\\nNote that the `rasa_x_consumer` key-value pair is optional. If it is not specified, the anonymized events will be published\\nto the Kafka topic, but they will not be streamed to Rasa X/Enterprise.\"}, \"How to enable anonymization of PII in logs\": \"You can enable anonymization of PII in logs by filling the `logger` section in the `endpoints.yml` file.\\nThe `logger` section must have the following structure:\\n\\n```\\nlogger:\\n formatter:\\n anonymization_rules: rules_1\\n```\\n\\nThe `anonymization_rules` field specifies the `id` of the anonymization rule list to be used for the logs.\\n\\n:::caution\\nWe strongly recommend to run with log level INFO in production.\\nRunning with log level DEBUG will increase the assistant's response latency because of processing delays.\\n:::\\n\\nNote that running `rasa shell` in debug mode with a Kafka event broker might result in logs related to the event publishing\\nto be printed to console **after** the bot message. This behaviour is expected because the event anonymization and publishing\\nis done asynchronously as a background task, so it will complete after the assistant has already predicted and executed the\\nbot response.\"}, \"metadata\": {\"id\": \"pii-management\", \"sidebar_label\": \"PII Management\", \"title\": \"PII Management\", \"hide_table_of_contents\": false}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 35]\"}, {\"title\": \"Policies\", \"description\": null, \"content\": {\"Action Selection\": {\"Policy Priority\": \"In the case that two policies predict with equal confidence (for example, the Memoization\\nand Rule Policies might both predict with confidence 1), the priority of the\\npolicies is considered. Rasa policies have default priorities that are set to ensure the\\nexpected outcome in the case of a tie. They look like this, where higher numbers have higher priority:\\n\\n<!-- We want to have high priority policies first; it's not possible to use a Markdown ordered list for that. -->\\n\\n['6 - `RulePolicy`', '3 - `MemoizationPolicy` or `AugmentedMemoizationPolicy`', '2 - `UnexpecTEDIntentPolicy`', '1 - `TEDPolicy`']\\n\\nIn general, it is not recommended to have more\\nthan one policy per priority level in your configuration. If you have 2 policies with the same priority and they predict\\nwith the same confidence, the resulting action will be chosen randomly.\\n\\nIf you create your own policy, use these priorities as a guide for figuring out the priority of your policy.\\nIf your policy is a machine learning policy, it should most likely have priority 1, the same as the `TEDPolicy`.\\n\\n:::warning overriding policy priorities\\nAll policy priorities are configurable via the `priority` parameter in the policy's configuration,\\nbut we **do not recommend** changing them outside of specific cases such as custom policies.\\nDoing so can lead to unexpected and undesired bot behavior.\\n\\n:::\"}, \"Machine Learning Policies\": {\"TED Policy\": \"The Transformer Embedding Dialogue (TED) Policy is\\na multi-task architecture for next action prediction and entity\\nrecognition. The architecture consists of several transformer encoders which are shared for both tasks.\\nA sequence of entity labels is predicted through a Conditional Random Field (CRF) tagging layer on top of the\\nuser sequence transformer encoder output corresponding to the input sequence of tokens.\\nFor the next action prediction, the dialogue transformer encoder output and the system action labels are embedded into a\\nsingle semantic vector space. We use the dot-product loss to maximize the similarity with the target label and\\nminimize similarities with negative samples.\\n\\nIf you want to learn more about the model, check out\\n[our paper](https://arxiv.org/abs/1910.00486) and on our\\n[youtube channel](https://www.youtube.com/watch?v=j90NvurJI4I&list=PL75e0qA87dlG-za8eLI6t0_Pbxafk-cxb&index=14&ab_channel=Rasa).\\nwhere we explain the model architecture in detail.\\n\\nTED Policy architecture comprises the following steps:\\n\\n['Concatenate features for', ['user input (user intent and entities) or user text processed through a user sequence transformer encoder,', 'previous system actions or bot utterances processed through a bot sequence transformer encoder,', 'slots and active forms'], 'for each time step into an input vector to the embedding layer that precedes the\\\\ndialogue transformer.', 'Feed the embedding of the input vector into the dialogue transformer encoder.', 'Apply a dense layer to the output of the dialogue transformer to get embeddings of the dialogue for each time step.', 'Apply a dense layer to create embeddings for system actions for each time step.', 'Calculate the similarity between the dialogue embedding and embedded system actions.\\\\nThis step is based on the [StarSpace](https://arxiv.org/abs/1709.03856) idea.', 'Concatenate the token-level output of the user sequence transformer encoder\\\\nwith the output of the dialogue transformer encoder for each time step.', 'Apply CRF algorithm to predict contextual entities for each user text input.']\\n\\n**Configuration:**\\n\\nYou can pass configuration parameters to the `TEDPolicy` using the `config.yml` file.\\nIf you want to fine-tune your model, start by modifying the following parameters:\\n\\n[\\\"`epochs`:\\\\nThis parameter sets the number of times the algorithm will see the training data (default: `1`).\\\\nOne `epoch` is equals to one forward pass and one backward pass of all the training examples.\\\\nSometimes the model needs more epochs to properly learn.\\\\nSometimes more epochs don't influence the performance.\\\\nThe lower the number of epochs the faster the model is trained.\\\\nHere is how the config would look like:\\\", '```\\\\npolicies:\\\\n- name: TEDPolicy\\\\n epochs: 200\\\\n```', '`max_history`:\\\\nThis parameter controls how much dialogue history the model looks at to decide which\\\\naction to take next. Default `max_history` for this policy is `None`,\\\\nwhich means that the complete dialogue history since session restart is taken into\\\\naccount. If you want to limit the model to only see a certain number of previous\\\\ndialogue turns, you can set `max_history` to a finite value.\\\\nPlease note that you should pick `max_history` carefully, so that the model has enough\\\\nprevious dialogue turns to create a correct prediction.\\\\nSee [Featurizers](#featurizers) for more details.\\\\nHere is how the config would look like:', '```\\\\npolicies:\\\\n- name: TEDPolicy\\\\n max_history: 8\\\\n```', '`number_of_transformer_layers`:\\\\nThis parameter sets the number of sequence transformer encoder layers to use for\\\\nsequential transformer encoders for user, action and action label texts and for\\\\ndialogue transformer encoder.\\\\n(defaults: `text: 1, action_text: 1, label_action_text: 1, dialogue: 1`).\\\\nThe number of sequence transformer encoder layers corresponds\\\\nto the transformer blocks to use for the model.', '`transformer_size`:\\\\nThis parameter sets the number of units in the sequence transformer encoder layers to use for\\\\nsequential transformer encoders for user, action and action label texts and for\\\\ndialogue transformer encoder.\\\\n(defaults: `text: 128, action_text: 128, label_action_text: 128, dialogue: 128`).\\\\nThe vectors coming out of the transformer encoders will have the given `transformer_size`.', '`connection_density`:\\\\nThis parameter defines the fraction of kernel weights that are set to non zero values for all feed forward\\\\nlayers in the model (default: `0.2`). The value should be between 0 and 1. If you set `connection_density`\\\\nto 1, no kernel weights will be set to 0, the layer acts as a standard feed forward layer. You should not\\\\nset `connection_density` to 0 as this would result in all kernel weights being 0, i.e. the model is not able\\\\nto learn.', '`split_entities_by_comma`:\\\\nThis parameter defines whether adjacent entities separated by a comma should be treated as one, or split. For example,\\\\nentities with the type `ingredients`, like \\\"apple, banana\\\" can be split into \\\"apple\\\" and \\\"banana\\\". An entity with type\\\\n`address`, like \\\"Sch\\u00f6nhauser Allee 175, 10119 Berlin\\\" should be treated as one.', 'Can either be\\\\n`True`/`False` globally:', '```\\\\npolicies:\\\\n - name: TEDPolicy\\\\n split_entities_by_comma: True\\\\n```', 'or set per entity type, such as:', '```\\\\npolicies:\\\\n - name: TEDPolicy\\\\n split_entities_by_comma:\\\\n address: False\\\\n ingredients: True\\\\n```', '`constrain_similarities`:\\\\nThis parameter when set to `True` applies a sigmoid cross entropy loss over all similarity terms.\\\\nThis helps in keeping similarities between input and negative labels to smaller values.\\\\nThis should help in better generalization of the model to real world test sets.', '`model_confidence`:\\\\nThis parameter allows the user to configure how confidences are computed during inference. Currently, only one value is supported:', ['`softmax`: Confidences are in the range `[0, 1]` (old behavior and current default). Computed similarities are normalized with the `softmax` activation function.'], '`use_gpu`:\\\\nThis parameter defines whether a GPU (if available) will be used training. By default, `TEDPolicy` will be trained on GPU \\\\nif a GPU is available (i.e. `use_gpu` is `True`). To enforce that `TEDPolicy` uses only the CPU for training, set `use_gpu` to `False`.']\\n\\nThe above configuration parameters are the ones you should configure to fit your model to your data.\\nHowever, additional parameters exist that can be adapted.\\n\\n<details><summary>More configurable parameters</summary>\\n\\n```\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| Parameter | Default Value | Description |\\n+=======================================+========================+==============================================================+\\n| hidden_layers_sizes | text: [] | Hidden layer sizes for layers before the embedding layers |\\n| | action_text: [] | for user messages and bot messages in previous actions |\\n| | label_action_text: [] | and labels. The number of hidden layers is |\\n| | | equal to the length of the corresponding list. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| dense_dimension | text: 128 | Dense dimension for sparse features to use after they are |\\n| | action_text: 128 | converted into dense features. |\\n| | label_action_text: 128 | |\\n| | intent: 20 | |\\n| | action_name: 20 | |\\n| | label_action_name: 20 | |\\n| | entities: 20 | |\\n| | slots: 20 | |\\n| | active_loop: 20 | |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| concat_dimension | text: 128 | Common dimension to which sequence and sentence features of |\\n| | action_text: 128 | different dimensions get converted before concatenation. |\\n| | label_action_text: 128 | |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| encoding_dimension | 50 | Dimension size of embedding vectors |\\n| | | before the dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| transformer_size | text: 128 | Number of units in user text sequence transformer encoder. |\\n| | action_text: 128 | Number of units in bot text sequence transformer encoder. |\\n| | label_action_text: 128 | Number of units in bot text sequence transformer encoder. |\\n| | dialogue: 128 | Number of units in dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_transformer_layers | text: 1 | Number of layers in user text sequence transformer encoder. |\\n| | action_text: 1 | Number of layers in bot text sequence transformer encoder. |\\n| | label_action_text: 1 | Number of layers in bot text sequence transformer encoder. |\\n| | dialogue: 1 | Number of layers in dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_attention_heads | 4 | Number of self-attention heads in transformers. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| unidirectional_encoder | True | Use a unidirectional or bidirectional encoder |\\n| | | for `text`, `action_text`, and `label_action_text`. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_key_relative_attention | False | If 'True' use key relative embeddings in attention. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_value_relative_attention | False | If 'True' use value relative embeddings in attention. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| max_relative_position | None | Maximum position for relative embeddings. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| batch_size | [64, 256] | Initial and final value for batch sizes. |\\n| | | Batch size will be linearly increased for each epoch. |\\n| | | If constant `batch_size` is required, pass an int, e.g. `8`. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| batch_strategy | \\\"balanced\\\" | Strategy used when creating batches. |\\n| | | Can be either 'sequence' or 'balanced'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| epochs | 1 | Number of epochs to train. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| random_seed | None | Set random seed to any 'int' to get reproducible results. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| learning_rate | 0.001 | Initial learning rate for the optimizer. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| embedding_dimension | 20 | Dimension size of dialogue & system action embedding vectors.|\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_negative_examples | 20 | The number of incorrect labels. The algorithm will minimize |\\n| | | their similarity to the user input during training. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| similarity_type | \\\"auto\\\" | Type of similarity measure to use, either 'auto' or 'cosine' |\\n| | | or 'inner'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| loss_type | \\\"cross_entropy\\\" | The type of the loss function, either 'cross_entropy' |\\n| | | or 'margin'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| ranking_length | 0 | Number of top actions to include in prediction. Confidences |\\n| | | of all other actions will be set to 0. Set to 0 to let the |\\n| | | prediction include confidences for all actions. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| renormalize_confidences | False | Normalize the top predictions. Applicable only with loss |\\n| | | type 'cross_entropy' and 'softmax' confidences. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| maximum_positive_similarity | 0.8 | Indicates how similar the algorithm should try to make |\\n| | | embedding vectors for correct labels. |\\n| | | Should be 0.0 < ... < 1.0 for 'cosine' similarity type. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| maximum_negative_similarity | -0.2 | Maximum negative similarity for incorrect labels. |\\n| | | Should be -1.0 < ... < 1.0 for 'cosine' similarity type. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_maximum_negative_similarity | True | If 'True' the algorithm only minimizes maximum similarity |\\n| | | over incorrect intent labels, used only if 'loss_type' is |\\n| | | set to 'margin'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| scale_loss | True | Scale loss inverse proportionally to confidence of correct |\\n| | | prediction. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| regularization_constant | 0.001 | The scale of regularization. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| negative_margin_scale | 0.8 | The scale of how important it is to minimize the maximum |\\n| | | similarity between embeddings of different labels. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_dialogue | 0.1 | Dropout rate for embedding layers of dialogue features. |\\n| | | Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_label | 0.0 | Dropout rate for embedding layers of label features. |\\n| | | Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_attention | 0.0 | Dropout rate for attention. Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| connection_density | 0.2 | Connection density of the weights in dense layers. |\\n| | | Value should be between 0 and 1. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_sparse_input_dropout | True | If 'True' apply dropout to sparse input tensors. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_dense_input_dropout | True | If 'True' apply dropout to sparse features after they are |\\n| | | converted into dense features. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| evaluate_every_number_of_epochs | 20 | How often to calculate validation accuracy. |\\n| | | Set to '-1' to evaluate just once at the end of training. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| evaluate_on_number_of_examples | 0 | How many examples to use for hold out validation set. |\\n| | | Large values may hurt performance, e.g. model accuracy. |\\n| | | Keep at 0 if your data set contains a lot of unique examples |\\n| | | of dialogue turns. |\\n| | | Set to 0 for no validation. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| tensorboard_log_directory | None | If you want to use tensorboard to visualize training |\\n| | | metrics, set this option to a valid output directory. You |\\n| | | can view the training metrics after training in tensorboard |\\n| | | via 'tensorboard --logdir <path-to-given-directory>'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| tensorboard_log_level | \\\"epoch\\\" | Define when training metrics for tensorboard should be |\\n| | | logged. Either after every epoch ('epoch') or for every |\\n| | | training step ('batch'). |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| checkpoint_model | False | Save the best performing model during training. Models are |\\n| | | stored to the location specified by `--out`. Only the one |\\n| | | best model will be saved. |\\n| | | Requires `evaluate_on_number_of_examples > 0` and |\\n| | | `evaluate_every_number_of_epochs > 0` |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| e2e_confidence_threshold | 0.5 | The threshold that ensures that end-to-end is picked only if |\\n| | | the policy is confident enough. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| featurizers | [] | List of featurizer names (alias names). Only features |\\n| | | coming from the listed names are used. If list is empty |\\n| | | all available features are used. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| entity_recognition | True | If 'True' entity recognition is trained and entities are |\\n| | | extracted. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| constrain_similarities | False | If `True`, applies sigmoid on all similarity terms and adds |\\n| | | it to the loss function to ensure that similarity values are |\\n| | | approximately bounded. |\\n| | | Used only when `loss_type=cross_entropy`. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| model_confidence | \\\"softmax\\\" | Affects how model's confidence for each action |\\n| | | is computed. Currently, only one value is supported: |\\n| | | 1. `softmax` - Similarities between input and action |\\n| | | embeddings are post-processed with a softmax function, |\\n| | | as a result of which confidence for all labels sum up to 1. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| BILOU_flag | True | If 'True', additional BILOU tags are added to entity labels. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| split_entities_by_comma | True | Splits a list of extracted entities by comma to treat each |\\n| | | one of them as a single entity. Can either be `True`/`False` |\\n| | | globally, or set per entity type, such as: |\\n| | | ``` |\\n| | | - name: TEDPolicy |\\n| | | split_entities_by_comma: |\\n| | | address: True |\\n| | | ``` |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n```\\n\\n:::note\\nThe parameter `maximum_negative_similarity` is set to a negative value to mimic the original\\nstarspace algorithm in the case `maximum_negative_similarity = maximum_positive_similarity` and\\n`use_maximum_negative_similarity = False`. See [starspace paper](https://arxiv.org/abs/1709.03856)\\nfor details.\\n\\n:::\\n\\n</details>\\n\\n:::note\\nIn addition to the config parameters above, `TEDPolicy` prediction performance and\\ntraining time are affected by the `--augmentation` argument of the `rasa train`\\ncommand. For more information see\\n[Data Augmentation](./policies.mdx#data-augmentation).\\n\\n:::\", \"UnexpecTED Intent Policy\": {\"Prediction of `action_unlikely_intent`\": \"`UnexpecTEDIntentPolicy` is invoked immediately after a user utterance and can either\\ntrigger `action_unlikely_intent` or abstain (in which case other policies will predict actions).\\nTo determine if `action_unlikely_intent` should be triggered, `UnexpecTEDIntentPolicy` computes a score\\nfor the user's intent in the current dialogue context and checks if this score is below a\\ncertain threshold score.\\n\\nThis threshold score is computed by collecting the ML model's output on many \\\"negative examples\\\".\\nThese negative examples are combinations of dialogue contexts and user\\nintents that are _incorrect_. `UnexpecTEDIntentPolicy` generates these negative examples from your\\ntraining data by picking a random story part and pairing it with a random intent that doesn't\\noccur at this point. For example, if you had just one training story:\\n\\n```\\nversion: 2.0\\nstories:\\n- story: happy path 1\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: mood_great\\n - action: utter_goodbye\\n```\\n\\nand an intent `affirm`, then a valid negative example will be:\\n\\n```\\nversion: 2.0\\nstories:\\n- story: negative example with affirm unexpected\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: affirm\\n```\\n\\nHere, `affirm` intent is unexpected as it doesn't occur in this particular conversation context across all training stories.\\nFor each intent, `UnexpecTEDIntentPolicy` uses these negative examples to figure out the range of scores the model\\npredicts. The threshold score is picked from this range of scores in such a way that the predicted score for a\\ncertain percentage of negative examples is higher than the threshold score and hence `action_unlikely_intent`\\nis not triggered for them. This percentage of negative examples can be controlled by the `tolerance` parameter.\\nThe higher the `tolerance`, the lower the intent's score (the more unlikely the intent) needs to be\\nbefore `UnexpecTEDIntentPolicy` triggers the `action_unlikely_intent` action.\\n\\n**Configuration:**\\n\\nYou can pass configuration parameters to the `UnexpecTEDIntentPolicy` using the `config.yml` file.\\nIf you want to fine-tune model's performance, start by modifying the following parameters:\\n\\n[\\\"`epochs`:\\\\nThis parameter sets the number of times the algorithm will see the training data (default: `1`).\\\\nOne `epoch` is equals to one forward pass and one backward pass of all the training examples.\\\\nSometimes the model needs more epochs to learn properly.\\\\nSometimes more epochs don't influence the performance.\\\\nThe lower the number of epochs the faster the model is trained.\\\\nHere is how the config would look like:\\\", '```\\\\npolicies:\\\\n- name: UnexpecTEDIntentPolicy\\\\n epochs: 200\\\\n```', '`max_history`:\\\\nThis parameter controls how much dialogue history the model looks at before making an inference.\\\\nDefault `max_history` for this policy is `None`, which means that the complete dialogue history\\\\nsince session (re)start is taken into account. If you want to limit the model\\\\nto only see a certain number of previous\\\\ndialogue turns, you can set `max_history` to a finite value.\\\\nPlease note that you should pick `max_history` carefully, so that the model has enough\\\\nprevious dialogue turns to create a correct prediction.\\\\nDepending on your dataset, higher values of `max_history` can result in more frequent prediction of `action_unlikely_intent`\\\\nas the number of unique possible conversation paths increases as more dialogue context is taken\\\\ninto account. Similarly, lowering the value of `max_history` can result in `action_unlikely_intent` being\\\\ntriggered less often but can also be a stronger indicator that the corresponding conversation path\\\\nis highly unique and hence unexpected.\\\\nWe recommend you to set the `max_history` of `UnexpecTEDIntentPolicy` equal to that of `TEDPolicy`.\\\\nHere is how the config would look like:', '```\\\\npolicies:\\\\n- name: UnexpecTEDIntentPolicy\\\\n max_history: 8\\\\n```', '`ignore_intents_list`:\\\\nThis parameter lets you configure `UnexpecTEDIntentPolicy` to not predict `action_unlikely_intent` for\\\\na subset of intents. You might want to do this if you come across a certain list of intents for which there\\\\nare too many false warnings generated.', '`tolerance`:\\\\nThe `tolerance` parameter is a number that ranges from `0.0` to `1.0` (inclusive).\\\\nIt helps to adjust the threshold score used during\\\\n[prediction of `action_unlikely_intent`](./policies.mdx#prediction-of-action_unlikely_intent)\\\\nat inference time.', 'Here, `0.0` means that the threshold score will be adjusted in such a way that `0%` of negative\\\\nexamples encountered during training are predicted with a score lower than the threshold score.\\\\nHence, conversation contexts from all negative examples will trigger an `action_unlikely_intent` action.', 'A tolerance of `0.1` means that the threshold score will be adjusted in a way such that 10% of negative\\\\nexamples encountered during training are predicted with a score lower than the threshold score.', 'A tolerance of `1.0` means that the threshold score is so low that `UnexpecTEDIntentPolicy` would not\\\\ntrigger `action_unlikely_intent` for any of the negative examples that it has encountered\\\\nduring training.', '`use_gpu`:\\\\nThis parameter defines whether a GPU (if available) will be used training. By default, `UnexpecTEDIntentPolicy` will be trained on GPU \\\\nif a GPU is available (i.e. `use_gpu` is `True`). To enforce that `UnexpecTEDIntentPolicy` uses only the CPU for training, set `use_gpu` to `False`.']\\n\\nThe above configuration parameters are the ones you should try tweaking according to your use case and training data.\\nHowever, additional parameters exist that you could adapt.\\n\\n<details><summary>More configurable parameters</summary>\\n\\n```\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| Parameter | Default Value | Description |\\n+=======================================+========================+==============================================================+\\n| hidden_layers_sizes | text: [] | Hidden layer sizes for layers before the embedding layers |\\n| | | for user messages and bot messages in previous actions |\\n| | | and labels. The number of hidden layers is |\\n| | | equal to the length of the corresponding list. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| dense_dimension | text: 128 | Dense dimension for sparse features to use after they are |\\n| | intent: 20 | converted into dense features. |\\n| | action_name: 20 | |\\n| | label_intent: 20 | |\\n| | entities: 20 | |\\n| | slots: 20 | |\\n| | active_loop: 20 | |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| concat_dimension | text: 128 | Common dimension to which sequence and sentence features of |\\n| | | different dimensions get converted before concatenation. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| encoding_dimension | 50 | Dimension size of embedding vectors |\\n| | | before the dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| transformer_size | text: 128 | Number of units in user text sequence transformer encoder. |\\n| | dialogue: 128 | Number of units in dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_transformer_layers | text: 1 | Number of layers in user text sequence transformer encoder. |\\n| | dialogue: 1 | Number of layers in dialogue transformer encoder. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_attention_heads | 4 | Number of self-attention heads in transformers. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| unidirectional_encoder | True | Use a unidirectional or bidirectional encoder |\\n| | | for `text`, `action_text`, and `label_action_text`. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_key_relative_attention | False | If 'True' use key relative embeddings in attention. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_value_relative_attention | False | If 'True' use value relative embeddings in attention. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| max_relative_position | None | Maximum position for relative embeddings. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| batch_size | [64, 256] | Initial and final value for batch sizes. |\\n| | | Batch size will be linearly increased for each epoch. |\\n| | | If constant `batch_size` is required, pass an int, e.g. `8`. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| batch_strategy | \\\"balanced\\\" | Strategy used when creating batches. |\\n| | | Can be either 'sequence' or 'balanced'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| epochs | 1 | Number of epochs to train. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| random_seed | None | Set random seed to any 'int' to get reproducible results. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| learning_rate | 0.001 | Initial learning rate for the optimizer. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| embedding_dimension | 20 | Dimension size of dialogue & system action embedding vectors.|\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| number_of_negative_examples | 20 | The number of incorrect labels. The algorithm will minimize |\\n| | | their similarity to the user input during training. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| ranking_length | 10 | Number of top actions to normalize scores for. Applicable |\\n| | | only with loss type 'cross_entropy' and 'softmax' |\\n| | | confidences. Set to 0 to disable normalization. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| scale_loss | True | Scale loss inverse proportionally to confidence of correct |\\n| | | prediction. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| regularization_constant | 0.001 | The scale of regularization. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_dialogue | 0.1 | Dropout rate for embedding layers of dialogue features. |\\n| | | Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_label | 0.0 | Dropout rate for embedding layers of label features. |\\n| | | Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| drop_rate_attention | 0.0 | Dropout rate for attention. Value should be between 0 and 1. |\\n| | | The higher the value the higher the regularization effect. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_sparse_input_dropout | True | If 'True' apply dropout to sparse input tensors. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| use_dense_input_dropout | True | If 'True' apply dropout to sparse features after they are |\\n| | | converted into dense features. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| evaluate_every_number_of_epochs | 20 | How often to calculate validation accuracy. |\\n| | | Set to '-1' to evaluate just once at the end of training. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| evaluate_on_number_of_examples | 0 | How many examples to use for hold out validation set. |\\n| | | Large values may hurt performance, e.g. model accuracy. |\\n| | | Keep at 0 if your data set contains a lot of unique examples |\\n| | | of dialogue turns. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| tensorboard_log_directory | None | If you want to use tensorboard to visualize training |\\n| | | metrics, set this option to a valid output directory. You |\\n| | | can view the training metrics after training in tensorboard |\\n| | | via 'tensorboard --logdir <path-to-given-directory>'. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| tensorboard_log_level | \\\"epoch\\\" | Define when training metrics for tensorboard should be |\\n| | | logged. Either after every epoch ('epoch') or for every |\\n| | | training step ('batch'). |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| checkpoint_model | False | Save the best performing model during training. Models are |\\n| | | stored to the location specified by `--out`. Only the one |\\n| | | best model will be saved. |\\n| | | Requires `evaluate_on_number_of_examples > 0` and |\\n| | | `evaluate_every_number_of_epochs > 0` |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| featurizers | [] | List of featurizer names (alias names). Only features |\\n| | | coming from the listed names are used. If list is empty |\\n| | | all available features are used. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| ignore_intents_list | [] | This parameter lets you configure `UnexpecTEDIntentPolicy` to ignore|\\n| | | the prediction of `action_unlikely_intent` for a subset of |\\n| | | intents. You might want to do this if you come across a |\\n| | | certain list of intents for which there are too many false |\\n| | | warnings generated. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n| tolerance | 0.0 | The `tolerance` parameter is a number that ranges from `0.0` |\\n| | | to `1.0` (inclusive). It helps to adjust the threshold score |\\n| | | used during prediction of `action_unlikely_intent` at |\\n| | | inference time. Here, `0.0` means that the score threshold |\\n| | | is the one that `UnexpecTEDIntentPolicy` had determined at training |\\n| | | time. A tolerance of `1.0` means that the threshold score |\\n| | | is so low that `IntentTED` would not trigger |\\n| | | `action_unlikely_intent` for any of the \\\"negative examples\\\" |\\n| | | that it has encountered during training. These negative |\\n| | | examples are combinations of dialogue contexts and user |\\n| | | intents that are _incorrect_. `UnexpecTEDIntentPolicy` generates |\\n| | | these negative examples from your training data by picking a |\\n| | | random story part and pairing it with a random intent that |\\n| | | doesn't occur at this point. |\\n+---------------------------------------+------------------------+--------------------------------------------------------------+\\n```\\n\\n</details>\", \"Tuning the tolerance parameter\": \"When [reviewing real conversations](./conversation-driven-development.mdx#review), we encourage you\\nto tune the `tolerance` parameter in `UnexpecTEDIntentPolicy`'s configuration to reduce the number\\nof false warnings (intents that actually are likely given the conversation context).\\nAs you increase the value of `tolerance` from `0` to `1` in steps of `0.05`,\\nthe number of false warnings should decrease. However, increasing the `tolerance` will\\nalso result in fewer triggers of `action_unlikely_intent` and hence more conversation\\npaths not present in training stories will be missing in the set of flagged conversations.\\nIf you change the `max_history` value and retrain a model, you might have to re-adjust the `tolerance` value as well.\\n\\n:::note\\n`UnexpecTEDIntentPolicy` is only trained on [stories](./stories.mdx) and not [rules](./rules.mdx) from the training data.\\n\\n:::\"}, \"Memoization Policy\": \"The `MemoizationPolicy` remembers the stories from your\\ntraining data. It checks if the current conversation matches the stories in your\\n`stories.yml` file. If so, it will predict the next action from the matching\\nstories of your training data with a confidence of `1.0`. If no matching conversation\\nis found, the policy predicts `None` with confidence `0.0`.\\n\\nWhen looking for a match in your training data, the policy will take the last\\n`max_history` number of turns of the conversation into account.\\nOne \\u201cturn\\u201d includes the message sent by the user and any actions the\\nassistant performed before waiting for the next message.\\n\\nYou can configure the number of turns the `MemoizationPolicy` should use in your\\nconfiguration:\\n\\n```\\npolicies:\\n - name: \\\"MemoizationPolicy\\\"\\n max_history: 3\\n```\", \"Augmented Memoization Policy\": \"The `AugmentedMemoizationPolicy` remembers examples from training\\nstories for up to `max_history` turns, just like the `MemoizationPolicy`.\\nAdditionally, it has a forgetting mechanism that will forget a certain amount\\nof steps in the conversation history and try to find a match in your stories\\nwith the reduced history. It predicts the next action with confidence `1.0`\\nif a match is found, otherwise it predicts `None` with confidence `0.0`.\\n\\n:::note Slots and predictions\\nIf you have dialogues where some slots that are set during\\nprediction time might not be set in training stories (e.g. in training\\nstories starting with a [reminder](./reaching-out-to-user.mdx#reminders), not all previous slots are set),\\nmake sure to add the relevant stories without slots to your training\\ndata as well.\\n\\n:::\"}, \"Rule-based Policies\": {\"Rule Policy\": \"The `RulePolicy` is a policy that handles conversation parts that follow\\na fixed behavior (e.g. business logic). It makes predictions based on\\nany `rules` you have in your training data. See the\\n[Rules documentation](./rules.mdx) for further information on how to define rules.\\n\\nThe `RulePolicy` has the following configuration options:\\n\\n```\\npolicies:\\n - name: \\\"RulePolicy\\\"\\n core_fallback_threshold: 0.3\\n core_fallback_action_name: action_default_fallback\\n enable_fallback_prediction: true\\n restrict_rules: true\\n check_for_contradictions: true\\n```\\n\\n['`core_fallback_threshold` (default: `0.3`): Please see the\\\\n[fallback documentation](fallback-handoff.mdx#handling-low-action-confidence) for\\\\nfurther information.', '`core_fallback_action_name` (default: `action_default_fallback`): Please see the\\\\n[fallback documentation](fallback-handoff.mdx#handling-low-action-confidence) for\\\\nfurther information.', '`enable_fallback_prediction` (default: `true`): Please see the\\\\n[fallback documentation](fallback-handoff.mdx#handling-low-action-confidence) for\\\\nfurther information.', '`check_for_contradictions` (default: `true`):\\\\nBefore training, the RulePolicy will perform a check to make sure that\\\\nslots and active loops set by actions are defined consistently for all rules.\\\\nThe following snippet contains an example of an incomplete rule:', '```\\\\nrules:\\\\n- rule: complete rule\\\\n steps:\\\\n - intent: search_venues\\\\n - action: action_search_venues\\\\n - slot_was_set:\\\\n - venues: [{\\\"name\\\": \\\"Big Arena\\\", \\\"reviews\\\": 4.5}]\\\\n\\\\n- rule: incomplete rule\\\\n steps:\\\\n - intent: search_venues\\\\n - action: action_search_venues\\\\n```', 'In the second `incomplete rule`, `action_search_venues` should set\\\\nthe `venues` slot because it is set in `complete rule`, but this event is missing.\\\\nThere are several possible ways to fix this rule.', \\\"In the case when `action_search_venues` can't find\\\\na venue and the `venues` slot should not be set,\\\\nyou should explicitly set the value of the slot to `null`.\\\\nIn the following story `RulePolicy` will predict `utter_venues_not_found`\\\\nonly if the slot `venues` is not set:\\\", '```\\\\nrules:\\\\n- rule: fixes incomplete rule\\\\n steps:\\\\n - intent: search_venues\\\\n - action: action_search_venues\\\\n - slot_was_set:\\\\n - venues: null\\\\n - action: utter_venues_not_found\\\\n```', 'If you want the slot setting to be handled by a different rule or story,\\\\nyou should add `wait_for_user_input: false` to the end of the rule snippet:', '```\\\\nrules:\\\\n- rule: incomplete rule\\\\n steps:\\\\n - intent: search_venues\\\\n - action: action_search_venues\\\\n wait_for_user_input: false\\\\n```', 'After training, the RulePolicy will check that none of the rules or stories contradict\\\\neach other. The following snippet is an example of two contradicting rules:', '```\\\\nrules:\\\\n- rule: Chitchat\\\\n steps:\\\\n - intent: chitchat\\\\n - action: utter_chitchat\\\\n\\\\n- rule: Greet instead of chitchat\\\\n steps:\\\\n - intent: chitchat\\\\n - action: utter_greet # `utter_greet` contradicts `utter_chitchat` from the rule above\\\\n```', '`restrict_rules` (default: `true`): Rules are restricted to one user turn, but\\\\nthere can be multiple bot events, including e.g. a form being filled and its subsequent submission.\\\\nChanging this parameter to `false` may result in unexpected behavior.']\\n\\n:::caution Overusing rules\\nOverusing rules for purposes outside of the [recommended use cases](rules.mdx)\\nwill make it very hard to maintain your assistant as the complexity grows.\\n\\n:::\"}, \"Configuring Policies\": {\"Max History\": \"One important hyperparameter for Rasa policies is the `max_history`.\\nThis controls how much dialogue history the model looks at to decide which\\naction to take next.\\n\\nYou can set the `max_history` by passing it to your policy\\nin the policy configuration in your `config.yml`.\\nThe default value is `None`, which means that the complete dialogue history since session\\nrestart is taken in the account.\\n\\n```\\npolicies:\\n - name: TEDPolicy\\n max_history: 5\\n epochs: 200\\n batch_size: 50\\n max_training_samples: 300\\n```\\n\\n:::note\\n`RulePolicy` doesn't have max history parameter, it always consider the full length\\nof provided rules. Please see [Rules](./rules.mdx) for further information.\\n:::\\n\\nAs an example, let's say you have an `out_of_scope` intent which\\ndescribes off-topic user messages. If your bot sees this intent multiple\\ntimes in a row, you might want to tell the user what you can help them\\nwith. So your story might look like this:\\n\\n```\\nstories:\\n - story: utter help after 2 fallbacks\\n steps:\\n - intent: out_of_scope\\n - action: utter_default\\n - intent: out_of_scope\\n - action: utter_default\\n - intent: out_of_scope\\n - action: utter_help_message\\n```\\n\\nFor your model to learn this pattern, the `max_history`\\nhas to be at least 4.\\n\\nIf you increase your `max_history`, your model will become bigger and\\ntraining will take longer. If you have some information that should\\naffect the dialogue very far into the future, you should store it as a\\nslot. Slot information is always available for every featurizer.\", \"Data Augmentation\": \"When you train a model, Rasa will create\\nlonger stories by randomly combining\\nthe ones in your stories files.\\nTake the stories below as an example:\\n\\n```\\nstories:\\n - story: thank\\n steps:\\n - intent: thankyou\\n - action: utter_youarewelcome\\n - story: say goodbye\\n steps:\\n - intent: goodbye\\n - action: utter_goodbye\\n```\\n\\nYou actually want to teach your policy to **ignore** the dialogue history\\nwhen it isn't relevant and to respond with the same action no matter\\nwhat happened before. To achieve this, individual stories are\\nconcatenated into longer stories. From the example above, data augmentation\\nmight produce a story by combining `thank` with `say goodbye` and then `thank` again,\\nequivalent to:\\n\\n```\\nstories:\\n - story: thank -> say goodbye -> thank\\n steps:\\n - intent: thankyou\\n - action: utter_youarewelcome\\n - intent: goodbye\\n - action: utter_goodbye\\n - intent: thankyou\\n - action: utter_youarewelcome\\n```\\n\\nYou can alter this behavior with the `--augmentation` flag,\\nwhich allows you to set the `augmentation_factor`.\\nThe `augmentation_factor` determines how many augmented stories are\\nsubsampled during training. The augmented stories are subsampled before training\\nsince their number can quickly become very large, and you want to limit it.\\nThe number of sampled stories is `augmentation_factor` x10.\\nBy default `augmentation_factor` is set to 50, resulting in a maximum of 500 augmented stories.\\n\\n`--augmentation 0` disables all augmentation behavior. `TEDPolicy` is the **only** policy\\naffected by augmentation. Other policies like `MemoizationPolicy` or `RulePolicy`\\nautomatically ignore all augmented stories (regardless of the `augmentation_factor`).\\n\\n`--augmentation` is an important parameter when trying to reduce `TEDPolicy` training\\ntime. Reducing the `augmentation_factor` decreases the size of the training data\\nand subsequently the time to train the policy. However, reducing the amount of data\\naugmentation can also reduce the performance of `TEDPolicy`. We recommend using\\na memoization based policy along with `TEDPolicy` when reducing the amount of data\\naugmentation to compensate.\", \"Featurizers\": {\"State Featurizers\": \"Every event in a trackers history creates a new state (e.g. running a bot\\naction, receiving a user message, setting slots). Featurizing a single state\\nof the tracker has two steps:\\n\\n['**Tracker provides a bag of active features**:', [\\\"features indicating intents and entities, if this is the first\\\\nstate in a turn, e.g. it's the first action we will take after\\\\nparsing the user's message. (e.g.\\\\n`[intent_restaurant_search, entity_cuisine]` )\\\", \\\"features indicating which slots are currently defined, e.g.\\\\n`slot_location` if the user previously mentioned the area\\\\nthey're searching for restaurants.\\\", 'features indicating the results of any API calls stored in\\\\nslots, e.g. `slot_matches`', 'features indicating what the last bot action or bot utterance was (e.g.\\\\n`prev_action_listen`)', 'features indicating if any loop is active and which one'], '**Convert all the features into numeric vectors**:', '`SingleStateFeaturizer` uses the Rasa NLU pipeline to convert the intent and\\\\nbot action names or bot utterances into numeric vectors.\\\\nSee the [NLU Model Configuration](./model-configuration.mdx) documentation\\\\nfor the details on how to configure Rasa NLU pipeline.', 'Entities, slots and active loops are featurized as one-hot encodings\\\\nto indicate their presence.']\\n\\n:::note\\nIf the domain defines the possible `actions`,\\n`[ActionGreet, ActionGoodbye]`,\\n4 additional default actions are added:\\n`[ActionListen(), ActionRestart(),\\nActionDefaultFallback(), ActionDeactivateForm()]`.\\nTherefore, label `0` indicates default action listen, label `1`\\ndefault restart, label `2` a greeting and `3` indicates goodbye.\\n\\n:::\", \"Tracker Featurizers\": {\"1. Full Dialogue\": \"`FullDialogueTrackerFeaturizer` creates a numerical representation of\\nstories to feed to a recurrent neural network where the whole dialogue\\nis fed to a network and the gradient is backpropagated from all time steps.\\nThe target label is the most appropriate bot action or bot utterance which should be triggered in the\\ncontext of the conversation.\\nThe `TrackerFeaturizer` iterates over tracker\\nstates and calls a `SingleStateFeaturizer` for each state to create numeric input features for a policy.\", \"2. Max History\": \"`MaxHistoryTrackerFeaturizer` operates very similarly to `FullDialogueTrackerFeaturizer` as\\nit creates an array of previous tracker states for each bot action or bot utterance but with the parameter\\n`max_history` defining how many states go into each row of input features.\\nIf `max_history` is not specified, the algorithm takes\\nthe whole length of a dialogue into account.\\nDeduplication is performed to filter out duplicated turns (bot actions\\nor bot utterances) in terms of their previous states.\\n\\nFor some algorithms a flat feature vector is needed, so input features\\nshould be reshaped to `(num_unique_turns, max_history * num_input_features)`.\", \"3. Intent Max History\": \"`IntentMaxHistoryTrackerFeaturizer` inherits from `MaxHistoryTrackerFeaturizer`. Since, it is used by\\n[`UnexpecTEDIntentPolicy`](#unexpected-intent-policy), the target labels that it creates are the intents that can be\\nexpressed by a user in the context of a conversation tracker. Unlike\\nother tracker featurizers, there can be multiple target labels. Hence, it pads the\\nlist of target labels with a constant value (`-1`) on the right to return an equally sized list of target labels\\nfor each input conversation tracker.\\n\\nJust like `MaxHistoryTrackerFeaturizer`, it also performs deduplication to\\nfilter out duplicated turns. However, it yields one featurized tracker per correct intent\\nfor the corresponding tracker. For example, if the correct labels for an input conversation tracker have the following\\nindices - `[0, 2, 4]`, then the featurizer will yield three pairs of featurized trackers and target labels.\\nThe featurized trackers will be identical to each other but the target labels in each pair will be\\n`[0, 2, 4]`, `[4, 0, 2]`, `[2, 4, 0]`.\"}}}, \"Custom Policies\": \":::info New in 3.0\\nRasa 3.0 unified the implementation of NLU components and policies.\\nThis requires changes to custom policies written for earlier versions of Rasa Open\\nSource. Please see the\\n[migration guide](migration-guide.mdx#custom-policies-and-custom-components) for a\\nstep-by-step guide for the migration.\\n\\n:::\\n\\nYou can also write custom policies and reference them in your configuration. In the example below, the\\nlast two lines show how to use a custom policy class and pass arguments to it.\\nSee the [guide on custom graph components](custom-graph-components.mdx) for a complete guide on custom policies.\\n\\n```\\npolicies:\\n - name: \\\"TEDPolicy\\\"\\n max_history: 5\\n epochs: 200\\n - name: \\\"RulePolicy\\\"\\n - name: \\\"path.to.your.policy.class\\\"\\n arg1: \\\"...\\\"\\n```\"}, \"metadata\": {\"id\": \"policies\", \"sidebar_label\": \"Policies\", \"title\": \"Policies\", \"abstract\": \"Your assistant uses policies to decide which action to take at each step in a conversation. There are machine-learning and rule-based policies that your assistant can use in tandem.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 36]\"}, {\"title\": \"Rasa Pro Change Log\", \"description\": null, \"content\": {\"Rasa Pro 3.6\": {\"Rasa Plus 3.6\": {\"Features\": [\"Implemented PII (Personally Identifiable Information) management using Microsoft Presidio as the entity analyzer and\\nanonymization engine.\\nThe feature covers the following:\", [\"anonymization of Rasa events (`UserUttered`, `BotUttered`, `SlotSet`, `EntitiesAdded`) before they are streamed to\\nKafka event broker anonymization topics specified in `endpoints.yml`.\", \"anonymization of Rasa logs that expose PII data\"], \"The main components of the feature are:\", [\"anonymization rules that define in `endpoints.yml` the PII entities to be anonymized and the anonymization method to be used\", \"anonymization executor that executes the anonymization rules on a given text\", \"anonymization orchestrator that orchestrates the execution of the anonymization rules and publishes\\nthe anonymized event to the matched Kafka topic.\", \"anonymization pipeline that contains a list of orchestrators and is registered to a singleton provider component,\\nwhich gets invoked in hook calls in Rasa Open Source when the pipeline must be retrieved for anonymizing events and logs.\"], \"Please read through the [PII Management](./pii-management.mdx) section in the official documentation to learn how to get started.\", \"Implemented support for real time evaluation of [Markers](./monitoring/analytics/realtime-markers.mdx) with the Analytics\\nData Pipeline. For this feature, we've added support for `rasa markers upload` command. Running this command validates the marker configuration file against the domain file and uploads the configuration to Analytics Data Pipeline.\"]}, \"Improvements\": [\"Add `rasa marker upload` command to upload markers to the Rasa Pro Services.\", \"Enhance the validation of the `anonymization` key in `endpoints.yaml` by introducing checks for required fields and duplicate IDs.\"], \"Bugfixes\": {\"Deprecations and Removal\": [\"Removed Python 3.7 support as [it reaches its end of life in June 2023](https://devguide.python.org/versions/)\"]}, \"Rasa Pro Services 3.1\": {\"Features\": [\"You can now process [Markers](./monitoring/analytics/realtime-markers.mdx) with the Analytics Data Pipeline in real-time, enabling you to gain valuable insights and improve the performance of your Rasa Assistant.\"]}}, \"Rasa Pro 3.5\": {\"Rasa Plus 3.5\": {\"Features\": [\"[End-to-end testing](./testing-your-assistant.mdx#end-to-end-testing) is an enhanced and comprehensive CLI-based testing tool that allows you to test conversation scenarios with different pre-configured contexts, execute custom actions, verify response texts or names, and assert when slots are filled. It is available using the new `rasa test e2e` command.\", \"You can now store your assistant's secrets in an [external credentials manager](./secrets-managers.mdx). In this release, Rasa Pro currently supports credentials manager for the Tracker Store with HashiCorp Vault.\"]}, \"Rasa Pro Services 3.0\": \"*No significant change from last minor version.*\"}, \"Rasa Pro 3.4\": {\"Rasa Plus 3.4\": {\"Features\": [\"Added a new [IVR channel connector](./connectors/audioodes-voiceai-connect.mdx) to connect your assistant to AudioCodes VoiceAI Connect.\"], \"Improvements\": [\"Rasa Pro now supports Python 3.10.\"]}, \"Rasa Pro Services 3.0\": \"*No significant change from last minor version.*\"}, \"Rasa Pro 3.3\": {\"Rasa Plus 3.3\": {\"Features\": [\"[Tracing capabilities](./monitoring/tracing.mdx) for your Rasa Pro assistant. Distributed tracing tracks requests as they flow through a distributed system (in this case: a Rasa assistant), sending data about the requests to a tracing backend which collects all trace data and enables inspecting it. With this version of the Tracing feature, Rasa Pro supports OpenTelemetry.\", \"[Concurrent Lock Store](./lock-stores.mdx#concurrentredislockstore) is a new lock store that uses Redis as a persistence layer and is safe for use with multiple Rasa server replicas.\"]}, \"Rasa Pro Services 3.0\": {\"Features\": [\"[Analytics Data Pipeline](./monitoring/analytics/getting-started-with-analytics.mdx) helps visualize and process Rasa assistant metrics in the tooling (BI tools, data warehouses) of your choice. Visualizations and analysis of the production assistant and its conversations allow you to assess ROI and improve the performance of the assistant over time.\"]}}}, \"metadata\": {\"id\": \"rasa-pro-changelog\", \"sidebar_label\": \"Rasa Pro Change Log\", \"title\": \"Rasa Pro Change Log\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 37]\"}, {\"title\": \"Rasa Pro\", \"description\": null, \"content\": {\"Rasa Pro Features\": {\"Analytics with Conversational Data Pipeline\": \"Visualise Rasa metrics in a third-party tool to measure the performance of your assistant.\\n\\n[Read more here](./monitoring/analytics/getting-started-with-analytics.mdx).\", \"Concurrent Lock Store\": \"Scale deployment and reliably handle high volumes of traffic across multiple Rasa instances with the confidence that no messages will be dropped.\\n\\n[Read more here](./lock-stores.mdx#concurrentredislockstore).\", \"End-to-End Testing\": \"Test your assistant with our end-to-end testing solution designed to meet enterprise-grade integration and acceptance testing criteria.\\n\\n[Read more here](./testing-your-assistant.mdx#end-to-end-testing).\", \"IVR Voice Connector\": \"Integrate with best-in-class IVR systems through our OOTB voice connectors.\\n\\n[Read more here](./connectors/audioodes-voiceai-connect.mdx).\", \"Observability (Tracing)\": \"Resolve performance issues faster and identify bottlenecks in message handling and model training.\\n\\n[Read more here](./monitoring/tracing.mdx).\", \"PII Handling\": \"Anonymize PII (Personal Identifiable Information) in logs and events streamed via the Kafka event broker. \\n\\n[Read more here](./pii-management.mdx)\", \"Real-Time Markers\": \"Mark points of interest in conversations to support the targeted analysis of user journeys real time.\\n\\n[Read more here](./monitoring/analytics/realtime-markers.mdx)\", \"Secrets Management\": \"Enhance security with our seamless Vault integration, enabling dynamic credential rotation for Rasa databases without system disruptions.\\n\\n[Read more here](./secrets-managers.mdx).\", \"Security Scanning for Vulnerability Protection\": \"Nightly and proactive security patches on your docker image to make sure dependencies are always up to date.\", \"Spaces (Alpha Release)\": \"Modularize your assistant for better scaling and team collaboration.\\n\\n[Read more here](./spaces.mdx)\"}}, \"metadata\": {\"id\": \"rasa-pro\", \"sidebar_label\": \"Rasa Pro\", \"title\": \"Rasa Pro\", \"hide_table_of_contents\": true}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 38]\"}, {\"title\": \"Reaching Out to the User\", \"description\": null, \"content\": {\"Reaching out first\": {\"1. Update the configuration\": \"Since you are using a rule for this behavior, you need to add the [RulePolicy](./policies.mdx#rule-policy)\\nto your configuration file:\\n\\n```\\npolicies:\\n # other policies\\n - name: RulePolicy\\n```\", \"2. Add a rule\": \"To have the assistant respond to the intent `greet` with a welcome message\\nonly at the beginning of a conversation, add the following rule:\\n\\n```\\nrules:\\n - rule: welcome user\\n conversation_start: true # this rule only applies at the beginning of a conversation\\n steps:\\n - intent: greet\\n - action: utter_welcome\\n```\", \"3. Add a response\": \"Finally, add a response for the `utter_welcome` utter action to your domain:\\n\\n```\\nresponses:\\n utter_welcome:\\n - text: Hi there! What can I help you with today?\\n```\"}, \"External Events\": {\"1. Trigger an Intent\": \"To have an event from an external device change the course of an ongoing conversation, you can\\nhave the device post to the\\n[`trigger_intent` endpoint](/pages/http-api#operation/triggerConversationIntent) of your conversation.\\nThe `trigger_intent` endpoint injects a user intent (possibly with entities) into your conversation.\\nFor Rasa, it is as if you entered a message that got classified with that specific intent and entities.\\nThe assistant will then predict and execute the next action as usual.\\n\\nFor example, the following post request would inject the intent `EXTERNAL_dry_plant` and the `plant` entity\\ninto the conversation with id `user123`:\\n\\n```\\ncurl -H \\\"Content-Type: application/json\\\" -X POST \\\\\\n -d '{\\\"name\\\": \\\"EXTERNAL_dry_plant\\\", \\\"entities\\\": {\\\"plant\\\": \\\"Orchid\\\"}}' \\\\\\n \\\"http://localhost:5005/conversations/user123/trigger_intent?output_channel=latest\\\"\\n```\", \"2. Get the Conversation ID\": \"In a real-life scenario, your external device would get the conversation ID from an API or a database.\\nIn the dry plant example, you might have a database of plants, the users that water them, and the users'\\nconversation IDs. Your Raspberry Pi would get the conversation ID directly from the database.\\nTo try out the reminderbot example locally, you'll need to get the conversation ID manually. See\\nthe reminderbot [README](https://github.com/RasaHQ/rasa/blob/main/examples/reminderbot) for more information.\", \"3. Add NLU Training Data\": \"In the dry plant example, your Raspberry Pi needs to send a message with the intent\\n`EXTERNAL_dry_plant` to the `trigger_intent` endpoint. This intent will be reserved for use by the Raspberry Pi, so\\nthere won't be any NLU training examples for it.\\n\\n```\\nintents:\\n - EXTERNAL_dry_plant\\n```\\n\\n:::note\\nYou should name intents that come from other devices with the `EXTERNAL_` prefix because it makes it\\neasier to see which intents are expected to come from external devices when working with your training data.\\n:::\", \"4. Update the Domain\": {\"5. Add a Rule\": \"You'll need a rule that tells your assistant how to respond when it receives a message from the Raspberry Pi.\\n\\n```\\nrules:\\n - rule: warn about dry plant\\n steps:\\n - intent: EXTERNAL_dry_plant\\n - action: utter_warn_dry\\n```\", \"6. Add a Response\": \"You'll need to define the response text for `utter_warn_dry`:\\n\\n```\\nresponses:\\n utter_warn_dry:\\n - text: \\\"Your {plant} needs some water!\\\"\\n```\\n\\nThe response will use the value from the slot `plant` to warn about the specific plant that needs watering.\"}, \"Try it out\": \"To try out the dry plant notification example, you'll need to start a [CallbackChannel](./connectors/your-own-website.mdx#callbackinput).\\n\\n:::caution\\nExternal Events and Reminders don't work in request-response channels like the `rest` channel or `rasa shell`.\\nCustom connectors for assistants implementing reminders or external events should be built\\noff of the [CallbackInput channel](./connectors/your-own-website.mdx#callbackinput) instead of the RestInput channel.\\n\\nSee the [reminderbot README](https://github.com/RasaHQ/rasa/blob/main/examples/reminderbot/README.md)\\nfor instructions on how to test your reminders locally.\\n:::\\n\\nRun this POST request to simulate the external event, using your conversation ID:\\n\\n```\\ncurl -H \\\"Content-Type: application/json\\\" -X POST -d \\\\\\n'{\\\"name\\\": \\\"EXTERNAL_dry_plant\\\", \\\"entities\\\": {\\\"plant\\\": \\\"Orchid\\\"}}' \\\\\\n\\\"http://localhost:5005/conversations/user1234/trigger_intent?output_channel=latest\\\"\\n```\\n\\nYou should see the bot respond in your channel:\\n\\n<Chat caption=\\\"A reminder\\\">\\n<ChatBotText>Your Orchid needs some water!</ChatBotText>\\n</Chat>\"}, \"Reminders\": {\"Scheduling Reminders\": {\"1. Define a Reminder\": \"To schedule a reminder, you need to define a custom action that returns\\nthe `ReminderScheduled` event. For example, the following custom action\\nschedules a reminder for five minutes from now:\\n\\n```\\nimport datetime\\nfrom rasa_sdk.events import ReminderScheduled\\nfrom rasa_sdk import Action\\n\\nclass ActionSetReminder(Action):\\n \\\"\\\"\\\"Schedules a reminder, supplied with the last message's entities.\\\"\\\"\\\"\\n\\n def name(self) -> Text:\\n return \\\"action_set_reminder\\\"\\n\\n async def run(\\n self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> List[Dict[Text, Any]]:\\n\\n dispatcher.utter_message(\\\"I will remind you in 5 minutes.\\\")\\n\\n date = datetime.datetime.now() + datetime.timedelta(minutes=5)\\n entities = tracker.latest_message.get(\\\"entities\\\")\\n\\n reminder = ReminderScheduled(\\n \\\"EXTERNAL_reminder\\\",\\n trigger_date_time=date,\\n entities=entities,\\n name=\\\"my_reminder\\\",\\n kill_on_user_message=False,\\n )\\n\\n return [reminder]\\n```\\n\\nThe first argument for the `ReminderScheduled` event is the reminder's name, in this case, `EXTERNAL_reminder`.\\nThe reminder name will be used later as an intent to trigger a reaction to the reminder.\\nName the reminder name with the\\n`EXTERNAL_` prefix to make it easier to see what's going on in your training data.\\n\\nYou can see that the last messages' `entities` are also passed to the reminder.\\nThis allows the action that reacts to the reminder to make use of the entities\\nfrom the user's scheduling message.\\n\\nFor example, if you want your assistant to remind you to call a friend, you could\\nsend it a message like \\\"Remind me to call Paul\\\". If \\\"Paul\\\" is extracted as a `PERSON`\\nentity, the action reacting to the reminder can use it to say \\\"Remember to call Paul!\\\"\", \"2. Add a Rule\": \"To schedule a reminder, add a rule:\\n\\n```\\nrules:\\n- rule: Schedule a reminder\\n steps:\\n - intent: ask_remind_call\\n entities:\\n - PERSON\\n - action: action_set_reminder\\n```\", \"3. Add Training Data\": \"You should add NLU training examples for scheduling the reminder:\\n\\n```\\nnlu:\\n- intent: ask_remind_call\\n examples: |\\n - remind me to call John\\n - later I have to call Alan\\n - Please, remind me to call Vova\\n - please remind me to call Tanja\\n - I must not forget to call Juste\\n```\\n\\nYou should also add it to your domain:\\n\\n```\\nintents:\\n - ask_remind_call\\n```\", \"4. Update your Pipeline\": \"By adding SpacyNLP and SpacyEntityExtractor to your pipeline in config.yml, you won't need to annotate any of the\\nnames in your training data, since Spacy has a `PERSON` dimension:\\n\\n```\\npipeline:\\n# other components\\n- name: SpacyNLP\\n model: \\\"en_core_web_md\\\"\\n- name: SpacyEntityExtractor\\n dimensions: [\\\"PERSON\\\"]\\n```\"}, \"Reacting to Reminders\": {\"1. Define a Reaction\": \"The bot reaches out to the user after receiving a\\nPOST request to the `trigger_intent` endpoint. Reminders, however, send\\nthe request to the right conversation ID automatically after a certain amount of time using\\nthe name that you define in the `ReminderScheduled` event.\\n\\nTo define a reaction to the reminder, you only need to write a [rule](./rules.mdx) that\\ntells the bot what action to take when it receives the reminder intent.\\n\\nIn the call reminder example, you want to use the entities that come with the\\nreminder to be reminded to call specific people, so you need to write a custom\\naction that does that:\\n\\n```\\nclass ActionReactToReminder(Action):\\n \\\"\\\"\\\"Reminds the user to call someone.\\\"\\\"\\\"\\n\\n def name(self) -> Text:\\n return \\\"action_react_to_reminder\\\"\\n\\n async def run(\\n self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any],\\n ) -> List[Dict[Text, Any]]:\\n\\n name = next(tracker.get_slot(\\\"PERSON\\\"), \\\"someone\\\")\\n dispatcher.utter_message(f\\\"Remember to call {name}!\\\")\\n\\n return []\\n```\", \"2. Add a Rule\": \"To tell your bot what action to run when a reminder is triggered, add a rule.\\n\\n```\\nrules:\\n- rule: Trigger `action_react_to_reminder` for `EXTERNAL_reminder`\\n steps:\\n - intent: EXTERNAL_reminder\\n - action: action_react_to_reminder\\n```\", \"3. Add Training Data\": \"You'll need to define the intent that triggers reacting to the reminder. You don't need to add any training examples,\\nsince the intent is reserved for the reminder.\\n\\n```\\nintents:\\n- intent: EXTERNAL_reminder\\n```\"}, \"Cancelling Reminders\": {\"1. Define an Action that Cancels a Reminder\": \"To cancel a reminder that you've already scheduled, you need a custom action\\nthat returns the `ReminderCancelled()` event.\\n\\nReturning `ReminderCancelled()` cancels all the reminders that are currently scheduled.\\nIf you only want to cancel certain reminders, you can specify some parameters by which to narrow down the scheduled reminders:\\n\\n['`ReminderCancelled(intent=\\\"EXTERNAL_greet\\\")` cancels all reminders with intent `EXTERNAL_greet`', '`ReminderCancelled(entities={})` cancels all reminders with the given entities', '`ReminderCancelled(\\\"...\\\")` cancels the one unique reminder with the given name \\u201c`...`\\u201d that you supplied\\\\nduring its creation']\\n\\nFor the call reminder example, you can define a custom action `action_forget_reminders` that cancels\\nall reminders:\\n\\n```\\nclass ForgetReminders(Action):\\n \\\"\\\"\\\"Cancels all reminders.\\\"\\\"\\\"\\n\\n def name(self) -> Text:\\n return \\\"action_forget_reminders\\\"\\n\\n async def run(\\n self, dispatcher, tracker: Tracker, domain: Dict[Text, Any]\\n ) -> List[Dict[Text, Any]]:\\n\\n dispatcher.utter_message(f\\\"Okay, I'll cancel all your reminders.\\\")\\n\\n # Cancel all reminders\\n return [ReminderCancelled()]\\n```\\n\\n:::caution\\nAll reminders are cancelled whenever you shutdown your Rasa server.\\n:::\", \"2. Add a Rule\": \"You'll need to add a rule for cancelling a reminder.\\n\\n```\\nrules:\\n- rule: Cancel a reminder\\n steps:\\n - intent: ask_forget_reminders\\n - action: action_forget_reminders\\n```\", \"3. Add Training Data\": \"You'll need to define an intent that triggers cancelling the reminder.\\n\\n```\\nnlu:\\n- intent: ask_forget_reminders\\n examples: |\\n - Forget about the reminder\\n - do not remind me\\n - cancel the reminder\\n - cancel all reminders please\\n```\\n\\nYou should also add it to domain.yml:\\n\\n```\\nintents:\\n- intent: ask_forget_reminders\\n```\"}, \"Try it Out\": \"To try out reminders you'll need to start a [CallbackChannel](./connectors/your-own-website.mdx#callbackinput).\\nYou'll also need to start the action server to schedule, react to, and cancel your reminders.\\nSee the [reminderbot README](https://github.com/RasaHQ/rasa/blob/main/examples/reminderbot) for details.\\n\\nThen, if you send the bot a message like `Remind me to call Paul Pots`, you should get a reminder\\nback five minutes later that says `Remember to call Paul Pots!`.\"}}, \"metadata\": {\"id\": \"reaching-out-to-user\", \"sidebar_label\": \"Reaching Out to the User\", \"title\": \"Reaching Out to the User\", \"abstract\": \"Sometimes you want your assistant to reach out to the user without the user's prompting. For example, you might want the assistant to send a message when the user opens the chat window, or you might want to prompt the user if they haven't sent a message for a while. This page is a guide to enabling your assistant to reach out to the user proactively.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 39]\"}, {\"title\": \"Responses\", \"description\": null, \"content\": {\"Defining Responses\": {\"Using Variables in Responses\": \"You can use variables to insert information into responses.\\nWithin a response, a variable is enclosed in curly brackets. For example, see the variable `name` below:\\n\\n```\\nresponses:\\n utter_greet:\\n - text: \\\"Hey, {name}. How are you?\\\"\\n```\\n\\nWhen the `utter_greet` response is used, Rasa automatically fills in the variable with the \\nvalue found in the slot called `name`. If such a slot doesn't exist or is empty, the variable gets\\nfilled with `None`.\\n\\nAnother way to fill in a variable is within a [custom action](./custom-actions.mdx).\\nIn your custom action code, you can supply values to a response to fill in specific variables. \\nIf you're using the Rasa SDK for your action server,\\nyou can pass a value for the variable as a keyword argument to [`dispatcher.utter_message`](./action-server/sdk-dispatcher.mdx):\\n\\n```\\ndispatcher.utter_message(\\n template=\\\"utter_greet\\\",\\n name=\\\"Sara\\\"\\n)\\n```\\n\\nIf you use a [different custom action server](./action-server/index.mdx#other-action-servers),\\nsupply the values by adding extra parameters to the responses your server returns:\\n\\n```\\n{\\n \\\"events\\\":[\\n ...\\n ],\\n \\\"responses\\\":[\\n {\\n \\\"template\\\":\\\"utter_greet\\\",\\n \\\"name\\\":\\\"Sara\\\"\\n }\\n ]\\n}\\n```\", \"Response Variations\": {\"IDs for Responses\": \":::note New in Rasa 3.6\\nYou can now set an ID for any response.\\nThis is useful when you want to use the [NLG server](./nlg.mdx) to generate the response.\\n\\nType for ID is string.\\n\\n:::\\n\\nExample of response variations with ID:\\n\\n```\\nresponses:\\n utter_greet:\\n - id: \\\"greet_1\\\"\\n text: \\\"Hey, {name}. How are you?\\\"\\n - id: \\\"greet_2\\\"\\n text: \\\"Hey, {name}. How is your day going?\\\"\\n```\"}, \"Channel-Specific Response Variations\": \"To specify different response variations depending on which channel\\nthe user is connected to, use channel-specific response variations.\\n\\nIn the following example, the `channel` key makes the first response variation channel-specific for \\nthe `slack` channel while the second variation is not channel-specific:\\n\\n```\\nresponses:\\n utter_ask_game:\\n - text: \\\"Which game would you like to play on Slack?\\\"\\n channel: \\\"slack\\\"\\n - text: \\\"Which game would you like to play?\\\"\\n```\\n\\n:::note\\nMake sure the value of the `channel` key matches the value returned by the `name()` method of your \\ninput channel. If you are using a built-in channel, this value will also match the channel name used\\nin your `credentials.yml` file.\\n:::\\n\\nWhen your assistant looks for suitable response variations under a given response name, it will first \\ntry to choose from channel-specific variations for the current channel.\\nIf there are no such variations, the assistant will choose from any response variations which are not\\nchannel-specific.\\n\\nIn the above example, the second response variation has no `channel` specified and can be used by\\nyour assistant for all channels other than `slack`.\\n\\n:::caution\\nFor each response, try to have at least one response variation without the `channel` key.\\nThis allows your assistant to properly respond in all environments, such as in new channels, \\nin the shell and in interactive learning.\\n:::\", \"Conditional Response Variations\": \"Specific response variations can also be selected based on one or more slot values using a conditional\\nresponse variation. A conditional response variation is defined in the domain or responses YAML files\\nsimilarly to a standard response variation but with an additional `condition` key. This key specifies\\na list of slot `name` and `value` constraints.\\n\\nWhen a response is triggered during a dialogue, the constraints of each conditional response variation\\nare checked against the current dialogue state. If all constraint slot values are equal to the corresponding\\nslot values of the current dialogue state, the response variation is eligible to be used by your conversational\\nassistant.\\n\\n:::note\\nThe comparison of dialogue state slot values and constraint slot values is performed by the\\nequality \\\"==\\\" operator which requires the type of slot values to match too.\\nFor example, if the constraint is specified as `value: true`, then the slot needs to be filled\\nwith a boolean `true`, not the string `\\\"true\\\"`.\\n:::\\n\\nIn the following example, we will define one conditional response variation with one constraint,\\nthat the `logged_in` slot is set to `true`:\\n\\n```\\nslots:\\n logged_in:\\n type: bool\\n influence_conversation: False\\n mappings:\\n - type: custom\\n name:\\n type: text\\n influence_conversation: False\\n mappings:\\n - type: custom\\n\\nresponses:\\n utter_greet:\\n - condition:\\n - type: slot\\n name: logged_in\\n value: true\\n text: \\\"Hey, {name}. Nice to see you again! How are you?\\\"\\n\\n - text: \\\"Welcome. How is your day going?\\\"\\n```\\n\\n```\\nstories:\\n- story: greet\\n steps:\\n - action: action_log_in\\n - slot_was_set:\\n - logged_in: true\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nIn the example above, the first response variation (``\\\"Hey, {name}. Nice to see you again! How are you?\\\"``)\\nwill be used whenever the `utter_greet` action is executed and the `logged_in` slot is set to `true`.\\nThe second variation, which has no condition, will be treated as the default and used whenever\\n`logged_in` is not equal to `true`.\\n\\n:::caution\\nIt is highly recommended to always provide a default response variation without a condition\\nto guard against those cases when no conditional response matches filled slots.\\n:::\\n\\nDuring a dialogue, Rasa will choose from all conditional response variations whose constraints are satisfied.\\nIf there are multiple eligible conditional response variations, Rasa will pick one at random.\\nFor example, consider the following response:\\n\\n```\\nresponses:\\n utter_greet:\\n - condition:\\n - type: slot\\n name: logged_in\\n value: true\\n text: \\\"Hey, {name}. Nice to see you again! How are you?\\\"\\n\\n - condition:\\n - type: slot\\n name: eligible_for_upgrade\\n value: true\\n text: \\\"Welcome, {name}. Did you know you are eligible for a free upgrade?\\\"\\n\\n - text: \\\"Welcome. How is your day going?\\\"\\n```\\n\\nIf `logged_in` and `eligible_for_upgrade` are both set to `true` then both the first and second response\\nvariations are eligible to be used, and will be chosen by the conversational assistant with equal probability.\\n\\nYou can continue using channel-specific response variations alongside conditional response variations\\nas shown in the example below.\\n\\n```\\nslots:\\n logged_in:\\n type: bool\\n influence_conversation: False\\n mappings:\\n - type: custom\\n name:\\n type: text\\n influence_conversation: False\\n mappings:\\n - type: custom\\n\\nresponses:\\n utter_greet:\\n - condition:\\n - type: slot\\n name: logged_in\\n value: true\\n text: \\\"Hey, {name}. Nice to see you again on Slack! How are you?\\\"\\n channel: slack\\n\\n - text: \\\"Welcome. How is your day going?\\\"\\n```\\n\\nRasa will prioritize the selection of responses in the following order:\\n\\n['conditional response variations with matching channel', 'default responses with matching channel', 'conditional response variations with no matching channel', 'default responses with no matching channel']\"}, \"Rich Responses\": {\"Buttons\": \"Here is an example of a response that uses buttons:\\n\\n```\\nresponses:\\n utter_greet:\\n - text: \\\"Hey! How are you?\\\"\\n buttons:\\n - title: \\\"great\\\"\\n payload: \\\"/mood_great\\\"\\n - title: \\\"super sad\\\"\\n payload: \\\"/mood_sad\\\"\\n```\\n\\nEach button in the list of `buttons` should have two keys:\\n\\n['`title`: The text displayed on the buttons that the user sees.', '`payload`: The message sent from the user to the assistant when the button is clicked.']\\n\\nIf you would like the buttons to also pass entities to the assistant:\\n\\n```\\nresponses:\\n utter_greet:\\n - text: \\\"Hey! Would you like to purchase motor or home insurance?\\\"\\n buttons:\\n - title: \\\"Motor insurance\\\"\\n payload: '/inform{{\\\"insurance\\\":\\\"motor\\\"}}'\\n - title: \\\"Home insurance\\\"\\n payload: '/inform{{\\\"insurance\\\":\\\"home\\\"}}'\\n```\\n\\nPassing multiple entities is also possible with:\\n\\n```\\n'/intent_name{{\\\"entity_type_1\\\":\\\"entity_value_1\\\", \\\"entity_type_2\\\": \\\"entity_value_2\\\"}}'\\n```\\n\\n:::note overwrite nlu with buttons\\nYou can use buttons to overwrite the NLU prediction and trigger a specific intent and entities.\\n\\nMessages starting with `/` are sent handled by the\\n`RegexInterpreter`, which expects NLU input in a shortened `/intent{entities}` format.\\nIn the example above, if the user clicks a button, the user input\\nwill be classified as either the `mood_great` or `mood_sad` intent.\\n\\nYou can include entities with the intent to be passed to the `RegexInterpreter` using the following format:\\n\\n`/inform{\\\"ORG\\\":\\\"Rasa\\\", \\\"GPE\\\":\\\"Germany\\\"}`\\n\\nThe `RegexInterpreter` will classify the message above with the intent `inform` and extract the entities\\n`Rasa` and `Germany` which are of type `ORG` and `GPE` respectively.\\n\\n:::\\n\\n:::note escaping curly braces in domain.yml\\nYou need to write the `/intent{entities}` shorthand response with double curly braces in domain.yml so that the assistant does not\\ntreat it as a [variable in a response](#using-variables-in-responses) and interpolate the content within the curly braces. \\n:::\\n\\n:::caution Check your channel\\nKeep in mind that it is up to the implementation of the output\\nchannel how to display the defined buttons. For example, some\\nchannels have a limit on the number of\\nbuttons you can provide. Check your channel's documentation under\\n**Concepts > Channel Connectors** for any channel-specific restrictions.\\n:::\", \"Images\": \"You can add images to a response by providing a URL to the image under the `image` key:\\n\\n```\\n utter_cheer_up:\\n - text: \\\"Here is something to cheer you up:\\\"\\n image: \\\"https://i.imgur.com/nGF1K8f.jpg\\\"\\n```\", \"Custom Output Payloads\": \"You can send any arbitrary output to the output channel using the\\n`custom` key. The output channel receives the object stored under the `custom` key\\nas a JSON payload.\\n\\nHere's an example of how to send a\\n[date picker](https://api.slack.com/reference/block-kit/block-elements#datepicker) to the\\n[Slack Output Channel](connectors/slack.mdx):\\n\\n```\\nresponses:\\n utter_take_bet:\\n - custom:\\n blocks:\\n - type: section\\n text:\\n text: \\\"Make a bet on when the world will end:\\\"\\n type: mrkdwn\\n accessory:\\n type: datepicker\\n initial_date: '2019-05-21'\\n placeholder:\\n type: plain_text\\n text: Select a date\\n```\"}, \"Using Responses in Conversations\": {\"Calling Responses as Actions\": \"If the name of the response starts with `utter_`, the response can\\ndirectly be used as an action, without being listed in the `actions` section of your domain. You would add the response\\nto the domain:\\n\\n```\\nresponses:\\n utter_greet:\\n - text: \\\"Hey! How are you?\\\"\\n```\\n\\nYou can use that same response as an action in your stories:\\n\\n```\\nstories:\\n- story: greet user\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nWhen the `utter_greet` action runs, it will send the message from\\nthe response back to the user.\\n\\n:::note Changing responses\\nIf you want to change the text, or any other part of the response,\\nyou need to retrain the assistant before these changes will be picked up.\\n:::\", \"Calling Responses from Custom Actions\": \"You can use the responses to generate response messages from your\\ncustom actions. If you're using Rasa SDK as your action server, you can use the dispatcher to generate the response message, for example: \\n\\n```\\nfrom rasa_sdk.interfaces import Action\\n\\nclass ActionGreet(Action):\\n def name(self):\\n return 'action_greet'\\n\\n def run(self, dispatcher, tracker, domain):\\n dispatcher.utter_message(template=\\\"utter_greet\\\")\\n return []\\n```\\n\\nIf you use a\\n[different custom action server](./action-server/index.mdx#other-action-servers),\\nyour server should return the following JSON to call the `utter_greet` response:\\n\\n```\\n{\\n \\\"events\\\":[],\\n \\\"responses\\\":[\\n {\\n \\\"template\\\":\\\"utter_greet\\\"\\n }\\n ]\\n}\\n```\"}}, \"metadata\": {\"id\": \"responses\", \"sidebar_label\": \"Responses\", \"title\": \"Responses\", \"abstract\": \"Responses are messages that your assistant sends to the user. A response is usually only text, but can also include content like images and buttons.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 40]\"}, {\"title\": \"Rules\", \"description\": \"Use Rasa rules to respond to FAQs, fill forms, or handle fallbacks gracefully.\", \"content\": {\"Writing a Rule\": {\"Rules for the Conversation Start\": \"To write a rule which only applies at the beginning of a conversation, add a\\n`conversation_start: true` to your rule:\\n\\n```\\nrules:\\n\\n- rule: Say `hello` when the user starts a conversation with intent `greet`\\n conversation_start: true\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nIf a user sends a message with the intent `greet` later in the conversation, the rule will not match.\", \"Rules with Conditions\": \"Conditions describe requirements which have to be fulfilled for a rule to be\\napplicable. To do so, add any information about the prior conversation under the\\n`condition` key:\\n\\n```\\nrules:\\n\\n- rule: Only say `hello` if the user provided a name\\n condition:\\n - slot_was_set:\\n - user_provided_name: true\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nPossible information that you can include under `condition` includes `slot_was_set` events\\nand `active_loop` events.\", \"Skip Waiting for User Input at the End of a Rule\": \"By default, rules will wait for the next user message when finished with the last step:\\n\\n```\\nrules:\\n\\n- rule: Rule which will wait for user message when it was applied\\n steps:\\n - intent: greet\\n - action: utter_greet\\n # - action: action_listen\\n # Every rule implicitly includes a prediction for `action_listen` as last step.\\n # This means that Rasa will wait for the next user message.\\n```\\n\\nIf you want to hand over the next action prediction to another story or rule, add\\n`wait_for_user_input: false` to your rule:\\n\\n```\\nrules:\\n\\n- rule: Rule which will not wait for user message once it was applied\\n steps:\\n - intent: greet\\n - action: utter_greet\\n wait_for_user_input: false\\n```\\n\\nThis indicates that the assistant should execute another action\\nbefore waiting for more user input.\", \"Abort a Rule\": \"Rules are designed to handle multiple output steps of a chatbot.\\nThey are terminated as soon as user interaction is required.\\nThis happens automatically via [launching a form](#rules-and-forms), since it starts with the user input of the first slot.\\nTherefore all steps after launch are ignored.\\n\\nTermination, however, can also be achieved manually.\\nThis can be useful to implement conditional termination criteria.\\nHere is an example:\\n\\n```\\nrules:\\n\\n- rule: Rule which will be conditionaly terminated\\n steps:\\n - intent: greet\\n - action: action_check_termination\\n - action: utter_greet\\n wait_for_user_input: true\\n```\\n\\n```\\nfrom rasa_sdk import Action\\nfrom rasa_sdk.events import FollowupAction\\n\\nclass ActionCheckTermination(Action):\\n\\n def name(self):\\n return \\\"action_check_termination\\\"\\n\\n def run(self, dispatcher, tracker, domain):\\n\\n # your business logic here\\n should_terminate = check_for_termination(<params>)\\n\\n if should_terminate:\\n return [FollowupAction(\\\"action_listen\\\")]\\n\\n return []\\n```\\n\\nutter_greet is never executed when termination is done, even after user input, because it causes a new intent prediction.\", \"Rules and Forms\": \"When a [Form](./forms.mdx) is active, the bot will make predictions based on\\nhow the form is defined, ignoring rules. Rules become applicable again if:\\n\\n['the form fills all required slots', 'the form rejects its execution (see\\\\n[Handling Unhappy Paths](./forms.mdx#writing-stories--rules-for-unhappy-form-paths) for\\\\nmore details)']\"}}, \"metadata\": {\"id\": \"rules\", \"sidebar_label\": \"Rules\", \"title\": \"Rules\", \"description\": \"Use Rasa rules to respond to FAQs, fill forms, or handle fallbacks gracefully.\", \"abstract\": \"Rules are a type of training data used to train your assistant's dialogue management model. Rules describe short pieces of conversations that should always follow the same path.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 41]\"}, {\"title\": \"Rasa SDK Change Log\", \"description\": null, \"content\": {\"root\": [\"The Rasa SDK changelog can be found in the [Rasa SDK repository](https://github.com/RasaHQ/rasa-sdk/blob/main/CHANGELOG.mdx)\"]}, \"metadata\": {\"id\": \"sdk_changelog\", \"sidebar_label\": \"Rasa SDK Change Log\", \"title\": \"Rasa SDK Change Log\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 42]\"}, {\"title\": \"Secrets Managers\", \"description\": \"Safeguard credentials your service uses to authenticate to external resources.\", \"content\": {\"HashiCorp Vault Secrets Manager\": {\"Authentication\": \"Rasa Pro can authenticate to Vault through\\n[Token authentication](https://www.vaultproject.io/docs/auth/token).\\n\\nBoth `expiring` and `non-expiring` (so called, root tokens) tokens are supported.\\nRasa Pro will automatically renew the token if it is expiring.\", \"How to configure access to Vault\": {\"Store access credentials in environment variables\": \"A simple example on how to combine environment variables and `endpoints.yml` configuration file\\nwould be to store access token in the environment variable and the rest of the configuration\\nin the `endpoints.yml` file.\\n\\n```\\n# environment variables\\nVAULT_TOKEN=<token used to authenticate to Vault>\\n```\\n\\n```\\nsecrets_manager:\\n type: vault\\n url: \\\"http://localhost:1234\\\"\\n secrets_path: rasa-secrets # if not set it defaults to `rasa-secrets`\\n transit_mount_point: transit # if you have enabled transit secrets engine, and you want to use it\\n```\"}, \"How to configure Tracker Store with Vault Secrets Manager\": [\"Configure Rasa to access the Vault instance\", \"Checkout the [How to configure access to Vault](#how-to-configure-access-to-vault) section for more details.\", \"Configure Rasa to use the Vault secrets manager to fetch credentials for the tracker store\", \"```\\ntracker_store:\\n type: SQL\\n url: localhost:5432\\n username:\\n source: secrets_manager.vault\\n secret_key: sql_store_username\\n password:\\n source: secrets_manager.vault\\n secret_key: sql_store_password\\n```\"]}}, \"metadata\": {\"id\": \"secrets-managers\", \"sidebar_label\": \"Secrets Managers\", \"title\": \"Secrets Managers\", \"description\": \"Safeguard credentials your service uses to authenticate to external resources.\", \"abstract\": \"You can store your assistant's secrets in an external credentials manager. Rasa Pro currently supports credentials manager for the Tracker Store\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 43]\"}, {\"title\": \"Setting up CI/CD\", \"description\": \"Set up a CI/CD pipeline to ensure that iterative improvements to your assistant are tested and deployed with minimum manual effort\", \"content\": {\"Overview\": \"Continuous Integration (CI) is the practice of merging in code changes\\nfrequently and automatically testing changes as they are committed. Continuous\\nDeployment (CD) means automatically deploying integrated changes to a staging\\nor production environment. Together, they allow you to make more frequent improvements\\nto your assistant and efficiently test and deploy those changes.\\n\\nThis guide will cover what should go in a CI/CD pipeline, specific to a\\nRasa project. How you implement that pipeline is up to you.\\nThere are many CI/CD tools out there, such as [GitHub Actions](https://github.com/features/actions),\\n[GitLab CI/CD](https://docs.gitlab.com/ee/ci/), [Jenkins](https://www.jenkins.io/doc/), and\\n[CircleCI](https://circleci.com/docs/). We recommend choosing a tool that integrates with\\nwhatever Git repository you use.\", \"Continuous Integration (CI)\": {\"CI Pipeline Overview\": \"Your CI pipeline should include model training and testing as steps to streamline the deployment process.\\nThe first step after saving new training data is to kick off the pipeline. This can be initiated manually\\nor when you create or update a pull request.\\n\\nNext, you need to run various sets of test to see the impact of your changes. This includes running\\ntests for data validation, NLU cross validation, and story testing. For\\nmore information about testing, see [Testing Your Assistant](./testing-your-assistant.mdx).\\n\\nThe last step is to review the results of your test and push the changes if the tests are successful.\\nOnce the new model is trained and tested, it can be deployed automatically using a Continuous\\nDeployment pipeline.\", \"GitHub Actions CI Pipeline\": \"You can use the [Rasa Train-Test Github Action](https://github.com/RasaHQ/rasa-train-test-gha)\\nin your CI pipeline to automatically perform data validation, training, and testing.\\n\\nAn example CI pipeline using the Github Action is shown below:\\n\\n```\\njobs:\\n training-testing:\\n name: Training and Testing\\n runs-on: ubuntu-latest\\n steps:\\n - uses: actions/checkout@v1\\n - name: Rasa Train and Test GitHub Action\\n uses: RasaHQ/rasa-train-test-gha@main\\n with:\\n requirements_file: requirements.txt\\n data_validate: true\\n rasa_train: true\\n cross_validation: true\\n rasa_test: true\\n test_type: all\\n publish_summary: true\\n github_token: ${{ secrets.GITHUB_TOKEN }}\\n - name: Upload model\\n if: github.ref == 'refs/heads/main'\\n uses: actions/upload-artifact@master\\n with:\\n name: model\\n path: models\\n```\\n\\nIn this pipeline, the Rasa Train-Test Github Action is performing data validation, model training, and story testing\\nin the first step and the model file is uploaded as an artifact in the second step.\\n\\nThe complete list of configurable parameters for the Rasa Train-Test Github Action is available in the repository's\\n[README](https://github.com/RasaHQ/rasa-train-test-gha#input-arguments).\\n\\nWhen `publish_summary` is set to `true`, this action will automatically publish the model's test results to the associated\\nPull Request as a comment:\\n\\n<img alt=\\\"image\\\" src={useBaseUrl(\\\"/img/train-test-github-action.png\\\")} />\\n\\nThe pull request can be approved or denied based on the evaluation results and, in many cases, you will want to automate the model's deployment if all CI checks pass. You can continue to the next section to learn more about Continuous Deployment.\"}, \"Continuous Deployment (CD)\": {\"Deploying Your Rasa Model\": \"If you ran [test stories](./testing-your-assistant.mdx) in your CI pipeline,\\nyou'll already have a trained model. You can set up your CD pipeline to upload the trained model to your\\nRasa server if the CI results are satisfactory. For example, to upload a model to Rasa X/Enterprise:\\n\\n```\\ncurl -k -F \\\"model=@models/my_model.tar.gz\\\" \\\"https://example.rasa.com/api/projects/default/models?api_token={your_api_token}\\\"\\n```\\n\\nIf you are using Rasa X/Enterprise, you can also [tag the uploaded model](https://rasa.com/docs/rasa-enterprise/pages/http-api/#tag/Models/paths/~1projects~1{project_id}~1models~1{model}~1tags~1{tag}/put)\\nas production (or whichever deployment you want to tag if using multiple [deployment environments](https://rasa.com/docs/rasa-enterprise/enterprise/deployment-environments/#)):\\n\\n```\\ncurl -X PUT \\\"https://example.rasa.com/api/projects/default/models/my_model/tags/production\\\"\\n```\\n\\n:::caution updates to action code\\nIf your update includes changes to both your model and your action\\ncode, and these changes depend on each other in any way, you should **not**\\nautomatically tag the model as `production`. You will first need to build and\\ndeploy your updated action server, so that the new model won't e.g. call\\nactions that don't exist in the pre-update action server.\\n:::\", \"Deploying Your Action Server\": \"You can automate\\n[building and uploading a new image for your action server](./deploy/deploy-action-server.mdx#building-an-action-server-image)\\nto an image repository for each\\nupdate to your action code. As noted above, be careful with\\nautomatically deploying a new image tag to production if the action server\\nwould be incompatible with the current production model.\"}, \"Example CI/CD pipelines\": \"As examples, see the CI/CD pipelines for\\n[Sara](https://github.com/RasaHQ/rasa-demo/blob/main/.github/workflows/continuous_integration.yml),\\nthe Rasa assistant that you can talk to in the Rasa Docs, and\\n[Carbon Bot](https://github.com/RasaHQ/carbon-bot/blob/master/.github/workflows/model_ci.yml).\\nBoth use [Github Actions](https://github.com/features/actions) as a CI/CD tool.\\n\\nThese examples are just two of many possibilities. If you have a CI/CD setup you like, please\\nshare it with the Rasa community on the [forum](https://forum.rasa.com).\"}, \"metadata\": {\"id\": \"setting-up-ci-cd\", \"sidebar_label\": \"Setting up CI/CD\", \"title\": \"Setting up CI/CD\", \"description\": \"Set up a CI/CD pipeline to ensure that iterative improvements to your assistant are tested and deployed with minimum manual effort\", \"abstract\": \"Even though developing a contextual assistant is different from developing traditional software, you should still follow software development best practices. Setting up a Continuous Integration (CI) and Continuous Deployment (CD) pipeline ensures that incremental updates to your bot are improving it, not harming it.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 44]\"}, {\"title\": \"Slot Validation Actions\", \"description\": null, \"content\": {\"`action_validate_slot_mappings`\": \"You can use the `action_validate_slot_mappings` action to define custom extraction and / or validation of slots that\\ncan be set or updated outside of a form context.\\n\\nThis action is called automatically at the end of the default action [`action_extract_slots`](./default-actions.mdx#action_extract_slots),\\nso the name must not be changed. If you are using Rasa SDK, you should extend the Rasa SDK [`ValidationAction` class](./action-server/validation-action.mdx#how-to-subclass-validationaction).\\nIf you are using a different action server, you will need to implement an action class with equivalent functionality to\\nthe Rasa SDK class. Please see [the action server docs](./action-server/validation-action.mdx#validationaction-class-implementation) for details.\\n\\nWith this option, you do not need to specify the `action` key in the [custom slot mapping](./domain.mdx#custom-slot-mappings),\\nsince the default action [`action_extract_slots`](./default-actions.mdx#action_extract_slots) runs `action_validate_slot_mappings`\\nautomatically if present in the `actions` section of the domain.\", \"`validate_<form name>`\": \"Custom actions named `validate_<form name>` will run automatically if the form it specifies in its name is activated.\\nIf you are using Rasa SDK, the custom action should inherit from the Rasa SDK [`FormValidationAction` class](./action-server/validation-action.mdx#formvalidationaction-class).\\nIf you are not using Rasa SDK, you will need to implement an action or action class with equivalent functionality to the\\n`FormValidationClass` in your custom action server. Please see [the action server docs](./action-server/validation-action.mdx#formvalidationaction-class-implementation) for details.\", \"Regular Custom Action\": \"You can use a regular custom action [custom action](./custom-actions.mdx) that returns [`slot`](./action-server/events.mdx#slot)\\nevents for custom slot extraction. Use this option if neither [`action_validate_slot_mappings`](#action_validate_slot_mappings) or\\n[`validate_<form name>`](#validate_form-name) meet your needs.\\nFor example, if you want to reuse the same custom action explicitly in a story or rule, you should use a regular custom\\naction for custom slot extraction.\\nA slot validation action should only return `slot` and [`bot`](./action-server/events.mdx#bot) events.\\nAny other event type will be filtered out by the default action [`action_extract_slots`](./default-actions.mdx#action_extract_slots).\\nThe name of the custom action must be specified in the `action` key of the relevant [custom slot mapping](./domain.mdx#custom-slot-mappings)\\nin the domain.\\nNote that the action name must be listed in the domain `actions` section too.\\n\\n:::note Using different actions for extraction and validation\\n\\nYou can use both a regular custom action and `action_validate_slot_mappings` together to extract and validate a slot. For example, you can specify a regular custom action as the `action` for a `custom` slot mapping, and also add validation logic for the same slot to `action_validate_slot_mappings`. The custom action specified in the custom slot mapping will be called first, and `action_validate_slot_mappings` will be called afterwards.\\n\\n:::\"}, \"metadata\": {\"id\": \"slot-validation-actions\", \"sidebar_label\": \"Slot Validation Actions\", \"title\": \"Slot Validation Actions\", \"abstract\": \"A slot validation action is a special type of custom action, designed to handle custom extraction and/or validation of slot values. This can be used to validate slots with predefined mappings or extract slots with custom mappings.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 45]\"}, {\"title\": \"Spaces\", \"description\": \"Learn about Spaces for Rasa.\", \"content\": {\"When to use Spaces\": \"Spaces can be helpful when you are dealing with multiple domains of your business in\\na single assistant. Oftentimes, this leads to multitude of forms, entities, and inform\\nintents that start to overlap at some point. Form filling and inform intents are a\\ntypical case of having this follow-up structure mentioned above. Another good case is\\nwhen you want to be able to define different behavior for help- or clarification\\nrequests based on the subdomain or process the user is in. This is technically possible\\ntoday with stories, but it can be cumbersome to describe the full event horizon\\nfor every interaction route.\", \"When not to use Spaces / Limitations\": \"Because spaces split a rasa bot into multiple parts, it is interacting with almost\\nevery of the existing features of rasa. We made it work with almost all of them, but\\nthere are some exceptions. This means, however, if you have created\\ncustomization beyond components that are aligned with the way rasa normally\\nworks, spaces might not work for you.\\n\\nAnother important limitation is that spaces currently do not support stories. We know\\nthis is a big limitations for many existing bots. However, because stories and their\\nexisting policies work with a fixed event horizon (`max_history`), they are at this\\npoint not compatible with the idea of being able to describe encapsulated units of logic\\nwell.\\n\\nCurrently, the only entity extractor that is works with the boundaries that spaces\\ncreate, is an adapted version of the `CRFEntityExtractor`. You can find more on this\\nin the following sections.\", \"An example spaces bot\": \"We have created a bot using spaces for you to look at, learn from and experiment with.\\nIt features three different spaces in the financial domain. [Here is the repository](https://github.com/RasaHQ/financial-spaces-bot)\", \"How to use spaces\": {\"Training only a specific subspace\": \"We have added `--space` argument to the rasa train command to give you the option to\\nonly train one specific subspace:\\n\\n`rasa train` -> trains the full assistant with all spaces\\n`rasa train --space investment` -> trains an assistant only containing the investment and the main space\\n\\nOther commands were not adjusted as they use trained assistants as inputs.\"}, \"How do spaces work?\": {\"What happens during the assembly?\": \"The most important step during the assembly is the prefixing. During this step every\\nintent, entity, slot, action, form, utterance that is defined in a space's domain file\\nis prefixed (infixed for utterances) with this space's name. For example, an intent\\n`ask_transfer_charge` in the `transfer_money` domain would become\\n`transfer_money.ask_transfer_charge` and every reference of this intent would be\\nadjusted. The final assistant then works on the prefixed data.\\n\\nAn exception to this is the main space. Anything in the main space and all its\\nprimitives that are used in other spaces, will not be prefixed.\\n\\nAnother exception are rules. They don't have a name that can be prefixed. Instead,\\nwe add a condition to each rule that it is only applicable while it's space is active.\", \"How is space activation tracked?\": \"A space is activated when any of their entry intents is predicted. A space can have\\nmultiple entry intents. However, only a single space can be active at a given time.\\nSo when space A is active and an entry intent of space B\\nis predicted, space A will be deactivated and space B is active from now on.\\n\\nSpace activation is tracked through slots that are automatically\\ngenerated during assembly.\", \"How does filter and rerank work?\": \"The filter and rerank component post-processes the intent ranking of the [intent\\nclassification components](./components.mdx#intent-classifiers). It accesses the [tracker](./action-server/sdk-tracker.mdx)\\nand checks which space are active or would be activated, in case an entry intent is at the top.\\n\\nIt then removes any intents from the ranking that are not possible. Further it also\\nremoves any entities that are not possible given the space activation status or\\nabout to be predicted entry intents.\", \"How does entity recognition work differently?\": \"Usually, entity recognizers in Rasa only return a single label per token in a message.\\nThus, there is no ranking, that could be post-processed as in the case of intents. We\\nhave built our `SpacesCRFEntityExtractor` in a way that it creates multiple extractors.\\nOne for each space. Now, during the post-processing step, we can filter out the\\nextractor of the spaces that are not activated.\", \"Custom Actions\": \"Custom actions work as before. However, the tracker, the domain, and slots\\nwill be stripped of any information from other spaces before being handed to your\\naction. Additionally, every event such as slot sets, will be prefixed after they are\\nreturned by your action. All of this ensures that from the view point of your custom\\naction, you don't need to worry about the other spaces and accidentally leaking\\nor altering information. This warrants isolation between your Spaces. Note that\\ncustom actions from the main spaces are not inherited by subspaces.\", \"Response Selection\": \"Response selection works as before. The only small difference is that in your\\n`config.yaml` you'll need to specify the retrieval intent including it's final prefix.\\nIf your retrieval intent is `investment_faq` in the `investment` space, then in your\\nconfig you'll need to set `investment.investment_faq` as the retrieval intent. If the\\nretrieval intent belongs to the main space, no prefix is added. That's why\\n, in this case, during the definition of the retrieval intent, no prefixing is necessary.\", \"Lookup tables and Synonyms\": \"[Lookup Tables](./training-data-format.mdx#lookup-tables) and\\n[Synonyms](./training-data-format.mdx#synonyms) work with spaces. However, they are not\\ntruly isolated between spaces. So there can be some unanticipated interactions.\\nFor synonyms, specifically:\\n\\n['Assume two spaces define the same synonym. Space A: \\\"IB\\\" -> \\\"Instant banking\\\".\\\\nSpace B: \\\"IB\\\"-> \\\"iron bank\\\". A warning is given that one value overwrites the other.', 'A similar thing can happen if \\\"IB\\\" is an entity in both spaces but only one\\\\ndefines it a synonym. Any entity with value IB will always be mapped to that synonym\\\\nno matter which space is active.']\\n\\nFor lookup tables no adverse interactions are known.\"}}, \"metadata\": {\"id\": \"spaces\", \"sidebar_label\": \"Spaces\", \"title\": \"Spaces\", \"description\": \"Learn about Spaces for Rasa.\", \"abstract\": \"Spaces are a way to modularize your assistant that increases isolation between subparts and classification performance for intents and entities that are only relevant in specific contexts.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 46]\"}, {\"title\": \"Stories\", \"description\": \"Stories are used to teach Rasa real conversation designs to learn from providing the basis for a scalable machine learning dialogue management.\", \"content\": {\"Format\": {\"User Messages\": \"While writing stories, you do not have to deal with the specific contents of\\nthe messages that the users send. Instead, you can take advantage of the output\\nfrom the NLU pipeline, which lets you use just the combination of an intent and\\nentities to refer to all the possible messages the users can send to mean the\\nsame thing.\\n\\nIt is important to include the entities here as well because the policies learn\\nto predict the next action based on a *combination* of both the intent and\\nentities (you can, however, change this behavior using the\\n[use_entities](./domain.mdx#ignoring-entities-for-certain-intents) attribute).\", \"Actions\": \"All actions executed by the bot, including [responses](./responses.mdx) are listed\\nin stories under the `action` key.\\n\\nYou can use a response from your domain as an action by listing it as one\\nin a story. Similarly, you can indicate that a story should call a custom action by including\\nthe name of the custom action from the `actions` list in your domain.\", \"Events\": {\"Slot Events\": \"Slot events are written under `slot_was_set` in a story. If this slot is set\\ninside a custom action, add the `slot_was_set` event immediately following the\\ncustom action call. If your custom action resets a slot value to `None`, the\\ncorresponding event for that would look like this:\\n\\n```\\nstories:\\n- story: set slot to none\\n steps:\\n # ... other story steps\\n - action: my_custom_action\\n - slot_was_set:\\n - my_slot: null\\n```\", \"Form Events\": \"There are three kinds of events that need to be kept in mind while dealing with\\nforms in stories.\\n\\n['A form action event (e.g. `- action: restaurant_form`) is used in the beginning when first starting a form, and also while resuming the form action when the form is already active.', 'A form activation event (e.g. `- active_loop: restaurant_form`) is used right after the first form action event.', 'A form deactivation event (e.g. `- active_loop: null`), which is used to deactivate the form.']\\n\\n:::note writing form stories\\nIn order to get around the pitfall of forgetting to add events, the recommended\\nway to write these stories is to use [interactive learning](./writing-stories.mdx#using-interactive-learning).\\n\\n:::\"}}, \"Checkpoints and OR statements\": {\"Checkpoints\": \"You can use checkpoints to modularize and simplify your training\\ndata. Checkpoints can be useful, but **do not overuse them**. Using\\nlots of checkpoints can quickly make your example stories hard to\\nunderstand, and will slow down training.\\n\\nHere is an example of stories that\\ncontain checkpoints:\\n\\n```\\nstories:\\n- story: beginning of flow\\n steps:\\n - intent: greet\\n - action: action_ask_user_question\\n - checkpoint: check_asked_question\\n\\n- story: handle user affirm\\n steps:\\n - checkpoint: check_asked_question\\n - intent: affirm\\n - action: action_handle_affirmation\\n - checkpoint: check_flow_finished\\n\\n- story: handle user deny\\n steps:\\n - checkpoint: check_asked_question\\n - intent: deny\\n - action: action_handle_denial\\n - checkpoint: check_flow_finished\\n\\n- story: finish flow\\n steps:\\n - checkpoint: check_flow_finished\\n - intent: goodbye\\n - action: utter_goodbye\\n```\\n\\n:::note\\nUnlike regular stories, checkpoints are not restricted to starting with\\nuser input. As long as the checkpoint is inserted at the right points\\nin the main stories, the first event can be a custom action or a response\\nas well.\\n\\n:::\", \"Or Statements\": \"Another way to write shorter stories, or to handle multiple intents\\nor slot events the same way, is to use an `or` statement.\\nFor example, if you ask the user to confirm something, and you want\\nto treat the `affirm` and `thankyou` intents in the same way.\\nThe story below will be converted into two stories at training time:\\n\\n```\\nstories:\\n- story:\\n steps:\\n # ... previous steps\\n - action: utter_ask_confirm\\n - or:\\n - intent: affirm\\n - intent: thankyou\\n - action: action_handle_affirmation\\n```\\n\\nYou can also use `or` statements with slot events.\\nThe following means the story requires that the current value for\\nthe `name` slot is set and is either `joe` or `bob`:\\n\\n```\\nstories:\\n- story:\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: tell_name\\n - or:\\n - slot_was_set:\\n - name: joe\\n - slot_was_set:\\n - name: bob\\n # ... next actions\\n```\\n\\n`or` statements can be useful, but if you are using a\\nlot of them, it is probably better to restructure your domain and/or intents.\\nOverusing OR statements will slow down training.\"}, \"Test Conversation Format\": \"The test conversation format is a format that combines both NLU data and stories\\ninto a single file for evaluation. Read more about this format in [Testing Your Assistant](./testing-your-assistant.mdx).\\n\\n:::caution testing only\\nThis format is only used for testing and cannot be used for training.\\n\\n:::\", \"End-to-end Training\": \":::info New in 2.2\\nEnd-to-end training is an experimental feature.\\nWe introduce experimental features to get feedback from our community, so we encourage you to try it out!\\nHowever, the functionality might be changed or removed in the future.\\nIf you have feedback (positive or negative) please share it with us on the [Rasa Forum](https://forum.rasa.com).\\n\\n:::\\n\\nWith end-to-end training, you do not have to deal with the specific\\nintents of the messages that are extracted by the NLU pipeline\\nor with separate `utter_` responses in the domain file.\\nInstead, you can include the text of the user messages and/or bot responses directly in your stories.\\nSee the [training data format](./training-data-format.mdx#end-to-end-training)\\nfor detailed description of how to write end-to-end stories.\\n\\nYou can mix training data in the end-to-end format with labeled training data which has \\n`intent`s and `action`s specified: Stories can have some steps defined by intents/actions\\nand other steps defined directly by user or bot utterances.\\n\\nWe call it end-to-end training because policies can consume and predict actual text.\\nFor end-to-end user inputs, intents classified by the NLU pipeline\\nand extracted entities are ignored.\\n\\nOnly [Rule Policy](./policies.mdx#rule-policy)\\nand [TED Policy](./policies.mdx#ted-policy) allow end-to-end training.\\n\\n['`RulePolicy` uses simple string matching during prediction. Namely,\\\\nrules based on user text will only match if the user\\\\ntext strings inside your rules and input during prediction are identical.', '`TEDPolicy` passes user text through an additional Neural Network to create\\\\nhidden representations of the text. In order to obtain robust performance you\\\\nneed to provide enough training stories to capture a variety of user texts for any \\\\nend-to-end dialogue turn.']\\n\\nRasa policies are trained for next utterance selection.\\nThe only difference to creating `utter_` response is how `TEDPolicy` featurizes\\nbot utterances.\\nIn case of an `utter_` action, `TEDPolicy` sees only the name of the action, while\\nif you provide actual utterance using `bot` key,\\n`TEDPolicy` will featurize it as textual input depending on the NLU configuration.\\nThis can help in case of similar utterances in slightly different situations.\\nHowever, this can also make things harder to learn because the fact that different\\nutterances have similar texts make it easier for `TEDPolicy` to confuse these utterances.\\n\\nEnd-to-end training requires significantly more parameters in `TEDPolicy`.\\nTherefore, training an end-to-end model might require significant computational\\nresources depending on how many end-to-end turns you have in your stories.\"}, \"metadata\": {\"id\": \"stories\", \"sidebar_label\": \"Stories\", \"title\": \"Stories\", \"description\": \"Stories are used to teach Rasa real conversation designs to learn from providing the basis for a scalable machine learning dialogue management.\", \"abstract\": \"Stories are a type of training data used to train your assistant's dialogue management model. Stories can be used to train models that are able to generalize to unseen conversation paths.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 47]\"}, {\"title\": \"Testing Your Assistant\", \"description\": null, \"content\": {\"Validating Data and Stories\": \"Data validation verifies that no mistakes or major inconsistencies appear in your domain, NLU\\ndata, or story data. To validate your data, have your CI run this command:\\n\\n```\\nrasa data validate\\n```\\n\\nIf you pass a `max_history` value to one or more policies in your `config.yml` file, provide the\\nsmallest of those values as\\n\\n```\\nrasa data validate --max-history <max_history>\\n```\\n\\nIf data validation results in errors, training a model can also fail or yield bad performance, so it's\\nalways good to run this check before training a model. By including the\\n`--fail-on-warnings` flag, this step will fail on warnings indicating more minor issues.\\n\\n:::note\\nRunning `rasa data validate` does **not** test if your [rules](./rules.mdx) are consistent with your stories.\\nHowever, during training, the `RulePolicy` checks for conflicts between rules and stories. Any such conflict will abort training.\\n:::\\n\\nTo read more about the validator and all of the available options, see [the documentation for\\n`rasa data validate`](./command-line-interface.mdx#rasa-data-validate).\", \"Writing Test Stories\": \"Testing your trained model on test stories is the best way to have confidence in how your assistant\\nwill act in certain situations. Written in a modified story\\nformat, test stories allow you to provide entire conversations and test that, given certain\\nuser input, your model will behave in the expected manner. This is especially\\nimportant as you start introducing more complicated stories from user\\nconversations.\\n\\nTest stories are like\\nthe stories in your training data, but include the user message as well.\\n\\nHere are some examples:\\n\\n<Tabs values={[{\\\"label\\\": \\\"Basics\\\", \\\"value\\\": \\\"basics\\\"}, {\\\"label\\\": \\\"Button Payload\\\", \\\"value\\\": \\\"buttons\\\"}, {\\\"label\\\": \\\"Custom Actions\\\", \\\"value\\\": \\\"customactions\\\"}, {\\\"label\\\": \\\"Forms Happy Path\\\", \\\"value\\\": \\\"formshappypath\\\"}, {\\\"label\\\": \\\"Forms Unhappy Path\\\", \\\"value\\\": \\\"formsunhappypath\\\"}]} defaultValue=\\\"basics\\\">\\n<TabItem value=\\\"basics\\\">\\n\\n```\\nstories:\\n- story: A basic story test\\n steps:\\n - user: |\\n hello\\n intent: greet\\n - action: utter_ask_howcanhelp\\n - user: |\\n show me [chinese]{\\\"entity\\\": \\\"cuisine\\\"} restaurants\\n intent: inform\\n - action: utter_ask_location\\n - user: |\\n in [Paris]{\\\"entity\\\": \\\"location\\\"}\\n intent: inform\\n - action: utter_ask_price\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"buttons\\\">\\n\\n```\\nstories:\\n- story: A test where a user clicks on a button with payload\\n steps:\\n - user: |\\n hello\\n intent: greet\\n - action: utter_ask_howcanhelp\\n - user: /inform{{\\\"cuisine\\\":\\\"chinese\\\"}}\\n intent: inform\\n - action: utter_ask_location\\n - user: /inform{{\\\"location\\\":\\\"Paris\\\"}}\\n intent: inform\\n - action: utter_ask_price\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"customactions\\\">\\n\\n```\\nstories:\\n- story: A test where a custom action returns events\\n steps:\\n - user: |\\n hey\\n intent: greet\\n - action: my_custom_action\\n - slot_was_set:\\n - my_slot: \\\"value added by custom action\\\"\\n - action: utter_ask_age\\n - user: |\\n thanks\\n intent: thankyou\\n - action: utter_no_worries\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"formshappypath\\\">\\n\\n```\\nstories:\\n- story: A test story with a form\\n steps:\\n - user: |\\n hi\\n intent: greet\\n - action: utter_greet\\n - user: |\\n im looking for a restaurant\\n intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - user: |\\n [afghan](cuisine) food\\n intent: inform\\n - action: restaurant_form\\n - active_loop: null\\n - action: utter_slots_values\\n - user: |\\n thanks\\n intent: thankyou\\n - action: utter_no_worries\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"formsunhappypath\\\">\\n\\n```\\nstories:\\n- story: A test story with unexpected input during a form\\n steps:\\n - user: |\\n hi\\n intent: greet\\n - action: utter_greet\\n - user: |\\n im looking for a restaurant\\n intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - user: |\\n How's the weather?\\n intent: chitchat\\n - action: utter_chitchat\\n - action: restaurant_form\\n - active_loop: null\\n - action: utter_slots_values\\n - user: |\\n thanks\\n intent: thankyou\\n - action: utter_no_worries\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"entities\\\">\\n\\n```\\nstories:\\n- story: A basic test story with multiple entities for a single token\\n steps:\\n - user: |\\n hello\\n intent: greet\\n - action: utter_ask_howcanhelp\\n - user: |\\n show me [chinese]{\\\"entity\\\": \\\"cuisine\\\"} restaurants\\n intent: inform\\n - action: utter_ask_location\\n - user: |\\n in [Paris][{\\\"entity\\\": \\\"location\\\"}, {\\\"entity\\\": \\\"city\\\"}]\\n intent: inform\\n - action: utter_ask_price\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\nBy default, the command will run tests on stories from any files with names starting with `test_`. You can also provide\\na specific test stories file or directory with the `--stories` argument.\\nYou can test your assistant against them by running:\\n\\n```\\nrasa test\\n```\\n\\nConversation testing is only as thorough and accurate as the test\\ncases you include, so you should continue to grow your set of test stories\\nas you make improvements to your assistant. A good rule of thumb to follow is that you should aim for your test stories\\nto be representative of the true distribution of real conversations.\\n\\nSee the [CLI documentation on `rasa test`](./command-line-interface.mdx#rasa-test) for\\nmore configuration options.\\n\\n:::caution Testing Custom Actions\\n[Custom Actions](./custom-actions.mdx) are not executed as part of test stories. If your custom\\nactions append any events to the conversation, this has to be reflected in your test story\\n(e.g. by adding `slot_was_set` events to your test story).\\n\\nTo test the code of your custom actions, you should write unit tests\\nfor them and include these tests in your [CI/CD pipeline](./setting-up-ci-cd.mdx).\\n\\n:::\", \"Evaluating an NLU Model\": {\"Using a Held-Out Test Set\": \"If you use the train-test\\nset approach, it is best to [shuffle and split your data](./command-line-interface.mdx#rasa-data-split)\\nusing `rasa data split` every time you evaluate your model, as\\nopposed to using a static NLU test set, which can easily become outdated.\\n\\nYou can split your NLU data into train and test sets using: \\n\\n```\\nrasa data split nlu\\n```\\n\\nNext, you can see how well your trained NLU model predicts the\\ndata from the test set you generated, using:\\n\\n```\\nrasa test nlu\\n --nlu train_test_split/test_data.yml\\n```\", \"Using Cross-Validation\": \"If you've made significant changes to your NLU training data (e.g.\\nsplitting an intent into two intents or adding a lot of training examples), you should run a\\nfull NLU evaluation using cross-validation. Cross-validation automatically creates\\nmultiple train/test splits and averages the results of evaluations on each train/test split.\\nThis means all your data is evaluated during cross-validation, making cross-validation the most\\nthorough way to automatically test your NLU model.\\n\\nTo run NLU testing in cross-validation mode run: \\n\\n```\\nrasa test nlu\\n --nlu data/nlu\\n --cross-validation\\n```\\n\\nYou can specify the number of test/train splits used with the `-f/--folds` flag:\\n\\n```\\nrasa test nlu\\n --nlu data/nlu\\n --cross-validation\\n --folds 5\\n```\\n\\nNote that during cross-validation, the NLU model will be trained for each fold,\\nso cross-validation with a large data set and a high number of folds can be time-consuming.\\nOn a small data set, a high number of folds can result in too few examples per intent being available for each test split.\\n\\nOn the other hand, if you specify a low number of folds, your data will be split into much larger chunks,\\nand there will be proportionally less data to train on for each fold.\\n\\nChoose a number of folds that balances both considerations for your dataset size.\\n\\n:::tip hyperparameter tuning\\nTo further improve your model check out this\\n[tutorial on hyperparameter tuning](https://blog.rasa.com/rasa-nlu-in-depth-part-3-hyperparameters/).\\n:::\", \"Comparing NLU Pipelines\": \"To get the most out of your training data, you should train and evaluate your model on different pipelines\\nand different amounts of training data.\\n\\nTo do so, pass multiple configuration files to the `rasa test` command:\\n\\n```\\nrasa test nlu --nlu data/nlu.yml\\n --config config_1.yml config_2.yml\\n```\\n\\nThis performs several steps:\\n\\n['Create a global 80% train / 20% test split from `data/nlu.yml`.', 'Exclude a certain percentage of data from the global train split.', 'Train models for each configuration on remaining training data.', 'Evaluate each model on the global test split.']\\n\\nThe above process is repeated with different percentages of training data in step 2\\nto give you an idea of how each pipeline will behave if you increase the amount of training data.\\nSince training is not completely deterministic, the whole process is repeated\\nthree times for each configuration specified.\\n\\nA graph with the mean and standard deviations of\\n[f1-scores](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.f1_score.html)\\nacross all runs is plotted.\\nThe f1-score graph, along with all train/test sets, the trained models, classification and error reports,\\nwill be saved into a folder called `nlu_comparison_results`.\\n\\nInspecting the f1-score graph can help you understand if you have enough data for your NLU model.\\nIf the graph shows that f1-score is still improving when all of the training data is used,\\nit may improve further with more data. But if f1-score has plateaued when all training data is used,\\nadding more data may not help.\\n\\nIf you want to change the number of runs or exclusion percentages, you can:\\n\\n```\\nrasa test nlu --nlu data/nlu.yml\\n --config config_1.yml config_2.yml\\n --runs 4 --percentages 0 25 50 70 90\\n```\", \"Interpreting the Output\": {\"Intent Classifiers\": \"The `rasa test` script will produce a report (`intent_report.json`), confusion matrix (`intent_confusion_matrix.png`)\\nand confidence histogram (`intent_histogram.png`) for your intent classification model.\\n\\nThe report logs [precision](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.precision_score.html),\\n[recall](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.recall_score.html) and\\n[f1-score](https://scikit-learn.org/stable/modules/generated/sklearn.metrics.f1_score.html) for each intent,\\nas well as providing an overall average. You can save these reports as JSON files using the `--report` argument.\\n\\nThe confusion matrix shows which intents are mistaken for others.\\nAny samples which have been incorrectly predicted are logged and saved to a file called `errors.json` for easier debugging.\\n\\n<div align=\\\"center\\\">\\n <img alt=\\\"image\\\" src={useBaseUrl(\\\"/img/intent_confusion_matrix_example.png\\\")} width=\\\"70%\\\" />\\n</div>\\n\\nThe histogram allows you to visualize the confidence for all predictions,\\nwith the correct and incorrect predictions being displayed by blue and red bars respectively.\\nImproving the quality of your training data will move the blue histogram bars up the plot and the\\nred histogram bars down the plot. It should also help in reducing the number of red histogram bars itself.\\n\\n<div align=\\\"center\\\">\\n <img alt=\\\"image\\\" src={useBaseUrl(\\\"/img/intent_histogram_example.png\\\")} width=\\\"70%\\\" />\\n</div>\", \"Response Selectors\": \"`rasa test` evaluates response selectors in the same way that it evaluates intent classifiers, producing a\\nreport (`response_selection_report.json`), confusion matrix (`response_selection_confusion_matrix.png`),\\nconfidence histogram (`response_selection_histogram.png`) and errors (`response_selection_errors.json`).\\nIf your pipeline includes multiple response selectors, they are evaluated in a single report.\\n\\nThe report logs precision, recall and f1 measure for\\neach sub-intent of a [retrieval intent](./glossary.mdx#retrieval-intent) and provides an overall average.\\nYou can save these reports as JSON files using the `--report` argument.\", \"Entity Extraction\": \"`rasa test` reports recall, precision, and f1-score for each entity type that\\nyour trainable entity extractors are trained to recognize.\\n\\nOnly trainable entity extractors, such as the `DIETClassifier` and `CRFEntityExtractor` are\\nevaluated by `rasa test`. Pretrained extractors like the `DucklingHTTPExtractor` are not evaluated.\\n\\nIf you have multiple entity extractors in your pipeline, or use some custom extractors,\\nmultiple entities might be associated with the same token. In this case,\\nyou can use a list notation in the test files, such as\\n\\n```\\nstories:\\n- story: A basic test story with multiple entities for a single token\\n steps:\\n - user: |\\n I like [ice cream][{\\\\\\\"entity\\\\\\\": \\\\\\\"food\\\\\\\"}, {\\\\\\\"entity\\\\\\\": \\\\\\\"desert\\\\\\\"}]\\n intent: inform\\n # ...\\n```\\n\\n:::caution incorrect entity annotations\\nIf any of your entities are incorrectly annotated, your evaluation may fail. One common problem\\nis that an entity cannot stop or start inside a token.\\nFor example, if you have an example for a `name` entity\\nlike `[Brian](name)'s house`, this is only valid if your tokenizer splits `Brian's` into\\nmultiple tokens.\\n\\n:::\", \"Entity Scoring\": \"To evaluate entity extraction we apply a simple tag-based approach. We don't consider\\n[BILOU tags](nlu-training-data.mdx#bilou-entity-tagging) exactly, but only the\\nentity type tags on a per token basis. For location entity like \\u201cnear Alexanderplatz\\u201d we\\nexpect the labels `LOC LOC` instead of the BILOU-based `B-LOC L-LOC`.\\n\\nOur approach is more lenient when it comes to evaluation, as it rewards\\npartial extraction and does not penalize the splitting of entities.\\nFor example, given the aforementioned entity \\u201cnear Alexanderplatz\\u201d and a system that extracts\\n\\u201cAlexanderplatz\\u201d, our approach rewards the extraction of \\u201cAlexanderplatz\\u201d and penalizes the missed out word \\u201cnear\\u201d.\\n\\nThe BILOU-based approach, however, would label this as a complete failure since it expects Alexanderplatz\\nto be labeled as a last token in an entity (`L-LOC`) instead of a single token entity (`U-LOC`). Note also that\\na split extraction of \\u201cnear\\u201d and \\u201cAlexanderplatz\\u201d would get full scores on our approach and zero on the\\nBILOU-based one.\\n\\nHere's a comparison between the two scoring mechanisms for the phrase \\u201cnear Alexanderplatz tonight\\u201d:\\n\\n| extracted |Simple tags (score) | BILOU tags (score) |\\n|----------------------------------------------------|--------------------|-----------------------|\\n|`[near Alexanderplatz](loc) [tonight](time)` |loc loc time (3) |B-loc L-loc U-time (3) |\\n|`[near](loc) [Alexanderplatz](loc) [tonight](time)` |loc loc time (3) |U-loc U-loc U-time (1) |\\n|`near [Alexanderplatz](loc) [tonight](time)` |O loc time (2) |O U-loc U-time (1) |\\n|`[near](loc) Alexanderplatz [tonight](time)` |loc O time (2) |U-loc O U-time (1) |\\n|`[near Alexanderplatz tonight](loc)` |loc loc loc (2) |B-loc I-loc L-loc (1) |\"}}, \"Evaluating a Dialogue Model\": {\"Interpreting the generated warnings\": \"The test script will also generate a warnings file called `results/stories_with_warnings.yml`.\\nThis file contains all test stories for which [`action_unlikely_intent`](./default-actions.mdx#action_unlikely_intent)\\nwas predicted at any conversation turn but all actions from the original story were predicted correctly.\\nHowever, if a test story originally included an `action_unlikely_intent`, for example to ensure [a rule is designed to\\ntrigger the conversation path after an `action_unlikely_intent`](./default-actions.mdx#customization-1) but the ensemble of\\npolicies failed to do so, then the corresponding story will end up in `results/failed_test_stories.yml` as\\na failed story.\\n\\nThe stories are sorted by the severity of `action_unlikely_intent`'s prediction.\\nThis severity is calculated by [`UnexpecTEDIntentPolicy`](./policies.mdx#unexpected-intent-policy) itself at prediction time.\\nThe higher the severity, the more unlikely is the intent and hence reviewing that particular\\nconversation path becomes more critical.\\n\\nNote, that `action_unlikely_intent` is predicted by\\n`UnexpecTEDIntentPolicy` which employs a machine learning based model\\nunder the hood and hence can result in false warnings as well. You can choose to ignore such warnings\\nif the conversation paths in these stories are already present in the training stories.\", \"Comparing Policy Configurations\": \"To choose a configuration for your dialogue model, or to choose hyperparameters for a\\nspecific policy, you want to measure how well your dialogue model will generalize\\nto conversations it hasn't seen before. Especially in the beginning\\nof a project, when you don't have a lot of real conversations to train\\nyour bot on, you may not want to exclude some to use as a test set.\\n\\nRasa has some scripts to help you choose and fine-tune your policy configuration.\\nOnce you are happy with it, you can then train your final configuration on your\\nfull data set.\\n\\nTo do this, you first have to train models for your different\\nconfigurations. Create two (or more) config files including the policies you want to\\ncompare, and then provide them to the train script to train your models:\\n\\n```\\nrasa train core -c config_1.yml config_2.yml \\\\\\n --out comparison_models --runs 3 --percentages 0 5 25 50 70 95\\n```\\n\\nSimilar to how the [NLU model was evaluated](./testing-your-assistant.mdx#comparing-nlu-pipelines), the above\\ncommand trains the dialogue model on multiple configurations and different amounts of training data.\\nFor each config file provided, Rasa will train dialogue models\\nwith 0, 5, 25, 50, 70 and 95% of your training stories excluded from the training\\ndata. This is repeated three times to ensure consistent results.\\n\\nOnce this script has finished, you can pass multiple models to the test script\\nto compare the models you just trained:\\n\\n```\\nrasa test core -m comparison_models --stories stories_folder\\n --out comparison_results --evaluate-model-directory\\n```\\n\\nThis will evaluate each model on the stories in `stories_folder`\\n(can be either training or test set) and plot some graphs\\nto show you which policy performs best. Since the previous train command\\nexcluded some amount of training data to train each model,\\nthe above test command can measure how well your model predicts the held-out stories.\\nTo compare single policies, create config files containing only one policy each.\\n\\n:::note\\nThis training process can take a long time, so we'd suggest letting it run\\nsomewhere in the background where it can't be interrupted.\\n\\n:::\", \"Testing Action Code\": \"The approach used to test your action code will depend on how it is\\nimplemented. For example, if you connect to external APIs, you should write integration tests to ensure\\nthat those APIs respond as expected to common inputs. However you test your action code, you should\\ninclude these tests in your CI pipeline so that they run each time you make changes.\\n\\nIf you have any questions or problems, please share them with us in the dedicated\\n[testing section on our forum](https://forum.rasa.com/tags/testing)!\"}, \"End-To-End Testing\": {\"How to write test cases\": \"To write test cases, you need to create a YAML file inside the `tests` directory of your project. The name of the file\\nshould be `e2e_test_cases.yml`. You can also create a subdirectory inside the `tests` directory and place your test case\\nYAML files there. These files will be automatically discovered and run by Rasa Pro, however you need to provide\\nthe path to the subdirectory as positional argument to the `rasa test e2e` command.\\n\\nEach input file must contain the `test_cases` required key. The value of this key is a list of test cases.\\nEach test case must include a name given to the `test_case` key and a list of test steps given to the `steps` key.\\nA step can be either one of the following:\\n\\n['`user`: a user message', '`bot`: a bot response', '`utter`: a domain utterance', '`slot_was_set`: a slot name and the value it was set to']\\n\\nYou can also add the optional `fixtures` top level key if pre-filled slots are required for setting any individual\\ntest case context. The `fixtures` key is a list of fixture names (which must be unique) and each fixture name maps to a\\nlist of slot key-value pairs. If one of the test cases requires a pre-filled slot, you can add the fixture name to the\\ntest case definition, by adding the fixture name to the optional `fixtures` key in the test case. The slot key-value\\npairs will be set before the test case is run.\\n\\nThe following example shows a test case file with fixtures and two test cases that make use of all available steps:\\n\\n```\\nfixtures:\\n - premium: # name of the fixture must be provided and be unique\\n - membership_type: premium # every fixture can contain multiple slot key-value pairs\\n - logged_in: True\\n - standard:\\n - logged_in: True\\n - membership_type: standard\\n\\ntest_cases:\\n - test_case: \\\"test_premium_booking\\\"\\n fixtures:\\n - premium # re-use the name of the fixture provided in fixtures section\\n steps:\\n - user: \\\"Hi!\\\"\\n - bot: \\\"Welcome back! How can I help you?\\\"\\n - user: \\\"I want to book a trip.\\\"\\n - utter: utter_ask_location\\n - user: \\\"I would like to travel to Lisbon.\\\"\\n - slot_was_set:\\n - location: \\\"Lisbon\\\"\\n - utter: utter_ask_date\\n - user: \\\"I would like to travel on 22nd of June.\\\"\\n - slot_was_set:\\n - travel_date: \\\"2023-06-22\\\"\\n - bot: \\\"Great! I will book your trip to Lisbon on 22nd of June.\\\"\\n - bot: \\\"You saved 20% by being a premium member.\\\"\\n\\n - test_case: \\\"test_anonymous_booking\\\"\\n steps:\\n - user: \\\"Hi!\\\"\\n - bot: \\\"Hey! How can I help you?\\\"\\n - user: \\\"I want to book a trip.\\\"\\n - utter: utter_ask_location\\n - user: \\\"I would like to travel to Paris.\\\"\\n - slot_was_set:\\n - location: \\\"Paris\\\"\\n - utter: utter_ask_date\\n - user: \\\"I would like to travel on 2nd of April.\\\"\\n - slot_was_set:\\n - travel_date: \\\"2023-04-02\\\"\\n - bot: \\\"Great! I will book your trip to Paris on 2nd of April.\\\"\\n - bot: \\\"You can also choose to save 20% by becoming a premium member.\\\"\\n```\\n\\n:::note\\n\\nIf you are using multiple consecutive `slot_was_set` steps in your test case, the order in which these are defined must\\nmatch the order in which the slots are filled in the dialogue.\\n\\n:::\", \"How to run the tests\": {\"Testing custom actions\": \"If the test cases include custom actions, start the action server first:\\n\\n```\\nrasa run actions && rasa test e2e\\n```\"}, \"How to interpret the output\": \"By default, the results are always printed to `stdout` and the command will exit with exit code `0` (if all tests passed)\\nor `1` (in case of test failures).\\n\\nThe output style is inspired by `pytest`:\\n\\n['Failed test cases will be stacked, each highlighting the difference in identified mismatches in similar style to `git diff`:\\\\nexpected messages will be preceded by `+` prefix, while actual messages will be preceded by `-` prefix.', 'The short test summary includes a list of every failed test case name and file location in a new line.']\\n\\nIf `-o` flag is specified in the command, the results are also written to the `tests/e2e_results.yml` file, which will\\ncontain a list of test results with the following keys:\\n\\n['`name`: the name of the test case', '`pass_status`: the status of the test case, either `True` or `False`', '`expected_steps`: the expected test steps', '`difference`: a list of differences between the expected and actual test steps']\"}}, \"metadata\": {\"id\": \"testing-your-assistant\", \"sidebar_label\": \"Testing Your Assistant\", \"title\": \"Testing Your Assistant\", \"abstract\": \"Rasa lets you validate and test dialogues end-to-end by running through test stories. In addition, you can also test the dialogue management and the message processing (NLU) separately.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 48]\"}, {\"title\": \"Tracker Stores\", \"description\": \"All conversations are stored within a tracker store. Read how Rasa provides implementations for different store types out of the box.\", \"content\": {\"Switch to root user to install packages\": \"USER root\\n\\nRUN apt-get update -qq && apt-get install -y --no-install-recommends alien libaio1 && apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*\", \"Copy in oracle instaclient\": \"\", \"https://www.oracle.com/database/technologies/instant-client/linux-x86-64-downloads.html\": \"COPY oracle.rpm oracle.rpm\", \"Install the Python wrapper library for the Oracle drivers\": \"RUN pip install cx-Oracle\", \"Install Oracle client libraries\": {\"RedisTrackerStore\": {\"Configuration\": \"To set up Rasa with Redis the following steps are required:\\n\\n['Start your Redis instance', 'Add required configuration to your `endpoints.yml`:']\\n\\n```\\ntracker_store:\\n type: redis\\n url: <url of the redis instance, e.g. localhost>\\n port: <port of your redis instance, usually 6379>\\n key_prefix: <alphanumeric value to prepend to tracker store keys>\\n db: <number of your database within redis, e.g. 0>\\n password: <password used for authentication>\\n use_ssl: <whether or not the communication is encrypted, default `false`>\\n```\\n\\n```\\nrasa run -m models --endpoints endpoints.yml\\n```\\n\\n['If deploying your model in Docker Compose, add the service to your `docker-compose.yml`:']\\n\\n```\\nredis:\\n image: redis:latest\\n```\\n\\nTo route requests to the new service, make sure that the `url` in your `endpoints.yml`\\nreferences the service name:\\n\\n```\\n tracker_store:\\n type: redis\\n url: <url of the redis instance, e.g. localhost>\\n port: <port of your redis instance, usually 6379>\\n db: <number of your database within redis, e.g. 0>\\n key_prefix: <alphanumeric value to prepend to tracker store keys>\\n password: <password used for authentication>\\n use_ssl: <whether or not the communication is encrypted, default `false`>\\n```\\n\\n['`url` (default: `localhost`): The url of your redis instance', '`port` (default: `6379`): The port which redis is running on', '`db` (default: `0`): The number of your redis database', '`key_prefix` (default: `None`): The prefix to prepend to tracker store keys. Must\\\\nbe alphanumeric', '`username` (default: `None`): Username used for authentication', '`password` (default: `None`): Password used for authentication\\\\n(`None` equals no authentication)', '`record_exp` (default: `None`): Record expiry in seconds', '`use_ssl` (default: `False`): whether or not to use SSL for transit encryption']\"}, \"MongoTrackerStore\": {\"Configuration\": {\"Configuration Parameters\": [\"`url` (default: `mongodb://localhost:27017`): URL of your MongoDB\", \"`db` (default: `rasa`): The database name which should be used\", \"`username` (default: `0`): The username which is used for authentication\", \"`password` (default: `None`): The password which is used for authentication\", \"`auth_source` (default: `admin`): database name associated with the user's credentials.\", \"`collection` (default: `conversations`): The collection name which is\\nused to store the conversations\"]}}, \"DynamoTrackerStore\": {\"Configuration\": {\"Configuration Parameters\": [\"`table_name` (default: `states`): name of the DynamoDB table\", \"`region` (default: `us-east-1`): name of the region associated with the client\"]}}, \"Custom Tracker Store\": {\"Configuration\": \"Put the module path to your custom tracker store and the parameters you require in your `endpoints.yml`:\\n\\n```\\ntracker_store:\\n type: path.to.your.module.Class\\n url: localhost\\n a_parameter: a value\\n another_parameter: another value\\n```\\n\\nIf you are deploying in Docker Compose, you have two options to add this store to Rasa:\\nextending the Rasa image to include the module, or mounting the module as volume.\\n\\nMake sure to add the corresponding service as well. For example, mounting it as a volume would look like so:\\n\\n```\\nrasa:\\n <existing rasa service configuration>\\n volumes:\\n - <existing volume mappings, if there are any>\\n - ./path/to/your/module.py:/app/path/to/your/module.py\\ncustom-tracker-store:\\n image: custom-image:tag\\n```\\n\\n```\\ntracker_store:\\n type: path.to.your.module.Class\\n url: custom-tracker-store\\n a_parameter: a value\\n another_parameter: another value\\n```\"}, \"Fallback Tracker Store\": \"In case the primary tracker store configured in `endpoints.yml` becomes unavailable, the rasa agent will issue an\\nerror message and fall back on the `InMemoryTrackerStore` implementation. A new dialogue session will be started for\\neach turn, which will be saved separately in the `InMemoryTrackerStore` fallback.\\n\\nAs soon as the primary tracker store comes back up, it will replace the fallback tracker store and save the\\nconversation from this point going forward. However, note that any previous states saved in the `InMemoryTrackerStore`\\nfallback will be lost.\\n\\n:::warning Using the same redis instance as lock-store and tracker store\\n\\nYou must not use the same Redis instance as both lock store and tracker store.\\nIf the Redis instance becomes unavailable, the conversation will hang because there is no fall back mechanism\\nimplemented for the lock store (as it is for the tracker store interfaces).\\n:::\"}}, \"metadata\": {\"id\": \"tracker-stores\", \"sidebar_label\": \"Tracker Stores\", \"title\": \"Tracker Stores\", \"description\": \"All conversations are stored within a tracker store. Read how Rasa provides implementations for different store types out of the box.\", \"abstract\": \"Your assistant's conversations are stored within a tracker store. Rasa provides implementations for different store types out of the box, or you can create your own custom one.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 49]\"}, {\"title\": \"Training Data Format\", \"description\": \"Description of the YAML format for training data\", \"content\": {\"Overview\": {\"High-Level Structure\": \"Each file can contain one or more **keys** with corresponding training\\ndata. One file can contain multiple keys, but each key can only appear\\nonce in a single file. The available keys are:\\n\\n['`version`', '`nlu`', '`stories`', '`rules`']\\n\\nYou should specify the `version` key in all YAML training data files.\\nIf you don't specify a version key in your training data file, Rasa\\nwill assume you are using the latest training data format specification supported\\nby the version of Rasa you have installed.\\nTraining data files with a Rasa version greater than the version you have\\ninstalled on your machine will be skipped.\\nCurrently, the latest training data format specification for Rasa 3.x is 3.1.\", \"Example\": \"Here's a short example which keeps all training data in a single file:\\n\\n```\\nversion: \\\"3.1\\\"\\n\\nnlu:\\n- intent: greet\\n examples: |\\n - Hey\\n - Hi\\n - hey there [Sara](name)\\n\\n- intent: faq/language\\n examples: |\\n - What language do you speak?\\n - Do you only handle english?\\n\\nstories:\\n- story: greet and faq\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: faq\\n - action: utter_faq\\n\\nrules:\\n- rule: Greet user\\n steps:\\n - intent: greet\\n - action: utter_greet\\n\\n```\\n\\nTo specify your test stories, you need to put them into a separate file:\\n\\n```\\nstories:\\n- story: greet and ask language\\n- steps:\\n - user: |\\n hey\\n intent: greet\\n - action: utter_greet\\n - user: |\\n what language do you speak\\n intent: faq/language\\n - action: utter_faq\\n```\\n\\n[Test stories](#test-stories) use the same format as the story training data and should be placed\\nin a separate file with the prefix `test_`.\\n\\n:::note The `|` symbol\\nAs shown in the above examples, the `user` and `examples` keys are followed by `|`\\n(pipe) symbol. In YAML `|` identifies multi-line strings with preserved indentation.\\nThis helps to keep special symbols like `\\\"`, `'` and others still available in the\\ntraining examples.\\n:::\"}, \"NLU Training Data\": {\"Training Examples\": \"Training examples are grouped by [intent](glossary.mdx#intent) and listed under the\\n`examples` key. Usually, you'll list one example per line as follows:\\n\\n```\\nnlu:\\n- intent: greet\\n examples: |\\n - hey\\n - hi\\n - whats up\\n```\\n\\nHowever, it's also possible to use an extended format if you have a custom NLU component and need metadata for your examples:\\n\\n```\\nnlu:\\n- intent: greet\\n examples:\\n - text: |\\n hi\\n metadata:\\n sentiment: neutral\\n - text: |\\n hey there!\\n```\\n\\nThe `metadata` key can contain arbitrary key-value data that is tied to an example and\\naccessible by the components in the NLU pipeline.\\nIn the example above, the sentiment metadata could be used by a custom component in\\nthe pipeline for sentiment analysis.\\n\\nYou can also specify this metadata at the intent level:\\n\\n```\\nnlu:\\n- intent: greet\\n metadata:\\n sentiment: neutral\\n examples:\\n - text: |\\n hi\\n - text: |\\n hey there!\\n```\\n\\nIn this case, the content of the `metadata` key is passed to every intent example.\\n\\nIf you want to specify [retrieval intents](glossary.mdx#retrieval-intent), then your NLU examples will look as follows:\\n\\n```\\nnlu:\\n- intent: chitchat/ask_name\\n examples: |\\n - What is your name?\\n - May I know your name?\\n - What do people call you?\\n - Do you have a name for yourself?\\n\\n- intent: chitchat/ask_weather\\n examples: |\\n - What's the weather like today?\\n - Does it look sunny outside today?\\n - Oh, do you mind checking the weather for me please?\\n - I like sunny days in Berlin.\\n```\\n\\nAll retrieval intents have a suffix\\nadded to them which identifies a particular response key for your assistant. In the\\nabove example, `ask_name` and `ask_weather` are the suffixes. The suffix is separated from\\nthe retrieval intent name by a `/` delimiter.\\n\\n:::note Special meaning of `/`\\nAs shown in the above examples, the `/` symbol is reserved as a delimiter to separate\\nretrieval intents from their associated response keys. Make sure not to use it in the\\nname of your intents.\\n:::\", \"Entities\": \"[Entities](glossary.mdx#entity) are structured pieces of information that can be extracted from a user's message.\\n\\nEntities are annotated in training examples with the entity's name.\\nIn addition to the entity name, you can annotate an entity with [synonyms](nlu-training-data.mdx#synonyms), [roles, or groups](nlu-training-data.mdx#entities-roles-and-groups).\\n\\nIn training examples, entity annotation would look like this:\\n\\n```\\nnlu:\\n- intent: check_balance\\n examples: |\\n - how much do I have on my [savings](account) account\\n - how much money is in my [checking]{\\\"entity\\\": \\\"account\\\"} account\\n - What's the balance on my [credit card account]{\\\"entity\\\":\\\"account\\\",\\\"value\\\":\\\"credit\\\"}\\n\\n```\\n\\nThe full possible syntax for annotating an entity is:\\n\\n```\\n[<entity-text>]{\\\"entity\\\": \\\"<entity name>\\\", \\\"role\\\": \\\"<role name>\\\", \\\"group\\\": \\\"<group name>\\\", \\\"value\\\": \\\"<entity synonym>\\\"}\\n```\\n\\nThe keywords `role`, `group`, and `value` are optional in this notation.\\nThe `value` field refers to synonyms. To understand what the labels `role` and `group` are\\nfor, see the section on [entity roles and groups](./nlu-training-data.mdx#entities-roles-and-groups).\", \"Synonyms\": \"Synonyms normalize your training data by mapping an\\nextracted entity to a value other than the literal text extracted.\\nYou can define synonyms using the format:\\n\\n```\\nnlu:\\n- synonym: credit\\n examples: |\\n - credit card account\\n - credit account\\n```\\n\\nYou can also define synonyms in-line in your training examples by\\nspecifying the `value` of the entity:\\n\\n```\\nnlu:\\n- intent: check_balance\\n examples: |\\n - how much do I have on my [credit card account]{\\\"entity\\\": \\\"account\\\", \\\"value\\\": \\\"credit\\\"}\\n - how much do I owe on my [credit account]{\\\"entity\\\": \\\"account\\\", \\\"value\\\": \\\"credit\\\"}\\n```\\n\\nRead more about synonyms on the [NLU Training Data page](./nlu-training-data.mdx#synonyms).\", \"Regular Expressions\": \"You can use regular expressions to improve intent classification and\\nentity extraction using the [`RegexFeaturizer`](components.mdx#regexfeaturizer) and [`RegexEntityExtractor`](components.mdx#regexentityextractor) components.\\n\\nThe format for defining a regular expression is as follows:\\n\\n```\\nnlu:\\n- regex: account_number\\n examples: |\\n - \\\\d{10,12}\\n```\\n\\nHere `account_number` is the name of the regular expression. When used as features for the `RegexFeaturizer` the name of the regular expression does not matter. When using the `RegexEntityExtractor`, the name of the regular expression should match the name of the entity you want to extract.\\n\\nRead more about when and how to use regular expressions with each component on the [NLU Training Data page](./nlu-training-data.mdx#regular-expressions).\", \"Lookup Tables\": \"Lookup tables are lists of words used to generate\\ncase-insensitive regular expression patterns. The format is as follows:\\n\\n```\\nnlu:\\n- lookup: banks\\n examples: |\\n - JPMC\\n - Bank of America\\n```\\n\\nWhen you supply a lookup table in your training data, the contents of that table\\nare combined into one large regular expression. This regex is used to check\\neach training example to see if it contains matches for entries in the\\nlookup table.\\n\\nLookup table regexes are processed identically to the regular\\nexpressions directly specified in the training data and can be used\\neither with the [RegexFeaturizer](components.mdx#regexfeaturizer)\\nor with the [RegexEntityExtractor](components.mdx#regexentityextractor).\\nThe name of the lookup table is subject to the same constraints as the\\nname of a regex feature.\\n\\nRead more about using lookup tables on the [NLU Training Data page](./nlu-training-data.mdx#lookup-tables).\"}, \"Conversation Training Data\": {\"Stories\": {\"User Messages\": \"All user messages are specified with the `intent:`\\nkey and an optional `entities:` key.\\n\\nWhile writing stories, you do not have to deal with the specific\\ncontents of the messages that the users send. Instead, you can take\\nadvantage of the output from the NLU pipeline, which uses\\na combination of an intent and entities to refer to all possible\\nmessages the users can send with the same meaning.\\n\\nUser messages follow the format:\\n\\n```\\nstories:\\n- story: user message structure\\n steps:\\n - intent: intent_name # Required\\n entities: # Optional\\n - entity_name: entity_value\\n - action: action_name\\n```\\n\\nFor example, to represent the sentence\\n`I want to check my credit balance`, where `credit` is an entity:\\n\\n```\\nstories:\\n- story: story with entities\\n steps:\\n - intent: account_balance\\n entities:\\n - account_type: credit\\n - action: action_credit_account_balance\\n```\\n\\nIt is important to include the entities here as well because the\\npolicies learn to predict the next action based on a *combination* of\\nboth the intent and entities (you can, however, change this behavior\\nusing the [`use_entities`](#entities) attribute).\", \"Actions\": \"All actions executed by the bot are specified with the `action:` key followed\\nby the name of the action.\\nWhile writing stories, you will encounter two types of actions:\\n\\n['[Responses](domain.mdx#responses): start with `utter_` and\\\\nsend a specific message to the user. e.g.']\\n\\n```\\nstories:\\n- story: story with a response\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\n['[Custom actions](custom-actions.mdx): start with `action_`, run\\\\narbitrary code and send any number of messages (or none).']\\n\\n```\\nstories:\\n- story: story with a custom action\\n steps:\\n - intent: feedback\\n - action: action_store_feedback\\n```\", \"Forms\": \"A [form](glossary.mdx#form) is a specific kind of custom action that contains the logic to loop over\\na set of required slots and ask the user for this information. You\\n[define a form](forms.mdx#defining-a-form) in the `forms` section in your domain.\\nOnce defined, you should specify the [happy path](glossary.mdx#happy--unhappy-paths)\\nfor a form as a [rule](forms.mdx). You should include interruptions of forms or\\nother \\\"unhappy paths\\\" in stories so that the model can\\ngeneralize to unseen conversation sequences.\\nAs a step in a story, a form takes the following format:\\n\\n```\\nstories:\\n- story: story with a form\\n steps:\\n - intent: find_restaurant\\n - action: restaurant_form # Activate the form\\n - active_loop: restaurant_form # This form is currently active\\n - active_loop: null # Form complete, no form is active\\n - action: utter_restaurant_found\\n```\\n\\nThe `action` step activates the form and begins looping over the required slots. The `active_loop: restaurant_form`\\nstep indicates that there is a currently active form. Much like a `slot_was_set` step,\\na `form` step doesn't **set** a form to active but indicates that it should already be activated.\\nIn the same way, the `active_loop: null` step indicates that no form should be active before the subsequent\\nsteps are taken.\\n\\nA form can be interrupted and remain active; in this case the interruption should come after the\\n`action: <form to activate>` step and be followed by the `active_loop: <active form>` step.\\nAn interruption of a form could look like this:\\n\\n```\\nstories:\\n- story: interrupted food\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - intent: chitchat\\n - action: utter_chitchat\\n - active_loop: restaurant_form\\n - active_loop: null\\n - action: utter_slots_values\\n```\", \"Slots\": \"A slot event is specified under the key `slot_was_set:` with the\\nslot name and optionally the slot's value.\\n\\n**[Slots](domain.mdx#slots)** act as the bots memory.\\nSlots are **set** by either the default action [`action_extract_slots`](./default-actions.mdx#action_extract_slots) according to the\\n[slot mappings](./domain.mdx#slot-mappings) specified in the domain, or by custom actions.\\nThey are **referenced** by stories in `slot_was_set` steps. For example:\\n\\n```\\nstories:\\n- story: story with a slot\\n steps:\\n - intent: celebrate_bot\\n - slot_was_set:\\n - feedback_value: positive\\n - action: utter_yay\\n```\\n\\nThis means the story requires that the current value for the `feedback_value`\\nslot be `positive` for the conversation to continue as specified.\\n\\nWhether or not you need to include the slot's value depends on the\\n[slot type](domain.mdx#slot-types) and whether the value can or should\\ninfluence the dialogue. If the value doesn't matter, as is the case for e.g. `text` slots,\\nyou can list only the slot's name:\\n\\n```\\nstories:\\n- story: story with a slot\\n steps:\\n - intent: greet\\n - slot_was_set:\\n - name\\n - action: utter_greet_user_by_name\\n```\\n\\nThe initial value for any slot by default is `null`, and you can use it to check if the slot was not set:\\n\\n```\\nstories:\\n- story: French cuisine\\n steps:\\n - intent: inform\\n - slot_was_set:\\n - cuisine: null\\n```\\n\\n:::note How slots work\\nStories do not **set** slots. The slot must be set by the default action `action_extract_slots` if a slot mapping applies, or custom\\naction **before** the `slot_was_set` step.\\n:::\", \"Checkpoints\": \"Checkpoints are specified with the `checkpoint:` key, either at the beginning\\nor the end of a story.\\n\\nCheckpoints are ways to connect stories together. They can be either the first\\nor the last step in a story. If they are the last step in a story, that story\\nwill be connected to each other story that starts with the checkpoint of the\\nsame name when the model is trained. Here is an example of a story that ends\\nwith a checkpoint, and one that starts with the same checkpoint:\\n\\n```\\nstories:\\n- story: story_with_a_checkpoint_1\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - checkpoint: greet_checkpoint\\n\\n- story: story_with_a_checkpoint_2\\n steps:\\n - checkpoint: greet_checkpoint\\n - intent: book_flight\\n - action: action_book_flight\\n```\\n\\nCheckpoints at the beginning of stories can also be conditional on\\nslots being set, for example:\\n\\n```\\nstories:\\n- story: story_with_a_conditional_checkpoint\\n steps:\\n - checkpoint: greet_checkpoint\\n # This checkpoint should only apply if slots are set to the specified value\\n slot_was_set:\\n - context_scenario: holiday\\n - holiday_name: thanksgiving\\n - intent: greet\\n - action: utter_greet_thanksgiving\\n```\\n\\nCheckpoints can help simplify your training data and reduce redundancy in it,\\nbut **do not overuse them**. Using lots of checkpoints can quickly make your\\nstories hard to understand. It makes sense to use them if a sequence of steps\\nis repeated often in different stories, but stories without checkpoints\\nare easier to read and write.\", \"OR statement\": \"`or` steps are ways to handle multiple intents or slot events the same way,\\nwithout writing a separate story for each intent. For example, if you ask the user to\\nconfirm something, you might want to treat the `affirm` and `thankyou` intents in the\\nsame way. Stories with `or` steps will be converted into multiple\\nseparate stories at training time.\\nFor example, the following story would be converted to two stories at training time:\\n\\n```\\nstories:\\n- story: story with OR\\n steps:\\n - intent: signup_newsletter\\n - action: utter_ask_confirm\\n - or:\\n - intent: affirm\\n - intent: thanks\\n - action: action_signup_newsletter\\n```\\n\\nYou can also use `or` statements with slot events.\\nThe following means the story requires that the current value for\\nthe `name` slot is set and is either `joe` or `bob`. This story\\nwould be converted to two stories at training time.\\n\\n```\\nstories:\\n- story:\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: tell_name\\n - or:\\n - slot_was_set:\\n - name: joe\\n - slot_was_set:\\n - name: bob\\n # ... next actions\\n```\\n\\nJust like checkpoints, OR statements can be useful, but if you are using a lot of them,\\nit is probably better to restructure your domain and/or intents.\\n\\n:::warning Don't overuse\\nOverusing these features (both checkpoints and OR statements) will slow down training.\\n:::\"}, \"Rules\": \"Rules are listed under the `rules` key and look similar to stories. A rule also has a `steps`\\nkey, which contains a list of the same steps as stories do. Rules can additionally\\ncontain the `conversation_started` and `conditions` keys. These are used to specify conditions\\nunder which the rule should apply.\\n\\nA rule that with a condition looks like this:\\n\\n```\\nrules:\\n- rule: Only say `hey` when the user provided a name\\n condition:\\n - slot_was_set:\\n - user_provided_name: true\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nFor more information about writing rules, see [Rules](rules.mdx#writing-a-rule).\"}, \"Test Stories\": \"Test stories check if a message is classified correctly as well as the action predictions.\\n\\nTest stories use the same format as [stories](#stories),\\nexcept that user message steps can include a `user` to specify the actual\\ntext and entity annotations of the user message. Here's an example of a\\ntest story:\\n\\n```\\nstories:\\n- story: A basic end-to-end test\\n steps:\\n - user: |\\n hey\\n intent: greet\\n - action: utter_ask_howcanhelp\\n - user: |\\n show me [chinese]{\\\"entity\\\": \\\"cuisine\\\"} restaurants\\n intent: inform\\n - action: utter_ask_location\\n - user: |\\n in [Paris]{\\\"entity\\\": \\\"location\\\"}\\n intent: inform\\n - action: utter_ask_price\\n```\\n\\nYou can run the tests using the following command:\\n\\n```\\nrasa test\\n```\\n\\nIf you want to know more about testing head over to\\n[Testing Your Assistant](testing-your-assistant.mdx).\", \"End-to-end Training\": \":::info New in 2.2\\nEnd-to-end training is an experimental feature.\\nWe introduce experimental features to get feedback from our community, so we encourage you to try it out!\\nHowever, the functionality might be changed or removed in the future.\\nIf you have feedback (positive or negative) please share it with us on the [Rasa Forum](https://forum.rasa.com).\\n\\n:::\\n\\nWith [end-to-end training](stories.mdx#end-to-end-training), you do not have to deal with the specific\\nintents of the messages that are extracted by the NLU pipeline.\\nInstead, you can put the text of the user message directly in the stories,\\nby using `user` key.\\n\\nThese end-to-end user messages follow the format:\\n\\n```\\nstories:\\n- story: user message structure\\n steps:\\n - user: the actual text of the user message\\n - action: action_name\\n```\\n\\nIn addition, you can add entity tags that can be extracted\\nby the [TED Policy](./policies.mdx#ted-policy).\\nThe syntax for entity tags is the same as in\\n[the NLU training data](./training-data-format.mdx#entities).\\nFor example, the following story contains the user utterance\\n` I can always go for sushi`. By using the syntax from the NLU training data\\n`[sushi](cuisine)`, you can mark `sushi` as an entity of type `cuisine`.\\n\\n```\\nstories:\\n- story: story with entities\\n steps:\\n - user: I can always go for [sushi](cuisine)\\n - action: utter_suggest_cuisine\\n```\\n\\nSimilarly, you can put bot utterances directly in the stories,\\nby using the `bot` key followed by the text that you want your bot to say.\\n\\nA story with only a bot utterance might look like this:\\n\\n```\\nstories:\\n- story: story with an end-to-end response\\n steps:\\n - intent: greet\\n entities:\\n - name: Ivan\\n - bot: Hello, a person with a name!\\n```\\n\\nYou can also have a mixed end-to-end story:\\n\\n```\\nstories:\\n- story: full end-to-end story\\n steps:\\n - intent: greet\\n entities:\\n - name: Ivan\\n - bot: Hello, a person with a name!\\n - intent: search_restaurant\\n - action: utter_suggest_cuisine\\n - user: I can always go for [sushi](cuisine)\\n - bot: Personally, I prefer pizza, but sure let's search sushi restaurants\\n - action: utter_suggest_cuisine\\n - user: Have a beautiful day!\\n - action: utter_goodbye\\n```\\n\\nRasa end-to-end training is fully integrated with standard Rasa approach.\\nIt means that you can have mixed stories with some steps defined by actions or intents\\nand other steps defined directly by user messages or bot responses.\"}, \"metadata\": {\"id\": \"training-data-format\", \"sidebar_label\": \"Training Data Format\", \"title\": \"Training Data Format\", \"description\": \"Description of the YAML format for training data\", \"abstract\": \"This page describes the different types of training data that go into a Rasa assistant and how this training data is structured.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 50]\"}, {\"title\": \"Training Data Importers\", \"description\": \"Change the way Rasa imports training data by replacing the default importer or writing your own importer.\", \"content\": {\"RasaFileImporter (default)\": \"By default Rasa uses the importer `RasaFileImporter`. If you want to use it on its\\nown, you don't have to specify anything in your configuration file.\\nIf you want to use it together with other importers, add it to your\\nconfiguration file:\\n\\n```\\nimporters:\\n- name: \\\"module.CustomImporter\\\"\\n parameter1: \\\"value\\\"\\n parameter2: \\\"value2\\\"\\n- name: \\\"RasaFileImporter\\\"\\n```\", \"MultiProjectImporter (experimental)\": \":::info New in 1.3\\nThis feature is currently experimental and might change or be removed in the future.\\nShare your feedback on it in the [forum](https://forum.rasa.com) to help\\nus making this feature ready for production.\\n\\n:::\\n\\nWith this importer you can train a model by combining multiple\\nreusable Rasa projects.\\nYou might, for example, handle chitchat with one project and greet your users with\\nanother. These projects can be developed in isolation, and then combined when you train\\nyour assistant.\\n\\nFor example, consider the following directory structure:\\n\\n```\\n.\\n\\u251c\\u2500\\u2500 config.yml\\n\\u2514\\u2500\\u2500 projects\\n \\u251c\\u2500\\u2500 GreetBot\\n \\u2502\\u00a0\\u00a0 \\u251c\\u2500\\u2500 data\\n \\u2502\\u00a0\\u00a0 \\u2502\\u00a0\\u00a0 \\u251c\\u2500\\u2500 nlu.yml\\n \\u2502\\u00a0\\u00a0 \\u2502\\u00a0\\u00a0 \\u2514\\u2500\\u2500 stories.yml\\n \\u2502\\u00a0\\u00a0 \\u2514\\u2500\\u2500 domain.yml\\n \\u2514\\u2500\\u2500 ChitchatBot\\n \\u251c\\u2500\\u2500 config.yml\\n \\u251c\\u2500\\u2500 data\\n \\u2502\\u00a0\\u00a0 \\u251c\\u2500\\u2500 nlu.yml\\n \\u2502\\u00a0\\u00a0 \\u2514\\u2500\\u2500 stories.yml\\n \\u2514\\u2500\\u2500 domain.yml\\n```\\n\\nHere the contextual AI assistant imports the `ChitchatBot` project which in turn\\nimports the `GreetBot` project. Project imports are defined in the configuration files of\\neach project.\\n\\nTo instruct Rasa to use the `MultiProjectImporter` module, you need add it to the `importers` list in your root `config.yml`.\\n\\n```\\nimporters:\\n- name: MultiProjectImporter\\n```\\n\\nThen, in the same file, specify which projects you want to import by adding them to the `imports` list.\\n\\n```\\nimports:\\n- projects/ChitchatBot\\n```\\n\\nThe configuration file of the `ChitchatBot` needs to reference `GreetBot`:\\n\\n```\\nimports:\\n- ../GreetBot\\n```\\n\\nSince the `GreetBot` project does not specify further project to import, it doesn't need a `config.yml`.\\n\\nRasa uses paths relative from the configuration file to import projects.\\nThese can be anywhere on your filesystem where file access is permitted.\\n\\nDuring the training process Rasa will import all required training files, combine\\nthem, and train a unified AI assistant. The training data is merged at\\nruntime, so no additional training data files are created.\\n\\n:::caution Policies and NLU Pipelines\\nRasa will use the policy and NLU pipeline configuration of the root project\\ndirectory during training. **Policy and NLU configurations of imported projects\\nwill be ignored.**\\n\\n:::\\n\\n:::caution watch out for merging\\nEqual intents, entities, slots, responses, actions and forms will be merged,\\ne.g. if two projects have training data for an intent `greet`,\\ntheir training data will be combined.\\n\\n:::\", \"Writing a Custom Importer\": \"If you are writing a custom importer, this importer has to implement the interface of\\n[`TrainingDataImporter`](reference/rasa/shared/importers/importer.md#trainingdataimporter-objects):\\n\\n```\\nfrom typing import Optional, Text, Dict, List, Union\\n\\nimport rasa\\nfrom rasa.shared.core.domain import Domain\\nfrom rasa.shared.nlu.interpreter import RegexInterpreter\\nfrom rasa.shared.core.training_data.structures import StoryGraph\\nfrom rasa.shared.importers.importer import TrainingDataImporter\\nfrom rasa.shared.nlu.training_data.training_data import TrainingData\\n\\n\\nclass MyImporter(TrainingDataImporter):\\n \\\"\\\"\\\"Example implementation of a custom importer component.\\\"\\\"\\\"\\n\\n def __init__(\\n self,\\n config_file: Optional[Text] = None,\\n domain_path: Optional[Text] = None,\\n training_data_paths: Optional[Union[List[Text], Text]] = None,\\n **kwargs: Dict\\n ):\\n \\\"\\\"\\\"Constructor of your custom file importer.\\n\\n Args:\\n config_file: Path to configuration file from command line arguments.\\n domain_path: Path to domain file from command line arguments.\\n training_data_paths: Path to training files from command line arguments.\\n **kwargs: Extra parameters passed through configuration in configuration file.\\n \\\"\\\"\\\"\\n\\n pass\\n\\n def get_domain(self) -> Domain:\\n path_to_domain_file = self._custom_get_domain_file()\\n return Domain.load(path_to_domain_file)\\n\\n def _custom_get_domain_file(self) -> Text:\\n pass\\n\\n def get_stories(\\n self,\\n interpreter: \\\"NaturalLanguageInterpreter\\\" = RegexInterpreter(),\\n exclusion_percentage: Optional[int] = None,\\n ) -> StoryGraph:\\n from rasa.shared.core.training_data.story_reader.yaml_story_reader import (\\n YAMLStoryReader,\\n )\\n\\n path_to_stories = self._custom_get_story_file()\\n return YAMLStoryReader.read_from_file(path_to_stories, self.get_domain())\\n\\n def _custom_get_story_file(self) -> Text:\\n pass\\n\\n def get_config(self) -> Dict:\\n path_to_config = self._custom_get_config_file()\\n return rasa.utils.io.read_config_file(path_to_config)\\n\\n def _custom_get_config_file(self) -> Text:\\n pass\\n\\n def get_nlu_data(self, language: Optional[Text] = \\\"en\\\") -> TrainingData:\\n from rasa.shared.nlu.training_data import loading\\n\\n path_to_nlu_file = self._custom_get_nlu_file()\\n return loading.load_data(path_to_nlu_file)\\n\\n def _custom_get_nlu_file(self) -> Text:\\n pass\\n```\"}, \"metadata\": {\"id\": \"training-data-importers\", \"sidebar_label\": \"Importers\", \"title\": \"Training Data Importers\", \"description\": \"Change the way Rasa imports training data by replacing the default importer or writing your own importer.\", \"abstract\": \"Rasa has built-in logic to collect and load training data written in Rasa format, but you can also customize how your training data gets imported using custom training data importers.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 51]\"}, {\"title\": \"Tuning Your NLU Model\", \"description\": null, \"content\": {\"How to Choose a Pipeline\": {\"Sensible Starting Pipelines\": \"If you're starting from scratch, it's often helpful to start with pretrained word embeddings.\\nPre-trained word embeddings are helpful as they already encode some kind of linguistic knowledge.\\nFor example, if you have a sentence like \\u201cI want to buy apples\\u201d in your training data, and Rasa is asked to predict\\nthe intent for \\u201cget pears\\u201d, your model already knows that the words \\u201capples\\u201d and \\u201cpears\\u201d are very similar.\\nThis is especially useful if you don't have enough training data.\\n\\nIf you are getting started with a one of [spaCy's supported languages](https://spacy.io/usage/models#languages),\\nwe recommend the following pipeline:\\n\\n```\\n```\\n\\nIt uses the [SpacyFeaturizer](./components.mdx#spacyfeaturizer), which provides \\npre-trained word embeddings (see [Language Models](./components.mdx#language-models)).\\n\\nIf you don't use any pre-trained word embeddings inside your pipeline, you are not bound to a specific language\\nand can train your model to be more domain specific.\\n\\nIf there are no word embeddings for your language or you have very domain specific terminology,\\nwe recommend using the following pipeline:\\n\\n```\\n```\\n\\nThis pipeline uses the [CountVectorsFeaturizer](./components.mdx#countvectorsfeaturizer) to train\\non only the training data you provide. This pipeline can handle any language in which words are\\nseparated by spaces. If this is not the case for your language, check out [alternatives to the \\nWhitespaceTokenizer](./components.mdx#tokenizers).\\n\\n:::note\\nIf you want to use custom components in your pipeline, see [Custom NLU Components](./components.mdx).\\n\\n:::\", \"Component Lifecycle\": \"Each component processes an input and/or creates an output. The order of the components is determined by\\nthe order they are listed in the `config.yml`; the output of a component can be used by any other component that\\ncomes after it in the pipeline. Some components only produce information used by other components\\nin the pipeline. Other components produce `output` attributes that are returned after\\nthe processing has finished.\\n\\nFor example, for the sentence `\\\"I am looking for Chinese food\\\"`, the output is:\\n\\n```\\n{\\n \\\"text\\\": \\\"I am looking for Chinese food\\\",\\n \\\"entities\\\": [\\n {\\n \\\"start\\\": 8,\\n \\\"end\\\": 15,\\n \\\"value\\\": \\\"chinese\\\",\\n \\\"entity\\\": \\\"cuisine\\\",\\n \\\"extractor\\\": \\\"DIETClassifier\\\",\\n \\\"confidence\\\": 0.864\\n }\\n ],\\n \\\"intent\\\": {\\\"confidence\\\": 0.6485910906220309, \\\"name\\\": \\\"restaurant_search\\\"},\\n \\\"intent_ranking\\\": [\\n {\\\"confidence\\\": 0.6485910906220309, \\\"name\\\": \\\"restaurant_search\\\"},\\n {\\\"confidence\\\": 0.1416153159565678, \\\"name\\\": \\\"affirm\\\"}\\n ]\\n}\\n```\\n\\nThis is created as a combination of the results of the different components in the following pipeline:\\n\\n```\\npipeline:\\n - name: WhitespaceTokenizer\\n - name: RegexFeaturizer\\n - name: LexicalSyntacticFeaturizer\\n - name: CountVectorsFeaturizer\\n - name: CountVectorsFeaturizer\\n analyzer: \\\"char_wb\\\"\\n min_ngram: 1\\n max_ngram: 4\\n - name: DIETClassifier\\n - name: EntitySynonymMapper\\n - name: ResponseSelector\\n```\\n\\nFor example, the `entities` attribute here is created by the `DIETClassifier` component.\\n\\nEvery component can implement several methods from the `Component` base class; in a pipeline these different methods\\nwill be called in a specific order. Assuming we added the following pipeline to our `config.yml`:\\n\\n```\\npipeline:\\n - name: \\\"Component A\\\"\\n - name: \\\"Component B\\\"\\n - name: \\\"Last Component\\\"\\n```\\n\\nThe image below shows the call order during the training of this pipeline:\\n\\nimport componentLifecycleImg from './component-lifecycle-img.png';\\n\\n<Image img={componentLifecycleImg} caption=\\\"Component Lifecycle\\\" alt=\\\"The component lifecycle during training. Components are processed in the order they're listed in the configuration file. All components are created and initialized in order before they are trained in order and then persisted in order.\\\" />\\n\\nBefore the first component is created using the `create` function, a so\\ncalled `context` is created (which is nothing more than a python dict).\\nThis context is used to pass information between the components. For example,\\none component can calculate feature vectors for the training data, store\\nthat within the context and another component can retrieve these feature\\nvectors from the context and do intent classification.\\n\\nInitially the context is filled with all configuration values. The arrows\\nin the image show the call order and visualize the path of the passed\\ncontext. After all components are trained and persisted, the\\nfinal context dictionary is used to persist the model's metadata.\", \"Doing Multi-Intent Classification\": {\"When to Use Multi-Intents\": \"Let's say you have a financial services bot and you have examples for intents `check_balances` and `transfer_money`:\\n\\n```\\nnlu:\\n- intent: check_balances\\n examples: |\\n - How much money do I have?\\n - what's my account balance?\\n\\n- intent: transfer_money\\n examples: |\\n - I want to transfer money to my savings account\\n - transfer money\\n```\\n\\nHowever, your bot receives incoming messages like this one, which combine both intents:\\n\\n<Chat caption=\\\"User wants to know balance in order to transfer money\\\">\\n<ChatUserText>How much money do I have? I want to transfer some to savings.</ChatUserText>\\n</Chat>\\n\\nIf you see enough of these examples, you can create a new intent multi-intent `check_balances+transfer_money` and add the incoming examples to it, for example:\\n\\n```\\nnlu:\\n- intent: check_balances+transfer_money\\n examples: |\\n - How much money do I have? I want to transfer some to savings.\\n - What's the balance on my account? I need to transfer some so I want to know how much I have\\n```\\n\\n:::note\\nThe model will not predict any combination of intents for which examples are not explicitly given in training data. As accounting for every possible intent combination would result in combinatorial explosion of the number of intents, you should only add those combinations of intents for which you see enough examples coming in from real users.\\n\\n:::\", \"How to Use Multi-Intents for Dialogue Management\": \"Multi-intent classification is intended to help with the downstream task of action prediction *after* a multi-intent. There are two complementary ways to use multi intents in dialogue training data:\\n\\n['Add regular stories or rules for the multi-intent. For example, given the following two rules for each individual intent: ']\\n\\n```\\nrules:\\n- rule: check account balance\\n steps:\\n - intent: check_balances\\n - action: action_check_balances\\n- rule: transfer money\\n steps:\\n - intent: transfer_money\\n - action: action_transfer_money\\n```\\n\\nYou could add another rule for the multi-intent that specifies a sequence of actions to address both intents:\\n\\n```\\nrules:\\n- rule: check balances and transfer money\\n steps:\\n - intent: check_balances+transfer_money\\n - action: action_check_balances\\n - action: action_transfer_money\\n```\\n\\n['Allow a machine-learning policy to generalize to the multi-intent scenario from single-intent stories.']\\n\\nWhen using a multi-intent, the intent is featurized for machine learning policies using multi-hot encoding. That means the featurization of `check_balances+transfer_money` will overlap with the featurization of each individual intent. Machine learning policies (like [TEDPolicy](./policies.mdx#ted-policy)) can then make a prediction based on the multi-intent even if it does not explicitly appear in any stories. It will typically act as if only one of the individual intents was present, however, so it is always a good idea to write a specific story or rule that deals with the multi-intent case.\"}, \"Comparing Pipelines\": \"Rasa gives you the tools to compare the performance of multiple pipelines on your data directly.\\nSee [Comparing NLU Pipelines](./testing-your-assistant.mdx#comparing-nlu-pipelines) for more information.\"}, \"Choosing the Right Components\": {\"Tokenization\": \"You can process whitespace-tokenized (i.e. words are separated by spaces) languages\\nwith the [WhitespaceTokenizer](./components.mdx#whitespacetokenizer). If your language is not whitespace-tokenized, you should use a different tokenizer.\\nWe support a number of different [tokenizers](./components.mdx), or you can\\ncreate your own [custom tokenizer](./components.mdx).\\n\\n:::note\\nSome components further down the pipeline may require a specific tokenizer. You can find those requirements\\non the individual components' `requires` parameter. If a required component is missing inside the pipeline, an\\nerror will be thrown.\\n\\n:::\", \"Featurization\": {\"Pre-trained Embeddings\": \"The advantage of using pre-trained word embeddings in your pipeline is that if you have a training example like:\\n\\u201cI want to buy apples\\u201d, and Rasa is asked to predict the intent for \\u201cget pears\\u201d, your model already knows that the\\nwords \\u201capples\\u201d and \\u201cpears\\u201d are very similar. This is especially useful if you don't have enough training data.\\nWe support a few components that provide pre-trained word embeddings:\\n\\n['[MitieFeaturizer](./components.mdx#mitiefeaturizer)', '[SpacyFeaturizer](./components.mdx#spacyfeaturizer)', '[ConveRTFeaturizer](./components.mdx#convertfeaturizer)', '[LanguageModelFeaturizer](./components.mdx#languagemodelfeaturizer)']\\n\\nIf your training data is in English, we recommend using the [ConveRTFeaturizer](./components.mdx#convertfeaturizer).\\nThe advantage of the [ConveRTFeaturizer](./components.mdx#convertfeaturizer) is that it doesn't treat each word of the user message independently, but\\ncreates a contextual vector representation for the complete sentence. For example, if you\\nhave a training example, like: \\u201cCan I book a car?\\u201d, and Rasa is asked to predict the intent for \\u201cI need a ride from\\nmy place\\u201d, since the contextual vector representation for both examples are already very similar, the intent classified\\nfor both is highly likely to be the same. This is also useful if you don't have enough training data.\\n\\nAn alternative to [ConveRTFeaturizer](./components.mdx#convertfeaturizer) is the [LanguageModelFeaturizer](./components.mdx#languagemodelfeaturizer) which uses pre-trained language\\nmodels such as BERT, GPT-2, etc. to extract similar contextual vector representations for the complete sentence. See\\n[LanguageModelFeaturizer](./components.mdx#languagemodelfeaturizer) for a full list of supported language models.\\n\\nIf your training data is not in English you can also use a different variant of a language model which\\nis pre-trained in the language specific to your training data.\\nFor example, there are chinese (`bert-base-chinese`) and japanese (`bert-base-japanese`) variants of the BERT model.\\nA full list of different variants of\\nthese language models is available in the\\n[official documentation of the Transformers library](https://huggingface.co/models?library=tf&sort=downloads).\\n\\n[spacynlp](./components.mdx#spacyfeaturizer) also provides word embeddings in many different languages,\\nso you can use this as another alternative, depending on the language of your training data.\", \"Supervised Embeddings\": \"If you don't use any pre-trained word embeddings inside your pipeline, you are not bound to a specific language\\nand can train your model to be more domain specific. For example, in general English, the word \\u201cbalance\\u201d is closely\\nrelated to \\u201csymmetry\\u201d, but very different to the word \\u201ccash\\u201d. In a banking domain, \\u201cbalance\\u201d and \\u201ccash\\u201d are closely\\nrelated and you'd like your model to capture that.\\nYou should only use featurizers from the category [sparse featurizers](./components.mdx#featurizers), such as\\n[CountVectorsFeaturizer](./components.mdx#countvectorsfeaturizer), [RegexFeaturizer](./components.mdx#regexfeaturizer) or [LexicalSyntacticFeaturizer](./components.mdx#lexicalsyntacticfeaturizer), if you don't want to use\\npre-trained word embeddings.\"}, \"Intent Classification / Response Selectors\": \"Depending on your data you may want to only perform intent classification, entity recognition or response selection.\\nOr you might want to combine multiple of those tasks. We support several components for each of the tasks.\\nWe recommend using [DIETClassifier](./components.mdx#dietclassifier) for intent classification and entity recognition\\nand [ResponseSelector](./components.mdx#responseselector) for response selection.\\n\\nBy default all of these components consume all available features produced in the pipeline.\\nHowever, sometimes it makes sense to restrict the features that are used by a specific component.\\nFor example, [ResponseSelector](./components.mdx#responseselector) is likely to perform better if no features from the\\n[RegexFeaturizer](./components.mdx#regexfeaturizer) or [LexicalSyntacticFeaturizer](./components.mdx#lexicalsyntacticfeaturizer) are used.\\nTo achieve that, you can do the following:\\nSet an alias for every featurizer in your pipeline via the option `alias`.\\nBy default the alias is set the the full featurizer class name, for example, `RegexFeaturizer`.\\nYou can then specify, for example, on the [ResponseSelector](./components.mdx#responseselector) via the option `featurizers` what features from\\nwhich featurizers should be used.\\nIf you don't set the option `featurizers` all available features will be used.\\n\\nHere is an example configuration file where the `DIETClassifier` is using all available features and the\\n`ResponseSelector` is just using the features from the `ConveRTFeaturizer` and the `CountVectorsFeaturizer`.\\n\\n```\\n```\", \"Entity Extraction\": \"Entity extraction involves parsing user messages for required pieces of information. Rasa\\nprovides entity extractors for custom entities as well as pre-trained ones like dates and locations.\\nHere is a summary of the available extractors and what they are best used for:\\n\\n| Component | Requires | Model | Notes |\\n|--------------------------|------------------|-------------------------------------------------|----------------------------------|\\n|`DIETClassifier` | N/A |conditional random field on top of a transformer |good for training custom entities |\\n|`CRFEntityExtractor` |sklearn-crfsuite |conditional random field |good for training custom entities |\\n|`SpacyEntityExtractor` |spaCy |averaged perceptron |provides pre-trained entities |\\n|`DucklingEntityExtractor` |running duckling |context-free grammar |provides pre-trained entities |\\n|`MitieEntityExtractor` |MITIE |structured SVM |good for training custom entities |\\n|`EntitySynonymMapper` |existing entities |N/A |maps known synonyms |\"}, \"Improving Performance\": {\"Handling Class Imbalance\": \"Classification algorithms often do not perform well if there is a large class imbalance,\\nfor example if you have a lot of training data for some intents and very little training data for others.\\nTo mitigate this problem, you can use a `balanced` batching strategy.\\nThis algorithm ensures that all classes are represented in every batch, or at least in\\nas many subsequent batches as possible, still mimicking the fact that some classes are more frequent than others.\\nBalanced batching is used by default. In order to turn it off and use a classic batching strategy include\\n`batch_strategy: sequence` in your config file.\\n\\n```\\nlanguage: \\\"en\\\"\\n\\npipeline:\\n# - ... other components\\n- name: \\\"DIETClassifier\\\"\\n batch_strategy: sequence\\n```\", \"Accessing Diagnostic Data\": \"To gain a better understanding of what your models do, you can access intermediate results of the prediction process.\\nTo do this, you need to access the `diagnostic_data` field of the [Message](./reference/rasa/shared/nlu/training_data/message.md#message-objects)\\nand [Prediction](./reference/rasa/core/policies/policy.md#policyprediction-objects) objects, which contain\\ninformation about attention weights and other intermediate results of the inference computation.\\nYou can use this information for debugging and fine-tuning, e.g. with [RasaLit](https://github.com/RasaHQ/rasalit).\\n\\nAfter you've [trained a model](.//command-line-interface.mdx#rasa-train), you can access diagnostic data for DIET, \\ngiven a processed message, like this:\\n\\n```\\nnlu_diagnostic_data = message.as_dict()[DIAGNOSTIC_DATA]\\n\\nfor component_name, diagnostic_data in nlu_diagnostic_data.items():\\n attention_weights = diagnostic_data[\\\"attention_weights\\\"]\\n print(f\\\"attention_weights for {component_name}:\\\")\\n print(attention_weights)\\n\\n text_transformed = diagnostic_data[\\\"text_transformed\\\"]\\n print(f\\\"\\\\ntext_transformed for {component_name}:\\\")\\n print(text_transformed)\\n```\\n\\nAnd you can access diagnostic data for TED like this:\\n\\n```\\nprediction = policy.predict_action_probabilities(\\n GREET_RULE, domain, RegexInterpreter()\\n)\\nprint(f\\\"{prediction.diagnostic_data.get('attention_weights')}\\\")\\n```\"}, \"Configuring Tensorflow\": {\"Deterministic Operations\": \"If you are using GPUs and have one or more sparse featurizer(s) in\\nyour pipeline, and/or use any of `TEDPolicy`, `UnexpecTEDIntentPolicy`, `DIETClassifier`,\\nor `ResponseSelector`, training and testing will fail if you set the environment variable\\n`TF_DETERMINISTIC_OPS=1`, because there are no deterministic GPU implementations of\\nunderlying tensorflow ops `tf.sparse.sparse_dense_matmul`,\\n`tf.nn.sparse_softmax_cross_entropy_with_logits`,\\nand `tf.math.unsorted_segment` ops. For more information see [here](https://github.com/tensorflow/community/blob/master/rfcs/20210119-determinism.md)\\n\\nFor the above reasons, the models are also not guaranteed to yield the exact same\\nperformance when trained on GPU across multiple runs. This even applies to situations where training is run\\nmultiple times on the same training data, with the same config\\nand random seeds set appropriately, while evaluating on a standard held-out test set.\\nInternal experiments have shown the following fluctuation in model performance when trained and evaluated on a held-out\\ntest set on a variety of datasets (experiments were run 5 times on each dataset):\\n\\n```\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Task, | Number of | Average standard | Minimum standard | Maximum standard |\\n| Metric (Range) | datasets | deviation | deviation | deviation |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Intent Classification | 11 | 0.0042 | 2.4e-5 | 0.0176 |\\n| Macro F1 (0-1) | | | | |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Entity Recognition | 7 | 0.0019 | 0.0007 | 0.0044 |\\n| Macro F1 (0-1) | | | | |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Response Selection | 2 | 0.0098 | 0.0003 | 0.0231 |\\n| Macro F1 (0-1) | | | | |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Action Selection | 5 | 0.0025 | 0.0010 | 0.0053 |\\n| Macro F1 (0-1) | | | | |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n| Conversation Success | 5 | 0.0077 | 0.0052 | 0.0103 |\\n| Accuracy (0-1) | | | | |\\n+-----------------------+------------+------------------+------------------+-------------------+\\n```\\n\\nThe above experiments were run on an Nvidia Tesla P4 GPU. You can expect similar fluctuations in\\nthe model performance when you evaluate on your dataset.\\nAcross different pipeline configurations tested, the fluctuation is more pronounced\\nwhen you use sparse featurizers in your pipeline. You can see which featurizers are sparse [here](./components.mdx#featurizers),\\nby checking the \\\"Type\\\" of a featurizer.\\n\\nModel performance on the above tasks should still be reproducible across multiple runs when\\ntrained on a CPU and none of these have changed:\\n\\n['Training data', 'Test data', 'Configuration pipeline', \\\"Random Seed in configuration's components.\\\"]\", \"Optimizing CPU Performance\": {\"Parallelizing One Operation\": \"Set `TF_INTRA_OP_PARALLELISM_THREADS` as an environment variable to specify the maximum number of threads that can be used\\nto parallelize the execution of one operation. For example, operations like `tf.matmul()` and `tf.reduce_sum` can be executed\\non multiple threads running in parallel. The default value for this variable is `0` which means TensorFlow would\\nallocate one thread per CPU core.\", \"Parallelizing Multiple Operations\": \"Set `TF_INTER_OP_PARALLELISM_THREADS` as an environment variable to specify the maximum number of threads that can be used\\nto parallelize the execution of multiple **non-blocking** operations. These would include operations that do not have a\\ndirected path between them in the TensorFlow graph. In other words, the computation of one operation does not affect the\\ncomputation of the other operation. The default value for this variable is `0` which means TensorFlow would allocate one thread per CPU core.\\n\\nTo understand more about how these two options differ from each other, refer to this\\n[stackoverflow thread](https://stackoverflow.com/questions/41233635/meaning-of-inter-op-parallelism-threads-and-intra-op-parallelism-threads/41233901#41233901).\"}, \"Optimizing GPU Performance\": {\"Limiting GPU Memory Growth\": \"TensorFlow by default blocks all the available GPU memory for the running process. This can be limiting if you are running\\nmultiple TensorFlow processes and want to distribute memory across them. To prevent Rasa from blocking all\\nof the available GPU memory, set the environment variable `TF_FORCE_GPU_ALLOW_GROWTH` to `True`.\", \"Restricting Absolute GPU Memory Available\": \"You may want to limit the absolute amount of GPU memory that can be used by a Rasa process.\\n\\nFor example, say you have two visible GPUs(`GPU:0` and `GPU:1`) and you want to allocate 1024 MB from the first GPU\\nand 2048 MB from the second GPU. You can do this by setting the environment variable `TF_GPU_MEMORY_ALLOC` to `\\\"0:1024, 1:2048\\\"`.\"}}}, \"metadata\": {\"id\": \"tuning-your-model\", \"sidebar_label\": \"Tuning Your NLU Model\", \"title\": \"Tuning Your NLU Model\", \"abstract\": \"Rasa will provide you with a suggested NLU config on initialization of the project, but as your project grows, it's likely that you will need to adjust your config to suit your training data.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 52]\"}, {\"title\": \"Handling Unexpected Input\", \"description\": null, \"content\": {\"User Interjections\": {\"Contextual Interjections\": \"Handling contextual interjections is similar to handling [contextual conversations](contextual-conversations.mdx)\\nin general.\\n\\nOne common case of contextual interjections is during slot filling for [form](forms.mdx), where the user\\nasks \\u201cWhy do you need to know that?\\u201d or \\\"Can you explain that?\\\".\\nThe response should differ for each slot. For example:\\n\\n<Chat caption=\\\"A contextual interjection\\\">\\n<ChatUserText>Hi</ChatUserText>\\n<ChatBotText>Hello! I am restaurant search assistant! How can I help?</ChatBotText>\\n<ChatUserText>I'm looking for a restaurant</ChatUserText>\\n<ChatBotText>What cuisine?</ChatBotText>\\n<ChatUserText>French</ChatUserText>\\n<ChatBotText>How many people?</ChatBotText>\\n<ChatUserText>Why do you need to know that?</ChatUserText>\\n<ChatBotText>I need to know how many people are in your party to ensure the restaurant can accomodate you.</ChatBotText>\\n<ChatBotText>How many people?</ChatBotText>\\n</Chat>\\n\\nSince we want the `requested_slot` to influence the conversation,\\nwe need to set the property `influence_conversation` of the slot `requested_slot`\\nto `true`, and assign it the categorical type:\\n\\n```\\nslots:\\n requested_slot:\\n type: categorical\\n values:\\n - cuisine\\n - num_people\\n - outdoor_seating\\n - preferences\\n - feedback\\n influence_conversation: true\\n mappings:\\n - type: custom\\n```\\n\\nThis means that the dialogue model will pay attention to the value of the slot when making a prediction\\n(read more about how [slots influence the assistant's behaviour](./domain.mdx#slots-and-conversation-behavior)).\\n\\nYou can then write stories for specific responses to interjections based on the value of `requested_slot`, for example:\\n\\n```\\nstories:\\n- story: cuisine interjection\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - slot_was_set:\\n - requested_slot: cuisine\\n - intent: explain\\n - action: utter_explain_cuisine\\n - action: restaurant_form\\n\\n- story: number of people interjection\\n steps:\\n - intent: request_restaurant\\n - action: restaurant_form\\n - active_loop: restaurant_form\\n - slot_was_set:\\n - requested_slot: num_people\\n - intent: explain\\n - action: utter_explain_num_people\\n - action: restaurant_form\\n```\"}, \"Summary\": \"How you handle unexpected input depends on whether the response should be\\ncontext sensitive or not.\\n\\nFor generic interjections:\\n\\n['[ ] Define rules for single-turn interactions', '[ ] Use the ResponseSelector for [FAQ and chitchat interruptions](chitchat-faqs.mdx)']\\n\\nFor contextual interjections:\\n\\n['[ ] Make `requested_slot` a categorical slot (for forms)', '[ ] Write stories for context-specific responses to interjections, using slot values where applicable']\"}, \"metadata\": {\"id\": \"unexpected-input\", \"sidebar_label\": \"Handling Unexpected Input\", \"title\": \"Handling Unexpected Input\", \"abstract\": \"One thing you can count on when building a conversational assistant is that users will say unexpected things. This page is a guide on handling unexpected input.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 53]\"}, {\"title\": \"Writing Conversation Data\", \"description\": null, \"content\": {\"Designing Stories\": \"When designing stories, there are two groups of conversational interactions that need\\nto be accounted for: happy and unhappy paths. Happy paths describe when the user is\\nfollowing the conversation flow as you'd expect and always providing the necessary\\ninformation when prompted. However, users will often deviate from happy\\npaths with questions, chit chat, or other asks. We call these unhappy path.\\n\\nIt's important for your bot to handle unhappy paths gracefully, but it's also impossible\\nto predict what path a given user might take.\\nOften, developers will try to account for every possible diverging path when designing\\nunhappy paths. Planning for every possible state in a state machine (many of which will never be reached)\\nrequires a lot of extra work and increases training time significantly.\\n\\nInstead, we recommend taking a [conversation-driven development](./conversation-driven-development.mdx)\\napproach when designing unhappy paths.\\nConversation-Driven Development promotes sharing your bot as early as possible with test users and\\ncollecting real conversation data that tells you exactly how users diverge from the\\nhappy paths. From this data, you can create stories to accomplish what the user is\\nrequesting and start to think about ways to guide them back into a happy path.\", \"When to Write Stories vs. Rules\": \"[Rules](./rules.mdx) are a type of training data used by the dialogue manager for\\nhandling pieces of conversations that should always follow the same path.\\n\\nRules can be useful when implementing:\\n\\n['[One-turn interactions](./chitchat-faqs.mdx): Some messages do not require any context to answer them.\\\\nRules are an easy way to map intents to responses, specifying fixed answers to these messages.', '[Fallback behavior](./fallback-handoff.mdx):\\\\nIn combination with the [FallbackClassifier](./components.mdx#fallbackclassifier),\\\\nyou can write rules to respond to low-confidence user messages with a certain fallback behavior.', '[Forms](./forms.mdx): Both activating and submitting a form will often follow a fixed path.\\\\nYou can also write rules to handle [unexpected input](./unexpected-input.mdx) during a form.']\\n\\nBecause rules do not generalize to unseen conversations, you should reserve them for\\nsingle-turn conversation snippets, and use stories to train on multi-turn\\nconversations.\\n\\nAn example of a rule where the bot returns a fixed response \\\"utter_greet\\\" to a user\\nmessage with intent \\\"greet\\\" would be:\\n\\n```\\nrules:\\n- rule: Greeting Rule\\n steps:\\n - intent: greet\\n - action: utter_greet\\n```\\n\\nFor multiple-turn interactions, you should define a story, for example:\\n\\n```\\nstories:\\n - story: Greeting and ask user how they're doing\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - action: utter_ask_how_doing\\n - intent: doing_great\\n - action: utter_happy\\n```\", \"Managing the Conversation Flow\": {\"When to Use Slots to Influence Conversations\": \"Slots act as your bot\\u2019s memory. When you define a slot, you can define whether a\\n[slot](domain.mdx#slots) should influence the conversation or not.\\nSlots with the property `influence_conversation` set to `false` can only store\\ninformation. Slots with the property `influence_conversation` set to `true` can affect\\nthe dialogue flow based on the information stored in it.\\n\\nSlots can be set after every user message based on [slot mappings](./domain.mdx#slot-mappings).\\nThey can also be set by a [custom action](./actions.mdx) run in response to a user message.\\nAll slots which influence the conversation need to be added to your stories or rules.\\nFor example, you can use a boolean slot set by a custom action to control the dialogue\\nflow based on its value using the following stories:\\n\\n```\\nstories:\\n- story: Welcome message, premium user\\n steps:\\n - intent: greet\\n - action: action_check_profile\\n - slot_was_set:\\n - premium_account: true\\n - action: utter_welcome_premium\\n\\n- story: Welcome message, basic user\\n steps:\\n - intent: greet\\n - action: action_check_profile\\n - slot_was_set:\\n - premium_account: false\\n - action: utter_welcome_basic\\n - action: utter_ask_upgrade\\n```\\n\\nIn cases where you don't want a slot to affect the conversation flow, you should\\nset the slot's property `influence_conversation` to `false`. You do not need to\\ninclude `slot_was_set` events for slots in your stories which do not influence the\\nconversation.\", \"Implementing Branching Logic\": \"When writing stories, sometimes the next action will depend on a value returned in one of your custom\\nactions. In these cases, it's important to find the right balance between returning slots and\\nusing custom action code directly to affect what your bot does next.\\n\\nIn cases where a value is used only to determine the bot's response, consider embedding the\\ndecision logic inside a custom action as opposed to using a featurized slot in your\\nstories. This can help reduce overall complexity and make your stories easier to manage.\\n\\nFor example, you can convert these stories:\\n\\n```\\nstories:\\n- story: It's raining now\\n steps:\\n - intent: check_for_rain\\n - action: action_check_for_rain\\n - slot_was_set:\\n - raining: true\\n - action: utter_is_raining\\n - action: utter_bring_umbrella\\n\\n- story: It isn't raining now\\n steps:\\n - intent: check_for_rain\\n - action: action_check_for_rain\\n - slot_was_set:\\n - raining: false\\n - action: utter_not_raining\\n - action: utter_no_umbrella_needed\\n```\\n\\ninto a single story:\\n\\n```\\nstories:\\n- story: check for rain\\n steps:\\n - intent: check_for_rain\\n - action: action_check_for_rain\\n```\\n\\nwith the custom action code:\\n\\n```\\ndef run(self, dispatcher, tracker, domain):\\n is_raining = check_rain()\\n if is_raining:\\n dispatcher.utter_message(template=\\\"utter_is_raining\\\")\\n dispatcher.utter_message(template=\\\"utter_bring_umbrella\\\")\\n else:\\n dispatcher.utter_message(template=\\\"utter_not_raining\\\")\\n dispatcher.utter_message(template=\\\"utter_no_umbrella_needed\\\")\\n return []\\n```\\n\\nIn cases where the value is used to influence the action flow going forward,\\nreturn a featurized slot to determine the stories. For example, if you want to collect\\ninformation about new users, but not returning ones, your stories might look like this:\\n\\n```\\nstories:\\n- story: greet new user\\n steps:\\n - intent: greet\\n - action: check_user_status\\n - slot_was_set:\\n - new_user: true\\n - action: utter_greet\\n - action: new_user_form\\n - active_loop: new_user_form\\n - active_loop: null\\n\\n- story: greet returning user\\n steps:\\n - intent: greet\\n - action: check_user_status\\n - slot_was_set:\\n - new_user: false\\n - action: utter_greet\\n - action: utter_how_can_help\\n```\", \"Using OR statements and Checkpoints\": {\"OR statements\": \"In stories where different intents or slot events are handled by your bot in the same way,\\nyou can use OR statements as an alternative to creating a new story.\\n\\nFor example, you can merge these two stories:\\n\\n```\\nstories:\\n- story: newsletter signup\\n steps:\\n - intent: signup_newsletter\\n - action: utter_ask_confirm_signup\\n - intent: affirm\\n - action: action_signup_newsletter\\n\\n- story: newsletter signup, confirm via thanks\\n steps:\\n - intent: signup_newsletter\\n - action: utter_ask_confirm_signup\\n - intent: thanks\\n - action: action_signup_newsletter\\n```\\n\\ninto a single story with an OR statement:\\n\\n```\\nstories:\\n- story: newsletter signup with OR\\n steps:\\n - intent: signup_newsletter\\n - action: utter_ask_confirm_signup\\n - or:\\n - intent: affirm\\n - intent: thanks\\n - action: action_signup_newsletter\\n```\\n\\nAt training time, this story will be split into the two original stories.\\n\\n:::caution consider restructuring data\\nIf you notice that you are using OR statements frequently\\nin your stories, consider restructuring your intents to reduce their granularity and\\nmore broadly capture user messages.\\n:::\", \"Checkpoints\": \"Checkpoints are useful for modularizing your stories into separate blocks that are\\nrepeated often. For example, if you want your bot to ask for user feedback at the end of\\neach conversation flow, you can use a checkpoint to avoid having to include the feedback\\ninteraction at the end of each story:\\n\\n```\\nstories:\\n- story: beginning of conversation\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: goodbye\\n - action: utter_goodbye\\n - checkpoint: ask_feedback\\n\\n- story: user provides feedback\\n steps:\\n - checkpoint: ask_feedback\\n - action: utter_ask_feedback\\n - intent: inform\\n - action: utter_thank_you\\n - action: utter_anything_else\\n\\n- story: user doesn't have feedback\\n steps:\\n - checkpoint: ask_feedback\\n - action: utter_ask_feedback\\n - intent: deny\\n - action: utter_no_problem\\n - action: utter_anything_else\\n```\\n\\n:::warning do not overuse\\nCheckpoints are meant to make it easier to re-use certain sections of conversation in lots\\nof different stories. We highly discourage using checkpoints inside existing checkpoints,\\nas this increases training time significantly and makes your stories difficult to understand.\\n:::\"}, \"Creating Logical Breaks in Stories\": \"When designing conversation flows, it is often tempting to create long story\\nexamples that capture a complete conversational interaction from start to finish.\\nIn many cases, this will increase the number of training stories required\\nto account for branching paths. Instead, consider separating your\\nlonger stories into smaller conversational blocks that handle sub-tasks.\\n\\nA happy path story for handling a lost credit card might look like:\\n\\n```\\nstories:\\n- story: Customer loses a credit card, reviews transactions, and gets a new card\\n steps:\\n - intent: card_lost\\n - action: check_transactions\\n - slot_was_set:\\n - reviewed_transactions: [\\\"starbucks\\\"]\\n - action: utter_ask_fraudulent_transactions\\n - intent: inform\\n - action: action_update_transactions\\n - intent: affirm\\n - action: utter_confirm_transaction_dispute\\n - action: utter_replace_card\\n - action: mailing_address_form\\n - active_loop: mailing_address\\n - active_loop: null\\n - action: utter_sent_replacement\\n - action: utter_anything_else\\n - intent: affirm\\n - action: utter_help\\n```\\n\\nHandling a lost credit card involves a series of sub-tasks, namely\\nchecking spending history for fraudulent transactions, confirming a mailing\\naddress for a replacement card, and then following up with the user\\nwith any additional requests. In this conversation arc, there are\\nseveral places where the bot prompts for user input, creating\\nbranching paths that need to be accounted for.\\n\\nFor example, when prompted with \\\"utter_ask_fraudulent_transactions\\\",\\nthe user might respond with a \\\"deny\\\" intent if none are applicable.\\nThe user might also choose to respond with a \\\"deny\\\" intent when asked\\nif there's anything else the bot can help them with.\\n\\nWe can separate out this long story into several smaller stories as:\\n\\n```\\nstories:\\n- story: Customer loses a credit card\\n steps:\\n - intent: card_lost\\n - action: utter_card_locked\\n - action: spending_history_form\\n - active_loop: spending_history_form\\n - active_loop: null\\n - slot_was_set:\\n - reviewed_transactions: [\\\"starbucks\\\"]\\n - action: utter_ask_fraudulent_transactions\\n\\n- story: Customer reviews transactions and gets a new card\\n steps:\\n - action: utter_ask_fraudulent_transactions\\n - intent: inform\\n - action: action_update_transactions\\n - slot_was_set:\\n - reviewed_transactions: [\\\"target\\\", \\\"starbucks\\\"]\\n - intent: affirm\\n - action: utter_confirm_transaction_dispute\\n - action: utter_replace_card\\n - action: mailing_address_form\\n - active_loop: mailing_address\\n - active_loop: null\\n - action: utter_sent_replacement\\n - action: utter_anything_else\\n\\n- story: Customer has something else they need help with\\n steps:\\n - action: utter_anything_else\\n - intent: affirm\\n - action: utter_help\\n```\"}, \"Handling Context Switching\": {\"Using Rules for Context Switching\": \"In some cases, such as single-turn interjections, you can handle context-switching\\nusing [rules](./rules.mdx) instead of through [stories](./stories.mdx).\\n\\nConsider this conversation scenario:\\n\\n<Chat caption=\\\"A single-turn interjection\\\">\\n<ChatUserText>Hi, I want to pay my credit card bill</ChatUserText>\\n<ChatBotText>Can do! Which of these credit accounts do you want to make a payment towards?</ChatBotText>\\n<ChatBotText><p>- Credit Account A</p>\\n\\n<p>- Credit Account B</p></ChatBotText>\\n<ChatUserText>Credit account B</ChatUserText>\\n<ChatBotText>How much do you want to pay?</ChatBotText>\\n<ChatUserText>What's my account balance?</ChatUserText>\\n<ChatBotText>Your current account balance is $1532.00</ChatBotText>\\n<ChatBotText>How much do you want to pay?</ChatBotText>\\n<ChatUserText>I want to pay the minimum balance</ChatUserText>\\n</Chat>\\n\\nIn this example, the user is in the middle of paying their credit card bill, asks for\\ntheir account balance, and is then guided back into the credit card payment form.\\nBecause asking for the account balance should always get the same response regardless of context,\\nyou can create a rule that will automatically be triggered inside of an existing flow:\\n\\n```\\nrules:\\n- rule: Check my account balance\\n steps:\\n - intent: check_account_balance\\n - action: action_get_account_balance\\n```\\n\\nBy default, the form will continue to stay active and re-prompt for the necessary\\ninformation, without having to create an additional training story.\", \"Using Stories for Context Switching\": \"You'll need to write additional stories for handling context switching when the\\nuser's interjection requires multiple conversation turns. If you have two distinct\\nconversational flows and want the user to be able to switch between the flows, you will\\nneed to create stories that specify how the switching will occur and how the context\\nis maintained.\\n\\nFor example, if you want to switch context upon a user ask and then return to the\\noriginal flow after that ask is complete:\\n\\n<Chat caption=\\\"A contextual interjection\\\">\\n<ChatUserText>Hi, I want to pay my credit card bill</ChatUserText>\\n<ChatBotText>Can do! Which of these credit accounts do you want to make a payment towards?</ChatBotText>\\n<ChatBotText><p>- Credit Account A</p>\\n\\n<p>- Credit Account B</p></ChatBotText>\\n<ChatUserText>Credit account B</ChatUserText>\\n<ChatBotText>How much do you want to pay?</ChatBotText>\\n<ChatUserText>Actually, I want to make a transfer</ChatUserText>\\n<ChatBotText>No problem!</ChatBotText>\\n<ChatBotText>Who would you like to transfer money to?</ChatBotText>\\n<ChatUserText>I want to send $500 to Katy Parrow</ChatUserText>\\n<ChatBotText>Successfully transferred $500 to Katy Parrow.</ChatBotText>\\n<ChatBotText>Would you like to pay your credit card bill now?</ChatBotText>\\n</Chat>\\n\\nYou will need to create a story that describes this context-switching interaction:\\n\\n```\\nstories:\\n- story: Context switch from credit card payment to money transfer\\n steps:\\n - intent: pay_credit_card\\n - action: credit_card_payment_form\\n - active_loop: credit_card_payment_form\\n - intent: transfer_money # - user requests a money transfer\\n - active_loop: null # - deactivate the credit card form\\n - action: transfer_money_form # - switch to the money transfer form\\n - active_loop: transfer_money_form\\n - active_loop: null\\n - action: utter_continue_credit_card_payment # - once the money transfer is completed,\\n # ask the user to return to the\\n # credit card payment form\\n```\"}, \"Managing Conversation Data Files\": \"You can provide training data to Rasa as\\na single file or as a directory containing multiple files.\\nWhen writing stories and rules, it's usually a good idea to create separate\\nfiles based on the types of conversations being represented.\\n\\nFor example, you might create a file `chitchat.yml` for handling chitchat,\\nand a `faqs.yml` file for FAQs.\\nRefer to our [rasa-demo bot](https://github.com/RasaHQ/rasa-demo)\\nfor examples of story file management in complex assistants.\", \"Using Interactive Learning\": {\"Command-line Interactive Learning\": \"The CLI command `rasa interactive` will start interactive learning on the command line.\\nIf your bot has custom actions, make sure to also\\n[run your action server](./action-server/running-action-server.mdx) in a separate terminal window.\\n\\nIn interactive mode, you will be asked to confirm every intent and action prediction\\nbefore the bot proceeds. Here's an example:\\n\\n```\\n? Next user input: hello\\n\\n? Is the NLU classification for 'hello' with intent 'hello' correct? Yes\\n\\n------\\nChat History\\n\\n # Bot You\\n\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\n 1 action_listen\\n\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\u2500\\n 2 hello\\n intent: hello 1.00\\n------\\n\\n? The bot wants to run 'utter_greet', correct? (Y/n)\\n\\n```\\n\\nYou'll be able to see the conversation history and slot values at each step of the conversation.\\n\\nIf you type ||y|| to approve a prediction, the bot will continue. If you type ||n||, you will\\nbe given the chance to correct the prediction before continuing: \\n\\n```\\n? What is the next action of the bot? (Use arrow keys)\\n \\u00bb <create new action>\\n 1.00 utter_greet\\n 0.00 ...\\n 0.00 action_back\\n 0.00 action_deactivate_loop\\n 0.00 action_default_ask_affirmation\\n 0.00 action_default_ask_rephrase\\n 0.00 action_default_fallback\\n 0.00 action_listen\\n 0.00 action_restart\\n 0.00 action_session_start\\n 0.00 action_two_stage_fallback\\n 0.00 utter_cheer_up\\n 0.00 utter_did_that_help\\n 0.00 utter_goodbye\\n 0.00 utter_happy\\n 0.00 utter_iamabot\\n```\\n\\nAt any point, you can use ||Ctrl-C|| to access the menu, allowing you to create more stories and export the \\ndata from the stories you've created so far. \\n\\n```\\n? Do you want to stop? (Use arrow keys)\\n \\u00bb Continue\\n Undo Last\\n Fork\\n Start Fresh\\n Export & Quit\\n```\"}}, \"metadata\": {\"id\": \"writing-stories\", \"sidebar_label\": \"Writing Conversation Data\", \"title\": \"Writing Conversation Data\", \"abstract\": \"Conversation data includes the stories and rules that make up the training data for your Rasa assistant's dialogue management model. Well-written conversation data allows your assistant to reliably follow conversation paths you've laid out and generalize to unexpected paths.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 54]\"}, {\"title\": \"Action Server\", \"description\": \"Documentation section: action-server\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/action-server\"}, \"subpages\": [{\"title\": \"Actions\", \"description\": null, \"content\": {\"Custom Action Input\": {\"`next_action`\": \"The `next_action` field tells your action server what action to run. \\nYour actions don't have to be implemented as classes, but they do have\\nto be callable by name. \\n\\nIn the example case, your action server should run the action `action_tell_weather`.\", \"`sender_id`\": \"The `sender_id` tells you the unique ID of the \\nuser having the conversation. Its format varies according to the input channel.\\nWhat it tells you about the user also depends on the input channel and how\\nthe user is identified by the channel. \\n\\nIn the example case, the `sender_id` is not used for anything.\", \"`tracker`\": \"The `tracker` contains information about the conversation, including a history of events\\nand a record of all slots:\\n\\n['`sender_id`: The same `sender_id` as is available in the top level of the payload', \\\"`slots`: Each slot in your bot's domain and its value at the current time\\\", '`latest_message`: The attributes of the latest message', '`latest_event_time`: The timestamp at which the last event was added to the tracker', '`followup_action`: The action called was a forced follow up action', '`paused`: Whether the conversation is currently paused', '`events`: A list of all previous [events](./events.mdx)', '`latest_input_channel`: The input channel from which the last user message was received', '`active_form`: The name of the currently active form, if any', '`latest_action_name`: The name of the last action the bot executed']\\n\\nIn the example case, your custom action uses the value of the `location` slot (if it is set)\\nto get the weather forecast. It also checks the `latest_input_channel` property\\nand formats the message payload so that it will display correctly in Facebook Messenger.\", \"`domain`\": \"The `domain` is a json representation of your `domain.yaml` file.\\nIt is unlikely that a custom action\\nwill refer to its contents, as they are static and do not indicate the state\\nof the conversation. \\n\\nYou can control if an action should receive a domain or not.\\nVisit [selective-domain](../domain.mdx#select-which-actions-should-receive-domain)\", \"`version`\": \"This is the version of the Rasa server. A custom action\\nis also unlikely to refer to this, although you might use it in a \\nverification step if your action server\\nis only compatible with certain Rasa versions.\"}, \"Custom Action Output\": {\"`events`\": \"[Events](./events.mdx) are how your action server can influence the conversation.\\nIn the example case, your custom action should store the maximum temperature \\nin the `temperature` slot, so it needs to return a [`slot` event](./events.mdx#slot). To set the\\nslot and do nothing else, your response payload would look like this:\\n\\n```\\n {\\n \\\"events\\\": [\\n {\\n \\\"event\\\": \\\"slot\\\",\\n \\\"timestamp\\\": null,\\n \\\"name\\\": \\\"temperature\\\",\\n \\\"value\\\": \\\"30\\\"\\n }\\n ],\\n \\\"responses\\\": []\\n }\\n```\\n\\nNote that events will be applied to the tracker in the order you list them; with `slot`\\nevents, the order won't matter, but with other event types it can.\", \"`responses`\": \"A response can be of any of the response types described in the\\n[documentation on rich responses](../responses.mdx#rich-responses).\\nSee the response sample of the [API spec](/pages/action-server-api) for the expected formats. \\n\\nIn the example case, you want to send the user a message with the weather forecast. \\nTo send a regular text message, the response payload would look like this:\\n\\n```\\n {\\n \\\"events\\\": [\\n {\\n \\\"event\\\": \\\"slot\\\",\\n \\\"timestamp\\\": null,\\n \\\"name\\\": \\\"temperature\\\",\\n \\\"value\\\": \\\"30\\\"\\n }\\n ],\\n \\\"responses\\\": [\\n {\\n \\\"text\\\": \\\"This is your weather forecast!\\\"\\n }\\n ]\\n }\\n```\\n\\nHowever, you want to make use of your channels' specific capabilities. Since \\nthe `latest_input_channel` was Facebook, you add a response with\\na custom payload that will be rendered as a media message according to Facebook's API spec.\\nYour response payload then looks like this:\\n\\n```\\n {\\n \\\"events\\\": [\\n {\\n \\\"event\\\": \\\"slot\\\",\\n \\\"timestamp\\\": null,\\n \\\"name\\\": \\\"temperature\\\",\\n \\\"value\\\": \\\"30\\\"\\n }\\n ],\\n \\\"responses\\\": [\\n {\\n \\\"text\\\": \\\"This is your weather forecast!\\\"\\n },\\n {\\n \\\"attachment\\\": {\\n \\\"type\\\": \\\"template\\\",\\n \\\"payload\\\": {\\n \\\"template_type\\\": \\\"media\\\",\\n \\\"elements\\\": [\\n {\\n \\\"media_type\\\": \\\"weather_forcast.gif\\\",\\n \\\"attachment_id\\\": \\\"<id from facebook upload endpoint>\\\"\\n }\\n ]\\n }\\n }\\n }\\n ]\\n }\\n```\\n\\nWhen this response is sent back to \\nthe Rasa server, Rasa will apply the `slot` event and two responses to the tracker, \\nand return both messages to the user.\"}, \"Special Action Types\": \"There are special action types that are automatically triggered under certain circumstances, namely [default actions](../default-actions.mdx)\\nand [slot validation actions](../slot-validation-actions.mdx).\\nThese special action types have predefined naming conventions that must be followed to maintain the automatic triggering behavior.\\n\\nYou can customize a default action by implementing a custom action with exactly the same name.\\nPlease see the [docs on default actions](../default-actions.mdx) for the expected behavior of each action.\\n\\nSlot validation actions are run on every user turn, depending on whether a form is active or not.\\nA slot validation action that should run when a form is not active must be called `action_validate_slot_mappings`.\\nA slot validation action that should run when a form is active must be called `validate_<form name>`.\\nThese actions are expected to return `SlotSet` events only and to behave like the Rasa SDK [`ValidationAction` class](./validation-action.mdx#validationaction-class-implementation)\\nand [`FormValidationAction` class](./validation-action.mdx#formvalidationaction-class-implementation) respectively.\"}, \"metadata\": {\"id\": \"actions\", \"sidebar_label\": \"Actions\", \"title\": \"Actions\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 0]\"}, {\"title\": \"Events\", \"description\": null, \"content\": {\"Event Types\": {\"`slot`\": \"Sets a slot on the tracker. It can set a slot to a value, \\nor reset a slot by setting its value to `null`. \\n\\n**Automatic Tracking**:\\n\\n['When a slot is filled by an entity of the same name. ']\\n\\nA custom action is needed\\nto set any slot not auto-filled by an entity. \\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"slot\\\",\\n \\\"name\\\": \\\"departure_airport\\\", \\n \\\"value\\\": \\\"BER\\\"\\n}\\n```\\n\\n**Parameters**:\\n\\n['`name`: Name of the slot to set', '`value`: Value to set the slot to. The datatype must match the [type](../domain.mdx#slot-types)\\\\nof the slot']\\n\\n**Rasa Class**: `rasa.core.events.SlotSet`\", \"`reset_slots`\": \"Resets all slots on the tracker to `null`. \\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"reset_slots\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.AllSlotsReset`\", \"`reminder`\": \"Schedules an intent to be triggered at a certain time in the future. \\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"reminder\\\",\\n \\\"intent\\\": \\\"my_intent\\\",\\n \\\"entities\\\": {\\\"entity1\\\": \\\"value1\\\", \\\"entity2\\\": \\\"value2\\\"},\\n \\\"date_time\\\": \\\"2018-09-03T11:41:10.128172\\\",\\n \\\"name\\\": \\\"my_reminder\\\",\\n \\\"kill_on_user_msg\\\": true,\\n}\\n```\\n\\n**Parameters**:\\n\\n['`intent`: Intent which the reminder will trigger ', '`entities`: Entities to send with the intent', '`date_time`: Date at which the execution of the action should be triggered. This should either be in UTC or include a timezone.', '`name`: ID of the reminder. If there are multiple reminders with the same id only the last will be run.', '`kill_on_user_msg`: Whether a user message before the trigger time will abort the reminder']\\n\\n**Rasa Class**: `rasa.core.events.ReminderScheduled`\", \"`cancel_reminder`\": \"Cancels a scheduled reminder or reminders. \\nAll reminders which match the supplied parameters will be cancelled.\\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"cancel_reminder\\\",\\n \\\"name\\\": \\\"my_reminder\\\",\\n \\\"intent\\\": \\\"my_intent\\\",\\n \\\"entities\\\": [\\n {\\\"entity\\\": \\\"entity1\\\", \\\"value\\\": \\\"value1\\\"},\\n {\\\"entity\\\": \\\"entity2\\\", \\\"value\\\": \\\"value2\\\"},\\n ],\\n \\\"date_time\\\": \\\"2018-09-03T11:41:10.128172\\\",\\n}\\n```\\n\\n**Parameters**:\\n\\n['`intent`: Intent which the reminder will trigger ', '`entities`: Entities to send with the intent', '`date_time`: Date at which the execution of the action should be triggered. This should either be in UTC or include a timezone.', '`name`: ID of the reminder.']\\n\\n**Rasa Class**: `rasa.core.events.ReminderCancelled`\", \"`pause`\": \"Stops the bot from responding to user messages. The conversation will remain paused and no actions will be predicted until the conversation is explicitly [resumed](#resume).\\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"pause\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.ConversationPaused`\", \"`resume`\": \"Resume a previously paused conversation. Once this event is added to the tracker the bot will start predicting actions again. It will not predict actions for user messages received while the conversation was paused.\\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"resume\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.ConversationResumed`\", \"`followup`\": \"Force a follow up action, bypassing action prediction. \\n\\n**Automatic Tracking**: Never\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"followup\\\",\\n \\\"name\\\": \\\"my_action\\\"\\n}\\n```\\n\\n**Parameters**:\\n\\n['`name`: The name of the follow up action that will be executed.']\\n\\n**Rasa Class**: `rasa.core.events.FollowupAction`\", \"`rewind`\": \"Reverts all side effects of the last user message and removes the last `user` event from the tracker. \\n\\n**Automatic Tracking**: \\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"rewind\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.UserUtteranceReverted`\", \"`undo`\": \"Undoes all side effects of the last bot action and removes the last bot action from the tracker. \\n\\n**Automatic Tracking**: \\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"undo\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.ActionReverted`\", \"`restart`\": \"Resets the tracker. After a `restart` event, there will be no conversation history and no record of the restart.\\n\\n**Automatic Tracking**: \\n\\n['When the `/restart` default intent is triggered.']\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"restart\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.Restarted`\", \"`session_started`\": \"Starts a new conversation by resetting the tracker and running the default action `ActionSessionStart`. This action will by default carry over existing `SlotSet` events to a new conversation session. You can configure this behaviour in your domain file under `session_config`.\\n\\n**Automatic Tracking**: \\n\\n['Whenever a user starts a conversation with the bot for the first time.', 'Whenever a session expires (after `session_expiration_time` specified in the domain), and the user resumes their conversation']\\n\\nRestarting a conversation with [`restart`](#restart) event **does not** automatically cause a `session_started` event. \\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"session_started\\\"\\n}\\n```\\n\\n**Rasa Class**: `rasa.core.events.SessionStarted`\", \"`user`\": \"The user sent a message to the bot. \\n\\n**Automatic Tracking**: \\n\\n['When the user sends a message to the bot.']\\n\\nThis event is not usually returned by a custom action.\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"user\\\",\\n \\\"text\\\": \\\"Hey\\\",\\n \\\"parse_data\\\": {\\n \\\"intent\\\": {\\n \\\"name\\\": \\\"greet\\\",\\n \\\"confidence\\\": 0.9\\n },\\n \\\"entities\\\": []\\n },\\n \\\"metadata\\\": {},\\n}\\n```\\n\\n**Parameters**:\\n\\n['`text`: Text of the user message', '`parse_data`: Parsed data of user message. This is ordinarily filled by NLU.', '`metadata`: Arbitrary metadata that comes with the user message']\\n\\n**Rasa Class**: `rasa.core.events.UserUttered`\", \"`bot`\": \"The bot sent a message to the user.\\n\\n**Automatic Tracking**: \\n\\n['Whenever `responses` are returned by a custom action', 'Whenever responses are sent to the user directly without being returned by a custom action (e.g. `utter_` actions)']\\n\\nThis event is not usually returned explicitly by a custom action; `responses` would be returned instead.\\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"bot\\\",\\n \\\"text\\\": \\\"Hey there!\\\",\\n \\\"data\\\": {}\\n}\\n```\\n\\n**Parameters**:\\n\\n['`text`: The text the bot sends to the user', '`data`: Any non-text elements of the bot response. The structure of `data` matches that of `responses` given in the [API spec](/pages/action-server-api).']\\n\\n**Rasa Class**: `rasa.core.events.BotUttered`\", \"`action`\": \"Logs an action called by the bot. Only the action itself is logged; the events that the action creates are logged separately when they are applied. \\n\\n**Automatic Tracking**: \\n\\n['Any action (including custom actions and responses) that is called, even if the action does not execute successfully.']\\n\\nThis event is not usually returned explicitly by a custom action. \\n\\n**JSON**:\\n\\n```\\n{\\n \\\"event\\\": \\\"action\\\",\\n \\\"name\\\": \\\"my_action\\\"\\n}\\n```\\n\\n**Parameters**:\\n\\n['`name`: Name of the action that was called']\\n\\n**Rasa Class**: `rasa.core.events.ActionExecuted`\"}}, \"metadata\": {\"id\": \"events\", \"sidebar_label\": \"Events\", \"title\": \"Events\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 1]\"}, {\"title\": \"Introduction to Rasa Action Server\", \"description\": null, \"content\": {\"How it works\": \"When your assistant predicts a custom action, the Rasa server sends\\na `POST` request to the action server with a json payload including\\nthe name of the predicted action,\\nthe conversation ID, the contents of the tracker and the contents of the domain.\\n\\nWhen the action server finishes running a custom action, it returns a json payload\\nof [responses](../responses.mdx) and [events](./events.mdx).\\nSee the [API spec](/pages/action-server-api) for details about the request and response payloads.\\n\\nThe Rasa server then returns the responses to the user and adds the events\\nto the conversation tracker.\", \"SDKs for Custom Actions\": {\"Rasa SDK (Python)\": \"Rasa SDK is a Python SDK for running custom actions. Besides implementing\\nthe required APIs, it offers methods for interacting with the conversation tracker\\nand composing events and responses.\\nIf you don't yet have an action server and don't need it\\nto be in a language other than Python, using the Rasa SDK will be the easiest way\\nto get started.\", \"Other Action Servers\": \"If you have legacy code or existing business logic in another language,\\nyou may not want to use the Rasa SDK. In this case you can write\\nyour own action server in any language you want. The only requirement\\nfor the action server is that it provide a `/webhook` endpoint which accepts HTTP `POST` requests\\nfrom the Rasa server and returns a payload of [events](./events.mdx) and responses.\\nSee the [API spec](/pages/action-server-api) for details about the required `/webhook` endpoint.\"}}, \"metadata\": {\"slug\": \"/action-server\", \"sidebar_label\": \"Introduction\", \"title\": \"Introduction to Rasa Action Server\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 2]\"}, {\"title\": \"Knowledge Base Actions\", \"description\": null, \"content\": {\"Using `ActionQueryKnowledgeBase`\": {\"Create a Knowledge Base\": \"The data used to answer the user's requests will be stored in a knowledge base.\\nA knowledge base can be used to store complex data structures.\\nWe suggest you get started by using the `InMemoryKnowledgeBase`.\\nOnce you want to start working with a large amount of data, you can switch to a custom knowledge base\\n(see [Creating Your Own Knowledge Base](./knowledge-base-actions.mdx#create-a-knowledge-base)).\\n\\nTo initialize an `InMemoryKnowledgeBase`, you need to provide the data in a json file.\\nThe following example contains data about restaurants and hotels.\\nThe json structure should contain a key for every object type, i.e. `\\\"restaurant\\\"` and `\\\"hotel\\\"`.\\nEvery object type maps to a list of objects \\u2013 here we have a list of 3 restaurants and a list of 3 hotels.\\n\\n```\\n{\\n \\\"restaurant\\\": [\\n {\\n \\\"id\\\": 0,\\n \\\"name\\\": \\\"Donath\\\",\\n \\\"cuisine\\\": \\\"Italian\\\",\\n \\\"outside-seating\\\": true,\\n \\\"price-range\\\": \\\"mid-range\\\"\\n },\\n {\\n \\\"id\\\": 1,\\n \\\"name\\\": \\\"Berlin Burrito Company\\\",\\n \\\"cuisine\\\": \\\"Mexican\\\",\\n \\\"outside-seating\\\": false,\\n \\\"price-range\\\": \\\"cheap\\\"\\n },\\n {\\n \\\"id\\\": 2,\\n \\\"name\\\": \\\"I due forni\\\",\\n \\\"cuisine\\\": \\\"Italian\\\",\\n \\\"outside-seating\\\": true,\\n \\\"price-range\\\": \\\"mid-range\\\"\\n }\\n ],\\n \\\"hotel\\\": [\\n {\\n \\\"id\\\": 0,\\n \\\"name\\\": \\\"Hilton\\\",\\n \\\"price-range\\\": \\\"expensive\\\",\\n \\\"breakfast-included\\\": true,\\n \\\"city\\\": \\\"Berlin\\\",\\n \\\"free-wifi\\\": true,\\n \\\"star-rating\\\": 5,\\n \\\"swimming-pool\\\": true\\n },\\n {\\n \\\"id\\\": 1,\\n \\\"name\\\": \\\"Hilton\\\",\\n \\\"price-range\\\": \\\"expensive\\\",\\n \\\"breakfast-included\\\": true,\\n \\\"city\\\": \\\"Frankfurt am Main\\\",\\n \\\"free-wifi\\\": true,\\n \\\"star-rating\\\": 4,\\n \\\"swimming-pool\\\": false\\n },\\n {\\n \\\"id\\\": 2,\\n \\\"name\\\": \\\"B&B\\\",\\n \\\"price-range\\\": \\\"mid-range\\\",\\n \\\"breakfast-included\\\": false,\\n \\\"city\\\": \\\"Berlin\\\",\\n \\\"free-wifi\\\": false,\\n \\\"star-rating\\\": 1,\\n \\\"swimming-pool\\\": false\\n },\\n ]\\n}\\n```\\n\\nOnce the data is defined in a json file, called, for example, `data.json`, you will be able use the this data file to create your\\n`InMemoryKnowledgeBase`, which will be passed to the action that queries the knowledge base.\\n\\nEvery object in your knowledge base should have at least the `\\\"name\\\"` and `\\\"id\\\"` fields to use the default implementation.\\nIf it doesn't, you'll have to [customize your InMemoryKnowledgeBase](./knowledge-base-actions.mdx#customizing-the-inmemoryknowledgebase).\", \"Define the NLU Data\": \"In this section:\\n\\n['we will introduce a new intent, `query_knowledge_base`', 'we will annotate `mention` entities so that our model detects indirect mentions of objects like \\u201cthe\\\\nfirst one\\u201d', 'we will use [synonyms](../training-data-format.mdx#synonyms) extensively']\\n\\nFor the bot to understand that the user wants to retrieve information from the knowledge base, you need to define\\na new intent. We will call it `query_knowledge_base`.\\n\\nWe can split requests that `ActionQueryKnowledgeBase` can handle into two categories:\\n(1) the user wants to obtain a list of objects of a specific type, or (2) the user wants to know about a certain\\nattribute of an object. The intent should contain lots of variations of both of these requests:\\n\\n```\\nnlu:\\n- intent: query_knowledge_base\\n examples: |\\n - what [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"} can you recommend?\\n - list some [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"}\\n - can you name some [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"} please?\\n - can you show me some [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"} options\\n - list [German](cuisine) [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"}\\n - do you have any [mexican](cuisine) [restaurants]{\\\"entity\\\": \\\"object_type\\\", \\\"value\\\": \\\"restaurant\\\"}?\\n - do you know the [price range]{\\\"entity\\\": \\\"attribute\\\", \\\"value\\\": \\\"price-range\\\"} of [that one](mention)?\\n - what [cuisine](attribute) is [it](mention)?\\n - do you know what [cuisine](attribute) the [last one]{\\\"entity\\\": \\\"mention\\\", \\\"value\\\": \\\"LAST\\\"} has?\\n - does the [first one]{\\\"entity\\\": \\\"mention\\\", \\\"value\\\": \\\"1\\\"} have [outside seating]{\\\"entity\\\": \\\"attribute\\\", \\\"value\\\": \\\"outside-seating\\\"}?\\n - what is the [price range]{\\\"entity\\\": \\\"attribute\\\", \\\"value\\\": \\\"price-range\\\"} of [Berlin Burrito Company](restaurant)?\\n - what about [I due forni](restaurant)?\\n - can you tell me the [price range](attribute) of [that restaurant](mention)?\\n - what [cuisine](attribute) do [they](mention) have?\\n```\\n\\nThe above example just shows examples related to the restaurant domain.\\nYou should add examples for every object type that exists in your knowledge base to the same `query_knowledge_base` intent.\\n\\nIn addition to adding a variety of training examples for each query type,\\nyou need to specify and annotate the following entities in your training examples:\\n\\n['`object_type`: Whenever a training example references a specific object type from your knowledge base, the object type should\\\\nbe marked as an entity. Use [synonyms](../training-data-format.mdx#synonyms) to map e.g. `restaurants` to `restaurant`, the correct\\\\nobject type listed as a key in the knowledge base.', '`mention`: If the user refers to an object via \\u201cthe first one\\u201d, \\u201cthat one\\u201d, or \\u201cit\\u201d, you should mark those terms\\\\nas `mention`. We also use synonyms to map some of the mentions to symbols. You can learn about that\\\\nin [resolving mentions](./knowledge-base-actions.mdx#resolve-mentions).', '`attribute`: All attribute names defined in your knowledge base should be identified as `attribute` in the\\\\nNLU data. Again, use synonyms to map variations of an attribute name to the one used in the\\\\nknowledge base.']\\n\\nRemember to add those entities to your domain file (as entities and slots):\\n\\n```\\nentities:\\n - object_type\\n - mention\\n - attribute\\n\\nslots:\\n object_type:\\n type: any\\n influence_conversation: false\\n mappings:\\n - type: from_entity\\n entity: object_type\\n mention:\\n type: any\\n influence_conversation: false\\n mappings:\\n - type: from_entity\\n entity: mention\\n attribute:\\n type: any\\n influence_conversation: false\\n mappings:\\n - type: from_entity\\n entity: attribute\\n```\\n\\n<a aria-hidden=\\\"true\\\" tabIndex=\\\"-1\\\" className=\\\"anchor enhancedAnchor\\\" id=\\\"create-action-query-knowledge-base\\\"></a>\", \"Create an Action to Query your Knowledge Base\": \"To create your own knowledge base action, you need to inherit `ActionQueryKnowledgeBase` and pass the knowledge\\nbase to the constructor of `ActionQueryKnowledgeBase`.\\n\\n```\\nfrom rasa_sdk.knowledge_base.storage import InMemoryKnowledgeBase\\nfrom rasa_sdk.knowledge_base.actions import ActionQueryKnowledgeBase\\n\\nclass MyKnowledgeBaseAction(ActionQueryKnowledgeBase):\\n def __init__(self):\\n knowledge_base = InMemoryKnowledgeBase(\\\"data.json\\\")\\n super().__init__(knowledge_base)\\n```\\n\\nWhenever you create an `ActionQueryKnowledgeBase`, you need to pass a `KnowledgeBase` to the constructor.\\nIt can be either an `InMemoryKnowledgeBase` or your own implementation of a `KnowledgeBase`\\n(see [Creating Your Own Knowledge Base](./knowledge-base-actions.mdx#create-a-knowledge-base)).\\nYou can only pull information from one knowledge base, as the usage of multiple knowledge bases at the same time is not supported.\\n\\nThis is the entirety of the code for this action! The name of the action is `action_query_knowledge_base`.\\nDon't forget to add it to your domain file:\\n\\n```\\nactions:\\n- action_query_knowledge_base\\n```\\n\\n:::note\\nIf you overwrite the default action name `action_query_knowledge_base`, you need to add the following three\\nunfeaturized slots to your domain file: `knowledge_base_objects`, `knowledge_base_last_object`, and\\n`knowledge_base_last_object_type`.\\nThe slots are used internally by `ActionQueryKnowledgeBase`.\\nIf you keep the default action name, those slots will be automatically added for you.\\n\\n:::\\n\\nYou also need to make sure to add a story to your stories file that includes the intent `query_knowledge_base` and\\nthe action `action_query_knowledge_base`. For example:\\n\\n```\\nstories:\\n- story: knowledge base happy path\\n steps:\\n - intent: greet\\n - action: utter_greet\\n - intent: query_knowledge_base\\n - action: action_query_knowledge_base\\n - intent: goodbye\\n - action: utter_goodbye\\n```\\n\\nThe last thing you need to do is to define the response `utter_ask_rephrase` in your domain file.\\nIf the action doesn't know how to handle the user's request, it will use this response to ask the user to rephrase.\\nFor example, add the following responses to your domain file:\\n\\n```\\nresponses:\\n utter_ask_rephrase:\\n - text: \\\"Sorry, I'm not sure I understand. Could you rephrase it?\\\"\\n - text: \\\"Could you please rephrase your message? I didn't quite get that.\\\"\\n```\\n\\nAfter adding all the relevant pieces, the action is now able to query the knowledge base.\"}, \"How It Works\": {\"Query the Knowledge Base for Objects\": \"In order to query the knowledge base for any kind of object, the user's request needs to include the object type.\\nLet's look at an example:\\n\\nCan you please name some restaurants?\\n\\nThis question includes the object type of interest: \\u201crestaurant.\\u201d\\nThe bot needs to pick up on this entity in order to formulate a query \\u2013 otherwise the action would not know what objects the user is interested in.\\n\\nWhen the user says something like:\\n\\nWhat Italian restaurant options in Berlin do I have?\\n\\nThe user wants to obtain a list of restaurants that (1) have Italian cuisine and (2) are located in\\nBerlin. If the NER detects those attributes in the request of the user, the action will use those to filter the\\nrestaurants found in the knowledge base.\\n\\nIn order for the bot to detect these attributes, you need to mark \\u201cItalian\\u201d and \\u201cBerlin\\u201d as entities in the NLU data:\\n\\n```\\nintents:\\n- intent: query_knowledge_base\\n examples: |\\n - What [Italian](cuisine) [restaurant](object_type) options in [Berlin](city) do I have?.\\n```\\n\\nThe names of the attributes, \\u201ccuisine\\u201d and \\u201ccity,\\u201d should be equal to the ones used in the knowledge base.\\nYou also need to add those as entities and slots to the domain file.\", \"Query the Knowledge Base for an Attribute of an Object\": \"If the user wants to obtain specific information about an object, the request should include both the object and\\nattribute of interest.\\n\\n:::info New in 3.6\\nThe user is not required to query the knowledge base to list any kind of object prior to this.\\nThe `ActionQueryKnowledgeBase` will extract the object type from the user's request and query the knowledge base for an attribute of the object. \\n:::\\n\\nFor example, if the user asks something like:\\n\\nWhat is the cuisine of Berlin Burrito Company?\\n\\nThe user wants to obtain the \\u201ccuisine\\u201d (attribute of interest) for the restaurant \\u201cBerlin Burrito Company\\u201d (object of\\ninterest).\\n\\nThe attribute and object of interest should be marked as entities in the NLU training data:\\n\\n```\\nintents:\\n- intent: query_knowledge_base\\n examples: |\\n - What is the [cuisine](attribute) of [Berlin Burrito Company](restaurant)?\\n```\\n\\nMake sure to add the object type, \\u201crestaurant,\\u201d to the domain file as entity and slot. This will support `ActionQueryKnowledgeBase`\\nto extract the object type of the object the user is interested in.\\n\\n<a aria-hidden=\\\"true\\\" tabIndex=\\\"-1\\\" className=\\\"anchor enhancedAnchor\\\" id=\\\"resolve-mentions\\\"></a>\", \"Resolve Mentions\": \"Following along from the above example, users may not always refer to restaurants by their names.\\nUsers can either refer to the object of interest by its name, e.g. \\u201cBerlin Burrito Company\\u201d (representation string\\nof the object), or they may refer to a previously listed object via a mention, for example:\\n\\nWhat is the cuisine of the second restaurant you mentioned?\\n\\nOur action is able to resolve these mentions to the actual object in the knowledge base.\\nMore specifically, it can resolve two mention types: (1) ordinal mentions, such as \\u201cthe first one\\u201d, and (2)\\nmentions such as \\u201cit\\u201d or \\u201cthat one\\u201d.\\n\\n**Ordinal Mentions**\\n\\nWhen a user refers to an object by its position in a list, it is called an ordinal mention. Here's an example:\\n\\n['User: What restaurants in Berlin do you know?', \\\"Bot: Found the following objects of type 'restaurant': 1: I due forni 2: PastaBar 3: Berlin Burrito Company\\\", 'User: Does the first one have outside seating?']\\n\\nThe user referred to \\u201cI due forni\\u201d by the term \\u201cthe first one\\u201d.\\nOther ordinal mentions might include \\u201cthe second one,\\u201d \\u201cthe last one,\\u201d \\u201cany,\\u201d or \\u201c3\\u201d.\\n\\nOrdinal mentions are typically used when a list of objects was presented to the user.\\nTo resolve those mentions to the actual object, we use an ordinal mention mapping which is set in the\\n`KnowledgeBase` class.\\nThe default mapping looks like:\\n\\n```\\n{\\n \\\"1\\\": lambda l: l[0],\\n \\\"2\\\": lambda l: l[1],\\n \\\"3\\\": lambda l: l[2],\\n \\\"4\\\": lambda l: l[3],\\n \\\"5\\\": lambda l: l[4],\\n \\\"6\\\": lambda l: l[5],\\n \\\"7\\\": lambda l: l[6],\\n \\\"8\\\": lambda l: l[7],\\n \\\"9\\\": lambda l: l[8],\\n \\\"10\\\": lambda l: l[9],\\n \\\"ANY\\\": lambda l: random.choice(l),\\n \\\"LAST\\\": lambda l: l[-1],\\n}\\n```\\n\\nThe ordinal mention mapping maps a string, such as \\u201c1\\u201d, to the object in a list, e.g. `lambda l: l[0]`, meaning the\\nobject at index `0`.\\n\\nAs the ordinal mention mapping does not, for example, include an entry for \\u201cthe first one\\u201d,\\nit is important that you use [Entity Synonyms](../training-data-format.mdx#synonyms) to map \\u201cthe first one\\u201d in your NLU data to \\u201c1\\u201d:\\n\\n```\\nintents:\\n- intent: query_knowledge_base\\n examples: |\\n - Does the [first one]{entity: \\\"mention\\\", value\\\": 1} have [outside seating]{entity: \\\"attribute\\\", value\\\": \\\"outside-seating\\\"}\\n```\\n\\nThe NER detects \\u201cfirst one\\u201d as a `mention` entity, but puts \\u201c1\\u201d into the `mention` slot.\\nThus, our action can take the `mention` slot together with the ordinal mention mapping to resolve \\u201cfirst one\\u201d to\\nthe actual object \\u201cI due forni\\u201d.\\n\\nYou can overwrite the ordinal mention mapping by calling the function `set_ordinal_mention_mapping()` on your\\n`KnowledgeBase` implementation (see [Customizing the InMemoryKnowledgeBase](./knowledge-base-actions.mdx#customizing-the-inmemoryknowledgebase)).\\n\\n**Other Mentions**\\n\\nTake a look at the following conversation:\\n\\n['User: What is the cuisine of PastaBar?', 'Bot: PastaBar has an Italian cuisine.', 'User: Does it have wifi?', 'Bot: Yes.', 'User: Can you give me an address?']\\n\\nIn the question \\u201cDoes it have wifi?\\u201d, the user refers to \\u201cPastaBar\\u201d by the word \\u201cit\\u201d.\\nIf the NER detected \\u201cit\\u201d as the entity `mention`, the knowledge base action would resolve it to the last mentioned\\nobject in the conversation, \\u201cPastaBar\\u201d.\\n\\nIn the next input, the user refers indirectly to the object \\u201cPastaBar\\u201d instead of mentioning it explicitly.\\nThe knowledge base action would detect that the user wants to obtain the value of a specific attribute, in this case, the address.\\nIf no mention or object was detected by the NER, the action assumes the user is referring to the most recently\\nmentioned object, \\u201cPastaBar\\u201d.\\n\\nYou can disable this behavior by setting `use_last_object_mention` to `False` when initializing the action.\"}, \"Customization\": {\"Customizing `ActionQueryKnowledgeBase`\": \"You can overwrite the following two functions of `ActionQueryKnowledgeBase` if you'd like to customize what the bot\\nsays to the user:\\n\\n['`utter_objects()`', '`utter_attribute_value()`']\\n\\n`utter_objects()` is used when the user has requested a list of objects.\\nOnce the bot has retrieved the objects from the knowledge base, it will respond to the user by default with a message, formatted like:\\n\\nFound the following objects of type 'restaurant':\\n1: I due forni\\n2: PastaBar\\n3: Berlin Burrito Company\\n\\nOr, if no objects are found,\\n\\nI could not find any objects of type 'restaurant'.\\n\\nIf you want to change the utterance format, you can overwrite the method `utter_objects()` in your action.\\n\\nThe function `utter_attribute_value()` determines what the bot utters when the user is asking for specific information about\\nan object.\\n\\nIf the attribute of interest was found in the knowledge base, the bot will respond with the following utterance:\\n\\n'Berlin Burrito Company' has the value 'Mexican' for attribute 'cuisine'.\\n\\nIf no value for the requested attribute was found, the bot will respond with\\n\\nDid not find a valid value for attribute 'cuisine' for object 'Berlin Burrito Company'.\\n\\nIf you want to change the bot utterance, you can overwrite the method `utter_attribute_value()`.\\n\\n:::note\\nThere is a [tutorial](https://blog.rasa.com/integrating-rasa-with-knowledge-bases/) on our blog about\\nhow to use knowledge bases in custom actions. The tutorial explains the implementation behind\\n`ActionQueryKnowledgeBase` in detail.\\n\\n:::\", \"Creating Your Own Knowledge Base Actions\": \"`ActionQueryKnowledgeBase` should allow you to easily get started with integrating knowledge bases into your actions.\\nHowever, the action can only handle two kind of user requests:\\n\\n['the user wants to get a list of objects from the knowledge base', 'the user wants to get the value of an attribute for a specific object']\\n\\nThe action is not able to compare objects or consider relations between objects in your knowledge base.\\nFurthermore, resolving any mention to the last mentioned object in the conversation might not always be optimal.\\n\\nIf you want to tackle more complex use cases, you can write your own custom action.\\nWe added some helper functions to `rasa_sdk.knowledge_base.utils`\\n([link to code](https://github.com/RasaHQ/rasa-sdk/tree/main/rasa_sdk/knowledge_base/) )\\nto help you when implement your own solution.\\nWe recommend using `KnowledgeBase` interface so that you can still use the `ActionQueryKnowledgeBase`\\nalongside your new custom action.\\n\\nIf you write a knowledge base action that tackles one of the above use cases or a new one, be sure to tell us about\\nit on the [forum](https://forum.rasa.com)!\\n\\n<a aria-hidden=\\\"true\\\" tabIndex=\\\"-1\\\" className=\\\"anchor enhancedAnchor\\\" id=\\\"customizing-the-inmemoryknowledgebase\\\"></a>\", \"Customizing the `InMemoryKnowledgeBase`\": \"The class `InMemoryKnowledgeBase` inherits `KnowledgeBase`.\\nYou can customize your `InMemoryKnowledgeBase` by overwriting the following functions:\\n\\n['`get_key_attribute_of_object()`: To keep track of what object the user was talking about last, we store the value\\\\nof the key attribute in a specific slot. Every object should have a key attribute that is unique,\\\\nsimilar to the primary key in a relational database. By default, the name of the key attribute for every object type\\\\nis set to `id`. You can overwrite the name of the key attribute for a specific object type by calling\\\\n`set_key_attribute_of_object()`.', \\\"`get_representation_function_of_object()`: Let's focus on the following restaurant:\\\", '```\\\\n{\\\\n \\\"id\\\": 0,\\\\n \\\"name\\\": \\\"Donath\\\",\\\\n \\\"cuisine\\\": \\\"Italian\\\",\\\\n \\\"outside-seating\\\": true,\\\\n \\\"price-range\\\": \\\"mid-range\\\"\\\\n}\\\\n```', \\\"When the user asks the bot to list any Italian restaurant, it doesn't need all of the details of the restaurant.\\\\nInstead, you want to provide a meaningful name that identifies the restaurant \\u2013 in most cases, the name of the object will do.\\\\nThe function `get_representation_function_of_object()` returns a lambda function that maps the\\\\nabove restaurant object to its name.\\\", '```\\\\nlambda obj: obj[\\\"name\\\"]\\\\n```', 'This function is used whenever the bot is talking about a specific object, so that the user is presented a meaningful\\\\nname for the object.', 'By default, the lambda function returns the value of the `\\\"name\\\"` attribute of the object.\\\\nIf your object does not have a `\\\"name\\\"` attribute , or the `\\\"name\\\"` of an object is\\\\nambiguous, you should set a new lambda function for that object type by calling\\\\n`set_representation_function_of_object()`.', '`set_ordinal_mention_mapping()`: The ordinal mention mapping is needed to resolve an ordinal mention, such as\\\\n\\u201csecond one,\\u201d to an object in a list. By default, the ordinal mention mapping looks like this:', '```\\\\n{\\\\n \\\"1\\\": lambda l: l[0],\\\\n \\\"2\\\": lambda l: l[1],\\\\n \\\"3\\\": lambda l: l[2],\\\\n \\\"4\\\": lambda l: l[3],\\\\n \\\"5\\\": lambda l: l[4],\\\\n \\\"6\\\": lambda l: l[5],\\\\n \\\"7\\\": lambda l: l[6],\\\\n \\\"8\\\": lambda l: l[7],\\\\n \\\"9\\\": lambda l: l[8],\\\\n \\\"10\\\": lambda l: l[9],\\\\n \\\"ANY\\\": lambda l: random.choice(l),\\\\n \\\"LAST\\\": lambda l: l[-1],\\\\n}\\\\n```', 'You can overwrite it by calling the function `set_ordinal_mention_mapping()`.\\\\nIf you want to learn more about how this mapping is used, check out [Resolve Mentions](./knowledge-base-actions.mdx#resolve-mentions).']\\n\\nSee the [example bot](https://github.com/RasaHQ/rasa/blob/main/examples/knowledgebasebot/actions/actions.py) for an\\nexample implementation of an `InMemoryKnowledgeBase` that uses the method `set_representation_function_of_object()`\\nto overwrite the default representation of the object type \\u201chotel.\\u201d\\nThe implementation of the `InMemoryKnowledgeBase` itself can be found in the\\n[rasa-sdk](https://github.com/RasaHQ/rasa-sdk/tree/main/rasa_sdk/knowledge_base/) package.\\n\\n<a aria-hidden=\\\"true\\\" tabIndex=\\\"-1\\\" className=\\\"anchor enhancedAnchor\\\" id=\\\"custom-knowledge-base\\\"></a>\", \"Creating Your Own Knowledge Base\": \"If you have more data or if you want to use a more complex data structure that, for example, involves relations between\\ndifferent objects, you can create your own knowledge base implementation.\\nJust inherit `KnowledgeBase` and implement the methods `get_objects()`, `get_object()`, `get_object_types()` and\\n`get_attributes_of_object()`. The [knowledge base code](https://github.com/RasaHQ/rasa-sdk/tree/main/rasa_sdk/knowledge_base/)\\nprovides more information on what those methods should do.\\n\\nYou can also customize your knowledge base further, by adapting the methods mentioned in the section\\n[Customizing the InMemoryKnowledgeBase](./knowledge-base-actions.mdx#customizing-the-inmemoryknowledgebase).\\n\\n:::note\\nWe wrote a [blog post](https://blog.rasa.com/set-up-a-knowledge-base-to-encode-domain-knowledge-for-rasa/)\\nthat explains how you can set up your own knowledge base.\\n\\n:::\"}}, \"metadata\": {\"id\": \"knowledge-bases\", \"sidebar_label\": \"Knowledge Base Actions\", \"title\": \"Knowledge Base Actions\", \"abstract\": \"Leverage information from knowledge bases inside conversations using `ActionQueryKnowledgeBase` in open source bot framework Rasa.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 3]\"}, {\"title\": \"Running a Rasa SDK Action Server\", \"description\": null, \"content\": {\"root\": [\"There are two ways to run the action server, depending on whether you \\nare using an environment with \\n`rasa` installed or not:\", \"If `rasa` is installed, you can run the action server using a `rasa` command:\", \"```\\nrasa run actions\\n```\", \"Alternatively you can make your assistant listen on a specific address using the `SANIC_HOST` environment\\nvariable:\", \"```\\nSANIC_HOST=192.168.69.150 rasa run actions\\n```\", \"If `rasa` is not installed, you can run the action server directly as a python module:\", \"```\\npython -m rasa_sdk --actions actions\\n```\", \"Running the action server directly as a python module allows for `SANIC_HOST` too:\", \"```\\nSANIC_HOST=192.168.69.150 python -m rasa_sdk --actions actions\\n```\", \"Using the command above, `rasa_sdk` will expect to find your actions \\nin a file called `actions.py`\\nor in a package directory called `actions`. \\nYou can specify a different actions module or package with the \\n`--actions` flag.\", \"The full list of options for running the action server with either command is:\", \"```\\n```\"]}, \"metadata\": {\"id\": \"running-action-server\", \"sidebar_label\": \"Running a Rasa SDK Server\", \"title\": \"Running a Rasa SDK Action Server\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 4]\"}, {\"title\": \"Sanic Extensions\", \"description\": null, \"content\": {\"Step-by-step guide on creating your own Sanic extension in rasa_sdk\": {\"Create the rasa_sdk_plugins package\": \"Create a package in your action server project which you must name `rasa_sdk_plugins`. Rasa SDK will try to instantiate this package in your project to start plugins.\\nIf no plugins are found, it will print a debug log that there are no plugins in your project.\", \"Register modules containing the hooks\": \"Create the package `rasa_sdk_plugins` and initialize the hooks by creating an `__init__.py` file where the plugin manager will look for the module where the hooks are implemented:\\n\\n```\\ndef init_hooks(manager: pluggy.PluginManager) -> None:\\n \\\"\\\"\\\"Initialise hooks into rasa sdk.\\\"\\\"\\\"\\n import sys\\n import rasa_sdk_plugins.your_module\\n\\n logger.info(\\\"Finding hooks\\\")\\n manager.register(sys.modules[\\\"rasa_sdk_plugins.your_module\\\"])\\n```\", \"Implement your hook\": \"Implement the hook `attach_sanic_app_extensions`. This hook forwards the app object created by Sanic in the `rasa_sdk` and allows you to create additional routes, middlewares, listeners and background tasks. Here's an example of this implementation that creates a listener.\\n\\nIn your `rasa_sdk_plugins.your_module.py`:\\n\\n```\\nfrom __future__ import annotations\\n\\nimport logging\\nimport pluggy\\n\\nfrom asyncio import AbstractEventLoop\\nfrom functools import partial\\n\\n\\nlogger = logging.getLogger(__name__)\\nhookimpl = pluggy.HookimplMarker(\\\"rasa_sdk\\\")\\n\\n\\n@hookimpl # type: ignore[misc]\\ndef attach_sanic_app_extensions(app: Sanic) -> None:\\n logger.info(\\\"hook called\\\")\\n app.register_listener(\\n partial(before_server_start),\\n \\\"before_server_start\\\",\\n )\\n\\n\\nasync def before_server_start(app: Sanic, loop: AbstractEventLoop):\\n logger.info(\\\"BEFORE SERVER START\\\")\\n```\"}}, \"metadata\": {\"id\": \"sanic-extensions\", \"sidebar_label\": \"Sanic Extensions\", \"title\": \"Sanic Extensions\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 5]\"}, {\"title\": \"Actions\", \"description\": null, \"content\": {\"Methods\": {\"Action.name\": \"Defines the action's name. The name returned by this method is the one used in your bot's domain.\\n\\n['**Returns**:', 'Name of action', '**Return type**: ', '`str`']\", \"Action.run\": {\"**Parameters**\": [\"**dispatcher** \\u2013 the dispatcher which is used to\\nsend messages back to the user. Use\\n`dispatcher.utter_message()` or any other\\n`rasa_sdk.executor.CollectingDispatcher`\\nmethod. See the [documentation for the dispatcher](sdk-dispatcher.mdx)\", \"**tracker** \\u2013 the state tracker for the current\\nuser. You can access slot values using\\n`tracker.get_slot(slot_name)`, the most recent user message\\nis `tracker.latest_message.text` and any other\\n`rasa_sdk.Tracker` property. See the [documentation for the tracker](sdk-tracker.mdx).\", \"**domain** \\u2013 the bot's domain\"], \"**Returns**\": \"A list of `rasa_sdk.events.Event` instances. See the [documentation for events](sdk-events.mdx).\", \"**Return type**\": \"`List`[`Dict`[`str`, `Any`]]\"}}, \"Example\": \"In a restaurant bot, if the user says \\u201cshow me a Mexican restaurant\\u201d,\\nyour bot could execute the action `ActionCheckRestaurants`,\\nwhich might look like this:\\n\\n```\\nfrom typing import Text, Dict, Any, List\\nfrom rasa_sdk import Action\\nfrom rasa_sdk.events import SlotSet\\n\\nclass ActionCheckRestaurants(Action):\\n def name(self) -> Text:\\n return \\\"action_check_restaurants\\\"\\n\\n def run(self,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: Dict[Text, Any]) -> List[Dict[Text, Any]]:\\n\\n cuisine = tracker.get_slot('cuisine')\\n q = \\\"select * from restaurants where cuisine='{0}' limit 1\\\".format(cuisine)\\n result = db.query(q)\\n\\n return [SlotSet(\\\"matches\\\", result if result is not None else [])]\\n```\\n\\nThis action queries a database to find restaurants matching\\nthe requested cuisine, and uses the list of restaurants found \\nto set the value of the `matches` slot.\"}, \"metadata\": {\"id\": \"sdk-actions\", \"sidebar_label\": \"Actions\", \"title\": \"Actions\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 6]\"}, {\"title\": \"Dispatcher\", \"description\": null, \"content\": {\"CollectingDispatcher\": {\"CollectingDispatcher.utter_message\": {\"**Parameters**\": \"The `utter_message` method takes the following optional arguments.\\nPassing no arguments will result in an empty message being returned to the user.\\nPassing multiple arguments will result in a rich response (e.g. text and buttons) being returned to the user.\\n\\n['`text`: The text to return to the user.']\\n\\n```\\ndispatcher.utter_message(text = \\\"Hey there\\\")\\n```\\n\\n['`image`: An image URL or file path that will be used to display an image to the user.']\\n\\n```\\ndispatcher.utter_message(image = \\\"https://i.imgur.com/nGF1K8f.jpg\\\")\\n```\\n\\n['`json_message`: A custom json payload as a dictionary. It can be used to send [channel specific responses](../responses.mdx).\\\\nThe following example would return a date picker in Slack:']\\n\\n```\\ndate_picker = {\\n \\\"blocks\\\":[\\n {\\n \\\"type\\\": \\\"section\\\",\\n \\\"text\\\":{\\n \\\"text\\\": \\\"Make a bet on when the world will end:\\\",\\n \\\"type\\\": \\\"mrkdwn\\\"\\n },\\n \\\"accessory\\\":\\n {\\n \\\"type\\\": \\\"datepicker\\\",\\n \\\"initial_date\\\": \\\"2019-05-21\\\",\\n \\\"placeholder\\\":\\n {\\n \\\"type\\\": \\\"plain_text\\\",\\n \\\"text\\\": \\\"Select a date\\\"\\n }\\n }\\n }\\n ]\\n}\\ndispatcher.utter_message(json_message = date_picker)\\n```\\n\\n['`response`: The name of a response to return to the user. This response should\\\\nbe specified in your assistants [domain](../domain.mdx).']\\n\\n```\\ndispatcher.utter_message(response = \\\"utter_greet\\\")\\n```\\n\\n['`attachment`: A URL or file path of an attachment to return to the user.']\\n\\n```\\ndispatcher.utter_message(attachment = \\\"\\\")\\n```\\n\\n[\\\"`buttons`: A list of buttons to return to the user.\\\\nEach button is a dictionary and should have a `title` and a `payload` key.\\\\nA button can include other keys, but these will only be used if\\\\na specific channel looks for them.\\\\nThe button's `payload` will be sent as a user message if the user\\\\nclicks the button.\\\"]\\n\\n```\\ndispatcher.utter_message(buttons = [\\n {\\\"payload\\\": \\\"/affirm\\\", \\\"title\\\": \\\"Yes\\\"},\\n {\\\"payload\\\": \\\"/deny\\\", \\\"title\\\": \\\"No\\\"},\\n ])\\n```\\n\\n[\\\"`elements`: These are specific to using Facebook as a messaging channel. For details\\\\nof expected format see [Facebook's documentation](https://developers.facebook.com/docs/messenger-platform/send-messages/template/generic/)\\\", '`**kwargs`: arbitrary keyword arguments, which can be\\\\nused to specify values for [variable interpolation in response variations](../responses.mdx). For example,\\\\ngiven the following response:']\\n\\n```\\nresponses:\\n utter_greet_name:\\n - text: Hi {name}!\\n```\\n\\nYou could specify the name with:\\n\\n```\\ndispatcher.utter_message(response = \\\"utter_greet_name\\\", name = \\\"Aimee\\\")\\n```\", \"**Return type**\": \"`None`\"}}}, \"metadata\": {\"id\": \"sdk-dispatcher\", \"sidebar_label\": \"Dispatcher\", \"title\": \"Dispatcher\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 7]\"}, {\"title\": \"Events\", \"description\": null, \"content\": {\"Event Classes\": {\"SlotSet\": \"```\\nrasa_sdk.events.SlotSet(\\n key: Text, \\n value: Any = None, \\n timestamp: Optional[float] = None\\n)\\n```\\n\\n**Underlying event**: [`slot`](events.mdx#slot)\\n\\n**Parameters**:\\n\\n['`key`: Name of the slot to set', '`value`: Value to set the slot to. The datatype must match the [type](../domain.mdx#slot-types)\\\\nof the slot', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**\\n\\n```\\nevt = SlotSet(key = \\\"name\\\", value = \\\"Mary\\\")\\n```\", \"AllSlotsReset\": \"```\\nrasa_sdk.events.AllSlotsReset(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`reset_slots`](events.mdx#reset_slots)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = AllSlotsReset()\\n```\", \"ReminderScheduled\": \"```\\nrasa_sdk.events.ReminderScheduled(\\n intent_name: Text,\\n trigger_date_time: datetime.datetime,\\n entities: Optional[Union[List[Dict[Text, Any]], Dict[Text, Text]]] = None,\\n name: Optional[Text] = None,\\n kill_on_user_message: bool = True,\\n timestamp: Optional[float] = None,\\n)\\n```\\n\\n**Underlying event**: [`reminder`](events.mdx#reminder)\\n\\n**Parameters**:\\n\\n['`intent_name`: Intent which the reminder will trigger ', '`trigger_date_time`: Datetime at which the execution of the action should be triggered. ', '`entities`: Entities to send with the intent', '`name`: ID of the reminder. If there are multiple reminders with the same id only the last will be run.', '`kill_on_user_message`: Whether a user message before the trigger time will abort the reminder', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nfrom datetime import datetime\\n\\nevt = ReminderScheduled(\\n intent_name = \\\"EXTERNAL_dry_plant\\\",\\n trigger_date_time = datetime(2020, 9, 15, 0, 36, 0, 851609),\\n entities = [{\\\"name\\\": \\\"plant\\\",\\\"value\\\":\\\"orchid\\\"}], \\n name = \\\"remind_water_plants\\\",\\n)\\n```\", \"ReminderCancelled\": \"```\\nReminderCancelled(\\n name: Optional[Text] = None,\\n intent_name: Optional[Text] = None,\\n entities: Optional[Union[List[Dict[Text, Any]], Dict[Text, Text]]] = None,\\n timestamp: Optional[float] = None,\\n) \\n```\\n\\n**Underlying event**: [`cancel_reminder`](events.mdx#cancel_reminder)\\n\\n**Parameters**:\\n\\n['`name`: ID of the reminder.', '`intent_name`: Intent which the reminder triggers ', '`entities`: Entities sent with the intent', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = ReminderCancelled(name = \\\"remind_water_plants\\\") \\n```\", \"ConversationPaused\": \"```\\nConversationPaused(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`pause`](events.mdx#slot)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = ConversationPaused()\\n```\", \"ConversationResumed\": \"```\\nConversationResumed(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`resume`](events.mdx#resume)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = ConversationResumed()\\n```\", \"FollowupAction\": \"```\\nFollowupAction(\\n name: Text, \\n timestamp: Optional[float] = None\\n)\\n```\\n\\n**Underlying event**: [`followup`](events.mdx#followup)\\n\\n**Parameters**:\\n\\n['`name`: The name of the follow up action that will be executed.', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = FollowupAction(name = \\\"action_say_goodbye\\\")\\n```\", \"UserUtteranceReverted\": \"```\\nUserUtteranceReverted(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`rewind`](events.mdx#rewind)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = UserUtteranceReverted()\\n```\", \"ActionReverted\": \"```\\nActionReverted(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`undo`](events.mdx#undo)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = ActionReverted()\\n```\", \"Restarted\": \"```\\nRestarted(timestamp: Optional[float] = None) \\n```\\n\\n**Underlying event**: [`restart`](events.mdx#restart)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = Restarted()\\n```\", \"SessionStarted\": \"```\\nSessionStarted(timestamp: Optional[float] = None)\\n```\\n\\n**Underlying event**: [`session_started`](events.mdx#session_started)\\n\\n**Parameters**:\\n\\n['`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = SessionStarted()\\n```\", \"UserUttered\": \"```\\nUserUttered(\\n text: Optional[Text],\\n parse_data: Optional[Dict[Text, Any]] = None,\\n timestamp: Optional[float] = None,\\n input_channel: Optional[Text] = None,\\n)\\n```\\n\\n**Underlying event**: [`user`](events.mdx#user)\\n\\n**Parameters**:\\n\\n['`text`: Text of the user message', '`parse_data`: Parsed data of user message. This is ordinarily filled by NLU.', '`input_channel`: The channel on which the message was received', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = UserUttered(text = \\\"Hallo bot\\\")\\n```\", \"BotUttered\": \"```\\nBotUttered(\\n text: Optional[Text] = None,\\n data: Optional[Dict[Text, Any]] = None,\\n metadata: Optional[Dict[Text, Any]] = None,\\n timestamp: Optional[float] = None,\\n)\\n```\\n\\n**Underlying event**: [`bot`](events.mdx#bot)\\n\\n**Parameters**:\\n\\n['`text`: The text the bot sends to the user', '`data`: Any non-text elements of the bot response. The structure of `data` matches that of `responses` given in the [API spec](/pages/action-server-api).', '`metadata`: Arbitrary key-value metadata', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = BotUttered(text = \\\"Hallo user\\\")\\n```\", \"ActionExecuted\": \"```\\nActionExecuted(\\n action_name,\\n policy=None,\\n confidence: Optional[float] = None,\\n timestamp: Optional[float] = None,\\n)\\n```\\n\\n**Underlying event**: [`action`](events.mdx#action)\\n\\n**Parameters**:\\n\\n['`action_name`: Name of the action that was called', '`policy`: The policy used to predict the action', '`confidence`: The confidence with which the action was predicted', '`timestamp`: Optional timestamp of the event']\\n\\n**Example**:\\n\\n```\\nevt = ActionExecuted(\\\"action_greet_user\\\")\\n```\"}}, \"metadata\": {\"id\": \"sdk-events\", \"sidebar_label\": \"Events\", \"title\": \"Events\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 8]\"}, {\"title\": \"Tracker\", \"description\": null, \"content\": {\"Attributes\": \"The following are available as attributes of a `Tracker` object:\\n\\n['`sender_id` - The unique ID of person talking to the bot.', '`slots` - The list of slots that can be filled as defined in the\\\\n\\u201cref\\u201ddomains.', '`latest_message` - A dictionary containing the attributes of the latest\\\\nmessage: `intent`, `entities` and `text`.', '`events` - A list of all previous events.', '`active_loop` - The name of the currently active loop.', '`latest_action_name` - The name of the last action the bot executed.']\", \"Methods\": {\"Tracker.current_state\": \"Return the current tracker state as an object.\\n\\n['**Return type**']\\n\\n`Dict[str, Any]`\", \"Tracker.is_paused\": \"State whether the tracker is currently paused.\\n\\n['**Return type**']\\n\\n`bool`\", \"Tracker.get_latest_entity_values\": \"Get entity values found for the passed entity type and optional role and\\ngroup in latest message.\\nIf you are only interested in the first entity of a given type use:\\n\\n```\\nnext(tracker.get_latest_entity_values(\\u201cmy_entity_name\\u201d), None)\\n```\\n\\nIf no entity is found, then `None` is the default result.\\n\\n['**Parameters**', ['`entity_type` \\u2013 the entity type of interest', '`entity_role` \\u2013 optional entity role of interest', '`entity_group` \\u2013 optional entity group of interest']]\\n\\n['**Returns**']\\n\\nList of entity values.\\n\\n['**Return type**']\\n\\n`Iterator[str]`\", \"Tracker.get_latest_input_channel\": \"Get the name of the input_channel of the latest UserUttered event\\n\\n['**Return type**']\\n\\n`Optional[str]`\", \"Tracker.events_after_latest_restart\": \"Return a list of events after the most recent restart.\\n\\n['**Return type**']\\n\\n`List[Dict]`\", \"Tracker.get_slot\": \"Retrieves the value of a slot.\\n\\n['**Parameters**', ['`key` \\u2013 the name of the slot of which to retrieve the value']]\\n\\n['**Return type**']\\n\\n`Optional[Any]`\", \"Tracker.get_intent_of_latest_message\": \"Retrieves the user's latest intent.\\n\\n['**Parameters**', ['`skip_fallback_intent` (default: `True`) \\u2013 Optionally skip the `nlu_fallback` intent and return the next highest ranked.']]\\n\\n['**Returns**']\\n\\nThe intent of the latest message if available.\\n\\n['**Return type**']\\n\\n`Optional[Text]`\"}}, \"metadata\": {\"id\": \"sdk-tracker\", \"sidebar_label\": \"Tracker\", \"title\": \"Tracker\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 9]\"}, {\"title\": \"Slot Validation Actions\", \"description\": null, \"content\": {\"`ValidationAction` class\": {\"How to subclass `ValidationAction`\": {\"Validation of Slots with Predefined Mappings\": \"To validate slots with a predefined mapping, you must write functions named `validate_<slot_name>`.\\n\\nIn the following example, the value for slot `location` is capitalized only if the extracted value is of type string:\\n\\n```\\nfrom typing import Text, Any, Dict\\n\\nfrom rasa_sdk import Tracker, ValidationAction\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk.types import DomainDict\\n\\n\\nclass ValidatePredefinedSlots(ValidationAction):\\n def validate_location(\\n self,\\n slot_value: Any,\\n dispatcher: CollectingDispatcher,\\n tracker: Tracker,\\n domain: DomainDict,\\n ) -> Dict[Text, Any]:\\n \\\"\\\"\\\"Validate location value.\\\"\\\"\\\"\\n if isinstance(slot_value, str):\\n # validation succeeded, capitalize the value of the \\\"location\\\" slot\\n return {\\\"location\\\": slot_value.capitalize()}\\n else:\\n # validation failed, set this slot to None\\n return {\\\"location\\\": None}\\n```\", \"Extraction of Custom Slot Mappings\": \"To define custom extraction code, write an `extract_<slot_name>` method for every slot with a\\ncustom slot mapping.\\n\\nThe following example shows the implementation of a custom action that extracts the slot `count_of_insults` to keep\\ntrack of the user's attitude.\\n\\n```\\nfrom typing import Dict, Text, Any\\n\\nfrom rasa_sdk import Tracker\\nfrom rasa_sdk.executor import CollectingDispatcher\\nfrom rasa_sdk.forms import ValidationAction\\n\\n\\nclass ValidateCustomSlotMappings(ValidationAction):\\n async def extract_count_of_insults(\\n self, dispatcher: CollectingDispatcher, tracker: Tracker, domain: Dict\\n ) -> Dict[Text, Any]:\\n intent_of_last_user_message = tracker.get_intent_of_latest_message()\\n current_count_of_insults = tracker.get_slot(\\\"count_of_insults\\\")\\n if intent_of_last_user_message == \\\"insult\\\":\\n current_count_of_insults += 1\\n\\n return {\\\"count_of_insults\\\": current_count_of_insults}\\n```\"}, \"`ValidationAction` class implementation\": {\"Methods\": {\"ValidationAction.name\": \"Defines the action's name: this must be hardcoded as `action_validate_slot_mappings`.\\n\\n['**Returns**:', 'Name of action', '**Return type**:', '`str`']\", \"ValidationAction.run\": {\"**Parameters**\": [\"**dispatcher** \\u2013 the dispatcher which is used to\\nsend messages back to the user. Use\\n`dispatcher.utter_message()` or any other\\n`rasa_sdk.executor.CollectingDispatcher`\\nmethod. See the [documentation for the dispatcher](./sdk-dispatcher.mdx)\", \"**tracker** \\u2013 the state tracker for the current\\nuser. You can access slot values using\\n`tracker.get_slot(slot_name)`, the most recent user message\\nis `tracker.latest_message.text` and any other\\n`rasa_sdk.Tracker` property. See the [documentation for the tracker](./sdk-tracker.mdx).\", \"**domain** \\u2013 the bot's domain\"], \"**Returns**\": \"A list of `rasa_sdk.events.Event` instances. See the [documentation for events](./sdk-events.mdx).\", \"**Return type**\": \"`List`[`Dict`[`str`, `Any`]]\"}, \"ValidationAction.required_slots\": {\"**Returns**\": \"A list of slot names of type `Text`.\"}, \"ValidationAction.get_extraction_events\": \"```\\nasync ValidationAction.get_extraction_events(dispatcher, tracker, domain)\\n```\\n\\nThe `get_extraction_events` method will gather the list of slot names via `required_slots` method call and then loop\\nthrough every slot name to run the `extract_<slot name>` method if available.\", \"**Returns**\": \"A list of `rasa_sdk.events.SlotSet` instances. See the [documentation for SlotSet events](./sdk-events.mdx#slotset).\", \"ValidationAction.get_validation_events\": {\"**Returns**\": \"A list of `rasa_sdk.events.SlotSet` instances. See the [documentation for SlotSet events](./sdk-events.mdx#slotset).\"}}}}, \"`FormValidationAction` class\": {\"`FormValidationAction` class implementation\": {\"Methods\": {\"FormValidationAction.name\": \"The method `name` will raise a `NotImplementedError` exception if the bot custom action subclassing `FormValidationAction`\\ndoes not return a custom name which follows this naming convention: `validate_<form name>`.\", \"FormValidationAction.required_slots\": \"The method `required_slots` will return the `domain_slots` which is a list of all slot names included in the form's\\n`required_slots`. `domain_slots` is returned by the `domain_slots` method, which only takes\\n`Domain` as an argument.\", \"FormValidationAction.next_requested_slot\": \"The method `next_requested_slot` will set the value of `REQUESTED_SLOT` to the next unset slot only if the\\n`required_slots` method was overridden by the custom action subclassing `FormValidationAction`.\\n\\nIf users didn't override `required_slots` then we'll let the `FormAction` within Rasa Open\\nSource request the next slot, and the method will return `None`.\\n\\nThe parameters the method requires are:\\n\\n['[dispatcher](./sdk-dispatcher.mdx)', '[tracker](./sdk-tracker.mdx)', \\\"the bot's domain\\\"]\", \"FormValidationAction.run\": \"The original implementation of the `ValidationAction.run` method is extended to add a call to the `next_requested_slot`\\nmethod. The output of the `next_requested_slot` method call (if not `None`) is added to the list of events that `run`\\nmethod returns.\"}}}}, \"metadata\": {\"id\": \"validation-action\", \"sidebar_label\": \"Slot Validation Actions\", \"title\": \"Slot Validation Actions\", \"abstract\": \"Learn how `ValidationAction` class is implemented in the Rasa SDK.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55, \\\"subpages\\\", 10]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 55]\"}, {\"title\": \"Connectors\", \"description\": \"Documentation section: connectors\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/connectors\"}, \"subpages\": [{\"title\": \"Audiocodes VoiceAI Connect\", \"description\": \"Build a Rasa Voice Bot on Audiocodes VoiceAI Connect\", \"content\": {\"Getting Credentials\": \"To get credentials, create a bot on the [VoiceAI connect portal](https://voiceaiconnect.audiocodes.io/).\\n\\n['Select **Bots** in the left sidebar.', 'Click on the **+** sign to create a new bot.', 'Select **Rasa** as the Bot Framework', 'Set the bot URL and choose a token value.']\\n\\n:::info Setting the bot URL with a tunneling solution when testing locally\\n\\nVisit this [section](../messaging-and-voice-channels.mdx#testing-channels-on-your-local-machine) to learn how to generate\\nthe required bot URL when testing the channel on your local machine.\\n\\n:::\", \"Setting credentials\": \"The token value chosen above will be used in the `credentials.yml`:\\n\\n```\\nrasa_plus.channels.audiocodes.AudiocodesInput:\\n token: <token>\\n```\\n\\nYou can also specify optional parameters:\\n\\n| Parameter | Default value | Description |\\n| --------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------- |\\n| `token` | No default value | The token to authenticate calls between your Rasa assistant and VoiceAI connect |\\n| `use_websocket` | `true` | If `true`, Rasa will send messages through a web socket. If set to `false`, Rasa will send messages through http API calls. |\\n| `keep_alive` | 120 | In seconds. For each ongoing conversation, VoiceAI Connect will periodically verify the conversation is still active on the Rasa side. |\\n\\nThen restart your Rasa server to make the new channel endpoint available.\", \"Usage\": {\"Receiving messages from a user\": \"When a user speaks on the phone, VoiceAI Connect will send a text message (after it is processed by the speech-to-text engine) to your assistant like any other channel.\\nThis message will be interpreted by the NLU and you can then drive the conversation with rules, stories and forms.\", \"Sending messages to a user\": \"Your bot will respond with text messages like with any other channel. The text-to-speech engine will convert the text and deliver it as a voice message to the user.\\n\\nHere is an example:\\n\\n```\\nutter_greet:\\n - text: 'Hello! isn\\u2019t every life and every work beautiful?'\\n```\\n\\n:::note \\nOnly text messages are allowed. Images, attachments, and buttons cannot be used with a voice channel. \\n:::\", \"Handling conversation events\": \"Non-voice events can also be handled by the bot. Here are a few examples:\\n\\n| Event | intent | Description |\\n| ------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `start` | `vaig_event_start` | VoiceAI will send this intent when it picks-up a phone call. In general, the response to that intent is a welcome or greeting message. [Call context](https://techdocs.audiocodes.com/voice-ai-connect/#VAIG_Combined/call-initiation.htm?TocPath=Bot%2520integration%257CBasic%2520behavior%257C_____1) will be provided through entities |\\n| `end` | `vaig_event_end` | VoiceAI will send this intent when a call ends. You can use that to call an action that updates the call information. |\\n| `DTMF` | `vaig_event_DTMF` | VoiceAI will send this intent when receiving a DTMF tone (i.e user presses digit on the keyboard of the phone). The digit(s) sent will be passed in the `value` entity |\\n\\nThe general pattern is that for every `event` sent, the bot will receive the `vaig_event_<event>` intent, with context information in entities.\\n\\nHere is a simple rule to send a greeting message when a call to the bot is initiated:\\n\\n```\\n- rule: New call\\n steps:\\n - intent: vaig_event_start\\n - action: utter_greet\\n```\\n\\nCheck the [VoiceAI Connect documentation](https://techdocs.audiocodes.com/voice-ai-connect/#VAIG_Combined/voiceai_connect.htm?TocPath=VoiceAI%2520Connect%257C_____0) for an exhaustive list of events.\", \"Configuring calls\": {\"Example: changing a pin code\": \"In this example we create a flow to allow a user to change a pin code.\\n\\n```\\n- rule: Set pin code\\n steps:\\n # User says \\\"I want to change my pin code\\\"\\n - intent: set_pin_code\\n # Send the noUserInput configuration event\\n - action: utter_config_no_user_input\\n # Send the DTMF format configuration event\\n - action: utter_config_dtmf_pin_code \\n # A standard Rasa form to collect the pin code from the user\\n - action: pin_code_form \\n - ...\\n```\\n\\nIn the domain, we can add the `utter_config_<config_event>` responses:\\n\\n[`noUserInput` event](https://techdocs.audiocodes.com/voice-ai-connect/#VAIG_Combined/inactivity-detection.htm?TocPath=Bot%2520integration%257CReceiving%2520notifications%257C_____3)\\n\\n```\\n utter_config_no_user_input:\\n - custom:\\n type: event\\n name: config\\n sessionParams:\\n # If user stays silent for 5 seconds or more, the notification will be sent\\n userNoInputTimeoutMS: 5000\\n # If you want to allow for more than one notification during a call\\n userNoInputRetries: 2\\n # Enable the noUserInput notification\\n userNoInputSendEvent: true\\n```\\n\\n[`DTMF` event](https://techdocs.audiocodes.com/voice-ai-connect/#VAIG_Combined/receive-dtmf.htm?TocPath=Bot%2520integration%257CReceiving%2520notifications%257C_____2)\\n\\n```\\n utter_config_dtmf_pin_code:\\n - custom:\\n type: event\\n name: config\\n sessionParams:\\n # Enable grouped collection (i.e will send all digits in a single payload)\\n dtmfCollect: true\\n # If more than 5 secs have passed since a digit was pressed, \\n # the input is considered completed and will be sent to the bot\\n dtmfCollectInterDigitTimeoutMS: 5000\\n # If 6 digits are collected, VoiceAI will send those 6 digits\\n # even if the user keeps pressing buttons\\n dtmfCollectMaxDigits: 6\\n # If the user presses '#' the input is considered complete\\n dtmfCollectSubmitDigit: \\\"#\\\"\\n```\\n\\nNow you can configure the `pin_code` slot in the `pin_code_form` to extract the pin code from the `value` entity with the `vaig_event_DTMF` intent:\\n\\n```\\n pin_code:\\n type: text\\n influence_conversation: false\\n mappings:\\n - type: from_entity\\n entity: value\\n intent: vaig_event_DTMF\\n not_intent: vaig_event_noUserInput\\n conditions:\\n - active_loop: pin_code_form\\n requested_slot: pin_code\\n```\\n\\nNotice how `vaig_event_noUserInput` was declared in the `not_intent` field. \\n\\nSince the `vaig_event_noUserInput` intent is sent by VoiceAI Connect when the user stays silent as per our configuration,\\nwe must deactivate the form so we can pick up the conversation from a rule or a story and gracefully handle the failure.\\n\\nIn the following example, we simply cancel the current flow if we receive the `vaig_event_noUserInput` intent (i.e. user stays silent) while the `pin_code_form` loop is active.\\n\\n```\\n- rule: Set pin code - happy path\\n steps:\\n - intent: set_pin_code\\n - action: utter_config_no_user_input\\n - action: utter_config_dtmf_pin_code\\n - action: pin_code_form\\n - active_loop: pin_code_form\\n - active_loop: null\\n - slot_was_set:\\n - requested_slot: null\\n - action: utter_pin_code_changed\\n - action: action_pin_code_cleanup\\n\\n- rule: Set pin code - no response - cancel.\\n condition:\\n - active_loop: pin_code_form\\n steps:\\n - intent: vaig_event_noUserInput\\n - action: utter_cancel_set_pin_code\\n - action: action_deactivate_loop\\n - active_loop: null\\n```\"}}}, \"metadata\": {\"id\": \"audiocodes-voiceai-connect\", \"sidebar_label\": \"Audiocodes VoiceAI Connect\", \"title\": \"Audiocodes VoiceAI Connect\", \"description\": \"Build a Rasa Voice Bot on Audiocodes VoiceAI Connect\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 0]\"}, {\"title\": \"Cisco Webex Teams\", \"description\": \"Build a Rasa Chat Bot on Cisco Webex\", \"content\": {\"Getting Credentials\": \"**How to get the Cisco Webex Teams credentials:**\\n\\nYou need to set up a bot. Check out the [Cisco Webex for Developers\\ndocumentation](https://developer.webex.com/docs/bots) for information\\nabout how to create your bot.\\n\\nAfter you have created the bot through Cisco Webex Teams, you need to create a\\nroom in Cisco Webex Teams. Then add the bot in the room the same way you would\\nadd a person in the room.\\n\\nYou need to note down the room ID for the room you created. This room ID will\\nbe used in `room` variable in the `credentials.yml` file.\\n\\nPlease follow this link below to find the room ID\\n`https://developer.webex.com/endpoint-rooms-get.html`\\n\\nIn the OAuth & Permissions section, add the URL of the Rasa endpoint\\nthat Webex should forward the messages to. The endpoint for receiving Cisco Webex Teams messages\\nis `http://<host>:<port>/webhooks/webexteams/webhook`, replacing\\nthe host and port with the appropriate values from your running Rasa server.\", \"Running on Cisco Webex Teams\": \"Add the Webex Teams credentials to your `credentials.yml`:\\n\\n```\\nwebexteams:\\n access_token: \\\"YOUR-BOT-ACCESS-TOKEN\\\"\\n room: \\\"YOUR-CISCOWEBEXTEAMS-ROOM-ID\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Cisco Webex Teams to send messages to.\\n\\n:::note\\nIf you do not set the `room` keyword\\nargument, messages will by delivered back to\\nthe user who sent them.\\n\\n:::\"}, \"metadata\": {\"id\": \"cisco-webex-teams\", \"sidebar_label\": \"Cisco Webex Teams\", \"title\": \"Cisco Webex Teams\", \"description\": \"Build a Rasa Chat Bot on Cisco Webex\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 1]\"}, {\"title\": \"Custom Connectors\", \"description\": \"Deploy and Run a Rasa Chat Bot on a custom chat interface\", \"content\": {\"The `name` method\": \"The `name` method defines the url prefix for the connector's webhook. It also defines the channel name you should use \\nin any [channel specific response variations](../responses.mdx#channel-specific-response-variations) and the name you\\nshould pass to the `output_channel` query parameter on the [trigger intent endpoint](https://www.rasa.com/docs/rasa/pages/http-api#operation/triggerConversationIntent).\\n\\nFor example, if your custom channel is named `myio`, you would define the `name` method as:\\n\\n```\\nfrom rasa.core.channels.channel import InputChannel\\n\\nclass MyIO(InputChannel):\\n def name() -> Text:\\n \\\"\\\"\\\"Name of your custom channel.\\\"\\\"\\\"\\n return \\\"myio\\\"\\n```\\n\\nYou would write a response variation specific to the `myio` channel as:\\n\\n```\\nresponses:\\n utter_greet:\\n - text: Hi! I'm the default greeting.\\n - text: Hi! I'm the custom channel greeting\\n channel: myio\\n```\\n\\nThe webhook you give to the custom channel to call would be\\n`http://<host>:<port>/webhooks/myio/webhook`, replacing \\nthe host and port with the appropriate values from your running Rasa server.\", \"The `blueprint` method\": \"The `blueprint` method\\nneeds to create a [sanic blueprint](https://sanicframework.org/en/guide/best-practices/blueprints.html#overview)\\nthat can be attached to a sanic server. \\nYour blueprint should have at least the two routes: `health` on the route `/`,\\nand `receive` on the route `/webhook` (see example custom channel below).\\n\\nAs part of your implementation of the `receive` endpoint, you will need to tell\\nRasa to handle the user message. You do this by calling \\n\\n```\\n on_new_message(\\n rasa.core.channels.channel.UserMessage(\\n text,\\n output_channel,\\n sender_id\\n )\\n )\\n```\\n\\nCalling `on_new_message` will send the user message to the [`handle_message`](https://github.com/RasaHQ/rasa/blob/c922253fe890bb4903329d4ade764e0711d384ec/rasa/core/agent.py#L511_) method.\\n\\nSee more details on the `UserMessage` object [here](https://www.rasa.com/docs/rasa/reference/rasa/core/channels/channel#usermessage-objects).\\n\\nThe `output_channel` argument refers to an output channel implementing the \\n[`OutputChannel`](https://www.rasa.com/docs/rasa/reference/rasa/core/channels/channel#outputchannel-objects) class. You can\\neither implement your own output channel class with the methods for your particular chat channel\\n(e.g. methods to send text and images) or you can use the\\n[`CollectingOutputChannel`](https://www.rasa.com/docs/rasa/reference/rasa/core/channels/channel#collectingoutputchannel-objects) \\nto collect the bot responses Rasa creates while the bot is processing your messages and return\\nthem as part of your endpoint response. This is the way the `RestInput`\\nchannel is implemented. For examples on how to create and use your own output\\nchannel, take a look at the implementations of the other\\noutput channels, e.g. the `SlackBot` in `rasa.core.channels.slack`.\\n\\nHere is a simplified example of a custom channel connector that makes use of the `CollectingOutputChannel`:\\n\\n```\\nimport asyncio\\nimport inspect\\nfrom sanic import Sanic, Blueprint, response\\nfrom sanic.request import Request\\nfrom sanic.response import HTTPResponse\\nfrom typing import Text, Dict, Any, Optional, Callable, Awaitable, NoReturn\\n\\nimport rasa.utils.endpoints\\nfrom rasa.core.channels.channel import (\\n InputChannel,\\n CollectingOutputChannel,\\n UserMessage,\\n)\\n\\nclass MyIO(InputChannel):\\n def name() -> Text:\\n \\\"\\\"\\\"Name of your custom channel.\\\"\\\"\\\"\\n return \\\"myio\\\"\\n\\n def blueprint(\\n self, on_new_message: Callable[[UserMessage], Awaitable[None]]\\n ) -> Blueprint:\\n\\n custom_webhook = Blueprint(\\n \\\"custom_webhook_{}\\\".format(type(self).__name__),\\n inspect.getmodule(self).__name__,\\n )\\n\\n @custom_webhook.route(\\\"/\\\", methods=[\\\"GET\\\"])\\n async def health(request: Request) -> HTTPResponse:\\n return response.json({\\\"status\\\": \\\"ok\\\"})\\n\\n @custom_webhook.route(\\\"/webhook\\\", methods=[\\\"POST\\\"])\\n async def receive(request: Request) -> HTTPResponse:\\n sender_id = request.json.get(\\\"sender\\\") # method to get sender_id \\n text = request.json.get(\\\"text\\\") # method to fetch text\\n input_channel = self.name() # method to fetch input channel\\n metadata = self.get_metadata(request) # method to get metadata\\n\\n collector = CollectingOutputChannel()\\n \\n # include exception handling\\n\\n await on_new_message(\\n UserMessage(\\n text,\\n collector,\\n sender_id,\\n input_channel=input_channel,\\n metadata=metadata,\\n )\\n )\\n\\n return response.json(collector.messages)\\n\\n return custom_webhook\\n```\", \"Metadata on messages\": \"If you need to use extra information from your front end in your custom\\nactions, you can pass this information using the `metadata` key of your user\\nmessage. This information will accompany the user message through the Rasa\\nserver into the action server when applicable, where you can find it stored in\\nthe `tracker`. Message metadata will not directly affect NLU classification\\nor action prediction. \\n\\nThe `InputChannel` class's default implementation of `get_metadata` **ignores all metadata**.\\nTo extract metadata in a custom connector, implement the `get_metadata` method.\\nThe `SlackInput` channel provides one example of a `get_metadata` method that extracts metadata according to the channel's response format.\", \"Credentials for Custom Channels\": \"To use a custom channel, you need to supply credentials for it in a credentials configuration file\\ncalled `credentials.yml`. \\nThis credentials file has to contain the **module path** (not the channel name) of your custom channel and\\nany required configuration parameters. \\n\\nFor example, for a custom connector class called `MyIO` saved in a file `addons/custom_channel.py`, \\nthe module path would be `addons.custom_channel.MyIO`, and the credentials could look like:\\n\\n```\\naddons.custom_channel.MyIO:\\n username: \\\"user_name\\\"\\n another_parameter: \\\"some value\\\"\\n```\\n\\nTo make the Rasa\\nserver aware of your custom channel, specify the path to `credentials.yml` to the Rasa server at startup with the command line argument `--credentials` .\", \"Testing the Custom Connector Webhook\": \"To test your custom connector, you can `POST` messages to the webhook using a json body with the following format:\\n\\n```\\n{\\n \\\"sender\\\": \\\"test_user\\\", // sender ID of the user sending the message\\n \\\"message\\\": \\\"Hi there!\\\",\\n \\\"metadata\\\": {} // optional, any extra info you want to add for processing in NLU or custom actions\\n}\\n```\\n\\nFor a locally running Rasa server, the curl request would look like this:\\n\\n```\\ncurl --request POST \\\\\\n --url http://localhost:5005/webhooks/myio/webhook \\\\\\n --header 'Content-Type: application/json' \\\\\\n --data '{\\n \\\"sender\\\": \\\"test_user\\\",\\n \\\"message\\\": \\\"Hi there!\\\",\\n \\\"metadata\\\": {}\\n }'\\n```\"}, \"metadata\": {\"id\": \"custom-connectors\", \"sidebar_label\": \"Custom Connectors\", \"title\": \"Custom Connectors\", \"description\": \"Deploy and Run a Rasa Chat Bot on a custom chat interface\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 2]\"}, {\"title\": \"Facebook Messenger\", \"description\": \"Build a Rasa Chat Bot on Facebook Messenger\", \"content\": {\"Facebook Setup\": {\"Getting Credentials\": \"**How to get the Facebook credentials:**\\nYou need to set up a Facebook app and a page.\\n\\n['To create the app head over to\\\\n[Facebook for Developers](https://developers.facebook.com/)\\\\nand click on **My Apps** \\u2192 **Add New App**.', 'Go onto the dashboard for the app and under **Products**,\\\\nfind the **Messenger** section and click **Set Up**. Scroll down to\\\\n**Token Generation** and click on the link to create a new page for your\\\\napp.', 'Create your page and select it in the dropdown menu for the\\\\n**Token Generation**. The shown **Page Access Token** is the\\\\n`page-access-token` needed later on.', 'Locate the **App Secret** in the app dashboard under **Settings** \\u2192 **Basic**.\\\\nThis will be your `secret`.', 'Use the collected `secret` and `page-access-token` in your\\\\n`credentials.yml`, and add a field called `verify` containing\\\\na string of your choice. Start `rasa run` with the\\\\n`--credentials credentials.yml` option.', 'Set up a **Webhook** and select at least the **messaging** and\\\\n**messaging_postback** subscriptions. Insert your callback URL, which will\\\\nlook like `https://<host>:<port>/webhooks/facebook/webhook`, replacing\\\\nthe host and port with the appropriate values from your running Rasa server.', 'Insert the **Verify Token** which has to match the `verify`\\\\nentry in your `credentials.yml`.']\\n\\n:::note configure https\\nFacebook Messenger only forwards\\nmessages to endpoints via `https`, so take appropriate measures to add\\nit to your setup. For local testing of your bot, see [Testing Channels on Your Local Machine](../messaging-and-voice-channels.mdx#testing-channels-on-your-local-machine).\\n:::\\n\\nFor more detailed steps, visit the\\n[Messenger docs](https://developers.facebook.com/docs/graph-api/webhooks).\", \"Running On Facebook Messenger\": \"Add the Facebook credentials to your `credentials.yml`:\\n\\n```\\nfacebook:\\n verify: \\\"rasa-bot\\\"\\n secret: \\\"3e34709d01ea89032asdebfe5a74518\\\"\\n page-access-token: \\\"EAAbHPa7H9rEBAAuFk4Q3gPKbDedQnx4djJJ1JmQ7CAqO4iJKrQcNT0wtD\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Facebook Messenger to send messages to.\"}, \"Supported response attachments\": \"In addition to typical text, image, and custom responses, the Facebook Messenger\\nchannel supports the following additional response attachments:\\n\\n['[Buttons](https://developers.facebook.com/docs/messenger-platform/send-messages/buttons)\\\\nare structured the same as other Rasa buttons. Facebook API limits the amount of\\\\nbuttons you can sent in a message to 3. If more than 3 buttons are provided in a\\\\nmessage, Rasa will ignore all provided buttons.', \\\"[Quick Replies](https://developers.facebook.com/docs/messenger-platform/send-messages/quick-replies)\\\\nprovide a way to present a set of up to 13 buttons in-conversation that contain a\\\\ntitle and optional image, and appear prominently above the composer. You can also\\\\nuse quick replies to request a person's email address or phone number.\\\", \\\"```\\\\nutter_fb_quick_reply_example:\\\\n - text: Hello World!\\\\n quick_replies:\\\\n - title: Text quick reply\\\\n payload: /example_intent\\\\n - title: Image quick reply\\\\n payload: /example_intent\\\\n image_url: http://example.com/img/red.png\\\\n # below are Facebook provided quick replies\\\\n # the title and payload will be filled\\\\n # with the user's information from their profile\\\\n - content_type: user_email\\\\n title:\\\\n payload:\\\\n - content_type: user_phone_number\\\\n title:\\\\n payload:\\\\n```\\\"]\\n\\n:::note\\nBoth Quick Reply and Button titles in Facebook Messenger have a character limit of\\n\\n['Titles longer than 20 characters will be truncated.']\\n\\n:::\\n\\n['[Elements](https://developers.facebook.com/docs/messenger-platform/send-messages/template/generic)\\\\nprovide a way to create a horizontally scrollable list up to 10 content elements that\\\\nintegrate buttons, images, and more alongside text a single message.', '```\\\\nutter_fb_element_example:\\\\n - text: Hello World!\\\\n elements:\\\\n - title: Element Title 1\\\\n subtitle: Subtitles are supported\\\\n buttons: # note the button limit still applies here\\\\n - title: Example button A\\\\n payload: /example_intent\\\\n - title: Example button B\\\\n payload: /example_intent\\\\n - title: Example button C\\\\n payload: /example_intent\\\\n - title: Element Title 2\\\\n image_url: http://example.com/img/red.png\\\\n buttons:\\\\n - title: Example button D\\\\n payload: /example_intent\\\\n - title: Example button E\\\\n payload: /example_intent\\\\n - title: Example button F\\\\n payload: /example_intent\\\\n```']\"}, \"metadata\": {\"id\": \"facebook-messenger\", \"sidebar_label\": \"Facebook Messenger\", \"title\": \"Facebook Messenger\", \"description\": \"Build a Rasa Chat Bot on Facebook Messenger\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 3]\"}, {\"title\": \"Google Hangouts Chat\", \"description\": \"Build a Rasa Chat Bot on Google Hangouts Chat\", \"content\": {\"Hangouts Chat Setup\": {\"Running On Hangouts Chat\": \"Add the Hangouts credentials to your `credentials.yml`:\\n\\n```\\nhangouts:\\n # no credentials required here\\n```\\n\\nIf you want to use OAuth2, add the project id obtained from the Google Developer Console:\\n\\n```\\nhangouts:\\n project_id: \\\"12345678901\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Google Hangouts to send messages to.\", \"Cards and Interactive Cards\": \"There are two ways in which Hangouts Chat will display bot messages, either as text or card. For each received\\nrequest, your bot will send all messages in one response. If one of those messages is a card (e.g. an image),\\nall other messages are converted to card format as well.\\n\\nInteractive cards trigger the `CARD_CLICKED` event for user interactions, e.g. when a button is clicked. When\\ncreating an interactive card, e.g. via `dispatcher.utter_button_message()` in your `actions.py`, you can\\nspecify a payload for each button that is going to be returned with the `CARD_CLICKED` event and extracted\\nby the `HangoutsInput` channel (for example\\n`buttons=[{\\\"text\\\":\\\"Yes!\\\", \\\"payload\\\":\\\"/affirm\\\"}, {\\\"text\\\":\\\"Nope.\\\", \\\"payload\\\":\\\"/deny\\\"}])`.\\nUpdating cards is not yet supported.\\n\\nFor more detailed information on cards, visit the\\n[Hangouts docs](https://developers.google.com/hangouts/chat/reference).\", \"Other Hangouts Chat Events\": \"Except for `MESSAGE` and `CARD_CLICKED`, Hangouts Chat knows two other event types, `ADDED_TO_SPACE` and\\n`REMOVED_FROM_SPACE`, which are triggered when your bot is added or removed from a direct message or chat room\\nspace. The default intent names for these events can be modified in the `HangoutsInput` constructor method.\"}}, \"metadata\": {\"id\": \"hangouts\", \"sidebar_label\": \"Google Hangouts Chat\", \"title\": \"Google Hangouts Chat\", \"description\": \"Build a Rasa Chat Bot on Google Hangouts Chat\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 4]\"}, {\"title\": \"Mattermost\", \"description\": \"Build a Rasa Chat Bot on Mattermost\", \"content\": {\"Getting Credentials\": \"Mattermost now uses bot accounts for better security. So you can use their guide to create\\nyour bot to get your token required for the credentials.yml file.\\n\\nFor more information on creating a bot account please see\\n[Bot Creation](https://docs.mattermost.com/developer/bot-accounts.html#bot-account-creation).\\n\\nFor information on converting existing user account into bot account please see\\n[User Conversion](https://docs.mattermost.com/developer/bot-accounts.html#how-do-i-convert-an-existing-account-to-a-bot-account).\\n\\n**How to set up the outgoing webhook:**\\n\\n['To create the Mattermost outgoing webhook, login to your Mattermost\\\\nteam site and go to **Main Menu > Integrations > Outgoing Webhooks**.', 'Click **Add outgoing webhook**.', \\\"Fill out the details including the channel you want the bot in.\\\\nYou will need to ensure the **trigger words** section is set up\\\\nwith `@yourbotname` so that the bot doesn't trigger on everything\\\\nthat is said.\\\", 'The **Content Type** must be set to `application/json`.', 'Make sure **trigger when** is set to value\\\\n**first word matches a trigger word exactly**.', 'Add the Callback URL, which will\\\\nlook like `http://<host>:<port>/webhooks/mattermost/webhook`, replacing\\\\nthe host and port with the appropriate values from your running Rasa server.']\\n\\nFor more detailed steps, visit the\\n[Mattermost docs](https://docs.mattermost.com/guides/developer.html).\", \"Running on Mattermost\": \"Add the Mattermost credentials to your `credentials.yml`:\\n\\n```\\nmattermost:\\n url: \\\"https://chat.example.com/api/v4\\\"\\n token: \\\"xxxxx\\\" # the token for the bot account from creating the bot step.\\n webhook_url: \\\"https://server.example.com/webhooks/mattermost/webhook\\\" # this should match the callback url from step 6\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Mattermost to send messages to.\"}, \"metadata\": {\"id\": \"mattermost\", \"sidebar_label\": \"Mattermost\", \"title\": \"Mattermost\", \"description\": \"Build a Rasa Chat Bot on Mattermost\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 5]\"}, {\"title\": \"Microsoft Bot Framework\", \"description\": \"Build a Rasa Chat Bot on Microsoft Bot Framework\", \"content\": {\"Running on Microsoft Bot Framework\": \"Add the Botframework credentials to your `credentials.yml`:\\n\\n```\\nbotframework:\\n app_id: \\\"MICROSOFT_APP_ID\\\"\\n app_password: \\\"MICROSOFT_APP_PASSWORD\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Microsoft Bot Framework to send messages to.\"}, \"metadata\": {\"id\": \"microsoft-bot-framework\", \"sidebar_label\": \"Microsoft Bot Framework\", \"title\": \"Microsoft Bot Framework\", \"description\": \"Build a Rasa Chat Bot on Microsoft Bot Framework\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 6]\"}, {\"title\": \"RocketChat\", \"description\": \"Build a Rasa Chat Bot on Rocketchat\", \"content\": {\"Getting Credentials\": \"**How to set up Rocket.Chat:**\\n\\n['Create a user that will be used to post messages, and set its\\\\ncredentials at credentials file.', 'Create a Rocket.Chat outgoing webhook by logging in as admin to\\\\nRocket.Chat and going to\\\\n**Administration > Integrations > New Integration**.', 'Select **Outgoing Webhook**.', 'Set **Event Trigger** section to value **Message Sent**.', \\\"Fill out the details, including the channel you want the bot\\\\nlisten to. Optionally, it is possible to set the\\\\n**Trigger Words** section with `@yourbotname` so that the bot\\\\ndoesn't trigger on everything that is said.\\\", 'In the **URLs** section, set the URL to \\\\n`http://<host>:<port>/webhooks/rocketchat/webhook`, replacing\\\\nthe host and port with the appropriate values from your running Rasa server.']\\n\\nFor more information on the Rocket.Chat Webhooks, see the\\n[Rocket.Chat Guide](https://docs.rocket.chat/use-rocket.chat/workspace-administration/integrations).\", \"Running on RocketChat\": \"Add the RocketChat credentials to your `credentials.yml`:\\n\\n```\\nrocketchat:\\n user: \\\"yourbotname\\\"\\n password: \\\"YOUR_PASSWORD\\\"\\n server_url: \\\"https://demo.rocket.chat\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for RocketChat to send messages to.\"}, \"metadata\": {\"id\": \"rocketchat\", \"sidebar_label\": \"RocketChat\", \"title\": \"RocketChat\", \"description\": \"Build a Rasa Chat Bot on Rocketchat\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 7]\"}, {\"title\": \"Slack\", \"description\": \"Build a Rasa Chat Bot on Slack\", \"content\": {\"Sending Messages\": \"Create a new file `credentials.yml` in the root folder of your Rasa\\nproject (if you've used `rasa init` this file should already exist and you can\\njust edit it). Add the following lines to the file:\\n\\n```\\nslack:\\n slack_channel: \\\"CA003L0XZ\\\" # channel ID, not a channel name!\\n slack_token: \\\"xoxb-XXX\\\" # token obtained in the next step\\n slack_signing_secret: \\\"YYY\\\" # secret obtained in the next step\\n```\\n\\nThe `slack_channel` can be a channel or an individual person that the bot should\\nlisten to for communications, in addition to the default behavior of listening\\nfor direct messages and app mentions, i.e. *@app_name*.\\nTo get a channel id, right click on the channel in Slack and choose **Copy Link**.\\nThe id will be the last component in the URL.\\n\\nIn the next couple steps, you'll create a Slack App to get the values for\\n`slack_token` and `slack_signing_secret`:\\n\\n['To create the app go to [Your Apps](https://api.slack.com/apps \\\"The Your Apps section of your Slack interface\\\") and click\\\\non **Create New App**.', '<Image img={createAppImg} caption=\\\"Create New App\\\" alt=\\\"Create New Slack App Screenshot\\\" max-width=\\\"500px\\\"/>', \\\"Fill out your **App Name** and select the **Development Workspace** where\\\\nyou'll play around and build your app.\\\", 'Head over to **OAuth & Permissions** and scroll down to **Scopes**. Scopes give\\\\nyour app permission to do things in your workspace.', 'To get started, you should at least add the following scopes:', ['`app_mentions:read`,', '`channels:history`,', '`chat:write`,', '`groups:history`,', '`im:history`,', '`mpim:history` and', '`reactions:write`.'], '<Image img={scopesImg} caption=\\\"Set up Slack Permissions\\\" alt=\\\"Set up Slack Permissions Screenshot\\\" max-width=\\\"500px\\\" />', 'In Slacks API documentation you can find a\\\\n[list and explanation of all available scopes](https://api.slack.com/scopes).', 'On the **OAuth & Permissions** page, click **Install App to Workspace** to add\\\\nthe bot to your workspace.', '<Image img={installAppImg} caption=\\\"Install Slack App\\\" alt=\\\"Install Slack App Screenshot\\\" max-width=\\\"500px\\\"/>', \\\"Once added, Slack will show you a **Bot User OAuth Access Token** which you'll\\\\nneed to add to your `credentials.yml` as the value for `slack_token`:\\\", '```\\\\nslack:\\\\n slack_channel: \\\"your-channel\\\" # choose a channel for your bot\\\\n slack_token: \\\"xoxb-XXX\\\" # token obtained in the next step\\\\n slack_signing_secret: \\\"YYY\\\" # secret obtained in the next step\\\\n```', 'The token should start with `xoxb`.', 'Head over to **Basic Information** to gather the **Signing Secret**.', '<Image img={secretImg} caption=\\\"Signing Secret\\\" alt=\\\"Signing Secret Screenshot\\\" max-width=\\\"500px\\\"/>', 'Copy the signing secret into your `credentials.yml` as the value for `slack_signing_secret`:', '```\\\\nslack:\\\\n slack_channel: \\\"your-channel\\\" # choose a channel for your bot\\\\n slack_token: \\\"xoxb-XXX\\\" # token obtained in the next step\\\\n slack_signing_secret: \\\"YYY\\\" # secret obtained in the next step\\\\n```']\\n\\nThis setup will allow your bot to send messages. Now let's head over to the setup\\nfor receiving and reacting to messages.\", \"Receiving Messages\": \"Before continuing, make sure you have configured a Slack App for [Sending Messages](./slack.mdx#sending-messages) and have added Slack credentials to your `credentials.yml` file.\\n\\nTo receive messages, you will need a publicly available URL for Slack to reach\\nyour bot and tell you about new messages. If you are running locally, you can\\n[test channels using ngrok](../messaging-and-voice-channels.mdx#testing-channels-on-your-local-machine)\\n\\n['To configure your bot to receive messages, your bot needs to be running.\\\\nStart your bot e.g. using', '```\\\\nrasa run\\\\n```', 'If you are running locally, make sure ngrok (or another tool to retrieve a public\\\\nurl) is running as well.', 'To send messages directly to your bot using the slack UI, head to **App Home**,\\\\nscroll to the bottom and select the checkbox for\\\\n`Allow users to send Slash commands and messages from the messages tab.`', 'You might have to quit the Slack app and re-open it before your changes take effect.', '<Image img={appHomeImg} caption=\\\"Messages Tab\\\" alt=\\\"Allow users to send Slash commands and messages from the messages tab\\\" max-width=\\\"500px\\\"/>', 'Configure the webhook by heading to **Event Subscriptions** and\\\\nturning **Enable Events** on.', 'As a request URL enter the public url of your bot and append `/webhooks/slack/webhook`, e.g.\\\\n`https://<host>/webhooks/slack/webhook` replacing `<host>` with your URL. If you\\\\nare using ngrok, your url should look like `https://92832de0.ngrok.io/webhooks/slack/webhook`.', \\\"You won't be able to use a `localhost` url.\\\", '<Image img={requestUrlImg} caption=\\\"Request URL\\\" alt=\\\"Request URL Screenshot\\\" max-width=\\\"500px\\\"/>', \\\"As a last step, you'll need to **Subscribe to bot events** on the same page.\\\\nYou'll need to add the following events:\\\", ['`message.channels`,', '`message.groups`,', '`message.im` and', '`message.mpim`.'], '<Image img={eventsImg} caption=\\\"Subscribe to Bot Events\\\" alt=\\\"Subscribe to Bot Events Screenshot\\\" max-width=\\\"500px\\\"/>', \\\"Make sure to hit **Save Changes** at the bottom of the page after you've added these events.\\\", \\\"(If you didn't grant all required permissions to your app while setting up\\\\nsending of messages, you'll be prompted to **reinstall your app** which you will\\\\nneed to do. Otherwise, Slack will confirm your change with a **Success!**)\\\"]\\n\\n:::note invite to channels\\nAs per [Slack docs](https://api.slack.com/authentication/basics#calling), make\\nsure you invite your bot to a channel it should be accessing. You can do this\\nby using `/invite` in the channel.\\n:::\\n\\nYour bot is now ready to go and will receive webhook notifications about new messages.\", \"Optional: Interactive Components\": \"After you've completed [Sending Messages](./slack.mdx#sending-messages) and\\n[Receiving Messages](./slack.mdx#receiving-messages) your bot is ready to go. If you\\nwant to use Slack's [interactive components](https://api.slack.com/block-kit/interactivity) (buttons or menus), you'll need to do\\nsome additional configuration:\\n\\nOpen the **Interactivity & Shortcuts** page and toggle **Interactivity** to be on.\\nAfterwards, you'll need to enter the same url into the **Request URL** field which\\nyou used in Step 2 of [Receiving Messages](./slack.mdx#receiving-messages), e.g. `https://<host>/webhooks/slack/webhook`.\\n\\n<Image img={interactivityImg} caption=\\\"Enabling Interactivity\\\" alt=\\\"Interactivity Screenshot\\\" max-width=\\\"500px\\\"/>\", \"Additional Slack Options\": \"Here is a complete overview of all the configuration parameters for the Slack\\nconnection:\\n\\n```\\nslack:\\n slack_channel: \\\"CA003L0XZ\\\" # channel ID, not a channel name!\\n slack_token: \\\"xoxb-XXX\\\" # token obtained in the next step\\n slack_signing_secret: \\\"YYY\\\" # secret obtained in the next step\\n proxy: \\\"http://myProxy.online\\\" # Proxy Server to route your traffic through. This configuration is optional. Only HTTP proxies are supported\\n slack_retry_reason_header: \\\"x-slack-retry-reason\\\" # Slack HTTP header name indicating reason that slack send retry request. This configuration is optional.\\n slack_retry_number_header: \\\"x-slack-retry-num\\\" # Slack HTTP header name indicating the attempt number. This configuration is optional.\\n errors_ignore_retry: None # Any error codes given by Slack included in this list will be ignored. Error codes are listed [here](https://api.slack.com/events-api#errors).\\n use_threads: False # If set to True, bot responses will appear as a threaded message in Slack. This configuration is optional and set to False by default.\\n conversation_granularity: \\\"sender\\\" # sender allows 1 conversation per user (across channels), channel allows 1 conversation per user per channel, thread allows 1 conversation per user per thread. This configuration is optional and set to sender by default.\\n```\\n\\nMake sure to restart your Rasa server after changing the\\n`credentials.yml` for the changes to take effect.\"}, \"metadata\": {\"id\": \"slack\", \"sidebar_label\": \"Slack\", \"title\": \"Slack\", \"description\": \"Build a Rasa Chat Bot on Slack\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 8]\"}, {\"title\": \"Telegram\", \"description\": \"Build a Rasa Chat Bot on Telegram\", \"content\": {\"Getting Credentials\": \"**How to get the Telegram credentials:**\\nYou need to set up a Telegram bot.\\n\\n['To create the bot, go to [Bot Father](https://web.telegram.org/#/im?p=@BotFather),\\\\nenter `/newbot` and follow the instructions. The URL that Telegram should send messages to will look like\\\\n`http://<host>:<port>/webhooks/telegram/webhook`, replacing\\\\nthe host and port with the appropriate values from your running Rasa server.', 'At the end you should get your `access_token` and the username you\\\\nset will be your `verify`.', \\\"If you want to use your bot in a group setting, it's advisable to\\\\nturn on group privacy mode by entering `/setprivacy`. Then the bot\\\\nwill only listen when a user's message starts with `/bot`.\\\"]\\n\\nFor more information, check out the [Telegram HTTP API](https://core.telegram.org/bots/api).\", \"Running on Telegram\": \"Add the Telegram credentials to your `credentials.yml`:\\n\\n```\\ntelegram:\\n access_token: \\\"490161424:AAGlRxinBRtKGb21_rlOEMtDFZMXBl6EC0o\\\"\\n verify: \\\"your_bot\\\"\\n webhook_url: \\\"https://your_url.com/webhooks/telegram/webhook\\\"\\n```\\n\\nRestart your Rasa server\\nto make the new channel endpoint available for Telegram to send messages to.\\n\\n:::note Handling `/start` message\\n\\nAt the beginning of a conversation, the user will press the 'Start' button in Telegram.\\nThis will trigger a message with the content */start* to be sent.\\nMake sure your bot can handle this intro message by designing a specific intent in the nlu training data file.\\nThen add this `start` intent to the domain alongside a story or rule to handle it.\\n\\n:::\", \"Supported Response Attachments\": \"In addition to standard `text:` responses, this channel also supports the following components from the [Telegram API](https://core.telegram.org/bots/api/#message):\\n\\n['`button` arguments:', ['button_type: inline | vertical | reply'], '`custom` arguments:', ['photo', 'audio', 'document', 'sticker', 'video', 'video_note', 'animation', 'voice', 'media', 'latitude, longitude (location)', 'latitude, longitude, title, address (venue)', 'phone_number', 'game_short_name', 'action']]\\n\\nExamples:\\n\\n```\\n\\n utter_ask_transfer_form_confirm:\\n - buttons:\\n - payload: /affirm\\n title: Yes\\n - payload: /deny\\n title: No, cancel the transaction\\n button_type: vertical\\n text: Would you like to transfer {currency}{amount_of_money} to {PERSON}?\\n image: \\\"https://i.imgur.com/nGF1K8f.jpg\\\"\\n```\\n\\n```\\n utter_giraffe_sticker:\\n - text: Here's my giraffe sticker!\\n custom:\\n sticker: \\\"https://github.com/TelegramBots/book/raw/master/src/docs/sticker-fred.webp\\\"\\n```\"}, \"metadata\": {\"id\": \"telegram\", \"sidebar_label\": \"Telegram\", \"title\": \"Telegram\", \"description\": \"Build a Rasa Chat Bot on Telegram\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 9]\"}, {\"title\": \"Twilio Voice\", \"description\": \"Deploy a Rasa IVR assistant via the Twilio Voice connector\", \"content\": {\"Running on Twilio\": {\"Connect to a Twilio Phone Number\": \"To forward calls from Twilio to your Rasa assistant the webhook for your phone number needs to be updated. Go to the [Phone\\nNumbers](https://www.twilio.com/console/phone-numbers/incoming) section of your Twilio account and select the phone\\nnumber you want to connect to Rasa. Find the `Voice & Fax` section on the screen. Under the `A CALL COMES IN` section\\nadd the webhook URL (e.g. `https://<host>:<port>/webhooks/twilio_voice/webhook`) for your Rasa bot replacing the host\\nand port with the appropriate values for your deployment. Click `Save` at the bottom of the page.\\n\\n<Image img={twilioWebhook} caption=\\\"Set Twilio Webhook\\\" alt=\\\"Screenshot of Twilio Console to Set Webhook\\\" max-width=\\\"500px\\\"/>\", \"Connect to a Twilio SIP Domain\": \"You can also connect your Twilio Voice channel to a Twilio SIP domain. You can follow the\\n[Twilio Sending SIP](https://www.twilio.com/docs/voice/api/sending-sip) guide to forward SIP requests to your Twilio SIP\\ndomain. Once your SIP domain is configured you will have to forward incoming calls to Rasa. In the Twilio console go to\\nthe [SIP Domains](https://console.twilio.com/develop/voice/manage/sip-domains?frameUrl=/console/voice/sip/endpoints)\\nsection. Select the SIP domain you would like to use. Find the `Call Control Configuration` section and add the\\nwebhook URL (e.g. `https://<host>:<port>/webhooks/twilio_voice/webhook`) for your Rasa bot replacing the host and port\\nwith the appropriate values for your deployment. Click `Save` at the bottom of the page.\\n\\n<Image img={twilioSipWebhook} caption=\\\"Set Twilio SIP Domain Webhook\\\" alt=\\\"Screenshot of Twilio Console to Set Webhook\\\" max-width=\\\"500px\\\"/>\"}, \"Configure Channel in Rasa\": \"In your `credentials.yml` file make sure the `twilio_voice` channel is added. Within `credentials.yml` there are a\\nnumber of parameters you can set to control the behavior of your assistant. An example with definitions of each\\nparameter is below. Unlike the Twilio text channel there is no need to add your Twilio\\ncredentials for the voice channel. Note, changing values for `enhanced` and `assistant_voice` can result in added costs\\nfrom Twilio. Review the documentation below for details about these settings.\\n\\n```\\ntwilio_voice:\\n initial_prompt: \\\"hello\\\"\\n assistant_voice: \\\"woman\\\"\\n reprompt_fallback_phrase: \\\"I didn't get that could you repeat?\\\"\\n speech_timeout: \\\"5\\\"\\n speech_model: \\\"default\\\"\\n enhanced: \\\"false\\\"\\n```\", \"Parameter Definitions\": {\"Initial Prompt\": \"When Twilio receives a new call and forwards this to Rasa, Twilio does not provide a user message. In this\\ncase Rasa will act as if the user sent the message \\\"Hello\\\". This behavior can be configured in your\\n`credentials.yml` file by setting the `initial_prompt` parameter to the desired input. The `initial_prompt` value will\\nbe sent to Rasa and the response will be spoken to the user to start the voice conversation. How you greet\\na user via a voice channel may differ from a text channel. You should review your responses and consider creating\\n[channel-specific variations](../responses.mdx#channel-specific-response-variations) where\\nnecessary.\", \"Assistant Voice\": \"You can add personality to your assistant by specifying the type of voice your assistant should speak with. In the\\n`credentials.yml` file you can add an option for `assistant_voice` to specify the type of voice of your assistant. For a\\nlist of supported voices you can check the [Twilio documentation](https://www.twilio.com/docs/voice/twiml/say#voice). By\\ndefault Twilio's `woman` voice will be used. Note that you will incur additional charges for using any of the `Polly`\\nvoices. The Twilio documentation has details about\\n[Polly pricing](https://www.twilio.com/docs/voice/twiml/say/text-speech#pricing).\", \"Reprompt Fallback Phrase\": \"Unlike text channels where users can review previous messages in the conversation and take their time to\\nreply, with voice channels users can get confused when there is a pause in the conversation. When a long pause is\\ndetected during a conversation Rasa will repeat the last utterance from the bot to re-prompt the user for a response. If\\nthe previous bot utterance cannot be identified then the message defined in `reprompt_fallback_phrase` will be sent. By\\ndefault this is set to \\\"I'm sorry I didn't get that could you rephrase\\\".\", \"Speech Timeout\": \"How long Twilio will collect speech from the caller. This parameter must be set to a number or \\\"auto\\\". If a number is\\nprovided the assistant will collect speech for the specified amount of time. If `speech_timeout` is set to \\\"auto\\\" then\\nTwilio will collect speech until a pause is detected. The default setting of this parameter is \\\"auto\\\". You can find more\\ndetails about `speech_timeout` in the\\n[Twilio documentation](https://www.twilio.com/docs/voice/twiml/gather#speechtimeout). Note that `speech_timeout=\\\"auto\\\"`\\nis only compatible with `speech_model='numbers_and_commands'`. An error will be raised if an incompatible\\n`speech_model` is used with the `speech_timeout`.\", \"Speech Model\": \"Adjusting the `speech_model` parameter can help Twilio with the accuracy of its speech-to-text transformation. Valid\\nvalues are `default`, `numbers_and_commands`, and `phone_call`. The default setting is \\\"default\\\". You can find more\\ndetails about `speech_model` in the\\n[Twilio documentation](https://www.twilio.com/docs/voice/twiml/gather#speechmodel).\", \"Enhanced\": \"Setting `enhanced` to `true` will allow you to use Twilio's premium speech model to improve the accuracy of\\ntranscription results. Note, setting this parameter to `true` will result in higher Twilio transcription costs. This\\nparameter is only supported if you also have set the `speech_model` parameter to `phone_call`. By default `enhanced` is\\nset to \\\"false\\\". You can find more about the `enhanced` speech model option in the\\n[Twilio documentation](https://www.twilio.com/docs/voice/twiml/gather#enhanced).\"}, \"Custom Voice Responses\": \"It is highly recommended that you provide voice\\n[channel specific responses](../responses.mdx#channel-specific-response-variations) for all\\nresponses containing images, emojis and/or abbreviations. Visual media like images and emojis do not translate well to\\nvoice applications. Having voice alternatives to those responses lets you tailor the user experience to the voice\\nchannel. If a response is detected as containing either an image or emoji a warning will be raised. The image or emoji\\nwill be removed from the response and only any accompanying text will be included in the response back to the user.\\n\\nIn addition to reviewing responses containing images and emojis you should also review all other responses for their\\napplicability to voice channels. Short-hand abbreviations like \\\"e.g.\\\" do not translate well. Voice responses should use\\nthe long-hand versions of any abbreviations. Interactions with users can differ between text and voice channels.\\nReviewing all responses in the scope of a voice channel and providing voice specific responses can make for a better\\nuser experience.\"}, \"metadata\": {\"id\": \"twilio-voice\", \"sidebar_label\": \"Twilio Voice\", \"title\": \"Twilio Voice\", \"description\": \"Deploy a Rasa IVR assistant via the Twilio Voice connector\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 10]\"}, {\"title\": \"Twilio\", \"description\": \"Deploy a Rasa assistant through text message or WhatsApp via the Twilio connector\", \"content\": {\"Getting Credentials\": {\"Connecting to WhatsApp\": \"You can deploy a Rasa assistant to WhatsApp through Twilio. However, to do so, you have\\nto have a [WhatsApp Business](https://www.whatsapp.com/business/) profile. Associate\\nyour Whatsapp Business profile with the phone number you purchased through Twilio to\\naccess the [Twilio API for WhatsApp](https://www.twilio.com/docs/whatsapp/api).\\n\\nAccording to the [Twilio API documentation](https://www.twilio.com/docs/whatsapp/api#using-phone-numbers-with-whatsapp),\\nthe phone number you use should be prefixed with whatsapp: in the `credentials.yml` described below.\"}, \"Running on Twilio\": {\"Receiving Location Data from Whatsapp with Twilio connector\": \"This is how you can receive location data (WhatsApp Location) from a user on this channel:\\n\\n['Create an intent named \\\"locationData\\\" and define two entities and slots for Latitude and Longitude respectively.']\\n\\n```\\nintents:\\n - locationData\\n\\nslots:\\n Latitude:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: Latitude\\n\\n Longitude:\\n type: text\\n mappings:\\n - type: from_entity\\n entity: Longitude\\n\\nentities:\\n - Latitude\\n - Longitude\\n\\n```\\n\\n['When the user sends a location message, the locationData intent will be triggered and the slots will be set from the entities. Note that you do not need to provide training data for the entities as they are handled by the channel.']\"}}, \"metadata\": {\"id\": \"twilio\", \"sidebar_label\": \"Twilio\", \"title\": \"Twilio\", \"description\": \"Deploy a Rasa assistant through text message or WhatsApp via the Twilio connector\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 11]\"}, {\"title\": \"Your Own Website\", \"description\": \"Deploy and Run a Rasa Chat Bot on a Website\", \"content\": {\"REST Channels\": {\"RestInput\": {\"Request and Response Format\": \"After making the `rest` input channel available, you can `POST` messages to\\n`http://<host>:<port>/webhooks/rest/webhook`, with the following format:\\n\\n```\\n{\\n \\\"sender\\\": \\\"test_user\\\", // sender ID of the user sending the message\\n \\\"message\\\": \\\"Hi there!\\\"\\n}\\n```\\n\\nThe response from Rasa will be a JSON body of bot responses, for example:\\n\\n```\\n[\\n {\\\"text\\\": \\\"Hey Rasa!\\\"}, {\\\"image\\\": \\\"http://example.com/image.jpg\\\"}\\n]\\n```\"}, \"CallbackInput\": {\"Request and Response Format\": \"After making the `callback` input available, you can `POST` messages to\\n`http://<host>:<port>/webhooks/callback/webhook` with the following format:\\n\\n```\\n{\\n \\\"sender\\\": \\\"test_user\\\", // sender ID of the user sending the message\\n \\\"message\\\": \\\"Hi there!\\\"\\n}\\n```\\n\\nIf successful, the response will be `success`. Once Rasa is ready to send a\\nmessage to the user, it will call the `url` specified in your `credentials.yml` with a `POST`\\nrequest containing a JSON body of the bot's responses:\\n\\n```\\n[\\n {\\\"text\\\": \\\"Hey Rasa!\\\"}, {\\\"image\\\": \\\"http://example.com/image.jpg\\\"}\\n]\\n```\"}}, \"Websocket Channel\": {\"JWT Authentication\": \"The SocketIO channel can be optionally configured to perform JWT authentication on connect\\nby defining the `jwt_key` and optional `jwt_method` in the `credentials.yml` file. \\n\\n```\\nsocketio:\\n user_message_evt: user_uttered\\n bot_message_evt: bot_uttered\\n session_persistence: true\\n jwt_key: my_public_key\\n jwt_method: HS256\\n```\\n\\nWhen initially requesting the connection, the client should pass in an encoded payload\\nas a JSON object under the key `token`:\\n\\n```\\n{\\n \\\"token\\\": \\\"jwt_encoded_payload\\\"\\n}\\n```\", \"Chat Widget\": \"Once you've set up your SocketIO channel, you can use the official Rasa Chat Widget on any webpage.\\nJust paste the following into your site HTML and paste the URL of your Rasa instance into\\nthe `data-websocket-url` attribute\\n\\n```\\n<div id=\\\"rasa-chat-widget\\\" data-websocket-url=\\\"https://your-rasa-url-here/\\\"></div>\\n<script src=\\\"https://unpkg.com/@rasahq/rasa-chat\\\" type=\\\"application/javascript\\\"></script>\\n```\\n\\nFor more information, including how to fully customize the widget for your website, you can check out the [full documentation](https://chat-widget-docs.rasa.com/).\\n\\nAlternatively, if you want to embed the widget in a React app, there is\\n[a library in the NPM package repository](https://www.npmjs.com/package/@rasahq/rasa-chat).\"}}, \"metadata\": {\"id\": \"your-own-website\", \"sidebar_label\": \"Your Own Website\", \"title\": \"Your Own Website\", \"description\": \"Deploy and Run a Rasa Chat Bot on a Website\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56, \\\"subpages\\\", 12]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 56]\"}, {\"title\": \"Deploy\", \"description\": \"Documentation section: deploy\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/deploy\"}, \"subpages\": [{\"title\": \"Deploy Rasa Action Server\", \"description\": null, \"content\": {\"Installation Requirements\": [\"Check that you have installed the Kubernetes or OpenShift command line\\ninterface (CLI). You can check this using the following command:\", \"<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\", \"```\\nkubectl version --short --client\\n\\n# The output should be similar to this\\n# Client Version: v1.19.11\\n```\", \"</TabItem>\\n<TabItem value=\\\"openshift\\\">\", \"```\\noc version --client\\n\\n# The output should be similar to this\\n# Client Version: 4.7.13\\n```\", \"</TabItem>\\n</Tabs>\", \"If this command resulted in an error, please install the\\n[Kubernetes CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) or the\\n[OpenShift CLI](https://docs.openshift.com/container-platform/4.7/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli)\\ndepending on the cluster you\\u2019re using.\", \"Make sure that the Kubernetes / OpenShift CLI is correctly connected to\\nyour cluster. You can do so by using the following commands:\", \"<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\", \"```\\nkubectl version --short\\n\\n# The output should be similar to this\\n# Client Version: v1.19.11\\n# Server Version: v1.19.10\\n```\", \"</TabItem>\\n<TabItem value=\\\"openshift\\\">\", \"```\\noc version\\n\\n# The output should be similar to this\\n# Client Version: 4.7.13\\n# Kubernetes Version: v1.20.0+df9c838\\n```\", \"</TabItem>\\n</Tabs>\", \"If you get an error when executing the command, you are not connected to your\\ncluster. To get the command to connect to the cluster please consult your cluster\\u2019s\\nadmin or the documentation of your cloud provider.\", \"Make sure you have the [Helm CLI](https://helm.sh/docs/intro/install/)\\ninstalled. To check this, run:\", \"```\\nhelm version --short\\n\\n# The output should be similar to this\\n# v3.6.0+g7f2df64\\n```\", \"If this command leads to an error, please install the\\n[Helm CLI](https://helm.sh/docs/intro/install/).\", \"In case you are using a version `<3.5` of Helm, please update to Helm version\\n`>=3.5`.\"], \"1. Installation\": {\"a. Create Namespace\": \"We recommend installing Rasa Action Server in a separate\\n[namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)\\nto avoid interfering with existing cluster deployments. To create a new namespace\\nrun the following command:\\n\\n<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\\n\\n```\\nkubectl create namespace <your namespace>\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"openshift\\\">\\n\\n```\\noc create namespace <your namespace>\\n```\\n\\n</TabItem>\\n</Tabs>\", \"b. Deploy Rasa Action Server\": \"Run the following commands:\\n\\n```\\n# Add the repository which contains the Rasa Action Server Helm chart\\nhelm repo add rasa https://helm.rasa.com\\n\\n# Deploy Rasa Action Server\\nhelm install \\\\\\n --namespace <your namespace> \\\\\\n <release name> \\\\\\n rasa/rasa-action-server\\n```\", \"c. Access Rasa Action Server\": \"By default the Rasa Action Server deployment is exposed via the `rasa-action-server` (`<release name>`) service and accessible only within a Kubernetes cluster. You can get\\nthe IP address using this command:\\n\\n<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\\n\\n```\\n export SERVICE_PORT=$(kubectl get --namespace <your namespace> -o jsonpath=\\\"{.spec.ports[0].port}\\\" services <release name>)\\n kubectl port-forward --namespace <your namespace> svc/<release name> ${SERVICE_PORT}:${SERVICE_PORT} &\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"openshift\\\">\\n\\n```\\n export SERVICE_PORT=$(oc get --namespace <your namespace> -o jsonpath=\\\"{.spec.ports[0].port}\\\" services <release name>)\\n oc port-forward --namespace <your namespace> svc/<release name> ${SERVICE_PORT}:${SERVICE_PORT} &\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\nYou can then access the deployment on `http://127.0.0.1:${SERVICE_PORT}`\\n\\n:::note\\nThe Rasa Action Server Helm chart uses the [rasa-x-demo](https://github.com/RasaHQ/rasa-x-demo) Docker image as default. In the [Building an Action Server Image](#building-an-action-server-image)\\nyou can learn how to build and use your custom Action Server image.\\n:::\"}, \"Building an Action Server Image\": {\"Automating your Action Server Image Builds\": {\"Manually Building an Action Server\": \"To create your image:\\n\\n['Make sure your actions are defined in `actions/actions.py`. The `rasa/rasa-sdk`\\\\nimage will automatically look for the actions in this file.', 'If your actions have any extra dependencies, create a list of them in a file,\\\\n`actions/requirements-actions.txt`.', \\\"Create a file named `Dockerfile` in your project directory,\\\\nin which you'll extend the official SDK image, copy over your code, and add any custom dependencies (if necessary).\\\\nFor example:\\\", '<pre><code parentName=\\\"pre\\\" className=\\\"language-python\\\">\\\\n{`# Extend the official Rasa SDK image\\\\nFROM rasa/rasa-sdk:${variables.rasa_sdk_version}', 'Use subdirectory as working directory', 'WORKDIR /app', 'Copy any additional custom requirements, if necessary (uncomment next line)', 'COPY actions/requirements-actions.txt ./', 'Change back to root user to install dependencies', 'USER root', 'Install extra requirements for actions code, if necessary (uncomment next line)', 'RUN pip install -r requirements-actions.txt', 'Copy actions folder to working directory', 'COPY ./actions /app/actions', \\\"By best practices, don't run the code with root user\\\", 'USER 1001`}</code></pre>']\\n\\nYou can then build the image via the following command:\\n\\n```\\ndocker build . -t <account_username>/<repository_name>:<custom_image_tag>\\n```\\n\\nThe `<custom_image_tag>` should reference how this image will be different from others. For\\nexample, you could version or date your tags, as well as create different tags that have different code for production\\nand development servers. You should create a new tag any time you update your code and want to re-deploy it.\"}, \"Using your Custom Action Server Image\": \"If you're building this image to make it available from another server, you should push the image to a cloud repository.\\n\\nThis documentation assumes you are pushing your images to [DockerHub](https://hub.docker.com/).\\nDockerHub will let you host multiple public repositories and\\none private repository for free. Be sure to first [create an account](https://hub.docker.com/signup/)\\nand [create a repository](https://hub.docker.com/signup/) to store your images. You could also push images to\\na different Docker registry, such as [Google Container Registry](https://cloud.google.com/container-registry),\\n[Amazon Elastic Container Registry](https://aws.amazon.com/ecr/), or\\n[Azure Container Registry](https://azure.microsoft.com/en-us/services/container-registry/).\\n\\nYou can push the image to DockerHub via:\\n\\n```\\ndocker login --username <account_username> --password <account_password>\\ndocker push <account_username>/<repository_name>:<custom_image_tag>\\n```\\n\\nTo authenticate and push images to a different container registry, please refer to the documentation of\\nyour chosen container registry.\"}, \"Setting a Custom Action Server Image\": \"In order to use a Custom Action Server image along with the Rasa Action Server deployment, you have to\\nuse the following values for your deployment.\\n\\n```\\n# values.yaml\\nimage:\\n name: \\\"image_name\\\"\\n tag: \\\"image_tag\\\"\\n```\\n\\nthen upgrade your deployment by executing the command:\\n\\n```\\nhelm upgrade --namespace <namespace> --reuse-values \\\\\\n -f values.yaml <release name> rasa/rasa-action-server\\n```\", \"2. Connect Rasa Action Server to a Rasa deployment\": \"If you have deployed your assistant using the Rasa Helm chart, and you have deployed your Rasa Action Server as well.\\nNow it's time to connect them together. You can do this easily by following the steps:\\n\\na. Create a `rasa-values.yaml` file which will include configuration for the Rasa deployment.\\n\\n```\\n# rasa-values.yaml\\nrasa-action-server:\\n external:\\n # -- Determine if external URL is used\\n enabled: true\\n # -- URL to Rasa Action Server\\n url: \\\"http://rasa-action-server/webhook\\\"\\n```\\n\\nThe configuration above tells Rasa which Rasa Action Server to use. In the example the `http://rasa-action-server/webhook` URL is used,\\nthe URL indicates that Rasa Action Server is deployed with release name `rasa-action-server`, and is located in the same namespace as Rasa server deployment.\\n\\nb. Upgrade the Rasa deployment\\n\\n```\\nhelm upgrade -n <namespace> --reuse-values -f rasa-values.yaml \\\\\\n <release name> rasa/rasa\\n```\"}, \"metadata\": {\"id\": \"deploy-action-server\", \"sidebar_label\": \"Deploy Action Server\", \"title\": \"Deploy Rasa Action Server\", \"abstract\": \"This page explains how to build an Action Server Image and deploy a Rasa Action Server using Helm. The second of three steps in deploying your Rasa assistant.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 0]\"}, {\"title\": \"Deploy Rasa Pro Services\", \"description\": \"Deploy Rasa Rasa Pro Services in production\", \"content\": {\"Rasa Pro Services Setup\": {\"Prerequisites\": {\"System Requirements\": \"The minimum hardware requirements include information about the\\nrequirements you need to install and use Rasa Pro Services. Hardware\\nrequirements are dependent on the average number of conversations and\\nexpected workload. Your exact needs may be more, depending on your workload.\\n\\nThe following is the recommended minimum hardware guidance:\\n\\n['CPU: 2 vCPU', 'Memory: 4 GB', 'Disk space: 10 GB']\\n\\nThese requirements correspond to the `t3.medium` instance type on AWS.\", \"License\": \"Running Rasa Pro Services requires a valid license. You need to supply the\\nlicense as an environment variable to the service.\"}, \"Installation and Configuration\": \"Rasa Plus streams data to Kafka which gets consumed by Rasa Pro Services.\\nThese different services need to be run and configured to be able to communicate.\\n\\n['Configure Rasa Plus to stream data to Kafka. The configuration for\\\\nKafka should be put in a configuration\\\\nfile `endpoints.yml`:', '```\\\\nevent_broker:\\\\n type: kafka\\\\n partition_by_sender: True\\\\n topic: rasa-events\\\\n url: <BROKER URL>\\\\n```', 'The `<BROKER_URL>` needs to be replaced with an address of a bootstrap\\\\nserver of your Kafka cluster. Configuration examples for different\\\\nsecurity protocols and other parameters can be found in the\\\\n[Kafka Event Broker](../event-brokers.mdx#kafka-event-broker)\\\\ndocumentation.', 'Rasa Pro Services is a docker image. Authenticate to pull\\\\nthe docker images:', '```\\\\ngcloud auth configure-docker europe-west3-docker.pkg.dev\\\\n```', 'Pull the Rasa Pro Services image to your machine:', '```\\\\ndocker pull europe-west3-docker.pkg.dev/rasa-releases/rasa-pro/rasa-pro\\\\n```', ':::note', 'For a more complete walkthrough on how to manage the authentication\\\\ncredentials and licenses in a production environment, see the\\\\n[Rasa Plus Deployment Guide](/docs/rasa/deploy/deploy-rasa#4-deploy-rasa-assistant) (select the **Rasa Plus** tab).', ':::', 'Run the Rasa Pro Services docker image and configure it to receive data\\\\nfrom your Rasa Plus assistant connected to Kafka:', '```\\\\ndocker run \\\\\\\\\\\\n -e RASA_PRO_LICENSE=<your_license> \\\\\\\\\\\\n -e KAFKA_BROKER_ADDRESS=<BROKER_URL> \\\\\\\\\\\\n -e KAFKA_TOPIC=rasa-events \\\\\\\\\\\\n europe-west3-docker.pkg.dev/rasa-releases/rasa-pro/rasa-pro\\\\n```', 'For production deployments, we recommend to us\\\\n[Amazon Elastic Container Service](https://docs.docker.com/cloud/ecs-integration/).']\", \"Docker Container Configuration (Reference)\": \"The Rasa Pro Services docker container supports configuration through\\nseveral environment variables. The following table lists the available\\nenvironment variables:\\n\\n| Environment Variable | Description | Default |\\n| :------------------------ | :-------------------------------------------------------------------------------------------------------------------- | :----------------- |\\n| `RASA_PRO_LICENSE` | **Required**. The license key for Rasa Pro Services. | |\\n| `KAFKA_BROKER_ADDRESS` | **Required**. The address of the Kafka broker. | |\\n| `KAFKA_TOPIC` | **Required**. The topic Rasa Plus publishes events to and Rasa Pro consumes from. | `rasa_core_events` |\\n| `LOGGING_LEVEL` | Set the log level of the application. Valid levels are DEBUG, INFO, WARNING, ERROR, CRITICAL. (Available from 3.0.2) | `INFO` |\\n| `RASA_ANALYTICS_DB_URL` | The URL of the data lake to store analytics data in. | |\\n| `KAFKA_SASL_MECHANISM` | The SASL mechanism to use for authentication. Valid mechanisms are | `PLAIN` |\\n| `KAFKA_SASL_USERNAME` | The username for SASL authentication. | |\\n| `KAFKA_SASL_PASSWORD` | The password for SASL authentication. | |\\n| `KAFKA_SECURITY_PROTOCOL` | The security protocol to use for communication with Kafka. Supported mechanisms are `PLAINTEXT` and `SASL_PLAINTEXT`. | `PLAINTEXT` |\\n| `KAFKA_SSL_CA_LOCATION` | The filepath for SSL CA Certificate that will be used to connect with Kafka (Available from `3.1.0b1`) | |\", \"Healthcheck Endpoint\": \"Rasa Pro Services exposes a health check endpoint at `/healthcheck`.\\nThe endpoint will return a `200` status code if the service is healthy.\\nIf any other status code is returned or if the endpoint is not reachable\\nthe service is unhealthy.\\n\\nExample response for `/healthcheck`:\\n\\n```\\n{\\n \\\"details\\\": {\\n \\\"analytics-consumer\\\": {\\n \\\"alive\\\": 1,\\n \\\"isHealthy\\\": true\\n }\\n },\\n \\\"isHealthy\\\": true\\n}\\n```\", \"Connect to a secured Kafka instance\": \"The connection to a secured Kafka instance can be configured by setting the\\nfollowing environment variables on the Rasa Pro docker container:\\n`KAFKA_SASL_MECHANISM`, `KAFKA_SASL_USERNAME`, `KAFKA_SASL_PASSWORD` and\\n`KAFKA_SECURITY_PROTOCOL`. A detailed description of the parameters can\\nbe found in the\\n[environment variable reference](#docker-container-configuration-reference).\\n\\nThe environment variables need to be configured upon startup of the Rasa Pro\\ndocker container.\\n\\nUsing Kafka `truststores` and `keystores` is currently not supported.\", \"Upgrading Versions\": \"To upgrade to the latest version of Rasa Pro Services, you must follow these steps:\\n\\n['Read the changelog documentation on breaking changes.', 'Download a new docker container and run it.']\\n\\n:::note Container Start-up\\nNote that the container might take some time to start-up as it is running\\ndatabase schema migrations as part of its start-up.\\n\\nIf the migrations have failed, the container will be shut down.\\n:::\"}}, \"metadata\": {\"id\": \"deploy-rasa-pro-services\", \"sidebar_label\": \"Deploy Rasa Pro Services\", \"title\": \"Deploy Rasa Pro Services\", \"description\": \"Deploy Rasa Rasa Pro Services in production\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 1]\"}, {\"title\": \"Deploy Rasa\", \"description\": \"Deploy a Rasa assistant on Kubernetes/Openshift using Helm\", \"content\": {\"Installation Requirements\": [\"Check that you have installed the Kubernetes or OpenShift command line\\ninterface (CLI). You can check this using the following command:\", \"<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\", \"```\\nkubectl version --short --client\\n\\n# The output should be similar to this\\n# Client Version: v1.19.11\\n```\", \"</TabItem>\\n<TabItem value=\\\"openshift\\\">\", \"```\\noc version --client\\n\\n# The output should be similar to this\\n# Client Version: 4.7.13\\n```\", \"</TabItem>\\n</Tabs>\", \"If this command resulted in an error, please install the\\n[Kubernetes CLI](https://kubernetes.io/docs/tasks/tools/install-kubectl/) or the\\n[OpenShift CLI](https://docs.openshift.com/container-platform/4.7/cli_reference/openshift_cli/getting-started-cli.html#installing-openshift-cli)\\ndepending on the cluster you\\u2019re using.\", \"Make sure that the Kubernetes / OpenShift CLI is correctly connected to\\nyour cluster. You can do so by using the following commands:\", \"<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\", \"```\\nkubectl version --short\\n\\n# The output should be similar to this\\n# Client Version: v1.19.11\\n# Server Version: v1.19.10\\n```\", \"</TabItem>\\n<TabItem value=\\\"openshift\\\">\", \"```\\noc version\\n\\n# The output should be similar to this\\n# Client Version: 4.7.13\\n# Kubernetes Version: v1.20.0+df9c838\\n```\", \"</TabItem>\\n</Tabs>\", \"If you get an error when executing the command, you are not connected to your\\ncluster. To get the command to connect to the cluster please consult your cluster\\u2019s\\nadmin or the documentation of your cloud provider.\", \"Make sure you have the [Helm CLI](https://helm.sh/docs/intro/install/)\\ninstalled. To check this, run:\", \"```\\nhelm version --short\\n\\n# The output should be similar to this\\n# v3.6.0+g7f2df64\\n```\", \"If this command leads to an error, please install the\\n[Helm CLI](https://helm.sh/docs/intro/install/).\", \"In case you are using a version `<3.5` of Helm, please update to Helm version\\n`>=3.5`.\"], \"Installation\": {\"1. Create Namespace\": \"We recommend installing Rasa in a separate\\n[namespace](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/)\\nto avoid interfering with existing cluster deployments. To create a new namespace\\nrun the following command:\\n\\n<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\\n\\n```\\nkubectl create namespace <your namespace>\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"openshift\\\">\\n\\n```\\noc create namespace <your namespace>\\n```\\n\\n</TabItem>\\n</Tabs>\", \"2. Create Values File\": \"Prepare an empty file called `rasa-values.yml` which will include all your custom\\nconfiguration for the installation with Helm.\\n\\nAll available values you can find in [the Rasa Helm Chart repository](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa#values).\\n\\n:::note\\nThe default configuration of the Rasa chart deploys a Rasa Server, downloads a model, and serves the downloaded model.\\nVisit [the Rasa Helm Chart repository](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa#quick-start) to check out more examples of configuration.\\n\\n:::\", \"3. Loading an initial model\": \"The first time you install Rasa, you may not have a model server available yet, or you may want a lightweight model for testing the deployment.\\nFor this purpose, you can choose between training or downloading an initial model. By default, the Rasa chart downloads an example model from GitHub.\\nTo use this option, you don't have to change anything.\\n\\nIf you want to define an existing model to download from a URL you define instead, update your `rasa-values.yaml` with the URL according to the following configuration:\\n\\n```\\napplicationSettings:\\n initialModel: \\\"https://github.com/RasaHQ/rasa-x-demo/blob/master/models/model.tar.gz?raw=true\\\"\\n```\\n\\n:::note\\nThe URL for the initial model download has to point to a tar.gz file and must not require authentication.\\n\\n:::\\n\\nIf you want to train an initial model you can do this by setting the `applicationSettings.trainInitialModel` to `true`.\\nIt creates a init container that trains a model based on data located in the `/app` directory. If the `/app` directory is empty it creates a new project.\\nYou can find an example that shows how to download data files from a git repository and train an initial model in the Rasa Helm Charts [examples](https://github.com/RasaHQ/helm-charts/blob/main/examples/rasa/train-model-helmfile.yaml).\", \"4. Deploy Rasa Assistant\": {\"Security Patch Releases\": \"Beginning with Rasa Plus 3.4.0, we release a new Docker image for supported versions each day at 0800 UTC. These images have OS security patches applied and include the date of generation in their tag in the format `YYYYMMDD`. \\nFor example, to use the 3.4.2 image generated on the 1st of February 2023, use the tag `3.4.2-20230201`. These images can optionally be used as a drop-in replacement for the same version of Rasa Plus, but with all OS security updates up to that date applied.\", \"Step 1: image pull secret\": \"You will need to create a pull secret to access the `rasa-plus` image. You should have\\nbeen provided with a JSON credentials file to access the registry.\\nThe file content should look similar to this:\\n\\n```\\n{\\n \\\"type\\\": \\\"service_account\\\",\\n \\\"project_id\\\": \\\"rasa-platform\\\",\\n \\\"private_key_id\\\": \\\"somerandomcharacters\\\",\\n \\\"private_key\\\": \\\"-----BEGIN PRIVATE KEY-----\\\\n\\\\nPBTu1lAJDLo136ZGTdMKi+/TuRqrIMg/..................................................................................................................................\\\\nsjAsuAH4Iz1XdfdenzGnyBZH\\\\n-----END PRIVATE KEY-----\\\\n\\\",\\n \\\"client_email\\\": \\\"company@rasa-platform.iam.gserviceaccount.com\\\",\\n \\\"client_id\\\": \\\"12345678910123\\\",\\n \\\"auth_uri\\\": \\\"https://accounts.google.com/o/oauth2/auth\\\",\\n \\\"token_uri\\\": \\\"https://accounts.google.com/o/oauth2/token\\\",\\n \\\"auth_provider_x509_cert_url\\\": \\\"https://www.googleapis.com/oauth2/v1/certs\\\",\\n \\\"client_x509_cert_url\\\": \\\"https://www.googleapis.com/robot/v1/metadata/x509/company%40rasa-platform.iam.gserviceaccount.com\\\"\\n}\\n```\\n\\nCreate the pull secret by running the corresponding command for your cluster environment:\\n\\n```\\n# kubernetes\\nkubectl --namespace <your namespace> \\\\\\n create secret docker-registry rasa-plus-pull-secret \\\\\\n --docker-server=https://europe-west3-docker.pkg.dev \\\\\\n --docker-email=company@rasa-platform.iam.gserviceaccount.com \\\\ # this value needs to be updated with correct client email\\n --docker-username=_json_key \\\\\\n --docker-password=\\\"$(cat <your-json-registry-creds-file>.json)\\\"\\n```\\n\\n```\\n# openshift\\noc --namespace <your namespace> \\\\\\n create secret docker-registry rasa-plus-pull-secret \\\\\\n --docker-server=https://europe-west3-docker.pkg.dev \\\\\\n --docker-email=company@rasa-platform.iam.gserviceaccount.com \\\\ # this value needs to be updated with correct client email\\n --docker-username=_json_key \\\\\\n --docker-password=\\\"$(cat <your-json-registry-creds-file>.json)\\\"\\n```\", \"Step 2: store license in a secret\": \"Step a: Save the license string to a file, for example:\\n\\n```\\necho \\\"<rasaplus-license-key-you-were-emailed>\\\" > license.txt\\n```\\n\\nStep b: Create a secret to hold the license key:\\n\\n```\\nkubectl -n <your-namespace> create secret generic rasapro-license --from-file=licensekey=./license.txt\\n```\\n\\nStep c: Remove the file on disk, for example:\\n\\n```\\n/bin/rm license.txt\\n```\", \"Step 3: update `values.yml`\": \"For the [Rasa Helm Chart](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa), update as follows:\\n\\n```\\nregistry: europe-west3-docker.pkg.dev/rasa-releases/rasa-plus/rasa-plus\\ncommand:\\n - rasa\\nimage:\\n name: rasa-plus\\n tag: 0.1.1\\n pullSecrets:\\n - name: rasa-plus-pull-secret\\nextraEnv:\\n - name: RASA_PRO_LICENSE\\n valueFrom:\\n secretKeyRef:\\n name: rasapro-license\\n key: licensekey\\n```\\n\\nFor the [Rasa X/Enterprise Helm Chart](https://github.com/RasaHQ/rasa-x-helm), update as follows:\\n\\n```\\nimages:\\n imagePullSecrets:\\n - name: rasa-plus-pull-secret\\nrasa:\\n command:\\n - rasa\\n name: europe-west3-docker.pkg.dev/rasa-releases/rasa-plus/rasa-plus\\n tag: 0.1.1\\n extraEnv:\\n - name: RASA_PRO_LICENSE\\n valueFrom:\\n secretKeyRef:\\n name: rasapro-license\\n key: licensekey\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n:::note\\n**OpenShift only**: If the deployment fails and `oc get events` returns\\n`1001 is not an allowed group spec.containers[0].securityContext.securityContext.runAsUser`,\\nre-run the installation command with the following values:\\n\\n```\\npostgresql:\\n volumePermissions:\\n securityContext:\\n runAsUser: \\\"auto\\\"\\n securityContext:\\n enabled: false\\n shmVolume:\\n chmod:\\n enabled: false\\nnginx:\\n image:\\n name: nginxinc/nginx-unprivileged\\n port: 8080\\n```\\n\\nThen wait until the deployment is ready. If you want to check on its status, the following command\\nwill block until the Rasa deployment is ready:\\n\\n<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\\n\\n```\\nkubectl --namespace <your namespace> \\\\\\n wait \\\\\\n --for=condition=available \\\\\\n --timeout=20m \\\\\\n --selector app.kubernetes.io/instance=<release name> \\\\\\n deployment\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"openshift\\\">\\n\\n```\\noc --namespace <your namespace> \\\\\\n wait \\\\\\n --for=condition=available \\\\\\n --timeout=20m \\\\\\n --selector app.kubernetes.io/instance=<release name> \\\\\\n deployment\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n:::\"}, \"5. Access Rasa Assistant\": \"By default the Rasa deployment is exposed via the `rasa` (`<release name>`) service and accessible only within a Kubernetes cluster.\\nTo access Rasa Assistant by using `kubectl port-forward`, use these commands:\\n\\n<Tabs groupId=\\\"kubernetes-dist\\\" values={[{\\\"label\\\": \\\"Kubernetes\\\", \\\"value\\\": \\\"kubernetes\\\"}, {\\\"label\\\": \\\"OpenShift\\\", \\\"value\\\": \\\"openshift\\\"}]} defaultValue=\\\"kubernetes\\\">\\n<TabItem value=\\\"kubernetes\\\">\\n\\n```\\n export SERVICE_PORT=$(kubectl get --namespace <your namespace> -o jsonpath=\\\"{.spec.ports[0].port}\\\" services <release name>)\\n kubectl port-forward --namespace <your namespace> svc/<release name> ${SERVICE_PORT}:${SERVICE_PORT} &\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"openshift\\\">\\n\\n```\\n export SERVICE_PORT=$(oc get --namespace <your namespace> -o jsonpath=\\\"{.spec.ports[0].port}\\\" services <release name>)\\n oc port-forward --namespace <your namespace> svc/<release name> ${SERVICE_PORT}:${SERVICE_PORT} &\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\nYou can then access the deployment on `http://127.0.0.1:${SERVICE_PORT}`\\n\\nThe other option is to expose your deployment on `NodePort` and access it directly.\\n\\n['Prepare configuration that switch the rasa service to `NodePort`.']\\n\\n```\\n# rasa-values.yaml\\nservice:\\n type: \\\"NodePort\\\"\\n```\\n\\n['Upgrade deployment.']\\n\\n```\\nhelm upgrade --namespace <NAMESPACE> --reuse-values -f rasa-values.yaml <RELEASE NAME> rasa/rasa\\n```\\n\\n['Get the node port and address for the rasa service']\\n\\n```\\nexport NODE_PORT=$(kubectl get --namespace <NAMESPACE> -o jsonpath=\\\"{.spec.ports[0].nodePort}\\\" services <RELEASE NAME>)\\n\\n$ curl http://127.0.0.1:${NODE_PORT}\\nHello from Rasa: 2.8.7\\n```\\n\\nVisit [the Rasa Helm Chart README](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa#exposing-the-rasa-deployment-to-the-public) to learn other ways to expose your deployment.\"}, \"Next Steps\": [\"Visit [the Rasa Helm Chart repository](https://github.com/RasaHQ/helm-charts/tree/main/charts/rasa) where you can find examples of configuration\"]}, \"metadata\": {\"id\": \"deploy-rasa\", \"sidebar_label\": \"Deploy Rasa\", \"title\": \"Deploy Rasa\", \"description\": \"Deploy a Rasa assistant on Kubernetes/Openshift using Helm\", \"abstract\": \"This page explains how to deploy Rasa Open Source and Rasa Plus using Helm.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 2]\"}, {\"title\": \"Deploying a Rasa Assistant\", \"description\": \"How to deploy your Rasa Assistant with Kubernetes/Openshift\", \"content\": {\"When to Deploy Your Assistant\": \"The best time to deploy your assistant and make it available to test users is once it can handle the most\\nimportant happy paths or is what we call a [minimum viable assistant](../glossary.mdx). Then you can use incoming\\nconversations to inform further development of your assistant.\", \"Recommended Deployment Method\": {\"Cluster Requirements\": \"To install the Rasa Helm Chart, you need an existing\\n[Kubernetes cluster](https://kubernetes.io/) or [OpenShift cluster](https://www.openshift.com/).\\nIf you don't have one yet, you can get a managed cluster from a cloud provider like:\\n\\n['[Google Cloud](https://cloud.google.com/kubernetes-engine),', '[DigitalOcean](https://www.digitalocean.com/products/kubernetes/),', '[Microsoft Azure](https://azure.microsoft.com/en-us/services/kubernetes-service/), or', '[Amazon EKS](https://aws.amazon.com/eks/).']\"}, \"Alternative Deployment Methods\": \"The following deployment methods are not suited to a production deployment, but can be useful for development and testing:\\n\\n['[Running an assistant locally on the command line](../command-line-interface.mdx#rasa-run)', '[Developing an assistant in a Docker container](../docker/building-in-docker.mdx)', '[Deploying an assistant with Docker Compose](../docker/deploying-in-docker-compose.mdx)']\"}, \"metadata\": {\"id\": \"introduction\", \"sidebar_label\": \"Introduction\", \"title\": \"Deploying a Rasa Assistant\", \"description\": \"How to deploy your Rasa Assistant with Kubernetes/Openshift\", \"abstract\": \"This section explains when and how to deploy an assistant built with Rasa. It will allow you to make your assistant available to users and set you up with a production-ready environment.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 57]\"}, {\"title\": \"Docker\", \"description\": \"Documentation section: docker\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/docker\"}, \"subpages\": [{\"title\": \"Building a Rasa Assistant in Docker\", \"description\": \"Learn how to build a Rasa assistant in Docker.\", \"content\": {\"Installing Docker\": \"If you're not sure if you have Docker installed, you can check by running:\\n\\n```\\ndocker -v\\n# Docker version 18.09.2, build 6247962\\n```\\n\\nIf Docker is installed on your machine, the output should show you your installed\\nversions of Docker. If the command doesn't work, you'll have to install Docker.\\nSee [Docker Installation](https://docs.docker.com/install/) for details.\", \"Setting up your Rasa Project\": \"Just like starting a project from scratch, you'll use the `rasa init` command to create a project.\\nThe only difference is that you'll be running Rasa inside a Docker container, using\\nthe image `rasa/rasa`. To initialize your project, run:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -v $(pwd):/app rasa/rasa:${variables.release}-full init --no-prompt`}</code></pre>\\n\\nWhat does this command mean?\\n\\n<ul>\\n <li><inlineCode>-v $(pwd):/app</inlineCode> mounts your current working directory to the working directory\\n in the Docker container. This means that files you create on your computer will be\\n visible inside the container, and files created in the container will\\n get synced back to your computer.</li>\\n <li><inlineCode>rasa/rasa</inlineCode> is the name of the docker image to run. '{variables.release}-full' is the name of the tag,\\n which specifies the version and dependencies.</li>\\n\\n <li>the Docker image has the <inlineCode>rasa</inlineCode> command as its entrypoint, which means you don't\\n have to type <inlineCode>rasa init</inlineCode>, just <inlineCode>init</inlineCode> is enough.</li>\\n</ul>\\n\\nRunning this command will produce a lot of output. What happens is:\\n\\n['a Rasa project is created', \\\"an initial model is trained using the project's training data.\\\"]\\n\\nTo check that the command completed correctly, look at the contents of your working directory:\\n\\n```\\nls -1\\n```\\n\\nThe initial project files should all be there, as well as a `models` directory that contains your trained model.\\n\\n:::note\\nIf you run into permission errors, it may be because the `rasa/rasa` images\\nrun as user `1001` as a best practice, to avoid giving the container `root` permissions.\\nHence, all files created by these containers will be owned by user `1001`. See the [Docker documentation](https://docs.docker.com/reference/cli/docker/container/run/)\\nif you want to run the containers as a different user.\\n\\n:::\", \"Talking to Your Assistant\": \"To talk to your newly-trained assistant, run this command:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -it -v $(pwd):/app rasa/rasa:${variables.release}-full shell`}</code></pre>\\n\\nThis will start a shell where you can chat to your assistant.\\nNote that this command includes the flags `-it`, which means that you are running\\nDocker interactively, and you are able to give input via the command line.\\nFor commands which require interactive input, like `rasa shell` and `rasa interactive`,\\nyou need to pass the `-it` flags.\", \"Training a Model\": \"If you edit any training data or edit the `config.yml` file, you'll need to\\nretrain your Rasa model. You can do so by running:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -v $(pwd):/app rasa/rasa:${variables.release}-full train --domain domain.yml --data data --out models`}</code></pre>\\n\\nHere's what's happening in that command:\\n\\n<ul>\\n <li><inlineCode>-v $(pwd):/app</inlineCode>: Mounts your project directory into the Docker\\n container so that Rasa can train a model on your training data</li>\\n\\n <li>rasa/rasa:{variables.release}-full: Use the Rasa image with the tag '{variables.release}-full'</li>\\n\\n <li><inlineCode>train</inlineCode>: Execute the <inlineCode>rasa train</inlineCode> command within the container. For more\\n information see <a href={useBaseUrl(\\\"/command-line-interface\\\")}>Command Line Interface</a>.</li>\\n</ul>\\n\\nIn this case, we've also passed values for the location of the domain file, training\\ndata, and the models output directory to show how these can be customized.\\nYou can also leave these out, since we are passing the default values.\", \"Customizing your Model\": {\"Choosing a Tag\": \"<p>\\n All <inlineCode>rasa/rasa</inlineCode> image tags start with a version number. The current version is {variables.release}. The tags are:\\n</p>\\n\\n['`{version}`', '`{version}-full`', '`{version}-spacy-en`', '`{version}-spacy-de`', '`{version}-spacy-it`', '`{version}-mitie-en`']\\n\\nThe `{version}-full` tag includes all possible pipeline dependencies, allowing you to change your `config.yml`\\nas you like without worrying about missing dependencies. The plain `{version}` tag includes all the\\ndependencies you need to run the default pipeline created by `rasa init`.\\n\\nTo keep images as small as possible, we also publish different tags of the `rasa/rasa` image\\nwith different dependencies installed. See [Additional Dependencies](../installation/installing-rasa-open-source.mdx#additional-dependencies) for more dependency information\\nspecific to your pipeline. For example, if you are using components with pre-trained word vectors from spaCy or\\nMITIE, you should choose the corresponding tag.\\n\\nIf your model has a dependency that is not included in any of the tags (for example, a different spaCy language model),\\nyou can build a docker image that extends the `rasa/rasa` image.\\n\\n:::note\\nYou can see a list of all the versions and tags of the Rasa\\nDocker image on [DockerHub](https://hub.docker.com/r/rasa/rasa/).\\n\\n:::\\n\\n:::caution\\nThe `latest` tags correspond to the build of the latest stable version.\\n\\n:::\", \"Adding Custom Components\": \"If you are using a custom NLU component or policy in your `config.yml`, you have to add the module file to your\\nDocker container. You can do this by either mounting the file or by including it in your\\nown custom image (e.g. if the custom component or policy has extra dependencies). Make sure\\nthat your module is in the Python module search path by setting the\\nenvironment variable `PYTHONPATH=$PYTHONPATH:<directory of your module>`.\", \"Adding Custom Actions\": \"To create more sophisticated assistants, you will want to use [Custom Actions](../actions.mdx#custom-actions).\\nContinuing the example from above, you might want to add an action which tells\\nthe user a joke to cheer them up.\\n\\nBuild a custom action using the Rasa SDK by editing `actions/actions.py`, for example:\\n\\n```\\nimport requests\\nimport json\\nfrom rasa_sdk import Action\\n\\n\\nclass ActionJoke(Action):\\n def name(self):\\n return \\\"action_joke\\\"\\n\\n def run(self, dispatcher, tracker, domain):\\n request = requests.get('http://api.icndb.com/jokes/random').json() # make an api call\\n joke = request['value']['joke'] # extract a joke from returned json response\\n dispatcher.utter_message(text=joke) # send the message back to the user\\n return []\\n```\\n\\nIn `data/stories.yml`, replace `utter_cheer_up` in with the custom action `action_joke`\\ntell your bot to use this new action.\\n\\nIn `domain.yml`, add a section for custom actions, including your new action:\\n\\n```\\nactions:\\n - action_joke\\n```\\n\\nAfter updating your domain and stories, you have to retrain your model:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -v $(pwd):/app rasa/rasa:${variables.release}-full train`}</code></pre>\\n\\nYour actions will run on a separate server from your Rasa server. First create a network to connect the two containers:\\n\\n```\\ndocker network create my-project\\n```\\n\\nYou can then run the actions with the following command:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -d -v $(pwd)/actions:/app/actions --net my-project --name action-server rasa/rasa-sdk:${variables.rasa_sdk_version}`}</code></pre>\\n\\nHere's what's happening in that command:\\n\\n['`-d`: Runs the container in detached mode so that you can run the rasa container in the same window.', '`-v $(pwd):/app`: Mounts your project directory into the Docker\\\\ncontainer so that the action server can run the code in the `actions` folder', '`net my-project`: Run the server on a specific network so that the rasa container can find it', '`--name action-server`: Gives the server a specific name for the rasa server to reference', '<code>rasa/rasa-sdk:{variables.rasa_sdk_version}</code> : Uses the Rasa SDK image with the tag {`${variables.rasa_sdk_version}`}']\\n\\nBecause the action server is running in detached mode, if you want to stop the container,\\ndo it with `docker stop action-server`. You can also run `docker ps` at any time to see all\\nof your currently running containers.\\n\\nTo instruct the Rasa server to use the action server, you have to tell Rasa its location.\\nAdd this endpoint to your `endpoints.yml`, referencing the `--name` you gave the server\\n(in this example, `action-server`):\\n\\n```\\naction_endpoint:\\n url: \\\"http://action-server:5055/webhook\\\"\\n```\\n\\nNow you can talk to your bot again via the `shell` command:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-bash\\\">\\n{`docker run -it -v $(pwd):/app -p 5005:5005 --net my-project rasa/rasa:${variables.release}-full shell`}</code></pre>\\n\\n:::note\\nIf you stop and restart the `action-server` container, you might see an error like this:\\n\\n```\\ndocker: Error response from daemon: Conflict. The container name \\\"/action-server\\\" is\\nalready in use by container \\\"f7ffc625e81ad4ad54cf8704e6ad85123c71781ca0a8e4b862f41c5796c33530\\\".\\nYou have to remove (or rename) that container to be able to reuse that name.\\n```\\n\\nIf that happens, it means you have a (stopped) container with the name already. You can remove it via:\\n\\n```\\ndocker rm action-server\\n```\\n\\n:::\"}, \"Deploying your Assistant\": \"Work on your bot until you have a minimum viable assistant that can handle your happy paths. After\\nthat, you'll want to deploy your model to get feedback from real test users. To do so, you can deploy the\\nmodel you created via one of our [recommended deployment methods](../deploy/introduction.mdx#recommended-deployment-method).\"}, \"metadata\": {\"id\": \"building-in-docker\", \"sidebar_label\": \"Building a Rasa Assistant in Docker\", \"title\": \"Building a Rasa Assistant in Docker\", \"description\": \"Learn how to build a Rasa assistant in Docker.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58, \\\"subpages\\\", 0]\"}, {\"title\": \"Deploying a Rasa Assistant in Docker Compose\", \"description\": \"Use Docker Compose to deploy a Rasa assistant\", \"content\": {\"Installing Docker\": \"If you're not sure if you have Docker installed, you can check by running:\\n\\n```\\ndocker -v && docker-compose -v\\n# Docker version 18.09.2, build 6247962\\n# docker-compose version 1.23.2, build 1110ad01\\n```\\n\\nIf Docker is installed on your machine, the output should show you your installed\\nversions of Docker and Docker Compose. If the command doesn't work, you'll have to\\ninstall Docker.\\nSee [Docker Installation](https://docs.docker.com/install/) for details.\", \"Configuring Channels\": \"To run your AI assistant in production, don't forget to configure your required\\n[Messaging and Voice Channels](../messaging-and-voice-channels.mdx) in `credentials.yml`. For example, to add a\\nREST channel, uncomment this section in the `credentials.yml`:\\n\\n```\\nrest:\\n # you don't need to provide anything here - this channel doesn't\\n # require any credentials\\n```\\n\\nThe REST channel will open your bot up to incoming requests at the `/webhooks/rest/webhook` endpoint.\", \"Using Docker Compose to Run Multiple Services\": \"Docker Compose provides an easy way to run multiple containers together without\\nhaving to run multiple commands or configure networks. This is essential when you\\nwant to deploy an assistant that also has an action server.\\n\\nStart by creating a file called `docker-compose.yml`:\\n\\n```\\ntouch docker-compose.yml\\n```\\n\\nAdd the following content to the file:\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-yaml\\\">\\n{`version: '3.0'\\nservices:\\n rasa:\\n image: rasa/rasa:${variables.release}-full\\n ports:\\n - 5005:5005\\n volumes:\\n - ./:/app\\n command:\\n - run`}</code></pre>\\n\\nThe file starts with the version of the Docker Compose specification that you\\nwant to use.\\nEach container is declared as a `service` within the `docker-compose.yml`.\\nThe first service is the `rasa` service, which runs your Rasa server.\\n\\nTo add the action server, add the image of your action server code. To learn how to deploy\\nan action server image, see [Building an Action Server Image](../deploy/deploy-action-server.mdx#building-an-action-server-image).\\n\\n<pre><code parentName=\\\"pre\\\" className=\\\"language-yaml\\\">\\n{`version: '3.0'\\nservices:\\n rasa:\\n image: rasa/rasa:${variables.release}-full\\n ports:\\n - 5005:5005\\n volumes:\\n - ./:/app\\n command:\\n - run\\n app:\\n image: <image:tag>\\n expose: 5055`}</code></pre>\\n\\nThe `expose: 5005` is what allows the `rasa` service to reach the `app` service on that port.\\nTo instruct the `rasa` service to send its action requests to that endpoint, add it to your `endpoints.yml`:\\n\\n```\\naction_endpoint:\\n url: http://app:5055/webhook\\n```\\n\\nTo run the services configured in your `docker-compose.yml` execute:\\n\\n```\\ndocker-compose up\\n```\\n\\nYou should then be able to interact with your bot via requests to port 5005, on the webhook endpoint that\\ncorresponds to a [configured channel](#configuring-channels):\\n\\n```\\ncurl -XPOST http://localhost:5005/webhooks/rest/webhook \\\\\\n -H \\\"Content-type: application/json\\\" \\\\\\n -d '{\\\"sender\\\": \\\"test\\\", \\\"message\\\": \\\"hello\\\"}'\\n```\", \"Configuring a Tracker Store\": \"By default, all conversations are saved in memory. This means that all\\nconversations are lost as soon as you restart the Rasa server.\\nIf you want to persist your conversations, you can use a different\\n[Tracker Store](../tracker-stores.mdx).\\n\\nTo add a tracker store to a Docker Compose deployment, you need to add a new\\nservice to your `docker-compose.yml` and modify the `endpoints.yml` to add\\nthe new tracker store, pointing to your new service. More information about how\\nto do so can be found in the tracker store documentation:\\n\\n['[SQLTrackerStore](../tracker-stores.mdx#sqltrackerstore)', '[RedisTrackerStore](../tracker-stores.mdx#redistrackerstore)', '[MongoTrackerStore](../tracker-stores.mdx#mongotrackerstore)', '[Custom Tracker Store](../tracker-stores.mdx#custom-tracker-store)']\"}, \"metadata\": {\"id\": \"deploying-in-docker-compose\", \"sidebar_label\": \"Deploying a Rasa Assistant in Docker Compose\", \"title\": \"Deploying a Rasa Assistant in Docker Compose\", \"description\": \"Use Docker Compose to deploy a Rasa assistant\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 58]\"}, {\"title\": \"Installation\", \"description\": \"Documentation section: installation\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/installation\"}, \"subpages\": [{\"title\": \"Setting up your environment\", \"description\": \"How to set up your environment before installing Rasa\", \"content\": {\"1. Python Environment Setup\": \"Check if your Python environment is already configured:\\n\\n```\\npython3 --version\\npip3 --version\\n```\\n\\n:::note Python3 Supported Versions\\n\\nCurrently, rasa supports the following Python versions: `3.7`, `3.8`, `3.9` and `3.10`.\\nNote that Python `3.10` is only supported for versions `3.4.x` and upwards.\\nAdditionally, rasa installation on Apple Silicon with Python `3.10` is not functional in `3.4.x` but will be supported starting from `3.5.x`.\\n\\n:::\\n\\nIf these packages are already installed, these commands should display version\\nnumbers for each step, and you can skip to the next step.\\n\\nOtherwise, proceed with the instructions below to install them.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Ubuntu\\\", \\\"value\\\": \\\"ubuntu\\\"}, {\\\"label\\\": \\\"macOS\\\", \\\"value\\\": \\\"macos\\\"}, {\\\"label\\\": \\\"Windows\\\", \\\"value\\\": \\\"windows\\\"}]} groupId=\\\"operating-systems\\\" defaultValue=\\\"ubuntu\\\">\\n<TabItem value=\\\"ubuntu\\\">\\n\\nFetch the relevant packages using `apt`, and install virtualenv using `pip`.\\n\\n```\\nsudo apt update\\nsudo apt install python3-dev python3-pip\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"macos\\\">\\n\\nInstall the [Homebrew](https://brew.sh) package manager if you haven't already.\\n\\nOnce you're done, you can install Python3.\\n\\n```\\nbrew update\\nbrew install python\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"windows\\\">\\n\\nMake sure the Microsoft VC++ Compiler is installed, so python can compile\\nany dependencies. You can get the compiler from <a className=\\\"reference external\\\"\\nhref=\\\"https://visualstudio.microsoft.com/visual-cpp-build-tools/\\\"\\ntarget=\\\"_blank\\\">Visual Studio</a>. Download the installer and select\\nVC++ Build tools in the list.Install [Python 3](https://www.python.org/downloads/windows/) (64-bit version) for Windows.\\n\\n```\\nC:\\\\> pip3 install -U pip\\n```\\n\\n</TabItem>\\n</Tabs>\", \"2. Virtual Environment Setup\": \"This step is optional, but we strongly recommend isolating python projects\\nusing virtual environments. Tools like\\n[virtualenv](https://virtualenv.pypa.io/en/latest/) and\\n[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/) provide\\nisolated Python environments, which are cleaner than installing packages system-wide\\n(as they prevent dependency conflicts). They also let you install packages\\nwithout root privileges.\\n\\n<Tabs values={[{\\\"label\\\": \\\"Ubuntu\\\", \\\"value\\\": \\\"ubuntu\\\"}, {\\\"label\\\": \\\"macOS\\\", \\\"value\\\": \\\"macos\\\"}, {\\\"label\\\": \\\"Windows\\\", \\\"value\\\": \\\"windows\\\"}]} groupId=\\\"operating-systems\\\" defaultValue=\\\"ubuntu\\\">\\n<TabItem value=\\\"ubuntu\\\">\\n\\nCreate a new virtual environment by choosing a Python interpreter and making a `./venv` directory to hold it:\\n\\n```\\npython3 -m venv ./venv\\n```\\n\\nActivate the virtual environment:\\n\\n```\\nsource ./venv/bin/activate\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"macos\\\">\\n\\nCreate a new virtual environment by choosing a Python interpreter and making a `./venv` directory to hold it:\\n\\n```\\npython3 -m venv ./venv\\n```\\n\\nActivate the virtual environment:\\n\\n```\\nsource ./venv/bin/activate\\n```\\n\\n</TabItem>\\n<TabItem value=\\\"windows\\\">\\n\\nCreate a new virtual environment by choosing a Python interpreter and making a `.\\\\\\\\venv` directory to hold it:\\n\\n```\\nC:\\\\> python3 -m venv ./venv\\n```\\n\\nActivate the virtual environment:\\n\\n```\\nC:\\\\> .\\\\venv\\\\Scripts\\\\activate\\n```\\n\\n</TabItem>\\n</Tabs>\", \"M1 / M2 (Apple Silicon) Limitations\": \"Rasa installations on Apple Silicon _don't_ use [Apple Metal](https://developer.apple.com/metal/) by default.\\nWe found that using the GPU on Apple Silicon increased training time for the\\n[`DIETClassifier`](../components.mdx#dietclassifier) and [`TEDPolicy`](../policies.mdx#ted-policy) dramatically.\\nYou can, however, install the optional dependency to test it yourself\\nor try it with other components using: `pip3 install 'rasa[metal]'`.\\n\\nCurrently, not all of Rasa's dependencies support Apple Silicon natively. This leads\\nto the following restrictions:\\n\\n['You can not run Duckling as a docker container on Apple Silicon. If you want\\\\nto use the [duckling entity extractor](../components.mdx#ducklingentityextractor) we recommend a cloud deployment of\\\\nduckling. Progress on this can be tracked on the\\\\n[Duckling project](https://github.com/facebook/duckling/issues/695).', \\\"Rasa on Apple Silicon does not support the [`ConveRTFeaturizer` component](../components.mdx#convertfeaturizer) or pipelines\\\\ncontaining it. The component relies on `tensorflow-text` which currently\\\\nisn't available for Apple Silicon. Progress on this can be tracked on the\\\\n[Tensorflow Text project](https://github.com/tensorflow/text/issues/823).\\\"]\"}, \"metadata\": {\"sidebar_label\": \"Setting up your environment\", \"title\": \"Setting up your environment\", \"description\": \"How to set up your environment before installing Rasa\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 0]\"}, {\"title\": \"Installing Rasa Open Source\", \"description\": \"Install Rasa Open Source on premises to enable local and customizable Natural Language Understanding and Dialogue Management.\", \"content\": {\"Install Rasa Open Source\": \"<Tabs values={[{\\\"label\\\": \\\"Ubuntu / macOS / Windows\\\", \\\"value\\\": \\\"ubuntu/macos/windows\\\"}]} defaultValue=\\\"ubuntu/macos/windows\\\">\\n<TabItem value=\\\"ubuntu/macos/windows\\\">\\n\\nFirst make sure your `pip` version is up to date:\\n\\n```\\npip3 install -U pip\\n```\\n\\nTo install Rasa Open Source:\\n\\n```\\npip3 install rasa\\n```\\n\\n</TabItem>\\n</Tabs>\\n\\n:::note Telemetry reporting\\nWhen you run Rasa Open Source for the first time, you\\u2019ll see a\\nmessage notifying you about anonymous usage data that is being collected.\\nYou can read more about how that data is pulled out and what it is used for in the\\n[telemetry documentation](../telemetry/telemetry.mdx).\\n:::\\n\\n**Congratulations! You have successfully installed Rasa Open Source!**\\n\\nYou can now create a new project with:\\n\\n```\\nrasa init\\n```\\n\\nYou can learn about the most important Rasa commands in the [Command Line Interface](../command-line-interface.mdx).\", \"Building from Source\": \"If you want to use the development version of Rasa Open Source, you can get it from GitHub:\\n\\n```\\ncurl -sSL https://install.python-poetry.org | python3 -\\ngit clone https://github.com/RasaHQ/rasa.git\\ncd rasa\\npoetry install\\n```\", \"Additional dependencies\": {\"Python 3.10 requirements\": \"_If you are using Linux_, installing `rasa[full]` could result in a failure while installing `tokenizers` and\\n`cryptography`.\\n\\nIn order to resolve it, you must follow these steps to install a Rust compiler:\\n\\n```\\napt install rustc && apt install cargo\\n```\\n\\nAfter initializing the Rust compiler, you should restart the console and check its installation:\\n\\n```\\nrustc --version\\n```\\n\\nIn case the PATH variable had not been automatically setup, run:\\n\\n```\\nexport PATH=\\\"$HOME/.cargo/bin:$PATH\\\"\\n```\\n\\n_If you are using macOS_, note that installing `rasa[full]` (either via pip or from source) could result in a failure\\nwhile installing `tokenizers` (issue described in depth [here](https://github.com/huggingface/tokenizers/issues/1050)).\\n\\nIn order to resolve it, you must follow these steps to install a Rust compiler:\\n\\n```\\nbrew install rustup\\nrustup-init\\n```\\n\\nAfter initializing the Rust compiler, you should restart the console and check its installation:\\n\\n```\\nrustc --version\\n```\\n\\nIn case the PATH variable had not been automatically setup, run:\\n\\n```\\nexport PATH=\\\"$HOME/.cargo/bin:$PATH\\\"\\n```\", \"Dependencies for spaCy\": \"For more information on spaCy models, check out the [spaCy docs](https://spacy.io/usage/models).\\n\\nYou can install it with the following commands:\\n\\n```\\npip3 install 'rasa[spacy]'\\npython3 -m spacy download en_core_web_md\\n```\\n\\n:::tip Using `zsh`?\\n\\nIn zsh, square brackets are interpreted as patterns on the command line.\\nTo run commands with square brackets, you can either enclose the arguments\\nwith square brackets in quotes, like `pip3 install 'rasa[spacy]'`, or escape\\nthe square brackets using backslashes, like `pip3 install rasa\\\\[spacy\\\\]`.\\nWe recommend using the former method (`pip3 install 'rasa[spacy]'`) in our\\ndocumentation because it works as expected across any shell\\n\\n:::\\n\\nThis will install Rasa Open Source as well as spaCy and its language model\\nfor the English language, but many other languages are available too.\\nWe recommend using at least the \\\"medium\\\" sized models (`_md`) instead of the spaCy's\\ndefault small `en_core_web_sm` model. Small models require less\\nmemory to run, but will likely reduce intent classification performance.\", \"Dependencies for MITIE\": \"First, run\\n\\n```\\npip3 install git+https://github.com/mit-nlp/MITIE.git\\npip3 install 'rasa[mitie]'\\n```\\n\\nand then download the\\n[MITIE models](https://github.com/mit-nlp/MITIE/releases/download/v0.4/MITIE-models-v0.2.tar.bz2).\\nThe file you need is `total_word_feature_extractor.dat`. Save this\\nanywhere. If you want to use MITIE, you need to\\ntell it where to find this file (in this example it was saved in the\\n`data` folder of the project directory).\"}, \"Upgrading Versions\": \"To upgrade your installed version of Rasa Open Source to the latest version from PyPI:\\n\\n```\\npip3 install --upgrade rasa\\n```\\n\\nTo download a specific version, specify the version number:\\n\\n```\\npip3 install rasa==3.0\\n```\"}, \"metadata\": {\"sidebar_label\": \"Installing Rasa Open Source\", \"title\": \"Installing Rasa Open Source\", \"description\": \"Install Rasa Open Source on premises to enable local and customizable Natural Language Understanding and Dialogue Management.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 1]\"}, {\"title\": \"Rasa Pro\", \"description\": \"Documentation section: rasa-pro\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/installation/rasa-pro\"}, \"subpages\": [{\"title\": \"Rasa Pro Installation\", \"description\": \"Install Rasa Pro in your production environment to create an enterprise ready Rasa deployment.\", \"content\": {\"Rasa Pro Setup\": {\"Python Package Installation\": {\"Authentication Set-Up\": \"To authenticate you need use a service account key file provided by Rasa to authenticate with Google Cloud.\\n\\nAuthenticate with GCP using the service account key.\\n\\n```\\ngcloud auth activate-service-account --key-file=service-account.json\\n```\\n\\nSet up keyring to allow Pip to authenticate with GCP Artifact Registry by installing keyring and then the backend that supports GCP Artifact Registry\\n\\n```\\npip install keyring\\npip install keyrings.google-artifactregistry-auth\\n```\\n\\nVerify that the backends have been installed correctly\\n\\n```\\nkeyring --list-backends\\n```\\n\\nThe results should include `ChainerBackend` and `GooglePythonAuth`.\", \"Installing with `pip`\": \"Enter the following settings to the `.pypirc` file. This can be found:\\n\\n['Linux and MacOS: `$HOME/.pypirc`', 'Windows: `%USERPROFILE%\\\\\\\\.pypirc`']\\n\\n```\\n[distutils]\\nindex-servers =\\n rasa-plus-py\\n\\n[rasa-plus-py]\\nrepository: https://europe-west3-python.pkg.dev/rasa-releases/rasa-plus-py/\\n\\n```\\n\\nNext, add these specific settings to the pip configuration file. The location for this depends on whether you want to update the per-user file or the file specific to a virtual environment that you are using.\\n\\nFor the file associated with your operating system user:\\n\\n['Linux: `$HOME/.config/pip/pip.conf` or `$HOME/.pip/pip.conf`', 'MacOS: `/Library/Application Support/pip/pip.conf` or `$HOME/.config/pip/pip.conf`', 'Windows: `%APPDATA%\\\\\\\\pip\\\\\\\\pip.ini` or `%USERPROFILE%\\\\\\\\pip\\\\\\\\pip.ini`']\\n\\nFor virtual environments:\\n\\n['Linux and macOS: `$VIRTUAL_ENV/pip.conf`', 'Windows: `%VIRTUAL_ENV%\\\\\\\\pip.ini`']\\n\\n```\\n[global]\\nextra-index-url = https://europe-west3-python.pkg.dev/rasa-releases/rasa-plus-py/simple/\\n\\n```\\n\\nFinally, you should be able to run `pip install rasa-plus`.\", \"Installing with `poetry`\": \"To install `rasa-plus` with `poetry`, you will need to associate the Artifact Registry URL with `rasa-plus` before installing it.\\nNote that you must upgrade poetry to the latest minor (`1.2.0`) in order for `poetry` to work with the GCP authentication set-up.\\nProceed with the following steps:\\n\\n['Run `poetry self add \\\"keyrings.google-artifactregistry-auth\\\"`', 'Add this section to `pyproject.toml`:']\\n\\n```\\n[[tool.poetry.source]]\\nname = \\\"rasa-plus\\\"\\nurl = \\\"https://europe-west3-python.pkg.dev/rasa-releases/rasa-plus-py/simple\\\"\\ndefault = false\\nsecondary = true\\n\\n```\\n\\n['Run `poetry install`.']\"}, \"Docker Image Installation\": \"The Rasa Pro Docker image is named `rasa-plus`. The Docker images are hosted on our GCP Artifact Registry.\\nAs a prerequisite, you will need:\\n\\n['to [install](https://cloud.google.com/sdk/docs/install) the Google Cloud CLI.', 'to verify that the user or service account you are using has the required permissions to access the repository.']\\n\\nTo authenticate you need use a service account key file provided by Rasa to authenticate with Google Cloud.\\n\\n```\\ngcloud auth activate-service-account --key-file=${KEYFILE}\\ngcloud auth configure-docker europe-west3-docker.pkg.dev\\ndocker pull europe-west3-docker.pkg.dev/rasa-releases/rasa-plus/rasa-plus\\n```\", \"Using An Intermediate Repository\": \"If you are using your own intermediate repository to cache libraries or dependencies (such as Artifactory or Nexus Repository Manager), you may need to generate a set of static credentials that allow you to authenticate with GCP Artifact Registry.\\n\\nAs a prerequisite, you will need:\\n\\n['to [install](https://cloud.google.com/sdk/docs/install) the Google Cloud CLI.', 'to verify that the user or service account you are using has the required permissions to access the repository.']\\n\\nTo generate your credentials, run:\\n\\n```\\ngcloud artifacts print-settings python \\\\\\n --project=rasa-releases \\\\\\n --repository=rasa-plus-py \\\\\\n --location=europe-west3 \\\\\\n --json-key=service-account.json\\n```\\n\\nYour credentials can be found in the output. The username will be `_json_key_base64` and the password will be a long, base64 encoded string.\", \"Runtime Configuration\": \"Rasa Pro will look for your license in the env var `RASA_PRO_LICENSE`.\\nYou can set this env var temporarily in your terminal, but it is recommended\\nto set it persistently so that you don't have to set it every time you run\\nRasa Pro.\\n\\nBash:\\n\\n```\\n## Temporary\\nexport RASA_PRO_LICENSE=<your-license-string>\\n\\n## Persistent\\necho \\\"export RASA_PRO_LICENSE=<your-license-string>\\\" >> ~/.bashrc\\n## If you're using a different flavor of bash e.g. Zsh, replace .bashrc with your shell's initialization script e.g. ~/.zshrc\\n```\\n\\nWindows Powershell:\\n\\n```\\n## Temporary\\n$env: RASA_PRO_LICENSE=<your-license-string>\\n\\n## Persistent\\n[System.Environment]::SetEnvironmentVariable('RASA_PRO_LICENSE','<your-license-string>')\\n```\\n\\nThen you can use the [`rasa` CLI](https://rasa.com/docs/rasa/command-line-interface) as usual, for example:\\n\\n```\\nrasa init\\n```\\n\\n:::note\\n\\nIf you run `rasa train` or `rasa run` after you\\u2019ve enabled tracing using Jaeger as a backend in your local development environment,\\nyou might come across this error `OSError: [Errno 40] Message too long`.\\n\\nThis could be caused by the OS of your local development environment restricting UDP packet size.\\nYou can find out the current UDP packet size by running `sysctl net.inet.udp.maxdgram` on macOS.\\nYou can increase UDP packet size by running `sudo sysctl -w net.inet.udp.maxdgram=65535`.\\n\\n:::\\n\\nCongratulations! You have now successfully installed Rasa Pro on your development environment.\\nTo learn more about production deployments, visit:\\n\\n['[Deploying Rasa Pro in production](../../deploy/deploy-rasa)', '[Deploying Rasa Pro Services in production](../../deploy/deploy-rasa-pro-services)']\"}}, \"metadata\": {\"sidebar_label\": \"Rasa Pro Installation\", \"title\": \"Rasa Pro Installation\", \"description\": \"Install Rasa Pro in your production environment to create an enterprise ready Rasa deployment.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Rasa Pro Artifacts\", \"description\": \"artifacts that ship with Rasa Pro.\", \"content\": {\"root\": [\"import useBaseUrl from \\\"@docusaurus/useBaseUrl\\\";\\nimport RasaProLabel from \\\"@theme/RasaProLabel\\\";\\nimport RasaProBanner from \\\"@theme/RasaProBanner\\\";\", \"<RasaProLabel />\", \"<RasaProBanner />\", [\"**Rasa Pro**, a drop-in replacement for Rasa Open Source\", \"**Rasa Pro Services**, flexible infrastructure and APIs on top of Rasa\\nOpen Source. Rasa Pro Services should be deployed alongside, but separately\\nfrom your production assistant.\"], \"Rasa Pro includes the Rasa Plus Python package, which is a drop-in replacement for Rasa Open Source that includes all the functionality of Rasa Open Source as well as additional features.\\nRasa Pro features are built on a plugin architecture that is seamlessly integrated with Rasa Open Source.\", \"For example, in the below diagram, tracing is run as a hook implementation in Rasa Plus, whose specification is defined and registered in Rasa Open Source.\", \"<img alt=\\\"image\\\" src={useBaseUrl(\\\"/img/rasa-plus-architecture.png\\\")} />\", \"The hook configures the tracing backend as specified in the `endpoints.yml` and instruments model training and message handling actions.\\nThe hook is then called within the Rasa Open Source main module, which is the entry point for the Rasa Open Source command line.\", \"The plugin architecture enables Rasa Pro to continue enhancing the Rasa Open Source argument parser while maintaining the same runnable command name (`rasa`).\"]}, \"metadata\": {\"sidebar_label\": \"Rasa Pro Artifacts\", \"title\": \"Rasa Pro Artifacts\", \"description\": \"artifacts that ship with Rasa Pro.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 59]\"}, {\"title\": \"Migrate From\", \"description\": \"Documentation section: migrate-from\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/migrate-from\"}, \"subpages\": [{\"title\": \"Rasa as open source alternative to Facebook\\u2019s Wit.ai - Migration Guide\", \"description\": \"Open source alternative to Facebook's Wit.ai for conversational bots and NLP\", \"content\": {\"Step 1: Export your Training Data from Wit.ai\": \"Navigate to your app's setting page by clicking the **Settings** item\\nin the **Management** section of the left navigation bar.\\nScroll down to **Export your data** and hit the button **Download .zip with your data**.\\n\\nThis will download a file with a `.zip` extension. Unzip this file to create a folder.\\nThe files you want from your download are located in the **utterances** directory.\", \"Step 2: Create a Rasa Project\": \"To create a Rasa project, run:\\n\\n```\\nrasa init\\n```\\n\\nThis will create a directory called `data`.\\nRemove the files in this directory, and move the content of the `utterances` directory\\nto `data`.\\n\\n```\\nrm -rf data/\\nmv /path/to/utterances data/\\n```\", \"Step 3: Train your NLU model\": \"To train a model using your Wit data, run:\\n\\n```\\nrasa train nlu\\n```\", \"Step 4: Test your NLU model\": \"Let's see how your NLU model will interpret some test messages.\\nTo start a testing session, run:\\n\\n```\\nrasa shell nlu\\n```\\n\\nThis will prompt your for input.\\nType a test message and press 'Enter'.\\nThe output of your NLU model will be printed to the screen.\\nYou can keep entering messages and test as many as you like.\\nPress 'control + C' to quit.\", \"Step 5: Start a Server with your NLU Model\": \"To start a server with your NLU model, run:\\n\\n```\\nrasa run nlu\\n```\\n\\nThis will start a server listening on port 5005.\\n\\nTo send a request to the server, run:\\n\\n```\\ncurl 'localhost:5005/model/parse?emulation_mode=wit' -d '{\\\"text\\\": \\\"hello\\\"}'\\nThe `emulation_mode` parameter tells Rasa that you want your json\\nresponse to have the same format as you would get from wit.ai.\\nYou can also leave it out to get the result in the usual Rasa format.\\n\\nJoin the [Rasa Community Forum](https://forum.rasa.com/) and let us know how your migration went!\\n```\"}, \"metadata\": {\"id\": \"facebook-wit-ai-to-rasa\", \"sidebar_label\": \"Rasa as open source alternative to Facebook\\u2019s Wit.ai - Migration Guide\", \"title\": \"Rasa as open source alternative to Facebook\\u2019s Wit.ai - Migration Guide\", \"description\": \"Open source alternative to Facebook's Wit.ai for conversational bots and NLP\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 0]\"}, {\"title\": \"Rasa as open source alternative to Google Dialogflow - Migration Guide\", \"description\": \"Open source alternative to Google Dialogflow for conversational bots and NLP\", \"content\": {\"Step 1: Export your data from Dialogflow\": \"Navigate to your agent's settings by clicking the gear icon.\\n\\nimport dialogflowExport1 from './dialogflow_export.png';\\n\\n<Image img={dialogflowExport1} width=\\\"240\\\" caption=\\\"Selecting settings\\\" alt=\\\"In Dialogflow, the gear icon that indicates settings sits next to the dropdown menu for choosing between projects.\\\" />\\n\\nClick on the 'Export and Import' tab and click on the 'Export as ZIP' button.\\n\\nimport dialogflowExport2 from './dialogflow_export_2.png';\\n\\n<Image img={dialogflowExport2} caption=\\\"Selecting Export and Import\\\" alt=\\\"The Settings page will let you select from multiple headers, of which you want to select Export and Import.\\\" />\\n\\nThis will download a file with a `.zip` extension. Unzip this file to create a folder.\", \"Step 2: Create a Rasa Project\": \"To create a Rasa project, run:\\n\\n```\\nrasa init\\n```\\n\\nThis will create a directory called `data`.\\nRemove the files in this directory, and\\nmove your unzipped folder into this directory.\\n\\n```\\nrm -r data/*\\nmv testagent data/\\n```\", \"Step 3: Train your NLU model\": \"To train a model using your Dialogflow data, run:\\n\\n```\\nrasa train nlu\\n```\", \"Step 4: Test your NLU model\": \"Let's see how your NLU model will interpret some test messages.\\nTo start a testing session, run:\\n\\n```\\nrasa shell nlu\\n```\\n\\nThis will prompt your for input.\\nType a test message and press 'Enter'.\\nThe output of your NLU model will be printed to the screen.\\nYou can keep entering messages and test as many as you like.\\nPress 'control + C' to quit.\", \"Step 5: Start a Server with your NLU Model\": \"To start a server with your NLU model, run:\\n\\n```\\nrasa run --enable-api\\n```\\n\\nThis will start a server listening on port 5005.\\n\\nTo send a request to the server, run:\\n\\n```\\ncurl 'localhost:5005/model/parse?emulation_mode=dialogflow' -d '{\\\"text\\\": \\\"hello\\\"}'\\n```\\n\\nThe `emulation_mode` parameter tells Rasa that you want your JSON response to have the same format as you would\\nget from the Dialogflow `sessions.detectIntent` endpoint (the format is\\ndescribed [here](https://cloud.google.com/dialogflow/es/docs/reference/rest/v2/DetectIntentResponse)).\\nYou can also leave it out to get the result in the usual Rasa format.\", \"Terminology:\": \"The words `intent`, `entity`, and `utterance` have the same meaning in Rasa as they do in Dialogflow.\\nIn Dialogflow, there is a concept called `Fulfillment`. In Rasa we call this a [Custom Action](../actions.mdx#custom-actions).\\n\\nJoin the [Rasa Community Forum](https://forum.rasa.com/) and let us know how your migration went!\"}, \"metadata\": {\"sidebar_label\": \"Rasa as open source alternative to Google Dialogflow - Migration Guide\", \"title\": \"Rasa as open source alternative to Google Dialogflow - Migration Guide\", \"description\": \"Open source alternative to Google Dialogflow for conversational bots and NLP\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 1]\"}, {\"title\": \"Rasa as open source alternative to IBM Watson - Migration Tips\", \"description\": \"Open source alternative to IBM Watson for conversational bots and NLP\", \"content\": {\"root\": [\"There is no support for IBM Watson yet. However, a group of community members is working on a way\\nto use <a className=\\\"reference external\\\" href=\\\"https://developer.ibm.com/tutorials/learn-how-to-export-import-a-watson-assistant-workspace/\\\" target=\\\"_blank\\\">exported IBM Watson workspaces</a>\\nin Rasa. If you're interested in that, check out our <a className=\\\"reference external\\\" href=\\\"https://forum.rasa.com/\\\" target=\\\"_blank\\\">Community Forum</a>.\"]}, \"metadata\": {\"id\": \"ibm-watson-to-rasa\", \"sidebar_label\": \"Rasa as open source alternative to IBM Watson - Migration Tips\", \"title\": \"Rasa as open source alternative to IBM Watson - Migration Tips\", \"description\": \"Open source alternative to IBM Watson for conversational bots and NLP\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 2]\"}, {\"title\": \"Rasa as open source alternative to Microsoft LUIS - Migration Guide\", \"description\": \"Open source alternative to Microsoft LUIS for conversational bots and NLP\", \"content\": {\"Step 1: Export your Training Data from LUIS\": \"Go to your list of [LUIS conversation apps](https://www.luis.ai/conversations/applications) and select the application\\nyou want to export.\\n\\nimport luisImage from './luis_export.png';\\n\\n<Image img={luisImage} caption=\\\"Export menu\\\" alt=\\\"Opening the menu reveals the 'Export to JSON' option.\\\" />\\n\\nSelect 'Export' > 'Export as JSON'. This will download a file with a `.json` extension that can be imported directly into Rasa.\", \"Step 2: Create a Rasa Project\": \"To create a Rasa project, run:\\n\\n```\\nrasa init\\n```\\n\\nThis will create a directory called `data`.\\nRemove the files in this directory, and\\nmove your json file into this directory.\\n\\n```\\nrm -r data/*\\nmv /path/to/file.json data/\\n```\", \"Step 3: Train your NLU model\": \"To train a model using your LUIS data, run:\\n\\n```\\nrasa train nlu\\n```\", \"Step 4: Test your NLU model\": \"Let's see how your NLU model will interpret some test messages.\\nTo start a testing session, run:\\n\\n```\\nrasa shell nlu\\n```\\n\\nThis will prompt your for input.\\nType a test message and press 'Enter'.\\nThe output of your NLU model will be printed to the screen.\\nYou can keep entering messages and test as many as you like.\\nPress 'control + C' to quit.\", \"Step 5: Start a Server with your NLU Model\": \"To start a server with your NLU model, run:\\n\\n```\\nrasa run\\n```\\n\\nThis will start a server listening on port 5005.\\n\\nTo send a request to the server, run:\\n\\n```\\ncurl 'localhost:5005/model/parse?emulation_mode=luis' -d '{\\\"text\\\": \\\"hello\\\"}'\\nThe `emulation_mode` parameter tells Rasa that you want your json\\nresponse to have the same format as you would get from LUIS.\\nYou can also leave it out to get the result in the usual Rasa format.\\n\\n## Terminology:\\n\\nThe words `intent`, `entity`, `role`, and `utterance` have the same meaning in Rasa as they do\\nin LUIS.\\nLUIS's `patterns` feature is very similar to Rasa NLU's [regex features](./training-data-format.mdx#regular-expressions)\\nLUIS's `phrase lists` feature does not currently have an equivalent in Rasa NLU.\\n\\nJoin the [Rasa Community Forum](https://forum.rasa.com/) and let us know how your migration went!\\n```\"}, \"metadata\": {\"id\": \"microsoft-luis-to-rasa\", \"sidebar_label\": \"Rasa as open source alternative to Microsoft LUIS - Migration Guide\", \"title\": \"Rasa as open source alternative to Microsoft LUIS - Migration Guide\", \"description\": \"Open source alternative to Microsoft LUIS for conversational bots and NLP\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 60]\"}, {\"title\": \"Monitoring\", \"description\": \"Documentation section: monitoring\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/monitoring\"}, \"subpages\": [{\"title\": \"Load Testing Guidelines\", \"description\": \"Information about how best to scale up your bot to support parallel user activity\\nand how you can use tracing to help debug issues.\\n\", \"content\": {\"Overview\": {\"Some recommendations to improve latency\": [\"Sanic Workers must be mapped 1:1 to CPU for both Rasa Pro and Rasa Action Server\", \"Create `async` actions to avoid any blocking I/O\", \"`enable_selective_domain: true` : Domain is only sent for actions that needs it. This massively trims the payload between the two pods.\", \"Consider using compute efficient machines on cloud which are optimized for high performance computing such as the C5 instances on AWS.\\nHowever, as they are low on memory, models need to be trained lightweight.\"], \"Debugging bot related issues while scaling up\": \"To test the Rasa [HTTP-API](https://rasa.com/docs/rasa/pages/http-api) ability to handle a large number of concurrent user activity we used the Rasa Pro [tracing](./tracing.mdx) capability\\nalong with a tracing backend or collector, such as Jaeger, to collect traces for the bot under test.\\n\\n:::note\\n\\nOur team is currently in the process of running additional performance-related tests. More information will be added here as we progress.\\n\\n:::\"}}, \"metadata\": {\"sidebar_label\": \"Load Testing Guidelines\", \"title\": \"Load Testing Guidelines\", \"description\": \"Information about how best to scale up your bot to support parallel user activity\\nand how you can use tracing to help debug issues.\\n\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 0]\"}, {\"title\": \"Tracing\", \"description\": \"Resolve performance issues faster and identify bottlenecks through OpenTelemetry-based tracing\", \"content\": {\"Tracing\": {\"Supported Tracing Backends/Collectors\": \"To trace requests in Rasa Pro, you can either use\\n[Jaeger](https://www.jaegertracing.io/) as a backend, or use\\nthe [OTEL Collector (OpenTelemetry Collector)](https://opentelemetry.io/docs/collector/).\\nto collect traces and then send them to the backend of your choice.\\nSee [Configuring a Tracing Backend or Collector](#configuring-a-tracing-backend-or-collector)\\nfor instructions.\", \"Enabling / Disabling\": \"Tracing is automatically enabled in Rasa Pro by\\n[configuring a supported tracing backend](#configuring-a-tracing-backend-or-collector).\\nNo further action is required to enable tracing.\\n\\nYou can disable tracing by leaving the `tracing:` configuration key empty\\nin your endpoints file.\", \"Action Server\": \"The trace context is sent along with requests to the custom action server\\nusing the [W3C Trace Context Specification](https://www.w3.org/TR/trace-context/).\\nYou can use this trace context to continue tracing the request through\\nyour custom action code. See [traced events](#traced-events) for\\ndetails on what attributes are made available as part of the trace context.\"}, \"Configuring a Tracing Backend or Collector\": {\"Jaeger\": \"To configure a Jaeger tracing backend, specify the `type` as `jaeger`.\\n\\n```\\ntracing:\\n type: jaeger\\n host: localhost\\n port: 6831\\n service_name: rasa\\n sync_export: ~\\n```\", \"OTEL Collector\": \"Collectors are components that collect traces in a vendor-agnostic way and then forward them to various backends.\\nFor example, the OpenTelemetry Collector (OTEL) can collect traces from multiple different components and instrumentation libraries, and then export them to multiple different backends e.g. jaeger.\\n\\nTo configure an OTEL Collector, specify the `type` as `otlp`.\\n\\n```\\ntracing:\\n type: otlp\\n endpoint: my-otlp-host:4318\\n insecure: false\\n service_name: rasa\\n root_certificates: ./tests/unit/tracing/fixtures/ca.pem\\n```\"}, \"Traced Events\": {\"Model Training\": {\"`GraphTrainer` Attributes\": \"The following attributes can be inspected during training of `GraphTrainer`:\\n\\n['`training_type` of model configuration:', ['`\\\"NLU\\\"`', '`\\\"CORE\\\"`', '`\\\"BOTH\\\"`', '`\\\"END-TO-END\\\"`'], '`language` of model configuration', '`recipe_name` used in the `config.yml` file', '`output_filename`: the location where the packaged model is saved', '`is_finetuning`: boolean argument, if `True` enables incremental training']\", \"`GraphNode` Attributes\": \"The following attributes are captured during the training (as well as prediction during message handling) of every graph node:\\n\\n['`node_name`', '`component_class`', '`fn_name`: method of component class that gets called']\"}, \"Message Handling\": {\"`Agent` Attributes\": \"Tracing the `Agent` instance handling a message captures the following attributes:\\n\\n['`input_channel`: the name of the channel connector', '`sender_id`: the conversation id', '`model_id`: a unique identifier for the model', '`model_name`: the model name']\", \"`MessageProcessor` Attributes\": \"The following `MessageProcessor` attributes are extracted during the tracing:\\n\\n['`number_of_events`: number of events in tracker', '`action_name`: the name of the predicted and executed action', '`sender_id`: the conversation id of the `DialogueStateTracker` object', '`message_id`: the unique message id']\\n\\nThe latter three attributes are also injected in the trace context that gets passed to the requests made to the custom action server.\", \"`TrackerStore` & `LockStore` Attributes\": \"Observable `TrackerStore` and `LockStore` attributes include:\\n\\n['`number_of_streamed_events`: number of new events to stream', '`broker_class`: the `EventBroker` on which the new events are published', '`lock_store_class`: Name of lock store used to lock conversations while messages are actively processed']\"}}}, \"metadata\": {\"sidebar_label\": \"Tracing\", \"title\": \"Tracing\", \"description\": \"Resolve performance issues faster and identify bottlenecks through OpenTelemetry-based tracing\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 1]\"}, {\"title\": \"Analytics\", \"description\": \"Documentation section: analytics\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/monitoring/analytics\"}, \"subpages\": [{\"title\": \"Data structure reference\", \"description\": null, \"content\": {\"Database Table Overview\": \"<!-- the diagram is generated from a database that has the correct schema\\n you need to connect to a live database, e.g. the one connected to our\\n example metabase. afterwards, you can use\\n https://app.trevor.io/datasources/617ec3a0-526f-4295-ad5a-3a31f0f4c027#m=ap\\n and its database map to create screenshots for all tables or the individual\\n tables -->\\n\\n<div align=\\\"center\\\">\\n <img\\n alt=\\\"An overview of the components of Rasa Pro.\\\"\\n src={useBaseUrl(\\\"/img/analytics/analytics-er-db.png\\\")}\\n width=\\\"100%\\\"\\n />\\n</div>\", \"Common Terms\": [\"**a sender** is a user who is talking to the assistant through a channel.\\nA user might have multiple senders if they use multiple channels, e.g.\\ncommunicating with the assistant through a website and through a\\nchannel integrated into a mobile app.\", \"**a session** is a conversation between a sender and the assistant.\\nA session is started when a sender sends a message to the assistant and\\nends when the session either has been timed out or explicitly ended.\\nIf a session is interrupted by a longer period of inactivity new\\nactivity will trigger a new session to be created ([configurable\\nthrough the session timeout](../../domain.mdx#session-configuration)).\", \"**a turn** always starts with a message from a sender and ends right before\\nthe next message from the sender. A turn can also end with a session\\nbeing timed out or explicitly ended. A turn will usually contain at least\\none bot response.\"], \"Tables\": {\"rasa_sender\": {\"`id` sender identifier\": \"The unique identifier of the sender is generated by Analytics. Sender\\ngets a different, generated id assigned. The `id` differs from the `sender_id`\\nused by the Rasa channels, the `sender_id` in Rasa is the\\n`sender_key` in Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `a78783c4-bef7-4e55-9ec7-5afb4420f19a`']\", \"`sender_key` Rasa channel sender identifier\": \"The unique identifier used by the Rasa channel to identify this sender. The\\n`sender_key` is specific to the channel implementation in Rasa and\\nthe format depends on the channel.\\n\\n['Type: `varchar(255)`', 'Example: `fb26ba0a9d8b4bd99e2b8716acb19e4b`']\", \"`channel` Rasa channel name\": \"Name of the channel that is used for this sender. The channel names are\\ndefined in the implementation of the respective Rasa channel.\\n\\n['Type: `varchar(255)`', 'Example: `socket.io`']\", \"`first_seen` first contact with this sender\": \"The date and time of the first contact with this sender. Corresponds to the\\ntime of the first event of the first session created for this sender.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`last_seen` latest contact with this sender\": \"The date and time of the last contact with this sender. Corresponds to the\\ntime of the latest event of the latest session created for this sender.\\n\\n['Type: `DateTime`', 'Example: `2022-10-28 02:15:49.326936`']\\n\\n[]\"}, \"rasa_session\": {\"`id` session identifier\": \"The unique identifier of the session. Every session gets a different,\\ngenerated id assigned.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`sender_id` sender who started the session\": \"The unique identifier of the sender who started the session. It is a\\nforeign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`timestamp` creation date time\": \"The timestamp when the session was created. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`start_sequence_number` start of the session\": \"The sequence number of the first event in this session. All events belong\\nto exactly one session. The start sequence number is always smaller or equal\\nto the `end_sequence_number`. The difference between start and end sequence\\nnumbers does not equal the number of events in this session since\\nsequence numbers are incremented across multiple conversations.\\n\\n['Type: `Integer`', 'Example: `78`']\", \"`end_sequence_number` end of the session\": \"The sequence number of the last event in the session.\\n\\n['Type: `Integer`', 'Example: `91`']\\n\\n[]\"}, \"rasa_turn\": {\"`id` session identifier\": \"The unique identifier of the turn. Every turn gets a different\\ngenerated id assigned.\\n\\n['Type: `varchar(36)`', 'Example: `ffa5d0cd-f5a6-45a4-9506-ba7ffd76edf1`']\", \"`sender_id` sender who started the turn\": \"The unique identifier of the sender who started the turn. It is a\\nforeign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this turn is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`start_sequence_number` start of the turn\": \"The sequence number of the first event in this turn. All events belong\\nto exactly one session. The start sequence number is always smaller or equal\\nto the `end_sequence_number`. The difference between start and end sequence\\nnumbers does not equal the number of events in this session since\\nsequence numbers are incremented across multiple conversations.\\n\\n['Type: `Integer`', 'Example: `79`']\", \"`end_sequence_number` end of the turn\": \"The sequence number of the last event in this turn.\\n\\n['Type: `Integer`', 'Example: `82`']\\n\\n[]\"}, \"rasa_event\": {\"`id` event identifier\": \"The unique identifier of the event. Every event gets different,\\ngenerated id assigned.\\n\\n['Type: `varchar(36)`', 'Example: `f5adcd16-b18d-4c5c-95f0-1747b20cb0e6`']\", \"`sender_id` sender whose conversation the event belongs to\": \"The unique identifier of the sender whose conversation this event is part of.\\nIt is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this event is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`timestamp` creation date time\": \"The timestamp when the event was created. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`event_type` kind of event\": \"The type of the event. The event type is a string and can be one of the\\nfollowing:\\n\\n['`user`: The user sent a message to the assistant.', '`bot`: The assistant sent a message to the user.', '`action`: The assistant executed an action.', '`session_started`: A new session was started.', '`action_execution_rejected`: An action failed to execute.', '`active_loop`: The assistant is currently in a loop.', '`slot`: A slot was set.', '`followup`: A follow-up action was triggered.', '`loop_interrupted`: A loop was interrupted.', '`pause`: A session is paused, e.g. because the session was handed over\\\\nto a human agent.', '`restart`: A session was restarted. This will trigger a new session to\\\\nbe started. The state of the assistant will be reset.', '`rewind`: The assistant rewinds to a previous state.', '`user_featurization`: The assistant featurized the user input.']\\n\\nThe event type defines how the event is interpreted and how the event\\naffects the conversation. For example, the `user` event type will\\nbe interpreted as a user message and the `bot` event type will be\\ninterpreted as a bot response.\\n\\n['Type: `varchar(255)`', 'Example: `action`']\", \"`model_id` model identifier\": \"The identifier of the Rasa model that was running as part of the assistant\\nwhen this event was created.\\n\\n['Type: `varchar(255)`', 'Example: `75a985b7b86d442ca013d61ea4781b22`']\", \"`environment` name of the assistant environment\": \"The name of the environment of the assistant that created this event.\\nThe environment is a string that is set up during the start of the assistant,\\n\\n['Type: `varchar(255)`', 'Example: `production`']\", \"`sequence_number` start of the event\": \"The sequence number of the event. The events of a session always have\\nincreasing sequence numbers. Sequence numbers are not guaranteed to be\\nsequential for events following one another. But sequence numbers can\\nbe used to order the events of a session.\\n\\n['Type: `Integer`', 'Example: `78`']\\n\\n[]\"}, \"rasa_bot_message\": {\"`id` bot message identifier\": \"The unique identifier of the bot message is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `2f2e5384-1bfa-4b53-90a7-c75e5f20b117`']\", \"`event_id` id of the event of this message\": \"The unique identifier of the event that created this bot message.\\nIt is a foreign key to the [`rasa_event.id`](#rasa_event) column.\\n\\n['Type: `varchar(36)`', 'Example: `f5adcd16-b18d-4c5c-95f0-1747b20cb0e6`']\", \"`sender_id` sender whose conversation the message belongs to\": \"The unique identifier of the sender whose conversation this message is part of.\\nIt is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this message is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`timestamp` creation date time\": \"The timestamp when the message was created. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`template_name` name of the template used to generate the message\": \"The name of the template that Rasa used to generate the bot message. Might\\nbe empty if the message was not generated from a template but a custom\\naction.\\n\\n['Type: `varchar(255)`', 'Example: `utter_greet`']\", \"`text` message content\": \"The text of the bot message.\\n\\n['Type: `varchar(65535)`', 'Example: `Ok, what can I help you with?`']\", \"`model_id` model identifier\": \"The identifier of the Rasa model that was running as part of the assistant\\nwhen this message was created.\\n\\n['Type: `varchar(255)`', 'Example: `75a985b7b86d442ca013d61ea4781b22`']\", \"`sequence_number` start of the event\": \"The sequence number of the message. The events of a session always have\\nincreasing sequence numbers. The sequence number of this message is the same\\nas the one of the underlying event.\\n\\n['Type: `Integer`', 'Example: `78`']\\n\\n[]\"}, \"rasa_user_message\": {\"`id` user message identifier\": \"The unique identifier of the user message is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `49fdd79e-976b-47c2-ab27-a4c3d743a1c9`']\", \"`event_id` id of the event of this message\": \"The unique identifier of the event that created this user message.\\nIt is a foreign key to the [`rasa_event.id`](#rasa_event) column.\\n\\n['Type: `varchar(36)`', 'Example: `f5adcd16-b18d-4c5c-95f0-1747b20cb0e6`']\", \"`sender_id` sender whose conversation the message belongs to\": \"The unique identifier of the sender whose conversation this message is part of.\\nIt is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this message is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`intent` classification of the text\": \"The name of the intent that Rasa classified the text as. One of the intents\\nin the domain used to train the model.\\n\\n['Type: `varchar(255)`', 'Example: `book_flight`']\", \"`retrieval_intent` classification of the text\": \"The name of the retrieval intent that Rasa classified the text as. Only\\npopulated if there is a configured retrieval intent.\\n\\n['Type: `varchar(255)`', 'Example: `book_flight/faq`']\", \"`confidence` certainty the model predicted for classifications\": \"The confidence of the ML model's intent prediction. The confidence is a\\nvalue between 0 and 1. The higher the value, the more certain the model is\\nthat the intent is correct.\\n\\n['Type: `Float`', 'Example: `0.8798527419567108`']\", \"`text` message content\": \"The text of the user message.\\n\\n['Type: `varchar(65535)`', 'Example: `I want to book a flight.`']\", \"`timestamp` creation date time\": \"The timestamp when the message was created. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`model_id` model identifier\": \"The identifier of the Rasa model that was running as part of the assistant\\nwhen this message was created.\\n\\n['Type: `varchar(255)`', 'Example: `75a985b7b86d442ca013d61ea4781b22`']\", \"`sequence_number` start of the event\": \"The sequence number of the message. The events of a session always have\\nincreasing sequence numbers. The sequence number of this message is the same\\nas the one of the underlying event.\\n\\n['Type: `Integer`', 'Example: `78`']\", \"`message_id` unique id for the message text\": \"A unique id that identifies the text of the message.\\n\\n['Type: `varchar(255)`', 'Example: `7cdb5700ac9c493aa46987b77d91c363`']\\n\\n[]\"}, \"rasa_action\": {\"`id` action identifier\": \"The unique identifier of the action execution is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `bd074dc7-e745-4db6-86d0-75b0af7bc067`']\", \"`event_id` id of the event of this action execution\": \"The unique identifier of the event that created this action execution.\\nIt is a foreign key to the [`rasa_event.id`](#rasa_event) column.\\n\\n['Type: `varchar(36)`', 'Example: `f5adcd16-b18d-4c5c-95f0-1747b20cb0e6`']\", \"`sender_id` sender whose conversation triggered this action execution\": \"The unique identifier of the sender whose conversation triggered this action\\nexecution. It is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this action execution is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`name` name of the executed action\": \"The name of the action that Rasa has predicted and executed. One of the actions\\nin the domain used to train the model.\\n\\n['Type: `varchar(255)`', 'Example: `action_book_flight`']\", \"`confidence` ML models certainty of the predicted action\": \"The confidence of ML model's action prediction. The confidence is a\\nvalue between 0 and 1. The higher the value, the more certain the model is\\nthat the action is correct.\\n\\n['Type: `Float`', 'Example: `0.9398527419567108`']\", \"`policy` name of the policy that predicted the action\": \"The name of the policy that predicted this action. The policy is a component\\nin the Rasa assistant that makes a prediction. The policy can be a rule\\npolicy, a memoization policy, or an ML policy.\\n\\n['Type: `varchar(255)`', 'Example: `policy_2_TEDPolicy`']\", \"`timestamp` creation date time\": \"The timestamp when the action was executed. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`model_id` model identifier\": \"The identifier of the Rasa model that was running as part of the assistant\\nwhen this action was executed.\\n\\n['Type: `varchar(255)`', 'Example: `75a985b7b86d442ca013d61ea4781b22`']\", \"`sequence_number` start of the event\": \"The sequence number of the executed action. The events of a session always have\\nincreasing sequence numbers. The sequence number of this executed action is\\nthe same as the one of the underlying event.\\n\\n['Type: `Integer`', 'Example: `78`']\\n\\n[]\"}, \"rasa_slot\": {\"`id` slot change identifier\": \"The unique identifier of this change in slot values is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `a793d284-b5b9-4cef-be8a-bc0f58c70c28`']\", \"`event_id` id of the event that triggered this slot change\": \"The unique identifier of the event that triggered this change\\nin the slot value. It is a foreign key to\\nthe [`rasa_event.id`](#rasa_event) column.\\n\\n['Type: `varchar(36)`', 'Example: `f5adcd16-b18d-4c5c-95f0-1747b20cb0e6`']\", \"`sender_id` sender whose conversation triggered this slot change\": \"The unique identifier of the sender whose conversation triggered this\\nslot change. It is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this slot change is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`slot_path` path of the slot\": \"A path to the slot that was changed. The path identifies the slot by its\\nname, the sender and the session. The path is a string that looks like\\n`<sender_id>/<session_id>/<slot_name>`.\\n\\n['Type: `varchar(255)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53/63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1/email`']\", \"`name` name of the slot\": \"The name of the changed slot. The name of the slot is the same\\nas the name of the slot in the domain.\\n\\n['Type: `varchar(255)`', 'Example: `email`']\", \"`value` new slot value\": \"The new value of the slot for the session. The value is a dumped\\nJSON object.\\n\\n['Type: `varchar(65535)`', 'Example: `john@example.com`']\", \"`timestamp` creation date time\": \"The timestamp when the slot value was changed. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-28 02:15:49.326936`']\", \"`sequence_number` start of the event\": \"The sequence number of the slot change. The events of a session always have\\nincreasing sequence numbers. The sequence number of the slot change is\\nthe same as the one of the underlying event.\\n\\n['Type: `Integer`', 'Example: `78`']\\n\\n[]\"}, \"rasa_session_slot_state\": {\"`id` path of the slot\": \"A path to the slot. The path identifies the slot by its\\nname, the sender and the session. The path is a string that looks like\\n`<sender_id>/<session_id>/<slot_name>`.\\n\\n['Type: `varchar(255)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53/63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1/email`']\", \"`sender_id` sender whose conversation this slot is part of\": \"The unique identifier of the sender whose conversation this slot is part of.\\nIt is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this slot is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`name` name of the slot\": \"The name of the slot. The name of the slot is the same\\nas the name of the slot in the domain.\\n\\n['Type: `varchar(255)`', 'Example: `email`']\", \"`value` last value of the slot in the session\": \"The value of the slot at the end of the session. The value is a dumped\\nJSON object. If a slot is changed multiple times during a session,\\nthe value is set to the last change.\\n\\n['Type: `varchar(65535)`', 'Example: `john@example.com`']\", \"`timestamp` creation date time\": \"Time of the last update of the slot in this session. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-21 02:15:49.326936`']\"}, \"rasa_patterns\": {\"`id` pattern identifier\": \"The unique identifier of the rasa pattern is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `bd074dc7-e745-4db6-86d0-75b0af7bc067`']\", \"`name` pattern name\": \"Name of the pattern\\n\\n['Type: `varchar()`', 'Example: `registration success`']\", \"`description` pattern description\": \"Description of the pattern\\n\\n['Type: `varchar()`', 'Example: `This marker identifies successful account registration in the chat`']\", \"`config` pattern configuration\": \"Pattern configuration dictionary stored as an escaped string\\n\\n['Type: `varchar()`', 'Example: `\\\"{\\\\'or\\\\': [{\\\\'intent\\\\': \\\\'mood_unhappy\\\\'},{\\\\'intent\\\\': \\\\'mood_great\\\\'}]}\\\"`']\", \"`is_active` soft-delete flag\": \"Only patterns with `is_active==True` are processed during real-time analysis\\n\\n['Type: `boolean`']\", \"`created_at` creation date time\": \"Time of creation of this pattern. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-21 02:15:49.326936`']\", \"`updated_at` update date time\": \"Time of the last update of the pattern in this session. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-21 02:15:49.326936`']\"}, \"rasa_markers\": {\"`id` marker identifier\": \"The unique identifier of the extracted rasa marker is generated by Analytics.\\n\\n['Type: `varchar(36)`', 'Example: `bd074dc7-e745-4db6-86d0-75b0af7bc067`']\", \"`pattern_id` pattern which was applied in this marker\": \"The unique identifier of the pattern which was applied in this marker. It is\\na foreign key to the [`rasa_patterns.id`](#rasa_patterns) column\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`sender_id` sender identifier\": \"The unique identifier of the sender whose conversation this marker is part of.\\nIt is a foreign key to the [`rasa_sender.id`](#rasa_sender) column.\\n\\n['Type: `varchar(36)`', 'Example: `9e4ebded-f232-4cc5-af78-d98daa0c1a53`']\", \"`session_id` session identifier\": \"The unique identifier of the session this marker is part of.\\nIt is a foreign key to the [`rasa_session.id`](#rasa_session) column.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`event_id` event identifier\": \"The unique identifier of the event from event broker where this marker was applied.\\nNote that a marker can be applied across multiple events, this is the ID of the last event in the sequence.\\n\\n['Type: `varchar(36)`', 'Example: `63b150a6-21a3-4e6c-bb24-5ab6ddc30cf1`']\", \"`num_preceding_user_turns` Number of Proeeding User turns\": \"an integer indicating the number of user turns preceding the event at which the marker applied.\\n\\n['Type: `integer`', 'Example: `4`']\", \"`created_at` creation date time\": \"Time of creation of this marker. The timestamp is a UTC.\\n\\n['Type: `DateTime`', 'Example: `2022-06-21 02:15:49.326936`']\"}}, \"Internal Tables\": \"Internal tables are used to store information about the assistant and\\nthe events that are sent to the assistant. They are not meant to be\\nqueried directly but are required for the functioning of Analytics. They\\nare a private API that is used by the Analytics service internally\\nand might change without notice.\\n\\nInternal tables:\\n\\n['`_rasa_raw_event`', '`alembic_version`']\"}, \"metadata\": {\"id\": \"data-structure-reference\", \"sidebar_label\": \"Data structure reference\", \"title\": \"Data structure reference\", \"abstract\": \"Overview of the data structure created by the Analytics pipeline. Description of all tables and attributes that can be used to build analytics dashboards.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Example queries\", \"description\": null, \"content\": {\"Number of sessions per month\": \"A common high-level usage metric of your assistant is the number of\\nsessions per month. Here is how it would look as an SQL query:\\n\\n```\\nSELECT\\n date_trunc('month', \\\"public\\\".\\\"rasa_session\\\".\\\"timestamp\\\") AS \\\"first_seen\\\",\\n count(*) AS \\\"count\\\"\\nFROM \\\"public\\\".\\\"rasa_session\\\"\\nGROUP BY 1\\nORDER BY 1 ASC\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Number of sessions per month visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-number-sessions-month.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>Number of sessions per month visualized in Metabase.</figcaption>\\n</figure>\", \"Number of sessions per channel\": \"If you're connecting your assistant to multiple channels, it could be\\nuseful to look at the number of sessions per channel, let's say per week.\\nThe query you would need for this metric is:\\n\\n```\\nSELECT\\n \\\"public\\\".\\\"rasa_sender\\\".\\\"channel\\\" AS \\\"channel\\\",\\n \\\"public\\\".\\\"rasa_sender\\\".\\\"first_seen\\\" AS \\\"timestamp\\\",\\n count(distinct \\\"public\\\".\\\"rasa_sender\\\".\\\"sender_key\\\") AS \\\"count\\\"\\nFROM \\\"public\\\".\\\"rasa_sender\\\"\\nGROUP BY 1, 2\\nORDER BY 1 ASC, 2 ASC\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Number of sessions per channel visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-number-sessions-channel.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>\\n The number of sessions per channel as visualized in Metabase.\\n </figcaption>\\n</figure>\", \"Top N intents\": \"To improve your assistant, you could look into the variety of intents\\nyour users express. The query below selects the top 5 intents which\\ncould help you have a good perspective on that topic:\\n\\n```\\nSELECT\\n \\\"public\\\".\\\"rasa_user_message\\\".\\\"intent\\\" AS \\\"intent\\\",\\n count(*) AS \\\"count\\\"\\nFROM \\\"public\\\".\\\"rasa_user_message\\\"\\nGROUP BY 1\\nORDER BY 2 DESC, 1 ASC\\nLIMIT 5\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Top 5 intents visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-top-5-intents.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>Top 5 intents visualized in Metabase.</figcaption>\\n</figure>\\n\\nMoreover, you can look for the intent distribution over time:\\n\\n```\\nSELECT\\n \\\"public\\\".\\\"rasa_user_message\\\".\\\"intent\\\" AS \\\"intent\\\",\\n date_trunc('month', \\\"public\\\".\\\"rasa_user_message\\\".\\\"timestamp\\\") AS \\\"timestamp\\\",\\n count(*) AS \\\"count\\\" FROM \\\"public\\\".\\\"rasa_user_message\\\"\\nGROUP BY 1, 2\\nORDER BY 1 ASC, 2 ASC\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Intent distribution over time visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-intent-distribution.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>Intent distribution over time visualized in Metabase.</figcaption>\\n</figure>\", \"Escalation rate\": \"The escalation rate or human hand-off rate is a measure of the number of\\nconversations the assistant passes to a human agent. This metric can\\nhelp you gain a better understanding of what happens during a conversation.\\nLet's say you have an intent named `handoff_to_support`. You'll get the\\nescalation rate over time with this sample query:\\n\\n```\\nWITH \\\"sessions\\\" AS (\\n SELECT\\n \\\"public\\\".\\\"rasa_user_message\\\".\\\"session_id\\\" AS \\\"session_id\\\",\\n date_trunc('month', \\\"public\\\".\\\"rasa_user_message\\\".\\\"timestamp\\\") AS \\\"timestamp\\\",\\n (\\n CASE \\\"public\\\".\\\"rasa_user_message\\\".\\\"intent\\\"\\n WHEN 'handoff_to_support'\\n THEN 1 ELSE 0\\n END\\n ) AS \\\"has_handoff_to_support\\\"\\n FROM \\\"public\\\".\\\"rasa_user_message\\\"\\n),\\n\\\"sessions_with_handoff\\\" AS (\\n SELECT\\n \\\"session_id\\\",\\n \\\"timestamp\\\",\\n SUM(\\\"has_handoff_to_support\\\") AS \\\"has_handoff_to_support\\\"\\n FROM \\\"sessions\\\"\\n GROUP BY 1, 2\\n)\\nSELECT\\n \\\"timestamp\\\",\\n SUM(\\\"has_handoff_to_support\\\") / count(*) AS \\\"escalation_rate\\\"\\nFROM \\\"sessions_with_handoff\\\"\\nGROUP BY 1 ASC\\nORDER BY 1 ASC\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Escalation rate visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-escalation-rate.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>Escalation rate visualized in Metabase.</figcaption>\\n</figure>\", \"Abandonment rate\": \"Abandonment rate can be defined in many different custom ways,\\nhowever here we'll define it as a session ending without a user message\\nafter a specific message was uttered by the bot, e.g. `utter_ask_name`.\\nYou could adapt the metric to detect sessions ending without a user\\nmessage after a specific set of intents. The SQL query would look like this:\\n\\n```\\nWITH \\\"sessions\\\" AS (\\n SELECT\\n DISTINCT ON (\\\"public\\\".\\\"rasa_event\\\".\\\"session_id\\\") \\\"public\\\".\\\"rasa_event\\\".\\\"session_id\\\",\\n \\\"public\\\".\\\"rasa_event\\\".\\\"timestamp\\\" AS \\\"timestamp\\\",\\n (\\n CASE\\n WHEN \\\"public\\\".\\\"rasa_bot_message\\\".\\\"template_name\\\" = 'utter_ask_name'\\n THEN 1 ELSE 0\\n END\\n ) AS \\\"is_abandonned\\\"\\n FROM \\\"public\\\".\\\"rasa_event\\\"\\n INNER JOIN \\\"public\\\".\\\"rasa_bot_message\\\"\\n ON \\\"public\\\".\\\"rasa_event\\\".\\\"id\\\" = \\\"public\\\".\\\"rasa_bot_message\\\".\\\"event_id\\\"\\n WHERE \\\"public\\\".\\\"rasa_event\\\".\\\"event_type\\\" = 'bot'\\n ORDER BY 1, 2 DESC\\n)\\nSELECT\\n date_trunc('month', \\\"timestamp\\\") AS \\\"timestamp\\\",\\n SUM(\\\"is_abandonned\\\")::float / count(*) AS \\\"abandonment_rate\\\"\\nFROM \\\"sessions\\\"\\nGROUP BY 1\\nORDER BY 1 ASC\\n```\\n\\n<figure align=\\\"center\\\">\\n <img\\n alt=\\\"Abandonment rate visualized in Metabase.\\\"\\n src={useBaseUrl(\\\"/img/analytics/graph-abandonment-rate.png\\\")}\\n width=\\\"100%\\\"\\n />\\n <figcaption>Abandonment rate visualized in Metabase.</figcaption>\\n</figure>\"}, \"metadata\": {\"id\": \"example-queries\", \"sidebar_label\": \"Example queries\", \"title\": \"Example queries\", \"description\": null}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"Getting started with Analytics\", \"description\": null, \"content\": {\"Types of metrics\": \"Metrics collected from your assistant can broadly be categorized as\\n\\n['User Analytics: Who are the users of the assistant, and how do they feel\\\\nabout it? Examples: demographics, channels, sentiment analysis', 'Usage Analytics: How is the assistant\\u2019s overall health and what kind of\\\\ntraffic is coming to it? Examples: total number of sessions, time per\\\\nsession, errors and error rates', 'Conversation Analytics: What happened during the conversation?\\\\nExamples: number of messages sent, abandonment depth, number of topics\\\\nintroduced by user, top N intents', 'Business Analytics: How is the assistant performing with regard to business goals?\\\\nExamples: ROI of assistant per LoB, time comparison of assistant vs agent, containment rate']\\n\\nIn this version of the Analytics pipeline, measurement of the following metrics\\nis possible\\n\\n| Metric | Category | Meaning |\\n|--------|----------|---------|\\n| Number of conversations| Usage Analytics | Total number of conversations |\\n| Number of users | Usage Analytics | Total number of users |\\n| Number of sessions | Usage Analytics | Gross traffic to assistant |\\n| Channels used | Usage Analytics | Sessions by channel |\\n| User session count | User Analytics | Total number of user sessions or average sessions per user |\\n| Top N intents | Conversation Analytics | Top intents across all users |\\n| Avg response time | Conversation Analytics | Average response time for assistant |\\n| Containment rate | Business Analytics | % of conversations handled purely by assistant (not handed to human agent |\\n| Abandonment rate | Business Analytics | % of abandoned conversations |\\n| Escalation rate | Business Analytics | % of conversations escalated to human agent |\\n\\nFor examples of how you can extract these metrics,\\nsee [Example queries](./example-queries.mdx).\", \"Prerequisites\": [\"A production deployment of Kafka is required to set up Rasa Pro.\\nWe recommend using [Amazon Managed Streaming for\\nApache Kafka](https://aws.amazon.com/msk/).\", \"A production deployment of a data lake needs to be connected to\\nthe data pipeline. Rasa Pro directly supports the following data lakes:\", [\"[PostgreSQL](https://aws.amazon.com/rds/postgresql/) (\\n**recommended**. All PostgreSQL >= 11.0 are supported)\", \"[Amazon Redshift](https://aws.amazon.com/redshift/)\"], \"Virtually any other data lakes can be configured to sync with your deployment of PostgreSQL.\\nYou can find additional instructions on how to connect your PostgreSQL deployment to either [BigQuery](#bigquery)\\nor [Snowflake](#snowflake) in the [Connect a data warehouse step](#2-connect-a-data-warehouse).\", \"We recommend managed deployments of your data lake to minimize maintenance\\nefforts.\"], \"1. Connect an assistant\": \"To connect an assistant to Rasa Pro Services, you need to connect the assistant\\nto an event broker. The assistant will stream all events to the event broker,\\nwhich will then be consumed by Rasa Pro Services.\\n\\nThe configuration of the assistant is the first step of\\n[Installation and Configuration](./deploy/deploy-rasa-pro-services.mdx/#installation-and-configuration).\\nNo additional configuration is required to connect the assistant to the\\nAnalytics pipeline. After the assistant is deployed, the Analytics pipeline\\nwill receive the data from the assistant and persist it to your\\ndata warehouse which will be configured in the next step.\", \"2. Connect a data warehouse\": {\"PostgreSQL\": \"You can use Amazon Relational Database Service (RDS) to create a PostgreSQL\\nDB instance which is the environment that will run your PostgreSQL database.\\n\\nFirst, you must set up Amazon RDS by completing the instructions listed\\n[here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SettingUp.html).\\nNext, create the PostgreSQL DB instance. You can follow one of the\\nfollowing instruction sets:\\n\\n['the AWS _Easy create_ instructions listed in the [**Creating a PostgreSQL DB instance** section](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_GettingStarted.CreatingConnecting.PostgreSQL.html#CHAP_GettingStarted.Creating.PostgreSQL)', 'the AWS [_Standard create_ instructions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html)']\\n\\nTo build the DB URL in the DBAPI format specified in the\\n[**Connect an assistance** section](#connect-an-assistant) you must enter\\nthe database credentials. You must obtain the database username and password\\nafter you select a database authentication option during the process of\\nthe PostgreSQL DB instance creation:\\n\\n['**Password authentication** to use database credentials only, in which\\\\ncase you must enter a username for the master username, as well as generate\\\\nthe master password.', '[**Password and IAM DB authentication**](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html)\\\\nto use IAM users and roles for the authentication of database users.', '[**Password and Kerberos authentication**](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/postgresql-kerberos.html)']\\n\\nFinally, when running the Analytics pipeline Docker container, set the\\n[environment variable `RASA_ANALYTICS_DB_URL`](../../deploy/deploy-rasa-pro-services.mdx#docker-container-configuration-reference)\\nto the PostgreSQL Amazon RDS DB instance URL.\", \"Redshift\": {\"Streaming from PostgreSQL to Redshift\": \"If you meet the [prerequisites](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html#CHAP_Target.Redshift.Prerequisites)\\nfor using an Amazon Redshift database as a target, you will need to implement two steps:\\n\\n['configure the PostgreSQL source for AWS Database Migration Service\\\\n(DMS) by following these [instructions](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html)', 'configure the Redshift target for AWS DMS following the instructions\\\\n[here](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Redshift.html).']\", \"Direct connection\": \"You can get started on enabling the direct connection with Redshift by\\nfollowing these resources on creating an [Amazon Redshift cluster](https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html).\\nBefore you do so, you should take into account that streaming historical\\ndata directly to Redshift could take much longer than streaming directly\\nto or via the PostgreSQL RDS instance.\\n\\nYou must update the `RASA_ANALYTICS_DB_URL` to the Redshift cluster DB URL\\nwhich must follow the following format:\\n\\n```\\nredshift://<USER>:<PASSWORD>@<AWS URL>:5439/<DB NAME>\\n```\\n\\nFor example:\\n\\n```\\nredshift://awsuser:4324312adfaGQ@analytics.cp1yucixmagz.us-east-1.redshift.amazonaws.com:5439/analytics\\n```\\n\\n:::caution Redshift write performance\\n\\nAs a result of performance considerations, we strongly advise against\\nchoosing a direct connection to Redshift. Redshift is a great data lake for\\nanalytics but lacks the necessary write performance to directly stream data to it.\\n\\n:::\"}, \"BigQuery\": \"To stream data from PostgreSQL to BigQuery, you can use [Datastream for BigQuery](https://cloud.google.com/datastream/docs).\\nDatastream for BigQuery supports several [PostgreSQL deployment types](https://cloud.google.com/datastream/docs/configure-your-source-postgresql-database#overview),\\nincluding [CloudSQL](https://cloud.google.com/sql/docs/postgres).\\n\\nBefore you begin, make sure to check the Datastream [prerequisites](https://cloud.google.com/datastream/docs/before-you-begin), as well as\\nadditional Datastream networking connectivity [requirements](https://cloud.google.com/datastream/docs/quickstart-replication-to-bigquery#requirements).\\n\\nYou can closely follow [this quickstart guide](https://cloud.google.com/datastream/docs/quickstart-replication-to-bigquery) on replicating data from PostgreSQL CloudSQL to BigQuery with Datastream.\\n\\nAlternatively, you can deep dive into the following Datastream set-up guides:\\n\\n['[Configure your source PostgreSQL database](https://cloud.google.com/datastream/docs/configure-your-source-postgresql-database)', 'Optional: use [customer-managed encryption keys](https://cloud.google.com/datastream/docs/use-cmek)', 'Create a [connection profile for PostgreSQL database](https://cloud.google.com/datastream/docs/create-connection-profiles#cp4postgresdb)', 'Create a [stream](https://cloud.google.com/datastream/docs/create-a-stream)']\", \"Snowflake\": \"You can sync your PostgreSQL deployment manually or via an automated [partner solution](https://docs.snowflake.com/en/user-guide/ecosystem-etl.html).\\n\\nThe instructions for manual sync include the following steps:\\n\\n['Extract data from PostgreSQL to file using `COPY INTO` [command](https://docs.snowflake.com/en/sql-reference/sql/copy-into-location.html).\\\\nYou should also explore the Snowflake [data loading best practices](https://docs.snowflake.com/en/user-guide/data-load-considerations.html) before extraction.', 'Stage the extracted data files to either internal or external locations such as AWS S3, Google Cloud Storage or Microsoft Azure.', 'Copy staged files to Snowflake tables using `COPY INTO` [command](https://docs.snowflake.com/en/sql-reference/sql/copy-into-table.html).\\\\nYou can decide to use [bulk data loading](https://docs.snowflake.com/en/user-guide/data-load-bulk.html) into Snowflake or to load continuously using [Snowpipe](https://docs.snowflake.com/en/user-guide/data-load-snowpipe.html).\\\\nAlternatively you can also benefit from [this plugin](https://cdap.atlassian.net/wiki/spaces/DOCS/pages/694157985/Cloud+Storage+to+Snowflake+Action) to load data to an existing Snowflake table.']\"}, \"3. Ingest past conversations (optional)\": \"When Analytics is connected to your Kafka instance, it will consume\\nall prior events on the Kafka topic and ingest them into the database.\\nKafka has a retention policy for events on a [topic which defaults to\\n7 days](https://docs.confluent.io/platform/current/installation/configuration/topic-configs.html#topicconfigs_retention.ms).\\n\\nIf you want to process events from conversations that are older than the\\nretention policy configured for the Rasa topic, you can manually\\ningest events from past conversations.\\n\\nManually ingesting data from past conversations requires a connection to the\\ntracker store. The tracker store contains past conversations and a\\nconnection to the Kafka cluster. Use the `rasa export` command to export\\nthe events stored in the tracker store to Kafka:\\n\\n```\\nrasa export --endpoints endpoints.yml\\n```\\n\\nConfigure the export to read from your production tracker store\\nand write to Kafka as an event broker, e.g.\\n\\n```\\n tracker_store:\\n type: SQL\\n dialect: \\\"postgresql\\\"\\n url: \\\"localhost\\\"\\n db: \\\"tracker\\\"\\n username: postgres\\n password: password\\n\\n event_broker:\\n type: kafka\\n topic: rasa-events\\n url: localhost:29092\\n partition_by_sender: true\\n```\\n\\n:::note\\n\\nRunning manual ingestion of past events multiple times will result in\\nduplicated events. There is currently no deduplication implemented in\\nAnalytics. Every ingested event will be stored in the database,\\neven if it was processed previously.\\n:::\", \"4. Connect a BI Solution\": {\"Example: Metabase\": \"Metabase is a free and open-source business intelligence platform. It\\nprovides a simple interface to query and visualize data. Metabase can\\nbe connected to PostgreSQL or Redshift databases.\\n\\n['[Connecting Metabase to PostgreSQL](https://www.metabase.com/data_sources/postgresql)', '[Connecting Metabase to Redshift](https://www.metabase.com/data_sources/amazon-redshift)']\", \"Example: Tableau\": \"Tableau is a business intelligence platform. It provides a flexible interface\\nto build business intelligence dashboards. Tableau can be connected to\\nPostgreSQL or Redshift databases.\\n\\n['[Connecting Tableau to PostgreSQL](https://help.tableau.com/current/pro/desktop/en-us/examples_postgresql.htm)', '[Connecting Tableau to Redshift](https://help.tableau.com/current/pro/desktop/en-us/examples_amazonredshift.htm)']\"}}, \"metadata\": {\"id\": \"getting-started-with-analytics\", \"sidebar_label\": \"Getting started\", \"title\": \"Getting started with Analytics\", \"description\": null, \"abstract\": \"Visualise and process Rasa assistant metrics in the tooling of choice.\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"Real-Time Analysis of Markers\", \"description\": null, \"content\": {\"Defining Markers\": \"Please consult the [Markers](../../markers.mdx/#defining-markers) section of Rasa documentation\\nfor details about defining markers.\", \"Enable Real-time Processing\": {\"Configuring the CLI command\": \"Visit our [CLI page](./command-line-interface.mdx#rasa-marker-upload)\\nfor more information about the command line arguments available.\"}, \"How are Markers processed?\": \"The markers YAML file describes the pattern of events for marker extraction.\\nOnce the YAML files are uploaded, the patterns to be used for marker extraction are\\nstored in the `rasa_patterns` table. As the Kafka Consumer starts receiving events\\nfrom the Rasa Assistant, it starts analyzing them for markers. The Pipeline\\nprocesses all the events from the Kafka Event Broker and identifies points of\\ninterest in the conversation that match the marker. The extracted markers are then stored\\nin the `rasa_marker` table.\\n\\nThe evaluation of Markers in the Pipeline is similar to the `rasa evaluate markers`\\ncommand which can be used to process Markers from the conversations in Tracker Store.\\nRead more about it [here](../../markers.mdx/#extracting-markers)\\n\\nExtracted markers are added to the `rasa_markers` table in the database\\nimmediately once they are processed. Each row in this table contains\\nthe foreign key identifiers for the pattern, session, sender and\\nlast event when marker was extracted along with `num_preceding_user_turns`\\nwhich tracks the number of turns preceding the event at which the marker applied.\\nCheck out the [Data Structure Reference](data-structure-reference.mdx/#rasa-markers) page for the\\ndatabase schema of relevant tables.\"}, \"metadata\": {\"id\": \"realtime-markers\", \"sidebar_label\": \"Real-Time Markers\", \"title\": \"Real-Time Analysis of Markers\", \"hide_table_of_contents\": false}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 61]\"}, {\"title\": \"Telemetry\", \"description\": \"Documentation section: telemetry\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/rasa/original/docs/docs/telemetry\"}, \"subpages\": [{\"title\": \"Rasa Telemetry\", \"description\": null, \"content\": {\"How to opt-out\": \"You can opt out of telemetry reporting at any time by running the command:\\n\\n```\\nrasa telemetry disable\\n```\\n\\nor by defining `RASA_TELEMETRY_ENABLED=false` as an environment variable.\\nIf you want to enable reporting again, you can run:\\n\\n```\\nrasa telemetry enable\\n```\", \"Why do we use telemetry reporting?\": \"**Anonymous** telemetry data allow us to prioritize our research efforts\\nand feature development based on usage. We want to collect aggregated\\ninformation on usage and reliability so that we can ensure a high-quality product.\\n\\nSo how will we use the reported telemetry data? Here are some examples\\nof what we use the data for:\\n\\n['We will be able to know which languages, pipelines and policies are used.\\\\nThis will enable us to direct our research efforts towards text and\\\\ndialogue handling projects that will have the biggest impact for our users.', 'We will be able to know data set sizes and general structure (e.g. the number\\\\nof intents). This allows us to better test our software on different types\\\\nof data sets and optimize the frameworks performance.', 'We will be able to get more detail on the types of errors you are running\\\\ninto while building an assistant (e.g. initialization, training, etc.).\\\\nThis will let us improve the quality of our framework and better focus our\\\\ntime on solving more common, frustrating issues.']\", \"What about sensitive data?\": \"Your sensitive data never leaves your machine. We:\\n\\n[\\\"**don't** report any personal identifiable information\\\", \\\"**don't** report your training data\\\", \\\"**don't** report any messages your assistant receives or sends\\\"]\\n\\n:::note Inspect what is reported\\nYou can view all the telemetry information that is reported\\nby defining the environment variable `RASA_TELEMETRY_DEBUG=true`, for example when running the train command:\\n\\n```\\nRASA_TELEMETRY_DEBUG=true rasa train\\n```\\n\\nWhen you set `RASA_TELEMETRY_DEBUG` no information will be sent to any server,\\ninstead it will be logged to the commandline as a json dump for you to inspect.\\n:::\", \"What do we report?\": \"Rasa reports aggregated usage details, command invocations, performance\\nmeasurements and errors.\\nWe use the telemetry data to better understand usage patterns. The reported data\\nwill directly allow us to better decide how to design future features\\nand prioritize current work.\\n\\nSpecifically, we collect the following information for all telemetry events:\\n\\n['Type of the reported event (e.g. *Training Started*)', 'Rasa machine ID: This is generated with a UUID and stored in the global Rasa\\\\nconfig at `~/.config/rasa/global.yml` and sent as `metrics_id`', 'One-way hash of the current working directory or a hash of the git remote', 'General OS level information (operating system, number of CPUs, number of\\\\nGPUs and whether the command is run inside a CI)', 'Current Rasa and Python version', 'Whether the command is run inside a Docker container', 'Hash of the license (if you are using Rasa Pro)']\\n\\nHere is an example report that shows the data reported to Rasa after running\\n`rasa train`:\\n\\n```\\n{\\n \\\"userId\\\": \\\"38d23c36c9be443281196080fcdd707d\\\",\\n \\\"event\\\": \\\"Training Started\\\",\\n \\\"properties\\\": {\\n \\\"language\\\": \\\"en\\\",\\n \\\"num_intent_examples\\\": 68,\\n \\\"num_entity_examples\\\": 0,\\n \\\"num_actions\\\": 17,\\n \\\"num_templates\\\": 6,\\n \\\"num_conditional_response_variations\\\": 5,\\n \\\"num_slot_mappings\\\": 10,\\n \\\"num_custom_slot_mappings\\\": 2,\\n \\\"num_conditional_slot_mappings\\\": 3,\\n \\\"num_slots\\\": 0,\\n \\\"num_forms\\\": 0,\\n \\\"num_intents\\\": 6,\\n \\\"num_entities\\\": 0,\\n \\\"num_story_steps\\\": 5,\\n \\\"num_lookup_tables\\\": 0,\\n \\\"num_synonyms\\\": 0,\\n \\\"num_regexes\\\": 0,\\n \\\"metrics_id\\\": \\\"38d23c36c9be443281196080fcdd707d\\\"\\n },\\n \\\"context\\\": {\\n \\\"os\\\": {\\n \\\"name\\\": \\\"Darwin\\\",\\n \\\"version\\\": \\\"19.4.0\\\"\\n },\\n \\\"ci\\\": false,\\n \\\"project\\\": \\\"a0a7178e6e5f9e6484c5cfa3ea4497ffc0c96d0ad3f3ad8e9399a1edd88e3cf4\\\",\\n \\\"python\\\": \\\"3.7.5\\\",\\n \\\"rasa_open_source\\\": \\\"2.0.0\\\",\\n \\\"cpu\\\": 16,\\n \\\"docker\\\": false,\\n \\\"license_hash\\\": \\\"t1a7170e6e5f9e6484c5cfa3ea4497ffc0c96a0ad3f3ad8e9399adadd88e3cf5\\\"\\n }\\n}\\n```\\n\\nWe **cannot identify individual users** from the dataset. It is anonymized and\\nuntraceable back to the user.\"}, \"metadata\": {\"id\": \"telemetry\", \"sidebar_label\": \"Rasa Telemetry\", \"title\": \"Rasa Telemetry\", \"abstract\": \"Rasa uses telemetry to report anonymous usage information. This information\\nis essential to help improve Rasa for all users.\\n\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 62, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 62]\"}], \"path\": \"[\\\"subpages\\\", 1]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Core Conversational AI Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Natural Language Understanding (NLU) Pipeline\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Text Processing and Tokenization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Language-specific tokenizers (Whitespace, Jieba, MITIE, spaCy) with multi-language support\", \"weight\": 3}, {\"requirements\": \"Text preprocessing and normalization capabilities\", \"weight\": 2}]}, {\"requirements\": \"Feature Extraction and Representation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Dense feature extraction using pre-trained models (ConveRT, LanguageModelFeaturizer, spaCy)\", \"weight\": 3}, {\"requirements\": \"Sparse feature extraction (CountVectors, Regex, LexicalSyntactic)\", \"weight\": 2}, {\"requirements\": \"Pre-trained embedding integration (MITIE, spaCy)\", \"weight\": 2}]}, {\"requirements\": \"Intent Classification System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"DIET (Dual Intent Entity Transformer) unified architecture for multi-task learning\", \"weight\": 3}, {\"requirements\": \"Multi-intent classification capability with confidence scoring\", \"weight\": 3}, {\"requirements\": \"Fallback mechanisms and out-of-scope detection\", \"weight\": 3}]}, {\"requirements\": \"Entity Extraction Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Named entity recognition with roles and groups support\", \"weight\": 3}, {\"requirements\": \"Multiple extraction methods: rule-based (RegexEntityExtractor), ML-based (CRFEntityExtractor, DIETClassifier), and pre-trained models (SpacyEntityExtractor)\", \"weight\": 3}, {\"requirements\": \"Entity synonym mapping and lookup table integration for normalization\", \"weight\": 2}]}, {\"requirements\": \"Response Selection System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"ResponseSelector for retrieval intents (FAQs, chitchat) with context-aware selection\", \"weight\": 2}]}]}, {\"requirements\": \"Dialogue Management System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Conversation State Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Tracker-based state management storing conversation events and context\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Event-driven architecture capturing user inputs, bot actions, slot changes, and conversation milestones\", \"weight\": 3}, {\"requirements\": \"Session lifecycle management and restart handling\", \"weight\": 2}]}, {\"requirements\": \"Slot-based memory system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Typed slot system (text, boolean, categorical, float, list, any) with influence on dialogue flow\", \"weight\": 3}, {\"requirements\": \"Configurable slot mapping mechanisms (entity, text, intent, trigger mappings)\", \"weight\": 3}]}, {\"requirements\": \"Persistent state storage with configurable Tracker Store backends (InMemory, Redis, MongoDB, DynamoDB, SQL)\", \"weight\": 3}, {\"requirements\": \"Lock Store mechanism for conversation-level concurrency control and race condition prevention\", \"weight\": 2}]}, {\"requirements\": \"Policy-Based Action Prediction\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Policy orchestration with priority-based execution allowing rule overrides\", \"weight\": 3}, {\"requirements\": \"Rule-Based Policy System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"RulePolicy for deterministic execution of fixed conversation paths and business logic\", \"weight\": 3}, {\"requirements\": \"Form handling for systematic information collection with validation\", \"weight\": 3}]}, {\"requirements\": \"Machine Learning Policies\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"TEDPolicy (Transformer Embedding Dialogue) for generalized conversation handling and multi-turn context modeling\", \"weight\": 3}, {\"requirements\": \"MemoizationPolicy for exact pattern matching from training stories\", \"weight\": 2}, {\"requirements\": \"UnexpecTED Intent Policy for out-of-scope detection and handling\", \"weight\": 2}]}]}, {\"requirements\": \"Form-Based Information Gathering\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Dynamic slot validation with custom mappings and unhappy path handling\", \"weight\": 3}, {\"requirements\": \"Form activation, deactivation, and loop-based collection mechanisms\", \"weight\": 2}]}]}, {\"requirements\": \"Action Execution System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Action Server Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Custom Action Framework with HTTP-based communication and event-driven execution\", \"weight\": 3}, {\"requirements\": \"Tracker and domain access for actions with external service integration capabilities\", \"weight\": 3}, {\"requirements\": \"Action Server endpoint for connecting to independent custom action services\", \"weight\": 3}]}, {\"requirements\": \"Built-in Default Actions\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Session management actions (action_restart, action_listen, action_default_fallback)\", \"weight\": 2}, {\"requirements\": \"Form and slot manipulation actions for conversation flow control\", \"weight\": 2}]}, {\"requirements\": \"Response Generation System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Template-based response actions (utter_...) with variable substitution and conditional variations\", \"weight\": 3}, {\"requirements\": \"Rich response support including text, buttons, images, and custom payloads\", \"weight\": 2}, {\"requirements\": \"Channel-specific response formatting and adaptation\", \"weight\": 2}, {\"requirements\": \"External NLG Server endpoint for delegated response generation\", \"weight\": 1}]}]}]}, {\"requirements\": \"Configuration and Data Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Domain Schema Definition\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Central domain.yml schema defining assistant capabilities (intents, entities, slots, actions, responses)\", \"weight\": 3}, {\"requirements\": \"Slot type definitions and mapping configurations\", \"weight\": 3}, {\"requirements\": \"Response template definitions with metadata and variations\", \"weight\": 2}]}, {\"requirements\": \"Training Data Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"NLU Training Data with examples, synonyms, regexes, and lookup tables\", \"weight\": 3}, {\"requirements\": \"Dialogue Training Data\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Stories for example conversation paths and ML policy training\", \"weight\": 3}, {\"requirements\": \"Rules for fixed behavior patterns that override ML predictions\", \"weight\": 3}]}, {\"requirements\": \"YAML-based training data format with validation and migration tools\", \"weight\": 2}]}, {\"requirements\": \"Model Configuration System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"NLU pipeline configuration with component sequence and hyperparameters\", \"weight\": 3}, {\"requirements\": \"Policy configuration for dialogue management with priority settings\", \"weight\": 3}, {\"requirements\": \"Graph Recipe format for complex, non-linear model architectures with custom components\", \"weight\": 2}]}]}, {\"requirements\": \"Training and Model Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Graph-Based Training Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Component dependency resolution and execution graph management\", \"weight\": 3}, {\"requirements\": \"Incremental training capabilities for model updates without full retraining\", \"weight\": 2}]}, {\"requirements\": \"Model Storage and Deployment\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-backend model storage (local, S3, GCS, Azure) with remote loading capabilities\", \"weight\": 3}, {\"requirements\": \"Model versioning and artifact management\", \"weight\": 2}]}, {\"requirements\": \"Testing and Evaluation Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Automated testing suite (rasa test) for NLU performance, dialogue prediction, and end-to-end flows\", \"weight\": 3}, {\"requirements\": \"Cross-validation and held-out test set evaluation with metrics reporting\", \"weight\": 2}, {\"requirements\": \"Data validation (rasa data validate) for training data integrity and consistency\", \"weight\": 2}]}]}, {\"requirements\": \"External Integrations and Communication\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Channel Connector System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Built-in connectors for messaging platforms (Slack, Facebook, Telegram, Twilio, Webex)\", \"weight\": 3}, {\"requirements\": \"Voice channel support (Twilio Voice, IVR) and custom website integration\", \"weight\": 2}, {\"requirements\": \"Custom connector framework for extending to new platforms\", \"weight\": 2}]}, {\"requirements\": \"HTTP API and Communication Layer\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"REST and WebSocket APIs for conversation management and model operations\", \"weight\": 3}, {\"requirements\": \"Authentication and security (JWT, token-based) for API access control\", \"weight\": 3}]}, {\"requirements\": \"Event Streaming and Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Event Broker endpoints for streaming to message queues (Kafka, RabbitMQ, SQL)\", \"weight\": 2}, {\"requirements\": \"Asynchronous event processing and analytics integration\", \"weight\": 2}]}]}, {\"requirements\": \"Development and Operations Framework\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Command Line Interface (CLI)\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Unified toolset for assistant lifecycle (init, train, interactive, run, data management)\", \"weight\": 3}]}, {\"requirements\": \"Deployment and Scaling Infrastructure\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Containerization support with official Docker images and Docker Compose configurations\", \"weight\": 2}, {\"requirements\": \"Kubernetes and OpenShift deployment with Helm charts for production scaling\", \"weight\": 2}]}, {\"requirements\": \"Monitoring and Observability\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"OpenTelemetry-based distributed tracing for performance monitoring and bottleneck identification\", \"weight\": 2}, {\"requirements\": \"Conversational analytics with event-based data pipeline and BI integration\", \"weight\": 2}, {\"requirements\": \"Marker-based conversation pattern detection and analytics\", \"weight\": 1}]}]}, {\"requirements\": \"Enterprise Security and Compliance Features\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"PII Management and Data Protection\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Rule-based PII detection and anonymization in logs and event streams\", \"weight\": 2}, {\"requirements\": \"Compliance-focused event stream anonymization\", \"weight\": 2}]}, {\"requirements\": \"Secrets and Credential Management\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"HashiCorp Vault integration for secure credential management\", \"weight\": 1}]}, {\"requirements\": \"Multi-tenant Architecture (Spaces)\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Domain-specific conversation spaces with filtering and context switching\", \"weight\": 2}, {\"requirements\": \"Space activation and tenant isolation mechanisms\", \"weight\": 2}]}]}]}"}}},{"rowIdx":16,"cells":{"repo_name":{"kind":"string","value":"storybook"},"repo_url":{"kind":"string","value":"https://github.com/storybookjs/storybook"},"commit_id":{"kind":"string","value":"f739234e9972691f757430404d8988e40b2dcf4c"},"docs_tree":{"kind":"string","value":"{\"title\": \"storybook\", \"description\": \"Documentation for storybook\", \"subpages\": [{\"title\": \"Frequently Asked Questions\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"Error: No angular.json file found\": \"<detail_content>\", \"How can I opt-out of Angular Ivy?\": \"<detail_content>\", \"How can I opt-out of Angular ngcc?\": \"<detail_content>\", \"How can I run coverage tests with Create React App and leave out stories?\": \"<detail_content>\", \"How do I setup Storybook to share Webpack configuration with Next.js?\": \"<detail_content>\", \"How do I fix module resolution in special environments?\": \"<detail_content>\", \"How do I setup the new React Context Root API with Storybook?\": \"<detail_content>\", \"Why is there no addons channel?\": \"<detail_content>\", \"Why aren't the addons working in a composed Storybook?\": \"<detail_content>\", \"Can I have a Storybook with no local stories?\": \"<detail_content>\", \"Which community addons are compatible with the latest version of Storybook?\": \"<detail_content>\", \"Is it possible to browse the documentation for past versions of Storybook?\": \"<detail_content>\", \"What icons are available for my toolbar or my addon?\": \"<detail_content>\", \"I see a \\\"No Preview\\\" error with a Storybook production build\": \"<detail_content>\", \"Can I use Storybook with Vue 2?\": \"<detail_content>\", \"Why aren't my code blocks highlighted with Storybook MDX?\": \"<detail_content>\", \"Why aren't my MDX styles working in Storybook?\": \"<detail_content>\", \"Why are my mocked GraphQL queries failing with Storybook's MSW addon?\": \"<detail_content>\", \"Can I use other GraphQL providers with Storybook's MSW addon?\": \"<detail_content>\", \"Can I mock GraphQL mutations with Storybook's MSW addon?\": \"<detail_content>\", \"Why are my stories not showing up correctly when using certain characters?\": \"<detail_content>\", \"Why is Storybook's source loader returning undefined with curried functions?\": \"<detail_content>\", \"Why are my args no longer displaying the default values?\": \"<detail_content>\", \"Why isn't Storybook's test runner working?\": \"<detail_content>\", \"How does Storybook handle environment variables?\": \"<detail_content>\"}}, {\"title\": \"Get started with Storybook\", \"path\": \"[\\\"subpages\\\", 1]\", \"content\": {\"What is Storybook?\": \"<detail_content>\", \"Install Storybook\": \"<detail_content>\", \"Main concepts\": \"<detail_content>\", \"Additional resources\": \"<detail_content>\"}}, {\"title\": \" Snippets\", \"description\": \"Documentation section: _snippets\", \"path\": \"[\\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Addon A11Y Add\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Config Context In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Config In Meta And Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Config In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Config Rules In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Config Rulesets In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Disable\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Parameter Error In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Parameter Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 9]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Parameter Remove\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 10]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Parameter Todo In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon A11Y Register\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Actions Action Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 13]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Backgrounds Define Globals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 14]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Backgrounds Disabled\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 15]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Backgrounds Grid\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 16]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Backgrounds Options In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 17]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Backgrounds Options In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 18]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Consume And Update Globaltype\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 19]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Consume Globaltype\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 20]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Docs Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 21]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Test Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 22]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Viewport Add Viewport In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 23]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Viewport Configuration In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 24]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Viewport Define Globals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 25]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Viewport Options In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 26]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Addon Vitest Set Project Annotations Simple\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 27]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"After Each In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 28]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Angular Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 29]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Angular Builder Production\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 30]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Angular Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 31]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Angular Project Compodoc Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 32]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Argtypes Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 33]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Canvas Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 34]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Controls Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 35]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Description Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 36]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Source Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 37]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Api Doc Block Story Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 38]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 39]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Default Value\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 40]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Description\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 41]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types If\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 42]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 43]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 44]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 45]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Mapping\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 46]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Name\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 47]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 48]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Table\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 49]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Arg Types Type\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 50]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Args In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 51]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Args Usage With Addons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 52]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Automock Register Full\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 53]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Automock Register Mock File\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 54]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Automock Register Spy\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 55]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Automocked Modules In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 56]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Before All In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 57]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Before Each In Meta Mock Date\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 58]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Before Each In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 59]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Build Storybook Production Mode\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 60]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Component With Proptypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 61]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Group Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 62]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Implementation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 63]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Snapshot Test Portable Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 64]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Argtypes With Categories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 65]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Argtypes With Subcategories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 66]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Baseline With Satisfies Story Level\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 67]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Baseline With Satisfies\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 68]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Baseline\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 69]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Click Handler Args\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 70]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Click Handler Simplificated\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 71]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Click Handler\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 72]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Component Args Primary\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 73]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Component Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 74]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Controls Primary Variant\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 75]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Controls Radio Group\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 76]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 77]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Default Export With Component\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 78]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Default Export\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 79]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Disable Addon\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 80]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Grouped\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 81]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Hoisted\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 82]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Hypothetical Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 83]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Matching Argtypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 84]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Onclick Action Spy\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 85]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Primary Composition\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 86]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Primary Long Name\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 87]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Rename Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 88]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story Using Args\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 89]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story With Addon Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 90]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story With Args\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 91]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story With Emojis\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 92]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story With Sample\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 93]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Button Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 94]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Checkbox Story Csf\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 95]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Checkbox Story Grouped\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 96]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Checkbox Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 97]\", \"content\": {\"Checkbox\": \"<detail_content>\"}}, {\"title\": \"Chromatic Github Action\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 98]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Chromatic Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 99]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Chromatic Storybook Add\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 100]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Code Panel Enable In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 101]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Code Panel In Meta And Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 102]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Compodoc Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 103]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Cypress Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 104]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Playwright Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 105]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Conditional Controls Mutual Exclusion\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 106]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Conditional Controls Toggle\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 107]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Custom Args Complex\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 108]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Custom Args Icons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 109]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Custom Args Mapping\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 110]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Disable Controls Alt\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 111]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Disable Controls Regex\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 112]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Disable Controls\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 113]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Figma Integration\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 114]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Highlight\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 115]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Sort Controls\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 116]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Static Asset Cdn\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 117]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Static Asset With Import\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 118]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Static Asset Without Import\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 119]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story With Custom Render Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 120]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Styled Variables Object Notation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 121]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Styled Variables Template Literals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 122]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Test With Testing Library\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 123]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Configure Mock Provider With Story Parameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 124]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Create Command Custom Package Manager\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 125]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Create Command Custom Version\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 126]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Create Command Manual Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 127]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Create Command\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 128]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 2 Example Primary Dark Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 129]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 2 Example Starter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 130]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 2 Example Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 131]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 2 Example Title\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 132]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Auto Title\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 133]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Default Render\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 134]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Primary Dark Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 135]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Render\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 136]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Starter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 137]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Csf 3 Example Title\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 138]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"With the story title defined\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 139]\", \"content\": {\"Primary\": \"<detail_content>\", \"Secondary\": \"<detail_content>\", \"Large\": \"<detail_content>\", \"Small\": \"<detail_content>\"}}, {\"title\": \"Decorator Parameterized In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 140]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Document Screen Fetch\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 141]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Document Screen With Graphql\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 142]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Eslint Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 143]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Eslint Plugin Storybook Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 144]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Essential Feature Disable\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 145]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Foo Bar Baz Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 146]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Ghp Github Action\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 147]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Gizmo Story Controls Customization\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 148]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Highlight Custom Style\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 149]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Highlight Menu\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 150]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Highlight Remove\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 151]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Highlight Reset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 152]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Highlight Scroll Into View\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 153]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Histogram Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 154]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Individual Snapshot Tests Portable Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 155]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Init Command Custom Version\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 156]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Init Command\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 157]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Interaction Test Complex\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 158]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Interaction Test Fn Mock Spy\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 159]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Interaction Test Simple\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 160]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story Expanded\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 161]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story Reuse Data\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 162]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story Starter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 163]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story Template\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 164]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story Unchecked\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 165]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story With Subcomponents\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 166]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"List Story With Unchecked Children\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 167]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Loader Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 168]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Login Form With Play Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 169]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Addons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 170]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Babel\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 171]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Builder Custom Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 172]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Builder\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 173]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Cross Origin Isolated\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 174]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Disable Project Json\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 175]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Disable Telemetry\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 176]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Disable Update Notifications\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 177]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Disable Webpack Defaults\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 178]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Core Enable Crash Reports\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 179]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Docs Autodocs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 180]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Docs Default Name\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 181]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Docs Docs Mode\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 182]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Env\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 183]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Features Arg Type Targets V7\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 184]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Features Development Mode For Build\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 185]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Features Legacy Decorator File Order\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 186]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 187]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Indexers Jsonstories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 188]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Indexers Title\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 189]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Indexers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 190]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Log Level\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 191]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Manager Head\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 192]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Preview Body\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 193]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Preview Head\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 194]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 195]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Refs Disable\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 196]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Refs With Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 197]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Refs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 198]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Static Dirs With Object\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 199]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Static Dirs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 200]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Stories Ordered\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 201]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Stories With Logic\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 202]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Stories With Object\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 203]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 204]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Svelte Csf Register\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 205]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Swc Jsx Transform\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 206]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Swc\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 207]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Autodocs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 208]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Blocks\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 209]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Disableaddons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 210]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Docgen\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 211]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Mdx\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 212]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Sourcemaps\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 213]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Test Disable Treeshaking\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 214]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typescript Check Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 215]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typescript Check\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 216]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typescript React Docgen Typescript Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 217]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typescript React Docgen\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 218]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typescript Skip Compiler\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 219]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Typical\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 220]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Vite Final Env\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 221]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Vite Final\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 222]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Main Config Webpack Final\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 223]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Margindecorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 224]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Migrate Csf 2 To 3\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 225]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Context Container Global\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 226]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Context Container Provider\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 227]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Context Container\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 228]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Context Create\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 229]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Context In Use\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 230]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mock Provider In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 231]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Module Aliases Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 232]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mount Advanced\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 233]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Mount Basic\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 234]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Msw Addon Configure Handlers Graphql\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 235]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Msw Addon Configure Handlers Http\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 236]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Msw Addon Initialize\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 237]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Msw Addon Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 238]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Msw Generate Service Worker\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 239]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Multiple Stories Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 240]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Disable Toc\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 241]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Env Var Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 242]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Exclude Tags\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 243]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Include Tags\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 244]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Skip Tags\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 245]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story Basic And Props\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 246]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story Import Json\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 247]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story Import Static Asset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 248]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story Mandatory Export\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 249]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story Use Globaltype\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 250]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story With Nonstory\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 251]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story With Storyname\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 252]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 253]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component Vite Env Variables\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 254]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component With Custom Syntax Highlight\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 255]\", \"content\": {\"SCSS example\": \"<detail_content>\"}}, {\"title\": \"My Component With Env Variables\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 256]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"My Component With Global Syntax Highlight\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 257]\", \"content\": {\"SCSS example\": \"<detail_content>\"}}, {\"title\": \"Nextjs Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 258]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs App Directory In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 259]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs App Directory In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 260]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Cache Mock\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 261]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Configure Svgr\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 262]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Headers Mock\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 263]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Image Static Dirs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 264]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 265]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Navigation Mock\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 266]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Navigation Override In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 267]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Navigation Segments For Use Params Override In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 268]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Navigation Segments Override In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 269]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Remove Addons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 270]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Router Mock\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 271]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Router Override In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 272]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 273]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 274]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nextjs Vite Remove Addons\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 275]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Other Foo Bar Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 276]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Override Compose Story Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 277]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Page Story Args Within Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 278]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Page Story Slots\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 279]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Page Story With Args Composition\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 280]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Page Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 281]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Parameters In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 282]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Parameters In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 283]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Parameters In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 284]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Play Function Composition\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 285]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Play Function With Canvas\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 286]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Play Function With Screen\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 287]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Play Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 288]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Csf Factory Render\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 289]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Csf Factory Run\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 290]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Compose Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 291]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Compose Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 292]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Multi Snapshot Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 293]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Override Globals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 294]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Set Project Annotations\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 295]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest Snapshot Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 296]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Jest With Play Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 297]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Playwright Ct Compose Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 298]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Playwright Ct Override Globals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 299]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Playwright Ct\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 300]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Compose Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 301]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Compose Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 302]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Multi Snapshot Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 303]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Override Globals\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 304]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Set Project Annotations\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 305]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest Snapshot Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 306]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Portable Stories Vitest With Play Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 307]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Preact Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 308]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Preact Vite Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 309]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Preact Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 310]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Preview Storybook Production Mode\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 311]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Native Web Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 312]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Native Web Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 313]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 314]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Vite Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 315]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 316]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Webpack5 Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 317]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Webpack5 Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 318]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"React Webpack5 Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 319]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Render Custom In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 320]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Render Custom In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 321]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Reuse Args Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 322]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Rsc Feature Flag\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 323]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Rsc Parameter In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 324]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Seo Description\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 325]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Seo Noindex\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 326]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Shadow Dom Testing Library In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 327]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Shadow Dom Testing Library In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 328]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Simple Page Implementation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 329]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Single Story Test\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 330]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Snapshot Tests Portable Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 331]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Add Command\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 332]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon A11Y Test Setup\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 333]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Compiler Babel Auto Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 334]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Compiler Swc Auto Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 335]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Controls Custom Matchers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 336]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Css Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 337]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Css Helpers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 338]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Disable Addon\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 339]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Load External Addons Preset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 340]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Manager Initial State\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 341]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Panel Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 342]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Panel Initial\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 343]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Preset Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 344]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Release\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 345]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Run Dev Mode\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 346]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Tab Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 347]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Themes Classname Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 348]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Themes Data Attribute Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 349]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Themes Jsx Provider Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 350]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Tool Initial Setup\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 351]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Toolbar Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 352]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Toolkit Types\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 353]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addon Use Global\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 354]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Disablequeryparams\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 355]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Getchannel\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 356]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Getqueryparam\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 357]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Geturlstate\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 358]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Imports\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 359]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Makedecorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 360]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api On\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 361]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Register\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 362]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Selectincurrentkind\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 363]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Selectstory\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 364]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Setqueryparams\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 365]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Useaddonstate\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 366]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Useapi\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 367]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Usechannel\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 368]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Useglobal\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 369]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Useparameter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 370]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Api Usestorybookstate\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 371]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Local Preset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 372]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Preset Babeldefault\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 373]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Preset Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 374]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Preset Vitefinal\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 375]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Preset Webpackfinal\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 376]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Preset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 377]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Root Preset Manager Entries\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 378]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Root Preset Preview Annotations\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 379]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Addons Root Preset\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 380]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Args Url Params Converted\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 381]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Argtypes With Addon\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 382]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Definition\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 383]\", \"content\": {\"Usage\": \"<detail_content>\", \"Inputs\": \"<detail_content>\"}}, {\"title\": \"Design implementation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 384]\", \"content\": {\"When to use?\": \"<detail_content>\", \"How to use?\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Full Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 385]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Main Mdx Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 386]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Definition\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 387]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Docs Only Page\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 388]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Dos Donts\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 389]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Imports\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 390]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Meta Block\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 391]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Auto Docs Mdx Docs Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 392]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Page\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 393]\", \"content\": {\"Usage\": \"<detail_content>\"}}, {\"title\": \"Design Resources\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 394]\", \"content\": {\"Figma\": \"<detail_content>\", \"UI/UX Design Guidelines\": \"<detail_content>\", \"Design Assets\": \"<detail_content>\"}}, {\"title\": \"Button\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 395]\", \"content\": {\"Usage\": \"<detail_content>\"}}, {\"title\": \"Storybook Automigrate\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 396]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Babel Configuration Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 397]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Backgrounds Addon Default Params\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 398]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Backgrounds Preset Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 399]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Build Test Flag\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 400]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Build Server\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 401]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Configuration Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 402]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Dev Server\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 403]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Interface\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 404]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Mdx\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 405]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Preview Exports\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 406]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Builder Api Shutdown Server\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 407]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Canvas Doc Block Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 408]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Client Globals Example File\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 409]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Client Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 410]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Component Layout Param\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 411]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Config Layout\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 412]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Coverage Addon Config Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 413]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Coverage Addon Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 414]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Coverage Addon Optimized Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 415]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Coverage Report Lcov\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 416]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Coverage Report Vue\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 417]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Csf 3 Auto Title Redundant\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 418]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Custom Docs Markdown\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 419]\", \"content\": {\"Changelog\": \"<detail_content>\"}}, {\"title\": \"Storybook Custom Manager Head\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 420]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Debug Webpack Dev\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 421]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Debug Webpack Prod\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 422]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Disable Telemetry Env\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 423]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Disable Telemetry Flag\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 424]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Doctor\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 425]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Ember Cli Build\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 426]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Extract Specific Version\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 427]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Figma Addon Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 428]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Fix Imports Autodocs Monorepo\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 429]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Framework Render Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 430]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Generated Argtypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 431]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Init V7\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 432]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Interactions Play Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 433]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Interactions Step Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 434]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Advanced Config Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 435]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Auto Title Custom\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 436]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Config Remark Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 437]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Configuration Src Dir\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 438]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Disable Telemetry\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 439]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Extend Ts Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 440]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Fix Imports Autodocs Monorepo\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 441]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Js Md Files\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 442]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Pnpm With Module Resolution\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 443]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Preview Head\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 444]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Prop Filter\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 445]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main React Docgen Typescript\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 446]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Ref Local\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 447]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Register Addon\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 448]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Register Example Addon\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 449]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Register Presets Managerentry\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 450]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Simplified Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 451]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Ts Module Resolution Atsign Import\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 452]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Ts Module Resolution\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 453]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Use Manager Entries\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 454]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Using Existing Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 455]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Versioned Webpack\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 456]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpack Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 457]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpack Preset Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 458]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpack5 Fscache\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 459]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpack5 Lazycompilation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 460]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpack5\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 461]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Main Webpackfinal Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 462]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Custom Theme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 463]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Dark Theme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 464]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Disable Roots\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 465]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Render Label Stories\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 466]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Sidebar Hide On Landing\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 467]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Manager Toolbar Hide On Docs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 468]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Default implementation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 469]\", \"content\": {\"Inputs\": \"<detail_content>\", \"Additional variations\": \"<detail_content>\"}}, {\"title\": \"Storybook Merged Argtypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 470]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Migrate Csf 2 To 3\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 471]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Migrate Mdx To Csf\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 472]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Migrate Stories Of To Csf\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 473]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preset Full Config Object\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 474]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Auto Docs Custom Docs Container\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 475]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Auto Docs Custom Mdx Template\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 476]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Auto Docs Custom Template Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 477]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Auto Docs Override Mdx Container\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 478]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Auto Docs Override Theme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 479]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Body Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 480]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Body Font Size\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 481]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Compodoc Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 482]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Configure Globaltypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 483]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Canvas\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 484]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Code Renderer\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 485]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Elements Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 486]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Metadata\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 487]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Params\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 488]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Custom Toc\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 489]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Doc Blocks Controls Exclude Prop\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 490]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Docs Dark Theme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 491]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Empty Sort Object\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 492]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Enable Toc\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 493]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Expanded Controls\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 494]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Extended Theme Variables\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 495]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Global Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 496]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Global Loader\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 497]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Global Parameters\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 498]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Head Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 499]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Head Import Global Styles\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 500]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Import Global Styles\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 501]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Layout Param\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 502]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Locales Globaltype\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 503]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Matching Argtypes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 504]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Optout Inline\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 505]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Parameters Color Swatches\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 506]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Prepareforinline\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 507]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Register Language Globally\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 508]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Sort Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 509]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview Use Global Type\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 510]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview With Library Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 511]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview With Ordered Pages And Wildcard\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 512]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview With Ordered Pages\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 513]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Preview With Styled Components Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 514]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Read Environment Variables\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 515]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Remove Command\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 516]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Run Dev\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 517]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Server Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 518]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Server Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 519]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Start Dev Server\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 520]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Story Layout Param\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 521]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Storyloading With Directory\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 522]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Storysource Manager Entries\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 523]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Telemetry Crash Report Event\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 524]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Telemetry Main Enable Crash Reports\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 525]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Telemetry Preview Event\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 526]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Telemetry Storybook Enable Crash Reports Env\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 527]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Telemetry Storybook Enable Crash Reports Flag\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 528]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Test Fn Mock Spy\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 529]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Test Mock File Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 530]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Test Mock Return Value\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 531]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Test With Storyname\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 532]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Theme Example Variables\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 533]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Theming Styled Import\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 534]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Upgrade Prerelease\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 535]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Upgrade To Prior Major\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 536]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Upgrade\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 537]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder Aliasing\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 538]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 539]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder Jest Mock\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 540]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder React Docgen\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 541]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder Register\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 542]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook Vite Builder Ts Configure\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 543]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Subpath Imports Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 544]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Csf Addon Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 545]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Csf Addon Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 546]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Csf Addon Tags\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 547]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Csf Story Custom Children\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 548]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Csf Story Migration\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 549]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 550]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Vite Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 551]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Svelte Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 552]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Sveltekit Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 553]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Sveltekit Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 554]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Sveltekit Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 555]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Autodocs In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 556]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Autodocs In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 557]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Autodocs Remove Component\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 558]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Autodocs Remove Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 559]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Combo Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 560]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Docs Only In Meta\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 561]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags In Meta And Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 562]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags In Preview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 563]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Tags Remove In Story\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 564]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner A11Y Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 565]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner A11Y Configure\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 566]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner A11Y Disable\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 567]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Auth\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 568]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Axe Playwright\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 569]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Config Serializer\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 570]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Config Snapshot Resolver\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 571]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Coverage\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 572]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Custom Page Viewport\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 573]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Custom Snapshot Resolver\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 574]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Custom Snapshot Serializer\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 575]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Dom Snapshot Testing\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 576]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Eject Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 577]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Execute With Flags\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 578]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Execute With Url\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 579]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Execute\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 580]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Helper Function\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 581]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Hooks Example\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 582]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Image Snapshot Testing\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 583]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 584]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Local Build Workflow\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 585]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner No Index Json\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 586]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Snapshot Resolver Custom Directory\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 587]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Tags Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 588]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Tags Exclude\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 589]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Tags Include\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 590]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Tags Skip\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 591]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner Waitpageready\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 592]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner With Deploy Event Workflow\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 593]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Test Runner With Index Json\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 594]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Typed Csf File\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 595]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Upgrade Command Specific Version\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 596]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vitest Plugin Install Coverage Support Packages\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 597]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vitest Plugin Run Tests\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 598]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vitest Plugin Run With Coverage\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 599]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vitest Plugin Vitest Config\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 600]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vitest Plugin Vitest Workspace\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 601]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vue Vite Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 602]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vue3 Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 603]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Vue3 Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 604]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Web Components Vite Add Framework\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 605]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Web Components Vite Framework Options\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 606]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Web Components Vite Install\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 607]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Webpack Final To Vite Final\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 608]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Your Component With Decorator With Props\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 609]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Your Component With Decorator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 610]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Your Component\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 611]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Your Theme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 612]\", \"content\": {\"root\": \"<detail_content>\"}}]}, {\"title\": \"Addons\", \"description\": \"Documentation section: addons\", \"path\": \"[\\\"subpages\\\", 3]\", \"subpages\": [{\"title\": \"Addon knowledge base\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\", \"content\": {\"Disable the addon panel\": \"<detail_content>\", \"Style your addon\": \"<detail_content>\", \"Storybook components\": \"<detail_content>\", \"Build system\": \"<detail_content>\", \"Hot module replacement\": \"<detail_content>\", \"Standalone Storybook addons\": {\"Local Storybook addons\": \"<detail_content>\"}, \"Composing addons in presets\": \"<detail_content>\"}}, {\"title\": \"Addon migration guide for Storybook 9.0\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\", \"content\": {\"Replacing dependencies\": {\"Dependency Management\": \"<detail_content>\"}, \"Key changes for addons\": {\"Package Consolidation\": \"<detail_content>\", \"Icon System Updates\": \"<detail_content>\", \"Manager Builder Changes\": \"<detail_content>\", \"Node.js 18 support dropped\": \"<detail_content>\", \"TypeScript Requirements\": \"<detail_content>\", \"Sidebar Component Changes\": \"<detail_content>\", \"Type System Updates\": \"<detail_content>\"}, \"9.0.0 Full migration guide\": \"<detail_content>\", \"Migration Example\": \"<detail_content>\", \"Releasing\": \"<detail_content>\", \"Support\": \"<detail_content>\"}}, {\"title\": \"Types of addons\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\", \"content\": {\"UI-based addons\": {\"Panels\": \"<detail_content>\", \"Toolbars\": \"<detail_content>\", \"Tabs\": \"<detail_content>\"}, \"Preset addons\": \"<detail_content>\"}}, {\"title\": \"Addon API\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\", \"content\": {\"Core Addon API\": {\"addons.add()\": \"<detail_content>\", \"addons.register()\": \"<detail_content>\", \"addons.getChannel()\": \"<detail_content>\", \"makeDecorator\": \"<detail_content>\"}, \"Storybook API\": {\"api.selectStory()\": \"<detail_content>\", \"api.selectInCurrentKind()\": \"<detail_content>\", \"api.setQueryParams()\": \"<detail_content>\", \"api.getQueryParam()\": \"<detail_content>\", \"api.getUrlState(overrideParams)\": \"<detail_content>\", \"api.on(eventName, fn)\": \"<detail_content>\", \"addons.setConfig(config)\": \"<detail_content>\"}, \"Storybook hooks\": {\"useStorybookState\": \"<detail_content>\", \"useStorybookApi\": \"<detail_content>\", \"useChannel\": \"<detail_content>\", \"useAddonState\": \"<detail_content>\", \"useParameter\": \"<detail_content>\", \"useGlobals\": \"<detail_content>\", \"useArgs\": \"<detail_content>\"}}}, {\"title\": \"Configure and communicate with an addon\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\", \"content\": {\"Preset\": \"<detail_content>\", \"Parameters\": \"<detail_content>\", \"Channels\": \"<detail_content>\"}}, {\"title\": \"Introduction to addons\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\", \"content\": {\"Storybook basics\": \"<detail_content>\", \"Anatomy of an addon\": {\"UI-based addons\": \"<detail_content>\", \"Preset addons\": \"<detail_content>\"}}}, {\"title\": \"Install addons\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\", \"content\": {\"Automatic installation\": {\"Manual installation\": \"<detail_content>\", \"Removing addons\": \"<detail_content>\"}}}, {\"title\": \"Add to the integration catalog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\", \"content\": {\"Addons\": {\"Addon metadata\": {\"How long does it take for my addon to show up in the catalog?\": \"<detail_content>\"}}, \"Recipes\": {\"Who owns them?\": \"<detail_content>\", \"Request a recipe\": \"<detail_content>\"}}}, {\"title\": \"Write an addon\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\", \"content\": {\"What are we going to build?\": \"<detail_content>\", \"Addon anatomy\": {\"UI-based addons\": \"<detail_content>\"}, \"Setup\": {\"Understanding the build system\": \"<detail_content>\"}, \"Register the addon\": {\"Conditionally render the addon\": \"<detail_content>\", \"Style the addon\": \"<detail_content>\"}, \"Packaging and publishing\": {\"Module Metadata\": \"<detail_content>\", \"Integration Catalog Metadata\": \"<detail_content>\", \"Publishing to NPM\": \"<detail_content>\", \"CI automation\": \"<detail_content>\"}}}, {\"title\": \"Write a preset addon\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\", \"content\": {\"How presets work\": {\"Local presets\": \"<detail_content>\", \"Root-level presets\": \"<detail_content>\"}, \"Presets API\": {\"Babel\": \"<detail_content>\", \"Builders\": {\"Vite\": \"<detail_content>\", \"Webpack\": \"<detail_content>\"}, \"ManagerEntries\": \"<detail_content>\", \"PreviewAnnotations\": \"<detail_content>\"}, \"Advanced configuration\": {\"Addons\": \"<detail_content>\", \"Entries\": \"<detail_content>\", \"UI configuration\": \"<detail_content>\"}, \"Troubleshooting\": {\"Storybook doesn't load files in my preset\": \"<detail_content>\"}}}]}, {\"title\": \"Api\", \"description\": \"Documentation section: api\", \"path\": \"[\\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"ArgTypes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"Automatic argType inference\": \"<detail_content>\", \"Manually specifying argTypes\": \"<detail_content>\", \"`argTypes`\": {\"`control`\": {\"`control.type`\": \"<detail_content>\", \"`control.accept`\": \"<detail_content>\", \"`control.labels`\": \"<detail_content>\", \"`control.max`\": \"<detail_content>\", \"`control.min`\": \"<detail_content>\", \"`control.presetColors`\": \"<detail_content>\", \"`control.step`\": \"<detail_content>\"}, \"`description`\": \"<detail_content>\", \"`if`\": \"<detail_content>\", \"`mapping`\": \"<detail_content>\", \"`name`\": \"<detail_content>\", \"`options`\": \"<detail_content>\", \"`table`\": {\"`table.category`\": \"<detail_content>\", \"`table.defaultValue`\": \"<detail_content>\", \"`table.disable`\": \"<detail_content>\", \"`table.readonly`\": \"<detail_content>\", \"`table.subcategory`\": \"<detail_content>\", \"`table.type`\": \"<detail_content>\"}, \"`type`\": \"<detail_content>\", \"`defaultValue`\": \"<detail_content>\"}}}, {\"title\": \"CLI options\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\", \"content\": {\"CLI commands\": {\"`dev`\": \"<detail_content>\", \"`build`\": \"<detail_content>\", \"`init`\": \"<detail_content>\", \"`add`\": \"<detail_content>\", \"`remove`\": \"<detail_content>\", \"`upgrade`\": \"<detail_content>\", \"`migrate`\": \"<detail_content>\", \"`automigrate`\": \"<detail_content>\", \"`doctor`\": \"<detail_content>\", \"`info`\": \"<detail_content>\", \"`index`\": \"<detail_content>\", \"`sandbox`\": \"<detail_content>\"}, \"`create-storybook`\": \"<detail_content>\"}}, {\"title\": \"API references\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Stories\": \"<detail_content>\", \"Docs\": \"<detail_content>\"}}, {\"title\": \"Frameworks\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 3]\", \"content\": {\"Scaffolding a new framework\": \"<detail_content>\", \"Framework architecture\": \"<detail_content>\", \"Configuring the server\": {\"Package structure\": \"<detail_content>\", \"Server options\": \"<detail_content>\"}, \"Configuring the client\": {\"Renderable objects\": \"<detail_content>\", \"Render function\": \"<detail_content>\", \"Package structure\": \"<detail_content>\"}}}, {\"title\": \"Parameters\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 4]\", \"content\": {\"Story parameters\": \"<detail_content>\", \"Meta parameters\": \"<detail_content>\", \"Project parameters\": \"<detail_content>\", \"Available parameters\": {\"`layout`\": \"<detail_content>\", \"`options`\": {\"`options.storySort`\": \"<detail_content>\"}, \"`test`\": {\"`clearMocks`\": \"<detail_content>\", \"`mockReset`\": \"<detail_content>\", \"`restoreMocks`\": \"<detail_content>\", \"`dangerouslyIgnoreUnhandledErrors`\": \"<detail_content>\"}, \"Essentials\": \"<detail_content>\"}, \"Parameter inheritance\": \"<detail_content>\"}}, {\"title\": \"Csf\", \"description\": \"Documentation section: csf\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"Component Story Format (CSF)\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Component Story Format (CSF)\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"Default export\": \"<detail_content>\", \"Named story exports\": \"<detail_content>\", \"Args story inputs\": \"<detail_content>\", \"Play function\": \"<detail_content>\", \"Custom render functions\": \"<detail_content>\", \"Storybook export vs. name handling\": \"<detail_content>\", \"Non-story exports\": \"<detail_content>\", \"Upgrading from CSF 2 to CSF 3\": {\"Spreadable story objects\": \"<detail_content>\", \"Default render functions\": \"<detail_content>\", \"Generate titles automatically\": \"<detail_content>\"}}}]}, {\"title\": \"Doc Blocks\", \"description\": \"Documentation section: doc-blocks\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6]\", \"subpages\": [{\"title\": \"ArgTypes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 0]\", \"content\": {\"ArgTypes\": {\"`exclude`\": \"<detail_content>\", \"`include`\": \"<detail_content>\", \"`of`\": \"<detail_content>\", \"`sort`\": \"<detail_content>\"}}}, {\"title\": \"Canvas\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 1]\", \"content\": {\"Canvas\": {\"`additionalActions`\": \"<detail_content>\", \"`className`\": \"<detail_content>\", \"`layout`\": \"<detail_content>\", \"`meta`\": \"<detail_content>\", \"`of`\": \"<detail_content>\", \"`source`\": \"<detail_content>\", \"`sourceState`\": \"<detail_content>\", \"`story`\": \"<detail_content>\", \"`withToolbar`\": \"<detail_content>\"}}}, {\"title\": \"ColorPalette\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 2]\", \"content\": {\"ColorPalette\": {\"`children`\": \"<detail_content>\"}, \"ColorItem\": {\"`colors`\": \"<detail_content>\", \"`subtitle`\": \"<detail_content>\", \"`title`\": \"<detail_content>\"}}}, {\"title\": \"Controls\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 3]\", \"content\": {\"Controls\": {\"`exclude`\": \"<detail_content>\", \"`include`\": \"<detail_content>\", \"`of`\": \"<detail_content>\", \"`sort`\": \"<detail_content>\"}}}, {\"title\": \"Description\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 4]\", \"content\": {\"Description\": {\"`of`\": \"<detail_content>\"}, \"Writing descriptions\": \"<detail_content>\"}}, {\"title\": \"IconGallery\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 5]\", \"content\": {\"Documenting icons\": {\"Automate icon documentation\": \"<detail_content>\"}, \"IconGallery\": {\"`children`\": \"<detail_content>\"}, \"IconItem\": {\"`name`\": \"<detail_content>\", \"`children`\": \"<detail_content>\"}}}, {\"title\": \"Markdown\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 6]\", \"content\": {\"Markdown\": {\"`children`\": \"<detail_content>\", \"`options`\": \"<detail_content>\"}, \"Why not import markdown directly?\": \"<detail_content>\"}}, {\"title\": \"Meta\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 7]\", \"content\": {\"Meta\": {\"`isTemplate`\": \"<detail_content>\", \"`name`\": \"<detail_content>\", \"`of`\": \"<detail_content>\", \"`title`\": \"<detail_content>\"}, \"Attached vs. unattached\": \"<detail_content>\"}}, {\"title\": \"Primary\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 8]\", \"content\": {\"Primary\": {\"`of`\": \"<detail_content>\"}}}, {\"title\": \"Source\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 9]\", \"content\": {\"Source\": {\"`code`\": \"<detail_content>\", \"`dark`\": \"<detail_content>\", \"`excludeDecorators`\": \"<detail_content>\", \"`language`\": \"<detail_content>\", \"`of`\": \"<detail_content>\", \"`transform`\": \"<detail_content>\", \"`type`\": \"<detail_content>\"}}}, {\"title\": \"Stories\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 10]\", \"content\": {\"Stories\": {\"`includePrimary`\": \"<detail_content>\", \"`title`\": \"<detail_content>\"}}}, {\"title\": \"Story\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 11]\", \"content\": {\"Story\": {\"`autoplay`\": \"<detail_content>\", \"`height`\": \"<detail_content>\", \"`inline`\": \"<detail_content>\", \"`meta`\": \"<detail_content>\", \"`of`\": \"<detail_content>\"}}}, {\"title\": \"Subtitle\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 12]\", \"content\": {\"Subtitle\": {\"`children`\": \"<detail_content>\", \"`of`\": \"<detail_content>\"}}}, {\"title\": \"Title\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 13]\", \"content\": {\"Title\": {\"`children`\": \"<detail_content>\", \"`of`\": \"<detail_content>\"}}}, {\"title\": \"Typeset\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 14]\", \"content\": {\"Typeset\": {\"`fontFamily`\": \"<detail_content>\", \"`fontSizes`\": \"<detail_content>\", \"`fontWeight`\": \"<detail_content>\", \"`sampleText`\": \"<detail_content>\"}}}, {\"title\": \"Unstyled\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 15]\", \"content\": {\"Unstyled\": {\"`children`\": \"<detail_content>\"}}}, {\"title\": \"useOf\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 16]\", \"content\": {\"useOf\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`moduleExportOrType`\": \"<detail_content>\", \"`validTypes`\": \"<detail_content>\"}, \"Return\": {\"`EnhancedResolvedModuleExportType['type'] === 'story'`\": \"<detail_content>\", \"`EnhancedResolvedModuleExportType['type'] === 'meta'`\": \"<detail_content>\", \"`EnhancedResolvedModuleExportType['type'] === 'component'`\": \"<detail_content>\"}}}}, {\"title\": \"Doc Blocks\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 17]\", \"content\": {\"root\": []}}]}, {\"title\": \"Main Config\", \"description\": \"Documentation section: main-config\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"main.js|ts configuration\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"root\": []}}, {\"title\": \"addons\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"babelDefault\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"`Babel.Config`\": \"<detail_content>\", \"`Options`\": \"<detail_content>\"}}, {\"title\": \"babel\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"`Babel.Config`\": \"<detail_content>\", \"`Options`\": \"<detail_content>\"}}, {\"title\": \"build\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"`test`\": {\"`test.disableBlocks`\": \"<detail_content>\", \"`test.disabledAddons`\": \"<detail_content>\", \"`test.disableMDXEntries`\": \"<detail_content>\", \"`test.disableAutoDocs`\": \"<detail_content>\", \"`test.disableDocgen`\": \"<detail_content>\", \"`test.disableSourcemaps`\": \"<detail_content>\", \"`test.disableTreeShaking`\": \"<detail_content>\"}}}, {\"title\": \"core\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"content\": {\"`builder`\": \"<detail_content>\", \"`channelOptions`\": {\"`channelOptions.maxDepth`\": \"<detail_content>\"}, \"`crossOriginIsolated`\": \"<detail_content>\", \"`disableProjectJson`\": \"<detail_content>\", \"`disableTelemetry`\": \"<detail_content>\", \"`disableWebpackDefaults`\": \"<detail_content>\", \"`disableWhatsNewNotifications`\": \"<detail_content>\", \"`enableCrashReports`\": \"<detail_content>\", \"`renderer`\": \"<detail_content>\"}}, {\"title\": \"docs\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\", \"content\": {\"`autodocs`\": \"<detail_content>\", \"`defaultName`\": \"<detail_content>\", \"`docsMode`\": \"<detail_content>\"}}, {\"title\": \"env\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"features\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\", \"content\": {\"`actions`\": \"<detail_content>\", \"`angularFilterNonInputControls`\": \"<detail_content>\", \"`argTypeTargetsV7`\": \"<detail_content>\", \"`backgrounds`\": \"<detail_content>\", \"`controls`\": \"<detail_content>\", \"`developmentModeForBuild`\": \"<detail_content>\", \"`highlight`\": \"<detail_content>\", \"`interactions`\": \"<detail_content>\", \"`legacyDecoratorFileOrder`\": \"<detail_content>\", \"`measure`\": \"<detail_content>\", \"`outline`\": \"<detail_content>\", \"`toolbars`\": \"<detail_content>\", \"`viewport`\": \"<detail_content>\"}}, {\"title\": \"framework\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\", \"content\": {\"`name`\": \"<detail_content>\", \"`options`\": {\"`options.builder`\": \"<detail_content>\"}}}, {\"title\": \"indexers\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\", \"content\": {\"`Indexer`\": {\"`test`\": \"<detail_content>\", \"`createIndex`\": {\"`fileName`\": \"<detail_content>\", \"`IndexerOptions`\": {\"`makeTitle`\": \"<detail_content>\"}, \"`IndexInput`\": {\"`exportName`\": \"<detail_content>\", \"`importPath`\": \"<detail_content>\", \"`type`\": \"<detail_content>\", \"`rawComponentPath`\": \"<detail_content>\", \"`metaId`\": \"<detail_content>\", \"`name`\": \"<detail_content>\", \"`tags`\": \"<detail_content>\", \"`title`\": \"<detail_content>\", \"`__id`\": \"<detail_content>\"}}}, \"Transpiling to CSF\": {\"Examples\": \"<detail_content>\"}}}, {\"title\": \"logLevel\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 11]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"managerHead\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 12]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"previewAnnotations\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 13]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"previewBody\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 14]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"previewHead\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 15]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"refs\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 16]\", \"content\": {\"Using a function\": \"<detail_content>\", \"Disable a ref\": \"<detail_content>\"}}, {\"title\": \"staticDirs\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 17]\", \"content\": {\"With configuration objects\": \"<detail_content>\"}}, {\"title\": \"stories\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 18]\", \"content\": {\"With an array of globs\": \"<detail_content>\", \"With a configuration object\": {\"`StoriesSpecifier`\": {\"`StoriesSpecifier.directory`\": \"<detail_content>\", \"`StoriesSpecifier.files`\": \"<detail_content>\", \"`StoriesSpecifier.titlePrefix`\": \"<detail_content>\"}}, \"With a custom implementation\": \"<detail_content>\"}}, {\"title\": \"swc\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 19]\", \"content\": {\"`SWC.Options`\": \"<detail_content>\", \"Options\": \"<detail_content>\"}}, {\"title\": \"typescript\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 20]\", \"content\": {\"`check`\": \"<detail_content>\", \"`checkOptions`\": \"<detail_content>\", \"`reactDocgen`\": \"<detail_content>\", \"`reactDocgenTypescriptOptions`\": \"<detail_content>\", \"`skipCompiler`\": \"<detail_content>\"}}, {\"title\": \"viteFinal\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 21]\", \"content\": {\"`Options`\": \"<detail_content>\"}}, {\"title\": \"webpackFinal\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 22]\", \"content\": {\"`Options`\": \"<detail_content>\"}}, {\"title\": \"Main configuration\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 23]\", \"content\": {\"The main configuration file: `main.js` or `main.ts`\": \"<detail_content>\", \"config\": \"<detail_content>\"}}]}, {\"title\": \"Portable Stories\", \"description\": \"Documentation section: portable-stories\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8]\", \"subpages\": [{\"title\": \"Portable Stories\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\", \"content\": {\"root\": []}}, {\"title\": \"Portable stories in Jest\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\", \"content\": {\"composeStories\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`csfExports`\": \"<detail_content>\", \"`projectAnnotations`\": \"<detail_content>\"}, \"Return\": \"<detail_content>\"}, \"composeStory\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`story`\": \"<detail_content>\", \"`componentAnnotations`\": \"<detail_content>\", \"`projectAnnotations`\": \"<detail_content>\", \"`exportsName`\": \"<detail_content>\"}, \"Return\": \"<detail_content>\"}, \"setProjectAnnotations\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`projectAnnotations`\": \"<detail_content>\"}}, \"Annotations\": \"<detail_content>\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"<detail_content>\", \"2. Compose\": \"<detail_content>\", \"3. Run\": \"<detail_content>\"}, \"Overriding globals\": \"<detail_content>\"}}, {\"title\": \"Portable stories in Playwright CT\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\", \"content\": {\"createTest\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`baseTest`\": \"<detail_content>\"}, \"Return\": \"<detail_content>\"}, \"setProjectAnnotations\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`projectAnnotations`\": \"<detail_content>\"}}, \"Annotations\": \"<detail_content>\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"<detail_content>\", \"2. Prepare, load, render, and play\": \"<detail_content>\"}, \"Overriding globals\": \"<detail_content>\"}}, {\"title\": \"Portable stories in Vitest\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\", \"content\": {\"composeStories\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`csfExports`\": \"<detail_content>\", \"`projectAnnotations`\": \"<detail_content>\"}, \"Return\": \"<detail_content>\"}, \"composeStory\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`story`\": \"<detail_content>\", \"`componentAnnotations`\": \"<detail_content>\", \"`projectAnnotations`\": \"<detail_content>\", \"`exportsName`\": \"<detail_content>\"}, \"Return\": \"<detail_content>\"}, \"setProjectAnnotations\": {\"Type\": \"<detail_content>\", \"Parameters\": {\"`projectAnnotations`\": \"<detail_content>\"}}, \"Annotations\": \"<detail_content>\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"<detail_content>\", \"2. Compose\": \"<detail_content>\", \"3. Run\": \"<detail_content>\"}, \"Overriding globals\": \"<detail_content>\"}}]}]}, {\"title\": \"Builders\", \"description\": \"Documentation section: builders\", \"path\": \"[\\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"Builder API\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"How do builders work?\": \"<detail_content>\", \"Builder API\": \"<detail_content>\", \"Implementation\": {\"Import stories\": \"<detail_content>\", \"Provide configuration options\": \"<detail_content>\", \"Handle preview.js exports\": \"<detail_content>\", \"MDX support\": \"<detail_content>\", \"Generate source code snippets\": \"<detail_content>\", \"Generate a static build\": \"<detail_content>\", \"Development server integration\": \"<detail_content>\", \"Shutdown the development server\": \"<detail_content>\", \"HMR support\": \"<detail_content>\", \"More information\": \"<detail_content>\"}}}, {\"title\": \"Builders\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"CLI basics\": \"<detail_content>\", \"Manual setup\": \"<detail_content>\"}}, {\"title\": \"Vite\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"content\": {\"Setup\": \"<detail_content>\", \"Configuration\": {\"Environment-based configuration\": \"<detail_content>\", \"Override the default configuration\": \"<detail_content>\", \"TypeScript\": \"<detail_content>\"}, \"Troubleshooting\": {\"Migrating from Webpack\": \"<detail_content>\", \"Working directory not being detected\": \"<detail_content>\", \"ArgTypes are not generated automatically\": \"<detail_content>\", \"Interaction tests not working as expected\": \"<detail_content>\"}}}, {\"title\": \"Webpack\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 3]\", \"content\": {\"Configure\": {\"Override the default configuration\": {\"Working with Webpack plugins\": \"<detail_content>\"}, \"Import a custom Webpack configuration\": \"<detail_content>\", \"Debug Webpack configuration\": \"<detail_content>\"}, \"Compiler support\": {\"SWC\": \"<detail_content>\", \"Babel\": \"<detail_content>\"}, \"Troubleshooting\": {\"TypeScript modules are not resolved within Storybook\": \"<detail_content>\", \"Pre-bundled assets do not show in the Storybook UI\": \"<detail_content>\", \"Storybook doesn't run with Webpack 4\": \"<detail_content>\"}}}]}, {\"title\": \"Configure\", \"description\": \"Documentation section: configure\", \"path\": \"[\\\"subpages\\\", 6]\", \"subpages\": [{\"title\": \"Environment variables\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\", \"content\": {\"Using .env files\": {\"With Vite\": \"<detail_content>\"}, \"Using Storybook configuration\": \"<detail_content>\", \"Using environment variables to choose the browser\": \"<detail_content>\", \"Troubleshooting\": {\"Environment variables are not working\": \"<detail_content>\"}}}, {\"title\": \"Configure Storybook\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\", \"content\": {\"Configure your Storybook project\": \"<detail_content>\", \"Configure story loading\": {\"With a configuration object\": \"<detail_content>\", \"With a directory\": \"<detail_content>\", \"With a custom implementation\": {\"Known limitations\": \"<detail_content>\"}}, \"Configure story rendering\": \"<detail_content>\", \"Configure Storybook\\u2019s UI\": \"<detail_content>\"}}, {\"title\": \"Story layout\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\", \"content\": {\"Global layout\": \"<detail_content>\", \"Component layout\": \"<detail_content>\", \"Story layout\": \"<detail_content>\"}}, {\"title\": \"Story rendering\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\", \"content\": {\"Running code for every story\": \"<detail_content>\", \"Adding to \\\\<head>\": \"<detail_content>\", \"Adding to \\\\<body>\": \"<detail_content>\"}}, {\"title\": \"Styling and CSS\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\", \"content\": {\"CSS\": {\"Import bundled CSS (Recommended)\": \"<detail_content>\", \"Include static CSS\": \"<detail_content>\"}, \"CSS modules\": {\"Vite\": \"<detail_content>\", \"Webpack\": \"<detail_content>\"}, \"PostCSS\": {\"Vite\": \"<detail_content>\", \"Webpack\": \"<detail_content>\"}, \"CSS pre-processors\": {\"Vite\": \"<detail_content>\", \"Webpack\": \"<detail_content>\"}, \"CSS-in-JS\": \"<detail_content>\", \"Adding webfonts\": {\"`.storybook/preview-head.html`\": \"<detail_content>\", \"`.storybook/preview.ts`\": \"<detail_content>\"}, \"Global styles\": \"<detail_content>\", \"Troubleshooting\": \"<detail_content>\"}}, {\"title\": \"Telemetry\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 5]\", \"content\": {\"Why is telemetry collected?\": \"<detail_content>\", \"What is being collected?\": \"<detail_content>\", \"What about sensitive information?\": \"<detail_content>\", \"Will this data be shared?\": \"<detail_content>\", \"How to opt-out\": \"<detail_content>\", \"Crash reports (disabled by default)\": \"<detail_content>\"}}, {\"title\": \"Webpack\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 6]\", \"content\": {\"Default configuration\": {\"Import images and other static files\": \"<detail_content>\", \"Import JSON as JavaScript\": \"<detail_content>\"}, \"Webpack 5\": {\"Lazy Compilation\": \"<detail_content>\", \"Filesystem Caching\": \"<detail_content>\"}, \"Extending Storybook\\u2019s webpack config\": \"<detail_content>\", \"Using your existing config\": \"<detail_content>\", \"TypeScript Module Resolution\": \"<detail_content>\"}}, {\"title\": \"Integration\", \"description\": \"Documentation section: integration\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"Compiler support\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"SWC\": \"<detail_content>\", \"Babel\": {\"Configure\": \"<detail_content>\", \"Working with Create React App\": \"<detail_content>\"}, \"Troubleshooting\": {\"The SWC compiler doesn't work with React\": \"<detail_content>\", \"Babel configuration not working\": \"<detail_content>\"}}}, {\"title\": \"ESLint plugin\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"Installation\": \"<detail_content>\", \"ESLint compatibility\": \"<detail_content>\", \"Usage\": {\"Configuration (`.eslintrc`)\": {\"Overriding/disabling rules\": \"<detail_content>\"}, \"Configuration (flat config format)\": {\"Overriding/disabling rules\": \"<detail_content>\"}, \"MDX Support\": \"<detail_content>\"}, \"Supported Rules and configurations\": \"<detail_content>\"}}, {\"title\": \"Feature support for frameworks\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"Core frameworks\": \"<detail_content>\", \"Community frameworks\": \"<detail_content>\", \"Deprecated\": \"<detail_content>\"}}, {\"title\": \"Framework support\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"How do frameworks work in Storybook?\": \"<detail_content>\", \"Which frameworks are supported?\": {\"What about feature support?\": \"<detail_content>\"}, \"Configure\": \"<detail_content>\", \"Troubleshooting\": {\"NextJS 13 doesn't work with Storybook\": \"<detail_content>\", \"My framework doesn't work with Storybook\": \"<detail_content>\", \"How do I build a Storybook framework?\": \"<detail_content>\", \"Legacy framework support\": \"<detail_content>\", \"Learn about configuring Storybook\": \"<detail_content>\"}}}, {\"title\": \"Images, fonts, and assets\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"Import assets into stories\": \"<detail_content>\", \"Serving static files via Storybook Configuration\": \"<detail_content>\", \"Reference assets from a CDN\": \"<detail_content>\", \"Absolute versus relative paths\": \"<detail_content>\", \"Referencing Fonts in Stories\": \"<detail_content>\"}}, {\"title\": \"Integration\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"content\": {\"root\": []}}, {\"title\": \"TypeScript\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\", \"content\": {\"Configure Storybook with TypeScript\": {\"Extending the default configuration\": \"<detail_content>\"}, \"Write stories with TypeScript\": {\"TypeScript 4.9 support\": \"<detail_content>\"}, \"Troubleshooting\": {\"The `satisfies` operator is not working as expected\": \"<detail_content>\", \"The TypeScript auto-completion is not working on my editor\": \"<detail_content>\", \"Storybook doesn't create the required types for external packages\": \"<detail_content>\", \"The types are not being generated for my component\": \"<detail_content>\"}}}]}, {\"title\": \"User Interface\", \"description\": \"Documentation section: user-interface\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8]\", \"subpages\": [{\"title\": \"Features and behavior\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\", \"content\": {\"Customize the UI\": {\"Override sidebar visibility\": \"<detail_content>\", \"Configure the toolbar\": \"<detail_content>\"}, \"Configuring through URL parameters\": \"<detail_content>\"}}, {\"title\": \"User Interface\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\", \"content\": {\"root\": []}}, {\"title\": \"Sidebar & URLS\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\", \"content\": {\"Roots\": \"<detail_content>\", \"Permalink to stories\": \"<detail_content>\", \"CSF 3.0 auto-titles\": {\"Auto-title filename case\": \"<detail_content>\", \"Auto-title redundant filenames\": \"<detail_content>\", \"Auto-title prefixes\": \"<detail_content>\", \"Story Indexers\": \"<detail_content>\"}}}, {\"title\": \"Storybook Addons\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\", \"content\": {\"Addon features\": \"<detail_content>\", \"Essential, core and community addons\": \"<detail_content>\"}}, {\"title\": \"Theming\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 4]\", \"content\": {\"Global theming\": \"<detail_content>\", \"Theming docs\": \"<detail_content>\", \"Create a theme quickstart\": \"<detail_content>\", \"CSS escape hatches\": \"<detail_content>\", \"MDX component overrides\": \"<detail_content>\", \"Addons and theme creation\": \"<detail_content>\", \"Using the theme for addon authors\": \"<detail_content>\"}}]}]}, {\"title\": \"Contribute\", \"description\": \"Documentation section: contribute\", \"path\": \"[\\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"RFC process\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"Goal\": {\"\\u201cFeature Request\\u201d vs. \\u201cRFC\\u201d\": \"<detail_content>\"}, \"The RFC lifecycle\": {\"1. `Status: Proposed`\": \"<detail_content>\", \"2. `Status: In review`\": \"<detail_content>\", \"3. `Status: accepted/rejected`\": \"<detail_content>\"}, \"Implementing an accepted RFC\": \"<detail_content>\"}}, {\"title\": \"Code contributions\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"Prerequisites\": \"<detail_content>\", \"Initial setup\": \"<detail_content>\", \"Run your first sandbox\": \"<detail_content>\", \"Running a different sandbox template\": \"<detail_content>\", \"Running tests\": \"<detail_content>\", \"Start developing\": \"<detail_content>\", \"Check your work\": {\"Add stories\": \"<detail_content>\", \"Add tests\": \"<detail_content>\", \"End-to-end tests (e2e)\": \"<detail_content>\"}, \"Submit a pull request\": {\"Target `next` branch\": {\"Useful resources when working with forks\": \"<detail_content>\"}, \"Reproducing job failures\": \"<detail_content>\"}, \"How to work with reproductions\": \"<detail_content>\", \"Developing a template\": {\"Running a sandbox\": \"<detail_content>\"}, \"Troubleshooting\": \"<detail_content>\"}}, {\"title\": \"Contributing a Storybook framework\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"How to make a framework\": {\"1. Decide on a package name\": \"<detail_content>\", \"2. Consider what your framework will need to do\": \"<detail_content>\", \"3. Write the documentation\": \"<detail_content>\", \"4. Author the framework itself\": {\"`package.json` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/package.json))\": \"<detail_content>\", \"`preset.js` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/preset.ts))\": \"<detail_content>\", \"`preview.js` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/preview.tsx))\": \"<detail_content>\", \"`types.ts` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/types.ts))\": \"<detail_content>\"}, \"5. Test your framework\": \"<detail_content>\", \"6. Let us know!\": \"<detail_content>\"}}}, {\"title\": \"Create a reproduction\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"Why should you create a reproduction?\": \"<detail_content>\", \"Pre-requisites\": \"<detail_content>\", \"Initial setup\": \"<detail_content>\", \"Third-party dependencies & addons\": \"<detail_content>\", \"Add stories\": \"<detail_content>\", \"Host\": \"<detail_content>\", \"Publish\": {\"Helpful resources when working with Chromatic\": \"<detail_content>\"}, \"Submit the issue\": \"<detail_content>\"}}, {\"title\": \"How to contribute\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"Contributor covenant\": \"<detail_content>\", \"Ways to contribute\": \"<detail_content>\", \"Not sure how to get started?\": \"<detail_content>\"}}, {\"title\": \"Documentation\", \"description\": \"Documentation section: documentation\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"Documentation updates\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"Find the Markdown file\": \"<detail_content>\", \"Create the pull request\": \"<detail_content>\"}}, {\"title\": \"Documentation\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"root\": []}}, {\"title\": \"Code snippets contributions\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"content\": {\"Documented frameworks\": \"<detail_content>\", \"Snippet syntax\": {\"Example\": \"<detail_content>\"}, \"Common attributes for code snippets\": {\"File name as title\": \"<detail_content>\", \"Language configuration\": \"<detail_content>\", \"Framework-specific code\": \"<detail_content>\", \"Package manager configuration\": \"<detail_content>\", \"Working with multiple snippets\": \"<detail_content>\"}, \"Contributing code snippets\": \"<detail_content>\", \"Preview your work\": \"<detail_content>\", \"Submit your contribution\": \"<detail_content>\", \"Troubleshooting\": {\"Code snippets not displaying\": \"<detail_content>\"}, \"Learn more about contributing to Storybook\": \"<detail_content>\"}}]}]}, {\"title\": \"Essentials\", \"description\": \"Documentation section: essentials\", \"path\": \"[\\\"subpages\\\", 8]\", \"subpages\": [{\"title\": \"Actions\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 0]\", \"content\": {\"Action args\": {\"Via storybook/test fn spy function\": \"<detail_content>\", \"Automatically matching args\": \"<detail_content>\"}, \"API\": {\"Parameters\": {\"`argTypesRegex`\": \"<detail_content>\", \"`disable`\": \"<detail_content>\"}, \"Exports\": {\"`action`\": \"<detail_content>\"}}}}, {\"title\": \"Backgrounds\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 1]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Defining the background for a story\": \"<detail_content>\", \"Extending the configuration\": \"<detail_content>\", \"Disable backgrounds\": \"<detail_content>\", \"Grid\": \"<detail_content>\", \"API\": {\"Globals\": {\"`grid`\": \"<detail_content>\", \"`value`\": \"<detail_content>\"}, \"Parameters\": {\"`disable`\": \"<detail_content>\", \"`grid`\": {\"`grid.cellAmount`\": \"<detail_content>\", \"`grid.cellSize`\": \"<detail_content>\", \"`grid.disable`\": \"<detail_content>\", \"`grid.offsetX`\": \"<detail_content>\", \"`grid.offsetY`\": \"<detail_content>\", \"`grid.opacity`\": \"<detail_content>\"}, \"`options`\": \"<detail_content>\"}}}}, {\"title\": \"Controls\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 2]\", \"content\": {\"Choosing the control type\": \"<detail_content>\", \"Custom control type matchers\": \"<detail_content>\", \"Fully custom args\": {\"Dealing with complex values\": \"<detail_content>\"}, \"Creating and editing stories from controls\": {\"Create a new story\": \"<detail_content>\", \"Edit a story\": \"<detail_content>\", \"Disable creating and editing of stories\": \"<detail_content>\"}, \"Configuration\": {\"Annotation\": \"<detail_content>\", \"Parameters\": {\"Show full documentation for each property\": \"<detail_content>\", \"Specify initial preset color swatches\": \"<detail_content>\", \"Filtering controls\": \"<detail_content>\", \"Sorting controls\": \"<detail_content>\"}, \"Disable controls for specific properties\": \"<detail_content>\", \"Conditional controls\": \"<detail_content>\"}, \"Troubleshooting\": {\"Controls are not automatically generated for my component\": \"<detail_content>\", \"The controls are not updating the story within the auto-generated documentation\": \"<detail_content>\"}, \"API\": {\"Parameters\": {\"`disable`\": \"<detail_content>\", \"`exclude`\": \"<detail_content>\", \"`expanded`\": \"<detail_content>\", \"`include`\": \"<detail_content>\", \"`presetColors`\": \"<detail_content>\", \"`sort`\": \"<detail_content>\", \"`disableSaveFromUI`\": \"<detail_content>\"}}}}, {\"title\": \"Highlight\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 3]\", \"content\": {\"Highlighting DOM Elements\": {\"Customize style\": \"<detail_content>\", \"Highlight menu\": \"<detail_content>\"}, \"Remove highlights\": \"<detail_content>\", \"Reset highlighted elements\": \"<detail_content>\", \"Scroll element into view\": \"<detail_content>\", \"API\": {\"Parameters\": {\"`disable`\": \"<detail_content>\"}, \"Exports\": {\"`HIGHLIGHT`\": \"<detail_content>\", \"`REMOVE_HIGHLIGHT`\": \"<detail_content>\", \"`RESET_HIGHLIGHT`\": \"<detail_content>\", \"`SCROLL_INTO_VIEW`\": \"<detail_content>\"}}}}, {\"title\": \"Essentials\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 4]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Disabling features\": \"<detail_content>\"}}, {\"title\": \"Measure & outline\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 5]\", \"content\": {\"Measure\": \"<detail_content>\", \"Outline\": \"<detail_content>\", \"API\": {\"Parameters\": {\"`disable`\": \"<detail_content>\"}}}}, {\"title\": \"Themes\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 6]\", \"content\": {\"Theme decorators\": {\"JSX providers\": \"<detail_content>\", \"CSS classes\": \"<detail_content>\", \"Data attributes\": \"<detail_content>\"}}}, {\"title\": \"Toolbars & globals\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 7]\", \"content\": {\"Globals\": \"<detail_content>\", \"Global types and the toolbar annotation\": \"<detail_content>\", \"Create a decorator\": \"<detail_content>\", \"Setting globals on a story\": \"<detail_content>\", \"Advanced usage\": \"<detail_content>\", \"Consuming globals from within a story\": \"<detail_content>\", \"Consuming globals from within an addon\": \"<detail_content>\", \"Updating globals from within an addon\": \"<detail_content>\"}}, {\"title\": \"Viewport\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 8]\", \"content\": {\"Configuration\": {\"Use a detailed set of devices\": \"<detail_content>\", \"Add new devices\": \"<detail_content>\", \"Configuring per component or story\": \"<detail_content>\"}, \"Defining the viewport for a story\": \"<detail_content>\", \"API\": {\"Keyboard shortcuts\": \"<detail_content>\", \"Globals\": {\"`value`\": \"<detail_content>\", \"`isRotated`\": \"<detail_content>\"}, \"Parameters\": {\"`disable`\": \"<detail_content>\", \"`options`\": \"<detail_content>\"}, \"Exports\": {\"`INITIAL_VIEWPORTS`\": \"<detail_content>\", \"`MINIMAL_VIEWPORTS`\": \"<detail_content>\"}}}}]}, {\"title\": \"Get Started\", \"description\": \"Documentation section: get-started\", \"path\": \"[\\\"subpages\\\", 9]\", \"subpages\": [{\"title\": \"Browse Stories\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 0]\", \"content\": {\"Sidebar and Canvas\": \"<detail_content>\", \"Toolbar\": \"<detail_content>\", \"Addons\": \"<detail_content>\", \"Use stories to build UIs\": \"<detail_content>\"}}, {\"title\": \"Conclusion\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Get started with Storybook\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 2]\", \"content\": {\"root\": []}}, {\"title\": \"Install Storybook\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 3]\", \"content\": {\"Project requirements\": \"<detail_content>\", \"Run the Setup Wizard\": \"<detail_content>\", \"Start Storybook\": \"<detail_content>\"}}, {\"title\": \"Setup Storybook\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 4]\", \"content\": {\"Render component styles\": \"<detail_content>\", \"Configure Storybook for your stack\": \"<detail_content>\", \"Load assets and resources\": \"<detail_content>\"}}, {\"title\": \"What's a story?\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 5]\", \"content\": {\"Working with stories\": {\"Create a new story\": \"<detail_content>\", \"Edit a story\": \"<detail_content>\"}}}, {\"title\": \"Why Storybook?\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 6]\", \"content\": {\"The problem\": \"<detail_content>\", \"The solution\": {\"Build UIs in isolation\": \"<detail_content>\", \"Capture UI variations as \\u201cstories\\u201d\": \"<detail_content>\", \"Storybook keeps track of every story\": \"<detail_content>\"}, \"Benefits\": \"<detail_content>\", \"Write stories once, reuse everywhere\": \"<detail_content>\"}}, {\"title\": \"Frameworks\", \"description\": \"Documentation section: frameworks\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"Storybook for Angular\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Run Storybook\": \"<detail_content>\", \"Setup Compodoc\": {\"Automatic setup\": \"<detail_content>\", \"Manual setup\": \"<detail_content>\"}, \"`applicationConfig` decorator\": \"<detail_content>\", \"`moduleMetadata` decorator\": \"<detail_content>\", \"FAQ\": {\"How do I migrate to an Angular Storybook builder?\": {\"Do you have only one Angular project in your workspace?\": \"<detail_content>\", \"I have multiple projects in my Angular workspace\": \"<detail_content>\"}, \"How do I configure Angular's builder for Storybook?\": \"<detail_content>\"}, \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\"}}}}, {\"title\": \"Frameworks\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Storybook for Next.js\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\", \"With Vite\": \"<detail_content>\"}}, \"Run the Setup Wizard\": \"<detail_content>\", \"Next.js's Image component\": {\"Local images\": \"<detail_content>\", \"Remote images\": \"<detail_content>\"}, \"Next.js font optimization\": {\"`next/font/google`\": \"<detail_content>\", \"`next/font/local`\": {\"`staticDir` mapping\": \"<detail_content>\"}, \"Not supported features of `next/font`\": \"<detail_content>\", \"Mocking fonts during testing\": \"<detail_content>\"}, \"Next.js routing\": {\"Overriding defaults\": \"<detail_content>\", \"Default router\": \"<detail_content>\"}, \"Next.js navigation\": {\"Set `nextjs.appDirectory` to `true`\": \"<detail_content>\", \"Overriding defaults\": \"<detail_content>\", \"`useSelectedLayoutSegment`, `useSelectedLayoutSegments`, and `useParams` hooks\": \"<detail_content>\", \"Default navigation context\": \"<detail_content>\"}, \"Next.js Head\": \"<detail_content>\", \"Sass/Scss\": \"<detail_content>\", \"CSS/Sass/Scss Modules\": \"<detail_content>\", \"Styled JSX\": \"<detail_content>\", \"PostCSS\": \"<detail_content>\", \"Absolute imports\": \"<detail_content>\", \"Module aliases\": \"<detail_content>\", \"Subpath imports\": \"<detail_content>\", \"Mocking modules\": {\"Built-in mocked modules\": \"<detail_content>\", \"Mocking other modules\": \"<detail_content>\"}, \"Runtime config\": \"<detail_content>\", \"Custom Webpack config\": \"<detail_content>\", \"Typescript\": \"<detail_content>\", \"React Server Components (RSC)\": \"<detail_content>\", \"Notes for Yarn v2 and v3 users\": \"<detail_content>\", \"FAQ\": {\"Stories for pages/components which fetch data\": \"<detail_content>\", \"Statically imported images won't load\": \"<detail_content>\", \"Module not found: Error: Can't resolve `package name`\": \"<detail_content>\", \"What if I'm using the Vite builder?\": \"<detail_content>\", \"Error: You are importing avif images, but you don't have sharp installed. You have to install sharp in order to use image optimization features in Next.js.\": \"<detail_content>\"}, \"API\": {\"Modules\": {\"`@storybook/nextjs/export-mocks`\": \"<detail_content>\", \"`@storybook/nextjs/cache.mock`\": \"<detail_content>\", \"`@storybook/nextjs/headers.mock`\": \"<detail_content>\", \"`@storybook/nextjs/navigation.mock`\": \"<detail_content>\", \"`@storybook/nextjs/router.mock`\": \"<detail_content>\"}, \"Options\": {\"`builder`\": \"<detail_content>\", \"`image`\": \"<detail_content>\", \"`nextConfigPath`\": \"<detail_content>\"}, \"Parameters\": {\"`appDirectory`\": \"<detail_content>\", \"`navigation`\": \"<detail_content>\", \"`router`\": \"<detail_content>\"}}}}, {\"title\": \"Storybook for Preact & Vite\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\"}}}}, {\"title\": \"Storybook for React Native Web\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook `addon-react-native-web`\": \"<detail_content>\", \"In a project with Storybook `react-native`\": \"<detail_content>\"}, \"Run the Setup Wizard\": \"<detail_content>\", \"React Native vs React Native Web\": {\"Comparison\": \"<detail_content>\"}, \"Using both React Native and React Native Web\": \"<detail_content>\", \"API\": {\"Options\": {\"Example configuration for reanimated\": \"<detail_content>\", \"Example configuration for nativewind\": \"<detail_content>\", \"Example configuration to transpile additional node_modules\": \"<detail_content>\", \"`builder`\": \"<detail_content>\"}}}}, {\"title\": \"Storybook for React & Vite\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Run the Setup Wizard\": \"<detail_content>\", \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\"}}}}, {\"title\": \"Storybook for React & Webpack\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Run the Setup Wizard\": \"<detail_content>\", \"Create React App (CRA)\": \"<detail_content>\", \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\"}}}}, {\"title\": \"Storybook for Svelte & Vite\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Writing native Svelte stories\": {\"Setup\": \"<detail_content>\", \"Configure\": \"<detail_content>\", \"Upgrade to Svelte CSF addon v5\": {\"Simplified story API\": \"<detail_content>\", \"Story templates\": \"<detail_content>\", \"Story slots to snippets\": \"<detail_content>\", \"Tags support\": \"<detail_content>\"}}, \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\", \"`docgen`\": {\"When to disable docgen\": \"<detail_content>\"}}}}}, {\"title\": \"Storybook for SvelteKit\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Supported features\": \"<detail_content>\", \"How to mock\": {\"Mocking links\": \"<detail_content>\"}, \"Writing native Svelte stories\": {\"Setup\": \"<detail_content>\", \"Configure\": \"<detail_content>\", \"Upgrade to Svelte CSF addon v5\": {\"Simplified story API\": \"<detail_content>\", \"Story templates\": \"<detail_content>\", \"Story slots to snippets\": \"<detail_content>\", \"Tags support\": \"<detail_content>\"}}, \"API\": {\"Parameters\": {\"`forms`\": {\"`forms.enhance`\": \"<detail_content>\"}, \"`hrefs`\": \"<detail_content>\", \"`navigation`\": {\"`navigation.goto`\": \"<detail_content>\", \"`navigation.pushState`\": \"<detail_content>\", \"`navigation.replaceState`\": \"<detail_content>\", \"`navigation.invalidate`\": \"<detail_content>\", \"`navigation.invalidateAll`\": \"<detail_content>\", \"`navigation.afterNavigate`\": \"<detail_content>\"}, \"`stores`\": {\"`stores.navigating`\": \"<detail_content>\", \"`stores.page`\": \"<detail_content>\", \"`stores.updated`\": \"<detail_content>\"}}, \"Options\": {\"`builder`\": \"<detail_content>\", \"`docgen`\": {\"When to disable docgen\": \"<detail_content>\"}}}, \"Troubleshooting\": {\"Error when starting Storybook\": \"<detail_content>\"}}}, {\"title\": \"Storybook for Vue & Vite\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"Extending the Vue application\": \"<detail_content>\", \"Using `vue-component-meta`\": {\"Support for multiple component types\": \"<detail_content>\", \"Prop description and JSDoc tag annotations\": \"<detail_content>\", \"Events types extraction\": \"<detail_content>\", \"Slots types extraction\": \"<detail_content>\", \"Exposed properties and methods\": \"<detail_content>\", \"Override the default configuration\": \"<detail_content>\"}, \"Troubleshooting\": {\"Storybook doesn't work with my Vue 2 project\": \"<detail_content>\"}, \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\", \"`docgen`\": {\"When to disable docgen\": \"<detail_content>\"}}}}}, {\"title\": \"Storybook for Web components & Vite\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Getting started\": {\"In a project without Storybook\": \"<detail_content>\", \"In a project with Storybook\": {\"Automatic migration\": \"<detail_content>\", \"Manual migration\": \"<detail_content>\"}}, \"API\": {\"Options\": {\"`builder`\": \"<detail_content>\"}}}}]}]}, {\"title\": \"Releases\", \"description\": \"Documentation section: releases\", \"path\": \"[\\\"subpages\\\", 10]\", \"subpages\": [{\"title\": \"Features Lifecycle\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 0]\", \"content\": {\"Experimental\": \"<detail_content>\", \"Preview\": \"<detail_content>\", \"Stable\": \"<detail_content>\", \"Deprecated\": \"<detail_content>\"}}, {\"title\": \"How we release Storybook\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 1]\", \"content\": {\"Release Channels\": \"<detail_content>\", \"Supported Versions\": \"<detail_content>\", \"Release Cycle\": \"<detail_content>\"}}, {\"title\": \"Migration guide from Storybook 7.x to 8.6\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 2]\", \"content\": {\"Major breaking changes\": \"<detail_content>\", \"Automatic upgrade\": {\"Common upgrade issues\": {\"`storyStoreV7:false` and `storiesOf`\": \"<detail_content>\", \"Missing `vite.config.js` file\": \"<detail_content>\"}}, \"New projects\": \"<detail_content>\", \"Manual migrations\": {\"`*.stories.mdx` to MDX+CSF\": {\"Known limitations\": \"<detail_content>\"}}, \"Troubleshooting\": \"<detail_content>\", \"Package structure changes\": \"<detail_content>\", \"Optional migrations\": {\"CSF 2 to CSF 3\": \"<detail_content>\"}}}, {\"title\": \"Migration guide for Storybook 9\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 3]\", \"content\": {\"Major breaking changes\": \"<detail_content>\", \"Automatic upgrade\": \"<detail_content>\", \"New projects\": \"<detail_content>\", \"Troubleshooting\": \"<detail_content>\", \"Package structure changes\": \"<detail_content>\", \"Optional migrations\": {\"`test-runner` to `addon-vitest`\": \"<detail_content>\", \"CSF 2 to CSF 3\": \"<detail_content>\"}}}, {\"title\": \"Roadmap\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 4]\", \"content\": {\"What's in the roadmap?\": {\"Candidates\": \"<detail_content>\", \"Under consideration\": \"<detail_content>\", \"In progress\": \"<detail_content>\", \"Done\": \"<detail_content>\"}, \"Frequently asked questions\": {\"When will project X be available?\": \"<detail_content>\", \"What about issue Y or discussion Z?\": \"<detail_content>\", \"How do I get something onto the board?\": \"<detail_content>\"}}}, {\"title\": \"Upgrading Storybook\", \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 5]\", \"content\": {\"Upgrade script\": {\"Mono-repository support\": {\"Limiting scope in large mono-repositories\": \"<detail_content>\"}}, \"Upgrade process\": {\"Automatic health check\": \"<detail_content>\", \"Error handling and debugging\": \"<detail_content>\"}, \"Command-line options\": {\"Available flags\": \"<detail_content>\", \"Example usage\": \"<detail_content>\"}, \"Automigrate script\": \"<detail_content>\", \"Prereleases\": \"<detail_content>\", \"Troubleshooting\": {\"Storybook doesn't detect my Storybook project\": \"<detail_content>\", \"Storybook doesn't automigrate non-Storybook files\": \"<detail_content>\", \"Storybook doesn't upgrade to the latest version when using Vue 2\": \"<detail_content>\"}}}]}, {\"title\": \"Sharing\", \"description\": \"Documentation section: sharing\", \"path\": \"[\\\"subpages\\\", 11]\", \"subpages\": [{\"title\": \"Design integrations\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 0]\", \"content\": {\"Figma\": {\"Embed Storybook in Figma with the plugin\": {\"Install plugin\": \"<detail_content>\", \"Link stories to Figma components\": \"<detail_content>\", \"View stories in Figma\": \"<detail_content>\"}, \"Embed Figma in Storybook with the addon\": {\"Install design addon\": \"<detail_content>\", \"Link Figma components to stories\": \"<detail_content>\", \"View designs in Storybook\": \"<detail_content>\"}}, \"Zeplin\": \"<detail_content>\", \"Zeroheight\": \"<detail_content>\", \"UXPin\": \"<detail_content>\", \"InVision Design System Manager\": \"<detail_content>\", \"Adobe XD\": \"<detail_content>\", \"Build your own integration\": \"<detail_content>\"}}, {\"title\": \"Embed stories\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 1]\", \"content\": {\"Embed a story with the toolbar\": \"<detail_content>\", \"Embed a story without the toolbar\": \"<detail_content>\", \"Embed documentation\": \"<detail_content>\", \"Embed stories on other platforms\": \"<detail_content>\"}}, {\"title\": \"Sharing\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 2]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Package Composition\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 3]\", \"content\": {\"For consumers\": {\"Set up\": \"<detail_content>\", \"Switching versions\": \"<detail_content>\"}, \"For authors\": {\"Automatic version selection\": \"<detail_content>\", \"Show a version selector\": \"<detail_content>\"}}}, {\"title\": \"Publish Storybook\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 4]\", \"content\": {\"Build Storybook as a static web application\": {\"Customizing the build for performance\": \"<detail_content>\", \"Build Storybook for older browsers\": \"<detail_content>\"}, \"Publish Storybook with Chromatic\": {\"Setup CI to publish automatically\": \"<detail_content>\", \"Review with your team\": \"<detail_content>\", \"Versioning and history\": \"<detail_content>\"}, \"Publish Storybook to other services\": {\"GitHub Pages\": \"<detail_content>\", \"CPP level 1\": \"<detail_content>\", \"CPP level 0\": \"<detail_content>\"}, \"Search engine optimization (SEO)\": {\"Description\": \"<detail_content>\", \"Preventing your Storybook from being crawled\": \"<detail_content>\"}}}, {\"title\": \"Storybook Composition\", \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 5]\", \"content\": {\"Compose published Storybooks\": \"<detail_content>\", \"Compose local Storybooks\": \"<detail_content>\", \"Compose Storybooks per environment\": \"<detail_content>\", \"Troubleshooting\": {\"Storybook composition is not working with my project\": \"<detail_content>\"}}}]}, {\"title\": \"Writing Docs\", \"description\": \"Documentation section: writing-docs\", \"path\": \"[\\\"subpages\\\", 12]\", \"subpages\": [{\"title\": \"Automatic documentation and Storybook\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 0]\", \"content\": {\"Set up automated documentation\": {\"Configure\": \"<detail_content>\", \"Write a custom template\": {\"With MDX\": \"<detail_content>\"}, \"Generate a table of contents\": \"<detail_content>\", \"Configure the table of contents\": {\"Component-level configuration\": \"<detail_content>\"}, \"Customize component documentation\": \"<detail_content>\"}, \"Advanced configuration\": {\"Documenting multiple components\": \"<detail_content>\", \"Customize the Docs Container\": \"<detail_content>\", \"Override the default theme\": \"<detail_content>\", \"Working with custom MDX components\": \"<detail_content>\", \"Addon options\": \"<detail_content>\"}, \"Troubleshooting\": {\"The table of contents doesn't render as expected\": {\"With simple documentation pages\": \"<detail_content>\", \"With small screens\": \"<detail_content>\", \"With MDX\": \"<detail_content>\"}, \"The auto-generated documentation is not showing up in a monorepo setup\": \"<detail_content>\", \"The controls are not updating the story within the auto-generated documentation\": \"<detail_content>\"}}}, {\"title\": \"Preview and build docs\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 1]\", \"content\": {\"Preview Storybook's documentation\": \"<detail_content>\", \"Publish Storybook's documentation\": \"<detail_content>\"}}, {\"title\": \"Code panel\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 2]\", \"content\": {\"Usage\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"Doc blocks\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 3]\", \"content\": {\"Within MDX\": \"<detail_content>\", \"Customizing the automatic docs page\": \"<detail_content>\", \"Customizing doc blocks\": \"<detail_content>\", \"Available blocks\": {\"[ArgTypes](../api/doc-blocks/doc-block-argtypes.mdx)\": \"<detail_content>\", \"[Canvas](../api/doc-blocks/doc-block-canvas.mdx)\": \"<detail_content>\", \"[ColorPalette](../api/doc-blocks/doc-block-colorpalette.mdx)\": \"<detail_content>\", \"[Controls](../api/doc-blocks/doc-block-controls.mdx)\": \"<detail_content>\", \"[Description](../api/doc-blocks/doc-block-description.mdx)\": \"<detail_content>\", \"[IconGallery](../api/doc-blocks/doc-block-icongallery.mdx)\": \"<detail_content>\", \"[Markdown](../api/doc-blocks/doc-block-markdown.mdx)\": \"<detail_content>\", \"[Meta](../api/doc-blocks/doc-block-meta.mdx)\": \"<detail_content>\", \"[Primary](../api/doc-blocks/doc-block-primary.mdx)\": \"<detail_content>\", \"[Source](../api/doc-blocks/doc-block-source.mdx)\": \"<detail_content>\", \"[Stories](../api/doc-blocks/doc-block-stories.mdx)\": \"<detail_content>\", \"[Story](../api/doc-blocks/doc-block-story.mdx)\": \"<detail_content>\", \"[Subtitle](../api/doc-blocks/doc-block-subtitle.mdx)\": \"<detail_content>\", \"[Title](../api/doc-blocks/doc-block-title.mdx)\": \"<detail_content>\", \"[Typeset](../api/doc-blocks/doc-block-typeset.mdx)\": \"<detail_content>\", \"[Unstyled](../api/doc-blocks/doc-block-unstyled.mdx)\": \"<detail_content>\"}, \"Make your own Doc Blocks\": \"<detail_content>\", \"Troubleshooting\": {\"Why can't I use the Doc Blocks inside my stories?\": \"<detail_content>\"}}}, {\"title\": \"How to document components\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 4]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"MDX\", \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 5]\", \"content\": {\"Basic example\": {\"MDX and CSF\": \"<detail_content>\", \"Anatomy of MDX\": \"<detail_content>\", \"Known limitations\": \"<detail_content>\"}, \"Setup custom documentation\": {\"Using the `Meta` Doc Block\": \"<detail_content>\", \"Writing unattached documentation\": \"<detail_content>\", \"Using the File System\": {\"Working with standalone documentation pages\": \"<detail_content>\"}, \"Fully control custom documentation\": \"<detail_content>\", \"Working with multiple components\": \"<detail_content>\", \"Generate documentation from Markdown\": \"<detail_content>\", \"Linking to other stories and pages\": \"<detail_content>\"}, \"Troubleshooting\": {\"Markdown tables aren't rendering correctly\": \"<detail_content>\", \"The MDX documentation doesn't render in my environment\": {\"Storybook doesn't create documentation for my component stories\": \"<detail_content>\"}, \"The migration seems flaky and keeps failing\": \"<detail_content>\", \"The controls are not updating the story within the MDX documentation page\": \"<detail_content>\", \"The React version used is unexpected\": \"<detail_content>\"}}}]}, {\"title\": \"Writing Stories\", \"description\": \"Documentation section: writing-stories\", \"path\": \"[\\\"subpages\\\", 13]\", \"subpages\": [{\"title\": \"Args\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 0]\", \"content\": {\"Args object\": \"<detail_content>\", \"Story args\": \"<detail_content>\", \"Component args\": \"<detail_content>\", \"Global args\": \"<detail_content>\", \"Args composition\": \"<detail_content>\", \"Args can modify any aspect of your component\": \"<detail_content>\", \"Setting args through the URL\": \"<detail_content>\", \"Setting args from within a story\": \"<detail_content>\", \"Mapping to complex arg values\": \"<detail_content>\"}}, {\"title\": \"Building pages with Storybook\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 1]\", \"content\": {\"Pure presentational pages\": {\"Args composition for presentational screens\": \"<detail_content>\"}, \"Mocking connected components\": {\"[Mocking imports](./mocking-data-and-modules/mocking-modules.mdx)\": \"<detail_content>\", \"[Mocking API Services](./mocking-data-and-modules/mocking-network-requests.mdx)\": \"<detail_content>\", \"[Mocking providers](./mocking-data-and-modules/mocking-providers.mdx)\": \"<detail_content>\", \"Avoiding mocking dependencies\": {\"Mocking containers in Storybook\": \"<detail_content>\", \"Providing containers to your application\": \"<detail_content>\", \"Mocking global containers in Storybook\": \"<detail_content>\"}}}}, {\"title\": \"Decorators\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 2]\", \"content\": {\"Wrap stories with extra markup\": \"<detail_content>\", \"\\u201cContext\\u201d for mocking\": {\"Using decorators to provide data\": \"<detail_content>\"}, \"Story decorators\": \"<detail_content>\", \"Component decorators\": \"<detail_content>\", \"Global decorators\": \"<detail_content>\", \"Decorator inheritance\": \"<detail_content>\"}}, {\"title\": \"How to write stories\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 3]\", \"content\": {\"Where to put stories\": \"<detail_content>\", \"Component Story Format\": {\"Default export\": \"<detail_content>\", \"Defining stories\": {\"Custom rendering\": \"<detail_content>\", \"Working with React Hooks\": \"<detail_content>\", \"Working with Solid Signals\": \"<detail_content>\"}, \"Rename stories\": \"<detail_content>\"}, \"How to write stories\": {\"Using the play function\": \"<detail_content>\", \"Using parameters\": \"<detail_content>\", \"Using decorators\": \"<detail_content>\"}, \"Stories for two or more components\": \"<detail_content>\"}}, {\"title\": \"Loaders\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 4]\", \"content\": {\"Fetching API data\": \"<detail_content>\", \"Global loaders\": \"<detail_content>\", \"Loader inheritance\": \"<detail_content>\"}}, {\"title\": \"Naming components and hierarchy\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 5]\", \"content\": {\"Structure and hierarchy\": \"<detail_content>\", \"Naming stories\": \"<detail_content>\", \"Grouping\": \"<detail_content>\", \"Roots\": \"<detail_content>\", \"Single-story hoisting\": \"<detail_content>\", \"Sorting stories\": \"<detail_content>\"}}, {\"title\": \"Parameters\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 6]\", \"content\": {\"Story parameters\": \"<detail_content>\", \"Component parameters\": \"<detail_content>\", \"Global parameters\": \"<detail_content>\", \"Rules of parameter inheritance\": \"<detail_content>\"}}, {\"title\": \"Play function\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 7]\", \"content\": {\"Writing stories with the play function\": \"<detail_content>\", \"Working with the canvas\": \"<detail_content>\", \"Composing stories\": \"<detail_content>\"}}, {\"title\": \"Stories for multiple components\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 8]\", \"content\": {\"Subcomponents\": \"<detail_content>\", \"Reusing story definitions\": \"<detail_content>\", \"Using children as an arg\": \"<detail_content>\", \"Creating a Template Component\": \"<detail_content>\"}}, {\"title\": \"Tags\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 9]\", \"content\": {\"Built-in tags\": \"<detail_content>\", \"Applying tags\": \"<detail_content>\", \"Removing tags\": \"<detail_content>\", \"Filtering by custom tags\": \"<detail_content>\", \"Recipes\": {\"Docs-only stories\": \"<detail_content>\", \"Combo stories, still tested individually\": \"<detail_content>\"}}}, {\"title\": \"Writing stories in TypeScript\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 10]\", \"content\": {\"Typing stories with `Meta` and `StoryObj`\": {\"Props type parameter\": \"<detail_content>\"}, \"Using `satisfies` for better type safety\": \"<detail_content>\", \"Typing custom args\": {\"Vue specific tips\": \"<detail_content>\", \"Svelte specific tips\": \"<detail_content>\"}}}, {\"title\": \"Mocking Data And Modules\", \"description\": \"Documentation section: mocking-data-and-modules\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11]\", \"subpages\": [{\"title\": \"Mocking data and modules\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\", \"content\": {\"root\": []}}, {\"title\": \"Mocking modules\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\", \"content\": {\"Automocking\": {\"Registering modules to mock\": {\"Spy-only\": \"<detail_content>\", \"Fully automocked modules\": \"<detail_content>\", \"Mock files\": \"<detail_content>\"}, \"Using automocked modules in stories\": \"<detail_content>\", \"How it works\": {\"Comparison to Vitest mocking\": \"<detail_content>\"}}, \"Alternative methods\": {\"Subpath imports\": {\"Mock files\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Using subpath imports in stories\": \"<detail_content>\", \"Spying on mocked modules\": \"<detail_content>\"}, \"Builder aliases\": \"<detail_content>\"}, \"Common scenarios\": {\"Setting up and cleaning up\": \"<detail_content>\"}, \"Troubleshooting\": {\"Receiving an `exports is not defined` error\": \"<detail_content>\"}}}, {\"title\": \"Mocking network requests\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\", \"content\": {\"Set up the MSW addon\": \"<detail_content>\", \"Mocking REST requests\": \"<detail_content>\", \"Mocking GraphQL requests\": \"<detail_content>\", \"Configuring MSW for stories\": \"<detail_content>\"}}, {\"title\": \"Mocking providers\", \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\", \"content\": {\"Configuring the mock provider\": \"<detail_content>\"}}]}]}, {\"title\": \"Writing Tests\", \"description\": \"Documentation section: writing-tests\", \"path\": \"[\\\"subpages\\\", 14]\", \"subpages\": [{\"title\": \"Accessibility tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 0]\", \"content\": {\"Install the addon\": \"<detail_content>\", \"Check for violations\": \"<detail_content>\", \"Configure\": {\"Rulesets\": \"<detail_content>\", \"Individual rules\": \"<detail_content>\", \"Test behavior\": \"<detail_content>\", \"Excluded elements\": \"<detail_content>\", \"Disable automated checks\": \"<detail_content>\"}, \"Run accessibility tests\": {\"With the Vitest addon\": \"<detail_content>\", \"With the test-runner\": \"<detail_content>\"}, \"Debug accessibility violations\": \"<detail_content>\", \"Automate with CI\": \"<detail_content>\", \"Recommended workflow\": \"<detail_content>\", \"FAQ\": {\"What\\u2019s the difference between browser-based and linter-based accessibility tests?\": \"<detail_content>\", \"Why are my tests failing in different environments?\": \"<detail_content>\", \"The addon panel does not show expected violations\": \"<detail_content>\"}}}, {\"title\": \"Testing in CI\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 1]\", \"content\": {\"Set up Storybook tests in CI\": {\"1. Define `package.json` script\": \"<detail_content>\", \"2. Add a new CI workflow\": {\"2.1 Debug test failures\": \"<detail_content>\", \"2.2 Calculate code coverage\": \"<detail_content>\"}, \"3. Run your workflow\": \"<detail_content>\"}, \"FAQs\": {\"How do I run other Vitest tests alongside my Storybook tests?\": \"<detail_content>\"}}}, {\"title\": \"How to test UIs with Storybook\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 2]\", \"content\": {\"Get started\": \"<detail_content>\", \"Key concepts\": {\"Component tests\": \"<detail_content>\", \"Storybook Test\": \"<detail_content>\", \"Watch mode\": \"<detail_content>\", \"CI\": \"<detail_content>\", \"Coverage\": {\"Coverage in CI\": \"<detail_content>\"}}, \"Types of tests\": {\"Render tests\": \"<detail_content>\", \"[Interaction tests](./interaction-testing.mdx)\": \"<detail_content>\", \"[Accessibility tests](./accessibility-testing.mdx)\": \"<detail_content>\", \"[Visual tests](./visual-testing.mdx)\": \"<detail_content>\", \"[Snapshot tests](./snapshot-testing.mdx)\": \"<detail_content>\"}, \"Reusing stories in other testing tools\": {\"[End-to-end](./integrations/stories-in-end-to-end-tests.mdx)\": \"<detail_content>\", \"[Unit](./integrations/stories-in-unit-tests.mdx)\": \"<detail_content>\"}}}, {\"title\": \"Interaction tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 3]\", \"content\": {\"Writing interaction tests\": {\"Querying the `canvas`\": {\"Querying within shadow DOM\": \"<detail_content>\"}, \"Simulating behavior with `userEvent`\": \"<detail_content>\", \"Asserting with `expect`\": \"<detail_content>\", \"Spying on functions with `fn`\": \"<detail_content>\", \"Run code before the component gets rendered\": {\"Create mock data before rendering\": \"<detail_content>\"}, \"Run code before each story in a file\": \"<detail_content>\", \"Set up or reset state for all tests\": {\"`beforeAll`\": \"<detail_content>\", \"`beforeEach`\": \"<detail_content>\"}, \"Make assertions after interactions\": {\"`afterEach`\": \"<detail_content>\"}, \"Group interactions with the step function\": \"<detail_content>\", \"Mocked modules\": \"<detail_content>\"}, \"Running interaction tests\": \"<detail_content>\", \"Debugging interaction tests\": {\"Permalinks for reproductions\": \"<detail_content>\"}, \"Automate with CI\": \"<detail_content>\", \"Troubleshooting\": \"<detail_content>\"}}, {\"title\": \"Snapshot tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 4]\", \"content\": {\"Snapshot tests\": \"<detail_content>\", \"Get started with Portable Stories\": \"<detail_content>\", \"Snapshot testing a portable story\": {\"Verifying an error is thrown\": \"<detail_content>\"}, \"Snapshot testing with the test-runner\": \"<detail_content>\", \"FAQ\": {\"What\\u2019s the difference between snapshot tests and visual tests?\": \"<detail_content>\"}}}, {\"title\": \"Test coverage\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 5]\", \"content\": {\"Set up\": \"<detail_content>\", \"Usage\": {\"Storybook UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Editor extension\": \"<detail_content>\", \"CI\": \"<detail_content>\"}, \"Configuration\": {\"Coverage provider\": \"<detail_content>\", \"Watermarks\": \"<detail_content>\", \"Additional configuration\": \"<detail_content>\"}}}, {\"title\": \"Visual tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 6]\", \"content\": {\"Install the addon\": \"<detail_content>\", \"Enable visual tests\": \"<detail_content>\", \"Run visual tests\": \"<detail_content>\", \"Review changes\": \"<detail_content>\", \"Automate with CI\": \"<detail_content>\", \"PR checks\": \"<detail_content>\", \"Configure\": \"<detail_content>\", \"FAQs\": {\"What\\u2019s the difference between visual tests and snapshot tests?\": \"<detail_content>\"}}}, {\"title\": \"Integrations\", \"description\": \"Documentation section: integrations\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"Integrations\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"root\": []}}, {\"title\": \"Stories in end-to-end tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"With Cypress\": \"<detail_content>\", \"With Playwright\": \"<detail_content>\"}}, {\"title\": \"Stories in unit tests\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"Write a test with Testing Library\": {\"Override story properties\": \"<detail_content>\"}, \"Run tests on a single story\": \"<detail_content>\", \"Combine stories into a single test\": \"<detail_content>\", \"Troubleshooting\": {\"Run tests in other frameworks\": \"<detail_content>\", \"The args are not being passed to the test\": \"<detail_content>\"}}}, {\"title\": \"Test runner\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"Setup\": \"<detail_content>\", \"Configure\": {\"CLI Options\": \"<detail_content>\", \"Run tests against a deployed Storybook\": \"<detail_content>\"}, \"Run accessibility tests\": \"<detail_content>\", \"Run snapshot tests\": {\"Set up\": \"<detail_content>\", \"Configure\": {\"Override the default snapshot directory\": \"<detail_content>\", \"Customize snapshot serialization\": \"<detail_content>\"}}, \"Generate code coverage\": {\"Set up\": \"<detail_content>\", \"Configure\": \"<detail_content>\", \"What about other coverage reporting tools?\": \"<detail_content>\"}, \"Set up CI to run tests\": {\"Run against deployed Storybooks via Github Actions deployment\": \"<detail_content>\", \"Run against non-deployed Storybooks\": \"<detail_content>\"}, \"Advanced configuration\": {\"Test hook API\": \"<detail_content>\", \"(Experimental) Filter tests\": {\"Disabling tests\": \"<detail_content>\", \"Run tests for a subset of stories\": \"<detail_content>\", \"Skip tests\": \"<detail_content>\"}, \"Authentication for deployed Storybooks\": \"<detail_content>\", \"Helpers\": {\"Accessing story information with the test-runner\": \"<detail_content>\", \"Working with assets\": \"<detail_content>\"}, \"Index.json mode\": {\"Why?\": \"<detail_content>\", \"How do I check if my Storybook has a `index.json` file?\": \"<detail_content>\"}}, \"What's the difference between Chromatic and Test runner?\": \"<detail_content>\", \"Troubleshooting\": {\"The test runner seems flaky and keeps timing out\": \"<detail_content>\", \"The error output in the CLI is too short\": \"<detail_content>\", \"Run the test runner in other CI environments\": \"<detail_content>\", \"Tests filtered by tags are incorrectly executed\": \"<detail_content>\", \"The test runner doesn't support Yarn PnP out of the box\": \"<detail_content>\", \"Run test coverage in other frameworks\": \"<detail_content>\", \"The coverage addon doesn't support optimized builds\": \"<detail_content>\", \"The coverage addon doesn't support instrumented code\": \"<detail_content>\"}}}, {\"title\": \"Vitest addon\", \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"Install and set up\": {\"Automatic setup\": \"<detail_content>\", \"Manual setup\": \"<detail_content>\", \"Example configuration files\": \"<detail_content>\"}, \"Usage\": {\"Storybook UI\": \"<detail_content>\", \"CLI\": {\"Debugging\": \"<detail_content>\"}, \"Editor extension\": \"<detail_content>\", \"In CI\": \"<detail_content>\"}, \"How it works\": \"<detail_content>\", \"Configuring tests\": {\"Toggling test types\": \"<detail_content>\", \"Including, excluding, or skipping tests\": \"<detail_content>\"}, \"Comparison to the test runner\": \"<detail_content>\", \"FAQ\": {\"What happens if Vitest itself has an error?\": \"<detail_content>\", \"What happens when there are different test results in multiple environments?\": \"<detail_content>\", \"How do I debug my CLI tests in Storybook?\": \"<detail_content>\", \"How do I ensure my tests can find assets in the public directory?\": \"<detail_content>\", \"How do I isolate Storybook tests from others?\": \"<detail_content>\", \"Why do we recommend browser mode?\": \"<detail_content>\", \"How do I use WebDriver instead of Playwright?\": \"<detail_content>\", \"How do I use a browser other than Chromium?\": \"<detail_content>\", \"How do I customize a test name?\": \"<detail_content>\", \"How do I fix the `m.createRoot is not a function` error?\": \"<detail_content>\", \"How do I fix the `Error: Vitest failed to find the current suite` error?\": \"<detail_content>\"}, \"API\": {\"Exports\": {\"`storybookTest`\": \"<detail_content>\"}, \"Options\": {\"`configDir`\": \"<detail_content>\", \"`storybookScript`\": \"<detail_content>\", \"`storybookUrl`\": \"<detail_content>\", \"`tags`\": \"<detail_content>\", \"`disableAddonDocs`\": \"<detail_content>\"}}}}]}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"storybook\", \"description\": \"Documentation for storybook\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs\"}, \"subpages\": [{\"title\": \"Frequently Asked Questions\", \"description\": null, \"content\": {\"Error: No angular.json file found\": \"Storybook can be set up for both single-project and multi-project Angular workspaces. To set up Storybook for a project, run [the install command](./get-started/install) at the root of the workspace where the `angular.json` file is located. During initialization, the `.storybook` folder will be created and the `angular.json` file will be edited to add the Storybook configuration for the selected project. It's important to run the command at the root level to ensure that Storybook detects all projects correctly.\", \"How can I opt-out of Angular Ivy?\": \"In case you are having trouble with Angular Ivy you can deactivate it in your `main.js|ts`:\\n\\n```\\nexport default {\\n stories: [\\n /* ... */\\n ],\\n addons: [\\n /* ... */\\n ],\\n framework: {\\n name: '@storybook/angular',\\n options: {\\n enableIvy: false,\\n },\\n },\\n};\\n```\", \"How can I opt-out of Angular ngcc?\": \"In case you postinstall ngcc, you can disable it:\\n\\n```\\nexport default {\\n stories: [\\n /* ... */\\n ],\\n addons: [\\n /* ... */\\n ],\\n framework: {\\n name: '@storybook/angular',\\n options: {\\n enableNgcc: false,\\n },\\n },\\n};\\n```\\n\\nPlease report any issues related to Ivy in our [GitHub Issue Tracker](https://github.com/storybookjs/storybook/labels/app%3A%20angular) as the support for View Engine will be dropped in a future release of Angular.\", \"How can I run coverage tests with Create React App and leave out stories?\": \"Create React App does not allow providing options to Jest in your `package.json`, however you can run `jest` with commandline arguments:\\n\\n```\\nnpm test -- --coverage --collectCoverageFrom='[\\\"src/**/*.{js,jsx}\\\",\\\"!src/**/stories/*\\\"]'\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nIf you're using [`Yarn`](https://yarnpkg.com/) as a package manager, you'll need to adjust the command accordingly.\\n\\n</Callout>\", \"How do I setup Storybook to share Webpack configuration with Next.js?\": \"You can generally reuse Webpack rules by placing them in a file that is imported from both your `next.config.js` and your `.storybook/main.js|ts` files. For example:\\n\\n```\\nexport default {\\n webpackFinal: async (baseConfig) => {\\n const nextConfig = await import('/path/to/next.config.js');\\n\\n // merge whatever from nextConfig into the webpack config storybook will use\\n return { ...baseConfig, ...nextConfig };\\n },\\n};\\n```\", \"How do I fix module resolution in special environments?\": \"In case you are using [Yarn Plug-n-Play](https://yarnpkg.com/features/pnp) or your project is set up within a mono repository environment, you might run into issues with module resolution similar to this when running Storybook:\\n\\n```\\nWARN Failed to load preset: \\\"@storybook/react-webpack5/preset\\\"\\nRequired package: @storybook/react-webpack5 (via \\\"@storybook/react-webpack5/preset\\\")\\n```\\n\\nTo fix this, you can wrap the package name inside your Storybook configuration file (i.e., `.storybook/main.js|ts`) as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-pnpm-with-module-resolution.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"How do I setup the new React Context Root API with Storybook?\": \"If your installed React Version equals or is higher than 18.0.0, the new React Root API is automatically used and the newest React [concurrent features](https://reactjs.org/docs/concurrent-mode-intro.html) can be used.\\n\\nYou can opt-out from the new React Root API by setting the following property in your `.storybook/main.js|ts` file:\\n\\n```\\nexport default {\\n framework: {\\n name: '@storybook/react-webpack5',\\n options: {\\n legacyRootApi: true,\\n },\\n },\\n};\\n```\", \"Why is there no addons channel?\": \"A common error is that an addon tries to access the \\\"channel\\\", but the channel is not set. It can happen in a few different cases:\\n\\n[\\\"You're trying to access addon channel (e.g., by calling `setOptions`) in a non-browser environment like Jest. You may need to add a channel mock:\\\", \\\"```\\\\nimport { addons, mockChannel } from 'storybook/preview-api';\\\\n\\\\naddons.setChannel(mockChannel());\\\\n```\\\", \\\"In React Native, it's a special case documented in [#1192](https://github.com/storybookjs/storybook/issues/1192)\\\"]\", \"Why aren't the addons working in a composed Storybook?\": \"Composition is a new feature that we released with version 6.0, and there are still some limitations to it.\\n\\nFor now, the addons you're using in a composed Storybook will not work.\\n\\nWe're working on overcoming this limitation, and soon you'll be able to use them as if you are working with a non-composed Storybook.\", \"Can I have a Storybook with no local stories?\": \"Storybook does not work unless you have at least one local story (or docs page) defined in your project. In this context, local means a `.stories.*` or `.mdx` file that is referenced in your project's `.storybook/main.js` config.\\n\\nIf you're in a [Storybook composition](./sharing/storybook-composition.mdx) scenario, where you have multiple Storybooks, and want to have an extra Storybook with no stories of its own, that serves as a \\\"glue\\\" for all the other Storybooks in a project for demo/documentation purposes, you can do the following steps:\\n\\nIntroduce a single `.mdx` docs page (addon-docs required), that serves as an Introduction page, like so:\\n\\n```\\n# Welcome\\n\\nSome description here\\n```\\n\\nAnd then refer to it in your Storybook config file:\\n\\n```\\nconst config = {\\n // define at least one local story/page here\\n stories: ['../Introduction.mdx'],\\n // define composed Storybooks here\\n refs: {\\n firstProject: { title: 'First', url: 'some-url' },\\n secondProject: { title: 'Second', url: 'other-url' },\\n },\\n // ...\\n};\\nexport default config;\\n```\", \"Which community addons are compatible with the latest version of Storybook?\": \"Starting with Storybook version 6.0, we've introduced some great features aimed at streamlining your development workflow.\\n\\nWith this, we would like to point out that if you plan on using addons created by our fantastic community, you need to consider that some of those addons might be working with an outdated version of Storybook.\\n\\nWe're actively working to provide a better way to address this situation, but in the meantime, we'd like to ask for a bit of caution on your end so that you don't run into unexpected problems. Let us know by leaving a comment in the following [GitHub issue](https://github.com/storybookjs/storybook/issues/26031) so that we can gather information and expand the current list of addons that need to be updated to work with the latest version of Storybook.\", \"Is it possible to browse the documentation for past versions of Storybook?\": \"With the release of version 6.0, we updated our documentation as well. That doesn't mean that the old documentation was removed. We kept it to help you with your Storybook migration process. Use the content from the table below in conjunction with our [migration guide](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md).\\n\\nWe're only covering versions 5.3 and 5.0 as they were important milestones for Storybook. If you want to go back in time a little more, you'll have to check the specific release in the monorepo.\\n\\n| Section | Page | Current Location | Version 5.3 location | Version 5.0 location |\\n| ---------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| N/A | Why Storybook | [See current documentation](./get-started/why-storybook.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| Get started | Install | [See current documentation](./get-started/install.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/guides/quick-start-guide) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/guides/quick-start-guide) |\\n| | What's a story | [See current documentation](./get-started/whats-a-story.mdx) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/guides) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/guides) |\\n| | Browse Stories | [See current documentation](./get-started/browse-stories.mdx) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/guides) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/blob/release/5.0/docs/src/pages/guides) |\\n| | Setup | [See current documentation](./get-started/setup.mdx) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/guides) | [See versioned documentation for your framework](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/guides) |\\n| Write stories | Introduction | [See current documentation](./writing-stories/index.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/writing-stories) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/basics/writing-stories) |\\n| | Parameters | [See current documentation](./writing-stories/parameters.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/writing-stories/index.md#parameters) | Non existing feature or undocumented |\\n| | Decorators | [See current documentation](./writing-stories/decorators.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/writing-stories/index.md#decorators) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/basics/writing-stories/index.md#using-decorators) |\\n| | Naming components and hierarchy | [See current documentation](./writing-stories/naming-components-and-hierarchy.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/writing-stories) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/basics/writing-stories) |\\n| | Build pages and screens | [See current documentation](./writing-stories/build-pages-with-storybook.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Stories for multiple components | [See current documentation](./writing-stories/stories-for-multiple-components.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| Write docs | Autodocs | [See current documentation](./writing-docs/autodocs.mdx) | See versioned addon documentation | Non existing feature or undocumented |\\n| | MDX | [See current documentation](./writing-docs/mdx.mdx) | See versioned addon documentation | Non existing feature or undocumented |\\n| | Doc Blocks | [See current documentation](./writing-docs/doc-blocks.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Preview and build docs | [See current documentation](./writing-docs/build-documentation.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| Testing | Visual tests | [See current documentation](./writing-tests/visual-testing.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/testing/automated-visual-testing) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/testing/automated-visual-testing) |\\n| | Accessibility tests | [See current documentation](./writing-tests/accessibility-testing.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Interaction tests | [See current documentation](./writing-tests/interaction-testing.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/testing/interaction-testing) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/testing/interaction-testing) |\\n| | Snapshot tests | [See current documentation](./writing-tests/snapshot-testing.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/testing/structural-testing) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/testing/structural-testing) |\\n| | Import stories in tests/Unit tests | [See current documentation](./writing-tests/integrations/stories-in-unit-tests.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/testing/react-ui-testing) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/testing/react-ui-testing) |\\n| | Import stories in tests/End-to-end testing | [See current documentation](./writing-tests/integrations/stories-in-end-to-end-tests.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/testing/react-ui-testing) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/testing/react-ui-testing) |\\n| Sharing | Publish Storybook | [See current documentation](./sharing/publish-storybook.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/exporting-storybook) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/basics/exporting-storybook) |\\n| | Embed | [See current documentation](./sharing/embed.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Composition | [See current documentation](./sharing/storybook-composition.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Package Composition | [See current documentation](./sharing/package-composition.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| Essentials | Controls | [See current documentation](./essentials/controls.mdx) | Controls are specific to version 6.0 see [Knobs versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/addons/knobs) | Controls are specific to version 6.0 see [Knobs versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/addons/knobs) |\\n| | Actions | [See current documentation](./essentials/actions.mdx) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/addons/actions) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/addons/actions) |\\n| | Viewport | [See current documentation](./essentials/viewport.mdx) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/addons/viewport) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/addons/viewport) |\\n| | Backgrounds | [See current documentation](./essentials/backgrounds.mdx) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/addons/backgrounds) | [See addon versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/addons/backgrounds) |\\n| | Toolbars and globals | [See current documentation](./essentials/toolbars-and-globals.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/basics/toolbar-guide) | Non existing feature or undocumented |\\n| Configure | Overview | [See current documentation](./configure/index.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/overview) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/basics/writing-stories) |\\n| | Integration/Frameworks | [See current documentation](./configure/integration/frameworks.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Integration/Framework support for frameworks | [See current documentation](./configure/integration/frameworks-feature-support.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Integration/Compilers | [See current documentation](./configure/integration/compilers.mdx) | See versioned documentation [here](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/custom-babel-config) | See versioned documentation [here](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/custom-babel-config) |\\n| | Integration/Typescript | [See current documentation](./configure/integration/typescript.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/typescript-config) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/typescript-config) |\\n| | Integration/Styling and CSS | [See current documentation](./configure/styling-and-css.mdx) | See versioned documentation | See versioned documentation |\\n| | Integration/Images and assets | [See current documentation](./configure/integration/images-and-assets.mdx) | See versioned documentation | See versioned documentation |\\n| | Story rendering | [See current documentation](./configure/story-rendering.mdx) | See versioned documentation [here](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/add-custom-head-tags) and [here](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/add-custom-body) | See versioned documentation [here](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/add-custom-head-tags) |\\n| | Story Layout | [See current documentation](./configure/story-layout.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | User Interface/Features and behavior | [See current documentation](./configure/user-interface/features-and-behavior.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/options-parameter) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/options-parameter) |\\n| | User Interface/Theming | [See current documentation](./configure/user-interface/theming.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/theming) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/theming) |\\n| | User Interface/Sidebar & URLS | [See current documentation](./configure/user-interface/sidebar-and-urls.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/options-parameter) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/options-parameter) |\\n| | Environment variables | [See current documentation](./configure/environment-variables.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/env-vars) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/env-vars) |\\n| Builders | Introduction | [See current documentation](./builders/index.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Vite | [See current documentation](./builders/vite.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Webpack | [See current documentation](./builders/webpack.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/custom-webpack-config/index.md) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/custom-webpack-config/index.md) |\\n| | Builder API | [See current documentation](./builders/builder-api.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| Addons | Introduction | [See current documentation](./addons/index.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/writing-addons) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/writing-addons) |\\n| | Install addons | [See current documentation](./addons/install-addons.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/using-addons/) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/using-addons/) |\\n| | Writing Addons | [See current documentation](./addons/writing-addons.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/writing-addons) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/writing-addons) |\\n| | Writing Presets | [See current documentation](./addons/writing-presets.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/presets/writing-presets) | Non existing feature or undocumented |\\n| | Addons Knowledge Base | [See current documentation](./addons/addon-knowledge-base.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/writing-addons) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/writing-addons) |\\n| | Types of addons | [See current documentation](./addons/addon-types.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Addons API | [See current documentation](./addons/addons-api.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/addons/api) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/addons/api) |\\n| API | @storybook/addon-docs/blocks/ArgTypes | [See current documentation](./api/doc-blocks/doc-block-argtypes.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Canvas | [See current documentation](./api/doc-blocks/doc-block-canvas.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/ColorPalette | [See current documentation](./api/doc-blocks/doc-block-colorpalette.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Controls | [See current documentation](./api/doc-blocks/doc-block-controls.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Description | [See current documentation](./api/doc-blocks/doc-block-description.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/IconGallery | [See current documentation](./api/doc-blocks/doc-block-icongallery.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Markdown | [See current documentation](./api/doc-blocks/doc-block-markdown.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Meta | [See current documentation](./api/doc-blocks/doc-block-meta.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Primary | [See current documentation](./api/doc-blocks/doc-block-primary.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Source | [See current documentation](./api/doc-blocks/doc-block-source.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Stories | [See current documentation](./api/doc-blocks/doc-block-stories.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Story | [See current documentation](./api/doc-blocks/doc-block-story.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Subtitle | [See current documentation](./api/doc-blocks/doc-block-subtitle.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Title | [See current documentation](./api/doc-blocks/doc-block-title.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Typeset | [See current documentation](./api/doc-blocks/doc-block-typeset.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/Unstyled | [See current documentation](./api/doc-blocks/doc-block-unstyled.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | @storybook/addon-docs/blocks/useOf | [See current documentation](./api/doc-blocks/doc-block-useof.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Stories/Component Story Format (see note below) | [See current documentation](./api/csf.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/formats/component-story-format) | Non existing feature or undocumented |\\n| | ArgTypes | [See current documentation](./api/arg-types.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/Overview | [See current documentation](./api/main-config/main-config.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/framework | [See current documentation](./api/main-config/main-config-framework.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/stories | [See current documentation](./api/main-config/main-config-stories.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/addons | [See current documentation](./api/main-config/main-config-addons.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/babel | [See current documentation](./api/main-config/main-config-babel.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/babelDefault | [See current documentation](./api/main-config/main-config-babel-default.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/build | [See current documentation](./api/main-config/main-config-build.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/core | [See current documentation](./api/main-config/main-config-core.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/docs | [See current documentation](./api/main-config/main-config-docs.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/env | [See current documentation](./api/main-config/main-config-env.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/features | [See current documentation](./api/main-config/main-config-features.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/indexers | [See current documentation](./api/main-config/main-config-indexers.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/logLevel | [See current documentation](./api/main-config/main-config-log-level.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/managerHead | [See current documentation](./api/main-config/main-config-manager-head.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/previewAnnotations | [See current documentation](./api/main-config/main-config-preview-annotations.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/previewBody | [See current documentation](./api/main-config/main-config-preview-body.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/previewHead | [See current documentation](./api/main-config/main-config-preview-head.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/refs | [See current documentation](./api/main-config/main-config-refs.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/staticDirs | [See current documentation](./api/main-config/main-config-static-dirs.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/swc | [See current documentation](./api/main-config/main-config-swc.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/typescript | [See current documentation](./api/main-config/main-config-typescript.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/viteFinal | [See current documentation](./api/main-config/main-config-vite-final.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | `main.js` configuration/webpackFinal | [See current documentation](./api/main-config/main-config-webpack-final.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | Frameworks | [See current documentation](./api/new-frameworks.mdx) | Non existing feature or undocumented | Non existing feature or undocumented |\\n| | CLI options | [See current documentation](./api/cli-options.mdx) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.3/docs/src/pages/configurations/cli-options) | [See versioned documentation](https://github.com/storybookjs/storybook/tree/release/5.0/docs/src/pages/configurations/cli-options) |\\n\\n<Callout variant=\\\"info\\\">\\nIf you have stories written with the older `storiesOf` format, it was removed in Storybook 8.0 and is no longer maintained. We recommend that you migrate your stories to CSF. See the [migration guide](./releases/migration-guide.mdx#major-breaking-changes) for more information. However, if you need, you can still access the old `storiesOf` [documentation](https://github.com/storybookjs/storybook/blob/release/5.3/docs/src/pages/formats/storiesof-api/index.md) for reference.\\n</Callout>\", \"What icons are available for my toolbar or my addon?\": \"With the [`@storybook/icons`](https://www.npmjs.com/package/@storybook/icons) package, you get a set of icons that you can use to customize your UI. Go through the [documentation](https://main--64b56e737c0aeefed9d5e675.chromatic.com/?path=/docs/introduction--docs) to see how the icons look and use it as a reference when writing your addon or defining your Storybook global types.\", \"I see a \\\"No Preview\\\" error with a Storybook production build\": \"If you're using the `serve` package to verify your production build of Storybook, you'll get that error. It relates to how `serve` handles rewrites. For instance, `/iframe.html` is rewritten into `/iframe`, and you'll get that error.\\n\\nWe recommend that you use [http-server](https://www.npmjs.com/package/http-server) instead and use the following command to preview Storybook:\\n\\n```\\nnpx http-server storybook-static\\n```\\n\\n<Callout variant=\\\"info\\\">\\nSuppose you don't want to run the command above frequently. Add `http-server` as a development dependency and create a new script to preview your production build of Storybook.\\n</Callout>\", \"Can I use Storybook with Vue 2?\": \"Vue 2 entered [End of Life](https://v2.vuejs.org/lts/) (EOL) on December 31, 2023, and is no longer supported by the Vue team. As a result, we've stopped supporting Vue 2 in Storybook 8 and above and will not be releasing any new versions that support it. We recommend upgrading your project to Vue 3, which Storybook fully supports. If that's not an option, you can still use Storybook with Vue 2 by installing the latest version of Storybook 7 with the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-init-v7.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Why aren't my code blocks highlighted with Storybook MDX?\": \"Out of the box, Storybook provides syntax highlighting for a set of languages (e.g., Javascript, Markdown, CSS, HTML, Typescript, GraphQL) you can use with your code blocks. Currently, there's a known limitation when you try to register a custom language to get syntax highlighting. We're working on a fix for this and will update this section once it's available.\", \"Why aren't my MDX styles working in Storybook?\": \"Writing documentation with MDX can be troublesome, especially regarding how your code is formatted when using line breaks with code blocks. For example, this will break:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n<style>{`\\n .class1 {\\n ...\\n }\\n\\n .class2 {\\n ...\\n }\\n`}</style>\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nBut this will work:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n<style>\\n {`\\n .class1 {\\n ...\\n }\\n\\n .class2 {\\n ...\\n }\\n `}\\n</style>\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nSee the following [issue](https://github.com/mdx-js/mdx/issues/1945) for more information.\", \"Why are my mocked GraphQL queries failing with Storybook's MSW addon?\": \"If you're working with Vue 3, you'll need to install [`@vue/apollo-composable`](https://www.npmjs.com/package/@vue/apollo-composable). With Svelte, you'll need to install [`@rollup/plugin-replace`](https://www.npmjs.com/package/@rollup/plugin-replace) and update your `rollup.config` file to the following:\\n\\n```\\n// Boilerplate imports\\n\\nimport replace from '@rollup/plugin-replace';\\nconst production = !process.env.ROLLUP_WATCH;\\n\\n// Remainder rollup.config implementation\\n\\nexport default {\\n input: 'src/main.js',\\n output: {\\n sourcemap: true,\\n format: 'iife',\\n name: 'app',\\n file: 'public/build/bundle.js',\\n },\\n plugins: [\\n // Other plugins\\n\\n // Configures the replace plugin to allow GraphQL Queries to work properly\\n replace({\\n 'process.env.NODE_ENV': JSON.stringify('development'),\\n }),\\n ]\\n};\\n```\\n\\nWith Angular, the most common issue is the placement of the `mockServiceWorker.js` file. Use this [example](https://github.com/mswjs/examples/tree/main/examples/with-angular) as a point of reference.\", \"Can I use other GraphQL providers with Storybook's MSW addon?\": \"Yes, check the [addon's examples](https://github.com/mswjs/msw-storybook-addon/tree/main/packages/docs/src/demos) to learn how to integrate different providers.\", \"Can I mock GraphQL mutations with Storybook's MSW addon?\": \"No, currently, the MSW addon only has support for GraphQL queries. If you're interested in including this feature, open an issue in the [MSW addon repository](https://github.com/mswjs/msw-storybook-addon) and follow up with the maintainer.\", \"Why are my stories not showing up correctly when using certain characters?\": \"Storybook allows you to use most characters while naming your stories. Still, specific characters (e.g., `#`) can lead to issues when Storybook generates the internal identifier for the story, leading to collisions and incorrectly outputting the correct story. We recommend using such characters sparsely.\", \"Why is Storybook's source loader returning undefined with curried functions?\": \"This is a known issue with Storybook. If you're interested in getting it fixed, open an issue with a [working reproduction](./contribute/how-to-reproduce.mdx) so that it can be triaged and fixed in future releases.\", \"Why are my args no longer displaying the default values?\": \"Before version 6.3, unset args were set to the `argTypes.defaultValue` if specified or inferred from the component's properties (e.g., React's prop types, Angular inputs, Vue props). Starting with version 6.3, Storybook no longer infers default values but instead defines the arg's value as `undefined` when unset, allowing the framework to supply its default value.\\n\\nIf you are using `argTypes.defaultValue` to fix the above, you no longer need to, and you can safely remove it from your stories.\\n\\nAdditionally, suppose you were using `argTypes.defaultValue` or relying on inference to set a default value for an arg. In that case, you should define the arg's value at the component level instead:\\n\\n```\\nexport default {\\n component: MyComponent,\\n args: {\\n //\\ud83d\\udc47 Defining the arg's value at the component level.\\n text: 'Something',\\n },\\n};\\n```\\n\\nFor Storybook's Docs, you can manually configure the displayed value by configuring the `table.defaultValue` setting:\\n\\n```\\nexport default {\\n component: MyComponent,\\n argTypes: {\\n //\\ud83d\\udc47 Defining the arg's display value in docs.\\n text: {\\n table: { defaultValue: { summary: 'SomeType<T>' } },\\n },\\n },\\n};\\n```\", \"Why isn't Storybook's test runner working?\": \"There's an issue with Storybook's test runner and the latest version of Jest (i.e., version 28), which prevents it from running effectively. As a workaround, you can downgrade Jest to the previous stable version (i.e., version 27), and you'll be able to run it. See the following [issue](https://github.com/storybookjs/test-runner/issues/99) for more information.\", \"How does Storybook handle environment variables?\": \"Storybook has built-in support for [environment variables](./configure/environment-variables.mdx). By default, environment variables are only available in Node.js code and are not available in the browser as some variables should be kept secret (e.g., API keys) and **not** exposed to anyone visiting the published Storybook.\\n\\nTo expose a variable, you must preface its name with `STORYBOOK_`. So `STORYBOOK_API_URL` will be available in browser code but `API_KEY` will not. Additionally you can also customize which variables are exposed by setting the [`env`](./configure/environment-variables.mdx#using-storybook-configuration) field in the `.storybook/main.js` file.\\n\\nVariables are set when JavaScript is compiled so when the development server is started or you build your Storybook. Environment variable files should not be committed to Git as they often contain secrets which are not safe to add to Git. Instead, add `.env.*` to your `.gitignore` file and set up the environment variables manually on your hosting provider (e.g., [GitHub](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository)).\"}, \"metadata\": {\"title\": \"Frequently Asked Questions\", \"sidebar\": {\"order\": 13, \"title\": \"FAQ\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"Get started with Storybook\", \"description\": null, \"content\": {\"What is Storybook?\": \"Storybook is a frontend workshop for building UI components and pages in isolation. It helps you develop and share hard-to-reach states and edge cases without needing to run your whole app. Thousands of teams use it for UI development, testing, and documentation. It's open source and free.\", \"Install Storybook\": \"Storybook is a standalone tool that runs alongside your app. It's a zero-config environment that works with any modern frontend framework. You can install Storybook into an existing project or create a new one from scratch.\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n<HomeRenderers />\\n\\nWant to know more about installing Storybook? Check out the [installation guide](./get-started/install.mdx).\", \"Main concepts\": \"Storybook is a powerful tool that can help you with many aspects of your UI development workflow. Here are some of the main concepts to get you started.\\n\\n<HomeConcepts />\", \"Additional resources\": \"Once you've learned the basics, explore these other ways to get the most out of Storybook.\\n\\n<HomeResources />\"}, \"metadata\": {\"title\": \"Get started with Storybook\", \"hideRendererSelector\": true}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1]\"}, {\"title\": \" Snippets\", \"description\": \"Documentation section: _snippets\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/_snippets\"}, \"subpages\": [{\"title\": \"Addon A11Y Add\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook add @storybook/addon-a11y\\n```\", \"```\\npnpm exec storybook add @storybook/addon-a11y\\n```\", \"```\\nyarn exec storybook add @storybook/addon-a11y\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Addon A11Y Config Context In Story\", \"description\": null, \"content\": {\"root\": [\"```\\n// ...rest of story file\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// ...rest of story file\\n\\nexport const ExampleStory = {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n parameters={{\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n }}\\n/>\\n```\", \"```\\n// ...rest of story file\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n parameters={{\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n }}\\n/>\\n```\", \"```\\n// ...rest of story file\\n\\nexport const ExampleStory = {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {\\n include: ['body'],\\n exclude: ['.no-a11y-check'],\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"Addon A11Y Config In Meta And Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Button>;\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\n\\nexport const ExampleStory = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n parameters={{\\n a11y: {\\n // ...same config available as above\\n },\\n }}\\n globals={{\\n a11y: {\\n // ...same config available as above\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n parameters={{\\n a11y: {\\n // ...same config available as above\\n },\\n }}\\n globals={{\\n a11y: {\\n // ...same config available as above\\n },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\n\\nexport const ExampleStory = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const ExampleStory: Story = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more.\\n */\\n context: {},\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n /*\\n * Configure test behavior\\n * See: https://storybook.js.org/docs/next/writing-tests/accessibility-testing#test-behavior\\n */\\n test: 'error',\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\n\\nexport const ExampleStory = {\\n parameters: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n globals: {\\n a11y: {\\n // ...same config available as above\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"Addon A11Y Config In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more. Typically, this is the CSS selector for the part of the DOM you want to analyze.\\n */\\n context: 'body',\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n a11y: {\\n /*\\n * Axe's context parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter\\n * to learn more. Typically, this is the CSS selector for the part of the DOM you want to analyze.\\n */\\n context: 'body',\\n /*\\n * Axe's configuration\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#api-name-axeconfigure\\n * to learn more about the available properties.\\n */\\n config: {},\\n /*\\n * Axe's options parameter\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter\\n * to learn more about the available options.\\n */\\n options: {},\\n },\\n },\\n globals: {\\n a11y: {\\n // Optional flag to prevent the automatic check\\n manual: true,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"Addon A11Y Config Rules In Story\", \"description\": null, \"content\": {\"root\": [\"```\\n// ...rest of story file\\n\\nexport const IndividualA11yRulesExample: Story = {\\n parameters: {\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// ...rest of story file\\n\\nexport const IndividualA11yRulesExample = {\\n parameters: {\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"IndividualA11yRulesExample\\\"\\n parameters={{\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n }}\\n/>\\n```\", \"```\\n// ...rest of story file\\n\\nexport const IndividualA11yRulesExample: Story = {\\n parameters: {\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"IndividualA11yRulesExample\\\"\\n parameters={{\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n }}\\n/>\\n```\", \"```\\n// ...rest of story file\\n\\nexport const IndividualA11yRulesExample = {\\n parameters: {\\n a11y: {\\n config: {\\n rules: [\\n {\\n // The autocomplete rule will not run based on the CSS selector provided\\n id: 'autocomplete-valid',\\n selector: '*:not([autocomplete=\\\"nope\\\"])',\\n },\\n {\\n // Setting the enabled option to false will disable checks for this particular rule on all stories.\\n id: 'image-alt',\\n enabled: false,\\n },\\n ],\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}, {\"title\": \"Addon A11Y Config Rulesets In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n a11y: {\\n options: {\\n /*\\n * Opt in to running WCAG 2.x AAA rules\\n * Note that you must explicitly re-specify the defaults (all but the last array entry)\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter-examples for more details\\n */\\n runOnly: ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice', 'wcag2aaa'],\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\", \"```\\nexport default {\\n parameters: {\\n a11y: {\\n options: {\\n /*\\n * Opt in to running WCAG 2.x AAA rules\\n * Note that you must explicitly re-specify the defaults (all but the last array entry)\\n * See https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter-examples for more details\\n */\\n runOnly: ['wcag2a', 'wcag2aa', 'wcag21a', 'wcag21aa', 'best-practice', 'wcag2aaa'],\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\"}, {\"title\": \"Addon A11Y Disable\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const NonA11yStory: Story = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const NonA11yStory = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const NonA11yStory: Story = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"NonA11yStory\\\"\\n globals={{\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n }}\\n/>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const NonA11yStory = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"NonA11yStory\\\"\\n globals={{\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const NonA11yStory: Story = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const NonA11yStory = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const NonA11yStory: Story = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const ExampleStory = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ExampleStory: Story = {\\n globals: {\\n a11y: {\\n // This option disables all automatic a11y checks on this story\\n manual: true,\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\"}, {\"title\": \"Addon A11Y Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install @storybook/addon-a11y --save-dev\\n```\", \"```\\npnpm add --save-dev @storybook/addon-a11y\\n```\", \"```\\nyarn add --dev @storybook/addon-a11y\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\"}, {\"title\": \"Addon A11Y Parameter Error In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n // ...\\n parameters: {\\n // \\ud83d\\udc47 Fail all accessibility tests when violations are found\\n a11y: { test: 'error' },\\n },\\n};\\nexport default preview;\\n```\", \"```\\nexport default {\\n // ...\\n parameters: {\\n // \\ud83d\\udc47 Fail all accessibility tests when violations are found\\n a11y: { test: 'error' },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\"}, {\"title\": \"Addon A11Y Parameter Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Button>;\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary: Story = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail: Story = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary: Story = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail: Story = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations -->\\n<Story\\n name=\\\"Primary\\\"\\n args={{ primary: true }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story will not fail on accessibility violations\\n (but will still run the tests and show warnings) -->\\n<Story\\n name=\\\"NoA11yFail\\\"\\n parameters={{\\n a11y: { test: 'todo' },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary: Story = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail: Story = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations -->\\n<Story\\n name=\\\"Primary\\\"\\n args={{ primary: true }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story will not fail on accessibility violations\\n (but will still run the tests and show warnings) -->\\n<Story\\n name=\\\"NoA11yFail\\\"\\n parameters={{\\n a11y: { test: 'todo' },\\n }}\\n/>\\n```\", \"```\\nimport { Button } from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary: Story = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail: Story = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n // \\ud83d\\udc47 Applies to all stories in this file\\n a11y: { test: 'error' },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will use the 'error' value and fail on accessibility violations\\nexport const Primary = {\\n args: { primary: true },\\n};\\n\\n// \\ud83d\\udc47 This story will not fail on accessibility violations\\n// (but will still run the tests and show warnings)\\nexport const NoA11yFail = {\\n parameters: {\\n a11y: { test: 'todo' },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 9]\"}, {\"title\": \"Addon A11Y Parameter Remove\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Meta } from '@storybook/angular';\\n\\nimport { Button } from './Button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n });\\n</script>\\n```\", \"```\\nimport { Button } from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\nimport { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n // \\ud83d\\udc47 Remove this once all stories pass accessibility tests\\n // a11y: { test: 'todo' },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 10]\"}, {\"title\": \"Addon A11Y Parameter Todo In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Meta } from '@storybook/angular';\\n\\nimport { DataTable } from './DataTable.component';\\n\\nconst meta: Meta<DataTable> = {\\n component: DataTable,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n};\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { Meta } from '@storybook/your-framework';\\n\\nimport { DataTable } from './DataTable';\\n\\nconst meta = {\\n component: DataTable,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n} satisfies Meta<typeof DataTable>;\\nexport default meta;\\n```\", \"```\\nimport { DataTable } from './DataTable';\\n\\nexport default {\\n component: DataTable,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n });\\n</script>\\n```\", \"```\\nimport { Button } from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n};\\n```\", \"```\\nimport { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta<DataTable> = {\\n component: 'demo-data-table',\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n};\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-data-table',\\n parameters: {\\n // \\ud83d\\udc47 This component's accessibility tests will not fail\\n // Instead, they display warnings in the Storybook UI\\n a11y: { test: 'todo' },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11]\"}, {\"title\": \"Addon A11Y Register\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using (e.g., react-vite, vue3-vite, angular, etc.)\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-a11y', //\\ud83d\\udc48 The a11y addon goes here\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using (e.g., react-vite, vue3-vite, angular, etc.)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-a11y', //\\ud83d\\udc48 The a11y addon goes here\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12]\"}, {\"title\": \"Addon Actions Action Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { action } from 'storybook/actions';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n });\\n</script>\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button';\\n\\nexport default {\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { action } from 'storybook/actions';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button';\\n\\nconst meta = {\\n component: Button,\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nexport default {\\n component: 'demo-button',\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n args: {\\n // \\ud83d\\udc47 Create an action that appears when the onClick event is fired\\n onClick: action('on-click'),\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 13]\"}, {\"title\": \"Addon Backgrounds Define Globals\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const OnDark: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 Override background value for this story -->\\n<Story\\n name=\\\"OnDark\\\"\\n globals={{\\n backgrounds: { value: \\\"dark\\\" },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n};\\n\\nexport const OnDark = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 Override background value for this story-->\\n<Story\\n name=\\\"OnDark\\\"\\n globals={{\\n backgrounds: { value: \\\"dark\\\" },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OnDark: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n};\\n\\nexport const OnDark = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework (e.g., react-vite, vue3-vite, etc.)\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OnDark: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n};\\n\\nexport const OnDark = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n globals: {\\n // \\ud83d\\udc47 Set background value for all component stories\\n backgrounds: { value: 'gray', grid: false },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const OnDark: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override background value for this story\\n backgrounds: { value: 'dark' },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 14]\"}, {\"title\": \"Addon Backgrounds Disabled\", \"description\": null, \"content\": {\"root\": [\"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Large\\\"\\n parameters={{\\n backgrounds: { disable: true },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Large = {\\n parameters: {\\n backgrounds: { disable: true },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Large\\\"\\n parameters={{\\n backgrounds: { disable: true },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Large: Story = {\\n parameters: {\\n backgrounds: { disable: true },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Large = {\\n parameters: {\\n backgrounds: { disable: true },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Large: Story = {\\n parameters: {\\n backgrounds: { disable: true },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 15]\"}, {\"title\": \"Addon Backgrounds Grid\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\n// To apply a set of backgrounds to all stories of Button:\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n // To apply a set of backgrounds to all stories of Button:\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\n// To apply a grid to all stories of Button:\\nexport default {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n // To apply a set of backgrounds to all stories of Button:\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\n// To apply a set of backgrounds to all stories of Button:\\nconst meta = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\n// To apply a grid to all stories of Button:\\nexport default {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\n// To apply a set of backgrounds to all stories of Button:\\nconst meta = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// To apply a set of backgrounds to all stories of Button:\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\n// To apply a set of backgrounds to all stories of Button:\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n backgrounds: {\\n grid: {\\n cellSize: 20,\\n opacity: 0.5,\\n cellAmount: 5,\\n offsetX: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n offsetY: 16, // Default is 0 if story has 'fullscreen' layout, 16 if layout is 'padded'\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 16]\"}, {\"title\": \"Addon Backgrounds Options In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Override the default `dark` option\\n dark: { name: 'Dark', value: '#000' },\\n // \\ud83d\\udc47 Add a new option\\n gray: { name: 'Gray', value: '#CCC' },\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 17]\"}, {\"title\": \"Addon Backgrounds Options In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Default options\\n dark: { name: 'Dark', value: '#333' },\\n light: { name: 'Light', value: '#F7F9F2' },\\n // \\ud83d\\udc47 Add your own\\n maroon: { name: 'Maroon', value: '#400' },\\n },\\n },\\n },\\n initialGlobals: {\\n // \\ud83d\\udc47 Set the initial background color\\n backgrounds: { value: 'light' },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n backgrounds: {\\n options: {\\n // \\ud83d\\udc47 Default options\\n dark: { name: 'Dark', value: '#333' },\\n light: { name: 'Light', value: '#F7F9F2' },\\n // \\ud83d\\udc47 Add your own\\n maroon: { name: 'Maroon', value: '#400' },\\n },\\n },\\n },\\n initialGlobals: {\\n // \\ud83d\\udc47 Set the initial background color\\n backgrounds: { value: 'light' },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 18]\"}, {\"title\": \"Addon Consume And Update Globaltype\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React, { useCallback } from 'react';\\nimport { OutlineIcon } from '@storybook/icons';\\nimport { useGlobals } from 'storybook/manager-api';\\nimport { addons } from 'storybook/preview-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { FORCE_RE_RENDER } from 'storybook/internal/core-events';\\n\\nconst ExampleToolbar = () => {\\n const [globals, updateGlobals] = useGlobals();\\n\\n const isActive = globals['my-param-key'] || false;\\n\\n // Function that will update the global value and trigger a UI refresh.\\n const refreshAndUpdateGlobal = () => {\\n // Updates Storybook global value\\n updateGlobals({\\n ['my-param-key']: !isActive,\\n }),\\n // Invokes Storybook's addon API method (with the FORCE_RE_RENDER) event to trigger a UI refresh\\n addons.getChannel().emit(FORCE_RE_RENDER);\\n };\\n\\n const toggleOutline = useCallback(() => refreshAndUpdateGlobal(), [isActive]);\\n\\n return (\\n <IconButton\\n key=\\\"Example\\\"\\n active={isActive}\\n title=\\\"Show a Storybook toolbar\\\"\\n onClick={toggleOutline}\\n >\\n <OutlineIcon />\\n </IconButton>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 19]\"}, {\"title\": \"Addon Consume Globaltype\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { useGlobals } from 'storybook/manager-api';\\n\\nimport {\\n AddonPanel,\\n Placeholder,\\n Separator,\\n Source,\\n Spaced,\\n Title,\\n} from 'storybook/internal/components';\\n\\nimport { MyThemes } from '../my-theme-folder/my-theme-file';\\n\\n// Function to obtain the intended theme\\nconst getTheme = (themeName) => {\\n return MyThemes[themeName];\\n};\\n\\nconst ThemePanel = (props) => {\\n const [{ theme: themeName }] = useGlobals();\\n\\n const selectedTheme = getTheme(themeName);\\n\\n return (\\n <AddonPanel {...props}>\\n {selectedTheme ? (\\n <Spaced row={3} outer={1}>\\n <Title>{selectedTheme.name}</Title>\\n <p>The full theme object</p>\\n <Source\\n code={JSON.stringify(selectedTheme, null, 2)}\\n language=\\\"js\\\"\\n copyable\\n padded\\n showLineNumbers\\n />\\n </Spaced>\\n ) : (\\n <Placeholder>No theme selected</Placeholder>\\n )}\\n </AddonPanel>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 20]\"}, {\"title\": \"Addon Docs Options\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n {\\n name: '@storybook/addon-docs',\\n options: {\\n csfPluginOptions: null,\\n mdxPluginOptions: {\\n mdxCompileOptions: {\\n remarkPlugins: [],\\n },\\n },\\n },\\n },\\n ],\\n};\\n\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n\\nexport default {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n {\\n name: '@storybook/addon-docs',\\n options: {\\n csfPluginOptions: null,\\n mdxPluginOptions: {\\n mdxCompileOptions: {\\n remarkPlugins: [],\\n },\\n },\\n },\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 21]\"}, {\"title\": \"Addon Test Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook add @storybook/addon-vitest\\n```\", \"```\\npnpm exec storybook add @storybook/addon-vitest\\n```\", \"```\\nyarn exec storybook add @storybook/addon-vitest\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 22]\"}, {\"title\": \"Addon Viewport Add Viewport In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { MINIMAL_VIEWPORTS } from 'storybook/viewport';\\n\\nconst kindleViewports = {\\n kindleFire2: {\\n name: 'Kindle Fire 2',\\n styles: {\\n width: '600px',\\n height: '963px',\\n },\\n },\\n kindleFireHD: {\\n name: 'Kindle Fire HD',\\n styles: {\\n width: '533px',\\n height: '801px',\\n },\\n },\\n};\\n\\nexport default {\\n parameters: {\\n viewport: {\\n options: {\\n ...MINIMAL_VIEWPORTS,\\n ...kindleViewports,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { MINIMAL_VIEWPORTS } from 'storybook/viewport';\\n\\nconst kindleViewports = {\\n kindleFire2: {\\n name: 'Kindle Fire 2',\\n styles: {\\n width: '600px',\\n height: '963px',\\n },\\n },\\n kindleFireHD: {\\n name: 'Kindle Fire HD',\\n styles: {\\n width: '533px',\\n height: '801px',\\n },\\n },\\n};\\n\\nconst preview: Preview = {\\n parameters: {\\n viewport: {\\n options: {\\n ...MINIMAL_VIEWPORTS,\\n ...kindleViewports,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 23]\"}, {\"title\": \"Addon Viewport Configuration In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n viewports: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n viewports: INITIAL_VIEWPORTS,\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nexport default {\\n component: 'my-component',\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n parameters: {\\n viewport: {\\n //\\ud83d\\udc47 Set available viewports for every story in the file\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 24]\"}, {\"title\": \"Addon Viewport Define Globals\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const OnPhone: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: \\\"tablet\\\", isRotated: false },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"OnPhone\\\"\\n globals={{\\n viewport: { value: \\\"mobile1\\\", isRotated: false },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n};\\n\\nexport const OnPhone = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: \\\"tablet\\\", isRotated: false },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"OnPhone\\\"\\n globals={{\\n viewport: { value: \\\"mobile1\\\", isRotated: false },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OnPhone: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n};\\n\\nexport const OnPhone = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OnPhone: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n};\\n\\nexport const OnPhone = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n globals: {\\n // \\ud83d\\udc47 Set viewport for all component stories\\n viewport: { value: 'tablet', isRotated: false },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const OnPhone: Story = {\\n globals: {\\n // \\ud83d\\udc47 Override viewport for this story\\n viewport: { value: 'mobile1', isRotated: false },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 25]\"}, {\"title\": \"Addon Viewport Options In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nexport default {\\n parameters: {\\n viewport: {\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n initialGlobals: {\\n viewport: { value: 'ipad', isRotated: false },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { INITIAL_VIEWPORTS } from 'storybook/viewport';\\n\\nconst preview: Preview = {\\n parameters: {\\n viewport: {\\n options: INITIAL_VIEWPORTS,\\n },\\n },\\n initialGlobals: {\\n viewport: { value: 'ipad', isRotated: false },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 26]\"}, {\"title\": \"Addon Vitest Set Project Annotations Simple\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\nimport * as previewAnnotations from './preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations]);\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\nimport * as previewAnnotations from './preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations]);\\n```\", \"```\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\nimport * as previewAnnotations from './preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations]);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 27]\"}, {\"title\": \"After Each In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Page } from './Page';\\n\\nconst meta: Meta<Page> = {\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Page>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" play={async ({ canvas }) => {\\n // ...\\n }}\\n/>\\n```\", \"```\\nimport Page from './Page.svelte';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" play={async ({ canvas }) => {\\n // ...\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Page from './Page.svelte';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Page } from './Page';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-page',\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-page',\\n // \\ud83d\\udc47 Runs after each story in this file\\n async afterEach(context) {\\n console.log(`\\u2705 Tested ${context.name} story`);\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ...\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 28]\"}, {\"title\": \"Angular Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/angular', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport { StorybookConfig } from '@storybook/angular';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/angular', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 29]\"}, {\"title\": \"Angular Builder Production\", \"description\": null, \"content\": {\"root\": [\"```\\n# Builds Storybook with Angular's custom builder\\n# See https://storybook.js.org/docs/get-started/frameworks/angular#how-do-i-migrate-to-an-angular-storybook-builder\\n# to learn how to create the custom builder\\nng run my-project:build-storybook\\n```\", \"```\\n{\\n \\\"scripts\\\": {\\n \\\"build-storybook\\\": \\\"ng run my-project:build-storybook\\\"\\n }\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 30]\"}, {\"title\": \"Angular Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/angular\\n```\", \"```\\npnpm add --save-dev @storybook/angular\\n```\", \"```\\nyarn add --dev @storybook/angular\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 31]\"}, {\"title\": \"Angular Project Compodoc Config\", \"description\": null, \"content\": {\"root\": [\"```\\n{\\n \\\"$schema\\\": \\\"./node_modules/@angular/cli/lib/config/schema.json\\\",\\n \\\"version\\\": 1,\\n \\\"newProjectRoot\\\": \\\"projects\\\",\\n \\\"projects\\\": {\\n \\\"your-project\\\": {\\n \\\"projectType\\\": \\\"application\\\",\\n \\\"schematics\\\": {},\\n \\\"root\\\": \\\"\\\",\\n \\\"sourceRoot\\\": \\\"src\\\",\\n \\\"prefix\\\": \\\"app\\\",\\n \\\"architect\\\": {\\n \\\"storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:start-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\".storybook\\\",\\n \\\"browserTarget\\\": \\\"your-project:build\\\",\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\n \\\"-e\\\",\\n \\\"json\\\",\\n \\\"-d\\\",\\n \\\".\\\", // Add this line to introspect the relevant files starting from the root directory of your project.\\n ],\\n \\\"port\\\": 6006,\\n },\\n },\\n \\\"build-storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:build-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\".storybook\\\",\\n \\\"browserTarget\\\": \\\"your-project:build\\\",\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\n \\\"-e\\\",\\n \\\"json\\\",\\n \\\"-d\\\",\\n \\\".\\\", // Add this line to introspect the relevant files starting from the root directory of your project.\\n ],\\n \\\"outputDir\\\": \\\"storybook-static\\\",\\n },\\n },\\n },\\n },\\n },\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 32]\"}, {\"title\": \"Api Doc Block Argtypes Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 33]\"}, {\"title\": \"Api Doc Block Canvas Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 34]\"}, {\"title\": \"Api Doc Block Controls Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n canvas: { sourceState: 'shown' },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 35]\"}, {\"title\": \"Api Doc Block Description Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary: Story = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n /**\\n * Button stories\\n * These stories showcase the button\\n */\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n });\\n</script>\\n\\n<!--\\n Button stories\\n These stories showcase the button\\n -->\\n\\n<Story\\n name=\\\"Primary\\\"\\n parameters={{\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments'\\n },\\n },\\n }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n};\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n};\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n /**\\n * Button stories\\n * These stories showcase the button\\n */\\n const meta = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n });\\n</script>\\n\\n<!--\\n Button stories\\n These stories showcase the button\\n -->\\n\\n<Story\\n name=\\\"Primary\\\"\\n parameters={{\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments'\\n },\\n },\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary: Story = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary: Story = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n};\\n\\n/**\\n * # Button stories\\n * These stories showcase the button\\n */\\nexport const Primary = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n/**\\n * Button stories\\n * These stories showcase the button\\n */\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n description: {\\n component: 'Another description, overriding the comments',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n/**\\n * Primary Button\\n * This is the primary button\\n */\\nexport const Primary: Story = {\\n parameters: {\\n docs: {\\n description: {\\n story: 'Another description on the story, overriding the comments',\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 36]\"}, {\"title\": \"Api Doc Block Source Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n source: { language: 'tsx' },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n source: { language: 'tsx' },\\n },\\n }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n source: { language: 'jsx' },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n source: { language: 'jsx' },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n source: { language: 'tsx' },\\n },\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n source: { language: 'tsx' },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n source: { language: 'tsx' },\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n source: { language: 'tsx' },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n source: { language: 'tsx' },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 37]\"}, {\"title\": \"Api Doc Block Story Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n story: { autoplay: true },\\n },\\n }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const meta = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n parameters={{\\n docs: {\\n story: { autoplay: true },\\n },\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport const Basic = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {\\n parameters: {\\n docs: {\\n story: { autoplay: true },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 38]\"}, {\"title\": \"Arg Types Control\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n control: {\\n type: 'number',\\n min: 0,\\n max: 100,\\n step: 10,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 39]\"}, {\"title\": \"Arg Types Default Value\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u274c Deprecated\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n // \\u274c Deprecated\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n // \\u26d4\\ufe0f Deprecated, do not use\\n defaultValue: 0,\\n },\\n },\\n // \\u2705 Do this instead\\n args: {\\n value: 0,\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 40]\"}, {\"title\": \"Arg Types Description\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n description: 'The value of the slider',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 41]\"}, {\"title\": \"Arg Types If\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n parent: { control: 'select', options: ['one', 'two', 'three'] },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg exists\\n parentExists: { if: { arg: 'parent', exists: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg does not exist\\n parentDoesNotExist: { if: { arg: 'parent', exists: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is truthy\\n parentIsTruthy: { if: { arg: 'parent' } },\\n parentIsTruthyVerbose: { if: { arg: 'parent', truthy: true } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not truthy\\n parentIsNotTruthy: { if: { arg: 'parent', truthy: false } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is 'three'\\n parentIsEqToValue: { if: { arg: 'parent', eq: 'three' } },\\n\\n // \\ud83d\\udc47 Only shown when `parent` arg value is not 'three'\\n parentIsNotEqToValue: { if: { arg: 'parent', neq: 'three' } },\\n\\n // Each of the above can also be conditional on the value of a globalType, e.g.:\\n\\n // \\ud83d\\udc47 Only shown when `theme` global exists\\n parentExists: { if: { global: 'theme', exists: true } },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 42]\"}, {\"title\": \"Arg Types In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n // \\ud83d\\udc47 All Button stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 43]\"}, {\"title\": \"Arg Types In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n argTypes: {\\n // \\ud83d\\udc47 All stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview = {\\n argTypes: {\\n // \\ud83d\\udc47 All stories expect a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n} satisfies Preview;\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 44]\"}, {\"title\": \"Arg Types In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\n\\ntype Story = StoryObj<typeof Button>;\\n\\nexport const Basic: Story = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n argTypes={{\\n label: { control: 'text', description: 'Overwritten description' }\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Basic = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Basic\\\"\\n argTypes={{\\n label: { control: 'text', description: 'Overwritten description' }\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n} satisfies Story;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n} satisfies Story;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Basic = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {\\n argTypes: {\\n // \\ud83d\\udc47 This story expects a label arg\\n label: {\\n control: 'text',\\n description: 'Overwritten description',\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 45]\"}, {\"title\": \"Arg Types Mapping\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Bold: <b>Bold</b>,\\n Italic: <i>Italic</i>,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Normal: normal,\\n Bold: bold,\\n Italic: italic,\\n },\\n },\\n },\\n });\\n</script>\\n\\n{#snippet normal()}\\n <span>Normal</span>\\n{/snippet}\\n\\n{#snippet bold()}\\n <b>Bold</b>\\n{/snippet}\\n{#snippet italic()}\\n <i>Italic</i>\\n{/snippet}\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Normal: normal,\\n Bold: bold,\\n Italic: italic,\\n },\\n },\\n },\\n });\\n</script>\\n\\n{#snippet normal()}\\n <span>Normal</span>\\n{/snippet}\\n\\n{#snippet bold()}\\n <b>Bold</b>\\n{/snippet}\\n{#snippet italic()}\\n <i>Italic</i>\\n{/snippet}\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Bold: <b>Bold</b>,\\n Italic: <i>Italic</i>,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Bold: <b>Bold</b>,\\n Italic: <i>Italic</i>,\\n },\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Bold: html`<b>Bold</b>`,\\n Italic: html`<i>Italic</i>`,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n label: {\\n control: { type: 'select' },\\n options: ['Normal', 'Bold', 'Italic'],\\n mapping: {\\n Bold: html`<b>Bold</b>`,\\n Italic: html`<i>Italic</i>`,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 46]\"}, {\"title\": \"Arg Types Name\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n actualArgName: {\\n name: 'Friendly name',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 47]\"}, {\"title\": \"Arg Types Options\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n icon: {\\n options: ['arrow-up', 'arrow-down', 'loading'],\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 48]\"}, {\"title\": \"Arg Types Table\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n value: {\\n table: {\\n defaultValue: { summary: 0 },\\n type: { summary: 'number' },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 49]\"}, {\"title\": \"Arg Types Type\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Example } from './Example';\\n\\nconst meta: Meta<Example> = {\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Example from './Example.svelte';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n};\\n```\", \"```\\nimport { Example } from './Example';\\n\\nexport default {\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Example from './Example.svelte';\\n\\n const { Story } = defineMeta({\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Example from './Example.svelte';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Example } from './Example';\\n\\nconst meta = {\\n component: Example,\\n argTypes: {\\n value: { type: 'number' },\\n },\\n} satisfies Meta<typeof Example>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-example',\\n argTypes: {\\n value: { type: 'number' },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-example',\\n argTypes: {\\n value: { type: 'number' },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 50]\"}, {\"title\": \"Args In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // The default value of the theme arg for all stories\\n args: { theme: 'light' },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n // The default value of the theme arg for all stories\\n args: { theme: 'light' },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 51]\"}, {\"title\": \"Args Usage With Addons\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { useArgs } from 'storybook/manager-api';\\n\\nconst [args, updateArgs, resetArgs] = useArgs();\\n\\n// To update one or more args:\\nupdateArgs({ key: 'value' });\\n\\n// To reset one (or more) args:\\nresetArgs((argNames: ['key']));\\n\\n// To reset all args\\nresetArgs();\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 52]\"}, {\"title\": \"Automock Register Full\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automatically replaces all exports from the `lib/session` local module with mock functions\\nsb.mock(import('../lib/session.ts'));\\n// \\ud83d\\udc47 Automatically replaces all exports from the `uuid` package in `node_modules` with mock functions\\nsb.mock(import('uuid'));\\n\\n// ...rest of the file\\n```\", \"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automatically replaces all exports from the `lib/session` local module with mock functions\\nsb.mock('../lib/session.js');\\n// \\ud83d\\udc47 Automatically replaces all exports from the `uuid` package in `node_modules` with mock functions\\nsb.mock('uuid');\\n\\n// ...rest of the file\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 53]\"}, {\"title\": \"Automock Register Mock File\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Replaces imports of this module with imports to `../lib/__mocks__/session.ts`\\nsb.mock(import('../lib/session.ts'));\\n// \\ud83d\\udc47 Replaces imports of this module with imports to `../__mocks__/uuid.ts`\\nsb.mock(import('uuid'));\\n\\n// ...rest of the file\\n```\", \"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Replaces imports of this module with imports to `../lib/__mocks__/session.ts`\\nsb.mock('../lib/session.js');\\n// \\ud83d\\udc47 Replaces imports of this module with imports to `../__mocks__/uuid.ts`\\nsb.mock('uuid');\\n\\n// ...rest of the file\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 54]\"}, {\"title\": \"Automock Register Spy\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automatically spies on all exports from the `lib/session` local module\\nsb.mock(import('../lib/session.ts'), { spy: true });\\n// \\ud83d\\udc47 Automatically spies on all exports from the `uuid` package in `node_modules`\\nsb.mock(import('uuid'), { spy: true });\\n\\n// ...rest of the file\\n```\", \"```\\nimport { sb } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automatically spies on all exports from the `lib/session` local module\\nsb.mock('../lib/session.js', { spy: true });\\n// \\ud83d\\udc47 Automatically spies on all exports from the `uuid` package in `node_modules`\\nsb.mock('uuid', { spy: true });\\n\\n// ...rest of the file\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 55]\"}, {\"title\": \"Automocked Modules In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { expect, mocked } from 'storybook/test';\\n\\nimport { AuthButton } from './AuthButton.component';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nconst meta: Meta<AuthButton> = {\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n mocked(uuidv4).mockReturnValue('1234-5678-90ab-cdef');\\n mocked(getUserFromSession).mockReturnValue({ name: 'John Doe' });\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<AuthButton>;\\n\\nexport const LogIn: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework (e.g. react-vite, vue3-vite, etc.)\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { expect, mocked } from 'storybook/test';\\n\\nimport { AuthButton } from './AuthButton';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nconst meta = {\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n mocked(uuidv4).mockReturnValue('1234-5678-90ab-cdef');\\n mocked(getUserFromSession).mockReturnValue({ name: 'John Doe' });\\n },\\n} satisfies Meta<typeof AuthButton>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LogIn: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { AuthButton } from './AuthButton';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nexport default {\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n uuidv4.mockReturnValue('1234-5678-90ab-cdef');\\n getUserFromSession.mockReturnValue({ name: 'John Doe' });\\n },\\n};\\n\\nexport const LogIn = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { expect, mocked } from 'storybook/test';\\n\\n import { AuthButton } from './AuthButton.svelte';\\n\\n import { v4 as uuidv4 } from 'uuid';\\n import { getUserFromSession } from '../lib/session';\\n\\n const { Story } = defineMeta({\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n mocked(uuidv4).mockReturnValue('1234-5678-90ab-cdef');\\n mocked(getUserFromSession).mockReturnValue({ name: 'John Doe' });\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"LogIn\\\"\\n play={async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { expect, mocked } from 'storybook/test';\\n\\nimport { AuthButton } from './AuthButton.svelte';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nconst meta = {\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n mocked(uuidv4).mockReturnValue('1234-5678-90ab-cdef');\\n mocked(getUserFromSession).mockReturnValue({ name: 'John Doe' });\\n },\\n} satisfies Meta<typeof AuthButton>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LogIn: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { expect } from 'storybook/test';\\n\\n import { AuthButton } from './AuthButton.svelte';\\n\\n import { v4 as uuidv4 } from 'uuid';\\n import { getUserFromSession } from '../lib/session';\\n\\n const { Story } = defineMeta({\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n uuidv4.mockReturnValue('1234-5678-90ab-cdef');\\n getUserFromSession.mockReturnValue({ name: 'John Doe' });\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"LogIn\\\"\\n play={async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n }}\\n/>\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { AuthButton } from './AuthButton.svelte';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nexport default {\\n component: AuthButton,\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n uuidv4.mockReturnValue('1234-5678-90ab-cdef');\\n getUserFromSession.mockReturnValue({ name: 'John Doe' });\\n },\\n};\\n\\nexport const LogIn = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { expect, mocked } from 'storybook/test';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nconst meta: Meta = {\\n component: 'demo-auth-button',\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n mocked(uuidv4).mockReturnValue('1234-5678-90ab-cdef');\\n mocked(getUserFromSession).mockReturnValue({ name: 'John Doe' });\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const LogIn: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { v4 as uuidv4 } from 'uuid';\\nimport { getUserFromSession } from '../lib/session';\\n\\nexport default {\\n component: 'demo-auth-button',\\n // \\ud83d\\udc47 This will run before each story is rendered\\n beforeEach: async () => {\\n // \\ud83d\\udc47 Force known, consistent behavior for mocked modules\\n uuidv4.mockReturnValue('1234-5678-90ab-cdef');\\n getUserFromSession.mockReturnValue({ name: 'John Doe' });\\n },\\n};\\n\\nexport const LogIn = {\\n play: async ({ canvas, userEvent }) => {\\n const button = canvas.getByRole('button', { name: 'Sign in' });\\n userEvent.click(button);\\n\\n // Assert that the getUserFromSession function was called\\n expect(getUserFromSession).toHaveBeenCalled();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 56]\"}, {\"title\": \"Before All In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { init } from '../project-bootstrap';\\n\\nexport default {\\n async beforeAll() {\\n await init();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { init } from '../project-bootstrap';\\n\\nconst preview: Preview = {\\n async beforeAll() {\\n await init();\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 57]\"}, {\"title\": \"Before Each In Meta Mock Date\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport MockDate from 'mockdate';\\n\\nimport { Page } from './Page';\\n\\nconst meta: Meta<Page> = {\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Page>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MockDate from 'mockdate';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" play={async ({ canvas }) => {\\n // ... This will run with the mocked Date\\n }}\\n/>\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\nimport Page from './Page.svelte';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MockDate from 'mockdate';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" play={async ({ canvas }) => {\\n // ... This will run with the mocked Date\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MockDate from 'mockdate';\\n\\nimport Page from './Page.svelte';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MockDate from 'mockdate';\\n\\nimport { Page } from './Page';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\nexport default {\\n component: 'my-page',\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n};\\n\\nexport const Default = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport MockDate from 'mockdate';\\n\\nconst meta: Meta = {\\n component: 'my-page',\\n // \\ud83d\\udc47 Set the value of Date for every story in the file\\n async beforeEach() {\\n MockDate.set('2024-02-14');\\n\\n // \\ud83d\\udc47 Reset the Date after each story\\n return () => {\\n MockDate.reset();\\n };\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n async play({ canvas }) {\\n // ... This will run with the mocked Date\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 58]\"}, {\"title\": \"Before Each In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport MockDate from 'mockdate';\\n\\nexport default {\\n async beforeEach() {\\n MockDate.reset();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport MockDate from 'mockdate';\\n\\nconst preview: Preview = {\\n async beforeEach() {\\n MockDate.reset();\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 59]\"}, {\"title\": \"Build Storybook Production Mode\", \"description\": null, \"content\": {\"root\": [\"```\\n# Builds Storybook with Angular's custom builder\\n# See https://storybook.js.org/docs/get-started/angular\\n# to learn how to create the custom builder\\nng run my-project:build-storybook\\n```\", \"```\\nnpm run build-storybook\\n```\", \"```\\npnpm run build-storybook\\n```\", \"```\\nyarn build-storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 60]\"}, {\"title\": \"Button Component With Proptypes\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Component, Input } from '@angular/core';\\n\\n@Component({\\n selector: 'my-button',\\n template: ` <button type=\\\"button\\\" [disabled]=\\\"isDisabled\\\">\\n {{ content }}\\n </button>`,\\n styleUrls: ['./button.css'],\\n})\\nexport class ButtonComponent {\\n /**\\n * Checks if the button should be disabled\\n */\\n @Input()\\n isDisabled: boolean;\\n\\n /**\\n The display content of the button\\n */\\n @Input()\\n content: string;\\n}\\n```\", \"```\\nimport React from 'react';\\n\\nimport PropTypes from 'prop-types';\\n\\nexport function Button({ isDisabled, content }) {\\n return (\\n <button type=\\\"button\\\" disabled={isDisabled}>\\n {content}\\n </button>\\n );\\n}\\n\\nButton.propTypes = {\\n /**\\n Checks if the button should be disabled\\n */\\n isDisabled: PropTypes.bool.isRequired,\\n /**\\n The display content of the button\\n */\\n content: PropTypes.string.isRequired,\\n};\\n```\", \"```\\nexport interface ButtonProps {\\n /**\\n * Checks if the button should be disabled\\n */\\n isDisabled: boolean;\\n /**\\n The display content of the button\\n */\\n content: string;\\n}\\n\\nexport const Button: React.FC<ButtonProps> = ({ isDisabled = false, content = '' }) => {\\n return (\\n <button type=\\\"button\\\" disabled={isDisabled}>\\n {content}\\n </button>\\n );\\n};\\n```\", \"```\\n<script>\\n /**\\n * A Button Component\\n * @component\\n */\\n\\n /**\\n * Disable the button\\n * @required\\n */\\n export let disabled = false;\\n\\n /**\\n * Button content\\n * @required\\n */\\n export let content = '';\\n<script/>\\n\\n<button type=\\\"button\\\" {disabled}>{content}</button>\\n```\", \"```\\n<template>\\n <button type=\\\"button\\\" :disabled=\\\"isDisabled\\\">{{ label }}</button>\\n</template>\\n\\n<script>\\n import { reactive } from 'vue';\\n\\n export default {\\n name: 'button',\\n props: {\\n /**\\n * Checks if the button should be disabled\\n */\\n isDisabled: {\\n type: Boolean,\\n default: false,\\n required: true,\\n },\\n /**\\n * The display label of the button\\n */\\n label: {\\n type: String,\\n default: 'One',\\n required: true,\\n },\\n },\\n setup(props) {\\n props = reactive(props);\\n return {\\n /**\\n * What will be returned here will available to the component\\n * Functions referenced here will act like methods\\n */\\n };\\n //\\n },\\n };\\n</script>\\n```\", \"```\\n<template>\\n <button type=\\\"button\\\" :disabled=\\\"isDisabled\\\">{{ label }}</button>\\n</template>\\n\\n<script lang=\\\"ts\\\">\\n import { defineComponent } from 'vue';\\n\\n export default defineComponent({\\n name: 'button',\\n props: {\\n /**\\n * Checks if the button should be disabled\\n */\\n isDisabled: {\\n type: Boolean,\\n default: false,\\n },\\n /**\\n * The display label of the button\\n */\\n label: {\\n type: String,\\n default: 'One',\\n required: true,\\n },\\n },\\n setup(props) {\\n /**\\n * What will be returned here will available to the component\\n * Functions referenced here will act like methods\\n */\\n },\\n });\\n</script>\\n```\", \"```\\nimport { LitElement, html } from 'lit';\\n\\n/**\\n * @prop {string} content - The display label of the button\\n * @prop {boolean} isDisabled - Checks if the button should be disabled\\n * @summary This is a custom button element\\n * @tag custom-button\\n */\\n\\nexport class CustomButton extends LitElement {\\n static get properties() {\\n return {\\n content: { type: String },\\n isDisabled: { type: Boolean },\\n };\\n }\\n\\n constructor() {\\n super();\\n this.content = 'One';\\n this.isDisabled = false;\\n }\\n\\n render() {\\n return html` <button type=\\\"button\\\" ?disabled=${this.isDisabled}>${this.content}</button> `;\\n }\\n}\\n\\ncustomElements.define('custom-button', CustomButton);\\n```\", \"```\\nimport { LitElement, html } from 'lit';\\nimport { customElement, property } from 'lit/decorators.js';\\n\\n/**\\n * @prop {string} content - The display label of the button\\n * @prop {boolean} isDisabled - Checks if the button should be disabled\\n * @summary This is a custom button element\\n * @tag custom-button\\n */\\n\\n@customElement('custom-button')\\nexport class CustomButton extends LitElement {\\n @property()\\n content?: string = 'One';\\n @property()\\n isDisabled?: boolean = false;\\n\\n render() {\\n return html` <button type=\\\"button\\\" ?disabled=${this.isDisabled}>${this.content}</button> `;\\n }\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 61]\"}, {\"title\": \"Button Group Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { ButtonGroup } from './ButtonGroup.component';\\nimport { Button } from './button.component';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta: Meta<ButtonGroup> = {\\n component: ButtonGroup,\\n decorators: [\\n moduleMetadata({\\n declarations: [Button],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonGroup>;\\n\\nexport const Pair: Story = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport { ButtonGroup } from '../ButtonGroup';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nexport default {\\n component: ButtonGroup,\\n};\\n\\nexport const Pair = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { ButtonGroup } from '../ButtonGroup';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta = {\\n component: ButtonGroup,\\n} satisfies Meta<typeof ButtonGroup>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Pair: Story = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport { ButtonGroup } from '../ButtonGroup';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nexport default {\\n component: ButtonGroup,\\n};\\n\\nexport const Pair = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { ButtonGroup } from '../ButtonGroup';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta = {\\n component: ButtonGroup,\\n} satisfies Meta<typeof ButtonGroup>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Pair: Story = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import ButtonGroup from './ButtonGroup.svelte';\\n\\n //\\ud83d\\udc47 Imports the Button stories\\n import * as ButtonStories from './Button.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: ButtonGroup,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Pair\\\"\\n args={{\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n }}\\n/>\\n```\", \"```\\nimport ButtonGroup from '../ButtonGroup.svelte';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nexport default {\\n component: ButtonGroup,\\n};\\n\\nexport const Pair = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import ButtonGroup from './ButtonGroup.svelte';\\n\\n //\\ud83d\\udc47 Imports the Button stories\\n import * as ButtonStories from './Button.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: ButtonGroup,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Pair\\\"\\n args={{\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport ButtonGroup from './ButtonGroup.svelte';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta = {\\n component: ButtonGroup,\\n} satisfies Meta<typeof ButtonGroup>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Pair: Story = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport ButtonGroup from './ButtonGroup.vue';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nexport default {\\n component: ButtonGroup,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Pair = {\\n render: (args) => ({\\n components: { ButtonGroup },\\n setup() {\\n return { args };\\n },\\n template: '<ButtonGroup v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport ButtonGroup from './ButtonGroup.vue';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta = {\\n component: ButtonGroup,\\n} satisfies Meta<typeof ButtonGroup>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Pair: Story = {\\n render: (args) => ({\\n components: { ButtonGroup },\\n setup() {\\n return { args };\\n },\\n template: '<ButtonGroup v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nexport default {\\n component: 'demo-button-group',\\n};\\n\\nexport const Pair = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n// \\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta: Meta = {\\n component: 'demo-button-group',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Pair: Story = {\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 62]\"}, {\"title\": \"Button Implementation\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Component, Input, Output, EventEmitter } from '@angular/core';\\n\\n@Component({\\n selector: 'button',\\n template: `the component implementation markup`,\\n})\\nexport class ButtonComponent {\\n /**\\n * Is this the principal call to action on the page?\\n */\\n @Input()\\n primary = false;\\n\\n /**\\n * What background color to use\\n */\\n @Input()\\n backgroundColor?: string;\\n\\n /**\\n * How large should the button be?\\n */\\n @Input()\\n size: 'small' | 'medium' | 'large' = 'medium';\\n\\n /**\\n * Button contents\\n *\\n * @required\\n */\\n @Input()\\n label = 'Button';\\n\\n /**\\n * Optional click handler\\n */\\n @Output()\\n onClick = new EventEmitter<Event>();\\n}\\n```\", \"```\\nimport React from 'react';\\n\\nimport PropTypes from 'prop-types';\\n\\n/**\\n * Primary UI component for user interaction\\n */\\nexport const Button = ({ primary, backgroundColor, size, label, ...props }) => {\\n // the component implementation\\n};\\n\\nButton.propTypes = {\\n /**\\n * Is this the principal call to action on the page?\\n */\\n primary: PropTypes.bool,\\n /**\\n * What background color to use\\n */\\n backgroundColor: PropTypes.string,\\n /**\\n * How large should the button be?\\n */\\n size: PropTypes.oneOf(['small', 'medium', 'large']),\\n /**\\n * Button contents\\n */\\n label: PropTypes.string.isRequired,\\n /**\\n * Optional click handler\\n */\\n onClick: PropTypes.func,\\n};\\n```\", \"```\\nexport interface ButtonProps {\\n /**\\n * Is this the principal call to action on the page?\\n */\\n primary?: boolean;\\n /**\\n * What background color to use\\n */\\n backgroundColor?: string;\\n /**\\n * How large should the button be?\\n */\\n size?: 'small' | 'medium' | 'large';\\n /**\\n * Button contents\\n */\\n label: string;\\n /**\\n * Optional click handler\\n */\\n onClick?: () => void;\\n}\\n\\n/**\\n * Primary UI component for user interaction\\n */\\nexport const Button: React.FC<ButtonProps> = ({\\n primary = false,\\n size = 'medium',\\n backgroundColor,\\n label,\\n ...props\\n}) => {\\n // the component implementation\\n};\\n```\", \"```\\n<script>\\n import { createEventDispatcher } from 'svelte';\\n /**\\n * Is this the principal call to action on the page?\\n */\\n export let primary = false;\\n\\n /**\\n * What background color to use\\n */\\n export let backgroundColor = undefined;\\n /**\\n * How large should the button be?\\n */\\n export let size = 'medium';\\n /**\\n * Button contents\\n */\\n export let label = '';\\n\\n $: style = backgroundColor ? `background-color: ${backgroundColor}` : '';\\n\\n const dispatch = createEventDispatcher();\\n\\n /**\\n * Optional click handler\\n */\\n export let onClick = (event) => {\\n dispatch('click', event);\\n };\\n</script>\\n\\n<button type=\\\"button\\\" {style} on:click=\\\"{onClick}\\\">{label}</button>\\n```\", \"```\\n<template> <!-- The component markup implementation --> </template>\\n\\n<script>\\n export default {\\n name: 'button',\\n props: {\\n /**\\n * Button contents\\n */\\n label: {\\n type: String,\\n required: true,\\n },\\n /**\\n * Is this the principal call to action on the page?\\n */\\n primary: {\\n type: Boolean,\\n default: false,\\n },\\n /**\\n * How large should the button be?\\n */\\n size: {\\n type: String,\\n default: 'medium',\\n validator: function (value) {\\n return ['small', 'medium', 'large'].indexOf(value) !== -1;\\n },\\n },\\n /**\\n * What background color to use\\n */\\n backgroundColor: {\\n type: String,\\n },\\n },\\n emits: ['click'],\\n setup(props, { emit }) {\\n props = reactive(props);\\n return {\\n /**\\n * Optional click handler\\n */\\n onClick() {\\n emit('click');\\n },\\n };\\n },\\n };\\n</script>\\n```\", \"```\\n<template> <!-- The component markup implementation --> </template>\\n\\n<script lang=\\\"ts\\\">\\n import { defineComponent, reactive } from 'vue';\\n\\n export default defineComponent({\\n // eslint-disable-next-line vue/multi-word-component-names\\n name: 'button',\\n props: {\\n /**\\n * Button contents\\n */\\n label: {\\n type: String,\\n required: true,\\n },\\n /**\\n * Is this the principal call to action on the page?\\n */\\n primary: {\\n type: Boolean,\\n default: false,\\n },\\n /**\\n * How large should the button be?\\n */\\n size: {\\n type: String,\\n default: 'medium',\\n validator: function (value) {\\n return ['small', 'medium', 'large'].indexOf(value) !== -1;\\n },\\n },\\n /**\\n * What background color to use\\n */\\n backgroundColor: {\\n type: String,\\n },\\n },\\n emits: ['click'],\\n setup(props, { emit }) {\\n props = reactive(props);\\n return {\\n /**\\n * Optional click handler\\n */\\n onClick() {\\n emit('click');\\n },\\n };\\n },\\n });\\n</script>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 63]\"}, {\"title\": \"Button Snapshot Test Portable Stories\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from '../stories/Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\ntest('Button snapshot', async () => {\\n await Primary.run();\\n expect(document.body.firstChild).toMatchSnapshot();\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\nimport { expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from '../stories/Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\ntest('Button snapshot', async () => {\\n await Primary.run();\\n expect(document.body.firstChild).toMatchSnapshot();\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\nimport { expect, test } from 'vitest';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from '../stories/Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\ntest('Button snapshot', async () => {\\n await Primary.run();\\n expect(document.body.firstChild).toMatchSnapshot();\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\nimport { expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from '../stories/Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\ntest('Button snapshot', async () => {\\n await Primary.run();\\n expect(document.body.firstChild).toMatchSnapshot();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 64]\"}, {\"title\": \"Button Story Argtypes With Categories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n },\\n },\\n // Assigns the argType to the Text category\\n label: {\\n table: {\\n category: 'Text',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n },\\n },\\n // Assigns the argType to the Text category\\n label: {\\n table: {\\n category: 'Text',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n },\\n },\\n // Assigns the argType to the Text category\\n label: {\\n table: {\\n category: 'Text',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n },\\n },\\n // Assigns the argType to the Text category\\n label: {\\n table: {\\n category: 'Text',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n },\\n },\\n // Assigns the argType to the Text category\\n label: {\\n table: {\\n category: 'Text',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 65]\"}, {\"title\": \"Button Story Argtypes With Subcategories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n // Assigns the argTypes to a specific subcategory\\n subcategory: 'Button colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n subcategory: 'Button style',\\n },\\n },\\n label: {\\n table: {\\n category: 'Text',\\n subcategory: 'Button contents',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n subcategory: 'Button Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n // Assigns the argTypes to a specific subcategory\\n subcategory: 'Button colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n subcategory: 'Button style',\\n },\\n },\\n label: {\\n table: {\\n category: 'Text',\\n subcategory: 'Button contents',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n subcategory: 'Button Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n // Assigns the argTypes to a specific subcategory\\n subcategory: 'Button colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n subcategory: 'Button style',\\n },\\n },\\n label: {\\n table: {\\n category: 'Text',\\n subcategory: 'Button contents',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n subcategory: 'Button Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n // Assigns the argTypes to a specific subcategory\\n subcategory: 'Button colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n subcategory: 'Button style',\\n },\\n },\\n label: {\\n table: {\\n category: 'Text',\\n subcategory: 'Button contents',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n subcategory: 'Button Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n // Assigns the argTypes to the Colors category\\n backgroundColor: {\\n control: 'color',\\n table: {\\n category: 'Colors',\\n // Assigns the argTypes to a specific subcategory\\n subcategory: 'Button colors',\\n },\\n },\\n primary: {\\n table: {\\n category: 'Colors',\\n subcategory: 'Button style',\\n },\\n },\\n label: {\\n table: {\\n category: 'Text',\\n subcategory: 'Button contents',\\n },\\n },\\n // Assigns the argType to the Events category\\n onClick: {\\n table: {\\n category: 'Events',\\n subcategory: 'Button Events',\\n },\\n },\\n // Assigns the argType to the Sizes category\\n size: {\\n table: {\\n category: 'Sizes',\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 66]\"}, {\"title\": \"Button Story Baseline With Satisfies Story Level\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Example = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n} satisfies Story;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 67]\"}, {\"title\": \"Button Story Baseline With Satisfies\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>; // \\ud83d\\udc48 Satisfies operator being used for stricter type checking.\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 68]\"}, {\"title\": \"Button Story Baseline\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\n//\\ud83d\\udc47 Throws a type error if the args don't match the component props\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n//\\ud83d\\udc47 Throws a type error if the args don't match the component props\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n//\\ud83d\\udc47 Throws a type error if the args don't match the component props\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 69]\"}, {\"title\": \"Button Story Click Handler Args\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { argsToTemplate } from '@storybook/angular';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Text: Story = {\\n render: (args) => ({\\n props: args,\\n // The argsToTemplate helper function converts the args to property and event bindings.\\n // You could also write the template in plain HTML and bind to the component's inputs and outputs yourself:\\n // <storybook-button [\\\"label\\\"]=\\\"label\\\" (onClick)=\\\"onClick($event)\\\">\\n // We don't recommend the latter since it can conflict with how Storybook applies arguments via the Controls panel.\\n // Binding to the component's inputs and outputs yourself will conflict with default values set inside the component's class.\\n // In edge-case scenarios, you may need to define the template yourself, though.\\n template: `<storybook-button ${argsToTemplate(args)}></storybook-button>`,\\n }),\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n render: ({ label, onClick }) => <Button label={label} onClick={onClick} />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text = {\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n render: ({ label, onClick }) => <Button label={label} onClick={onClick} />,\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n render: ({ label, onClick }) => <Button label={label} onClick={onClick} />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text = {\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n render: ({ label, onClick }) => <Button label={label} onClick={onClick} />,\\n};\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nimport { action } from 'storybook/actions';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: ({ label, click }) => ({\\n Component: Button,\\n props: {\\n label,\\n },\\n on: {\\n click,\\n },\\n }),\\n args: {\\n label: 'Hello',\\n click: action('clicked'),\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n render: ({ label, click }) => ({\\n Component: Button,\\n props: {\\n label,\\n },\\n on: {\\n click,\\n },\\n }),\\n args: {\\n label: 'Hello',\\n click: action('clicked'),\\n },\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return {\\n ...args,\\n onClick: action('clicked'),\\n };\\n },\\n template: '<Button @click=\\\"onClick\\\" :label=\\\"label\\\" />',\\n }),\\n args: {\\n label: 'Hello',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return {\\n ...args,\\n onClick: action('clicked'),\\n };\\n },\\n template: '<Button @click=\\\"onClick\\\" :label=\\\"label\\\" />',\\n }),\\n args: {\\n label: 'Hello',\\n },\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'custom-button',\\n};\\n\\nexport const Text = {\\n render: ({ label, onClick }) =>\\n html`<custom-button label=\\\"${label}\\\" @click=${onClick}></custom-button>`,\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'custom-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Text: Story = {\\n render: ({ label, onClick }) =>\\n html`<custom-button label=\\\"${label}\\\" @click=${onClick}></custom-button>`,\\n args: {\\n label: 'Hello',\\n onClick: action('clicked'),\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 70]\"}, {\"title\": \"Button Story Click Handler Simplificated\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n args: {},\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n args: {},\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n args: {},\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n onClick: {},\\n },\\n};\\n\\nexport const Text = {\\n args: {},\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n title: 'Button',\\n component: Button,\\n argTypes: {\\n onClick: {},\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\", \"```\\nexport default {\\n component: 'custom-button',\\n argTypes: {\\n onClick: { action: 'onClick' },\\n },\\n};\\n\\nexport const Text = {\\n args: {},\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'custom-button',\\n argTypes: {\\n onClick: { action: 'onClick' },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Text: Story = {\\n args: {},\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 71]\"}, {\"title\": \"Button Story Click Handler\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Text: Story = {\\n render: () => ({\\n props: {\\n label: 'Button',\\n onClick: action('clicked'),\\n },\\n template: `<storybook-button [label]=\\\"label\\\" (onClick)=\\\"onClick($event)\\\"></storybook-button>`,\\n }),\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: () => <Button label=\\\"Hello\\\" onClick={action('clicked')} />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n render: () => <Button label=\\\"Hello\\\" onClick={action('clicked')} />,\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: () => <Button label=\\\"Hello\\\" onClick={action('clicked')} />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n render: () => <Button label=\\\"Hello\\\" onClick={action('clicked')} />,\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: () => ({\\n Component: Button,\\n props: {\\n label: 'Hello',\\n },\\n on: {\\n click: action('clicked'),\\n },\\n }),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n render: (args) => ({\\n Component: Button,\\n props: args,\\n }),\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Text = {\\n render: () => ({\\n components: { Button },\\n setup() {\\n return {\\n onClick: action('clicked'),\\n };\\n },\\n template: '<Button label=\\\"Hello\\\" @click=\\\"onClick\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Text: Story = {\\n render: () => ({\\n components: { Button },\\n setup() {\\n return {\\n onClick: action('clicked'),\\n };\\n },\\n template: '<Button label=\\\"Hello\\\" @click=\\\"onClick\\\" />',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nimport { action } from 'storybook/actions';\\n\\nexport default {\\n component: 'custom-button',\\n};\\n\\nexport const Text = {\\n render: () => html`<custom-button label=\\\"Hello\\\" @click=${action('clicked')}></custom-button>`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { action } from 'storybook/actions';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'custom-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Text: Story = {\\n render: () => html`<custom-button label=\\\"Hello\\\" @click=${action('clicked')}></custom-button>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 72]\"}, {\"title\": \"Button Story Component Args Primary\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n //\\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n // \\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n // \\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n // \\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n backgroundColor: { control: 'color' },\\n },\\n args: {\\n // \\ud83d\\udc47 Now all Button stories will be primary.\\n primary: true,\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 73]\"}, {\"title\": \"Button Story Component Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { componentWrapperDecorator, moduleMetadata } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nimport { Parent } from './parent.component'; // Parent contains ng-content\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n decorators: [\\n moduleMetadata({\\n declarations: [ParentComponent],\\n }),\\n // With template\\n componentWrapperDecorator((story) => `<div style=\\\"margin: 3em\\\">${story}</div>`),\\n // With component which contains ng-content\\n componentWrapperDecorator(Parent),\\n ],\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { createButton } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n decorators: [\\n (story) => {\\n const decorator = document.createElement('div');\\n decorator.style.margin = '3em';\\n decorator.appendChild(story());\\n return decorator;\\n },\\n ],\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => createButton(args),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createButton, ButtonArgs } from './Button';\\n\\nconst meta: Meta<ButtonArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n decorators: [\\n (story) => {\\n const decorator = document.createElement('div');\\n decorator.style.margin = '3em';\\n decorator.appendChild(story());\\n return decorator;\\n },\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonArgs>;\\n\\nexport const Primary: Story = {\\n render: (args) => createButton(args),\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport type { Meta } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n decorators: [() => MarginDecorator],\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nexport default {\\n component: Button,\\n decorators: [() => MarginDecorator],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n decorators: [() => MarginDecorator],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nconst meta = {\\n component: Button,\\n decorators: [() => MarginDecorator],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story /></div>' })],\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story /></div>' })],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n\\nexport const Example = {};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Example: Story = {};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 74]\"}, {\"title\": \"Button Story Controls Primary Variant\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={{ variant: 'primary' }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={{ variant: 'primary' }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Success = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n args: {\\n variant: 'primary',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 75]\"}, {\"title\": \"Button Story Controls Radio Group\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n variant: {\\n options: ['primary', 'secondary'],\\n control: { type: 'radio' },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 76]\"}, {\"title\": \"Button Story Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { componentWrapperDecorator, moduleMetadata } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nimport { Parent } from './parent.component'; // Parent contains ng-content\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n decorators: [componentWrapperDecorator((story) => `<div style=\\\"margin: 3em\\\">${story}</div>`)],\\n};\\n\\nexport const InsideParent: Story = {\\n decorators: [\\n moduleMetadata({\\n declarations: [Parent],\\n }),\\n componentWrapperDecorator(Parent),\\n ],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n decorators={[\\n () => MarginDecorator\\n ]}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n decorators: [() => MarginDecorator],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n decorators={[\\n () => MarginDecorator\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n decorators: [() => MarginDecorator],\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => ({\\n components: { Button },\\n template: '<Button primary label=\\\"Hello World\\\" />',\\n }),\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story /></div>' })],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button primary label=\\\"Hello World\\\" />',\\n }),\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story /></div>' })],\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 77]\"}, {\"title\": \"Button Story Default Export With Component\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'button',\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n```\", \"```\\nimport type { Meta } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 78]\"}, {\"title\": \"Button Story Default Export\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { createButton } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/html';\\n\\nimport { createButton, ButtonArgs } from './Button';\\n\\nconst meta: Meta<ButtonArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 79]\"}, {\"title\": \"Button Story Disable Addon\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n myAddon: { disable: true }, // Disables the addon\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n parameters: {\\n myAddon: { disable: true }, // Disables the addon\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n parameters: {\\n myAddon: { disable: true }, // Disables the addon\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: {\\n myAddon: { disable: true }, // Disables the addon\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n myAddon: { disable: true }, // Disables the addon\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 80]\"}, {\"title\": \"Button Story Grouped\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Design System/Atoms/Button',\\n component: 'demo-button',\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Design System/Atoms/Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 81]\"}, {\"title\": \"Button Story Hoisted\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button as ButtonComponent } from './button.component';\\n\\nconst meta: Meta<ButtonComponent> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: ButtonComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonComponent>;\\n\\n// This is the only named export in the file, and it matches the component name\\nexport const Button: Story = {};\\n```\", \"```\\nimport { Button as ButtonComponent } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: ButtonComponent,\\n};\\n\\n// This is the only named export in the file, and it matches the component name\\nexport const Button = {};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button as ButtonComponent } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Button',\\n component: ButtonComponent,\\n} satisfies Meta<typeof ButtonComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// This is the only named export in the file, and it matches the component name\\nexport const Button: Story = {};\\n```\", \"```\\nexport default {\\n title: 'Design System/Atoms/Button',\\n component: 'demo-button',\\n};\\n\\n// This is the only named export in the file, and it matches the component name\\nexport const Button = {};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Design System/Atoms/Button',\\n component: 'demo-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n// This is the only named export in the file, and it matches the component name\\nexport const Button: Story = {};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 82]\"}, {\"title\": \"Button Story Hypothetical Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Sample = {\\n render: () => ({\\n template: '<button :label=label />',\\n data: {\\n label: 'hello button',\\n },\\n }),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Sample: Story = {\\n render: () => ({\\n template: '<button :label=label />',\\n data: {\\n label: 'hello button',\\n },\\n }),\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 83]\"}, {\"title\": \"Button Story Matching Argtypes\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: { actions: { argTypesRegex: '^on.*' } },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 84]\"}, {\"title\": \"Button Story Onclick Action Spy\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { fn } from 'storybook/test';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { fn } from 'storybook/test';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n });\\n</script>\\n```\", \"```\\nimport { fn } from 'storybook/test';\\n\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n};\\n```\", \"```\\nimport { fn } from 'storybook/test';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { fn } from 'storybook/test';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { fn } from 'storybook/test';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { fn } from 'storybook/test';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n // \\ud83d\\udc47 Use `fn` to spy on the onClick arg, which will appear in the actions panel once invoked\\n args: { onClick: fn() },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 85]\"}, {\"title\": \"Button Story Primary Composition\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n\\n const primaryArgs = {\\n primary: true,\\n label: 'Button',\\n }\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={primaryArgs} />\\n\\n<Story name=\\\"Secondary\\\" args={{...primaryArgs, primary: false}} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n\\n const primaryArgs = {\\n primary: true,\\n label: 'Button',\\n }\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={primaryArgs} />\\n\\n<Story name=\\\"Secondary\\\" args={{...primaryArgs, primary: false}} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n primary: false,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 86]\"}, {\"title\": \"Button Story Primary Long Name\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName: Story = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n\\n const primaryArgs = {\\n primary: true,\\n label: 'Button',\\n }\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={primaryArgs} />\\n\\n<Story name=\\\"PrimaryLongName\\\"\\n args={{\\n ...primaryArgs,\\n label: 'Primary with a really long name'\\n }} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n\\n const primaryArgs = {\\n primary: true,\\n label: 'Button',\\n }\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={primaryArgs} />\\n\\n<Story name=\\\"PrimaryLongName\\\"\\n args={{\\n ...primaryArgs,\\n label: 'Primary with a really long name'\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName: Story = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName: Story = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryLongName: Story = {\\n args: {\\n ...Primary.args,\\n label: 'Primary with a really long name',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 87]\"}, {\"title\": \"Button Story Rename Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport { createButton } from './Button';\\n\\nexport default {\\n render: (args) => createButton(args),\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createButton, ButtonArgs } from './Button';\\n\\nconst meta: Meta<ButtonArgs> = {\\n render: (args) => createButton(args),\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonArgs>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n {/* \\ud83d\\udc47 Friendly name */}\\n name=\\\"I am the primary\\\"\\n {/* \\ud83d\\udc47 Unique export name */}\\n exportName=\\\"Primary\\\"\\n/>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n {/* \\ud83d\\udc47 Friendly name */}\\n name=\\\"I am the primary\\\"\\n {/* \\ud83d\\udc47 Unique export name */}\\n exportName=\\\"Primary\\\"\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Rename this story\\n name: 'I am the primary',\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 88]\"}, {\"title\": \"Button Story Using Args\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport { createButton } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => createButton(args),\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n render: (args) => createButton(args),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary = {\\n render: (args) => createButton(args),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\nimport { createButton, ButtonArgs } from './Button';\\n\\nconst meta: Meta<ButtonArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonArgs>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => createButton(args),\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n render: (args) => createButton(args),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n render: (args) => createButton(args),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n backgroundColor: '#ff0',\\n label: 'Button',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Secondary\\\"\\n args={{\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Tertiary\\\"\\n args={{\\n backgroundColor:'#ff0',\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n backgroundColor: '#ff0',\\n label: 'Button',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Secondary\\\"\\n args={{\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Tertiary\\\"\\n args={{\\n backgroundColor:'#ff0',\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n};\\n\\nexport const Tertiary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n background: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n args: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n};\\n\\nexport const Secondary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n};\\n\\nexport const Tertiary: Story = {\\n args: {\\n ...Primary.args,\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 89]\"}, {\"title\": \"Button Story With Addon Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'this data is passed to the addon',\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic: Story = {\\n render: () => ({\\n template: `<app-button>hello</<app-button>`,\\n }),\\n};\\n```\", \"```\\nimport React from 'react';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n};\\n\\nexport const Basic = {\\n render: () => <Button>Hello</Button>,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic: Story = {\\n render: () => <Button>Hello</Button>,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n};\\n\\nexport const Basic = {\\n render: () => <Button>Hello</Button>,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'this data is passed to the addon',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic: Story = {\\n render: () => <Button>Hello</Button>,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Basic\\\"/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'this data is passed to the addon',\\n },\\n },\\n};\\n\\nexport const Basic = {};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n });\\n</script>\\n\\n<Story name=\\\"Basic\\\"/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'this data is passed to the addon',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n};\\n\\nexport const Basic = {\\n render: () => ({\\n components: { Button },\\n template: '<Button label=\\\"Hello\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button label=\\\"Hello\\\" />',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'Button',\\n component: 'custom-button',\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic = {\\n render: () => html`<custom-button label=\\\"Hello\\\"></custom-button>`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'custom-button',\\n //\\ud83d\\udc47 Creates specific parameters for the story\\n parameters: {\\n myAddon: {\\n data: 'This data is passed to the addon',\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Basic: Story = {\\n render: () => html`<custom-button label=\\\"Hello\\\"></custom-button>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 90]\"}, {\"title\": \"Button Story With Args\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular/';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => {\\n const btn = document.createElement('button');\\n btn.innerText = args.label;\\n\\n const mode = args.primary ? 'storybook-button--primary' : 'storybook-button--secondary';\\n btn.className = ['storybook-button', 'storybook-button--medium', mode].join(' ');\\n\\n return btn;\\n },\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\ntype ButtonArgs = {\\n primary: boolean;\\n label: string;\\n};\\n\\nconst meta: Meta<ButtonArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonArgs>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => {\\n const btn = document.createElement('button');\\n btn.innerText = args.label;\\n\\n const mode = args.primary ? 'storybook-button--primary' : 'storybook-button--secondary';\\n btn.className = ['storybook-button', 'storybook-button--medium', mode].join(' ');\\n\\n return btn;\\n },\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\n/** @jsx h */\\nimport { h } from 'preact';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => <Button {...args} />,\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n label: 'Button',\\n primary: true,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n primary: true,\\n label: 'Button'\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n primary: true,\\n label: 'Button'\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 91]\"}, {\"title\": \"Button Story With Emojis\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n props: {\\n label: 'Button',\\n backgroundColor: '#ff0',\\n },\\n }),\\n};\\n\\nexport const Secondary: Story = {\\n render: () => ({\\n props: {\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n backgroundColor: '#ff0',\\n },\\n }),\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => ({\\n props: {\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n backgroundColor: '#ff0',\\n },\\n }),\\n};\\n```\", \"```\\nimport { createButton } from './Button';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: 'Button' }),\\n};\\n\\nexport const Secondary = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf' }),\\n};\\n\\nexport const Tertiary = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13' }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\nimport { createButton, ButtonArgs } from './Button';\\n\\nconst meta: Meta<ButtonArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ButtonArgs>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: 'Button' }),\\n};\\n\\nexport const Secondary: Story = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf' }),\\n};\\n\\nexport const Tertiary: Story = {\\n render: (args) => createButton({ backgroundColor: '#ff0', label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13' }),\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />,\\n};\\n\\nexport const Secondary = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />,\\n};\\n\\nexport const Tertiary = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />,\\n};\\n\\nexport const Secondary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />,\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />,\\n};\\n\\nexport const Secondary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />,\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />\\n</Story>\\n\\n<Story name=\\\"Secondary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />\\n</Story>\\n\\n<Story name=\\\"Tertiary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />\\n</Story>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n }),\\n};\\n\\nexport const Secondary = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n }),\\n};\\n\\nexport const Tertiary = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n }),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />\\n</Story>\\n\\n<Story name=\\\"Secondary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />\\n</Story>\\n\\n<Story name=\\\"Tertiary\\\">\\n <Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/svelte/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: 'Button',\\n },\\n }),\\n};\\n\\nexport const Secondary: Story = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf',\\n },\\n }),\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => ({\\n Component: Button,\\n props: {\\n backgroundColor: '#ff0',\\n label: '\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13',\\n },\\n }),\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />',\\n }),\\n};\\n\\nexport const Secondary = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />',\\n }),\\n};\\n\\nexport const Tertiary = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof Button>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"Button\\\" />',\\n }),\\n};\\n\\nexport const Secondary: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\" />',\\n }),\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button backgroundColor=\\\"#ff0\\\" label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\" />',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"Button\\\"></demo-button>`,\\n};\\n\\nexport const Secondary = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\"></demo-button>`,\\n};\\n\\nexport const Tertiary = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\"></demo-button>`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"Button\\\"></demo-button>`,\\n};\\n\\nexport const Secondary: Story = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"\\ud83d\\ude04\\ud83d\\udc4d\\ud83d\\ude0d\\ud83d\\udcaf\\\"></demo-button>`,\\n};\\n\\nexport const Tertiary: Story = {\\n render: () => html`<demo-button .backgroundColor=\\\"#ff0\\\" .label=\\\"\\ud83d\\udcda\\ud83d\\udcd5\\ud83d\\udcc8\\ud83e\\udd13\\\"></demo-button>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 92]\"}, {\"title\": \"Button Story With Sample\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Sample = {\\n render: () => <Button label=\\\"hello button\\\" />,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Sample = {\\n render: () => <Button label=\\\"hello button\\\" />,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 93]\"}, {\"title\": \"Button Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n props: {\\n label: 'Button',\\n primary: true,\\n },\\n }),\\n};\\n```\", \"```\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => {\\n const btn = document.createElement('button');\\n btn.innerText = 'Button';\\n\\n btn.className = [\\n 'storybook-button',\\n 'storybook-button--medium',\\n 'storybook-button--primary',\\n ].join(' ');\\n\\n return btn;\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nconst meta: Meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Button',\\n};\\n\\nexport default meta;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: StoryObj = {\\n render: () => {\\n const btn = document.createElement('button');\\n btn.innerText = 'Button';\\n\\n btn.className = [\\n 'storybook-button',\\n 'storybook-button--medium',\\n 'storybook-button--primary',\\n ].join(' ');\\n\\n return btn;\\n },\\n};\\n```\", \"```\\n/** @jsx h */\\nimport { h } from 'preact';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => <Button primary label=\\\"Button\\\" />,\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => <Button primary label=\\\"Button\\\" />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => <Button primary label=\\\"Button\\\" />,\\n};\\n```\", \"```\\nimport React, { useState } from 'react';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n * Example Button story with React Hooks.\\n * See note below related to this example.\\n */\\nconst ButtonWithHooks = () => {\\n // Sets the hooks for both the label and primary props\\n const [value, setValue] = useState('Secondary');\\n const [isPrimary, setIsPrimary] = useState(false);\\n\\n // Sets a click handler to change the label's value\\n const handleOnChange = () => {\\n if (!isPrimary) {\\n setIsPrimary(true);\\n setValue('Primary');\\n }\\n };\\n return <Button primary={isPrimary} onClick={handleOnChange} label={value} />;\\n};\\n\\nexport const Primary = {\\n render: () => <ButtonWithHooks />,\\n};\\n```\", \"```\\nimport React, { useState } from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * Example Button story with React Hooks.\\n * See note below related to this example.\\n */\\nconst ButtonWithHooks = () => {\\n // Sets the hooks for both the label and primary props\\n const [value, setValue] = useState('Secondary');\\n const [isPrimary, setIsPrimary] = useState(false);\\n\\n // Sets a click handler to change the label's value\\n const handleOnChange = () => {\\n if (!isPrimary) {\\n setIsPrimary(true);\\n setValue('Primary');\\n }\\n };\\n return <Button primary={isPrimary} onClick={handleOnChange} label={value} />;\\n};\\n\\nexport const Primary = {\\n render: () => <ButtonWithHooks />,\\n} satisfies Story;\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => <Button primary label=\\\"Button\\\" />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => <Button primary label=\\\"Button\\\" />,\\n};\\n```\", \"```\\nimport { createSignal } from 'solid-js';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n * Example Button story with Solid Hooks.\\n * See note below related to this example.\\n */\\nconst ButtonWithHooks = () => {\\n // Sets the hooks for both the label and primary props\\n const [value, setValue] = createSignal('Secondary');\\n const [isPrimary, setIsPrimary] = createSignal(false);\\n\\n // Sets a click handler to change the label's value\\n const handleOnChange = () => {\\n if (!isPrimary()) {\\n setIsPrimary(true);\\n setValue('Primary');\\n }\\n };\\n return <Button primary={isPrimary()} onClick={handleOnChange} label={value()} />;\\n};\\n\\nexport const Primary = {\\n render: () => <ButtonWithHooks />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { createSignal } from 'solid-js';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * Example Button story with Solid Hooks.\\n * See note below related to this example.\\n */\\nconst ButtonWithHooks = () => {\\n // Sets the hooks for both the label and primary props\\n const [value, setValue] = createSignal('Secondary');\\n const [isPrimary, setIsPrimary] = createSignal(false);\\n\\n // Sets a click handler to change the label's value\\n const handleOnChange = () => {\\n if (!isPrimary()) {\\n setIsPrimary(true);\\n setValue('Primary');\\n }\\n };\\n return <Button primary={isPrimary()} onClick={handleOnChange} label={value()} />;\\n};\\n\\nexport const Primary = {\\n render: () => <ButtonWithHooks />,\\n} satisfies Story;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={{ primary: true, label: 'Button' }} />\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story name=\\\"Primary\\\" args={{ primary: true, label: 'Button' }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n Component: Button,\\n props: {\\n primary: true,\\n label: 'Button',\\n },\\n }),\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: () => ({\\n components: { Button },\\n template: '<Button primary label=\\\"Button\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: () => ({\\n components: { Button },\\n template: '<Button primary label=\\\"Button\\\" />',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n render: () => html`<demo-button primary></demo-button>`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n render: () => html`<demo-button primary></demo-button>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 94]\"}, {\"title\": \"Checkbox Story Csf\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Checkbox } from './checkbox.component';\\n\\nconst meta: Meta<Checkbox> = {\\n component: Checkbox,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Checkbox>;\\n\\nexport const Unchecked: Story = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Checkbox from './Checkbox.svelte';\\n\\n const { Story } = defineMeta({\\n component: Checkbox,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Unchecked\\\"\\n args={{\\n label: 'Unchecked',\\n }}\\n/>\\n```\", \"```\\nimport Checkbox from './Checkbox.svelte';\\n\\nexport default {\\n component: Checkbox,\\n};\\n\\nexport const Unchecked = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\nimport { Checkbox } from './Checkbox';\\n\\nexport default {\\n component: Checkbox,\\n};\\n\\nexport const Unchecked = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Checkbox from './Checkbox.svelte';\\n\\n const { Story } = defineMeta({\\n component: Checkbox,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Unchecked\\\"\\n args={{\\n label: 'Unchecked',\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Checkbox from './Checkbox.svelte';\\n\\nconst meta = {\\n component: Checkbox,\\n} satisfies Meta<typeof Checkbox>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Unchecked: Story = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Checkbox } from './Checkbox';\\n\\nconst meta = {\\n component: Checkbox,\\n} satisfies Meta<typeof Checkbox>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Unchecked: Story = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\nexport default {\\n title: 'Checkbox',\\n component: 'checkbox',\\n};\\n\\nexport const Unchecked = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'checkbox-element',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Unchecked: Story = {\\n args: {\\n label: 'Unchecked',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 95]\"}, {\"title\": \"Checkbox Story Grouped\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Checkbox } from './checkbox.component';\\n\\nconst meta: Meta<Checkbox> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import CheckBox from './Checkbox.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n });\\n</script>\\n```\", \"```\\nimport CheckBox from './Checkbox.svelte';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n};\\n```\", \"```\\nimport { CheckBox } from './Checkbox';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import CheckBox from './Checkbox.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport CheckBox from './Checkbox.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n} satisfies Meta<typeof CheckBox>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { CheckBox } from './Checkbox';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Design System/Atoms/Checkbox',\\n component: CheckBox,\\n} satisfies Meta<typeof CheckBox>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Design System/Atoms/Checkbox',\\n component: 'demo-checkbox',\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Design System/Atoms/Checkbox',\\n component: 'demo-checkbox',\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 96]\"}, {\"title\": \"Checkbox Story\", \"description\": null, \"content\": {\"Checkbox\": \"A checkbox is a square box that can be activated or deactivated when ticked.\\n\\nUse checkboxes to select one or more options from a list of choices.\\n\\n<Canvas of={CheckboxStories.Unchecked} />\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 97]\"}, {\"title\": \"Chromatic Github Action\", \"description\": null, \"content\": {\"root\": [\"```\\n# Workflow name\\nname: 'Chromatic Publish'\\n\\n# Event for the workflow\\non: push\\n\\n# List of jobs\\njobs:\\n test:\\n # Operating System\\n runs-on: ubuntu-latest\\n # Job steps\\n steps:\\n - uses: actions/checkout@v4\\n with:\\n fetch-depth: 0\\n - uses: actions/setup-node@v4\\n with:\\n node-version: 20\\n cache: 'yarn'\\n - run: yarn\\n #\\ud83d\\udc47 Adds Chromatic as a step in the workflow\\n - uses: chromaui/action@latest\\n # Options required for Chromatic's GitHub Action\\n with:\\n #\\ud83d\\udc47 Chromatic projectToken,\\n projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}\\n token: ${{ secrets.GITHUB_TOKEN }}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 98]\"}, {\"title\": \"Chromatic Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install chromatic --save-dev\\n```\", \"```\\npnpm add --save-dev chromatic\\n```\", \"```\\nyarn add --dev chromatic\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 99]\"}, {\"title\": \"Chromatic Storybook Add\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @chromatic-com/storybook\\n```\", \"```\\npnpm dlx storybook@latest add @chromatic-com/storybook\\n```\", \"```\\nyarn dlx storybook@latest add @chromatic-com/storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 100]\"}, {\"title\": \"Code Panel Enable In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n docs: {\\n codePanel: true,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using (e.g., react-vite, vue3-vite, angular, etc.)\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n codePanel: true,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 101]\"}, {\"title\": \"Code Panel In Meta And Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<typeof Button>;\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary: Story = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary: Story = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/react-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary: Story = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary: Story = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n children: 'Button',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Secondary\\\"\\n args={{\\n children: 'Button',\\n variant: 'secondary',\\n }}\\n parameters={{\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary: Story = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary: Story = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"Primary\\\"\\n args={{\\n children: 'Button',\\n }}\\n/>\\n\\n<Story\\n name=\\\"Secondary\\\"\\n args={{\\n children: 'Button',\\n variant: 'secondary',\\n }}\\n parameters={{\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary: Story = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary: Story = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary: Story = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary: Story = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Enable Code panel for all stories in this file\\n codePanel: true,\\n },\\n },\\n};\\n\\n// \\ud83d\\udc47 This story will display the Code panel\\nconst Primary = {\\n args: {\\n children: 'Button',\\n },\\n};\\n\\nconst Secondary = {\\n args: {\\n children: 'Button',\\n variant: 'secondary',\\n },\\n parameters: {\\n docs: {\\n // \\ud83d\\udc47 Disable Code panel for this specific story\\n codePanel: false,\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 102]\"}, {\"title\": \"Compodoc Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install @compodoc/compodoc --save-dev\\n```\", \"```\\npnpm add --save-dev @compodoc/compodoc\\n```\", \"```\\nyarn add --dev @compodoc/compodoc\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 103]\"}, {\"title\": \"Component Cypress Test\", \"description\": null, \"content\": {\"root\": [\"```\\n/// <reference types=\\\"cypress\\\" />\\n\\ndescribe('Login Form', () => {\\n it('Should contain valid login information', () => {\\n cy.visit('/iframe.html?id=components-login-form--example');\\n cy.get('#login-form').within(() => {\\n cy.log('**enter the email**');\\n cy.get('#email').should('have.value', 'email@provider.com');\\n cy.log('**enter password**');\\n cy.get('#password').should('have.value', 'a-random-password');\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 104]\"}, {\"title\": \"Component Playwright Test\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test, expect } from '@playwright/test';\\n\\ntest('Login Form inputs', async ({ page }) => {\\n await page.goto('http://localhost:6006/iframe.html?id=components-login-form--example');\\n const email = await page.inputValue('#email');\\n const password = await page.inputValue('#password');\\n await expect(email).toBe('email@provider.com');\\n await expect(password).toBe('a-random-password');\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 105]\"}, {\"title\": \"Component Story Conditional Controls Mutual Exclusion\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n // Button can be passed a label or an image, not both\\n label: {\\n control: 'text',\\n if: { arg: 'image', truthy: false },\\n },\\n image: {\\n control: { type: 'select', options: ['foo.jpg', 'bar.jpg'] },\\n if: { arg: 'label', truthy: false },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 106]\"}, {\"title\": \"Component Story Conditional Controls Toggle\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n label: { control: 'text' }, // Always shows the control\\n advanced: { control: 'boolean' },\\n // Only enabled if advanced is true\\n margin: { control: 'number', if: { arg: 'advanced' } },\\n padding: { control: 'number', if: { arg: 'advanced' } },\\n cornerRadius: { control: 'number', if: { arg: 'advanced' } },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 107]\"}, {\"title\": \"Component Story Custom Args Complex\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { YourComponent } from './your-component.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<YourComponent>;\\n\\nconst someFunction = (valuePropertyA: String, valuePropertyB: String) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory: Story = {\\n render: (args) => {\\n const { propertyA, propertyB } = args;\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(propertyA, propertyB);\\n return {\\n props: {\\n ...args,\\n someProperty: someFunctionResult,\\n },\\n };\\n },\\n args: { propertyA: 'Item One', propertyB: 'Another Item One' },\\n};\\n```\", \"```\\nimport { YourComponent } from './your-component';\\n\\nexport default {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory = {\\n render: (args) => {\\n const { propertyA, propertyB } = args;\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(propertyA, propertyB);\\n\\n return <YourComponent {...args} someProperty={someFunctionResult} />;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './your-component';\\n\\nconst meta = {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory: Story = {\\n render: (args) => {\\n const { propertyA, propertyB } = args;\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(propertyA, propertyB);\\n\\n return <YourComponent {...args} someProperty={someFunctionResult} />;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport { createSignal, createEffect } from 'solid-js';\\n\\nimport { YourComponent } from './your-component';\\n\\nexport default {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory = {\\n render: (args) => {\\n const [someFunctionResult, setSomeFunctionResult] = createSignal();\\n\\n //\\ud83d\\udc47 Assigns the function result to a signal\\n createEffect(() => {\\n setSomeFunctionResult(someFunction(args.propertyA, args.propertyB));\\n });\\n\\n return <YourComponent {...args} someProperty={someFunctionResult()} />;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { createSignal, createEffect } from 'solid-js';\\n\\nimport { YourComponent } from './your-component';\\n\\nconst meta = {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory: Story = {\\n render: (args) => {\\n const [someFunctionResult, setSomeFunctionResult] = createSignal();\\n\\n //\\ud83d\\udc47 Assigns the function result to a signal\\n createEffect(() => {\\n setSomeFunctionResult(someFunction(args.propertyA, args.propertyB));\\n });\\n\\n return <YourComponent {...args} someProperty={someFunctionResult()} />;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n });\\n\\n const someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n };\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n }}\\n>\\n {#snippet template(args)}\\n <YourComponent\\n {...args}\\n someProperty={someFunction(args.propertyA, args.propertyB)}\\n />\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\nexport default {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory = {\\n render: (args) => {\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(args.propertyA, args.propertyB);\\n return {\\n Component: YourComponent,\\n props: {\\n ...args,\\n someProperty: someFunctionResult,\\n },\\n };\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n });\\n\\n const someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n };\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n }}\\n>\\n {#snippet template(args)}\\n <YourComponent\\n {...args}\\n someProperty={someFunction(args.propertyA, args.propertyB)}\\n />\\n {/snippet}\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory: Story = {\\n render: (args) => {\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(args.propertyA, args.propertyB);\\n return {\\n Component: YourComponent,\\n props: {\\n ...args,\\n someProperty: someFunctionResult,\\n },\\n };\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport YourComponent from './YourComponent.vue';\\n\\nexport default {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory = {\\n render: ({ args }) => {\\n const { propertyA, propertyB } = args;\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const functionResult = someFunction(propertyA, propertyB);\\n return {\\n components: { YourComponent },\\n setup() {\\n return {\\n ...args,\\n //\\ud83d\\udc47 Replaces arg variable with the override (without the need of mutation)\\n someProperty: functionResult,\\n };\\n },\\n template:\\n '<YourComponent :propertyA=\\\"propertyA\\\" :propertyB=\\\"propertyB\\\" :someProperty=\\\"someProperty\\\"/>',\\n };\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport YourComponent from './YourComponent.vue';\\n\\nconst meta = {\\n component: YourComponent,\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n render: ({ args }) => {\\n const { propertyA, propertyB } = args;\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const functionResult = someFunction(propertyA, propertyB);\\n return {\\n components: { YourComponent },\\n setup() {\\n return {\\n ...args,\\n //\\ud83d\\udc47 Replaces arg variable with the override (without the need of mutation)\\n someProperty: functionResult,\\n };\\n },\\n template:\\n '<YourComponent :propertyA=\\\"propertyA\\\" :propertyB=\\\"propertyB\\\" :someProperty=\\\"someProperty\\\"/>',\\n };\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'custom-component',\\n //\\ud83d\\udc47 Creates specific argTypes\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nconst someFunction = (valuePropertyA, valuePropertyB) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory = {\\n render: ({ propertyA, propertyB }) => {\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(propertyA, propertyB);\\n\\n return html`\\n <custom-component\\n .propertyA=${propertyA}\\n .propertyB=${propertyB}\\n .someProperty=${someFunctionResult}\\n ></custom-component>\\n `;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'custom-component',\\n //\\ud83d\\udc47 Creates specific argTypes with options\\n argTypes: {\\n propertyA: {\\n options: ['Item One', 'Item Two', 'Item Three'],\\n control: { type: 'select' }, // Automatically inferred when 'options' is defined\\n },\\n propertyB: {\\n options: ['Another Item One', 'Another Item Two', 'Another Item Three'],\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nconst someFunction = (valuePropertyA: any, valuePropertyB: any) => {\\n // Do some logic here\\n};\\n\\nexport const ExampleStory: Story = {\\n render: ({ propertyA, propertyB }) => {\\n //\\ud83d\\udc47 Assigns the function result to a variable\\n const someFunctionResult = someFunction(propertyA, propertyB);\\n\\n return html`\\n <custom-component\\n .propertyA=${propertyA}\\n .propertyB=${propertyB}\\n .someProperty=${someFunctionResult}\\n ></custom-component>\\n `;\\n },\\n args: {\\n propertyA: 'Item One',\\n propertyB: 'Another Item One',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 108]\"}, {\"title\": \"Component Story Custom Args Icons\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport Icon from './icon.component';\\n\\nimport { IconA, IconB, IconC, IconD, IconE } from './icons';\\n\\n// Maps the icons to a JSON serializable object to be safely used with the argTypes\\nconst iconMap = { IconA, IconB, IconC, IconD, IconE };\\n\\nconst meta: Meta<Icon> = {\\n title: 'My Story with Icons',\\n component: Icon,\\n argTypes: {\\n icon: {\\n options: Object.keys(iconMap),\\n },\\n },\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Icon>;\\n\\nconst Template: Story = (args) => {\\n // retrieves the appropriate icon passes it as a component prop\\n const { icon } = args;\\n const selectedIcon = iconMap[icon];\\n return {\\n component: Icon,\\n props: {\\n ...args,\\n icon: selectedIcon,\\n },\\n };\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 109]\"}, {\"title\": \"Component Story Custom Args Mapping\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n import { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\n const arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nexport default {\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n import { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\n const arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\n const { Story } = defineMeta({\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nconst meta = {\\n component: Button,\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nexport default {\\n component: 'demo-button',\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nimport { ArrowUp, ArrowDown, ArrowLeft, ArrowRight } from './icons';\\n\\nconst arrows = { ArrowUp, ArrowDown, ArrowLeft, ArrowRight };\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n argTypes: {\\n arrow: {\\n options: Object.keys(arrows), // An array of serializable values\\n mapping: arrows, // Maps serializable option values to complex arg values\\n control: {\\n type: 'select', // Type 'select' is automatically inferred when 'options' is defined\\n labels: {\\n // 'labels' maps option values to string labels\\n ArrowUp: 'Up',\\n ArrowDown: 'Down',\\n ArrowLeft: 'Left',\\n ArrowRight: 'Right',\\n },\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 110]\"}, {\"title\": \"Component Story Disable Controls Alt\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { YourComponent } from './YourComponent.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\nexport default {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'your-component',\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'your-component',\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n control: false,\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 111]\"}, {\"title\": \"Component Story Disable Controls Regex\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { YourComponent } from './YourComponent.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<YourComponent>;\\n\\nexport const ArrayInclude: Story = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude: Story = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude: Story = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude: Story = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ArrayInclude\\\"\\n parameters={{\\n controls: { include: ['foo', 'bar'] },\\n }}\\n/>\\n\\n<Story\\n name=\\\"RegexInclude\\\"\\n parameters={{\\n controls: { include: /^hello*/ },\\n }}\\n/>\\n\\n<Story\\n name=\\\"ArrayExclude\\\"\\n parameters={{\\n controls: { exclude: ['foo', 'bar'] },\\n }}\\n/>\\n\\n<Story\\n name=\\\"RegexExclude\\\"\\n parameters={{\\n controls: { exclude: /^hello*/ },\\n }}\\n/>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\nexport default {\\n component: YourComponent,\\n};\\n\\nexport const ArrayInclude = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n};\\n\\nexport const ArrayInclude = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ArrayInclude\\\"\\n parameters={{\\n controls: { include: ['foo', 'bar'] },\\n }}\\n/>\\n\\n<Story\\n name=\\\"RegexInclude\\\"\\n parameters={{\\n controls: { include: /^hello*/ },\\n }}\\n/>\\n\\n<Story\\n name=\\\"ArrayExclude\\\"\\n parameters={{\\n controls: { exclude: ['foo', 'bar'] },\\n }}\\n/>\\n\\n<Story\\n name=\\\"RegexExclude\\\"\\n parameters={{\\n controls: { exclude: /^hello*/ },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ArrayInclude: Story = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude: Story = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude: Story = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude: Story = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ArrayInclude: Story = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude: Story = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude: Story = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude: Story = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'your-component',\\n};\\n\\nexport const ArrayInclude = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'your-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ArrayInclude: Story = {\\n parameters: {\\n controls: { include: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexInclude: Story = {\\n parameters: {\\n controls: { include: /^hello*/ },\\n },\\n};\\n\\nexport const ArrayExclude: Story = {\\n parameters: {\\n controls: { exclude: ['foo', 'bar'] },\\n },\\n};\\n\\nexport const RegexExclude: Story = {\\n parameters: {\\n controls: { exclude: /^hello*/ },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 112]\"}, {\"title\": \"Component Story Disable Controls\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { YourComponent } from './YourComponent.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\nexport default {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'your-component',\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'your-component',\\n argTypes: {\\n // foo is the property we want to remove from the UI\\n foo: {\\n table: {\\n disable: true,\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 113]\"}, {\"title\": \"Component Story Figma Integration\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Example = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Example = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Example\\\"\\n parameters={{\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n }}\\n/>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Example = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Example\\\"\\n parameters={{\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\n// More on default export: https://storybook.js.org/docs/svelte/writing-stories/introduction#default-export\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Example = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\n// More on default export: https://storybook.js.org/docs/writing-stories/#default-export\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const Example = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Example: Story = {\\n parameters: {\\n design: {\\n type: 'figma',\\n url: 'https://www.figma.com/file/Sample-File',\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 114]\"}, {\"title\": \"Component Story Highlight\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Highlighted: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Highlighted = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Highlighted: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Highlighted\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Highlighted = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Highlighted\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Highlighted: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Highlighted = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Highlighted: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const Highlighted = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Highlighted: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n });\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 115]\"}, {\"title\": \"Component Story Sort Controls\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from from '@storybook/angular';\\n\\nimport { YourComponent } from './YourComponent.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n });\\n</script>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\nexport default {\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n parameters: { controls: { sort: 'requiredFirst' } },\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'your-component',\\n parameters: { controls: { sort: 'requiredFirst' } },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'your-component',\\n parameters: { controls: { sort: 'requiredFirst' } },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 116]\"}, {\"title\": \"Component Story Static Asset Cdn\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n props: {\\n src: 'https://storybook.js.org/images/placeholders/350x150.png',\\n alt: 'My CDN placeholder',\\n },\\n }),\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const WithAnImage = {\\n render: () => (\\n <img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\" />\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => (\\n <img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\" />\\n ),\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const WithAnImage = {\\n render: () => (\\n <img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\" />\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => (\\n <img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\" />\\n ),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent\\n src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\"\\n alt=\\\"My CDN placeholder\\\"\\n />\\n</Story>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const WithAnImage = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n src: 'https://storybook.js.org/images/placeholders/350x150.png',\\n alt: 'My CDN placeholder',\\n },\\n }),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent\\n src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\"\\n alt=\\\"My CDN placeholder\\\"\\n />\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n src: 'https://storybook.js.org/images/placeholders/350x150.png',\\n alt: 'My CDN placeholder',\\n },\\n }),\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const WithAnImage = {\\n render: () => ({\\n template:\\n '<img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\"/>',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n template:\\n '<img src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\" alt=\\\"My CDN placeholder\\\"/>',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const WithAnImage = {\\n render: () =>\\n html`<img\\n src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\"\\n alt=\\\"My CDN placeholder\\\"\\n />`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const WithAnImage: Story = {\\n render: () =>\\n html`<img\\n src=\\\"https://storybook.js.org/images/placeholders/350x150.png\\\"\\n alt=\\\"My CDN placeholder\\\"\\n />`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 117]\"}, {\"title\": \"Component Story Static Asset With Import\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nimport imageFile from './static/image.png';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n props: {\\n src: image.src,\\n alt: image.alt,\\n },\\n template: `<img src=\\\"{{src}}\\\" alt=\\\"{{alt}}\\\" />`,\\n }),\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nimport imageFile from './static/image.png';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage = {\\n render: () => <img src={image.src} alt={image.alt} />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport imageFile from './static/image.png';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage: Story = {\\n render: () => <img src={image.src} alt={image.alt} />,\\n};\\n```\", \"```\\nimport imageFile from './static/image.png';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage = {\\n render: () => <img src={image.src} alt={image.alt} />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport imageFile from './static/image.png';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage: Story = {\\n render: () => <img src={image.src} alt={image.alt} />,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n import imageFile from './static/image.png';\\n\\n let image = {\\n src: imageFile,\\n alt: 'my image',\\n };\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent {image} />\\n</Story>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nimport imageFile from './static/image.png';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage = {\\n render: () => ({\\n Component: MyComponent,\\n props: image,\\n }),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n import imageFile from './static/image.png';\\n\\n let image = {\\n src: imageFile,\\n alt: 'my image',\\n };\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent {image} />\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nimport imageFile from './static/image.png';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n Component: MyComponent,\\n props: image,\\n }),\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nimport imageFile from './static/image.png';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage = {\\n render: () => ({\\n setup() {\\n //\\ud83d\\udc47 Returns the content of the image object create above.\\n return { image };\\n },\\n template: `<img v-bind=\\\"image\\\"/>`,\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nimport imageFile from './static/image.png';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n setup() {\\n //\\ud83d\\udc47 Returns the content of the image object create above.\\n return { image };\\n },\\n template: `<img v-bind=\\\"image\\\"/>`,\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nimport imageFile from './static/image.png';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport const WithAnImage = {\\n render: () => html`<img src=\\\"${image.src}\\\" alt=\\\"${image.alt}\\\" /> `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nimport imageFile from './static/image.png';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nconst image = {\\n src: imageFile,\\n alt: 'my image',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const WithAnImage: Story = {\\n render: () => html`<img src=\\\"${image.src}\\\" alt=\\\"${image.alt}\\\" />`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 118]\"}, {\"title\": \"Component Story Static Asset Without Import\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage: Story = {\\n render: () => ({\\n props: {\\n src: '/image.png',\\n alt: 'my image',\\n },\\n }),\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage = {\\n render: () => <img src=\\\"/image.png\\\" alt=\\\"my image\\\" />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage: Story = {\\n render: () => <img src=\\\"/image.png\\\" alt=\\\"my image\\\" />,\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage = {\\n render: () => <img src=\\\"/image.png\\\" alt=\\\"my image\\\" />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage: Story = {\\n render: () => <img src=\\\"/image.png\\\" alt=\\\"my image\\\" />,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent src=\\\"/image.png\\\" alt=\\\"my image\\\" />\\n</Story>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n src: '/image.png',\\n alt: 'my image',\\n },\\n }),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"WithAnImage\\\">\\n <MyComponent src=\\\"/image.png\\\" alt=\\\"my image\\\" />\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage: Story = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n src: '/image.png',\\n alt: 'my image',\\n },\\n }),\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage = {\\n render: () => ({\\n template: '<img src=\\\"image.png\\\" alt=\\\"my image\\\" />',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithAnImage: Story = {\\n render: () => ({\\n template: '<img src=\\\"image.png\\\" alt=\\\"my image\\\" />',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage = {\\n render: () => html`<img src=\\\"/image.png\\\" alt=\\\"image\\\" />`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n// Assume image.png is located in the \\\"public\\\" directory.\\nexport const WithAnImage: Story = {\\n render: () => html`<img src=\\\"/image.png\\\" alt=\\\"image\\\" />`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 119]\"}, {\"title\": \"Component Story With Custom Render Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata, argsToTemplate } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { Layout } from './Layout.component';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n decorators: [\\n moduleMetadata({\\n declarations: [Layout],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example: Story = {\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <app-my-component ${argsToTemplate(args)}></app-my-component>\\n </article>\\n </app-layout>\\n `,\\n }),\\n};\\n```\", \"```\\n/** @jsx h */\\nimport { h } from 'preact';\\n\\nimport { Layout } from './Layout';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example = {\\n render: () => (\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n ),\\n};\\n```\", \"```\\nimport { Layout } from './Layout';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example = {\\n render: () => (\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Layout } from './Layout';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example: Story = {\\n render: () => (\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n ),\\n};\\n```\", \"```\\nimport { Layout } from './Layout';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n title: 'MyComponent',\\n component: MyComponent,\\n};\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example = {\\n render: () => (\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Layout } from './Layout';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example: Story = {\\n render: () => (\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n ),\\n};\\n```\", \"```\\nimport Layout from './Layout.vue';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example = {\\n render: () => ({\\n components: { Layout, MyComponent },\\n template: `\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n `,\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Layout from './Layout.vue';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example: Story = {\\n render: () => ({\\n components: { Layout, MyComponent },\\n template: `\\n <Layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <MyComponent />\\n </article>\\n </Layout>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example = {\\n render: () => html`\\n <layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <my-component />\\n </article>\\n </layout>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n// This story uses a render function to fully control how the component renders.\\nexport const Example: Story = {\\n render: () => html`\\n <layout>\\n <header>\\n <h1>Example</h1>\\n </header>\\n <article>\\n <my-component />\\n </article>\\n </layout>\\n `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 120]\"}, {\"title\": \"Component Styled Variables Object Notation\", \"description\": null, \"content\": {\"root\": [\"```\\nconst Component = styled.div(({ theme }) => ({\\n background: theme.background.app,\\n width: 0,\\n}));\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 121]\"}, {\"title\": \"Component Styled Variables Template Literals\", \"description\": null, \"content\": {\"root\": [\"```\\nconst Component = styled.div`\\n background: `${props => props.theme.background.app}`\\n width: 0;\\n`;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 122]\"}, {\"title\": \"Component Test With Testing Library\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { render, screen, fireEvent } from '@testing-library/angular';\\n\\nimport { FormComponent } from './LoginForm.component';\\n\\nimport { InvalidForm } from './Form.stories'; //\\ud83d\\udc48 Our stories imported here.\\n\\ntest('Checks if the form is valid ', async () => {\\n await render(FormComponent, {\\n componentProperties: InvalidForm.args,\\n });\\n\\n fireEvent.click(screen.getByText('Submit'));\\n\\n const isFormValid = screen.getByTestId('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport '@testing-library/jest-dom/extend-expect';\\n\\nimport { h } from 'preact';\\n\\nimport { render, fireEvent } from '@testing-library/preact';\\n\\nimport { InvalidForm } from './LoginForm.stories'; //\\ud83d\\udc48 Our stories imported here.\\n\\nit('Checks if the form is valid', async () => {\\n const { getByTestId, getByText } = render(<InvalidForm {...InvalidForm.args} />);\\n\\n fireEvent.click(getByText('Submit'));\\n\\n const isFormValid = getByTestId('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, render, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './LoginForm.stories'; // \\ud83d\\udc48 Our stories imported here.\\n\\nconst { InvalidForm } = composeStories(stories);\\n\\ntest('Checks if the form is valid', async () => {\\n // Renders the composed story\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, render, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './LoginForm.stories'; // \\ud83d\\udc48 Our stories imported here.\\n\\nconst { InvalidForm } = composeStories(stories);\\n\\ntest('Checks if the form is valid', async () => {\\n // Renders the composed story\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, render, screen } from '@testing-library/svelte';\\n\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './LoginForm.stories'; // \\ud83d\\udc48 Our stories imported here.\\n\\nconst { InvalidForm } = composeStories(stories);\\n\\nit('Checks if the form is valid', async () => {\\n // Renders the composed story\\n await InvalidForm.run();\\n\\n await fireEvent.click(screen.getByText('Submit'));\\n\\n const isFormValid = screen.getByTestId('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, render, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from './LoginForm.stories'; // \\ud83d\\udc48 Our stories imported here.\\n\\nconst { InvalidForm } = composeStories(stories);\\n\\ntest('Checks if the form is valid', async () => {\\n // Renders the composed story\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, render, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from './LoginForm.stories'; // \\ud83d\\udc48 Our stories imported here.\\n\\nconst { InvalidForm } = composeStories(stories);\\n\\ntest('Checks if the form is valid', async () => {\\n // Renders the composed story\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 123]\"}, {\"title\": \"Configure Mock Provider With Story Parameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\n// Wrapped in light theme\\nexport const Default = {};\\n\\n// Wrapped in dark theme\\nexport const Dark = {\\n parameters: {\\n theme: 'dark',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// Wrapped in light theme\\nexport const Default: Story = {};\\n\\n// Wrapped in dark theme\\nexport const Dark: Story = {\\n parameters: {\\n theme: 'dark',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 124]\"}, {\"title\": \"Create Command Custom Package Manager\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm create storybook@latest --package-manager=npm\\n```\", \"```\\npnpm create storybook@latest --package-manager=npm\\n```\", \"```\\nyarn create storybook --package-manager=npm\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 125]\"}, {\"title\": \"Create Command Custom Version\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm create storybook@8.3\\n```\", \"```\\npnpm create storybook@8.3\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 126]\"}, {\"title\": \"Create Command Manual Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm create storybook@latest --type solid\\n```\", \"```\\npnpm create storybook@latest --type solid\\n```\", \"```\\nyarn create storybook --type solid\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 127]\"}, {\"title\": \"Create Command\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm create storybook@latest\\n```\", \"```\\npnpm create storybook@latest\\n```\", \"```\\nyarn create storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 128]\"}, {\"title\": \"Csf 2 Example Primary Dark Story\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const PrimaryOnDark = Primary.bind({});\\nPrimaryOnDark.args = Primary.args;\\nPrimaryOnDark.parameters = { background: { default: 'dark' } };\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 129]\"}, {\"title\": \"Csf 2 Example Starter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Meta, Story } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n} as Meta;\\n\\nexport const Primary: Story = (args) => ({\\n props: args,\\n});\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n};\\n\\nexport const Primary = (args) => <Button {...args} />;\\nPrimary.args = { primary: true };\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { ComponentStory, ComponentMeta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n} as ComponentMeta<typeof Button>;\\n\\nexport const Primary: ComponentStory<typeof Button> = (args) => <Button {...args} />;\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n};\\n\\nexport const Primary = (args) => <Button {...args} />;\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport { ComponentStory, ComponentMeta } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n} as ComponentMeta<typeof Button>;\\n\\nexport const Primary: ComponentStory<typeof Button> = (args) => <Button {...args} />;\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n};\\n\\nexport const Primary = (args) => ({\\n Component: Button,\\n props: args,\\n});\\nPrimary.args = { primary: true };\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n} as Meta<typeof Button>;\\n\\nexport const Primary: StoryFn<typeof Button> = (args) => ({\\n Component: Button,\\n props: args,\\n});\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n};\\n\\nexport const Primary = (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n});\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport { Meta, StoryFn } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nexport default {\\n title: 'Button',\\n component: Button,\\n} as Meta<typeof Button>;\\n\\nexport const Primary: StoryFn<typeof Button> = (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n});\\nPrimary.args = { primary: true };\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'components/Button',\\n component: 'demo-button',\\n};\\n\\nexport const Primary = ({ primary }) => html`<custom-button ?primary=${primary}></custom-button>`;\\nPrimary.args = {\\n primary: true,\\n};\\n```\", \"```\\nimport type { Meta, Story } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'components/Button',\\n component: 'demo-button',\\n} as Meta;\\n\\nexport const Primary: Story = ({ primary }) =>\\n html`<demo-button ?primary=${primary}></demo-button>`;\\nPrimary.args = {\\n primary: true,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 130]\"}, {\"title\": \"Csf 2 Example Story\", \"description\": null, \"content\": {\"root\": [\"```\\n// Other imports and story implementation\\nexport const Default: Story = (args) => ({\\n props: args,\\n});\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = (args) => <Button {...args} />;\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: ComponentStory<typeof Button> = (args) => <Button {...args} />;\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = (args) => <Button {...args} />;\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: ComponentStory<typeof Button> = (args) => <Button {...args} />;\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = (args) => ({\\n Component: Button,\\n props: args,\\n});\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: StoryFn<typeof Button> = (args) => ({\\n Component: Button,\\n props: args,\\n});\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n});\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: StoryFn<typeof Button> = (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n});\\n```\", \"```\\n// Other imports and story implementation\\n\\nexport const Default = ({ primary, size, label }) =>\\n html`<custom-button ?primary=\\\"${primary}\\\" size=\\\"${size}\\\" label=\\\"${label}\\\"></custom-button>`;\\n```\", \"```\\n// Other imports and story implementation\\n\\nexport const Default: Story = ({ primary, backgroundColor, size, label }) =>\\n html`<custom-button ?primary=\\\"${primary}\\\" size=\\\"${size}\\\" label=\\\"${label}\\\"></custom-button>`;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 131]\"}, {\"title\": \"Csf 2 Example Title\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n title: 'components/Button',\\n component: Button,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 132]\"}, {\"title\": \"Csf 3 Example Auto Title\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default { component: Button };\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 133]\"}, {\"title\": \"Csf 3 Example Default Render\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const Default = {};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 134]\"}, {\"title\": \"Csf 3 Example Primary Dark Story\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const PrimaryOnDark = {\\n ...Primary,\\n parameters: { background: { default: 'dark' } },\\n};\\n```\", \"```\\nexport const PrimaryOnDark: Story = {\\n ...Primary,\\n parameters: { background: { default: 'dark' } },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 135]\"}, {\"title\": \"Csf 3 Example Render\", \"description\": null, \"content\": {\"root\": [\"```\\n// Other imports and story implementation\\nexport const Default: Story = {\\n render: (args) => ({\\n props: args,\\n }),\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = {\\n render: (args) => <Button {...args} />,\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: Story = {\\n render: (args) => <Button {...args} />,\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = {\\n render: (args) => <Button {...args} />,\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: Story = {\\n render: (args) => <Button {...args} />,\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = {\\n render: (args) => ({\\n Component: Button,\\n props: args,\\n });\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: Story = {\\n render: (args) => ({\\n Component: Button,\\n props: args,\\n }),\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n};\\n```\", \"```\\n// Other imports and story implementation\\nexport const Default: Story = {\\n render: (args) => ({\\n components: { Button },\\n setup() {\\n return { args };\\n },\\n template: '<Button v-bind=\\\"args\\\" />',\\n }),\\n};\\n```\", \"```\\n// Other imports and story implementation\\n\\nexport const Default = {\\n render: (args) => html`<demo-button label=\\\"Hello\\\" @click=${action('clicked')}></demo-button>`,\\n};\\n```\", \"```\\n// Other imports and story implementation\\n\\nexport const Default: Story = {\\n render: (args) => html`<custom-button label=\\\"Hello\\\" @click=${action('clicked')}></custom-button>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 136]\"}, {\"title\": \"Csf 3 Example Starter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = { component: Button };\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default { component: Button };\\n\\nexport const Primary = { args: { primary: true } };\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default { component: Button };\\n\\nexport const Primary = { args: { primary: true } };\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default { component: Button };\\n\\nexport const Primary = { args: { primary: true } };\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\", \"```\\nimport Button from './Button.vue';\\n\\nexport default { component: Button };\\n\\nexport const Primary = { args: { primary: true } };\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Button from './Button.vue';\\n\\nconst meta = { component: Button } satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\", \"```\\nexport default {\\n title: 'components/Button',\\n component: 'demo-button',\\n};\\n\\nexport const Primary = { args: { primary: true } };\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'components/Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = { args: { primary: true } };\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 137]\"}, {\"title\": \"Csf 3 Example Title\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"src/components/Button/Button.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\nimport { Meta, Story } from '@storybook/addon-docs/blocks';\", \"{/* \\ud83d\\udc47 Documentation-only page */}\", \"<Meta title=\\\"Documentation\\\" />\", \"{/* \\ud83d\\udc47 Component documentation page */}\\nimport * as ButtonStories from './Button.stories';\", \"<Meta of={ButtonStories} />\", \"<Story of={ButtonStories.Primary} />\", \"```\\n\\n```js filename=\\\"src/components/Button/Button.stories.js|jsx\\\" renderer=\\\"common\\\" language=\\\"js\\\"\\nimport { Button } from './Button';\\n\\nexport default {\\n // Sets the name for the stories container\\n title: 'components/Button',\\n // The component name will be used if `title` is not set\\n component: Button,\\n};\\n\\n// The story variable name will be used if `name` is not set\\nconst Primary = {\\n // Sets the name for that particular story\\n name: 'Primary',\\n args: {\\n label: 'Button',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n // Sets the name for the stories container\\n title: 'components/Button',\\n // The component name will be used if `title` is not set\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// The story variable name will be used if `name` is not set\\nconst Primary: Story = {\\n // Sets the name for that particular story\\n name: 'Primary',\\n args: {\\n label: 'Button',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 138]\"}, {\"title\": \"With the story title defined\", \"description\": null, \"content\": {\"Primary\": \"<Story id=\\\"example-button--primary\\\" />\", \"Secondary\": \"<Story id=\\\"example-button--secondary\\\" />\", \"Large\": \"<Story id=\\\"example-button--large\\\" />\", \"Small\": \"<Story id=\\\"example-button--small\\\" />\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 139]\"}, {\"title\": \"Decorator Parameterized In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nconst preview: Preview = {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n componentWrapperDecorator((story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n // Your page layout is probably a little more complex than this ;)\\n return `<div class=\\\"page-layout\\\">${story}</div>`;\\n case 'page-mobile':\\n return `<div class=\\\"page-mobile-layout\\\">${story}</div>`;\\n default:\\n // In the default case, don't apply a layout\\n return story;\\n }\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport React from 'react';\\n\\nexport default {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n return (\\n // Your page layout is probably a little more complex than this ;)\\n <div className=\\\"page-layout\\\">\\n <Story />\\n </div>\\n );\\n case 'page-mobile':\\n return (\\n <div className=\\\"page-mobile-layout\\\">\\n <Story />\\n </div>\\n );\\n default:\\n // In the default case, don't apply a layout\\n return <Story />;\\n }\\n },\\n ],\\n};\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n return (\\n // Your page layout is probably a little more complex than this ;)\\n <div className=\\\"page-layout\\\">\\n <Story />\\n </div>\\n );\\n case 'page-mobile':\\n return (\\n <div className=\\\"page-mobile-layout\\\">\\n <Story />\\n </div>\\n );\\n default:\\n // In the default case, don't apply a layout\\n return <Story />;\\n }\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nexport default {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n return (\\n // Your page layout is probably a little more complex than this ;)\\n <div className=\\\"page-layout\\\">\\n <Story />\\n </div>\\n );\\n case 'page-mobile':\\n return (\\n <div className=\\\"page-mobile-layout\\\">\\n <Story />\\n </div>\\n );\\n default:\\n // In the default case, don't apply a layout\\n return <Story />;\\n }\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Preview } from 'storybook-solidjs-vite';\\n\\nconst preview: Preview = {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n return (\\n // Your page layout is probably a little more complex than this ;)\\n <div className=\\\"page-layout\\\">\\n <Story />\\n </div>\\n );\\n case 'page-mobile':\\n return (\\n <div className=\\\"page-mobile-layout\\\">\\n <Story />\\n </div>\\n );\\n default:\\n // In the default case, don't apply a layout\\n return <Story />;\\n }\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nexport default {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (_, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n // Your page layout is probably a little more complex than this ;)\\n return { template: '<div class=\\\"page-layout\\\"><story/></div>' };\\n case 'page-mobile':\\n return { template: '<div class=\\\"page-mobile-layout\\\"><story/></div>' };\\n default:\\n // In the default case, don't apply a layout\\n return { template: '<story/>' };\\n }\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Preview } from '@storybook/vue3-vite';\\n\\nconst preview: Preview = {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (_, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading from parameters\\n const { pageLayout } = parameters;\\n switch (pageLayout) {\\n case 'page':\\n // Your page layout is probably a little more complex than this ;)\\n return { template: '<div class=\\\"page-layout\\\"><story/></div>' };\\n case 'page-mobile':\\n return { template: '<div class=\\\"page-mobile-layout\\\"><story/></div>' };\\n default:\\n // In the default case, don't apply a layout\\n return { template: '<story/>' };\\n }\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 140]\"}, {\"title\": \"Document Screen Fetch\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Component, OnInit } from '@angular/core';\\nimport { HttpClient } from '@angular/common/http';\\n\\n@Component({\\n selector: 'document-screen',\\n template: `\\n <div>\\n <div *ngIf=\\\"error\\\"><p>There was an error fetching the data!</p></div>\\n <div *ngIf=\\\"loading\\\"><p>Loading...</p></div>\\n <div *ngIf=\\\"!loading && subdocuments.length > 0\\\">\\n <page-layout [user]=\\\"user\\\">\\n <document-header [document]=\\\"document\\\"></document-header>\\n <document-list [documents]=\\\"subdocuments\\\"></document-list>\\n </page-layout>\\n </div>\\n </div>\\n `,\\n})\\nexport class DocumentScreen implements OnInit {\\n user: any = { id: 0, name: 'Some User' };\\n\\n document: any = { id: 0, title: 'Some Title' };\\n\\n subdocuments: any = [];\\n\\n error = false;\\n loading = true;\\n\\n constructor(private http: HttpClient) {}\\n\\n ngOnInit() {\\n this.http.get<any>('https://your-restful-endpoint').subscribe({\\n next: (data) => {\\n this.loading = false;\\n this.user = data.user;\\n this.document = data.document;\\n this.documents.data.subdocuments;\\n },\\n error: (error) => {\\n this.error = true;\\n },\\n });\\n }\\n}\\n```\", \"```\\nimport React, { useState, useEffect } from 'react';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\n// Example hook to retrieve data from an external endpoint\\nfunction useFetchData() {\\n const [status, setStatus] = useState('idle');\\n const [data, setData] = useState([]);\\n useEffect(() => {\\n setStatus('loading');\\n fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n throw new Error(res.statusText);\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((data) => {\\n setStatus('success');\\n setData(data);\\n })\\n .catch(() => {\\n setStatus('error');\\n });\\n }, []);\\n return {\\n status,\\n data,\\n };\\n}\\nexport function DocumentScreen() {\\n const { status, data } = useFetchData();\\n\\n const { user, document, subdocuments } = data;\\n\\n if (status === 'loading') {\\n return <p>Loading...</p>;\\n }\\n if (status === 'error') {\\n return <p>There was an error fetching the data!</p>;\\n }\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport React, { useState, useEffect } from 'react';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\n// Example hook to retrieve data from an external endpoint\\nfunction useFetchData() {\\n const [status, setStatus] = useState<string>('idle');\\n const [data, setData] = useState<any[]>([]);\\n useEffect(() => {\\n setStatus('loading');\\n fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n throw new Error(res.statusText);\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((data) => {\\n setStatus('success');\\n setData(data);\\n })\\n .catch(() => {\\n setStatus('error');\\n });\\n }, []);\\n\\n return {\\n status,\\n data,\\n };\\n}\\n\\nexport function DocumentScreen() {\\n const { status, data } = useFetchData();\\n\\n const { user, document, subdocuments } = data;\\n\\n if (status === 'loading') {\\n return <p>Loading...</p>;\\n }\\n if (status === 'error') {\\n return <p>There was an error fetching the data!</p>;\\n }\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport { createSignal, Match, Switch } from 'solid-js';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\n// Example hook to retrieve data from an external endpoint\\nfunction useFetchData() {\\n const [status, setStatus] = createSignal('idle');\\n const [data, setData] = createSignal([]);\\n\\n setStatus('loading');\\n fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n throw new Error(res.statusText);\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((data) => {\\n setStatus('success');\\n setData(data);\\n })\\n .catch(() => {\\n setStatus('error');\\n });\\n\\n return {\\n status,\\n data,\\n };\\n}\\nexport function DocumentScreen() {\\n const { status, data } = useFetchData();\\n\\n return (\\n <Switch>\\n <Match when={status() === 'loading'}>\\n <p>Loading...</p>\\n </Match>\\n <Match when={status() === 'error'}>\\n <p>There was an error fetching the data!</p>\\n </Match>\\n <Match when={user} keyed>\\n <PageLayout user={data().user}>\\n <DocumentHeader document={data().document} />\\n <DocumentList documents={data().subdocuments} />\\n </PageLayout>\\n </Match>\\n </Switch>\\n );\\n}\\n```\", \"```\\n<script>\\n import { onMount } from 'svelte';\\n\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n export let user = {};\\n export let document = {};\\n export let subdocuments = [];\\n export let status = 'loading';\\n\\n onMount(async () => {\\n await fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n throw new Error(res.statusText);\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((data) => {\\n user = data.user;\\n status = 'success';\\n document = data.document;\\n subdocuments = data.subdocuments;\\n })\\n .catch(() => {\\n status = 'error';\\n });\\n });\\n</script>\\n\\n{#if status === \\\"error\\\"}\\n<p>There was an error fetching the data!</p>\\n{:else if status === \\\"loading\\\"}\\n<p>Loading...</p>\\n{:else}\\n<PageLayout {user}>\\n <DocumentHeader {document} />\\n <DocumentList documents=\\\"{subdocuments}\\\" />\\n</PageLayout>\\n{/if}\\n```\", \"```\\n<script lang=\\\"ts\\\">\\n import { onMount } from 'svelte';\\n\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n export let user: Record<string, unknown> = {};\\n export let document: Record<string, unknown> = {};\\n export let subdocuments: Record<string, unknown>[] = [];\\n export let status: 'error' | 'loading' | 'success' = 'loading';\\n\\n onMount(async () => {\\n await fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n throw new Error(res.statusText);\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((data) => {\\n user = data.user;\\n status = 'success';\\n document = data.document;\\n subdocuments = data.subdocuments;\\n })\\n .catch(() => {\\n status = 'error';\\n });\\n });\\n</script>\\n\\n{#if status === \\\"error\\\"}\\n<p>There was an error fetching the data!</p>\\n{:else if status === \\\"loading\\\"}\\n<p>Loading...</p>\\n{:else}\\n<PageLayout {user}>\\n <DocumentHeader {document} />\\n <DocumentList documents=\\\"{subdocuments}\\\" />\\n</PageLayout>\\n{/if}\\n```\", \"```\\n<template>\\n <div v-if=\\\"!loading && data && data.subdocuments.length\\\">\\n <PageLayout :user=\\\"data.user\\\">\\n <DocumentHeader :document=\\\"data.document\\\" />\\n <DocumentList :documents=\\\"data.subdocuments\\\" />\\n </PageLayout>\\n </div>\\n <p v-if=\\\"loading\\\">Loading...</p>\\n <p v-if=\\\"error\\\">There was an error fetching the data!</p>\\n</template>\\n<script>\\n import { ref } from 'vue';\\n\\n import PageLayout from './PageLayout';\\n import DocumentHeader from './DocumentHeader';\\n import DocumentList from './DocumentList';\\n\\n export default {\\n name: 'DocumentScreen',\\n setup() {\\n const data = ref(null);\\n const loading = ref(true);\\n const error = ref(null);\\n fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n error.value = res.statusText;\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((requestData) => {\\n data.value = requestData;\\n loading.value = false;\\n })\\n .catch(() => {\\n error.value = 'error';\\n });\\n return {\\n error,\\n loading,\\n data,\\n };\\n },\\n };\\n</script>\\n```\", \"```\\n<template>\\n <div v-if=\\\"!loading && data && data.subdocuments.length\\\">\\n <PageLayout :user=\\\"data.user\\\">\\n <DocumentHeader :document=\\\"data.document\\\" />\\n <DocumentList :documents=\\\"data.subdocuments\\\" />\\n </PageLayout>\\n </div>\\n <p v-if=\\\"loading\\\">Loading...</p>\\n <p v-if=\\\"error\\\">There was an error fetching the data!</p>\\n</template>\\n<script lang=\\\"ts\\\">\\n import { defineComponent, ref } from 'vue';\\n import PageLayout from './PageLayout';\\n import DocumentHeader from './DocumentHeader';\\n import DocumentList from './DocumentList';\\n\\n export default defineComponent({\\n name: 'SampleRestComponent',\\n components: {\\n PageLayout,\\n DocumentHeader,\\n DocumentList,\\n },\\n setup() {\\n const data = ref(null);\\n const loading = ref(true);\\n const error = ref(null);\\n fetch('https://your-restful-endpoint')\\n .then((res) => {\\n if (!res.ok) {\\n error.value = res.statusText;\\n }\\n return res;\\n })\\n .then((res) => res.json())\\n .then((requestData) => {\\n data.value = requestData;\\n loading.value = false;\\n })\\n .catch(() => {\\n error.value = 'error';\\n });\\n return {\\n error,\\n loading,\\n data,\\n };\\n },\\n });\\n</script>\\n```\", \"```\\nimport { LitElement, html } from 'lit-element';\\n\\nclass DocumentScreen extends LitElement {\\n static get properties() {\\n return {\\n _data: { type: Object },\\n _status: { state: true },\\n };\\n }\\n\\n constructor() {\\n super();\\n this._status = 'idle';\\n }\\n\\n connectedCallback() {\\n super.connectedCallback();\\n this.fetchData();\\n }\\n\\n fetchData() {\\n this._status = 'loading';\\n\\n fetch('https://your-restful-endpoint')\\n .then((response) => {\\n if (!response.ok) {\\n throw new Error('Network response was not ok');\\n }\\n response.json();\\n })\\n .then((data) => {\\n this._status = 'success';\\n this._data = data;\\n })\\n .catch((error) => {\\n this._status = 'error';\\n });\\n }\\n\\n render() {\\n if (this._status === 'error') {\\n return html`<p>There was an error fetching the data!</p>`;\\n }\\n\\n if (this._status === 'loading') {\\n return html`<p>Loading...</p>`;\\n }\\n\\n const { user, document, subdocuments } = this._data;\\n return html`\\n <demo-page-layout .user=${user}>\\n <demo-document-header .document=${document}></demo-document-header>\\n <demo-document-list .documents=${subdocuments}></demo-document-list>\\n </demo-page-layout>\\n `;\\n }\\n}\\n\\ncustomElements.define('demo-document-screen', DocumentScreen);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 141]\"}, {\"title\": \"Document Screen With Graphql\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Component, OnInit } from '@angular/core';\\nimport { Apollo } from 'apollo-angular';\\nimport gql from 'graphql-tag';\\n\\n@Component({\\n selector: 'document-screen',\\n template: `\\n <div *ngIf=\\\"loading\\\">Loading...</div>\\n <div *ngIf=\\\"error\\\">There was an error fetching the data!</div>\\n <div *ngIf=\\\"!loading && subdocuments.length > 0\\\">\\n <page-layout [user]=\\\"user\\\">\\n <document-header [document]=\\\"document\\\"></document-header>\\n <document-list [documents]=\\\"subdocuments\\\"></document-list>\\n </page-layout>\\n </div>\\n `,\\n})\\nexport class SampleGraphqlComponent implements OnInit {\\n user: any = { id: 0, name: 'Some User' };\\n\\n document: any = { id: 0, title: 'Some Title' };\\n\\n subdocuments: any = [];\\n\\n error = '';\\n loading = true;\\n\\n constructor(private apollo: Apollo) {}\\n ngOnInit() {\\n this.apollo\\n .watchQuery({\\n query: gql`\\n query AllInfoQuery {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n `,\\n })\\n .valueChanges.subscribe((result: any) => {\\n this.user = result?.data?.user;\\n this.document = result?.data?.document;\\n this.subdocuments = result?.data?.subdocuments;\\n this.loading = result.loading;\\n\\n // Errors is an array and we're getting the first item only\\n this.error = result.errors[0].message;\\n });\\n }\\n}\\n```\", \"```\\nimport { useQuery, gql } from '@apollo/client';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nconst AllInfoQuery = gql`\\n query AllInfo {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n`;\\n\\nfunction useFetchInfo() {\\n const { loading, error, data } = useQuery(AllInfoQuery);\\n\\n return { loading, error, data };\\n}\\n\\nexport function DocumentScreen() {\\n const { loading, error, data } = useFetchInfo();\\n\\n if (loading) {\\n return <p>Loading...</p>;\\n }\\n\\n if (error) {\\n return <p>There was an error fetching the data!</p>;\\n }\\n\\n return (\\n <PageLayout user={data.user}>\\n <DocumentHeader document={data.document} />\\n <DocumentList documents={data.subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport { useQuery, gql } from '@apollo/client';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nconst AllInfoQuery = gql`\\n query AllInfo {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n`;\\n\\ninterface Data {\\n allInfo: {\\n user: {\\n userID: number;\\n name: string;\\n opening_crawl: boolean;\\n };\\n document: {\\n id: number;\\n userID: number;\\n title: string;\\n brief: string;\\n status: string;\\n };\\n subdocuments: {\\n id: number;\\n userID: number;\\n title: string;\\n content: string;\\n status: string;\\n };\\n };\\n}\\n\\nfunction useFetchInfo() {\\n const { loading, error, data } = useQuery<Data>(AllInfoQuery);\\n\\n return { loading, error, data };\\n}\\n\\nexport function DocumentScreen() {\\n const { loading, error, data } = useFetchInfo();\\n\\n if (loading) {\\n return <p>Loading...</p>;\\n }\\n\\n if (error) {\\n return <p>There was an error fetching the data!</p>;\\n }\\n\\n return (\\n <PageLayout user={data.user}>\\n <DocumentHeader document={data.document} />\\n <DocumentList documents={data.subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport { Match, Switch } from 'solid-js';\\nimport { createGraphQLClient, gql } from '@solid-primitives/graphql';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nconst newQuery = createGraphQLClient('https://foobar.com/v1/api');\\nconst AllInfoQuery = gql`\\n query AllInfo {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n`;\\n\\nfunction useFetchInfo() {\\n const [data] = newQuery(AllInfoQuery, { path: 'home' });\\n return data;\\n}\\n\\nexport function DocumentScreen() {\\n const data = useFetchInfo();\\n\\n return (\\n <Switch>\\n <Match when={data.loading}>\\n <p>Loading...</p>\\n </Match>\\n <Match when={data.error}>\\n <p>There was an error fetching the data!</p>\\n </Match>\\n <Match when={data()} keyed>\\n {(data) => (\\n <PageLayout user={data.user}>\\n <DocumentHeader document={data.document} />\\n <DocumentList documents={data.subdocuments} />\\n </PageLayout>\\n )}\\n </Match>\\n </Switch>\\n );\\n}\\n```\", \"```\\nimport { createGraphQLClient, gql } from '@solid-primitives/graphql';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nconst newQuery = createGraphQLClient('https://foobar.com/v1/api');\\nconst AllInfoQuery = gql`\\n query AllInfo {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n`;\\n\\ninterface Data {\\n allInfo: {\\n user: {\\n userID: number;\\n name: string;\\n opening_crawl: boolean;\\n };\\n document: {\\n id: number;\\n userID: number;\\n title: string;\\n brief: string;\\n status: string;\\n };\\n subdocuments: {\\n id: number;\\n userID: number;\\n title: string;\\n content: string;\\n status: string;\\n };\\n };\\n}\\n\\nfunction useFetchInfo() {\\n const [data] = newQuery<Data>(AllInfoQuery, { path: 'home' });\\n return data;\\n}\\n\\nexport function DocumentScreen() {\\n const data = useFetchInfo();\\n\\n return (\\n <Switch>\\n <Match when={data.loading}>\\n <p>Loading...</p>\\n </Match>\\n <Match when={data.error}>\\n <p>There was an error fetching the data!</p>\\n </Match>\\n <Match when={data()} keyed>\\n {(data) => (\\n <PageLayout user={data.user}>\\n <DocumentHeader document={data.document} />\\n <DocumentList documents={data.subdocuments} />\\n </PageLayout>\\n )}\\n </Match>\\n </Switch>\\n );\\n}\\n```\", \"```\\n<template>\\n <div v-if=\\\"loading\\\">Loading...</div>\\n\\n <div v-else-if=\\\"error\\\">There was an error fetching the data!</div>\\n\\n <div v-if=\\\"!loading && data && result.subdocuments.length\\\">\\n <PageLayout :user=\\\"data.user\\\">\\n <DocumentHeader :document=\\\"result.document\\\" />\\n <DocumentList :documents=\\\"result.subdocuments\\\" />\\n </PageLayout>\\n </div>\\n</template>\\n\\n<script>\\n import PageLayout from './PageLayout';\\n import DocumentHeader from './DocumentHeader';\\n import DocumentList from './DocumentList';\\n\\n import gql from 'graphql-tag';\\n import { useQuery } from '@vue/apollo-composable';\\n\\n export default {\\n name: 'DocumentScreen',\\n setup() {\\n const { result, loading, error } = useQuery(gql`\\n query AllInfoQuery {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n `);\\n return {\\n result,\\n loading,\\n error,\\n };\\n },\\n };\\n</script>\\n```\", \"```\\n<template>\\n <div v-if=\\\"loading\\\">Loading...</div>\\n\\n <div v-else-if=\\\"error\\\">There was an error fetching the data!</div>\\n\\n <div v-if=\\\"!loading && data && result.subdocuments.length\\\">\\n <PageLayout :user=\\\"data.user\\\">\\n <DocumentHeader :document=\\\"result.document\\\" />\\n <DocumentList :documents=\\\"result.subdocuments\\\" />\\n </PageLayout>\\n </div>\\n</template>\\n\\n<script lang=\\\"ts\\\">\\n import PageLayout from './PageLayout';\\n import DocumentHeader from './DocumentHeader';\\n import DocumentList from './DocumentList';\\n\\n import gql from 'graphql-tag';\\n import { useQuery } from '@vue/apollo-composable';\\n import { defineComponent } from 'vue';\\n\\n export default defineComponent({\\n name: 'DocumentScreen',\\n setup() {\\n const { result, loading, error } = useQuery(gql`\\n query AllInfoQuery {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n `);\\n\\n return {\\n result,\\n loading,\\n error,\\n };\\n },\\n });\\n</script>\\n```\", \"```\\n<script>\\n import { queryStore, gql, getContextClient } from '@urql/svelte';\\n\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n const AllInfoQuery = queryStore({\\n client: getContextClient(),\\n query: gql`\\n query AllInfoQuery {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n `,\\n });\\n</script>\\n\\n{#if $AllInfoQuery.fetching}\\n<p>Loading...</p>\\n{:else if $AllInfoQuery.error}\\n<p>There was an error fetching the data!</p>\\n{:else}\\n<PageLayout user={$AllInfoQuery.data.AllInfoQuery.user}>\\n <DocumentHeader document={$AllInfoQuery.data.AllInfoQuery.document} />\\n <DocumentList documents={$AllInfoQuery.data.AllInfoQuery.subdocuments} />\\n</PageLayout>\\n{/if}\\n```\", \"```\\n<script lang=\\\"ts\\\">\\n import { queryStore, gql, getContextClient } from '@urql/svelte';\\n\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n const AllInfoQuery = queryStore({\\n client: getContextClient(),\\n query: gql`\\n query AllInfoQuery {\\n user {\\n userID\\n name\\n }\\n document {\\n id\\n userID\\n title\\n brief\\n status\\n }\\n subdocuments {\\n id\\n userID\\n title\\n content\\n status\\n }\\n }\\n `,\\n });\\n</script>\\n\\n{#if $AllInfoQuery.fetching}\\n<p>Loading...</p>\\n{:else if $AllInfoQuery.error}\\n<p>There was an error fetching the data!</p>\\n{:else}\\n<PageLayout user={$AllInfoQuery.data.AllInfoQuery.user}>\\n <DocumentHeader document={$AllInfoQuery.data.AllInfoQuery.document} />\\n <DocumentList documents={$AllInfoQuery.data.AllInfoQuery.subdocuments} />\\n</PageLayout>\\n{/if}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 142]\"}, {\"title\": \"Eslint Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev eslint\\n```\", \"```\\npnpm add --save-dev eslint\\n```\", \"```\\nyarn add --dev eslint\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 143]\"}, {\"title\": \"Eslint Plugin Storybook Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev eslint-plugin-storybook\\n```\", \"```\\npnpm add --save-dev eslint-plugin-storybook\\n```\", \"```\\nyarn add --dev eslint-plugin-storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 144]\"}, {\"title\": \"Essential Feature Disable\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n backgrounds: false, // \\ud83d\\udc48 disable the backgrounds feature\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n backgrounds: false, // \\ud83d\\udc48 disable the backgrounds feature\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 145]\"}, {\"title\": \"Foo Bar Baz Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Foo } from './Foo.component';\\n\\nconst meta: Meta<Foo> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Foo>;\\n\\nexport const Baz: Story = {};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Foo from './Foo.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n });\\n</script>\\n\\n<Story name=\\\"Baz\\\" />\\n```\", \"```\\nimport Foo from './Foo.svelte';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n};\\n\\nexport const Baz = {};\\n```\", \"```\\nimport { Foo } from './Foo';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n};\\n\\nexport const Baz = {};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Foo from './Foo.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n });\\n</script>\\n\\n<Story name=\\\"Baz\\\" />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Foo from './Foo.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n} satisfies Meta<typeof Foo>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Baz: Story = {};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Foo } from './Foo';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Foo/Bar',\\n component: Foo,\\n} satisfies Meta<typeof Foo>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Baz: Story = {};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 146]\"}, {\"title\": \"Ghp Github Action\", \"description\": null, \"content\": {\"root\": [\"```\\n# Workflow name\\nname: Build and Publish Storybook to GitHub Pages\\n\\non:\\n # Event for the workflow to run on\\n push:\\n branches:\\n - 'your-branch-name' # Replace with the branch you want to deploy from\\n\\npermissions:\\n contents: read\\n pages: write\\n id-token: write\\n\\n# List of jobs\\njobs:\\n deploy:\\n runs-on: ubuntu-latest\\n # Job steps\\n steps:\\n # Manual Checkout\\n - uses: actions/checkout@v4\\n with:\\n fetch-depth: 0\\n # Set up Node\\n - uses: actions/setup-node@v4\\n with:\\n node-version: '20'\\n #\\ud83d\\udc47 Add Storybook build and deploy to GitHub Pages as a step in the workflow\\n - uses: bitovi/github-actions-storybook-to-github-pages@v1.0.3\\n with:\\n install_command: yarn install # default: npm ci\\n build_command: yarn build-storybook # default: npm run build-storybook\\n path: storybook-static # default: dist/storybook\\n checkout: false # default: true\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 147]\"}, {\"title\": \"Gizmo Story Controls Customization\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Gizmo } from './Gizmo.component';\\n\\nconst meta: Meta<Gizmo> = {\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Gizmo from './Gizmo.svelte';\\n\\n const { Story } = defineMeta({\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Gizmo from './Gizmo.svelte';\\n\\nexport default {\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n};\\n```\", \"```\\nimport { Gizmo } from './Gizmo';\\n\\nexport default {\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Gizmo from './Gizmo.svelte';\\n\\n const { Story } = defineMeta({\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Gizmo from './Gizmo.svelte';\\n\\nconst meta = {\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n} satisfies Meta<typeof Gizmo>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Gizmo } from './Gizmo';\\n\\nconst meta = {\\n component: Gizmo,\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n} satisfies Meta<typeof Gizmo>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'gizmo-element',\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'gizmo-element',\\n argTypes: {\\n canRotate: {\\n control: 'boolean',\\n },\\n width: {\\n control: { type: 'number', min: 400, max: 1200, step: 50 },\\n },\\n height: {\\n control: { type: 'range', min: 200, max: 1500, step: 50 },\\n },\\n rawData: {\\n control: 'object',\\n },\\n coordinates: {\\n control: 'object',\\n },\\n texture: {\\n control: {\\n type: 'file',\\n accept: '.png',\\n },\\n },\\n position: {\\n control: 'radio',\\n options: ['left', 'right', 'center'],\\n },\\n rotationAxis: {\\n control: 'check',\\n options: ['x', 'y', 'z'],\\n },\\n scaling: {\\n control: 'select',\\n options: [10, 50, 75, 100, 200],\\n },\\n label: {\\n control: 'text',\\n },\\n meshColors: {\\n control: {\\n type: 'color',\\n presetColors: ['#ff0000', '#00ff00', '#0000ff'],\\n },\\n },\\n revisionDate: {\\n control: 'date',\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 148]\"}, {\"title\": \"Highlight Custom Style\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"StyledHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"StyledHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n styles: {\\n backgroundColor: `color-mix(in srgb, hotpink, transparent 90%)`,\\n outline: '3px solid hotpink',\\n animation: 'sb-highlight-pulse 3s linear infinite',\\n transition: 'outline-offset 0.2s ease-in-out',\\n },\\n hoverStyles: {\\n outlineOffset: '3px',\\n },\\n focusStyles: {\\n backgroundColor: 'transparent',\\n },\\n keyframes: `@keyframes sb-highlight-pulse {\\n 0% { outline-color: rgba(255, 105, 180, 1); }\\n 50% { outline-color: rgba(255, 105, 180, 0.2); }\\n 100% { outline-color: rgba(255, 105, 180, 1); }\\n }`,\\n });\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 149]\"}, {\"title\": \"Highlight Menu\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"StyledHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ]\\n ],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"StyledHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ]\\n ],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const StyledHighlight = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const StyledHighlight: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n selectors: ['h2', 'a', '.storybook-button'],\\n menu: [\\n [\\n {\\n id: 'button-name',\\n title: 'Login',\\n description: 'Navigate to the login page',\\n clickEvent: 'my-menu-click-event',\\n },\\n {\\n id: 'h2-home',\\n title: 'Acme',\\n description: 'Navigate to the home page',\\n },\\n ],\\n ],\\n });\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 150]\"}, {\"title\": \"Highlight Remove\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const RemoveHighlight: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const RemoveHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const RemoveHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"RemoveHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const RemoveHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"RemoveHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const RemoveHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const RemoveHighlight = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const RemoveHighlight: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const RemoveHighlight = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const RemoveHighlight: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(HIGHLIGHT, {\\n id: 'my-unique-id',\\n selectors: ['header', 'section', 'footer'],\\n });\\n emit(REMOVE_HIGHLIGHT, 'my-unique-id');\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 151]\"}, {\"title\": \"Highlight Reset\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const ResetHighlight: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ResetHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ResetHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ResetHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ResetHighlight = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ResetHighlight\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ResetHighlight: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ResetHighlight = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ResetHighlight: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const ResetHighlight = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { HIGHLIGHT, RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ResetHighlight: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(RESET_HIGHLIGHT); //\\ud83d\\udc48 Remove previously highlighted elements\\n emit(HIGHLIGHT, {\\n selectors: ['header', 'section', 'footer'],\\n });\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 152]\"}, {\"title\": \"Highlight Scroll Into View\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const ScrollIntoView: Story = {\\n decorators: [\\n componentWrapperDecorator((story) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return story;\\n }),\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ScrollIntoView = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ScrollIntoView: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ScrollIntoView\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ScrollIntoView = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { useChannel } from 'storybook/preview-api';\\n import { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ScrollIntoView\\\"\\n decorators={[\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ScrollIntoView: Story = {\\n decorators: [\\n (storyFn) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return storyFn();\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ScrollIntoView = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ScrollIntoView: Story = {\\n decorators: [\\n () => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return {\\n template: '<story />',\\n };\\n },\\n ],\\n};\\n```\", \"```\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const ScrollIntoView = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return story();\\n },\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { useChannel } from 'storybook/preview-api';\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ScrollIntoView: Story = {\\n decorators: [\\n (story) => {\\n const emit = useChannel({});\\n emit(SCROLL_INTO_VIEW, '#footer');\\n return story();\\n },\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 153]\"}, {\"title\": \"Histogram Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { HistogramComponent } from './histogram.component';\\n\\nconst meta: Meta<HistogramComponent> = {\\n component: HistogramComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<HistogramComponent>;\\n\\nexport const Default: Story = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport { createHistogram } from './Histogram';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Histogram',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Default = {\\n render: (args) => createHistogram(args),\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createHistogram, HistogramProps } from './Histogram';\\n\\nconst meta: Meta<HistogramProps> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Histogram',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<HistogramProps>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Default: Story = {\\n render: (args) => createHistogram(args),\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\n/** @jsx h */\\nimport { h } from 'preact';\\n\\nimport { Histogram } from './Histogram';\\n\\nexport default {\\n component: Histogram,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Default = {\\n render: (args) => <Histogram {...args} />,\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport { Histogram } from './Histogram';\\n\\nexport default {\\n component: Histogram,\\n};\\n\\nexport const Default = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Histogram } from './Histogram';\\n\\nconst meta = {\\n component: Histogram,\\n} satisfies Meta<typeof Histogram>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport { Histogram } from './Histogram';\\n\\nexport default {\\n component: Histogram,\\n};\\n\\nexport const Default = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Histogram } from './Histogram';\\n\\nconst meta = {\\n component: Histogram,\\n} satisfies Meta<typeof Histogram>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Histogram from './Histogram.svelte';\\n\\n const { Story } = defineMeta({\\n component: Histogram,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Default\\\"\\n args={{\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n }}\\n/>\\n```\", \"```\\nimport Histogram from './Histogram.svelte';\\n\\nexport default {\\n component: Histogram,\\n};\\n\\nexport const Default = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Histogram from './Histogram.svelte';\\n\\n const { Story } = defineMeta({\\n component: Histogram,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Default\\\"\\n args={{\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Histogram from './Histogram.svelte';\\n\\nconst meta = {\\n component: Histogram,\\n} satisfies Meta<typeof Histogram>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport Histogram from './Histogram.vue';\\n\\nexport default {\\n component: Histogram,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Default = {\\n render: (args) => ({\\n components: { Histogram },\\n setup() {\\n return { args };\\n },\\n template: '<Histogram v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Histogram from './Histogram.vue';\\n\\nconst meta = {\\n component: Histogram,\\n} satisfies Meta<typeof Histogram>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Default: Story = {\\n render: (args) => ({\\n components: { Histogram },\\n setup() {\\n return { args };\\n },\\n template: '<Histogram v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'histogram-component',\\n};\\n\\nexport const Default = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'histogram-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n args: {\\n dataType: 'latency',\\n showHistogramLabels: true,\\n histogramAccentColor: '#1EA7FD',\\n label: 'Latency distribution',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 154]\"}, {\"title\": \"Individual Snapshot Tests Portable Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\nimport * as glob from 'glob';\\n\\n//\\ud83d\\udc47 Augment expect with jest-specific-snapshot\\nimport 'jest-specific-snapshot';\\n\\nimport { describe, test, expect } from '@jest/globals';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}')\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n\\n return { filePath, storyFile, storyDir, componentName };\\n });\\n}\\n\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n // Defines the custom snapshot path location and file name\\n const customSnapshotPath = `./__snapshots__/${componentName}.test.js.snap`;\\n expect(document.body.firstChild).toMatchSpecificSnapshot(customSnapshotPath);\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport path from \\\"path\\\";\\nimport * as glob from \\\"glob\\\";\\n\\n//\\ud83d\\udc47 Augment expect with jest-specific-snapshot\\nimport \\\"jest-specific-snapshot\\\";\\n\\nimport { describe, test, expect } from \\\"@jest/globals\\\";\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (\\n entry: StoryFile\\n): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}'),\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n const storyDir = path.dirname(filePath);\\n const componentName = path\\n .basename(filePath)\\n .replace(/\\\\.(stories|story)\\\\.[^/.]+$/, \\\"\\\");\\n\\n return { filePath, storyFile, storyDir, componentName };\\n });\\n}\\n\\ndescribe(\\\"Stories Snapshots\\\", () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(\\n ([name, story]) => ({ name, story })\\n );\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n // Defines the custom snapshot path location and file name\\n const customSnapshotPath = `./__snapshots__/${componentName}.test.ts.snap`;\\n expect(document.body.firstChild).toMatchSpecificSnapshot(customSnapshotPath);\\n });\\n });\\n });\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\nimport path from 'path';\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (error) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${error}`\\n );\\n }\\n};\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n // Defines the custom snapshot path location and file name\\n const customSnapshotPath = `./__snapshots__/${componentName}.spec.js.snap`;\\n await expect(document.body.firstChild).toMatchFileSnapshot(customSnapshotPath);\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport path from 'path';\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (entry: StoryFile): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob<StoryFile>('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\n\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n // Defines the custom snapshot path location and file name\\n const customSnapshotPath = `./__snapshots__/${componentName}.spec.ts.snap`;\\n await expect(document.body.firstChild).toMatchFileSnapshot(customSnapshotPath);\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 155]\"}, {\"title\": \"Init Command Custom Version\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@8.2 init\\n```\", \"```\\npnpm dlx storybook@8.2 init\\n```\", \"```\\nyarn dlx storybook@8.2 init\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 156]\"}, {\"title\": \"Init Command\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@next init\\n```\", \"```\\npnpm dlx storybook@next init\\n```\", \"```\\nyarn dlx storybook@next init\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 157]\"}, {\"title\": \"Interaction Test Complex\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\nimport { EventForm } from './EventForm.component';\\n\\nconst meta: Meta<EventForm> = {\\n component: EventForm,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<EventForm>;\\n\\nexport const Submits: Story = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework (e.g. react-vite, vue3-vite, etc.)\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\nimport { EventForm } from './EventForm';\\n\\nconst meta = {\\n component: EventForm,\\n} satisfies Meta<typeof EventForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Submits: Story = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\nimport { EventForm } from './EventForm';\\n\\nexport default {\\n component: EventForm,\\n};\\n\\nexport const Submits = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { fn, expect } from 'storybook/test';\\n\\n import { users } from '../mocks/users';\\n import { EventForm } from './EventForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: EventForm,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Submits\\\"\\n args={{\\n // Mock functions so we can manipulate and spy on them\\n getUsers: fn(),\\n onSubmit: fn(),\\n }}\\n beforeEach={async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n }}\\n play={async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\nimport { EventForm } from './EventForm.svelte';\\n\\nconst meta = {\\n component: EventForm,\\n} satisfies Meta<typeof EventForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Submits: Story = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { fn, expect } from 'storybook/test';\\n\\n import { users } from '../mocks/users';\\n import { EventForm } from './EventForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: EventForm,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Submits\\\"\\n args={{\\n // Mock functions so we can manipulate and spy on them\\n getUsers: fn(),\\n onSubmit: fn(),\\n }}\\n beforeEach={async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n }}\\n play={async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n }}\\n/>\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\nimport { EventForm } from './EventForm.svelte';\\n\\nexport default {\\n component: EventForm,\\n};\\n\\nexport const Submits = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\n\\nconst meta: Meta = {\\n component: 'demo-event-form',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Submits: Story = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { users } from '../mocks/users';\\n\\nexport default {\\n component: 'demo-event-form',\\n};\\n\\nexport const Submits = {\\n // Mock functions so we can manipulate and spy on them\\n args: {\\n getUsers: fn(),\\n onSubmit: fn(),\\n },\\n beforeEach: async ({ args }) => {\\n // Manipulate `getUsers` mock to return mocked value\\n args.getUsers.mockResolvedValue(users);\\n },\\n play: async ({ args, canvas, userEvent }) => {\\n const usersList = canvas.getAllByRole('listitem');\\n await expect(usersList).toHaveLength(4);\\n await expect(canvas.getAllByText('VIP')).toHaveLength(2);\\n\\n const titleInput = await canvas.findByLabelText('Enter a title for your event');\\n await userEvent.type(titleInput, 'Holiday party');\\n\\n const submitButton = canvas.getByRole('button', { text: 'Plan event' });\\n await userEvent.click(submitButton);\\n\\n // Spy on `onSubmit` to verify that it is called correctly\\n await expect(args.onSubmit).toHaveBeenCalledWith({\\n name: 'Holiday party',\\n userCount: 4,\\n data: expect.anything(),\\n });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 158]\"}, {\"title\": \"Interaction Test Fn Mock Spy\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm.component';\\n\\nconst meta: Meta<LoginForm> = {\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<LoginForm>;\\n\\nexport const FilledForm: Story = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework (e.g. react-vite, vue3-vite, etc.)\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nconst meta = {\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const FilledForm: Story = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nexport default {\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\nexport const FilledForm = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import LoginForm from './LoginForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm.svelte';\\n\\nconst meta = {\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const FilledForm: Story = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import LoginForm from './LoginForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n });\\n</script>\\n\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n }}\\n/>\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm.svelte';\\n\\nexport default {\\n component: LoginForm,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\nexport const FilledForm = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { fn, expect } from 'storybook/test';\\n\\nconst meta: Meta = {\\n component: 'demo-login-form',\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const FilledForm: Story = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { fn, expect } from 'storybook/test';\\n\\nexport default {\\n component: 'demo-login-form',\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\nexport const FilledForm = {\\n play: async ({ args, canvas, userEvent }) => {\\n await userEvent.type(canvas.getByLabelText('Email'), 'email@provider.com');\\n await userEvent.type(canvas.getByLabelText('Password'), 'a-random-password');\\n await userEvent.click(canvas.getByRole('button', { name: 'Log in' }));\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await expect(args.onSubmit).toHaveBeenCalled();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 159]\"}, {\"title\": \"Interaction Test Simple\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { expect } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog.component';\\n\\nconst meta: Meta<Dialog> = {\\n component: Dialog,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Dialog>;\\n\\nexport const Opens: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework (e.g. react-vite, vue3-vite, etc.)\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { expect } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog';\\n\\nconst meta = {\\n component: Dialog,\\n} satisfies Meta<typeof Dialog>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Opens: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog';\\n\\nexport default {\\n component: Dialog,\\n};\\n\\nexport const Opens = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Dialog from './Dialog.svelte';\\n\\n const { Story } = defineMeta({\\n component: Dialog,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Opens\\\"\\n play={async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { expect } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog.svelte';\\n\\nconst meta = {\\n component: Dialog,\\n} satisfies Meta<typeof Dialog>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Opens: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Dialog from './Dialog.svelte';\\n\\n const { Story } = defineMeta({\\n component: Dialog,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Opens\\\"\\n play={async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n }}\\n/>\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog.svelte';\\n\\nexport default {\\n component: Dialog,\\n};\\n\\nexport const Opens = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { expect } from 'storybook/test';\\n\\nconst meta: Meta = {\\n component: 'demo-dialog',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Opens: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nexport default {\\n component: 'demo-dialog',\\n};\\n\\nexport const Opens = {\\n play: async ({ canvas, userEvent }) => {\\n // Click on a button and assert that a dialog appears\\n const button = canvas.getByRole('button', { text: 'Open Modal' });\\n await userEvent.click(button);\\n await expect(canvas.getByRole('dialog')).toBeInTheDocument();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 160]\"}, {\"title\": \"List Story Expanded\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\nimport { ListItem } from './list-item.component';\\n\\nconst meta: Meta<List> = {\\n component: List,\\n decorators: [\\n moduleMetadata({\\n declarations: [List, ListItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<List>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {\\n render: (args) => ({\\n props: args,\\n template: '<app-list></app-list>',\\n }),\\n};\\n\\nexport const OneItem: Story = {\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <app-list-item></app-list-item>\\n </app-list>`,\\n }),\\n};\\n\\nexport const ManyItems: Story = {\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <app-list-item></app-list-item>\\n <app-list-item></app-list-item>\\n <app-list-item></app-list-item>\\n </app-list>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { createList } from './List';\\nimport { createListItem } from './ListItem';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Empty = {\\n render: () => createList(args),\\n};\\n\\nexport const OneItem = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem());\\n return list;\\n },\\n};\\n\\nexport const ManyItems = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem());\\n list.appendChild(createListItem());\\n list.appendChild(createListItem());\\n return list;\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createList, ListArgs } from './List';\\nimport { createListItem } from './ListItem';\\n\\nconst meta: Meta<ListArgs> = {\\n title: 'List',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ListArgs>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Empty: Story = {\\n render: () => createList(args),\\n};\\n\\nexport const OneItem: Story = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem());\\n return list;\\n },\\n};\\n\\nexport const ManyItems: Story = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem());\\n list.appendChild(createListItem());\\n list.appendChild(createListItem());\\n return list;\\n },\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nexport default {\\n component: List,\\n};\\n\\nexport const Empty = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n\\nexport const ManyItems = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Empty: Story = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n\\nexport const ManyItems: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nexport default {\\n component: List,\\n};\\n\\nexport const Empty = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n\\nexport const ManyItems = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Empty: Story = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n\\nexport const ManyItems: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<Story name=\\\"Empty\\\" />\\n\\n<Story name=\\\"One Item\\\">\\n {#snippet template(args)}\\n <List {...args} >\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n\\n<Story name=\\\"Many Items\\\">\\n {#snippet template(args)}\\n <List {...args} >\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<Story name=\\\"Empty\\\" />\\n\\n<Story name=\\\"One Item\\\">\\n {#snippet template(args)}\\n <List {...args} >\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n\\n<Story name=\\\"Many Items\\\">\\n {#snippet template(args)}\\n <List {...args} >\\n <ListItem />\\n <ListItem />\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport List from './ListComponent.vue';\\nimport ListItem from './ListItem.vue';\\n\\nexport default {\\n component: List,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Empty = {\\n render: () => ({\\n components: { List },\\n template: '<List/>',\\n }),\\n};\\n\\nexport const OneItem = {\\n render: () => ({\\n components: { List, ListItem },\\n template: `\\n <List>\\n <list-item/>\\n </List>`,\\n }),\\n};\\n\\nexport const ManyItems = {\\n render: () => ({\\n components: { List, ListItem },\\n template: `\\n <List>\\n <list-item/>\\n <list-item/>\\n <list-item/>\\n </List>`,\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './ListComponent.vue';\\nimport ListItem from './ListItem.vue';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Empty: Story = {\\n render: () => ({\\n components: { List },\\n template: '<List/>',\\n }),\\n};\\n\\nexport const OneItem: Story = {\\n render: () => ({\\n components: { List, ListItem },\\n template: `\\n <List>\\n <list-item/>\\n </List>`,\\n }),\\n};\\n\\nexport const ManyItems: Story = {\\n render: (args) => ({\\n components: { List, ListItem },\\n template: `\\n <List>\\n <list-item/>\\n <list-item/>\\n <list-item/>\\n </List>`,\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-list',\\n};\\n\\nexport const Empty = {\\n render: () => html`<demo-list></demo-list>`,\\n};\\n\\nexport const OneItem = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n\\nexport const ManyItems = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n <demo-list-item></demo-list-item>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-list',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Empty: Story = {\\n render: () => html`<demo-list></demo-list>`,\\n};\\n\\nexport const OneItem: Story = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n\\nexport const ManyItems: Story = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n <demo-list-item></demo-list-item>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 161]\"}, {\"title\": \"List Story Reuse Data\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\nimport { ListItem } from './list-item.component';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta: Meta<List> = {\\n component: List,\\n decorators: [\\n moduleMetadata({\\n declarations: [List, ListItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<List>;\\n\\nexport const ManyItems: Story = {\\n args: {\\n Selected: Selected.args.isSelected,\\n Unselected: Unselected.args.isSelected,\\n },\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <app-list-item [isSelected]=\\\"Selected\\\"></app-list-item>\\n <app-list-item [isSelected]=\\\"Unselected\\\"></app-list-item>\\n <app-list-item [isSelected]=\\\"Unselected\\\"></app-list-item>\\n </app-list>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { createList } from './List';\\nimport { createListItem } from './ListItem';\\n\\n// \\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nexport default {\\n title: 'List',\\n};\\n\\nexport const ManyItems = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem(Selected.args));\\n list.appendChild(createListItem(Unselected.args));\\n list.appendChild(createListItem(Unselected.args));\\n return list;\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createList, ListArgs } from './List';\\nimport { createListItem } from './ListItem';\\n\\n// \\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta: Meta<ListArgs> = {\\n title: 'List',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ListArgs>;\\n\\nexport const ManyItems: Story = {\\n render: (args) => {\\n const list = createList(args);\\n list.appendChild(createListItem(Selected.args));\\n list.appendChild(createListItem(Unselected.args));\\n list.appendChild(createListItem(Unselected.args));\\n return list;\\n },\\n};\\n```\", \"```\\nimport React from 'react';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nexport default {\\n component: List,\\n};\\n\\nexport const ManyItems = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ManyItems: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nexport default {\\n component: List,\\n};\\n\\nexport const ManyItems = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ManyItems: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n //\\ud83d\\udc47 We're importing the necessary stories from ListItem\\n import { Selected, Unselected } from './ListItem.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<Story name=\\\"Many Items\\\">\\n {#snippet children(args)}\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n //\\ud83d\\udc47 We're importing the necessary stories from ListItem\\n import { Selected, Unselected } from './ListItem.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<Story name=\\\"Many Items\\\">\\n {#snippet children(args)}\\n <List {...args}>\\n <ListItem {...Selected.args} />\\n <ListItem {...Unselected.args} />\\n <ListItem {...Unselected.args} />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport List from './ListComponent.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nexport default {\\n component: List,\\n};\\n\\nexport const ManyItems = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { ...args };\\n },\\n template: `\\n <List v-bind=\\\"args\\\">\\n <list-item :isSelected=\\\"Selected\\\"/>\\n <list-item :isSelected=\\\"Unselected\\\"/>\\n <list-item :isSelected=\\\"Unselected\\\"/>\\n </List>`,\\n }),\\n args: {\\n Selected: Selected.args.isSelected,\\n Unselected: Unselected.args.isSelected,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './ListComponent.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ManyItems: Story = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { ...args };\\n },\\n template: `\\n <List v-bind=\\\"args\\\">\\n <list-item :isSelected=\\\"Selected\\\"/>\\n <list-item :isSelected=\\\"Unselected\\\"/>\\n <list-item :isSelected=\\\"Unselected\\\"/>\\n </List>`,\\n }),\\n args: {\\n Selected: Selected.args.isSelected,\\n Unselected: Unselected.args.isSelected,\\n },\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\n// \\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nexport default {\\n component: 'demo-list',\\n};\\n\\nexport const ManyItems = {\\n render: (args) => html`\\n <demo-list>\\n ${Selected({ ...args, ...Selected.args })} ${Unselected({ ...args, ...Unselected.args })}\\n ${Unselected({ ...args, ...Unselected.args })}\\n </demo-list>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\n// \\ud83d\\udc47 We're importing the necessary stories from ListItem\\nimport { Selected, Unselected } from './ListItem.stories';\\n\\nconst meta: Meta = {\\n component: 'demo-list',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ManyItems: Story = {\\n render: (args) => html`\\n <demo-list>\\n ${Selected({ ...args, ...Selected.args })} ${Unselected({ ...args, ...Unselected.args })}\\n ${Unselected({ ...args, ...Unselected.args })}\\n </demo-list>\\n `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 162]\"}, {\"title\": \"List Story Starter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\n\\nconst meta: Meta<List> = {\\n component: List,\\n decorators: [\\n moduleMetadata({\\n declarations: [List],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<List>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {\\n render: (args) => ({\\n props: args,\\n template: `<app-list></app-list>`,\\n }),\\n};\\n```\", \"```\\nimport { createList } from './List';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {\\n render: (args) => createList(args),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createList, ListArgs } from './List';\\n\\nconst meta: Meta<ListArgs> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ListArgs>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {\\n render: (args) => createList(args),\\n};\\n```\", \"```\\nimport { List } from './List';\\n\\nexport default {\\n component: List,\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {};\\n```\", \"```\\nimport { List } from './List';\\n\\nexport default {\\n component: List,\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<!-- Always an empty list, not super interesting -->\\n<Story name=\\\"Empty\\\" />\\n```\", \"```\\nimport List from './List.svelte';\\n\\nexport default {\\n component: List,\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n });\\n</script>\\n\\n<!-- Always an empty list, not super interesting -->\\n<Story name=\\\"Empty\\\" />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport List from './List.svelte';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {};\\n```\", \"```\\nimport List from './ListComponent.vue';\\n\\nexport default {\\n component: List,\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {\\n render: () => ({\\n components: { List },\\n template: '<List/>',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './ListComponent.vue';\\n\\nconst meta = {\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {\\n render: () => ({\\n components: { List },\\n template: '<List/>',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-list',\\n};\\n\\n// Always an empty list, not super interesting\\nexport const Empty = {\\n render: () => html`<demo-list></demo-list>`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-list',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n// Always an empty list, not super interesting\\nexport const Empty: Story = {\\n render: () => html`<demo-list></demo-list>`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 163]\"}, {\"title\": \"List Story Template\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\nimport { ListItem } from './list-item.component';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta: Meta<List> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n decorators: [\\n moduleMetadata({\\n declarations: [List, ListItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<List>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nconst ListTemplate: Story = {\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <div *ngFor=\\\"let item of items\\\">\\n <app-list-item [item]=\\\"item\\\"></app-list-item>\\n </div>\\n </app-list>\\n `,\\n }),\\n};\\n\\nexport const Empty: Story = {\\n ...ListTemplate,\\n args: { items: [] },\\n};\\n\\nexport const OneItem: Story = {\\n ...ListTemplate,\\n args: {\\n items: [{ ...Unchecked.args }],\\n },\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate = {\\n render: ({ items, ...args }) => {\\n return (\\n <List>\\n {items.map((item) => (\\n <ListItem {...item} />\\n ))}\\n </List>\\n );\\n },\\n};\\n\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * Seehttps://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate: Story = {\\n render: ({ items, ...args }) => {\\n return (\\n <List>\\n {items.map((item) => (\\n <ListItem {...item} />\\n ))}\\n </List>\\n );\\n },\\n};\\n\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [{ ...Unchecked.args }],\\n },\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate = {\\n render: ({ items, ...args }) => {\\n return (\\n <List>\\n {items.map((item) => (\\n <ListItem {...item} />\\n ))}\\n </List>\\n );\\n },\\n};\\n\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * Seehttps://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate: Story = {\\n render: ({ items, ...args }) => {\\n return (\\n <List>\\n {items.map((item) => (\\n <ListItem {...item} />\\n ))}\\n </List>\\n );\\n },\\n};\\n\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [{ ...Unchecked.args }],\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n //\\ud83d\\udc47 Imports a specific story from ListItem stories\\n import { Unchecked } from './ListItem.stories.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n });\\n</script>\\n\\n<!--\\n The template construct will be spread to the existing stories.\\n It's based on Svelte's snippet syntax allowing you share the same UI with small variations.\\n-->\\n{#snippet template(args)}\\n <List {...args}>\\n {#each args.items as item}\\n <ListItem {...item} />\\n {/each}\\n </List>\\n{/snippet}\\n\\n<Story name=\\\"Empty\\\" args={{ items: [] }} {template} />\\n\\n<Story\\n name=\\\"One Item\\\"\\n args={{\\n items: [{ ...Unchecked.args }],\\n }}\\n {template}\\n/>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n //\\ud83d\\udc47 Imports a specific story from ListItem stories\\n import { Unchecked } from './ListItem.stories.svelte';\\n\\n const { Story } = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n });\\n</script>\\n\\n<!--\\n The template construct will be spread to the existing stories.\\n It's based on Svelte's snippet syntax allowing you share the same UI with small variations.\\n-->\\n{#snippet template(args)}\\n <List {...args}>\\n {#each args.items as item}\\n <ListItem {...item} />\\n {/each}\\n </List>\\n{/snippet}\\n\\n<Story name=\\\"Empty\\\" args={{ items: [] }} {template} />\\n\\n<Story\\n name=\\\"One Item\\\"\\n args={{\\n items: [{ ...Unchecked.args }],\\n }}\\n {template}\\n/>\\n```\", \"```\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { ...args };\\n },\\n template: `\\n <List v-bind=\\\"args\\\">\\n <div v-for=\\\"item in items\\\" :key=\\\"item.title\\\">\\n <ListItem :item=\\\"item\\\"/>\\n </div>\\n </List>\\n `,\\n }),\\n};\\n\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nexport const ListTemplate: Story = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { ...args };\\n },\\n template: `\\n <List v-bind=\\\"args\\\">\\n <div v-for=\\\"item in items\\\" :key=\\\"item.title\\\">\\n <ListItem :item=\\\"item\\\"/>\\n </div>\\n </List>\\n `,\\n }),\\n};\\n\\nexport const Empty: Story = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\nexport const OneItem: Story = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\", \"```\\nimport { html } from 'lit';\\nimport { repeat } from 'lit/directives/repeat.js';\\n\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n title: 'List',\\n component: 'demo-list',\\n};\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate = {\\n render: ({ items, ...args }) => {\\n return html`\\n <demo-list>\\n ${repeat(items, (item) => html`<demo-list-item>${item}</demo-list-item>`)}\\n </demo-list>\\n `;\\n },\\n};\\nexport const Empty = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\nimport { repeat } from 'lit/directives/repeat.js';\\n\\nconst meta: Meta = {\\n title: 'List',\\n component: 'demo-list',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n//\\ud83d\\udc47 The ListTemplate construct will be spread to the existing stories.\\nconst ListTemplate = {\\n render: ({ items, ...args }) => {\\n return html`\\n <demo-list>\\n ${repeat(items, (item) => html`<demo-list-item>${item}</demo-list-item>`)}\\n </demo-list>\\n `;\\n },\\n};\\n\\nexport const Empty: Story = {\\n ...ListTemplate,\\n args: {\\n items: [],\\n },\\n};\\n\\nexport const OneItem: Story = {\\n ...ListTemplate,\\n args: {\\n items: [\\n {\\n ...Unchecked.args,\\n },\\n ],\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 164]\"}, {\"title\": \"List Story Unchecked\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\nimport { ListItem } from './list-item.component';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta: Meta<List> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n decorators: [\\n moduleMetadata({\\n declarations: [List, ListItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<List>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem: Story = {\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <app-list-item [item]=\\\"item\\\"></app-list-item>\\n </app-list>\\n `,\\n }),\\n args: {\\n ...Unchecked.args,\\n },\\n};\\n```\", \"```\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <Unchecked {...Unchecked.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport const meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <Unchecked {...Unchecked.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <Unchecked {...Unchecked.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport const meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <Unchecked {...Unchecked.args} />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem = {\\n args: {\\n ...Unchecked.args,\\n },\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n //\\ud83d\\udc47 The args will now be passed down to the template\\n return { args };\\n },\\n template: '<List v-bind=\\\"args\\\"><ListItem v-bind=\\\"args\\\"/></List>',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\n//\\ud83d\\udc47 Imports a specific story from ListItem stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const OneItem: Story = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n //\\ud83d\\udc47 The args will now be passed down to the template\\n return { args };\\n },\\n template: '<List v-bind=\\\"args\\\"><ListItem v-bind=\\\"args\\\"/></List>',\\n }),\\n args: {\\n ...Unchecked.args,\\n },\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\n// \\ud83d\\udc47 Import the stories of MyListItem\\nimport { Unchecked } from './MyListItem.stories';\\n\\nexport default {\\n title: 'MyList',\\n component: 'demo-my-list',\\n};\\n\\nexport const OneItem = {\\n render: () => html` <List> ${Unchecked({ ...Unchecked.args })} </List> `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\n// \\ud83d\\udc47 Import the stories of MyListItem\\nimport { Unchecked } from './my-list-item.stories';\\n\\nconst meta: Meta = {\\n title: 'MyList',\\n component: 'demo-my-list',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const OneItem: Story = {\\n render: () => html` <List> ${Unchecked({ ...Unchecked.args })} </List> `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 165]\"}, {\"title\": \"List Story With Subcomponents\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { List } from './list.component';\\nimport { ListItem } from './list-item.component';\\n\\nconst meta: Meta<List> = {\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n decorators: [\\n moduleMetadata({\\n declarations: [List, ListItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<List>;\\n\\nexport const Empty: Story = {};\\n\\nexport const OneItem: Story = {\\n args: {},\\n render: (args) => ({\\n props: args,\\n template: `\\n <app-list>\\n <app-list-item></app-list-item>\\n </app-list>\\n `,\\n }),\\n};\\n```\", \"```\\nimport React from 'react';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nexport default {\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n};\\n\\nexport const Empty = {};\\n\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nconst meta = {\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n} satisfies Meta<typeof List>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Empty: Story = {};\\n\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n};\\n\\nexport const Empty = {};\\n\\nexport const OneItem = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\nimport { ListItem } from './ListItem';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n subcomponents: { ListItem },\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Empty: Story = {};\\n\\nexport const OneItem: Story = {\\n render: (args) => (\\n <List {...args}>\\n <ListItem />\\n </List>\\n ),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n subcomponents: { ListItem },\\n });\\n</script>\\n\\n<Story name=\\\"Empty\\\" />\\n\\n<Story name=\\\"One Item\\\">\\n {#snippet children(args)}\\n <List {...args}>\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import List from './List.svelte';\\n import ListItem from './ListItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: List,\\n subcomponents: { ListItem },\\n });\\n</script>\\n\\n<Story name=\\\"Empty\\\" />\\n\\n<Story name=\\\"One Item\\\">\\n {#snippet children(args)}\\n <List {...args}>\\n <ListItem />\\n </List>\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'List',\\n component: 'demo-list',\\n subcomponents: { ListItem: 'demo-list-item' }, // \\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n};\\n\\nexport const Empty = {};\\n\\nexport const OneItem = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n title: 'List',\\n component: 'demo-list',\\n subcomponents: { ListItem: 'demo-list-item' }, // \\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Empty: Story = {};\\n\\nexport const OneItem: Story = {\\n render: () => html`\\n <demo-list>\\n <demo-list-item></demo-list-item>\\n </demo-list>\\n `,\\n};\\n```\", \"```\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\nexport default {\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n};\\n\\nexport const Empty = {\\n render: () => ({\\n components: { List },\\n template: '<List/>',\\n }),\\n};\\n\\nexport const OneItem = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { args }\\n }\\n template: '<List v-bind=\\\"args\\\"><ListItem /></List>',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport List from './List.vue';\\nimport ListItem from './ListItem.vue';\\n\\nconst meta = {\\n component: List,\\n subcomponents: { ListItem }, //\\ud83d\\udc48 Adds the ListItem component as a subcomponent\\n} satisfies Meta<typeof List>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Empty: Story = {\\n render: () => ({\\n components: { List },\\n template: '<List />',\\n }),\\n};\\n\\nexport const OneItem: Story = {\\n render: (args) => ({\\n components: { List, ListItem },\\n setup() {\\n return { args }\\n }\\n template: '<List v-bind=\\\"args\\\"><ListItem /></List>',\\n }),\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 166]\"}, {\"title\": \"List Story With Unchecked Children\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\nexport const OneItem = {\\n args: {\\n children: <Unchecked {...Unchecked.args} />,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OneItem: Story = {\\n args: {\\n children: <Unchecked {...Unchecked.args} />,\\n },\\n};\\n```\", \"```\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n};\\n\\nexport const OneItem = {\\n args: {\\n children: <Unchecked {...Unchecked.args} />,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { List } from './List';\\n\\n//\\ud83d\\udc47 Instead of importing ListItem, we import the stories\\nimport { Unchecked } from './ListItem.stories';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'List',\\n component: List,\\n} satisfies Meta<typeof List>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const OneItem: Story = {\\n args: {\\n children: <Unchecked {...Unchecked.args} />,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 167]\"}, {\"title\": \"Loader Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { TodoItem } from './TodoItem';\\n\\nconst meta: Meta<TodoItem> = {\\n component: TodoItem,\\n decorators: [\\n moduleMetadata({\\n declarations: [TodoItem],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<TodoItem>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args, { loaded: { todo } }) => ({\\n props: {\\n args,\\n todo,\\n },\\n }),\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport { TodoItem } from './TodoItem';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport default {\\n component: TodoItem,\\n render: (args, { loaded: { todo } }) => <TodoItem {...args} {...todo} />,\\n};\\n\\nexport const Primary = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { TodoItem } from './TodoItem';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nconst meta = {\\n component: TodoItem,\\n render: (args, { loaded: { todo } }) => <TodoItem {...args} {...todo} />,\\n} satisfies Meta<typeof TodoItem>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport { TodoItem } from './TodoItem';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport default {\\n component: TodoItem,\\n render: (args, { loaded: { todo } }) => <TodoItem {...args} {...todo} />,\\n};\\n\\nexport const Primary = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { TodoItem } from './TodoItem';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nconst meta = {\\n component: TodoItem,\\n render: (args, { loaded: { todo } }) => <TodoItem {...args} {...todo} />,\\n} satisfies Meta<typeof TodoItem>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import TodoItem from './TodoItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: TodoItem,\\n render: template,\\n });\\n</script>\\n\\n{#snippet template(args, { loaded: { todo } })}\\n <TodoItem {...args} {...todo} />\\n{/snippet}\\n\\n<Story\\n name=\\\"Primary\\\"\\n loaders={[\\n async () => ({\\n todo: await (\\n await fetch('https://jsonplaceholder.typicode.com/todos/1')\\n ).json(),\\n }),\\n ]}\\n/>\\n```\", \"```\\nimport TodoItem from './TodoItem.svelte';\\n\\nexport default {\\n component: TodoItem,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args, { loaded: { todo } }) => ({\\n Component: TodoItem,\\n props: {\\n ...args,\\n todo,\\n },\\n }),\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import TodoItem from './TodoItem.svelte';\\n\\n const { Story } = defineMeta({\\n component: TodoItem,\\n render: template,\\n });\\n</script>\\n\\n{#snippet template(args, { loaded: { todo } })}\\n <TodoItem {...args} {...todo} />\\n{/snippet}\\n\\n<Story\\n name=\\\"Primary\\\"\\n loaders={[\\n async () => ({\\n todo: await (\\n await fetch('https://jsonplaceholder.typicode.com/todos/1')\\n ).json(),\\n }),\\n ]}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport TodoItem from './TodoItem.svelte';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/svelte/api/csf\\n * to learn how to use render functions.\\n */\\nconst meta = {\\n component: TodoItem,\\n render: (args, { loaded: { todo } }) => ({\\n Component: TodoItem,\\n props: {\\n ...args,\\n ...todo,\\n },\\n }),\\n} satisfies Meta<typeof TodoItem>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport TodoItem from './TodoItem.vue';\\n\\nexport default {\\n component: TodoItem,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary = {\\n render: (args, { loaded: { todo } }) => ({\\n components: { TodoItem },\\n setup() {\\n return { args, todo: todo };\\n },\\n template: '<TodoItem :todo=\\\"todo\\\" />',\\n }),\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport TodoItem from './TodoItem.vue';\\n\\nconst meta = {\\n component: TodoItem,\\n} satisfies Meta<typeof TodoItem>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args, { loaded: { todo } }) => ({\\n components: { TodoItem },\\n setup() {\\n return { args, todo: todo };\\n },\\n template: '<TodoItem :todo=\\\"todo\\\" />',\\n }),\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport default {\\n component: 'demo-todo-item',\\n render: (args, { loaded: { todo } }) => TodoItem({ ...args, ...todo }),\\n};\\n\\nexport const Primary = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nconst meta: Meta = {\\n component: 'demo-todo-item',\\n render: (args, { loaded: { todo } }) => TodoItem({ ...args, ...todo }),\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary: Story = {\\n loaders: [\\n async () => ({\\n todo: await (await fetch('https://jsonplaceholder.typicode.com/todos/1')).json(),\\n }),\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 168]\"}, {\"title\": \"Login Form With Play Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm.component';\\n\\nconst meta: Meta<LoginForm> = {\\n component: LoginForm,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<LoginForm>;\\n\\nexport const EmptyForm: Story = {};\\n\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nexport default {\\n component: LoginForm,\\n};\\n\\nexport const EmptyForm = {};\\n\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nconst meta = {\\n component: LoginForm,\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const EmptyForm: Story = {};\\n\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nexport default {\\n component: LoginForm,\\n};\\n\\nexport const EmptyForm = {};\\n\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { expect } from 'storybook/test';\\n\\nimport { LoginForm } from './LoginForm';\\n\\nconst meta = {\\n component: LoginForm,\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const EmptyForm: Story = {};\\n\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect, userEvent, within } from 'storybook/test';\\n\\n import LoginForm from './LoginForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: LoginForm,\\n });\\n</script>\\n\\n<Story name=\\\"EmptyForm\\\" />\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n-->\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n }}\\n/>\\n```\", \"```\\nimport { expect, userEvent, within } from 'storybook/test';\\n\\nimport LoginForm from './LoginForm.svelte';\\n\\nexport default {\\n component: LoginForm,\\n};\\n\\nexport const EmptyForm = {};\\n\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect, userEvent, within } from 'storybook/test';\\n\\n import LoginForm from './LoginForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: LoginForm,\\n });\\n</script>\\n\\n<Story name=\\\"EmptyForm\\\" />\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n-->\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect, userEvent, within } from 'storybook/test';\\n\\nimport LoginForm from './LoginForm.svelte';\\n\\nconst meta = {\\n component: LoginForm,\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const EmptyForm: Story = {};\\n\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nimport LoginForm from './LoginForm.vue';\\n\\nexport default {\\n component: LoginForm,\\n};\\n\\nexport const EmptyForm = {\\n render: () => ({\\n components: { LoginForm },\\n template: `<LoginForm />`,\\n }),\\n};\\n\\nexport const FilledForm = {\\n render: () => ({\\n components: { LoginForm },\\n template: `<LoginForm />`,\\n }),\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { expect } from 'storybook/test';\\n\\nimport LoginForm from './LoginForm.vue';\\n\\nconst meta = {\\n component: LoginForm,\\n} satisfies Meta<typeof LoginForm>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const EmptyForm: Story = {\\n render: () => ({\\n components: { LoginForm },\\n template: `<LoginForm />`,\\n }),\\n};\\n\\nexport const FilledForm: Story = {\\n render: () => ({\\n components: { LoginForm },\\n template: `<LoginForm />`,\\n }),\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\nexport default {\\n component: 'demo-login-form',\\n};\\n\\nexport const EmptyForm = {};\\n\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { expect } from 'storybook/test';\\n\\nconst meta: Meta = {\\n component: 'demo-login-form',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const EmptyForm: Story = {};\\n\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // \\ud83d\\udc47 Simulate interactions with the component\\n await userEvent.type(canvas.getByTestId('email'), 'email@provider.com');\\n\\n await userEvent.type(canvas.getByTestId('password'), 'a-random-password');\\n\\n // See https://storybook.js.org/docs/essentials/actions#automatically-matching-args to learn how to setup logging in the Actions panel\\n await userEvent.click(canvas.getByRole('button'));\\n\\n // \\ud83d\\udc47 Assert DOM structure\\n await expect(\\n canvas.getByText(\\n 'Everything is perfect. Your account is ready and we should probably get you started!'\\n )\\n ).toBeInTheDocument();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 169]\"}, {\"title\": \"Main Config Addons\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { fileURLToPath } from 'node:url';\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n '@storybook/addon-docs',\\n {\\n name: '@storybook/addon-styling-webpack',\\n options: {\\n rules: [\\n {\\n test: /\\\\.css$/,\\n use: [\\n 'style-loader',\\n 'css-loader',\\n {\\n loader: 'postcss-loader',\\n options: {\\n implementation: fileURLToPath(import.meta.resolve('postcss')),\\n },\\n },\\n ],\\n },\\n ],\\n },\\n },\\n ],\\n};\\n```\", \"```\\nimport { fileURLToPath } from 'node:url';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n '@storybook/addon-docs',\\n {\\n name: '@storybook/addon-styling-webpack',\\n options: {\\n rules: [\\n {\\n test: /\\\\.css$/,\\n use: [\\n 'style-loader',\\n 'css-loader',\\n {\\n loader: 'postcss-loader',\\n options: {\\n implementation: fileURLToPath(import.meta.resolve('postcss')),\\n },\\n },\\n ],\\n },\\n ],\\n },\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 170]\"}, {\"title\": \"Main Config Babel\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async babel(config, { configType }) {\\n if (configType === 'DEVELOPMENT') {\\n // Your development configuration goes here\\n }\\n if (configType === 'PRODUCTION') {\\n // Your production configuration goes here.\\n }\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async babel(config, { configType }) {\\n if (configType === 'DEVELOPMENT') {\\n // Your development configuration goes here\\n }\\n if (configType === 'PRODUCTION') {\\n // Your production configuration goes here.\\n }\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 171]\"}, {\"title\": \"Main Config Builder Custom Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n builder: {\\n name: '@storybook/builder-vite',\\n options: {\\n viteConfigPath: '../customVite.config.js',\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 172]\"}, {\"title\": \"Main Config Core Builder\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n builder: {\\n name: '@storybook/builder-vite',\\n options: {\\n viteConfigPath: '../../../vite.config.js',\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n framework: '@storybook/your-framework',\\n core: {\\n builder: {\\n name: '@storybook/builder-vite',\\n options: {\\n viteConfigPath: '../../../vite.config.js',\\n },\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 173]\"}, {\"title\": \"Main Config Core Cross Origin Isolated\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n crossOriginIsolated: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n crossOriginIsolated: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 174]\"}, {\"title\": \"Main Config Core Disable Project Json\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableProjectJson: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableProjectJson: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 175]\"}, {\"title\": \"Main Config Core Disable Telemetry\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableTelemetry: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableTelemetry: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 176]\"}, {\"title\": \"Main Config Core Disable Update Notifications\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableWhatsNewNotifications: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableWhatsNewNotifications: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 177]\"}, {\"title\": \"Main Config Core Disable Webpack Defaults\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableWebpackDefaults: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableWebpackDefaults: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 178]\"}, {\"title\": \"Main Config Core Enable Crash Reports\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n enableCrashReports: true, // \\ud83d\\udc48 Appends the crash reports to the telemetry events\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n enableCrashReports: true, // \\ud83d\\udc48 Appends the crash reports to the telemetry events\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 179]\"}, {\"title\": \"Main Config Docs Autodocs\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n autodocs: 'tag',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n autodocs: 'tag',\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 180]\"}, {\"title\": \"Main Config Docs Default Name\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n defaultName: 'Documentation',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n defaultName: 'Documentation',\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 181]\"}, {\"title\": \"Main Config Docs Docs Mode\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n docsMode: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n docs: {\\n docsMode: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 182]\"}, {\"title\": \"Main Config Env\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n /*\\n * \\ud83d\\udc47 The `config` argument contains all the other existing environment variables.\\n * Either configured in an `.env` file or configured on the command line.\\n */\\n env: (config) => ({\\n ...config,\\n EXAMPLE_VAR: 'An environment variable configured in Storybook',\\n }),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n /*\\n * \\ud83d\\udc47 The `config` argument contains all the other existing environment variables.\\n * Either configured in an `.env` file or configured on the command line.\\n */\\n env: (config) => ({\\n ...config,\\n EXAMPLE_VAR: 'An environment variable configured in Storybook',\\n }),\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 183]\"}, {\"title\": \"Main Config Features Arg Type Targets V7\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n argTypeTargetsV7: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n argTypeTargetsV7: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 184]\"}, {\"title\": \"Main Config Features Development Mode For Build\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n developmentModeForBuild: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n developmentModeForBuild: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 185]\"}, {\"title\": \"Main Config Features Legacy Decorator File Order\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n legacyDecoratorFileOrder: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n features: {\\n legacyDecoratorFileOrder: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 186]\"}, {\"title\": \"Main Config Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n // Replace react-vite with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\n name: '@storybook/your-framework',\\n options: {\\n legacyRootApi: true,\\n },\\n },\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/your-framework',\\n options: {\\n legacyRootApi: true,\\n },\\n },\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 187]\"}, {\"title\": \"Main Config Indexers Jsonstories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport fs from 'fs/promises';\\n\\nconst jsonStoriesIndexer = {\\n test: /stories\\\\.json$/,\\n createIndex: async (fileName) => {\\n const content = JSON.parse(fs.readFileSync(fileName));\\n\\n const stories = generateStoryIndexesFromJson(content);\\n\\n return stories.map((story) => ({\\n type: 'story',\\n importPath: `virtual:jsonstories--${fileName}--${story.componentName}`,\\n exportName: story.name,\\n }));\\n },\\n};\\n\\nconst config = {\\n framework: '@storybook/your-framework',\\n stories: [\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n // \\ud83d\\udc47 Make sure files to index are included in `stories`\\n '../src/**/*.stories.json',\\n ],\\n experimental_indexers: async (existingIndexers) => [...existingIndexers, jsonStoriesIndexer],\\n};\\n\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\nimport type { Indexer } from 'storybook/internal/types';\\n\\nimport fs from 'fs/promises';\\n\\nconst jsonStoriesIndexer: Indexer = {\\n test: /stories\\\\.json$/,\\n createIndex: async (fileName) => {\\n const content = JSON.parse(fs.readFileSync(fileName));\\n\\n const stories = generateStoryIndexesFromJson(content);\\n\\n return stories.map((story) => ({\\n type: 'story',\\n importPath: `virtual:jsonstories--${fileName}--${story.componentName}`,\\n exportName: story.name,\\n }));\\n },\\n};\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: [\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n // \\ud83d\\udc47 Make sure files to index are included in `stories`\\n '../src/**/*.stories.json',\\n ],\\n experimental_indexers: async (existingIndexers) => [...existingIndexers, jsonStoriesIndexer],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 188]\"}, {\"title\": \"Main Config Indexers Title\", \"description\": null, \"content\": {\"root\": [\"```\\nconst combosIndexer = {\\n test: /\\\\.stories\\\\.[tj]sx?$/,\\n createIndex: async (fileName, { makeTitle }) => {\\n // \\ud83d\\udc47 Grab title from fileName\\n const title = fileName.match(/\\\\/(.*)\\\\.stories/)[1];\\n\\n // Read file and generate entries ...\\n let entries = [];\\n // Read file and generate entries...\\n\\n return entries.map((entry) => ({\\n type: 'story',\\n // \\ud83d\\udc47 Use makeTitle to format the title\\n title: `${makeTitle(title)} Custom`,\\n importPath: fileName,\\n exportName: entry.name,\\n }));\\n },\\n};\\n\\nconst config = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],\\n experimental_indexers: async (existingIndexers) => [...existingIndexers, combosIndexer],\\n};\\n\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\nimport type { Indexer } from 'storybook/internal/types';\\n\\nconst combosIndexer: Indexer = {\\n test: /\\\\.stories\\\\.[tj]sx?$/,\\n createIndex: async (fileName, { makeTitle }) => {\\n // \\ud83d\\udc47 Grab title from fileName\\n const title = fileName.match(/\\\\/(.*)\\\\.stories/)[1];\\n\\n // Read file and generate entries ...\\n const entries = [];\\n\\n return entries.map((entry) => ({\\n type: 'story',\\n // \\ud83d\\udc47 Use makeTitle to format the title\\n title: `${makeTitle(title)} Custom`,\\n importPath: fileName,\\n exportName: entry.name,\\n }));\\n },\\n};\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],\\n experimental_indexers: async (existingIndexers) => [...existingIndexers, combosIndexer],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 189]\"}, {\"title\": \"Main Config Indexers\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n // \\ud83d\\udc47 Make sure files to index are included in `stories`\\n '../src/**/*.custom-stories.@(js|jsx|ts|tsx)',\\n ],\\n experimental_indexers: async (existingIndexers) => {\\n const customIndexer = {\\n test: /\\\\.custom-stories\\\\.[tj]sx?$/,\\n createIndex: async (fileName) => {\\n // See API and examples below...\\n },\\n };\\n return [...existingIndexers, customIndexer];\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: [\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n // \\ud83d\\udc47 Make sure files to index are included in `stories`\\n '../src/**/*.custom-stories.@(js|jsx|ts|tsx)',\\n ],\\n experimental_indexers: async (existingIndexers) => {\\n const customIndexer = {\\n test: /\\\\.custom-stories\\\\.[tj]sx?$/,\\n createIndex: async (fileName) => {\\n // See API and examples below...\\n },\\n };\\n return [...existingIndexers, customIndexer];\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 190]\"}, {\"title\": \"Main Config Log Level\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n logLevel: 'debug',\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n logLevel: 'debug',\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 191]\"}, {\"title\": \"Main Config Manager Head\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n managerHead: (head) => `\\n ${head}\\n <link rel=\\\"preload\\\" href=\\\"/fonts/my-custom-manager-font.woff2\\\" />\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n managerHead: (head) => `\\n ${head}\\n <link rel=\\\"preload\\\" href=\\\"/fonts/my-custom-manager-font.woff2\\\" />\\n `,\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 192]\"}, {\"title\": \"Main Config Preview Body\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n previewBody: (body) => `\\n ${body}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n previewBody: (body) => `\\n ${body}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 193]\"}, {\"title\": \"Main Config Preview Head\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n previewHead: (head) => `\\n ${head}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n previewHead: (head) => `\\n ${head}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 194]\"}, {\"title\": \"Main Config Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n previewBody: (body) => `\\n ${body}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n previewBody: (body) => `\\n ${body}\\n ${\\n process.env.ANALYTICS_ID ? '<script src=\\\"https://cdn.example.com/analytics.js\\\"></script>' : ''\\n }\\n `,\\n};\\n\\nexport default config;\\n```\", \"```\\nexport default {\\n previewHead: (head) => `\\n ${head}\\n <style>\\n html, body {\\n background: #827979;\\n }\\n </style>\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n previewHead: (head) => `\\n ${head}\\n <style>\\n html, body {\\n background: #827979;\\n }\\n </style>\\n `,\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 195]\"}, {\"title\": \"Main Config Refs Disable\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n 'package-name': { disable: true },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n 'package-name': { disable: true },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 196]\"}, {\"title\": \"Main Config Refs With Function\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n\\n // \\ud83d\\udc47 Retrieve the current environment from the configType argument\\n refs: (config, { configType }) => {\\n if (configType === 'DEVELOPMENT') {\\n return {\\n react: {\\n title: 'Composed React Storybook running in development mode',\\n url: 'http://localhost:7007',\\n },\\n angular: {\\n title: 'Composed Angular Storybook running in development mode',\\n url: 'http://localhost:7008',\\n },\\n };\\n }\\n return {\\n react: {\\n title: 'Composed React Storybook running in production',\\n url: 'https://your-production-react-storybook-url',\\n },\\n angular: {\\n title: 'Composed Angular Storybook running in production',\\n url: 'https://your-production-angular-storybook-url',\\n },\\n };\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n\\n // \\ud83d\\udc47 Retrieve the current environment from the configType argument\\n refs: (config, { configType }) => {\\n if (configType === 'DEVELOPMENT') {\\n return {\\n react: {\\n title: 'Composed React Storybook running in development mode',\\n url: 'http://localhost:7007',\\n },\\n angular: {\\n title: 'Composed Angular Storybook running in development mode',\\n url: 'http://localhost:7008',\\n },\\n };\\n }\\n return {\\n react: {\\n title: 'Composed React Storybook running in production',\\n url: 'https://your-production-react-storybook-url',\\n },\\n angular: {\\n title: 'Composed Angular Storybook running in production',\\n url: 'https://your-production-angular-storybook-url',\\n },\\n };\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 197]\"}, {\"title\": \"Main Config Refs\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n 'design-system': {\\n title: 'Storybook Design System',\\n url: 'https://master--5ccbc373887ca40020446347.chromatic.com/',\\n expanded: false, // Optional, true by default\\n sourceUrl: 'https://github.com/storybookjs/storybook', // Optional\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n 'design-system': {\\n title: 'Storybook Design System',\\n url: 'https://master--5ccbc373887ca40020446347.chromatic.com/',\\n expanded: false, // Optional, true by default,\\n sourceUrl: 'https://github.com/storybookjs/storybook', // Optional\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 198]\"}, {\"title\": \"Main Config Static Dirs With Object\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n staticDirs: [{ from: '../my-custom-assets/images', to: '/assets' }],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n staticDirs: [{ from: '../my-custom-assets/images', to: '/assets' }],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 199]\"}, {\"title\": \"Main Config Static Dirs\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n staticDirs: ['../public', '../static'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n staticDirs: ['../public', '../static'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 200]\"}, {\"title\": \"Main Config Stories Ordered\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n '../src/**/*.mdx', // \\ud83d\\udc48 These will display first in the sidebar\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)', // \\ud83d\\udc48 Followed by these\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 201]\"}, {\"title\": \"Main Config Stories With Logic\", \"description\": null, \"content\": {\"root\": [\"```\\nasync function findStories() {\\n // your custom logic returns a list of files\\n}\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: async (list) => [\\n ...list,\\n // \\ud83d\\udc47 Add your found stories to the existing list of story files\\n ...(await findStories()),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\nimport type { StoriesEntry } from 'storybook/internal/types';\\n\\nasync function findStories(): Promise<StoriesEntry[]> {\\n // your custom logic returns a list of files\\n}\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: async (list: StoriesEntry[]) => [\\n ...list,\\n // \\ud83d\\udc47 Add your found stories to the existing list of story files\\n ...(await findStories()),\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 202]\"}, {\"title\": \"Main Config Stories With Object\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n {\\n // \\ud83d\\udc47 Sets the directory containing your stories\\n directory: '../packages/components',\\n // \\ud83d\\udc47 Storybook will load all files that match this glob\\n files: '*.stories.*',\\n // \\ud83d\\udc47 Used when generating automatic titles for your stories\\n titlePrefix: 'MyComponents',\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: [\\n {\\n // \\ud83d\\udc47 Sets the directory containing your stories\\n directory: '../packages/components',\\n // \\ud83d\\udc47 Storybook will load all files that match this glob\\n files: '*.stories.*',\\n // \\ud83d\\udc47 Used when generating automatic titles for your stories\\n titlePrefix: 'MyComponents',\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 203]\"}, {\"title\": \"Main Config Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 204]\"}, {\"title\": \"Main Config Svelte Csf Register\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n stories: ['../src/**/*.stories.@(js|jsx|ts|tsx|svelte)'],\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-svelte-csf',\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n stories: ['../src/**/*.stories.@(js|jsx|ts|tsx|svelte)'],\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-svelte-csf',\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 205]\"}, {\"title\": \"Main Config Swc Jsx Transform\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/your-framework',\\n options: {},\\n },\\n swc: (config, options) => ({\\n jsc: {\\n transform: {\\n react: {\\n runtime: 'automatic',\\n },\\n },\\n },\\n }),\\n};\\n```\", \"```\\n// Replace your-framework with the webpack-based framework you are using (e.g., react-webpack5)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/your-framework',\\n options: {},\\n },\\n swc: (config, options) => ({\\n jsc: {\\n transform: {\\n react: {\\n runtime: 'automatic',\\n },\\n },\\n },\\n }),\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 206]\"}, {\"title\": \"Main Config Swc\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/your-framework',\\n options: {},\\n },\\n swc: (config, options) => {\\n return {\\n ...config,\\n // Apply your custom SWC configuration\\n };\\n },\\n};\\n```\", \"```\\nimport type { Options } from '@swc/core';\\n// Replace your-framework with the webpack-based framework you are using (e.g., react-webpack5)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/your-framework',\\n options: {},\\n },\\n swc: (config: Options, options): Options => {\\n return {\\n ...config,\\n // Apply your custom SWC configuration\\n };\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 207]\"}, {\"title\": \"Main Config Test Disable Autodocs\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableAutoDocs: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableAutoDocs: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 208]\"}, {\"title\": \"Main Config Test Disable Blocks\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableBlocks: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableBlocks: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 209]\"}, {\"title\": \"Main Config Test Disable Disableaddons\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-a11y', '@storybook/addon-vitest'],\\n build: {\\n test: {\\n disabledAddons: ['@storybook/addon-a11y'],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-a11y', '@storybook/addon-vitest'],\\n build: {\\n test: {\\n disabledAddons: ['@storybook/addon-a11y'],\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 210]\"}, {\"title\": \"Main Config Test Disable Docgen\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableDocgen: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableDocgen: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 211]\"}, {\"title\": \"Main Config Test Disable Mdx\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableMDXEntries: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableMDXEntries: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 212]\"}, {\"title\": \"Main Config Test Disable Sourcemaps\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableSourcemaps: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableSourcemaps: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 213]\"}, {\"title\": \"Main Config Test Disable Treeshaking\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableTreeShaking: false,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n build: {\\n test: {\\n disableTreeShaking: false,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 214]\"}, {\"title\": \"Main Config Typescript Check Options\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n check: true,\\n checkOptions: {\\n eslint: true,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 215]\"}, {\"title\": \"Main Config Typescript Check\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n check: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 216]\"}, {\"title\": \"Main Config Typescript React Docgen Typescript Options\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n reactDocgen: 'react-docgen-typescript',\\n reactDocgenTypescriptOptions: {\\n shouldExtractLiteralValuesFromEnum: true,\\n // \\ud83d\\udc47 Default prop filter, which excludes props from node_modules\\n propFilter: (prop) => (prop.parent ? !/node_modules/.test(prop.parent.fileName) : true),\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 217]\"}, {\"title\": \"Main Config Typescript React Docgen\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n reactDocgen: 'react-docgen',\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 218]\"}, {\"title\": \"Main Config Typescript Skip Compiler\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n skipCompiler: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 219]\"}, {\"title\": \"Main Config Typical\", \"description\": null, \"content\": {\"root\": [\"```\\nconst config = {\\n // Required\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n // Optional\\n addons: ['@storybook/addon-docs'],\\n docs: {\\n autodocs: 'tag',\\n },\\n staticDirs: ['../public'],\\n};\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n // Required\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n // Optional\\n addons: ['@storybook/addon-docs'],\\n docs: {\\n autodocs: 'tag',\\n },\\n staticDirs: ['../public'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 220]\"}, {\"title\": \"Main Config Vite Final Env\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n builder: '@storybook/builder-vite',\\n },\\n async viteFinal(config, { configType }) {\\n const { mergeConfig } = await import('vite');\\n\\n if (configType === 'DEVELOPMENT') {\\n // Your development configuration goes here\\n }\\n if (configType === 'PRODUCTION') {\\n // Your production configuration goes here.\\n }\\n return mergeConfig(config, {\\n // Your environment configuration here\\n });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 221]\"}, {\"title\": \"Main Config Vite Final\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async viteFinal(config, { configType }) {\\n const { mergeConfig } = await import('vite');\\n\\n if (configType === 'DEVELOPMENT') {\\n // Your development configuration goes here\\n }\\n if (configType === 'PRODUCTION') {\\n // Your production configuration goes here.\\n }\\n return mergeConfig(config, {\\n // Your environment configuration here\\n });\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async viteFinal(config, { configType }) {\\n const { mergeConfig } = await import('vite');\\n\\n if (configType === 'DEVELOPMENT') {\\n // Your development configuration goes here\\n }\\n if (configType === 'PRODUCTION') {\\n // Your production configuration goes here.\\n }\\n return mergeConfig(config, {\\n // Your environment configuration here\\n });\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 222]\"}, {\"title\": \"Main Config Webpack Final\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config, { configType }) => {\\n if (configType === 'DEVELOPMENT') {\\n // Modify config for development\\n }\\n if (configType === 'PRODUCTION') {\\n // Modify config for production\\n }\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config, { configType }) => {\\n if (configType === 'DEVELOPMENT') {\\n // Modify config for development\\n }\\n if (configType === 'PRODUCTION') {\\n // Modify config for production\\n }\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 223]\"}, {\"title\": \"Margindecorator\", \"description\": null, \"content\": {\"root\": [\"```\\n<script>\\n let { children } = $props();\\n</script>\\n\\n<div>\\n {@render children()}\\n</div>\\n\\n<style>\\n div {\\n margin: 3em;\\n }\\n</style>\\n```\", \"```\\n<script>\\n import type { Snippet } from 'svelte';\\n\\n let { children }: { children: Snippet } = $props();\\n</script>\\n\\n<div>\\n {@render children()}\\n</div>\\n\\n<style>\\n div {\\n margin: 3em;\\n }\\n</style>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 224]\"}, {\"title\": \"Migrate Csf 2 To 3\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\npnpm exec storybook migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\nyarn exec storybook migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 225]\"}, {\"title\": \"Mock Context Container Global\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { normal as NavigationNormal } from '../components/Navigation.stories';\\n\\nimport GlobalContainerContext from '../components/lib/GlobalContainerContext';\\n\\nconst context = {\\n NavigationContainer: NavigationNormal,\\n};\\n\\nconst AppDecorator = (storyFn) => {\\n return (\\n <GlobalContainerContext.Provider value={context}>{storyFn()}</GlobalContainerContext.Provider>\\n );\\n};\\n\\nexport default { decorators: [AppDecorator] };\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { normal as NavigationNormal } from '../components/Navigation.stories';\\n\\nimport GlobalContainerContext from '../components/lib/GlobalContainerContext';\\n\\nconst context = {\\n NavigationContainer: NavigationNormal,\\n};\\n\\nconst AppDecorator = (storyFn) => {\\n return (\\n <GlobalContainerContext.Provider value={context}>{storyFn()}</GlobalContainerContext.Provider>\\n );\\n};\\n\\nconst preview: Preview = {\\n decorators: [AppDecorator],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { normal as NavigationNormal } from '../components/Navigation.stories';\\n\\nimport GlobalContainerContext from '../components/lib/GlobalContainerContext';\\n\\nconst context = {\\n NavigationContainer: NavigationNormal,\\n};\\n\\nconst AppDecorator = (storyFn) => {\\n return (\\n <GlobalContainerContext.Provider value={context}>{storyFn()}</GlobalContainerContext.Provider>\\n );\\n};\\nexport const decorators = [AppDecorator];\\n```\", \"```\\nimport { normal as NavigationNormal } from '../components/Navigation.stories';\\n\\nimport GlobalContainerContext from '../components/lib/GlobalContainerContext';\\n\\nconst context = {\\n NavigationContainer: NavigationNormal,\\n};\\n\\nconst AppDecorator = (storyFn) => {\\n return (\\n <GlobalContainerContext.Provider value={context}>{storyFn()}</GlobalContainerContext.Provider>\\n );\\n};\\n\\nconst preview: Preview = {\\n decorators: [AppDecorator],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 226]\"}, {\"title\": \"Mock Context Container Provider\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport ProfilePageContext from './ProfilePageContext';\\nimport { ProfilePageContainer } from './ProfilePageContainer';\\nimport { UserPostsContainer } from './UserPostsContainer';\\nimport { UserFriendsContainer } from './UserFriendsContainer';\\n\\n//\\ud83d\\udc47 Ensure that your context value remains referentially equal between each render.\\nconst context = {\\n UserPostsContainer,\\n UserFriendsContainer,\\n};\\n\\nexport const AppProfilePage = () => {\\n return (\\n <ProfilePageContext.Provider value={context}>\\n <ProfilePageContainer />\\n </ProfilePageContext.Provider>\\n );\\n};\\n```\", \"```\\nimport ProfilePageContext from './ProfilePageContext';\\nimport { ProfilePageContainer } from './ProfilePageContainer';\\nimport { UserPostsContainer } from './UserPostsContainer';\\nimport { UserFriendsContainer } from './UserFriendsContainer';\\n\\n//\\ud83d\\udc47 Ensure that your context value remains referentially equal between each render.\\nconst context = {\\n UserPostsContainer,\\n UserFriendsContainer,\\n};\\n\\nexport const AppProfilePage = () => {\\n return (\\n <ProfilePageContext.Provider value={context}>\\n <ProfilePageContainer />\\n </ProfilePageContext.Provider>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 227]\"}, {\"title\": \"Mock Context Container\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { ProfilePage } from './ProfilePage';\\nimport { UserPosts } from './UserPosts';\\n\\n//\\ud83d\\udc47 Imports a specific story from a story file\\nimport { Normal as UserFriendsNormal } from './UserFriends.stories';\\n\\nexport default {\\n component: ProfilePage,\\n};\\n\\nconst ProfilePageProps = {\\n name: 'Jimi Hendrix',\\n userId: '1',\\n};\\n\\nconst context = {\\n //\\ud83d\\udc47 We can access the `userId` prop here if required:\\n UserPostsContainer({ userId }) {\\n return <UserPosts {...UserPostsProps} />;\\n },\\n // Most of the time we can simply pass in a story.\\n // In this case we're passing in the `normal` story export\\n // from the `UserFriends` component stories.\\n UserFriendsContainer: UserFriendsNormal,\\n};\\n\\nexport const Normal = {\\n render: () => (\\n <ProfilePageContext.Provider value={context}>\\n <ProfilePage {...ProfilePageProps} />\\n </ProfilePageContext.Provider>\\n ),\\n};\\n```\", \"```\\nimport { ProfilePage } from './ProfilePage';\\nimport { UserPosts } from './UserPosts';\\n\\n//\\ud83d\\udc47 Imports a specific story from a story file\\nimport { Normal as UserFriendsNormal } from './UserFriends.stories';\\n\\nexport default {\\n component: ProfilePage,\\n};\\n\\nconst ProfilePageProps = {\\n name: 'Jimi Hendrix',\\n userId: '1',\\n};\\n\\nconst context = {\\n //\\ud83d\\udc47 We can access the `userId` prop here if required:\\n UserPostsContainer({ userId }) {\\n return <UserPosts {...UserPostsProps} />;\\n },\\n // Most of the time we can simply pass in a story.\\n // In this case we're passing in the `normal` story export\\n // from the `UserFriends` component stories.\\n UserFriendsContainer: UserFriendsNormal,\\n};\\n\\nexport const Normal = {\\n render: () => (\\n <ProfilePageContext.Provider value={context}>\\n <ProfilePage {...ProfilePageProps} />\\n </ProfilePageContext.Provider>\\n ),\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 228]\"}, {\"title\": \"Mock Context Create\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { createContext } from 'react';\\n\\nconst ProfilePageContext = createContext();\\n\\nexport default ProfilePageContext;\\n```\", \"```\\nimport { createContext } from 'solid-js';\\n\\nconst ProfilePageContext = createContext();\\n\\nexport default ProfilePageContext;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 229]\"}, {\"title\": \"Mock Context In Use\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { useContext } from 'react';\\n\\nimport ProfilePageContext from './ProfilePageContext';\\n\\nexport const ProfilePage = ({ name, userId }) => {\\n const { UserPostsContainer, UserFriendsContainer } = useContext(ProfilePageContext);\\n\\n return (\\n <div>\\n <h1>{name}</h1>\\n <UserPostsContainer userId={userId} />\\n <UserFriendsContainer userId={userId} />\\n </div>\\n );\\n};\\n```\", \"```\\nimport { useContext } from 'solid-js';\\n\\nimport ProfilePageContext from './ProfilePageContext';\\n\\nexport const ProfilePage = (props) => {\\n const { UserPostsContainer, UserFriendsContainer } = useContext(ProfilePageContext);\\n\\n return (\\n <div>\\n <h1>{props.name}</h1>\\n <UserPostsContainer userId={props.userId} />\\n <UserFriendsContainer userId={props.userId} />\\n </div>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 230]\"}, {\"title\": \"Mock Provider In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { ThemeProvider } from 'styled-components';\\n\\n// themes = { light, dark }\\nimport * as themes from '../src/themes';\\n\\nexport default {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading the theme value from parameters\\n const { theme = 'light' } = parameters;\\n return (\\n <ThemeProvider theme={themes[theme]}>\\n <Story />\\n </ThemeProvider>\\n );\\n },\\n ],\\n};\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { ThemeProvider } from 'styled-components';\\n\\n// themes = { light, dark }\\nimport * as themes from '../src/themes';\\n\\nconst preview: Preview = {\\n decorators: [\\n // \\ud83d\\udc47 Defining the decorator in the preview file applies it to all stories\\n (Story, { parameters }) => {\\n // \\ud83d\\udc47 Make it configurable by reading the theme value from parameters\\n const { theme = 'light' } = parameters;\\n return (\\n <ThemeProvider theme={themes[theme]}>\\n <Story />\\n </ThemeProvider>\\n );\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 231]\"}, {\"title\": \"Module Aliases Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n viteFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve?.alias,\\n // \\ud83d\\udc47 External module\\n lodash: import.meta.resolve('./lodash.mock'),\\n // \\ud83d\\udc47 Internal modules\\n '@/api': import.meta.resolve('./api.mock.ts'),\\n '@/app/actions': import.meta.resolve('./app/actions.mock.ts'),\\n '@/lib/session': import.meta.resolve('./lib/session.mock.ts'),\\n '@/lib/db': import.meta.resolve('./lib/db.mock.ts'),\\n };\\n }\\n\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n viteFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve?.alias,\\n // \\ud83d\\udc47 External module\\n lodash: import.meta.resolve('./lodash.mock'),\\n // \\ud83d\\udc47 Internal modules\\n '@/api': import.meta.resolve('./api.mock.ts'),\\n '@/app/actions': import.meta.resolve('./app/actions.mock.ts'),\\n '@/lib/session': import.meta.resolve('./lib/session.mock.ts'),\\n '@/lib/db': import.meta.resolve('./lib/db.mock.ts'),\\n };\\n }\\n\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\", \"```\\nexport default {\\n // Replace your-framework with the framework you are using (e.g., nextjs, react-webpack5)\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve.alias,\\n // \\ud83d\\udc47 External module\\n lodash: import.meta.resolve('./lodash.mock'),\\n // \\ud83d\\udc47 Internal modules\\n '@/api$': import.meta.resolve('./api.mock.ts'),\\n '@/app/actions$': import.meta.resolve('./app/actions.mock.ts'),\\n '@/lib/session$': import.meta.resolve('./lib/session.mock.ts'),\\n '@/lib/db$': import.meta.resolve('./lib/db.mock.ts'),\\n };\\n }\\n\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using (e.g., nextjs, react-webpack5)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve.alias,\\n // \\ud83d\\udc47 External module\\n lodash: import.meta.resolve('./lodash.mock'),\\n // \\ud83d\\udc47 Internal modules\\n '@/api$': import.meta.resolve('./api.mock.ts'),\\n '@/app/actions$': import.meta.resolve('./app/actions.mock.ts'),\\n '@/lib/session$': import.meta.resolve('./lib/session.mock.ts'),\\n '@/lib/db$': import.meta.resolve('./lib/db.mock.ts'),\\n };\\n }\\n\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 232]\"}, {\"title\": \"Mount Advanced\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g., react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nconst meta = { component: Page } satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n <Page {...args} params={{ id: String(note.id) }} />\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nexport default { component: Page };\\n\\nexport const Default = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n <Page {...args} params={{ id: String(note.id) }} />\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g., svelte-vite, sveltekit, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nconst meta = { component: Page } satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n Page,\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n { props: { ...args, params: { id: String(note.id) } } }\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nexport default { component: Page };\\n\\nexport const Default = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n Page,\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n { props: { ...args, params: { id: String(note.id) } } }\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nconst meta = { component: Page } satisfies Meta<typeof Page>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n Page,\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n { props: { ...args, params: { id: String(note.id) } } }\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/db'\\nimport db from '../lib/db';\\nimport { Page } from './Page';\\n\\nexport default { component: Page };\\n\\nexport const Default = {\\n play: async ({ mount, args, userEvent }) => {\\n const note = await db.note.create({\\n data: { title: 'Mount inside of play' },\\n });\\n\\n const canvas = await mount(\\n Page,\\n // \\ud83d\\udc47 Pass data that is created inside of the play function to the component\\n // For example, a just-generated UUID\\n { props: { ...args, params: { id: String(note.id) } } }\\n );\\n\\n await userEvent.click(await canvas.findByRole('menuitem', { name: /login to add/i }));\\n },\\n argTypes: {\\n // \\ud83d\\udc47 Make the params prop un-controllable, as the value is always overriden in the play function.\\n params: { control: { disable: true } },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 233]\"}, {\"title\": \"Mount Basic\", \"description\": null, \"content\": {\"root\": [\"```\\nimport MockDate from 'mockdate';\\n\\n// ...rest of story file\\n\\nexport const ChristmasUI = {\\n async play({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n },\\n};\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\n// ...rest of story file\\n\\nexport const ChristmasUI: Story = {\\n async play({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Calendar from './Calendar.svelte';\\n\\n const { Story } = defineMeta({\\n component: Calendar,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ChristmasUI\\\"\\n play={async ({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n }}\\n/>\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\n// ...rest of story file\\n\\nexport const ChristmasUI: Story = {\\n async play({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Calendar from './Calendar.svelte';\\n\\n const { Story } = defineMeta({\\n component: Calendar,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ChristmasUI\\\"\\n play={async ({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n }}\\n/>\\n```\", \"```\\nimport MockDate from 'mockdate';\\n\\n// ...rest of story file\\n\\nexport const ChristmasUI = {\\n async play({ mount }) {\\n MockDate.set('2024-12-25');\\n // \\ud83d\\udc47 Render the component with the mocked date\\n await mount();\\n // ...rest of test\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 234]\"}, {\"title\": \"Msw Addon Configure Handlers Graphql\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\nimport { HttpClientModule } from '@angular/common/http';\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentHeader } from './DocumentHeader.component';\\nimport { DocumentList } from './DocumentList.component';\\nimport { PageLayout } from './PageLayout.component';\\nimport { DocumentScreen } from './YourPage.component';\\nimport { MockGraphQLModule } from './mock-graphql.module';\\n\\nconst meta: Meta<DocumentScreen> = {\\n component: DocumentScreen,\\n decorators: [\\n moduleMetadata({\\n declarations: [DocumentList, DocumentHeader, PageLayout],\\n imports: [CommonModule, HttpClientModule, MockGraphQLModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\ntype Story = StoryObj<DocumentScreen>;\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\nimport { NgModule } from '@angular/core';\\nimport { APOLLO_OPTIONS } from 'apollo-angular';\\n\\nimport { ApolloClientOptions, InMemoryCache } from '@apollo/client/core';\\nimport { HttpLink } from 'apollo-angular/http';\\n\\n// See here for docs https://apollo-angular.com/docs/get-started\\n\\nconst uri = 'https://your-graphql-endpoint';\\nexport function createApollo(httpLink: HttpLink): ApolloClientOptions<any> {\\n return {\\n link: httpLink.create({ uri }),\\n cache: new InMemoryCache(),\\n defaultOptions: {\\n watchQuery: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n query: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n },\\n };\\n}\\n\\n@NgModule({\\n providers: [\\n {\\n provide: APOLLO_OPTIONS,\\n useFactory: createApollo,\\n deps: [HttpLink],\\n },\\n ],\\n})\\nexport class MockGraphQLModule {}\\n```\", \"```\\nimport { ApolloClient, ApolloProvider, InMemoryCache } from '@apollo/client';\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentScreen } from './YourPage';\\n\\nconst mockedClient = new ApolloClient({\\n uri: 'https://your-graphql-endpoint',\\n cache: new InMemoryCache(),\\n defaultOptions: {\\n watchQuery: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n query: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n },\\n});\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport default {\\n component: DocumentScreen,\\n decorators: [\\n (Story) => (\\n <ApolloProvider client={mockedClient}>\\n <Story />\\n </ApolloProvider>\\n ),\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { ApolloClient, ApolloProvider, InMemoryCache } from '@apollo/client';\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentScreen } from './YourPage';\\n\\nconst mockedClient = new ApolloClient({\\n uri: 'https://your-graphql-endpoint',\\n cache: new InMemoryCache(),\\n defaultOptions: {\\n watchQuery: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n query: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n },\\n});\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\nconst meta = {\\n component: DocumentScreen,\\n decorators: [\\n (Story) => (\\n <ApolloProvider client={mockedClient}>\\n <Story />\\n </ApolloProvider>\\n ),\\n ],\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { graphql, HttpResponse, delay } from 'msw';\\n\\n import MockApolloWrapperClient from './MockApolloWrapperClient.svelte';\\n import DocumentScreen from './YourPage.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n decorators: [() => MockApolloWrapperClient],\\n });\\n\\n //\\ud83d\\udc47The mocked data that will be used in the story\\n const TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n };\\n</script>\\n\\n<Story\\n name=\\\"MockedSuccess\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n AllInfoQuery: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n\\n<Story\\n name=\\\"MockedError\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n```\", \"```\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport MockApolloWrapperClient from './MockApolloWrapperClient.svelte';\\nimport DocumentScreen from './YourPage.svelte';\\n\\nexport default {\\n component: DocumentScreen,\\n decorators: [() => MockApolloWrapperClient],\\n};\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<script>\\n import {\\n Client,\\n setContextClient,\\n cacheExchange,\\n fetchExchange,\\n } from '@urql/svelte';\\n\\n const client = new Client({\\n url: 'https://your-graphql-endpoint',\\n exchanges: [cacheExchange, fetchExchange],\\n });\\n\\n setContextClient(client);\\n\\n const { children } = $props();\\n</script>\\n\\n<div>\\n {@render children()}\\n</div>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { graphql, HttpResponse, delay } from 'msw';\\n\\n import MockApolloWrapperClient from './MockApolloWrapperClient.svelte';\\n import DocumentScreen from './YourPage.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n decorators: [() => MockApolloWrapperClient],\\n });\\n\\n //\\ud83d\\udc47The mocked data that will be used in the story\\n const TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n };\\n</script>\\n\\n<Story\\n name=\\\"MockedSuccess\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n AllInfoQuery: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n\\n<Story\\n name=\\\"MockedError\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport MockApolloWrapperClient from './MockApolloWrapperClient.svelte';\\nimport DocumentScreen from './YourPage.svelte';\\n\\nconst meta = {\\n component: DocumentScreen,\\n decorators: [() => MockApolloWrapperClient],\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<script lang=\\\"ts\\\">\\n import {\\n Client,\\n setContextClient,\\n cacheExchange,\\n fetchExchange,\\n } from '@urql/svelte';\\n\\n const client = new Client({\\n url: 'https://your-graphql-endpoint',\\n exchanges: [cacheExchange, fetchExchange],\\n });\\n\\n setContextClient(client);\\n\\n interface Props {\\n children: any;\\n }\\n const { children }: Props = $props();\\n</script>\\n\\n<div>\\n {@render children?.()}\\n</div>\\n\\n```\", \"```\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport WrapperComponent from './ApolloWrapperClient.vue';\\nimport DocumentScreen from './YourPage.vue';\\n\\nexport default {\\n component: DocumentScreen,\\n render: () => ({\\n components: { DocumentScreen, WrapperComponent },\\n template: '<WrapperComponent><DocumentScreen /></WrapperComponent>',\\n }),\\n};\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<template>\\n <div><slot /></div>\\n</template>\\n\\n<script>\\n import { defineComponent, provide } from 'vue';\\n import { DefaultApolloClient } from '@vue/apollo-composable';\\n import { ApolloClient, createHttpLink, InMemoryCache } from '@apollo/client/core';\\n\\n // Apollo client wrapper component that can be used within your app and Storybook\\n export default defineComponent({\\n name: 'WrapperComponent',\\n setup() {\\n const httpLink = createHttpLink({\\n // You should use an absolute URL here\\n uri: 'https://your-graphql-endpoint',\\n });\\n const cache = new InMemoryCache();\\n\\n const mockedClient = new ApolloClient({\\n link: httpLink,\\n cache,\\n defaultOptions: {\\n watchQuery: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n query: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n },\\n });\\n provide(DefaultApolloClient, mockedClient);\\n },\\n });\\n</script>\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { graphql, HttpResponse, delay } from 'msw';\\n\\nimport WrapperComponent from './ApolloWrapperClient.vue';\\nimport DocumentScreen from './YourPage.vue';\\n\\nconst meta = {\\n component: DocumentScreen,\\n render: () => ({\\n components: { DocumentScreen, WrapperComponent },\\n template: '<WrapperComponent><DocumentScreen /></WrapperComponent>',\\n }),\\n} satisfies Meta<typeof DocumentScreen>;\\n\\n//\\ud83d\\udc47The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', () => {\\n return HttpResponse.json({\\n data: {\\n allInfo: {\\n ...TestData,\\n },\\n },\\n });\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n graphql.query('AllInfoQuery', async () => {\\n await delay(800);\\n return HttpResponse.json({\\n errors: [\\n {\\n message: 'Access denied',\\n },\\n ],\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<template>\\n <div><slot /></div>\\n</template>\\n\\n<script>\\n import { defineComponent, provide } from 'vue';\\n import { DefaultApolloClient } from '@vue/apollo-composable';\\n import { ApolloClient, createHttpLink, InMemoryCache } from '@apollo/client/core';\\n\\n // Apollo client wrapper component that can be used within your app and Storybook\\n export default defineComponent({\\n name: 'WrapperComponent',\\n setup() {\\n const httpLink = createHttpLink({\\n // You should use an absolute URL here\\n uri: 'https://your-graphql-endpoint',\\n });\\n const cache = new InMemoryCache();\\n\\n const mockedClient = new ApolloClient({\\n link: httpLink,\\n cache,\\n defaultOptions: {\\n watchQuery: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n query: {\\n fetchPolicy: 'no-cache',\\n errorPolicy: 'all',\\n },\\n },\\n });\\n provide(DefaultApolloClient, mockedClient);\\n },\\n });\\n</script>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 235]\"}, {\"title\": \"Msw Addon Configure Handlers Http\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentScreen } from './YourPage.component';\\n\\nconst meta: Meta<DocumentScreen> = {\\n component: DocumentScreen,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<DocumentScreen>;\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { http, HttpResponse, delay } from 'msw';\\n\\n import DocumentScreen from './YourPage.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n });\\n\\n // \\ud83d\\udc47 The mocked data that will be used in the story\\n const TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: \\\"approved\\\",\\n },\\n ],\\n };\\n</script>\\n\\n<Story\\n name=\\\"MockedSuccess\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n }}\\n/>\\n\\n<Story\\n name=\\\"MockedError\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n```\", \"```\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nimport DocumentScreen from './YourPage.svelte';\\n\\nexport default {\\n component: DocumentScreen,\\n};\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentScreen } from './YourPage';\\n\\nexport default {\\n component: DocumentScreen,\\n};\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { http, HttpResponse, delay } from 'msw';\\n\\n import DocumentScreen from './YourPage.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n });\\n\\n // \\ud83d\\udc47 The mocked data that will be used in the story\\n const TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: \\\"approved\\\",\\n },\\n ],\\n };\\n</script>\\n\\n<Story\\n name=\\\"MockedSuccess\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n }}\\n/>\\n\\n<Story\\n name=\\\"MockedError\\\"\\n parameters={{\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nimport DocumentScreen from './YourPage.svelte';\\n\\nconst meta = {\\n component: DocumentScreen,\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nimport { DocumentScreen } from './YourPage';\\n\\nconst meta = {\\n component: DocumentScreen,\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nexport default {\\n component: 'demo-document-screen',\\n};\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { http, HttpResponse, delay } from 'msw';\\n\\nconst meta: Meta = {\\n component: 'demo-document-screen',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n// \\ud83d\\udc47 The mocked data that will be used in the story\\nconst TestData = {\\n user: {\\n userID: 1,\\n name: 'Someone',\\n },\\n document: {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n brief: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.',\\n status: 'approved',\\n },\\n subdocuments: [\\n {\\n id: 1,\\n userID: 1,\\n title: 'Something',\\n content:\\n 'Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.',\\n status: 'approved',\\n },\\n ],\\n};\\n\\nexport const MockedSuccess: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint/', () => {\\n return HttpResponse.json(TestData);\\n }),\\n ],\\n },\\n },\\n};\\n\\nexport const MockedError: Story = {\\n parameters: {\\n msw: {\\n handlers: [\\n http.get('https://your-restful-endpoint', async () => {\\n await delay(800);\\n return new HttpResponse(null, {\\n status: 403,\\n });\\n }),\\n ],\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 236]\"}, {\"title\": \"Msw Addon Initialize\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { initialize, mswLoader } from 'msw-storybook-addon';\\n\\n/*\\n * Initializes MSW\\n * See https://github.com/mswjs/msw-storybook-addon#configuring-msw\\n * to learn how to customize it\\n */\\ninitialize();\\n\\nexport default {\\n // ... rest of preview configuration\\n loaders: [mswLoader], // \\ud83d\\udc48 Add the MSW loader to all stories\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { initialize, mswLoader } from 'msw-storybook-addon';\\n\\n/*\\n * Initializes MSW\\n * See https://github.com/mswjs/msw-storybook-addon#configuring-msw\\n * to learn how to customize it\\n */\\ninitialize();\\n\\nconst preview: Preview = {\\n // ... rest of preview configuration\\n loaders: [mswLoader], // \\ud83d\\udc48 Add the MSW loader to all stories\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 237]\"}, {\"title\": \"Msw Addon Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install msw msw-storybook-addon --save-dev\\n```\", \"```\\npnpm add msw msw-storybook-addon --save-dev\\n```\", \"```\\nyarn add msw msw-storybook-addon --save-dev\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 238]\"}, {\"title\": \"Msw Generate Service Worker\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx msw init public/\\n```\", \"```\\nyarn dlx msw init public/\\n```\", \"```\\npnpm dlx msw init public/\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 239]\"}, {\"title\": \"Multiple Stories Test\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { fireEvent, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as FormStories from './LoginForm.stories';\\n\\nconst { InvalidForm, ValidForm } = composeStories(FormStories);\\n\\ntest('Tests invalid form state', async () => {\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n\\ntest('Tests filled form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as FormStories from './LoginForm.stories';\\n\\nconst { InvalidForm, ValidForm } = composeStories(FormStories);\\n\\ntest('Tests invalid form state', async () => {\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n\\ntest('Tests filled form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as FormStories from './LoginForm.stories';\\n\\nconst { InvalidForm, ValidForm } = composeStories(FormStories);\\n\\ntest('Tests invalid form state', async () => {\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n\\ntest('Tests filled form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as FormStories from './LoginForm.stories';\\n\\nconst { InvalidForm, ValidForm } = composeStories(FormStories);\\n\\ntest('Tests invalid form state', async () => {\\n await InvalidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).toBeInTheDocument();\\n});\\n\\ntest('Tests filled form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 240]\"}, {\"title\": \"My Component Disable Toc\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n tags: ['autodocs'],\\n parameters: {\\n docs: {\\n toc: {\\n disable: true, // \\ud83d\\udc48 Disables the table of contents\\n },\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 241]\"}, {\"title\": \"My Component Env Var Config\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent';\\n\\n// To apply a set of backgrounds to all stories of Button:\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Default: Story = {\\n args: {\\n exampleProp: process.env.EXAMPLE_VAR,\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Default = {\\n args: {\\n exampleProp: process.env.EXAMPLE_VAR,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n exampleProp: process.env.EXAMPLE_VAR,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const Default = {\\n args: {\\n exampleProp: process.env.EXAMPLE_VAR,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n args: {\\n exampleProp: process.env.EXAMPLE_VAR,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 242]\"}, {\"title\": \"My Component Exclude Tags\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `no-tests` tag to all stories in this file\\n tags: ['no-tests'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const ExcludeStory: Story = {\\n //\\ud83d\\udc47 Adds the `no-tests` tag to this story to exclude it from the tests when enabled in the test-runner configuration\\n tags: ['no-tests'],\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `no-tests` tag to all stories in this file\\n tags: ['no-tests'],\\n};\\n\\nexport const ExcludeStory = {\\n //\\ud83d\\udc47 Adds the `no-tests` tag to this story to exclude it from the tests when enabled in the test-runner configuration\\n tags: ['no-tests'],\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `no-tests` tag to all stories in this file\\n tags: ['no-tests'],\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExcludeStory: Story = {\\n //\\ud83d\\udc47 Adds the `no-tests` tag to this story to exclude it from the tests when enabled in the test-runner configuration\\n tags: ['no-tests'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 243]\"}, {\"title\": \"My Component Include Tags\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `test-only` tag to all stories in this file\\n tags: ['test-only'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const IncludeStory: Story = {\\n //\\ud83d\\udc47 Adds the `test-only` tag to this story to be included in the tests when enabled in the test-runner configuration\\n tags: ['test-only'],\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `test-only` tag to all stories in this file\\n tags: ['test-only'],\\n};\\n\\nexport const IncludeStory = {\\n //\\ud83d\\udc47 Adds the `test-only` tag to this story to be included in the tests when enabled in the test-runner configuration\\n tags: ['test-only'],\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `test-only` tag to all stories in this file\\n tags: ['test-only'],\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const IncludeStory: Story = {\\n //\\ud83d\\udc47 Adds the `test-only` tag to this story to be included in the tests when enabled in the test-runner configuration\\n tags: ['test-only'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 244]\"}, {\"title\": \"My Component Skip Tags\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `skip-test` tag to all stories in this file\\n tags: ['skip-test'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const SkipStory: Story = {\\n //\\ud83d\\udc47 Adds the `skip-test` tag to this story to allow it to be skipped in the tests when enabled in the test-runner configuration\\n tags: ['skip-test'],\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `skip-test` tag to all stories in this file\\n tags: ['skip-test'],\\n};\\n\\nexport const SkipStory = {\\n //\\ud83d\\udc47 Adds the `skip-test` tag to this story to allow it to be skipped in the tests when enabled in the test-runner configuration\\n tags: ['skip-test'],\\n};\\n```\", \"```\\n// Replace your-framework with the name of your framework\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n //\\ud83d\\udc47 Provides the `skip-test` tag to all stories in this file\\n tags: ['skip-test'],\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const SkipStory: Story = {\\n //\\ud83d\\udc47 Adds the `skip-test` tag to this story to allow it to be skipped in the tests when enabled in the test-runner configuration\\n tags: ['skip-test'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 245]\"}, {\"title\": \"My Component Story Basic And Props\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Default: Story = {};\\n\\nexport const WithProp: Story = {\\n render: () => ({\\n props: {\\n prop: 'value',\\n },\\n }),\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Basic = {};\\n\\nexport const WithProp = {\\n render: () => <MyComponent prop=\\\"value\\\" />,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {};\\n\\nexport const WithProp: Story = {\\n render: () => <MyComponent prop=\\\"value\\\" />,\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Basic = {};\\n\\nexport const WithProp = {\\n render: () => <MyComponent prop=\\\"value\\\" />,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {};\\n\\nexport const WithProp: Story = {\\n render: () => <MyComponent prop=\\\"value\\\" />,\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"Basic\\\">\\n <MyComponent />\\n</Story>\\n\\n<Story name=\\\"WithProp\\\">\\n <MyComponent prop=\\\"value\\\" />\\n</Story>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Basic = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const WithProp = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n prop: 'value',\\n },\\n }),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"Basic\\\">\\n <MyComponent />\\n</Story>\\n\\n<Story name=\\\"WithProp\\\">\\n <MyComponent prop=\\\"value\\\" />\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const WithProp: Story = {\\n render: () => ({\\n Component: MyComponent,\\n props: {\\n prop: 'value',\\n },\\n }),\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Basic = {\\n render: () => ({\\n components: { MyComponent },\\n template: '<MyComponent />',\\n }),\\n};\\n\\nexport const WithProp = {\\n render: () => ({\\n components: { MyComponent },\\n template: '<MyComponent prop=\\\"value\\\"/>',\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic: Story = {\\n render: () => ({\\n components: { MyComponent },\\n template: '<MyComponent />',\\n }),\\n};\\n\\nexport const WithProp: Story = {\\n render: () => ({\\n components: { MyComponent },\\n template: '<MyComponent prop=\\\"value\\\"/>',\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'Path/To/MyComponent',\\n component: 'my-component',\\n};\\n\\nexport const Basic = {};\\n\\nexport const WithProp = {\\n render: () => html`<my-component prop=\\\"value\\\" />`,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {};\\n\\nexport const WithProp: Story = {\\n render: () => html`<my-component prop=\\\"value\\\" />`,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 246]\"}, {\"title\": \"My Component Story Import Json\", \"description\": null, \"content\": {\"root\": [\"```\\n// This will automatically be parsed to the contents of `data.json`\\nimport data from './data.json';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 247]\"}, {\"title\": \"My Component Story Import Static Asset\", \"description\": null, \"content\": {\"root\": [\"```\\n// This will include './static/image.png' in the bundle.\\n// And return a path to be included in a src attribute\\nimport imageFile from './static/image.png';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 248]\"}, {\"title\": \"My Component Story Mandatory Export\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const meta = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n });\\n</script>\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const meta = defineMeta({\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'Path/To/MyComponent',\\n component: MyComponent,\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Path/To/MyComponent',\\n component: 'my-component',\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Path/To/MyComponent',\\n component: 'my-component',\\n decorators: [\\n /* ... */\\n ],\\n parameters: {\\n /* ... */\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 249]\"}, {\"title\": \"My Component Story Use Globaltype\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale: Story = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return {\\n template: `<p>${caption}</p>`,\\n };\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return <p>{caption}</p>;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return <p>{caption}</p>;\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return <p>{caption}</p>;\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return <p>{caption}</p>;\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from \\\"@storybook/addon-svelte-csf\\\";\\n\\n import MyComponent from \\\"./MyComponent.svelte\\\";\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<script>\\n const getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case \\\"kr\\\":\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case \\\"zh\\\":\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n };\\n</script>\\n\\n<Story name=\\\"StoryWithLocale\\\">\\n {#snippet template(args, { globals: { locale } })}\\n <MyComponent\\n {...args}\\n locale={getCaptionForLocale(locale)}\\n />\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return {\\n Component: MyComponent,\\n props: {\\n locale: caption,\\n },\\n };\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from \\\"@storybook/addon-svelte-csf\\\";\\n\\n import MyComponent from \\\"./MyComponent.svelte\\\";\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<script lang=\\\"ts\\\">\\n const getCaptionForLocale = (locale:string) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case \\\"kr\\\":\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case \\\"zh\\\":\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n };\\n</script>\\n\\n<Story name=\\\"StoryWithLocale\\\">\\n {#snippet template(args, { globals: { locale } })}\\n <MyComponent\\n {...args}\\n locale={getCaptionForLocale(locale)}\\n />\\n {/snippet}\\n</Story>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale: Story = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return {\\n Component: MyComponent,\\n props: {\\n locale: caption,\\n },\\n };\\n },\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return {\\n template: `<p>${caption}</p>`,\\n };\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<typeof MyComponent>;\\n\\nexport const MyStory: Story = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return {\\n template: `<p>${caption}</p>`,\\n };\\n },\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'my-component',\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport const StoryWithLocale = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return html`<p>${caption}</p>`;\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nconst getCaptionForLocale = (locale) => {\\n switch (locale) {\\n case 'es':\\n return 'Hola!';\\n case 'fr':\\n return 'Bonjour!';\\n case 'kr':\\n return '\\uc548\\ub155\\ud558\\uc138\\uc694!';\\n case 'zh':\\n return '\\u4f60\\u597d!';\\n default:\\n return 'Hello!';\\n }\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const StoryWithLocale: Story = {\\n render: (args, { globals: { locale } }) => {\\n const caption = getCaptionForLocale(locale);\\n return html`<p>${caption}</p>`;\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 250]\"}, {\"title\": \"My Component Story With Nonstory\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nimport someData from './data.json';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport default meta;\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nimport someData from './data.json';\\n\\nexport default {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nimport someData from './data.json';\\n\\nconst meta = {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nimport someData from './data.json';\\n\\nexport default {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nimport someData from './data.json';\\n\\nconst meta = {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n import someData from './data.json';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n });\\n\\n export const simpleData = { foo: 1, bar: 'baz' };\\n\\n export const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n</script>\\n\\n<Story name=\\\"SimpleStory\\\" args={{ data: simpleData }} />\\n\\n<Story name=\\\"ComplexStory\\\" args={{ data: complexData }} />\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nimport someData from './data.json';\\n\\nexport default {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n import someData from './data.json';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n });\\n\\n export const simpleData = { foo: 1, bar: 'baz' };\\n\\n export const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n</script>\\n\\n<Story name=\\\"SimpleStory\\\" args={{ data: simpleData }} />\\n\\n<Story name=\\\"ComplexStory\\\" args={{ data: complexData }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nimport someData from './data.json';\\n\\nconst meta = {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport MyComponent from './MyComponent.vue';\\n\\nimport someData from './data.json';\\n\\nexport default {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'],\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport MyComponent from './MyComponent.vue';\\n\\nimport someData from './data.json';\\n\\nconst meta = {\\n component: MyComponent,\\n includeStories: ['SimpleStory', 'ComplexStory'],\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport const SimpleStory = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n includeStories: ['SimpleStory', 'ComplexStory'], // \\ud83d\\udc48 Storybook loads these stories\\n excludeStories: /.*Data$/, // \\ud83d\\udc48 Storybook ignores anything that contains Data\\n};\\n\\nexport const simpleData = { foo: 1, bar: 'baz' };\\nexport const complexData = { foo: 1, foobar: { bar: 'baz', baz: someData } };\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const SimpleStory: Story = {\\n args: {\\n data: simpleData,\\n },\\n};\\n\\nexport const ComplexStory: Story = {\\n args: {\\n data: complexData,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 251]\"}, {\"title\": \"My Component Story With Storyname\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<Button> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Simple: Story = {\\n name: 'So simple!',\\n // ...\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const Simple = {\\n name: 'So simple!',\\n // ...\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Simple: Story = {\\n name: 'So simple!',\\n // ...\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const Simple = {\\n name: 'So simple!',\\n // ...\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Simple: Story = {\\n name: 'So simple!',\\n // ...\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 252]\"}, {\"title\": \"My Component Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'MyComponent',\\n component: MyComponent,\\n};\\n\\n// Your stories\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 253]\"}, {\"title\": \"My Component Vite Env Variables\", \"description\": null, \"content\": {\"root\": [\"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n }}\\n/>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: import.meta.env.STORYBOOK_DATA_KEY,\\n propertyB: import.meta.env.VITE_CUSTOM_VAR,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 254]\"}, {\"title\": \"My Component With Custom Syntax Highlight\", \"description\": null, \"content\": {\"SCSS example\": \"This is a sample SCSS code block example highlighted in Storybook\\n\\n{/* Don't forget to replace (\\\") with (```) when you copy the snippet to your own app */}\\n\\n\\\"scss\\n$font-stack: Helvetica, sans-serif;\\n$primary-color: #333;\\n\\nbody {\\nfont: 100% $font-stack;\\ncolor: $primary-color;\\n}\\n\\\"\\n\\n{/* The usage of this \\\"Component\\\" is intentional to enable react-syntax-highlighter's own highlighter */}\\n\\nexport const Component = () => {\\nreturn <SyntaxHighlighter/>;\\n};\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 255]\"}, {\"title\": \"My Component With Env Variables\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: process.env.STORYBOOK_DATA_KEY\\n }}\\n/>\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n args={{\\n propertyA: process.env.STORYBOOK_DATA_KEY\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n};\\n\\nexport const ExampleStory = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ExampleStory: Story = {\\n args: {\\n propertyA: process.env.STORYBOOK_DATA_KEY,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 256]\"}, {\"title\": \"My Component With Global Syntax Highlight\", \"description\": null, \"content\": {\"SCSS example\": \"This is a sample Sass snippet example with Storybook docs\\n\\n{/* Don't forget to replace (\\\") with (```) when you copy the snippet to your own app */}\\n\\n\\\"scss\\n$font-stack: Helvetica, sans-serif;\\n$primary-color: #333;\\n\\nbody {\\nfont: 100% $font-stack;\\ncolor: $primary-color;\\n}\\n\\\"\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 257]\"}, {\"title\": \"Nextjs Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/nextjs', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/nextjs';\\n\\nconst config: StorybookConfig = {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/nextjs', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 258]\"}, {\"title\": \"Nextjs App Directory In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nexport default {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true, // \\ud83d\\udc48 Set this\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nconst meta = {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true, // \\ud83d\\udc48 Set this\\n },\\n },\\n} satisfies Meta<typeof NavigationBasedComponent>;\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 259]\"}, {\"title\": \"Nextjs App Directory In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n parameters: {\\n // ...\\n nextjs: {\\n appDirectory: true,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n // ...\\n parameters: {\\n // ...\\n nextjs: {\\n appDirectory: true,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 260]\"}, {\"title\": \"Nextjs Cache Mock\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { expect } from 'storybook/test';\\n\\n/*\\n * Replace your-framework with nextjs or nextjs-vite\\n * \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\n */\\nimport { revalidatePath } from '@storybook/your-framework/cache.mock';\\n\\nimport MyForm from './my-form';\\n\\nexport default {\\n component: MyForm,\\n};\\n\\nexport const Submitted = {\\n async play({ canvas, userEvent }) {\\n const submitButton = canvas.getByRole('button', { name: /submit/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 Use any mock assertions on the function\\n await expect(revalidatePath).toHaveBeenCalledWith('/');\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { revalidatePath } from '@storybook/your-framework/cache.mock';\\n\\nimport MyForm from './my-form';\\n\\nconst meta = {\\n component: MyForm,\\n} satisfies Meta<typeof MyForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Submitted: Story = {\\n async play({ canvas, userEvent }) {\\n const submitButton = canvas.getByRole('button', { name: /submit/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 Use any mock assertions on the function\\n await expect(revalidatePath).toHaveBeenCalledWith('/');\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 261]\"}, {\"title\": \"Nextjs Configure Svgr\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n webpackFinal: async (config) => {\\n config.module = config.module || {};\\n config.module.rules = config.module.rules || [];\\n\\n // This modifies the existing image rule to exclude .svg files\\n // since you want to handle those files with @svgr/webpack\\n const imageRule = config.module.rules.find((rule) => rule?.['test']?.test('.svg'));\\n if (imageRule) {\\n imageRule['exclude'] = /\\\\.svg$/;\\n }\\n\\n // Configure .svg files to be loaded with @svgr/webpack\\n config.module.rules.push({\\n test: /\\\\.svg$/,\\n use: ['@svgr/webpack'],\\n });\\n\\n return config;\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/nextjs';\\n\\nconst config: StorybookConfig = {\\n // ...\\n webpackFinal: async (config) => {\\n config.module = config.module || {};\\n config.module.rules = config.module.rules || [];\\n\\n // This modifies the existing image rule to exclude .svg files\\n // since you want to handle those files with @svgr/webpack\\n const imageRule = config.module.rules.find((rule) => rule?.['test']?.test('.svg'));\\n if (imageRule) {\\n imageRule['exclude'] = /\\\\.svg$/;\\n }\\n\\n // Configure .svg files to be loaded with @svgr/webpack\\n config.module.rules.push({\\n test: /\\\\.svg$/,\\n use: ['@svgr/webpack'],\\n });\\n\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 262]\"}, {\"title\": \"Nextjs Headers Mock\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { expect } from 'storybook/test';\\n\\n/*\\n * Replace your-framework with nextjs or nextjs-vite\\n * \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\n */\\nimport { cookies, headers } from '@storybook/your-framework/headers.mock';\\n\\nimport MyForm from './my-form';\\n\\nexport default {\\n component: MyForm,\\n};\\n\\nexport const LoggedInEurope = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set mock cookies and headers ahead of rendering\\n cookies().set('username', 'Sol');\\n headers().set('timezone', 'Central European Summer Time');\\n },\\n async play() {\\n // \\ud83d\\udc47 Assert that your component called the mocks\\n await expect(cookies().get).toHaveBeenCalledOnce();\\n await expect(cookies().get).toHaveBeenCalledWith('username');\\n await expect(headers().get).toHaveBeenCalledOnce();\\n await expect(cookies().get).toHaveBeenCalledWith('timezone');\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { cookies, headers } from '@storybook/your-framework/headers.mock';\\n\\nimport MyForm from './my-form';\\n\\nconst meta = {\\n component: MyForm,\\n} satisfies Meta<typeof MyForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LoggedInEurope: Story = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set mock cookies and headers ahead of rendering\\n cookies().set('username', 'Sol');\\n headers().set('timezone', 'Central European Summer Time');\\n },\\n async play() {\\n // \\ud83d\\udc47 Assert that your component called the mocks\\n await expect(cookies().get).toHaveBeenCalledOnce();\\n await expect(cookies().get).toHaveBeenCalledWith('username');\\n await expect(headers().get).toHaveBeenCalledOnce();\\n await expect(cookies().get).toHaveBeenCalledWith('timezone');\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 263]\"}, {\"title\": \"Nextjs Image Static Dirs\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n staticDirs: [\\n {\\n from: '../src/components/fonts',\\n to: 'src/components/fonts',\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n // ...\\n staticDirs: [\\n {\\n from: '../src/components/fonts',\\n to: 'src/components/fonts',\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 264]\"}, {\"title\": \"Nextjs Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/nextjs\\n```\", \"```\\npnpm add --save-dev @storybook/nextjs\\n```\", \"```\\nyarn add --dev @storybook/nextjs\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 265]\"}, {\"title\": \"Nextjs Navigation Mock\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { expect } from 'storybook/test';\\n\\n/*\\n * Replace your-framework with nextjs or nextjs-vite\\n * \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\n */\\nimport { redirect, getRouter } from '@storybook/your-framework/navigation.mock';\\n\\nimport MyForm from './my-form';\\n\\nexport default {\\n component: MyForm,\\n parameters: {\\n nextjs: {\\n // \\ud83d\\udc47 As in the Next.js application, next/navigation only works using App Router\\n appDirectory: true,\\n },\\n },\\n};\\n\\nexport const Unauthenticated = {\\n async play() {\\n // \\ud83d\\udc47 Assert that your component called redirect()\\n await expect(redirect).toHaveBeenCalledWith('/login', 'replace');\\n },\\n};\\n\\nexport const GoBack = {\\n async play({ canvas, userEvent }) {\\n const backBtn = await canvas.findByText('Go back');\\n\\n await userEvent.click(backBtn);\\n // \\ud83d\\udc47 Assert that your component called back()\\n await expect(getRouter().back).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { redirect, getRouter } from '@storybook/your-framework/navigation.mock';\\n\\nimport MyForm from './my-form';\\n\\nconst meta = {\\n component: MyForm,\\n parameters: {\\n nextjs: {\\n // \\ud83d\\udc47 As in the Next.js application, next/navigation only works using App Router\\n appDirectory: true,\\n },\\n },\\n} satisfies Meta<typeof MyForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Unauthenticated: Story = {\\n async play() {\\n // \\ud83d\\udc47 Assert that your component called redirect()\\n await expect(redirect).toHaveBeenCalledWith('/login', 'replace');\\n },\\n};\\n\\nexport const GoBack: Story = {\\n async play({ canvas, userEvent }) {\\n const backBtn = await canvas.findByText('Go back');\\n\\n await userEvent.click(backBtn);\\n // \\ud83d\\udc47 Assert that your component called back()\\n await expect(getRouter().back).toHaveBeenCalled();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 266]\"}, {\"title\": \"Nextjs Navigation Override In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nexport default {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n },\\n },\\n};\\n\\n// Interact with the links to see the route change events in the Actions panel.\\nexport const Example = {\\n parameters: {\\n nextjs: {\\n navigation: {\\n pathname: '/profile',\\n query: {\\n user: '1',\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nconst meta = {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n },\\n },\\n} satisfies Meta<typeof NavigationBasedComponent>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n// Interact with the links to see the route change events in the Actions panel.\\nexport const Example: Story = {\\n parameters: {\\n nextjs: {\\n navigation: {\\n pathname: '/profile',\\n query: {\\n user: '1',\\n },\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 267]\"}, {\"title\": \"Nextjs Navigation Segments For Use Params Override In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nexport default {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n navigation: {\\n segments: [\\n ['slug', 'hello'],\\n ['framework', 'nextjs'],\\n ],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nconst meta = {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n navigation: {\\n segments: [\\n ['slug', 'hello'],\\n ['framework', 'nextjs'],\\n ],\\n },\\n },\\n },\\n} satisfies Meta<typeof NavigationBasedComponent>;\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 268]\"}, {\"title\": \"Nextjs Navigation Segments Override In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nexport default {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n navigation: {\\n segments: ['dashboard', 'analytics'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport NavigationBasedComponent from './NavigationBasedComponent';\\n\\nconst meta = {\\n component: NavigationBasedComponent,\\n parameters: {\\n nextjs: {\\n appDirectory: true,\\n navigation: {\\n segments: ['dashboard', 'analytics'],\\n },\\n },\\n },\\n} satisfies Meta<typeof NavigationBasedComponent>;\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 269]\"}, {\"title\": \"Nextjs Remove Addons\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n addons: [\\n // ...\\n // \\ud83d\\udc47 These can both be removed\\n // 'storybook-addon-next',\\n // 'storybook-addon-next-router',\\n ],\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/nextjs';\\n\\nconst config: StorybookConfig = {\\n // ...\\n addons: [\\n // ...\\n // \\ud83d\\udc47 These can both be removed\\n // 'storybook-addon-next',\\n // 'storybook-addon-next-router',\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 270]\"}, {\"title\": \"Nextjs Router Mock\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { expect } from 'storybook/test';\\n\\n/*\\n * Replace your-framework with nextjs or nextjs-vite\\n * \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\n */\\nimport { getRouter } from '@storybook/your-framework/router.mock';\\n\\nimport MyForm from './my-form';\\n\\nexport default {\\n component: MyForm,\\n};\\n\\nexport const GoBack = {\\n async play({ canvas, userEvent }) {\\n const backBtn = await canvas.findByText('Go back');\\n\\n await userEvent.click(backBtn);\\n // \\ud83d\\udc47 Assert that your component called back()\\n await expect(getRouter().back).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { getRouter } from '@storybook/your-framework/router.mock';\\n\\nimport MyForm from './my-form';\\n\\nconst meta = {\\n component: MyForm,\\n} satisfies Meta<typeof MyForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const GoBack: Story = {\\n async play({ canvas, userEvent }) {\\n const backBtn = await canvas.findByText('Go back');\\n\\n await userEvent.click(backBtn);\\n // \\ud83d\\udc47 Assert that your component called back()\\n await expect(getRouter().back).toHaveBeenCalled();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 271]\"}, {\"title\": \"Nextjs Router Override In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport RouterBasedComponent from './RouterBasedComponent';\\n\\nexport default {\\n component: RouterBasedComponent,\\n};\\n\\n// Interact with the links to see the route change events in the Actions panel.\\nexport const Example = {\\n parameters: {\\n nextjs: {\\n router: {\\n pathname: '/profile/[id]',\\n asPath: '/profile/1',\\n query: {\\n id: '1',\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport RouterBasedComponent from './RouterBasedComponent';\\n\\nconst meta = {\\n component: RouterBasedComponent,\\n} satisfies Meta<typeof RouterBasedComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n// Interact with the links to see the route change events in the Actions panel.\\nexport const Example: Story = {\\n parameters: {\\n nextjs: {\\n router: {\\n pathname: '/profile/[id]',\\n asPath: '/profile/1',\\n query: {\\n id: '1',\\n },\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 272]\"}, {\"title\": \"Nextjs Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/nextjs-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/nextjs-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/nextjs-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 273]\"}, {\"title\": \"Nextjs Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/nextjs-vite\\n```\", \"```\\npnpm add --save-dev @storybook/nextjs-vite\\n```\", \"```\\nyarn add --dev @storybook/nextjs-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 274]\"}, {\"title\": \"Nextjs Vite Remove Addons\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n addons: [\\n // ...\\n // \\ud83d\\udc47 These can both be removed\\n // 'storybook-addon-next',\\n // 'storybook-addon-next-router',\\n ],\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/nextjs-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n addons: [\\n // ...\\n // \\ud83d\\udc47 These can both be removed\\n // 'storybook-addon-next',\\n // 'storybook-addon-next-router',\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 275]\"}, {\"title\": \"Other Foo Bar Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Foo } from './Foo.component';\\n\\nconst meta: Meta<Foo> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'OtherFoo/Bar',\\n component: Foo,\\n id: 'Foo/Bar', // Or 'foo-bar' if you prefer\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Foo>;\\n\\nexport const Baz: Story = {\\n name: 'Insert name here',\\n};\\n```\", \"```\\nimport { Foo } from './Foo';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'OtherFoo/Bar',\\n component: Foo,\\n id: 'Foo/Bar', // Or 'foo-bar' if you prefer\\n};\\n\\nexport const Baz = {\\n name: 'Insert name here',\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Foo } from './Foo';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'OtherFoo/Bar',\\n component: Foo,\\n id: 'Foo/Bar', // Or 'foo-bar' if you prefer\\n} satisfies Meta<typeof Foo>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Baz: Story = {\\n name: 'Insert name here',\\n};\\n```\", \"```\\nexport default {\\n title: 'OtherFoo/Bar',\\n component: 'foo',\\n id: 'Foo/Bar', // Or 'foo-bar' if you prefer\\n};\\n\\nexport const Baz = {\\n name: 'Insert name here',\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'OtherFoo/Bar',\\n component: 'foo',\\n id: 'Foo/Bar', // Or 'foo-bar' if you prefer\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Baz: Story = {\\n name: 'Insert name here',\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 276]\"}, {\"title\": \"Override Compose Story Test\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './LoginForm.stories';\\n\\nconst { ValidForm } = composeStories(stories, {\\n decorators: [\\n // Decorators defined here will be added to all composed stories from this function\\n ],\\n globalTypes: {\\n // Override globals for all composed stories from this function\\n },\\n parameters: {\\n // Override parameters for all composed stories from this function\\n },\\n});\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport Meta, { ValidForm as ValidFormStory } from './LoginForm.stories';\\n\\nconst ValidForm = composeStory(ValidFormStory, Meta, {\\n decorators: [\\n // Decorators defined here will be added to this story\\n ],\\n globalTypes: {\\n // Override globals for this story\\n },\\n parameters: {\\n // Override parameters for this story\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 277]\"}, {\"title\": \"Page Story Args Within Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { useArgs } from 'storybook/preview-api';\\n\\nimport { Checkbox } from './checkbox';\\n\\nexport default {\\n title: 'Inputs/Checkbox',\\n component: Checkbox,\\n};\\n\\nexport const Example = {\\n args: {\\n isChecked: false,\\n label: 'Try Me!',\\n },\\n /**\\n * \\ud83d\\udc47 To avoid linting issues, it is recommended to use a function with a capitalized name.\\n * If you are not concerned with linting, you may use an arrow function.\\n */\\n render: function Render(args) {\\n const [{ isChecked }, updateArgs] = useArgs();\\n\\n function onChange() {\\n updateArgs({ isChecked: !isChecked });\\n }\\n\\n return <Checkbox {...args} onChange={onChange} isChecked={isChecked} />;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { useArgs } from 'storybook/preview-api';\\n\\nimport { Checkbox } from './checkbox';\\n\\nconst meta = {\\n title: 'Inputs/Checkbox',\\n component: Checkbox,\\n} satisfies Meta<typeof Checkbox>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof Checkbox>;\\n\\nexport const Example = {\\n args: {\\n isChecked: false,\\n label: 'Try Me!',\\n },\\n /**\\n * \\ud83d\\udc47 To avoid linting issues, it is recommended to use a function with a capitalized name.\\n * If you are not concerned with linting, you may use an arrow function.\\n */\\n render: function Render(args) {\\n const [{ isChecked }, updateArgs] = useArgs();\\n\\n function onChange() {\\n updateArgs({ isChecked: !isChecked });\\n }\\n\\n return <Checkbox {...args} onChange={onChange} isChecked={isChecked} />;\\n },\\n} satisfies Story;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 278]\"}, {\"title\": \"Page Story Slots\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { argsToTemplate } from '@storybook/angular';\\n\\nimport { Page } from './page.component';\\n\\ntype PagePropsAndCustomArgs = Page & { footer?: string };\\n\\nconst meta: Meta<PagePropsAndCustomArgs> = {\\n component: Page,\\n render: ({ footer, ...args }) => ({\\n props: args,\\n template: `\\n <storybook-page ${argsToTemplate(args)}>\\n <ng-container footer>${footer}</ng-container>\\n </storybook-page>`,\\n }),\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<PagePropsAndCustomArgs>;\\n\\nexport const CustomFooter: Story = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\", \"```\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n render: ({ footer, ...args }) => (\\n <Page {...args}>\\n <footer>{footer}</footer>\\n </Page>\\n ),\\n};\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Page } from './Page';\\n\\ntype PagePropsAndCustomArgs = React.ComponentProps<typeof Page> & { footer?: string };\\n\\nconst meta = {\\n component: Page,\\n render: ({ footer, ...args }) => (\\n <Page {...args}>\\n <footer>{footer}</footer>\\n </Page>\\n ),\\n} satisfies Meta<PagePropsAndCustomArgs>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n} satisfies Story;\\n```\", \"```\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n render: ({ footer, ...args }) => (\\n <Page {...args}>\\n <footer>{footer}</footer>\\n </Page>\\n ),\\n};\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\", \"```\\nimport type { ComponentProps } from 'solid-js';\\n\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Page } from './Page';\\n\\ntype PagePropsAndCustomArgs = ComponentProps<typeof Page> & { footer?: string };\\n\\nconst meta = {\\n component: Page,\\n render: ({ footer, ...args }) => (\\n <Page {...args}>\\n <footer>{footer}</footer>\\n </Page>\\n ),\\n} satisfies Meta<PagePropsAndCustomArgs>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n} satisfies Story;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page\\n });\\n</script>\\n\\n<Story name=\\\"CustomFooter\\\" args={{ footer: 'Built with Storybook' }}>\\n {#snippet template(args)}\\n <Page {...args} >\\n <footer>{args.footer}</footer>\\n </Page>\\n {/snippet}\\n</Story>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page\\n });\\n</script>\\n\\n<Story name=\\\"CustomFooter\\\" args={{ footer: 'Built with Storybook' }}>\\n {#snippet template(args)}\\n <Page {...args} >\\n <footer>{args.footer}</footer>\\n </Page>\\n {/snippet}\\n</Story>\\n```\", \"```\\nimport Page from './Page.vue';\\n\\nexport default {\\n component: Page,\\n render: (args) => ({\\n components: { Page },\\n setup() {\\n return { args };\\n },\\n template: `\\n <page v-bind=\\\"args\\\">\\n <template v-slot:footer>\\n <footer v-if=\\\"args.footer\\\" v-html=\\\"args.footer\\\" />\\n </template>\\n </page>\\n `,\\n }),\\n};\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\", \"```\\nimport type { ComponentPropsAndSlots, Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Page from './Page.vue';\\n\\ntype PagePropsAndCustomArgs = ComponentPropsAndSlots<typeof Page> & { footer?: string };\\n\\nconst meta = {\\n component: Page,\\n render: (args) => ({\\n components: { Page },\\n setup() {\\n return { args };\\n },\\n template: `\\n <page v-bind=\\\"args\\\">\\n <template v-slot:footer>\\n <footer v-if=\\\"args.footer\\\" v-html=\\\"args.footer\\\" />\\n </template>\\n </page>\\n `,\\n }),\\n} satisfies Meta<PagePropsAndCustomArgs>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n} satisfies Story;\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'Page',\\n component: 'demo-page',\\n render: ({ footer }) => html`\\n <demo-page>\\n <footer>${footer}</footer>\\n </demo-page>\\n `,\\n};\\n\\nexport const CustomFooter = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\ntype CustomArgs = { footer?: string };\\n\\nconst meta: Meta<CustomArgs> = {\\n title: 'Page',\\n component: 'demo-page',\\n render: ({ footer }) => html`\\n <demo-page>\\n <footer>${footer}</footer>\\n </demo-page>\\n `,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<CustomArgs>;\\n\\nexport const CustomFooter: Story = {\\n args: {\\n footer: 'Built with Storybook',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 279]\"}, {\"title\": \"Page Story With Args Composition\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { DocumentScreen } from './YourPage.component';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nconst meta: Meta<DocumentScreen> = {\\n component: DocumentScreen,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<DocumentScreen>;\\n\\nexport const Simple: Story = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import DocumentScreen from './YourPage.svelte';\\n\\n // \\ud83d\\udc47 Imports the required stories\\n import * as PageLayout from './PageLayout.stories.svelte';\\n import * as DocumentHeader from './DocumentHeader.stories.svelte';\\n import * as DocumentList from './DocumentList.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Simple\\\"\\n args={{\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n }}\\n/>\\n```\", \"```\\nimport DocumentScreen from './YourPage.svelte';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nexport default {\\n component: DocumentScreen,\\n};\\n\\nexport const Simple = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\nimport { DocumentScreen } from './YourPage';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nexport default {\\n component: DocumentScreen,\\n};\\n\\nexport const Simple = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import DocumentScreen from './YourPage.svelte';\\n\\n // \\ud83d\\udc47 Imports the required stories\\n import * as PageLayout from './PageLayout.stories.svelte';\\n import * as DocumentHeader from './DocumentHeader.stories.svelte';\\n import * as DocumentList from './DocumentList.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: DocumentScreen,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Simple\\\"\\n args={{\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport DocumentScreen from './YourPage.svelte';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nconst meta = {\\n component: DocumentScreen,\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Simple: Story = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { DocumentScreen } from './YourPage';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nconst meta = {\\n component: DocumentScreen,\\n} satisfies Meta<typeof DocumentScreen>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Simple: Story = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Imports the required stories\\nimport * as PageLayout from './PageLayout.stories';\\nimport * as DocumentHeader from './DocumentHeader.stories';\\nimport * as DocumentList from './DocumentList.stories';\\n\\nexport default {\\n component: 'demo-document-screen',\\n};\\n\\nexport const Simple = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n// \\ud83d\\udc47 Imports the required stories\\nimport PageLayout from './PageLayout.stories';\\nimport DocumentHeader from './DocumentHeader.stories';\\nimport DocumentList from './DocumentList.stories';\\n\\nconst meta: Meta = {\\n component: 'demo-document-screen',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Simple: Story = {\\n args: {\\n user: PageLayout.Simple.args.user,\\n document: DocumentHeader.Simple.args.document,\\n subdocuments: DocumentList.Simple.args.documents,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 280]\"}, {\"title\": \"Page Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { moduleMetadata } from '@storybook/angular';\\n\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { CommonModule } from '@angular/common';\\n\\nimport { Button } from './button.component';\\nimport { Header } from './header.component';\\nimport { Page } from './page.component';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta: Meta<Page> = {\\n component: Page,\\n decorators: [\\n moduleMetadata({\\n declarations: [Button, Header],\\n imports: [CommonModule],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Page>;\\n\\nexport const LoggedIn: Story = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport { Page } from './Page';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nexport default {\\n component: Page,\\n};\\n\\nexport const LoggedIn = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Page } from './Page';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LoggedIn: Story = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport { Page } from './Page';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nexport default {\\n component: Page,\\n};\\n\\nexport const LoggedIn = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Page } from './Page';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LoggedIn: Story = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n //\\ud83d\\udc47 Imports all Header stories\\n import * as HeaderStories from './Header.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page,\\n });\\n</script>\\n\\n<Story name=\\\"LoggedIn\\\" args={{ ...HeaderStories.LoggedIn.args }} />\\n```\", \"```\\nimport Page from './Page.svelte';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nexport default {\\n component: Page,\\n};\\n\\nexport const LoggedIn = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n //\\ud83d\\udc47 Imports all Header stories\\n import * as HeaderStories from './Header.stories.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page,\\n });\\n</script>\\n\\n<Story name=\\\"LoggedIn\\\" args={{ ...HeaderStories.LoggedIn.args }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Page from './Page.svelte';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const LoggedIn: Story = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport Page from './Page.vue';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nexport default {\\n component: Page,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const LoggedIn = {\\n render: (args) => ({\\n components: { Page },\\n setup() {\\n return { args };\\n },\\n template: '<page v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Page from './Page.vue';\\n\\n//\\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => ({\\n components: { Page },\\n setup() {\\n return { args };\\n },\\n template: '<page v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nexport default {\\n component: 'demo-page',\\n};\\n\\nexport const LoggedIn = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n// \\ud83d\\udc47 Imports all Header stories\\nimport * as HeaderStories from './Header.stories';\\n\\nconst meta: Meta = {\\n component: 'demo-page',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const LoggedIn: Story = {\\n args: {\\n ...HeaderStories.LoggedIn.args,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 281]\"}, {\"title\": \"Parameters In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n};\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n //\\ud83d\\udc47 Creates specific parameters at the component level\\n parameters: {\\n backgrounds: {\\n options: {},\\n },\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 282]\"}, {\"title\": \"Parameters In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n backgrounds: {\\n options: {\\n light: { name: 'Light', value: '#fff' },\\n dark: { name: 'Dark', value: '#333' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n backgrounds: {\\n options: {\\n light: { name: 'Light', value: '#fff' },\\n dark: { name: 'Dark', value: '#333' },\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 283]\"}, {\"title\": \"Parameters In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 Story-level parameters-->\\n<Story\\n name=\\\"Primary\\\"\\n parameters={{\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 Story-level parameters-->\\n<Story\\n name=\\\"Primary\\\"\\n parameters={{\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Primary: Story = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Primary = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n backgrounds: {\\n options: {\\n red: { name: 'Red', value: '#f00' },\\n green: { name: 'Green', value: '#0f0' },\\n blue: { name: 'Blue', value: '#00f' },\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 284]\"}, {\"title\": \"Play Function Composition\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<MyComponent>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FirstStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('an-element'), 'example-value');\\n },\\n};\\n\\nexport const SecondStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('other-element'), 'another value');\\n },\\n};\\n\\nexport const CombinedStories: Story = {\\n play: async ({ context, canvas, userEvent }) => {\\n // Runs the FirstStory and Second story play function before running this story's play function\\n await FirstStory.play(context);\\n await SecondStory.play(context);\\n await userEvent.type(canvas.getByTestId('another-element'), 'random value');\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FirstStory = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('an-element'), 'example-value');\\n },\\n};\\n\\nexport const SecondStory = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('other-element'), 'another value');\\n },\\n};\\n\\nexport const CombinedStories = {\\n play: async ({ context, canvas, userEvent }) => {\\n // Runs the FirstStory and Second story play function before running this story's play function\\n await FirstStory.play(context);\\n await SecondStory.play(context);\\n await userEvent.type(canvas.getByTestId('another-element'), 'random value');\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FirstStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('an-element'), 'example-value');\\n },\\n};\\n\\nexport const SecondStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('other-element'), 'another value');\\n },\\n};\\n\\nexport const CombinedStories: Story = {\\n play: async ({ context, canvas, userEvent }) => {\\n // Runs the FirstStory and Second story play function before running this story's play function\\n await FirstStory.play(context);\\n await SecondStory.play(context);\\n await userEvent.type(canvas.getByTestId('another-element'), 'random value');\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-my-component',\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FirstStory = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('an-element'), 'example-value');\\n },\\n};\\n\\nexport const SecondStory = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('other-element'), 'another value');\\n },\\n};\\n\\nexport const CombinedStories = {\\n play: async ({ context, canvas, userEvent }) => {\\n // Runs the FirstStory and Second story play function before running this story's play function\\n await FirstStory.play(context);\\n await SecondStory.play(context);\\n await userEvent.type(canvas.getByTestId('another-element'), 'random value');\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nconst meta: Meta = {\\n component: 'demo-my-component',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FirstStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('an-element'), 'example-value');\\n },\\n};\\n\\nexport const SecondStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.type(canvas.getByTestId('other-element'), 'another value');\\n },\\n};\\n\\nexport const CombinedStories: Story = {\\n play: async ({ context, canvas, userEvent }) => {\\n // Runs the FirstStory and Second story play function before running this story's play function\\n await FirstStory.play(context);\\n await SecondStory.play(context);\\n await userEvent.type(canvas.getByTestId('another-element'), 'random value');\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 285]\"}, {\"title\": \"Play Function With Canvas\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n component: MyComponent,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const ExampleStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n play={async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n }} />\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nexport const ExampleStory = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"ExampleStory\\\"\\n play={async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExampleStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-my-component',\\n};\\n\\nexport const ExampleStory = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-my-component',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const ExampleStory: Story = {\\n play: async ({ canvas, userEvent }) => {\\n // Starts querying from the component's root element\\n await userEvent.type(canvas.getByTestId('example-element'), 'something');\\n await userEvent.click(canvas.getByRole('button'));\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 286]\"}, {\"title\": \"Play Function With Screen\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { screen } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog.component';\\n\\nconst meta: Meta<Dialog> = {\\n component: Dialog,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Dialog>;\\n\\nexport const Open: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { screen } from 'storybook/test';\\n\\n import Dialog from './Dialog.svelte';\\n\\n const { Story } = defineMeta({\\n component: Dialog,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Open\\\"\\n play={async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n }} />\\n```\", \"```\\nimport Dialog from './Dialog.svelte';\\n\\nexport default {\\n component: Dialog,\\n};\\n\\nexport const Open = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\nimport { Dialog } from './Dialog';\\nimport { screen } from 'storybook/test';\\n\\nexport default {\\n component: Dialog,\\n};\\n\\nexport const Open = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { screen } from 'storybook/test';\\n\\n import Dialog from './Dialog.svelte';\\n\\n const { Story } = defineMeta({\\n component: Dialog,\\n });\\n</script>\\n\\n<Story\\n name=\\\"Open\\\"\\n play={async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n }} />\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { screen } from 'storybook/test';\\n\\nimport Dialog from './Dialog.svelte';\\n\\nconst meta = {\\n component: Dialog,\\n} satisfies Meta<typeof Dialog>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Open: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { screen } from 'storybook/test';\\n\\nimport { Dialog } from './Dialog';\\n\\nconst meta = {\\n component: Dialog,\\n} satisfies Meta<typeof Dialog>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Open: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\nimport { screen } from 'storybook/test';\\n\\nexport default {\\n component: 'demo-dialog',\\n};\\n\\nexport const Open = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { screen } from 'storybook/test';\\n\\nconst meta: Meta = {\\n component: 'demo-dialog',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Open: Story = {\\n play: async ({ canvas, userEvent }) => {\\n await userEvent.click(canvas.getByRole('button', { name: 'Open dialog' }));\\n\\n // Starts querying from the document\\n const dialog = screen.getByRole('dialog');\\n await expect(dialog).toBeVisible();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 287]\"}, {\"title\": \"Play Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { RegistrationForm } from './RegistrationForm.component';\\n\\nconst meta: Meta<RegistrationForm> = {\\n component: RegistrationForm,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<RegistrationForm>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import RegistrationForm from './RegistrationForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: RegistrationForm,\\n });\\n</script>\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n-->\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n }}\\n/>\\n```\", \"```\\nimport RegistrationForm from './RegistrationForm.svelte';\\n\\nexport default {\\n component: RegistrationForm,\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\nimport { RegistrationForm } from './RegistrationForm';\\n\\nexport default {\\n component: RegistrationForm,\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import RegistrationForm from './RegistrationForm.svelte';\\n\\n const { Story } = defineMeta({\\n component: RegistrationForm,\\n });\\n</script>\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n-->\\n<Story\\n name=\\\"FilledForm\\\"\\n play={async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport RegistrationForm from './RegistrationForm.svelte';\\n\\nconst meta = {\\n component: RegistrationForm,\\n} satisfies Meta<typeof RegistrationForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { RegistrationForm } from './RegistrationForm';\\n\\nconst meta = {\\n component: RegistrationForm,\\n} satisfies Meta<typeof RegistrationForm>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-registration-form',\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-registration-form',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const FilledForm: Story = {\\n play: async ({ canvas, userEvent }) => {\\n const emailInput = canvas.getByLabelText('email', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(emailInput, 'example-email@email.com', {\\n delay: 100,\\n });\\n\\n const passwordInput = canvas.getByLabelText('password', {\\n selector: 'input',\\n });\\n\\n await userEvent.type(passwordInput, 'ExamplePassword', {\\n delay: 100,\\n });\\n\\n const submitButton = canvas.getByRole('button');\\n await userEvent.click(submitButton);\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 288]\"}, {\"title\": \"Portable Stories Csf Factory Render\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test, expect } from 'vitest';\\nimport { render, screen } from '@testing-library/react';\\n\\n// Import all stories from the stories file\\nimport * as stories from './Button.stories';\\n\\nconst { Primary, Secondary } = stories;\\n\\ntest('renders primary button with default args', async () => {\\n // Access the story's component via the .Component property\\n render(<Primary.Component />);\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n // You can override props by passing them directly to the story's component\\n render(<Primary.Component>Hello world</Primary.Component>);\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 289]\"}, {\"title\": \"Portable Stories Csf Factory Run\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test, expect } from 'vitest';\\nimport { screen } from '@testing-library/react';\\n\\n// Import all stories from the stories file\\nimport * as stories from './Button.stories';\\n\\nconst { Primary, Secondary } = stories;\\n\\ntest('renders primary button with default args', async () => {\\n // The run function will mount the component and run all of Storybook's lifecycle hooks\\n await Primary.run();\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n // You can override props by passing them in the context argument of the run function\\n await Primary.run({ args: { ...Primary.composed.args, children: 'Hello world' } });\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 290]\"}, {\"title\": \"Portable Stories Jest Compose Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test, expect } from '@jest/globals';\\nimport { render, screen } from '@testing-library/react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\n// Import all stories and the component annotations from the stories file\\nimport * as stories from './Button.stories';\\n\\n// Every component that is returned maps 1:1 with the stories,\\n// but they already contain all annotations from story, meta, and project levels\\nconst { Primary, Secondary } = composeStories(stories);\\n\\ntest('renders primary button with default args', () => {\\n render(<Primary />);\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', () => {\\n // You can override props and they will get merged with values from the story's args\\n render(<Primary>Hello world</Primary>);\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\", \"```\\nimport { test, expect } from '@jest/globals';\\nimport { render, screen } from '@testing-library/vue';\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\n// Import all stories and the component annotations from the stories file\\nimport * as stories from './Button.stories';\\n\\n// Every component that is returned maps 1:1 with the stories,\\n// but they already contain all annotations from story, meta, and project levels\\nconst { Primary, Secondary } = composeStories(stories);\\n\\ntest('renders primary button with default args', () => {\\n render(Primary);\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', () => {\\n // You can override props and they will get merged with values from the story's args\\n render(Primary, { props: { label: 'Hello world' } });\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 291]\"}, {\"title\": \"Portable Stories Jest Compose Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { jest, test, expect } from '@jest/globals';\\nimport { render, screen } from '@testing-library/react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('onclick handler is called', () => {\\n // Returns a story which already contains all annotations from story, meta and global levels\\n const Primary = composeStory(PrimaryStory, meta);\\n\\n const onClickSpy = jest.fn();\\n await Primary.run({ args: { ...Primary.args, onClick: onClickSpy } });\\n\\n const buttonElement = screen.getByRole('button');\\n buttonElement.click();\\n expect(onClickSpy).toHaveBeenCalled();\\n});\\n```\", \"```\\nimport { jest, test, expect } from '@jest/globals';\\nimport { render, screen } from '@testing-library/vue';\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('onclick handler is called', () => {\\n // Returns a story which already contains all annotations from story, meta and global levels\\n const Primary = composeStory(PrimaryStory, meta);\\n\\n const onClickSpy = jest.fn();\\n await Primary.run({ args: { ...Primary.args, onClick: onClickSpy } });\\n\\n const buttonElement = screen.getByRole('button');\\n buttonElement.click();\\n expect(onClickSpy).toHaveBeenCalled();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 292]\"}, {\"title\": \"Portable Stories Jest Multi Snapshot Test\", \"description\": null, \"content\": {\"root\": [\"```\\n// \\ud83d\\udc47 Augment expect with jest-specific-snapshot\\nimport 'jest-specific-snapshot';\\n\\n// ...Code omitted for brevity\\n\\ndescribe(options.suite, () => {\\n //\\ud83d\\udc47 Add storyDir in the arguments list\\n getAllStoryFiles().forEach(({ filePath, storyFile, storyDir }) => {\\n // ...Previously existing code\\n describe(title, () => {\\n // ...Previously existing code\\n stories.forEach(({ name, story }) => {\\n // ...Previously existing code\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n\\n //\\ud83d\\udc47 Define the path to save the snapshot to:\\n const snapshotPath = path.join(\\n storyDir,\\n options.snapshotsDirName,\\n `${componentName}${options.snapshotExtension}`,\\n );\\n expect(document.body.firstChild).toMatchSpecificSnapshot(snapshotPath);\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 293]\"}, {\"title\": \"Portable Stories Jest Override Globals\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test } from '@jest/globals';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('renders in English', async () => {\\n const Primary = composeStory(\\n PrimaryStory,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n );\\n\\n await Primary.run();\\n});\\n\\ntest('renders in Spanish', async () => {\\n const Primary = composeStory(PrimaryStory, meta, { globals: { locale: 'es' } });\\n\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from '@jest/globals';\\nimport { render } from '@testing-library/vue';\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('renders in English', async () => {\\n const Primary = composeStory(\\n PrimaryStory,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n );\\n\\n await Primary.run();\\n});\\n\\ntest('renders in Spanish', async () => {\\n const Primary = composeStory(PrimaryStory, meta, { globals: { locale: 'es' } });\\n\\n await Primary.run();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 294]\"}, {\"title\": \"Portable Stories Jest Set Project Annotations\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { beforeAll } from '@jest/globals';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Supports beforeAll hook from Storybook\\nbeforeAll(annotations.beforeAll);\\n```\", \"```\\nimport { beforeAll } from '@jest/globals';\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Supports beforeAll hook from Storybook\\nbeforeAll(annotations.beforeAll);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 295]\"}, {\"title\": \"Portable Stories Jest Snapshot Test\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\nimport * as glob from 'glob';\\n\\nimport { describe, test, expect } from '@jest/globals';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}')\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n return { filePath, storyFile };\\n });\\n}\\n\\n// Recreate similar options to Storyshots. Place your configuration below\\nconst options = {\\n suite: 'Storybook Tests',\\n storyKindRegex: /^.*?DontTest$/,\\n storyNameRegex: /UNSET/,\\n snapshotsDirName: '__snapshots__',\\n snapshotExtension: '.storyshot',\\n};\\n\\ndescribe(options.suite, () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n if (options.storyKindRegex.test(title) || meta.parameters?.storyshots?.disable) {\\n // Skip component tests if they are disabled\\n return;\\n }\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile))\\n .map(([name, story]) => ({ name, story }))\\n .filter(({ name, story }) => {\\n // Implements a filtering mechanism to avoid running stories that are disabled via parameters or that match a specific regex mirroring the default behavior of Storyshots.\\n return !options.storyNameRegex.test(name) && !story.parameters.storyshots?.disable;\\n });\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module, without a disable parameter, or add parameters.storyshots.disable in the default export of this file.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n // Instead of not running the test, you can create logic to skip it, flagging it accordingly in the test results.\\n const testFn = story.parameters.storyshots?.skip ? test.skip : test;\\n\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\nimport path from 'path';\\nimport * as glob from 'glob';\\n\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport { describe, test, expect } from '@jest/globals';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (entry: StoryFile): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}')\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n return { filePath, storyFile };\\n });\\n}\\n\\n// Recreate similar options to Storyshots. Place your configuration below\\nconst options = {\\n suite: 'Storybook Tests',\\n storyKindRegex: /^.*?DontTest$/,\\n storyNameRegex: /UNSET/,\\n snapshotsDirName: '__snapshots__',\\n snapshotExtension: '.storyshot',\\n};\\n\\ndescribe(options.suite, () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n if (options.storyKindRegex.test(title) || meta.parameters?.storyshots?.disable) {\\n // Skip component tests if they are disabled\\n return;\\n }\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile))\\n .map(([name, story]) => ({ name, story }))\\n .filter(({ name, story }) => {\\n // Implements a filtering mechanism to avoid running stories that are disabled via parameters or that match a specific regex mirroring the default behavior of Storyshots.\\n return !options.storyNameRegex.test(name) && !story.parameters.storyshots?.disable;\\n });\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module, without a disable parameter, or add parameters.storyshots.disable in the default export of this file.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n // Instead of not running the test, you can create logic to skip it, flagging it accordingly in the test results.\\n const testFn = story.parameters.storyshots?.skip ? test.skip : test;\\n\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 296]\"}, {\"title\": \"Portable Stories Jest With Play Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test } from '@jest/globals';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('renders and executes the play function', async () => {\\n // Mount story and run interactions\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from '@jest/globals';\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('renders and executes the play function', async () => {\\n // Mount story and run interactions\\n await Primary.run();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 297]\"}, {\"title\": \"Portable Stories Playwright Ct Compose Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test } from '@playwright/experimental-ct-react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Supports beforeAll hook from Storybook\\ntest.beforeAll(annotations.beforeAll);\\n```\", \"```\\nimport { test } from '@playwright/experimental-ct-vue';\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Supports beforeAll hook from Storybook\\ntest.beforeAll(annotations.beforeAll);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 298]\"}, {\"title\": \"Portable Stories Playwright Ct Override Globals\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary } from './Button.stories';\\n\\nexport const PrimaryEnglish = composeStory(\\n Primary,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n);\\n\\nexport const PrimarySpanish = composeStory(Primary, meta, { globals: { locale: 'es' } });\\n```\", \"```\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport meta, { Primary } from './Button.stories';\\n\\nexport const PrimaryEnglish = composeStory(\\n Primary,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n);\\n\\nexport const PrimarySpanish = composeStory(Primary, meta, { globals: { locale: 'es' } });\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 299]\"}, {\"title\": \"Portable Stories Playwright Ct\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { createTest } from '@storybook/react/experimental-playwright';\\nimport { test as base } from '@playwright/experimental-ct-react';\\n\\n// See explanation below for `.portable` stories file\\nimport stories from './Button.stories.portable';\\n\\nconst test = createTest(base);\\n\\ntest('renders primary button', async ({ mount }) => {\\n // The mount function will execute all the necessary steps in the story,\\n // such as loaders, render, and play function\\n await mount(<stories.Primary />);\\n});\\n\\ntest('renders primary button with overridden props', async ({ mount }) => {\\n // You can pass custom props to your component via JSX\\n const component = await mount(<stories.Primary label=\\\"label from test\\\" />);\\n await expect(component).toContainText('label from test');\\n await expect(component.getByRole('button')).toHaveClass(/storybook-button--primary/);\\n});\\n```\", \"```\\nimport { createTest } from '@storybook/vue3/experimental-playwright';\\nimport { test as base } from '@playwright/experimental-ct-vue';\\n\\n// See explanation below for `.portable` stories file\\nimport stories from './Button.stories.portable';\\n\\nconst test = createTest(base);\\n\\n// \\ud83d\\udc49 Important: Due to current limitations, you can only reference your stories as JSX elements.\\n\\ntest('renders primary button', async ({ mount }) => {\\n // The mount function will execute all the necessary steps in the story,\\n // such as loaders, render, and play function\\n await mount(<stories.Primary />);\\n});\\n\\ntest('renders primary button with overridden props', async ({ mount }) => {\\n // You can pass custom props to your component via JSX\\n const component = await mount(<stories.Primary label=\\\"label from test\\\" />);\\n await expect(component).toContainText('label from test');\\n await expect(component.getByRole('button')).toHaveClass(/storybook-button--primary/);\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 300]\"}, {\"title\": \"Portable Stories Vitest Compose Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test, expect } from 'vitest';\\nimport { screen } from '@testing-library/react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\n// Import all stories and the component annotations from the stories file\\nimport * as stories from './Button.stories';\\n\\n// Every component that is returned maps 1:1 with the stories,\\n// but they already contain all annotations from story, meta, and project levels\\nconst { Primary, Secondary } = composeStories(stories);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n // You can override props by passing them in the context argument of the run function\\n await Primary.run({ args: { ...Primary.args, children: 'Hello world' } });\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\", \"```\\nimport { test, expect } from 'vitest';\\nimport { screen } from '@testing-library/svelte';\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStories } from '@storybook/your-framework';\\n\\n// Import all stories and the component annotations from the stories file\\nimport * as stories from './Button.stories';\\n\\n// Every component that is returned maps 1:1 with the stories,\\n// but they already contain all annotations from story, meta, and project levels\\nconst { Primary, Secondary } = composeStories(stories);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n // You can override props by passing them in the context argument of the run function\\n await Primary.run({ args: { ...Primary.args, children: 'Hello world' } });\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\", \"```\\nimport { test, expect } from 'vitest';\\nimport { screen } from '@testing-library/vue';\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\n// Import all stories and the component annotations from the stories file\\nimport * as stories from './Button.stories';\\n\\n// Every component that is returned maps 1:1 with the stories,\\n// but they already contain all annotations from story, meta, and project levels\\nconst { Primary, Secondary } = composeStories(stories);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n // You can override props by passing them in the context argument of the run function\\n await Primary.run({ args: { ...Primary.args, children: 'Hello world' } });\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 301]\"}, {\"title\": \"Portable Stories Vitest Compose Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { vi, test, expect } from 'vitest';\\nimport { screen } from '@testing-library/react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\n// Returns a story which already contains all annotations from story, meta and global levels\\nconst Primary = composeStory(PrimaryStory, meta);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n await Primary.run({ args: { ...Primary.args, label: 'Hello world' } });\\n\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\", \"```\\nimport { vi, test, expect } from 'vitest';\\nimport { render, screen } from '@testing-library/svelte';\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\n// Returns a story which already contains all annotations from story, meta and global levels\\nconst Primary = composeStory(PrimaryStory, meta);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n await Primary.run({ args: { ...Primary.args, label: 'Hello world' } });\\n\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\", \"```\\nimport { vi, test, expect } from 'vitest';\\nimport { render, screen } from '@testing-library/vue';\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\n// Returns a story which already contains all annotations from story, meta and global levels\\nconst Primary = composeStory(PrimaryStory, meta);\\n\\ntest('renders primary button with default args', async () => {\\n await Primary.run();\\n\\n const buttonElement = screen.getByText('Text coming from args in stories file!');\\n expect(buttonElement).not.toBeNull();\\n});\\n\\ntest('renders primary button with overridden props', async () => {\\n await Primary.run({ args: { ...Primary.args, label: 'Hello world' } });\\n\\n const buttonElement = screen.getByText(/Hello world/i);\\n expect(buttonElement).not.toBeNull();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 302]\"}, {\"title\": \"Portable Stories Vitest Multi Snapshot Test\", \"description\": null, \"content\": {\"root\": [\"```\\n// ...Code omitted for brevity\\n\\ndescribe(options.suite, () => {\\n // \\ud83d\\udc47 Add storyDir in the arguments list\\n getAllStoryFiles().forEach(({ filePath, storyFile, storyDir }) => {\\n // ...Previously existing code\\n describe(title, () => {\\n // ...Previously existing code\\n stories.forEach(({ name, story }) => {\\n // ...Previously existing code\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n\\n // \\ud83d\\udc47 Define the path to save the snapshot to:\\n const snapshotPath = path.join(\\n storyDir,\\n options.snapshotsDirName,\\n `${componentName}${options.snapshotExtension}`,\\n );\\n await expect(document.body.firstChild).toMatchFileSnapshot(snapshotPath);\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 303]\"}, {\"title\": \"Portable Stories Vitest Override Globals\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test } from 'vitest';\\nimport { render } from '@testing-library/react';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('renders in English', async () => {\\n const Primary = composeStory(\\n PrimaryStory,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n );\\n\\n await Primary.run();\\n});\\n\\ntest('renders in Spanish', async () => {\\n const Primary = composeStory(PrimaryStory, meta, { globals: { locale: 'es' } });\\n\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from 'vitest';\\nimport { render } from '@testing-library/svelte';\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('renders in English', async () => {\\n const Primary = composeStory(\\n PrimaryStory,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n );\\n\\n await Primary.run();\\n});\\n\\ntest('renders in Spanish', async () => {\\n const Primary = composeStory(PrimaryStory, meta, { globals: { locale: 'es' } });\\n\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from 'vitest';\\nimport { render } from '@testing-library/vue';\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport meta, { Primary as PrimaryStory } from './Button.stories';\\n\\ntest('renders in English', async () => {\\n const Primary = composeStory(\\n PrimaryStory,\\n meta,\\n { globals: { locale: 'en' } } // \\ud83d\\udc48 Project annotations to override the locale\\n );\\n\\n await Primary.run();\\n});\\n\\ntest('renders in Spanish', async () => {\\n const Primary = composeStory(PrimaryStory, meta, { globals: { locale: 'es' } });\\n\\n await Primary.run();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 304]\"}, {\"title\": \"Portable Stories Vitest Set Project Annotations\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { beforeAll } from 'vitest';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Run Storybook's beforeAll hook\\nbeforeAll(annotations.beforeAll);\\n```\", \"```\\nimport { beforeAll } from 'vitest';\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Run Storybook's beforeAll hook\\nbeforeAll(annotations.beforeAll);\\n```\", \"```\\nimport { beforeAll } from 'vitest';\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\n// \\ud83d\\udc47 Import the exported annotations, if any, from the addons you're using; otherwise remove this\\nimport * as addonAnnotations from 'my-addon/preview';\\nimport * as previewAnnotations from './.storybook/preview';\\n\\nconst annotations = setProjectAnnotations([previewAnnotations, addonAnnotations]);\\n\\n// Run Storybook's beforeAll hook\\nbeforeAll(annotations.beforeAll);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 305]\"}, {\"title\": \"Portable Stories Vitest Snapshot Test\", \"description\": null, \"content\": {\"root\": [\"```\\n// @vitest-environment jsdom\\n\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\n\\n// Recreate similar options to Storyshots. Place your configuration below\\nconst options = {\\n suite: 'Storybook Tests',\\n storyKindRegex: /^.*?DontTest$/,\\n storyNameRegex: /UNSET/,\\n snapshotsDirName: '__snapshots__',\\n snapshotExtension: '.storyshot',\\n};\\n\\ndescribe(options.suite, () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName, storyDir }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n if (options.storyKindRegex.test(title) || meta.parameters?.storyshots?.disable) {\\n // Skip component tests if they are disabled\\n return;\\n }\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile))\\n .map(([name, story]) => ({ name, story }))\\n .filter(({ name, story }) => {\\n // Implements a filtering mechanism to avoid running stories that are disabled via parameters or that match a specific regex mirroring the default behavior of Storyshots.\\n return !options.storyNameRegex?.test(name) && !story.parameters.storyshots?.disable;\\n });\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module, without a disable parameter, or add parameters.storyshots.disable in the default export of this file.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n // Instead of not running the test, you can create logic to skip it, flagging it accordingly in the test results.\\n const testFn = story.parameters.storyshots?.skip ? test.skip : test;\\n\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (entry: StoryFile): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob<StoryFile>('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\n\\n// Recreate similar options to Storyshots. Place your configuration below\\nconst options = {\\n suite: 'Storybook Tests',\\n storyKindRegex: /^.*?DontTest$/,\\n storyNameRegex: /UNSET/,\\n snapshotsDirName: '__snapshots__',\\n snapshotExtension: '.storyshot',\\n};\\n\\ndescribe(options.suite, () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName, storyDir }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n if (options.storyKindRegex.test(title) || meta.parameters?.storyshots?.disable) {\\n // Skip component tests if they are disabled\\n return;\\n }\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile))\\n .map(([name, story]) => ({ name, story }))\\n .filter(({ name, story }) => {\\n // Implements a filtering mechanism to avoid running stories that are disabled via parameters or that match a specific regex mirroring the default behavior of Storyshots.\\n return !options.storyNameRegex?.test(name) && !story.parameters.storyshots?.disable;\\n });\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module, without a disable parameter, or add parameters.storyshots.disable in the default export of this file.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n // Instead of not running the test, you can create logic to skip it, flagging it accordingly in the test results.\\n const testFn = story.parameters.storyshots?.skip ? test.skip : test;\\n\\n testFn(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 306]\"}, {\"title\": \"Portable Stories Vitest With Play Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { test } from 'vitest';\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('renders and executes the play function', async () => {\\n // Mount story and run interactions\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from 'vitest';\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('renders and executes the play function', async () => {\\n // Mount story and run interactions\\n await Primary.run();\\n});\\n```\", \"```\\nimport { test } from 'vitest';\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('renders and executes the play function', async () => {\\n // Mount story and run interactions\\n await Primary.run();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 307]\"}, {\"title\": \"Preact Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n // framework: '@storybook/preact-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/preact-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/preact-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n // framework: '@storybook/preact-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/preact-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 308]\"}, {\"title\": \"Preact Vite Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/preact-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/preact-vite';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/preact-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 309]\"}, {\"title\": \"Preact Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/preact-vite\\n```\", \"```\\npnpm add --save-dev @storybook/preact-vite\\n```\", \"```\\nyarn add --dev @storybook/preact-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 310]\"}, {\"title\": \"Preview Storybook Production Mode\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx http-server ./path/to/build\\n```\", \"```\\npnpm dlx http-server ./path/to/build\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 311]\"}, {\"title\": \"React Native Web Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n addons: [\\n '@storybook/addon-react-native-web', // \\ud83d\\udc48 Remove the addon\\n ],\\n // Replace @storybook/react-webpack5 with the Vite framework\\n framework: '@storybook/react-native-web-vite',\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/react-native-web-vite';\\n\\nconst config: StorybookConfig = {\\n addons: [\\n '@storybook/addon-react-native-web', // \\ud83d\\udc48 Remove the addon\\n ],\\n // Replace @storybook/react-webpack5 with the Vite framework\\n framework: '@storybook/react-native-web-vite',\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 312]\"}, {\"title\": \"React Native Web Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/react-native-web-vite vite\\n```\", \"```\\npnpm add --save-dev @storybook/react-native-web-vite vite\\n```\", \"```\\nyarn add --dev @storybook/react-native-web-vite vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 313]\"}, {\"title\": \"React Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/react-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/react-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n // framework: '@storybook/react-webpack5', \\ud83d\\udc48 Remove this\\n framework: '@storybook/react-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 314]\"}, {\"title\": \"React Vite Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/react-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/react-vite';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/react-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 315]\"}, {\"title\": \"React Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/react-vite\\n```\", \"```\\npnpm add --save-dev @storybook/react-vite\\n```\", \"```\\nyarn add --dev @storybook/react-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 316]\"}, {\"title\": \"React Webpack5 Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/react-webpack5', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/react-webpack5';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/react-webpack5', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 317]\"}, {\"title\": \"React Webpack5 Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/react-webpack5',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/react-webpack5';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/react-webpack5',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 318]\"}, {\"title\": \"React Webpack5 Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/react-webpack5\\n```\", \"```\\npnpm add --save-dev @storybook/react-webpack5\\n```\", \"```\\nyarn add --dev @storybook/react-webpack5\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 319]\"}, {\"title\": \"Render Custom In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular/';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n render: (args) => ({\\n props: args,\\n template: `\\n <demo-alert>\\n Alert text\\n <demo-button ${argsToTemplate(args)}></demo-button>\\n </demo-alert>\\n `,\\n }),\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const DefaultInAlert: Story = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport { Alert } from './Alert';\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n render: (args) => (\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n ),\\n};\\n\\nexport const DefaultInAlert = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Alert } from './Alert';\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n render: (args) => (\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n ),\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const DefaultInAlert: Story = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport Alert from './Alert.vue';\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n render: (args) => ({\\n components: { Alert, Button },\\n setup() {\\n return { args };\\n },\\n template: '<Alert><Button v-bind=\\\"args\\\" /></Alert>',\\n }),\\n};\\n\\nexport const DefaultInAlert = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Alert from './Alert.vue';\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n render: (args) => ({\\n components: { Alert, Button },\\n setup() {\\n return { args };\\n },\\n template: '<Alert><Button v-bind=\\\"args\\\" /></Alert>',\\n }),\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const DefaultInAlert: Story = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport html from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n render: (args) => html`\\n <demo-alert>\\n Alert text\\n <demo-button ?primary=\\\"${args.primary}\\\" label=\\\"${args.label}\\\"></demo-button>\\n </demo-alert>\\n `,\\n};\\n\\nexport const DefaultInAlert = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport html from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n render: (args) => html`\\n <demo-alert>\\n Alert text\\n <demo-button ?primary=\\\"${args.primary}\\\" label=\\\"${args.label}\\\"></demo-button>\\n </demo-alert>\\n `,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const DefaultInAlert: Story = {\\n args: {\\n label: 'Button',\\n },\\n};\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 320]\"}, {\"title\": \"Render Custom In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular/';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n render: (args) => ({\\n props: args,\\n template: `\\n <demo-alert>\\n Alert text\\n <demo-button ${argsToTemplate(args)}></demo-button>\\n </demo-alert>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { Alert } from './Alert';\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const PrimaryInAlert = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n render: (args) => (\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Alert } from './Alert';\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n render: (args) => (\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n ),\\n};\\n```\", \"```\\nimport Alert from './Alert.vue';\\nimport Button from './Button.vue';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const PrimaryInAlert = {\\n render: (args) => ({\\n components: { Alert, Button },\\n setup() {\\n return { args };\\n },\\n template: '<Alert><Button v-bind=\\\"args\\\" /></Alert>',\\n }),\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport Alert from './Alert.vue';\\nimport Button from './Button.vue';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const PrimaryInAlert: Story = {\\n render: (args) => ({\\n components: { Alert, Button },\\n setup() {\\n return { args };\\n },\\n template: '<Alert><Button v-bind=\\\"args\\\" /></Alert>',\\n }),\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n};\\n```\", \"```\\nimport html from 'lit';\\n\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const PrimaryInAlert = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n render: (args) => html`\\n <demo-alert>\\n Alert text\\n <demo-button ?primary=\\\"${args.primary}\\\" label=\\\"${args.label}\\\"></demo-button>\\n </demo-alert>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport html from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const PrimaryInAlert: Story = {\\n args: {\\n primary: true,\\n label: 'Button',\\n },\\n render: (args) => html`\\n <demo-alert>\\n Alert text\\n <demo-button ?primary=\\\"${args.primary}\\\" label=\\\"${args.label}\\\"></demo-button>\\n </demo-alert>\\n `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 321]\"}, {\"title\": \"Reuse Args Test\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { render, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('reuses args from composed story', () => {\\n render(<Primary />);\\n\\n const buttonElement = screen.getByRole('button');\\n // Testing against values coming from the story itself! No need for duplication\\n expect(buttonElement.textContent).toEqual(Primary.args.label);\\n});\\n```\", \"```\\nimport { render, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('reuses args from composed story', () => {\\n render(<Primary />);\\n\\n const buttonElement = screen.getByRole('button');\\n // Testing against values coming from the story itself! No need for duplication\\n expect(buttonElement.textContent).toEqual(Primary.args.label);\\n});\\n```\", \"```\\nimport { render, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('reuses args from composed story', () => {\\n render(Primary());\\n\\n const buttonElement = screen.getByRole('button');\\n // Testing against values coming from the story itself! No need for duplication\\n expect(buttonElement.textContent).toEqual(Primary.args.label);\\n});\\n```\", \"```\\nimport { render, screen } from '@testing-library/vue';\\n\\nimport { composeStories } from '@storybook/vue3-vite';\\n\\nimport * as stories from './Button.stories';\\n\\nconst { Primary } = composeStories(stories);\\n\\ntest('reuses args from composed story', () => {\\n render(Primary());\\n\\n const buttonElement = screen.getByRole('button');\\n // Testing against values coming from the story itself! No need for duplication\\n expect(buttonElement.textContent).toEqual(Primary.args.label);\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 322]\"}, {\"title\": \"Rsc Feature Flag\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n features: {\\n experimentalRSC: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n // ...\\n features: {\\n experimentalRSC: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 323]\"}, {\"title\": \"Rsc Parameter In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport MyServerComponent from './MyServerComponent';\\n\\nexport default {\\n component: MyServerComponent,\\n parameters: {\\n react: { rsc: false },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyServerComponent from './MyServerComponent';\\n\\nconst meta = {\\n component: MyServerComponent,\\n parameters: {\\n react: { rsc: false },\\n },\\n} satisfies Meta<typeof MyServerComponent>;\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 324]\"}, {\"title\": \"Seo Description\", \"description\": null, \"content\": {\"root\": [\"```\\n<meta name=\\\"description\\\" content=\\\"Components for my awesome project\\\" key=\\\"desc\\\" />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 325]\"}, {\"title\": \"Seo Noindex\", \"description\": null, \"content\": {\"root\": [\"```\\n<meta name=\\\"robots\\\" content=\\\"noindex\\\" />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 326]\"}, {\"title\": \"Shadow Dom Testing Library In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/web-components-vite';\\nimport { within as withinShadow } from 'shadow-dom-testing-library';\\n\\nconst preview: Preview = {\\n // \\ud83d\\udc47 Augment the canvas with the shadow DOM queries\\n beforeEach({ canvasElement, canvas }) {\\n Object.assign(canvas, { ...withinShadow(canvasElement) });\\n },\\n // ...\\n};\\n\\n// \\ud83d\\udc47 Extend TypeScript types for safety\\nexport type ShadowQueries = ReturnType<typeof withinShadow>;\\n\\n// Since Storybook@8.6\\ndeclare module 'storybook/internal/csf' {\\n interface Canvas extends ShadowQueries {}\\n}\\n\\nexport default preview;\\n```\", \"```\\nimport { within as withinShadow } from 'shadow-dom-testing-library';\\n\\nexport default {\\n // \\ud83d\\udc47 Augment the canvas with the shadow DOM queries\\n beforeEach({ canvasElement, canvas }) {\\n Object.assign(canvas, { ...withinShadow(canvasElement) });\\n },\\n // ...\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 327]\"}, {\"title\": \"Shadow Dom Testing Library In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const ShadowDOMExample: Story = {\\n async play({ canvas }) {\\n // \\ud83d\\udc47 Will find an element even if it's within a shadow root\\n const button = await canvas.findByShadowRole('button', { name: /Reset/i });\\n },\\n};\\n```\", \"```\\nexport const ShadowDOMExample = {\\n async play({ canvas }) {\\n // \\ud83d\\udc47 Will find an element even if it's within a shadow root\\n const button = await canvas.findByShadowRole('button', { name: /Reset/i });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 328]\"}, {\"title\": \"Simple Page Implementation\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { Component, Input } from '@angular/core';\\n\\n@Component({\\n selector: 'document-screen',\\n template: `\\n <page-layout [user]=\\\"user\\\">\\n <document-header [document]=\\\"document\\\"></document-header>\\n <document-list [documents]=\\\"subdocuments\\\"></document-list>\\n </page-layout>\\n `,\\n})\\nexport class DocumentScreen {\\n @Input()\\n user: any = { id: 0, name: 'Some User' };\\n\\n @Input()\\n document: any = { id: 0, title: 'Some Title' };\\n\\n @Input()\\n subdocuments: any = [];\\n}\\n```\", \"```\\nimport React from 'react';\\n\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nexport function DocumentScreen({ user, document, subdocuments }) {\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport PageLayout from './PageLayout';\\nimport Document from './Document';\\nimport SubDocuments from './SubDocuments';\\nimport DocumentHeader from './DocumentHeader';\\nimport DocumentList from './DocumentList';\\n\\nexport interface DocumentScreenProps {\\n user?: {};\\n document?: Document;\\n subdocuments?: SubDocuments[];\\n}\\n\\nexport function DocumentScreen({ user, document, subdocuments }: DocumentScreenProps) {\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport { PageLayout } from './PageLayout';\\nimport { DocumentHeader } from './DocumentHeader';\\nimport { DocumentList } from './DocumentList';\\n\\nexport function DocumentScreen({ user, document, subdocuments }) {\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\nimport PageLayout from './PageLayout';\\nimport Document from './Document';\\nimport SubDocuments from './SubDocuments';\\nimport DocumentHeader from './DocumentHeader';\\nimport DocumentList from './DocumentList';\\n\\nexport interface DocumentScreen {\\n user?: {};\\n document?: Document;\\n subdocuments?: SubDocuments[];\\n}\\n\\nfunction DocumentScreen({ user, document, subdocuments }) {\\n return (\\n <PageLayout user={user}>\\n <DocumentHeader document={document} />\\n <DocumentList documents={subdocuments} />\\n </PageLayout>\\n );\\n}\\n```\", \"```\\n<script>\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n export let user = {};\\n export let document = {};\\n export let subdocuments = [];\\n</script>\\n\\n<div>\\n <PageLayout {user}>\\n <DocumentHeader {document} />\\n <DocumentList documents=\\\"{subdocuments}\\\" />\\n </PageLayout>\\n</div>\\n```\", \"```\\n<script lang=\\\"ts\\\">\\n import PageLayout from './PageLayout.svelte';\\n import DocumentHeader from './DocumentHeader.svelte';\\n import DocumentList from './DocumentList.svelte';\\n\\n export let user: Record<string, unknown> = {};\\n export let document: Record<string, unknown> = {};\\n export let subdocuments: Record<string, unknown>[] = [];\\n</script>\\n\\n<div>\\n <PageLayout {user}>\\n <DocumentHeader {document} />\\n <DocumentList documents=\\\"{subdocuments}\\\" />\\n </PageLayout>\\n</div>\\n```\", \"```\\n<template>\\n <PageLayout :user=\\\"user\\\">\\n <DocumentHeader :document=\\\"document\\\" />\\n <DocumentList :documents=\\\"subdocuments\\\" />\\n </PageLayout>\\n</template>\\n\\n<script>\\n import PageLayout from './PageLayout';\\n import DocumentHeader from './DocumentHeader';\\n import DocumentList from './DocumentList';\\n import { reactive } from 'vue';\\n\\n export default {\\n name: 'DocumentScreen',\\n components: { PageLayout, DocumentHeader, DocumentList },\\n props: {\\n user: {\\n type: String,\\n default: 'N/A',\\n },\\n document: {\\n type: Object,\\n default: () => ({\\n id: 1,\\n title: 'A document',\\n content: 'Lorem Ipsum',\\n }),\\n },\\n subdocuments: {\\n type: Array,\\n default: () => [],\\n },\\n },\\n setup(props) {\\n props = reactive(props);\\n return {\\n /**\\n * What will be returned here will available to the component\\n * Functions referenced here will act like methods\\n */\\n };\\n },\\n };\\n</script>\\n```\", \"```\\nimport { LitElement, html } from 'lit-element';\\n\\nclass DocumentScreen extends LitElement {\\n static get properties() {\\n return {\\n data: { type: Object },\\n };\\n }\\n\\n constructor() {\\n super();\\n this.data = {};\\n }\\n\\n render() {\\n const { user, document, subdocuments } = this.data;\\n return html`\\n <demo-page-layout .user=${user}>\\n <demo-document-header .document=${document}></demo-document-header>\\n <demo-document-list .documents=${subdocuments}></demo-document-list>\\n </demo-page-layout>\\n `;\\n }\\n}\\n\\ncustomElements.define('demo-document-screen', DocumentScreen);\\n```\", \"```\\nimport { LitElement, html } from 'lit-element';\\n\\n@customElement('demo-document-screen')\\nclass DocumentScreen extends LitElement {\\n @property({ type: Object })\\n data: {\\n user: Record<string, unknown>;\\n document: Record<string, unknown>;\\n subdocuments: Array<Record<string, unknown>>;\\n } = {};\\n\\n constructor() {\\n super();\\n }\\n\\n render() {\\n const { user, document, subdocuments } = this.data;\\n return html`\\n <demo-page-layout .user=${user}>\\n <demo-document-header .document=${document}></demo-document-header>\\n <demo-document-list .documents=${subdocuments}></demo-document-list>\\n </demo-page-layout>\\n `;\\n }\\n}\\n\\ndeclare global {\\n interface HTMLElementTagNameMap {\\n 'demo-document-screen': DocumentScreen;\\n }\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 329]\"}, {\"title\": \"Single Story Test\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { fireEvent, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport Meta, { ValidForm as ValidFormStory } from './LoginForm.stories';\\n\\nconst ValidForm = composeStory(ValidFormStory, Meta);\\n\\ntest('Validates form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { composeStory } from '@storybook/your-framework';\\n\\nimport Meta, { ValidForm as ValidFormStory } from './LoginForm.stories';\\n\\nconst ValidForm = composeStory(ValidFormStory, Meta);\\n\\ntest('Validates form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/vue';\\n\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport Meta, { ValidForm as ValidFormStory } from './LoginForm.stories';\\n\\nconst ValidForm = composeStory(ValidFormStory, Meta);\\n\\ntest('Validates form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\", \"```\\nimport { fireEvent, screen } from '@testing-library/vue';\\n\\nimport { composeStory } from '@storybook/vue3-vite';\\n\\nimport Meta, { ValidForm as ValidFormStory } from './LoginForm.stories';\\n\\nconst ValidForm = composeStory(ValidFormStory, Meta);\\n\\ntest('Validates form', async () => {\\n await ValidForm.run();\\n\\n const buttonElement = screen.getByRole('button', {\\n name: 'Submit',\\n });\\n\\n fireEvent.click(buttonElement);\\n\\n const isFormValid = screen.getByLabelText('invalid-form');\\n expect(isFormValid).not.toBeInTheDocument();\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 330]\"}, {\"title\": \"Snapshot Tests Portable Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\nimport * as glob from 'glob';\\n\\nimport { describe, test, expect } from '@jest/globals';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}')\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n\\n return { filePath, storyFile, storyDir, componentName };\\n });\\n}\\n\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n const mounted = render(story());\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(mounted.container).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport path from 'path';\\nimport * as glob from 'glob';\\n\\nimport { describe, test, expect } from '@jest/globals';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (entry: StoryFile): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your stories files\\n const storyFiles = glob.sync(\\n path.join(process.cwd(), 'stories/**/*.{stories,story}.{js,jsx,mjs,ts,tsx}')\\n );\\n\\n return storyFiles.map((filePath) => {\\n const storyFile = require(filePath);\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n\\n return { filePath, storyFile, storyDir, componentName };\\n });\\n}\\n\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\nimport path from 'path';\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\nconst compose = (entry) => {\\n try {\\n return composeStories(entry);\\n } catch (error) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${error}`\\n );\\n }\\n};\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\", \"```\\n// @vitest-environment jsdom\\n\\n// Replace your-framework with one of the supported Storybook frameworks (react, vue3)\\nimport type { Meta, StoryFn } from '@storybook/your-framework';\\n\\nimport path from 'path';\\nimport { describe, expect, test } from 'vitest';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { composeStories } from '@storybook/your-framework';\\n\\ntype StoryFile = {\\n default: Meta;\\n [name: string]: StoryFn | Meta;\\n};\\n\\nconst compose = (entry: StoryFile): ReturnType<typeof composeStories<StoryFile>> => {\\n try {\\n return composeStories(entry);\\n } catch (e) {\\n throw new Error(\\n `There was an issue composing stories for the module: ${JSON.stringify(entry)}, ${e}`\\n );\\n }\\n};\\n\\nfunction getAllStoryFiles() {\\n // Place the glob you want to match your story files\\n const storyFiles = Object.entries(\\n import.meta.glob<StoryFile>('./stories/**/*.(stories|story).@(js|jsx|mjs|ts|tsx)', {\\n eager: true,\\n })\\n );\\n\\n return storyFiles.map(([filePath, storyFile]) => {\\n const storyDir = path.dirname(filePath);\\n const componentName = path.basename(filePath).replace(/\\\\.(stories|story)\\\\.[^/.]+$/, '');\\n return { filePath, storyFile, componentName, storyDir };\\n });\\n}\\n\\ndescribe('Stories Snapshots', () => {\\n getAllStoryFiles().forEach(({ storyFile, componentName }) => {\\n const meta = storyFile.default;\\n const title = meta.title || componentName;\\n\\n describe(title, () => {\\n const stories = Object.entries(compose(storyFile)).map(([name, story]) => ({ name, story }));\\n\\n if (stories.length <= 0) {\\n throw new Error(\\n `No stories found for this module: ${title}. Make sure there is at least one valid story for this module.`\\n );\\n }\\n\\n stories.forEach(({ name, story }) => {\\n test(name, async () => {\\n await story.run();\\n // Ensures a consistent snapshot by waiting for the component to render by adding a delay of 1 ms before taking the snapshot.\\n await new Promise((resolve) => setTimeout(resolve, 1));\\n expect(document.body.firstChild).toMatchSnapshot();\\n });\\n });\\n });\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 331]\"}, {\"title\": \"Storybook Add Command\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-a11y\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-a11y\\n```\", \"```\\nyarn dlx storybook@latest add @storybook/addon-a11y\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 332]\"}, {\"title\": \"Storybook Addon A11Y Test Setup\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport { setProjectAnnotations } from '@storybook/your-framework';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\", \"```\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\", \"```\\nimport { setProjectAnnotations } from '@storybook/vue3-vite';\\n\\n// Import the a11y addon annotations\\nimport * as a11yAddonAnnotations from '@storybook/addon-a11y/preview';\\n\\n// Optionally import your own annotations\\nimport * as projectAnnotations from './preview';\\n\\nsetProjectAnnotations([\\n // Add the a11y addon annotations\\n a11yAddonAnnotations,\\n projectAnnotations,\\n]);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 333]\"}, {\"title\": \"Storybook Addon Compiler Babel Auto Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-webpack5-compiler-babel\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-webpack5-compiler-babel\\n```\", \"```\\nyarn dlx storybook@latest add @storybook/addon-webpack5-compiler-babel\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 334]\"}, {\"title\": \"Storybook Addon Compiler Swc Auto Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-webpack5-compiler-swc\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-webpack5-compiler-swc\\n```\", \"```\\nyarn dlx storybook@latest add @storybook/addon-webpack5-compiler-swc\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 335]\"}, {\"title\": \"Storybook Addon Controls Custom Matchers\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 336]\"}, {\"title\": \"Storybook Addon Css Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { dedent } from 'ts-dedent';\\n\\nexport default function outlineCSS(selector: string) {\\n return dedent/* css */ `\\n ${selector} body {\\n outline: 1px solid #2980b9 !important;\\n }\\n\\n ${selector} article {\\n outline: 1px solid #3498db !important;\\n }\\n\\n ${selector} nav {\\n outline: 1px solid #0088c3 !important;\\n }\\n\\n ${selector} aside {\\n outline: 1px solid #33a0ce !important;\\n }\\n\\n ${selector} section {\\n outline: 1px solid #66b8da !important;\\n }\\n\\n ${selector} header {\\n outline: 1px solid #99cfe7 !important;\\n }\\n\\n ${selector} footer {\\n outline: 1px solid #cce7f3 !important;\\n }\\n\\n ${selector} h1 {\\n outline: 1px solid #162544 !important;\\n }\\n\\n ${selector} h2 {\\n outline: 1px solid #314e6e !important;\\n }\\n\\n ${selector} h3 {\\n outline: 1px solid #3e5e85 !important;\\n }\\n\\n ${selector} h4 {\\n outline: 1px solid #449baf !important;\\n }\\n\\n ${selector} h5 {\\n outline: 1px solid #c7d1cb !important;\\n }\\n\\n ${selector} h6 {\\n outline: 1px solid #4371d0 !important;\\n }\\n\\n ${selector} main {\\n outline: 1px solid #2f4f90 !important;\\n }\\n\\n ${selector} address {\\n outline: 1px solid #1a2c51 !important;\\n }\\n\\n ${selector} div {\\n outline: 1px solid #036cdb !important;\\n }\\n\\n ${selector} p {\\n outline: 1px solid #ac050b !important;\\n }\\n\\n ${selector} hr {\\n outline: 1px solid #ff063f !important;\\n }\\n\\n ${selector} pre {\\n outline: 1px solid #850440 !important;\\n }\\n\\n ${selector} blockquote {\\n outline: 1px solid #f1b8e7 !important;\\n }\\n\\n ${selector} ol {\\n outline: 1px solid #ff050c !important;\\n }\\n\\n ${selector} ul {\\n outline: 1px solid #d90416 !important;\\n }\\n\\n ${selector} li {\\n outline: 1px solid #d90416 !important;\\n }\\n\\n ${selector} dl {\\n outline: 1px solid #fd3427 !important;\\n }\\n\\n ${selector} dt {\\n outline: 1px solid #ff0043 !important;\\n }\\n\\n ${selector} dd {\\n outline: 1px solid #e80174 !important;\\n }\\n\\n ${selector} figure {\\n outline: 1px solid #ff00bb !important;\\n }\\n\\n ${selector} figcaption {\\n outline: 1px solid #bf0032 !important;\\n }\\n\\n ${selector} table {\\n outline: 1px solid #00cc99 !important;\\n }\\n\\n ${selector} caption {\\n outline: 1px solid #37ffc4 !important;\\n }\\n\\n ${selector} thead {\\n outline: 1px solid #98daca !important;\\n }\\n\\n ${selector} tbody {\\n outline: 1px solid #64a7a0 !important;\\n }\\n\\n ${selector} tfoot {\\n outline: 1px solid #22746b !important;\\n }\\n\\n ${selector} tr {\\n outline: 1px solid #86c0b2 !important;\\n }\\n\\n ${selector} th {\\n outline: 1px solid #a1e7d6 !important;\\n }\\n\\n ${selector} td {\\n outline: 1px solid #3f5a54 !important;\\n }\\n\\n ${selector} col {\\n outline: 1px solid #6c9a8f !important;\\n }\\n\\n ${selector} colgroup {\\n outline: 1px solid #6c9a9d !important;\\n }\\n\\n ${selector} button {\\n outline: 1px solid #da8301 !important;\\n }\\n\\n ${selector} datalist {\\n outline: 1px solid #c06000 !important;\\n }\\n\\n ${selector} fieldset {\\n outline: 1px solid #d95100 !important;\\n }\\n\\n ${selector} form {\\n outline: 1px solid #d23600 !important;\\n }\\n\\n ${selector} input {\\n outline: 1px solid #fca600 !important;\\n }\\n\\n ${selector} keygen {\\n outline: 1px solid #b31e00 !important;\\n }\\n\\n ${selector} label {\\n outline: 1px solid #ee8900 !important;\\n }\\n\\n ${selector} legend {\\n outline: 1px solid #de6d00 !important;\\n }\\n\\n ${selector} meter {\\n outline: 1px solid #e8630c !important;\\n }\\n\\n ${selector} optgroup {\\n outline: 1px solid #b33600 !important;\\n }\\n\\n ${selector} option {\\n outline: 1px solid #ff8a00 !important;\\n }\\n\\n ${selector} output {\\n outline: 1px solid #ff9619 !important;\\n }\\n\\n ${selector} progress {\\n outline: 1px solid #e57c00 !important;\\n }\\n\\n ${selector} select {\\n outline: 1px solid #e26e0f !important;\\n }\\n\\n ${selector} textarea {\\n outline: 1px solid #cc5400 !important;\\n }\\n\\n ${selector} details {\\n outline: 1px solid #33848f !important;\\n }\\n\\n ${selector} summary {\\n outline: 1px solid #60a1a6 !important;\\n }\\n\\n ${selector} command {\\n outline: 1px solid #438da1 !important;\\n }\\n\\n ${selector} menu {\\n outline: 1px solid #449da6 !important;\\n }\\n\\n ${selector} del {\\n outline: 1px solid #bf0000 !important;\\n }\\n\\n ${selector} ins {\\n outline: 1px solid #400000 !important;\\n }\\n\\n ${selector} img {\\n outline: 1px solid #22746b !important;\\n }\\n\\n ${selector} iframe {\\n outline: 1px solid #64a7a0 !important;\\n }\\n\\n ${selector} embed {\\n outline: 1px solid #98daca !important;\\n }\\n\\n ${selector} object {\\n outline: 1px solid #00cc99 !important;\\n }\\n\\n ${selector} param {\\n outline: 1px solid #37ffc4 !important;\\n }\\n\\n ${selector} video {\\n outline: 1px solid #6ee866 !important;\\n }\\n\\n ${selector} audio {\\n outline: 1px solid #027353 !important;\\n }\\n\\n ${selector} source {\\n outline: 1px solid #012426 !important;\\n }\\n\\n ${selector} canvas {\\n outline: 1px solid #a2f570 !important;\\n }\\n\\n ${selector} track {\\n outline: 1px solid #59a600 !important;\\n }\\n\\n ${selector} map {\\n outline: 1px solid #7be500 !important;\\n }\\n\\n ${selector} area {\\n outline: 1px solid #305900 !important;\\n }\\n\\n ${selector} a {\\n outline: 1px solid #ff62ab !important;\\n }\\n\\n ${selector} em {\\n outline: 1px solid #800b41 !important;\\n }\\n\\n ${selector} strong {\\n outline: 1px solid #ff1583 !important;\\n }\\n\\n ${selector} i {\\n outline: 1px solid #803156 !important;\\n }\\n\\n ${selector} b {\\n outline: 1px solid #cc1169 !important;\\n }\\n\\n ${selector} u {\\n outline: 1px solid #ff0430 !important;\\n }\\n\\n ${selector} s {\\n outline: 1px solid #f805e3 !important;\\n }\\n\\n ${selector} small {\\n outline: 1px solid #d107b2 !important;\\n }\\n\\n ${selector} abbr {\\n outline: 1px solid #4a0263 !important;\\n }\\n\\n ${selector} q {\\n outline: 1px solid #240018 !important;\\n }\\n\\n ${selector} cite {\\n outline: 1px solid #64003c !important;\\n }\\n\\n ${selector} dfn {\\n outline: 1px solid #b4005a !important;\\n }\\n\\n ${selector} sub {\\n outline: 1px solid #dba0c8 !important;\\n }\\n\\n ${selector} sup {\\n outline: 1px solid #cc0256 !important;\\n }\\n\\n ${selector} time {\\n outline: 1px solid #d6606d !important;\\n }\\n\\n ${selector} code {\\n outline: 1px solid #e04251 !important;\\n }\\n\\n ${selector} kbd {\\n outline: 1px solid #5e001f !important;\\n }\\n\\n ${selector} samp {\\n outline: 1px solid #9c0033 !important;\\n }\\n\\n ${selector} var {\\n outline: 1px solid #d90047 !important;\\n }\\n\\n ${selector} mark {\\n outline: 1px solid #ff0053 !important;\\n }\\n\\n ${selector} bdi {\\n outline: 1px solid #bf3668 !important;\\n }\\n\\n ${selector} bdo {\\n outline: 1px solid #6f1400 !important;\\n }\\n\\n ${selector} ruby {\\n outline: 1px solid #ff7b93 !important;\\n }\\n\\n ${selector} rt {\\n outline: 1px solid #ff2f54 !important;\\n }\\n\\n ${selector} rp {\\n outline: 1px solid #803e49 !important;\\n }\\n\\n ${selector} span {\\n outline: 1px solid #cc2643 !important;\\n }\\n\\n ${selector} br {\\n outline: 1px solid #db687d !important;\\n }\\n\\n ${selector} wbr {\\n outline: 1px solid #db175b !important;\\n }`;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 337]\"}, {\"title\": \"Storybook Addon Css Helpers\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { global } from '@storybook/global';\\n\\nexport const clearStyles = (selector: string | string[]) => {\\n const selectors = Array.isArray(selector) ? selector : [selector];\\n selectors.forEach(clearStyle);\\n};\\n\\nconst clearStyle = (input: string | string[]) => {\\n const selector = typeof input === 'string' ? input : input.join('');\\n const element = global.document.getElementById(selector);\\n if (element && element.parentElement) {\\n element.parentElement.removeChild(element);\\n }\\n};\\n\\nexport const addOutlineStyles = (selector: string, css: string) => {\\n const existingStyle = global.document.getElementById(selector);\\n if (existingStyle) {\\n if (existingStyle.innerHTML !== css) {\\n existingStyle.innerHTML = css;\\n }\\n } else {\\n const style = global.document.createElement('style');\\n style.setAttribute('id', selector);\\n style.innerHTML = css;\\n global.document.head.appendChild(style);\\n }\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 338]\"}, {\"title\": \"Storybook Addon Disable Addon\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register(ADDON_ID, () => {\\n addons.add(PANEL_ID, {\\n type: types.PANEL,\\n title: 'My Addon',\\n render: () => <div>Addon tab content</div>,\\n paramKey: 'myAddon', // this element\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 339]\"}, {\"title\": \"Storybook Addon Load External Addons Preset\", \"description\": null, \"content\": {\"root\": [\"```\\nfunction managerEntries(entry = []) {\\n return [...entry, import.meta.resolve('my-other-addon/manager')];\\n}\\n\\nconst previewAnnotations = (entry = [], options) => {\\n return [...entry, import.meta.resolve('my-other-addon/preview')];\\n};\\n\\nexport default {\\n managerEntries,\\n previewAnnotations,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 340]\"}, {\"title\": \"Storybook Addon Manager Initial State\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons, types } from 'storybook/manager-api';\\nimport { ADDON_ID, TOOL_ID } from './constants';\\nimport { Tool } from './Tool';\\n\\n// Register the addon\\naddons.register(ADDON_ID, () => {\\n // Register the tool\\n addons.add(TOOL_ID, {\\n type: types.TOOL,\\n title: 'My addon',\\n match: ({ tabId, viewMode }) => !tabId && viewMode === 'story',\\n render: Tool,\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 341]\"}, {\"title\": \"Storybook Addon Panel Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { AddonPanel } from 'storybook/internal/components';\\n\\nimport { useGlobals, addons, types } from 'storybook/manager-api';\\n\\naddons.register('my/panel', () => {\\n addons.add('my-panel-addon/panel', {\\n title: 'Example Storybook panel',\\n //\\ud83d\\udc47 Sets the type of UI element in Storybook\\n type: types.PANEL,\\n render: ({ active }) => (\\n <AddonPanel active={active}>\\n <h2>I'm a panel addon in Storybook</h2>\\n </AddonPanel>\\n ),\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 342]\"}, {\"title\": \"Storybook Addon Panel Initial\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { addons, types } from 'storybook/manager-api';\\n\\nimport { AddonPanel } from 'storybook/internal/components';\\n\\nconst ADDON_ID = 'myaddon';\\nconst PANEL_ID = `${ADDON_ID}/panel`;\\n\\naddons.register(ADDON_ID, (api) => {\\n addons.add(PANEL_ID, {\\n type: types.PANEL,\\n title: 'My Addon',\\n render: ({ active }) => (\\n <AddonPanel active={active}>\\n <div> Storybook addon panel </div>\\n </AddonPanel>\\n ),\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 343]\"}, {\"title\": \"Storybook Addon Preset Example\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function previewAnnotations(entry = []) {\\n return [...entry, import.meta.resolve('./defaultParameters')];\\n}\\n\\nexport function managerEntries(entries) {\\n return [...entries, import.meta.resolve('./register')];\\n}\\n\\nexport default {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'light', value: '#F8F8F8' },\\n { name: 'dark', value: '#333333' },\\n ],\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 344]\"}, {\"title\": \"Storybook Addon Release\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run release\\n```\", \"```\\npnpm run release\\n```\", \"```\\nyarn release\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 345]\"}, {\"title\": \"Storybook Addon Run Dev Mode\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run start\\n```\", \"```\\npnpm run start\\n```\", \"```\\nyarn start\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 346]\"}, {\"title\": \"Storybook Addon Tab Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { addons, types } from 'storybook/manager-api';\\n\\naddons.register('my-addon', () => {\\n addons.add('my-addon/tab', {\\n type: types.TAB,\\n title: 'Example Storybook tab',\\n render: () => (\\n <div>\\n <h2>I'm a tabbed addon in Storybook</h2>\\n </div>\\n ),\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 347]\"}, {\"title\": \"Storybook Addon Themes Classname Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { withThemeByClassName } from '@storybook/addon-themes';\\n\\nimport '../src/index.css'; // Your application's global CSS file\\n\\nconst preview = {\\n decorators: [\\n withThemeByClassName({\\n themes: {\\n light: '',\\n dark: 'dark',\\n },\\n defaultTheme: 'light',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { Preview, Renderer } from '@storybook/your-framework';\\n\\nimport { withThemeByClassName } from '@storybook/addon-themes';\\n\\nimport '../src/index.css'; // Your application's global CSS file\\n\\nconst preview: Preview = {\\n decorators: [\\n withThemeByClassName<Renderer>({\\n themes: {\\n light: '',\\n dark: 'dark',\\n },\\n defaultTheme: 'light',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 348]\"}, {\"title\": \"Storybook Addon Themes Data Attribute Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { withThemeByDataAttribute } from '@storybook/addon-themes';\\n\\nimport '../src/index.css'; // Your application's global CSS file\\n\\nconst preview = {\\n decorators: [\\n withThemeByDataAttribute({\\n themes: {\\n light: 'light',\\n dark: 'dark',\\n },\\n defaultTheme: 'light',\\n attributeName: 'data-theme',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { Preview, Renderer } from '@storybook/your-framework';\\n\\nimport { withThemeByDataAttribute } from '@storybook/addon-themes';\\n\\nimport '../src/index.css'; // Your application's global CSS file\\n\\nconst preview: Preview = {\\n decorators: [\\n withThemeByDataAttribute<Renderer>({\\n themes: {\\n light: 'light',\\n dark: 'dark',\\n },\\n defaultTheme: 'light',\\n attributeName: 'data-theme',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 349]\"}, {\"title\": \"Storybook Addon Themes Jsx Provider Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { withThemeFromJSXProvider } from '@storybook/addon-themes';\\n\\nimport { createGlobalStyle, ThemeProvider } from 'styled-components';\\nimport { lightTheme, darkTheme } from '../src/themes';\\n\\nconst GlobalStyles = createGlobalStyle`\\n body {\\n font-family: \\\"Nunito Sans\\\", \\\"Helvetica Neue\\\", Helvetica, Arial, sans-serif;\\n }\\n`;\\n\\nconst preview = {\\n decorators: [\\n withThemeFromJSXProvider({\\n themes: {\\n light: lightTheme,\\n dark: darkTheme,\\n },\\n defaultTheme: 'light',\\n Provider: ThemeProvider,\\n GlobalStyles,\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport { Preview, Renderer } from '@storybook/your-framework';\\n\\nimport { withThemeFromJSXProvider } from '@storybook/addon-themes';\\n\\nimport { createGlobalStyle, ThemeProvider } from 'styled-components';\\nimport { lightTheme, darkTheme } from '../src/themes';\\n\\nconst GlobalStyles = createGlobalStyle`\\n body {\\n font-family: \\\"Nunito Sans\\\", \\\"Helvetica Neue\\\", Helvetica, Arial, sans-serif;\\n }\\n`;\\n\\nconst preview: Preview = {\\n decorators: [\\n withThemeFromJSXProvider<Renderer>({\\n themes: {\\n light: lightTheme,\\n dark: darkTheme,\\n },\\n defaultTheme: 'light',\\n Provider: ThemeProvider,\\n GlobalStyles,\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 350]\"}, {\"title\": \"Storybook Addon Tool Initial Setup\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React, { memo, useCallback, useEffect } from 'react';\\n\\nimport { useGlobals, useStorybookApi } from 'storybook/manager-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { LightningIcon } from '@storybook/icons';\\n\\nimport { ADDON_ID, PARAM_KEY, TOOL_ID } from './constants';\\n\\nexport const Tool = memo(function MyAddonSelector() {\\n const [globals, updateGlobals] = useGlobals();\\n const api = useStorybookApi();\\n\\n const isActive = [true, 'true'].includes(globals[PARAM_KEY]);\\n\\n const toggleMyTool = useCallback(() => {\\n updateGlobals({\\n [PARAM_KEY]: !isActive,\\n });\\n }, [isActive]);\\n\\n useEffect(() => {\\n api.setAddonShortcut(ADDON_ID, {\\n label: 'Toggle Addon [8]',\\n defaultShortcut: ['8'],\\n actionName: 'myaddon',\\n showInMenu: false,\\n action: toggleMyTool,\\n });\\n }, [toggleMyTool, api]);\\n\\n return (\\n <IconButton key={TOOL_ID} active={isActive} title=\\\"Enable my addon\\\" onClick={toggleMyTool}>\\n <LightningIcon />\\n </IconButton>\\n );\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 351]\"}, {\"title\": \"Storybook Addon Toolbar Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { addons, types } from 'storybook/manager-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { OutlineIcon } from '@storybook/icons';\\n\\naddons.register('my-addon', () => {\\n addons.add('my-addon/toolbar', {\\n title: 'Example Storybook toolbar',\\n //\\ud83d\\udc47 Sets the type of UI element in Storybook\\n type: types.TOOL,\\n //\\ud83d\\udc47 Shows the Toolbar UI element if the story canvas is being viewed\\n match: ({ tabId, viewMode }) => !tabId && viewMode === 'story',\\n render: ({ active }) => (\\n <IconButton active={active} title=\\\"Show a Storybook toolbar\\\">\\n <OutlineIcon />\\n </IconButton>\\n ),\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 352]\"}, {\"title\": \"Storybook Addon Toolkit Types\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React, { memo, useCallback, useEffect } from 'react';\\n\\nimport { useGlobals, useStorybookApi } from 'storybook/manager-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { LightningIcon } from '@storybook/icons';\\n\\nimport { ADDON_ID, PARAM_KEY, TOOL_ID } from './constants';\\n\\nexport const Tool = memo(function MyAddonSelector() {\\n const [globals, updateGlobals] = useGlobals();\\n const api = useStorybookApi();\\n\\n const isActive = [true, 'true'].includes(globals[PARAM_KEY]);\\n\\n const toggleMyTool = useCallback(() => {\\n updateGlobals({\\n [PARAM_KEY]: !isActive,\\n });\\n }, [isActive]);\\n\\n useEffect(() => {\\n api.setAddonShortcut(ADDON_ID, {\\n label: 'Toggle Measure [O]',\\n defaultShortcut: ['O'],\\n actionName: 'outline',\\n showInMenu: false,\\n action: toggleMyTool,\\n });\\n }, [toggleMyTool, api]);\\n\\n return (\\n <IconButton key={TOOL_ID} active={isActive} title=\\\"Enable my addon\\\" onClick={toggleMyTool}>\\n <LightningIcon />\\n </IconButton>\\n );\\n});\\n```\", \"```\\nimport React from 'react';\\n\\nimport { useAddonState, useChannel } from 'storybook/manager-api';\\nimport { AddonPanel } from 'storybook/internal/components';\\n\\nimport { ADDON_ID, EVENTS } from './constants';\\n\\n// See https://github.com/storybookjs/addon-kit/blob/main/src/components/PanelContent.tsx for an example of a PanelContent component\\nimport { PanelContent } from './components/PanelContent';\\n\\ninterface PanelProps {\\n active: boolean;\\n}\\n\\nexport const Panel: React.FC<PanelProps> = (props) => {\\n // https://storybook.js.org/docs/addons/addons-api#useaddonstate\\n const [results, setState] = useAddonState(ADDON_ID, {\\n danger: [],\\n warning: [],\\n });\\n\\n // https://storybook.js.org/docs/addons/addons-api#usechannel\\n const emit = useChannel({\\n [EVENTS.RESULT]: (newResults) => setState(newResults),\\n });\\n\\n return (\\n <AddonPanel {...props}>\\n <PanelContent\\n results={results}\\n fetchData={() => {\\n emit(EVENTS.REQUEST);\\n }}\\n clearData={() => {\\n emit(EVENTS.CLEAR);\\n }}\\n />\\n </AddonPanel>\\n );\\n};\\n```\", \"```\\nimport React from 'react';\\n\\nimport { useParameter } from 'storybook/manager-api';\\n\\nimport { PARAM_KEY } from './constants';\\n\\n// See https://github.com/storybookjs/addon-kit/blob/main/src/components/TabContent.tsx for an example of a TabContent component\\nimport { TabContent } from './components/TabContent';\\n\\ninterface TabProps {\\n active: boolean;\\n}\\n\\nexport const Tab: React.FC<TabProps> = ({ active }) => {\\n // https://storybook.js.org/docs/addons/addons-api#useparameter\\n const paramData = useParameter<string>(PARAM_KEY, '');\\n\\n return active ? <TabContent code={paramData} /> : null;\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 353]\"}, {\"title\": \"Storybook Addon Use Global\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type {\\n Renderer,\\n PartialStoryFn as StoryFunction,\\n StoryContext,\\n} from 'storybook/internal/types';\\n\\nimport { useEffect, useMemo, useGlobals } from 'storybook/preview-api';\\nimport { PARAM_KEY } from './constants';\\n\\nimport { clearStyles, addOutlineStyles } from './helpers';\\n\\nimport outlineCSS from './outlineCSS';\\n\\nexport const withGlobals = (StoryFn: StoryFunction<Renderer>, context: StoryContext<Renderer>) => {\\n const [globals] = useGlobals();\\n\\n const isActive = [true, 'true'].includes(globals[PARAM_KEY]);\\n\\n // Is the addon being used in the docs panel\\n const isInDocs = context.viewMode === 'docs';\\n\\n const outlineStyles = useMemo(() => {\\n const selector = isInDocs ? `#anchor--${context.id} .docs-story` : '.sb-show-main';\\n\\n return outlineCSS(selector);\\n }, [context.id]);\\n useEffect(() => {\\n const selectorId = isInDocs ? `my-addon-docs-${context.id}` : `my-addon`;\\n\\n if (!isActive) {\\n clearStyles(selectorId);\\n return;\\n }\\n\\n addOutlineStyles(selectorId, outlineStyles);\\n\\n return () => {\\n clearStyles(selectorId);\\n };\\n }, [isActive, outlineStyles, context.id]);\\n\\n return StoryFn();\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 354]\"}, {\"title\": \"Storybook Addons Api Disablequeryparams\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n api.setQueryParams({\\n exampleParameter: null,\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 355]\"}, {\"title\": \"Storybook Addons Api Getchannel\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React, { useCallback } from 'react';\\nimport { OutlineIcon } from '@storybook/icons';\\nimport { useGlobals } from 'storybook/manager-api';\\nimport { addons } from 'storybook/preview-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { FORCE_RE_RENDER } from 'storybook/internal/core-events';\\n\\nconst ExampleToolbar = () => {\\n const [globals, updateGlobals] = useGlobals();\\n\\n const isActive = globals['my-param-key'] || false;\\n\\n // Function that will update the global value and trigger a UI refresh.\\n const refreshAndUpdateGlobal = () => {\\n updateGlobals({\\n ['my-param-key']: !isActive,\\n }),\\n // Invokes Storybook's addon API method (with the FORCE_RE_RENDER) event to trigger a UI refresh\\n addons.getChannel().emit(FORCE_RE_RENDER);\\n };\\n\\n const toggleToolbarAddon = useCallback(() => refreshAndUpdateGlobal(), [isActive]);\\n\\n return (\\n <IconButton\\n key=\\\"Example\\\"\\n active={isActive}\\n title=\\\"Show the toolbar addon\\\"\\n onClick={toggleToolbarAddon}\\n >\\n <OutlineIcon />\\n </IconButton>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 356]\"}, {\"title\": \"Storybook Addons Api Getqueryparam\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n api.getQueryParam('exampleParameter');\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 357]\"}, {\"title\": \"Storybook Addons Api Geturlstate\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n const href = api.getUrlState({\\n selectedKind: 'kind',\\n selectedStory: 'story',\\n }).url;\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 358]\"}, {\"title\": \"Storybook Addons Api Imports\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/preview-api';\\n\\nimport { useStorybookApi } from 'storybook/manager-api';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 359]\"}, {\"title\": \"Storybook Addons Api Makedecorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { makeDecorator } from 'storybook/preview-api';\\n\\nexport const withAddonDecorator = makeDecorator({\\n name: 'withSomething',\\n parameterName: 'CustomParameter',\\n skipIfNoParametersOrOptions: true,\\n wrapper: (getStory, context, { parameters }) => {\\n /*\\n * Write your custom logic here based on the parameters passed in Storybook's stories.\\n * Although not advised, you can also alter the story output based on the parameters.\\n */\\n return getStory(context);\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 360]\"}, {\"title\": \"Storybook Addons Api On\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n // Logs the event data to the browser console whenever the event is emitted.\\n api.on('custom-addon-event', (eventData) => console.log(eventData));\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 361]\"}, {\"title\": \"Storybook Addons Api Register\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/preview-api';\\n\\n// Register the addon with a unique name.\\naddons.register('my-organisation/my-addon', (api) => {});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 362]\"}, {\"title\": \"Storybook Addons Api Selectincurrentkind\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n api.selectInCurrentKind('Default');\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 363]\"}, {\"title\": \"Storybook Addons Api Selectstory\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n api.selectStory('Button', 'Default');\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 364]\"}, {\"title\": \"Storybook Addons Api Setqueryparams\", \"description\": null, \"content\": {\"root\": [\"```\\naddons.register('my-organisation/my-addon', (api) => {\\n api.setQueryParams({\\n exampleParameter: 'Sets the example parameter value',\\n anotherParameter: 'Sets the another parameter value',\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 365]\"}, {\"title\": \"Storybook Addons Api Useaddonstate\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { useAddonState } from 'storybook/manager-api';\\nimport { AddonPanel, IconButton } from 'storybook/internal/components';\\nimport { LightningIcon } from '@storybook/icons';\\n\\nexport const Panel = () => {\\n const [state, setState] = useAddonState('addon-unique-identifier', 'initial state');\\n\\n return (\\n <AddonPanel key=\\\"custom-panel\\\" active=\\\"true\\\">\\n <Button onClick={() => setState('Example')}>\\n Click to update Storybook's internal state\\n </Button>\\n </AddonPanel>\\n );\\n};\\nexport const Tool = () => {\\n const [state, setState] = useAddonState('addon-unique-identifier', 'initial state');\\n\\n return (\\n <IconButton\\n key=\\\"custom-toolbar\\\"\\n active=\\\"true\\\"\\n title=\\\"Enable my addon\\\"\\n onClick={() => setState('Example')}\\n >\\n <LightningIcon />\\n </IconButton>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 366]\"}, {\"title\": \"Storybook Addons Api Useapi\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React, { useEffect, useCallback } from 'react';\\n\\nimport { useStorybookApi } from 'storybook/manager-api';\\nimport { IconButton } from 'storybook/internal/components';\\nimport { ChevronDownIcon } from '@storybook/icons';\\n\\nexport const Panel = () => {\\n const api = useStorybookApi();\\n\\n const toggleMyTool = useCallback(() => {\\n // Custom logic to toggle the addon here\\n }, []);\\n\\n useEffect(() => {\\n api.setAddonShortcut('custom-toolbar-addon', {\\n label: 'Enable toolbar addon',\\n defaultShortcut: ['G'],\\n actionName: 'Toggle',\\n showInMenu: false,\\n action: toggleAddon,\\n });\\n }, [api]);\\n\\n return (\\n <IconButton key=\\\"custom-toolbar\\\" active=\\\"true\\\" title=\\\"Show a toolbar addon\\\">\\n <ChevronDownIcon />\\n </IconButton>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 367]\"}, {\"title\": \"Storybook Addons Api Usechannel\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\nimport { useChannel } from 'storybook/manager-api';\\nimport { AddonPanel, Button } from 'storybook/internal/components';\\nimport { STORY_CHANGED } from 'storybook/internal/core-events';\\n\\nexport const Panel = () => {\\n // Creates a Storybook API channel and subscribes to the STORY_CHANGED event\\n const emit = useChannel({\\n STORY_CHANGED: (...args) => console.log(...args),\\n });\\n\\n return (\\n <AddonPanel key=\\\"custom-panel\\\" active=\\\"true\\\">\\n <Button onClick={() => emit('my-event-type', { sampleData: 'example' })}>\\n Emit a Storybook API event with custom data\\n </Button>\\n </AddonPanel>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 368]\"}, {\"title\": \"Storybook Addons Api Useglobal\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { AddonPanel, Button } from 'storybook/internal/components';\\n\\nimport { useGlobals } from 'storybook/manager-api';\\n\\nexport const Panel = () => {\\n const [globals, updateGlobals] = useGlobals();\\n\\n const isActive = globals['my-param-key'] || false; // \\ud83d\\udc48 Sets visibility based on the global value.\\n\\n return (\\n <AddonPanel key=\\\"custom-panel\\\" active={isActive}>\\n <Button onClick={() => updateGlobals({ ['my-param-key']: !isActive })}>\\n {isActive ? 'Hide the addon panel' : 'Show the panel'}\\n </Button>\\n </AddonPanel>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 369]\"}, {\"title\": \"Storybook Addons Api Useparameter\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { AddonPanel } from 'storybook/internal/components';\\n\\nimport { useParameter } from 'storybook/manager-api';\\n\\nexport const Panel = () => {\\n // Connects to Storybook's API and retrieves the value of the custom parameter for the current story\\n const value = useParameter('custom-parameter', 'initial value');\\n\\n return (\\n <AddonPanel key=\\\"custom-panel\\\" active=\\\"true\\\">\\n {value === 'initial value' ? (\\n <h2>The story doesn't contain custom parameters. Defaulting to the initial value.</h2>\\n ) : (\\n <h2>You've set {value} as the parameter.</h2>\\n )}\\n </AddonPanel>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 370]\"}, {\"title\": \"Storybook Addons Api Usestorybookstate\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\n\\nimport { AddonPanel } from 'storybook/internal/components';\\n\\nimport { useStorybookState } from 'storybook/manager-api';\\n\\nexport const Panel = () => {\\n const state = useStorybookState();\\n return (\\n <AddonPanel {...props}>\\n {state.viewMode !== 'docs' ? (\\n <h2>Do something with the documentation</h2>\\n ) : (\\n <h2>Show the panel when viewing the story</h2>\\n )}\\n </AddonPanel>\\n );\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 371]\"}, {\"title\": \"Storybook Addons Local Preset\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { webpackFinal as webpack } from './webpack/webpackFinal';\\nimport { viteFinal as vite } from './vite/viteFinal';\\nimport { babelDefault as babel } from './babel/babelDefault';\\n\\nexport const webpackFinal = webpack;\\nexport const viteFinal = vite;\\nexport const babelDefault = babel;\\n```\", \"```\\nimport { webpackFinal as webpack } from './webpack/webpackFinal';\\n\\nimport { viteFinal as vite } from './vite/viteFinal';\\n\\nimport { babelDefault as babel } from './babel/babelDefault';\\n\\nexport const webpackFinal = webpack as any;\\n\\nexport const viteFinal = vite as any;\\n\\nexport const babelDefault = babel as any;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 372]\"}, {\"title\": \"Storybook Addons Preset Babeldefault\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function babelDefault(config) {\\n return {\\n ...config,\\n plugins: [\\n ...config.plugins,\\n [import.meta.resolve('@babel/plugin-transform-react-jsx'), {}, 'preset'],\\n ],\\n };\\n}\\n```\", \"```\\nimport { TransformOptions } from '@babel/core';\\n\\nexport function babelDefault(config: TransformOptions) {\\n return {\\n ...config,\\n plugins: [\\n ...config.plugins,\\n [import.meta.resolve('@babel/plugin-transform-react-jsx'), {}, 'preset'],\\n ],\\n };\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 373]\"}, {\"title\": \"Storybook Addons Preset Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { PARAM_KEY } from './constants';\\n\\nimport { CustomDecorator } from './decorators';\\n\\nconst preview = {\\n decorators: [CustomDecorator],\\n globals: {\\n [PARAM_KEY]: false,\\n },\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport type { Renderer, ProjectAnnotations } from 'storybook/internal/types';\\nimport { PARAM_KEY } from './constants';\\nimport { CustomDecorator } from './decorators';\\n\\nconst preview: ProjectAnnotations<Renderer> = {\\n decorators: [CustomDecorator],\\n globals: {\\n [PARAM_KEY]: false,\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 374]\"}, {\"title\": \"Storybook Addons Preset Vitefinal\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function ViteFinal(config, options = {}) {\\n config.plugins.push(\\n new MyCustomPlugin({\\n someOption: true,\\n }),\\n );\\n\\n return config;\\n}\\n```\", \"```\\nexport function ViteFinal(config: any, options: any = {}) {\\n config.plugins.push(\\n new MyCustomPlugin({\\n someOption: true,\\n }),\\n );\\n\\n return config;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 375]\"}, {\"title\": \"Storybook Addons Preset Webpackfinal\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { fileURLtoPath } from 'node:url';\\nexport function webpackFinal(config, options = {}) {\\n const rules = [\\n ...(config.module?.rules || []),\\n {\\n test: /\\\\.custom-file-extension$/,\\n loader: fileURLToPath(import.meta.resolve(`custom-loader`)),\\n },\\n ];\\n config.module.rules = rules;\\n\\n return config;\\n}\\n```\", \"```\\nimport { fileURLtoPath } from 'node:url';\\nimport type { Configuration as WebpackConfig } from 'webpack';\\n\\nexport function webpackFinal(config: WebpackConfig, options: any = {}) {\\n const rules = [\\n ...(config.module?.rules || []),\\n {\\n test: /\\\\.custom-file$/,\\n loader: fileURLToPath(import.meta.resolve(`custom-loader`)),\\n },\\n ];\\n config.module.rules = rules;\\n\\n return config;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 376]\"}, {\"title\": \"Storybook Addons Preset\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const previewAnnotations = (entry = [], options) => {\\n return [...entry, import.meta.resolve('./dist/preview')];\\n};\\n```\", \"```\\nexport const previewAnnotations = (entry = [], options) => {\\n return [...entry, import.meta.resolve('./dist/preview')];\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 377]\"}, {\"title\": \"Storybook Addons Root Preset Manager Entries\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const managerEntries = (entry = []) => {\\n return [...entry, import.meta.resolve('path-to-third-party-addon')];\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 378]\"}, {\"title\": \"Storybook Addons Root Preset Preview Annotations\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const previewAnnotations = (entry = [], options) => {\\n return [...entry, import.meta.resolve('./dist/preview')];\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 379]\"}, {\"title\": \"Storybook Addons Root Preset\", \"description\": null, \"content\": {\"root\": [\"```\\nexport const previewAnnotations = [import.meta.resolve('./dist/preview')];\\n\\nexport const managerEntries = [import.meta.resolve('./dist/manager')];\\n\\nexport * from './dist/preset.js';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 380]\"}, {\"title\": \"Storybook Args Url Params Converted\", \"description\": null, \"content\": {\"root\": [\"```\\n{\\n obj: { key: 'val' },\\n arr: ['one', 'two'],\\n nil: null\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 381]\"}, {\"title\": \"Storybook Argtypes With Addon\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { useArgTypes } from 'storybook/manager-api';\\n\\n// inside your panel\\nconst { argTypes } = useArgTypes();\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 382]\"}, {\"title\": \"Definition\", \"description\": null, \"content\": {\"Usage\": \"The component comes in different variants such as `primary`, `secondary`, `large` and `small` which you can use to alter the look and feel of the button.\", \"Inputs\": \"Button has the following properties:\\n\\n<Controls />\\n\\n```\\n\\n<!-- prettier-ignore -->\\n```mdx filename=\\\"Button.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\" tabTitle=\\\"of-prop\\\"\\nimport { Meta, Controls } from '@storybook/addon-docs/blocks';\\n\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n# Definition\\n\\nButton is a clickable interactive element that triggers a response.\\n\\nYou can place text and icons inside of a button.\\n\\nButtons are often used for form submissions and to toggle elements into view.\\n\\n## Usage\\n\\nThe component comes in different variants such as `primary`, `secondary`, `large` and `small` which you can use to alter the look and feel of the button.\\n\\n## Inputs\\n\\nButton has the following properties:\\n\\n<Controls />\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 383]\"}, {\"title\": \"Design implementation\", \"description\": null, \"content\": {\"When to use?\": \"In a select input where there are less than 3-4 items, consider using radio boxes, or radio inputs instead.\", \"How to use?\": \"To help users understand the options available in a select input, include a default option that is unselectable and acts as a label.\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 384]\"}, {\"title\": \"Storybook Auto Docs Full Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs'],\\n docs: {\\n //\\ud83d\\udc47 See the table below for the list of supported options\\n defaultName: 'Documentation',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs'],\\n docs: {\\n //\\ud83d\\udc47 See the table below for the list of supported options\\n defaultName: 'Documentation',\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 385]\"}, {\"title\": \"Storybook Auto Docs Main Mdx Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n //\\ud83d\\udc47 Your documentation written in MDX along with your stories goes here\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n ],\\n addons: ['@storybook/addon-docs'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n //\\ud83d\\udc47 Your documentation written in MDX along with your stories goes here\\n '../src/**/*.mdx',\\n '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',\\n ],\\n addons: ['@storybook/addon-docs'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 386]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Definition\", \"description\": null, \"content\": {\"root\": [\"```\\n# Checkbox\\n\\nA checkbox is a square box that can be activated or deactivated when ticked.\\n\\nUse checkboxes to select one or more options from a list of choices.\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 387]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Docs Only Page\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"ExampleDocumentation.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\", \"import * as ExampleComponentStories from './ExampleComponent.stories';\", \"{/* \\ud83d\\udc47 Documentation-only page */}\", \"<Meta title=\\\"Documentation\\\" />\", \"{/* \\ud83d\\udc47 Component documentation page */}\", \"<Meta of={ExampleComponentStories} />\", \"```\\n\\n<!-- prettier-ignore -->\\n```mdx filename=\\\"ExampleDocumentation.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"Svelte CSF\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\\n\\nimport * as ExampleComponentStories from './ExampleComponent.stories.svelte';\\n\\n{/* \\ud83d\\udc47 Documentation-only page */}\\n\\n<Meta title=\\\"Documentation\\\" />\\n\\n{/* \\ud83d\\udc47 Component documentation page */}\\n\\n<Meta of={ExampleComponentStories} />\\n```\", \"<!-- prettier-ignore -->\\n```mdx filename=\\\"ExampleDocumentation.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"CSF\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\", \"import * as ExampleComponentStories from './ExampleComponent.stories';\", \"{/* \\ud83d\\udc47 Documentation-only page */}\", \"<Meta title=\\\"Documentation\\\" />\", \"{/* \\ud83d\\udc47 Component documentation page */}\", \"<Meta of={ExampleComponentStories} />\", \"```\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 388]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Dos Donts\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"Guideline.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\n<Guidelines>\\n <Dos>\\n - Use buttons for the main actions on your page\\n - Identify the primary action and make it `primary`\\n </Dos>\\n <Donts>\\n - Use a button when a link will do (e.g., for navigation-only actions)\\n - Use multiple `primary` buttons in a single UI state\\n </Donts>\\n</Guidelines>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 389]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Imports\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\nimport { Canvas, Meta } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"```\\n\\n<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"Svelte CSF\\\"\\nimport { Canvas, Meta } from '@storybook/addon-docs/blocks';\\n\\nimport * as CheckboxStories from './Checkbox.stories.svelte';\\n```\", \"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"CSF\\\"\\nimport { Canvas, Meta } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"```\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 390]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Meta Block\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"<Meta of={CheckboxStories} />\", \"```\\n\\n<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"Svelte CSF\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\\n\\nimport * as CheckboxStories from './Checkbox.stories.svelte';\\n\\n<Meta of={CheckboxStories} />\\n```\", \"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"CSF\\\"\\nimport { Meta } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"<Meta of={CheckboxStories} />\", \"```\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 391]\"}, {\"title\": \"Storybook Auto Docs Mdx Docs Story\", \"description\": null, \"content\": {\"root\": [\"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"common\\\" language=\\\"mdx\\\"\\nimport { Canvas } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"<Canvas of={CheckboxStories.Unchecked} />\\n```\", \"```\\nimport { Canvas } from '@storybook/addon-docs/blocks';\\n\\nimport * as CheckboxStories from './Checkbox.stories.svelte';\\n\\n<Canvas of={CheckboxStories.Unchecked} />\\n```\", \"<!-- prettier-ignore -->\\n```mdx filename=\\\"Checkbox.mdx\\\" renderer=\\\"svelte\\\" language=\\\"mdx\\\" tabTitle=\\\"CSF\\\"\\nimport { Canvas } from '@storybook/addon-docs/blocks';\", \"import * as CheckboxStories from './Checkbox.stories';\", \"<Canvas of={CheckboxStories.Unchecked} />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 392]\"}, {\"title\": \"Page\", \"description\": null, \"content\": {\"Usage\": \"<Canvas of={PageStories.Basic} />\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 393]\"}, {\"title\": \"Design Resources\", \"description\": null, \"content\": {\"Figma\": \"[Figma](https://www.figma.com/) is a collaborative design and prototyping tool. It's the heart of the design process, allowing designers to work together seamlessly.\\n\\n[\\\"**Get Access**: If you're not already part of the Figma project, request access from the project lead or manager.\\\"]\", \"UI/UX Design Guidelines\": \"Before you dive into designing, familiarize yourself with our UI/UX design guidelines. They provide valuable insights into our design philosophy and standards.\\n\\n['[UI/UX Guidelines Document](https://your-design-guidelines-link.com)']\", \"Design Assets\": \"All the essential design assets like logos, icons, and brand guidelines can be found in the Figma project. Ensure you have access and familiarize yourself with these assets for consistency.\\n\\n[]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 394]\"}, {\"title\": \"Button\", \"description\": null, \"content\": {\"Usage\": \"<Story of={ButtonStories.Basic} />\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 395]\"}, {\"title\": \"Storybook Automigrate\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest automigrate\\n```\", \"```\\npnpm dlx storybook@latest automigrate\\n```\", \"```\\nyarn dlx storybook@latest automigrate\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 396]\"}, {\"title\": \"Storybook Babel Configuration Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { TransformOptions } from '@babel/core';\\n\\nexport function babelDefault(config: TransformOptions) {\\n return {\\n plugins: [[import.meta.resolve('@babel/plugin-transform-react-jsx'), {}, 'preset']],\\n };\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 397]\"}, {\"title\": \"Storybook Backgrounds Addon Default Params\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'light', value: '#F8F8F8' },\\n { name: 'dark', value: '#333333' },\\n ],\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 398]\"}, {\"title\": \"Storybook Backgrounds Preset Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function previewAnnotations(entry = []) {\\n return [...entry, import.meta.resolve('./defaultParameters')];\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 399]\"}, {\"title\": \"Storybook Build Test Flag\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run build-storybook -- --test\\n```\", \"```\\npnpm run build-storybook --test\\n```\", \"```\\nyarn build-storybook --test\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 400]\"}, {\"title\": \"Storybook Builder Api Build Server\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { build as viteBuild } from 'vite';\\nimport { stringifyProcessEnvs } from './envs';\\nimport { commonConfig } from './vite-config';\\n\\nimport type { EnvsRaw, ExtendedOptions } from './types';\\n\\nexport async function build(options: ExtendedOptions) {\\n const { presets } = options;\\n\\n const baseConfig = await commonConfig(options, 'build');\\n const config = {\\n ...baseConfig,\\n build: {\\n outDir: options.outputDir,\\n emptyOutDir: false,\\n sourcemap: true,\\n },\\n };\\n\\n const finalConfig = await presets.apply('viteFinal', config, options);\\n\\n const envsRaw = await presets.apply<Promise<EnvsRaw>>('env');\\n // Stringify env variables after getting `envPrefix` from the final config\\n const envs = stringifyProcessEnvs(envsRaw, finalConfig.envPrefix);\\n // Update `define`\\n finalConfig.define = {\\n ...finalConfig.define,\\n ...envs,\\n };\\n\\n await viteBuild(finalConfig);\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 401]\"}, {\"title\": \"Storybook Builder Api Configuration Options\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { stringifyProcessEnvs } from './envs';\\nimport { getOptimizeDeps } from './optimizeDeps';\\nimport { commonConfig } from './vite-config';\\n\\nimport type { EnvsRaw, ExtendedOptions } from './types';\\n\\nexport async function createViteServer(options: ExtendedOptions, devServer: Server) {\\n const { port, presets } = options;\\n\\n // Defines the baseline config.\\n const baseConfig = await commonConfig(options, 'development');\\n const defaultConfig = {\\n ...baseConfig,\\n server: {\\n middlewareMode: true,\\n hmr: {\\n port,\\n server: devServer,\\n },\\n fs: {\\n strict: true,\\n },\\n },\\n optimizeDeps: await getOptimizeDeps(baseConfig, options),\\n };\\n\\n const finalConfig = await presets.apply('viteFinal', defaultConfig, options);\\n\\n const envsRaw = await presets.apply<Promise<EnvsRaw>>('env');\\n\\n // Remainder implementation\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 402]\"}, {\"title\": \"Storybook Builder Api Dev Server\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { createServer } from 'vite';\\n\\nexport async function createViteServer(options: ExtendedOptions, devServer: Server) {\\n const { port } = options;\\n // Remainder server configuration\\n\\n // Creates the server.\\n return createServer({\\n // The server configuration goes here\\n server: {\\n middlewareMode: true,\\n hmr: {\\n port,\\n server: devServer,\\n },\\n },\\n });\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 403]\"}, {\"title\": \"Storybook Builder Api Interface\", \"description\": null, \"content\": {\"root\": [\"```\\nexport interface Builder<Config, Stats> {\\n start: (args: {\\n options: Options;\\n startTime: ReturnType<typeof process.hrtime>;\\n router: Router;\\n server: Server;\\n }) => Promise<void | {\\n stats?: Stats;\\n totalTime: ReturnType<typeof process.hrtime>;\\n bail: (e?: Error) => Promise<void>;\\n }>;\\n build: (arg: {\\n options: Options;\\n startTime: ReturnType<typeof process.hrtime>;\\n }) => Promise<void | Stats>;\\n bail: (e?: Error) => Promise<void>;\\n getConfig: (options: Options) => Promise<Config>;\\n corePresets?: string[];\\n overridePresets?: string[];\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 404]\"}, {\"title\": \"Storybook Builder Api Mdx\", \"description\": null, \"content\": {\"root\": [\"```\\nimport mdx from 'vite-plugin-mdx';\\n\\nimport { createCompiler } from 'storybook/internal/csf-tools/mdx';\\n\\nexport function mdxPlugin() {\\n return mdx((filename) => {\\n const compilers = [];\\n\\n if (filename.endsWith('stories.mdx') || filename.endsWith('story.mdx')) {\\n compilers.push(createCompiler({}));\\n }\\n return {\\n compilers,\\n };\\n });\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 405]\"}, {\"title\": \"Storybook Builder Api Preview Exports\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { virtualPreviewFile, virtualStoriesFile } from './virtual-file-names';\\nimport { transformAbsPath } from './utils/transform-abs-path';\\nimport type { ExtendedOptions } from './types';\\n\\nexport async function generateIframeScriptCode(options: ExtendedOptions) {\\n const { presets, frameworkPath, framework } = options;\\n const frameworkImportPath = frameworkPath || `@storybook/${framework}`;\\n\\n const presetEntries = await presets.apply('config', [], options);\\n const configEntries = [...presetEntries].filter(Boolean);\\n\\n const absoluteFilesToImport = (files: string[], name: string) =>\\n files\\n .map((el, i) => `import ${name ? `* as ${name}_${i} from ` : ''}'${transformAbsPath(el)}'`)\\n .join('\\\\n');\\n\\n const importArray = (name: string, length: number) =>\\n new Array(length).fill(0).map((_, i) => `${name}_${i}`);\\n\\n const code = `\\n // Ensure that the client API is initialized by the framework before any other iframe code\\n // is loaded. That way our client-apis can assume the existence of the API+store\\n import { configure } from '${frameworkImportPath}';\\n\\n import {\\n addDecorator,\\n addParameters,\\n addArgTypesEnhancer,\\n addArgsEnhancer,\\n setGlobalRender\\n } from 'storybook/preview-api';\\n import { logger } from 'storybook/internal/client-logger';\\n ${absoluteFilesToImport(configEntries, 'config')}\\n import * as preview from '${virtualPreviewFile}';\\n import { configStories } from '${virtualStoriesFile}';\\n\\n const configs = [${importArray('config', configEntries.length)\\n .concat('preview.default')\\n .join(',')}].filter(Boolean)\\n\\n configs.forEach(config => {\\n Object.keys(config).forEach((key) => {\\n const value = config[key];\\n switch (key) {\\n case 'args':\\n case 'argTypes': {\\n return logger.warn('Invalid args/argTypes in config, ignoring.', JSON.stringify(value));\\n }\\n case 'decorators': {\\n return value.forEach((decorator) => addDecorator(decorator, false));\\n }\\n case 'parameters': {\\n return addParameters({ ...value }, false);\\n }\\n case 'render': {\\n return setGlobalRender(value)\\n }\\n case 'globals':\\n case 'globalTypes': {\\n const v = {};\\n v[key] = value;\\n return addParameters(v, false);\\n }\\n case 'decorateStory':\\n case 'renderToCanvas': {\\n return null;\\n }\\n default: {\\n // eslint-disable-next-line prefer-template\\n return console.log(key + ' was not supported :( !');\\n }\\n }\\n });\\n })\\n configStories(configure);\\n `.trim();\\n return code;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 406]\"}, {\"title\": \"Storybook Builder Api Shutdown Server\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { createViteServer } from './vite-server';\\n\\nlet server: ViteDevServer;\\nexport async function bail(): Promise<void> {\\n return server?.close();\\n}\\n\\nexport const start: ViteBuilder['start'] = async ({ options, server: devServer }) => {\\n // Remainder implementation goes here\\n server = await createViteServer(options as ExtendedOptions, devServer);\\n\\n return {\\n bail,\\n totalTime: process.hrtime(startTime),\\n };\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 407]\"}, {\"title\": \"Storybook Canvas Doc Block Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { ColorItem, ColorPalette } from '@storybook/addon-docs/blocks';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n};\\n\\nconst theme = {\\n colors: {\\n primaryDark: {\\n value: '#1C1C1C',\\n },\\n primaryRegular: {\\n value: '#363636',\\n },\\n primaryLight1: {\\n value: '#4D4D4D',\\n },\\n primaryLight2: {\\n value: '#878787',\\n },\\n primaryLight3: {\\n value: '#D1D1D1',\\n },\\n primaryLight4: {\\n value: '#EDEDED',\\n },\\n },\\n};\\n\\n// \\u274c Don't use the Doc Blocks inside your stories. It will break Storybook with a cryptic error.\\nexport const Colors = {\\n render: () => (\\n <ColorPalette>\\n {Object.entries(theme.colors).map(([key, { value }]) => (\\n <ColorItem\\n colors={{\\n [key]: value,\\n }}\\n key={key}\\n subtitle={`theme.colors.${key}`}\\n title={key}\\n />\\n ))}\\n </ColorPalette>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { ColorItem, ColorPalette } from '@storybook/addon-docs/blocks';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nconst theme = {\\n colors: {\\n primaryDark: {\\n value: '#1C1C1C',\\n },\\n primaryRegular: {\\n value: '#363636',\\n },\\n primaryLight1: {\\n value: '#4D4D4D',\\n },\\n primaryLight2: {\\n value: '#878787',\\n },\\n primaryLight3: {\\n value: '#D1D1D1',\\n },\\n primaryLight4: {\\n value: '#EDEDED',\\n },\\n },\\n};\\n\\n// \\u274c Don't use the Doc Blocks inside your stories. It will break Storybook with a cryptic error.\\nexport const Colors: Story = {\\n render: () => (\\n <ColorPalette>\\n {Object.entries(theme.colors).map(([key, { value }]) => (\\n <ColorItem\\n colors={{\\n [key]: value,\\n }}\\n key={key}\\n subtitle={`theme.colors.${key}`}\\n title={key}\\n />\\n ))}\\n </ColorPalette>\\n ),\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 408]\"}, {\"title\": \"Storybook Client Globals Example File\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { global } from '@storybook/global';\\n\\nconst { window: globalWindow } = global;\\n\\nglobalWindow.STORYBOOK_ENV = 'vue';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 409]\"}, {\"title\": \"Storybook Client Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { start } from 'storybook/preview-api';\\n\\nimport './globals';\\n\\nimport render from './render';\\n\\nconst api = start(render);\\n\\n// the boilerplate code\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 410]\"}, {\"title\": \"Storybook Component Layout Param\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n // Sets the layout parameter component wide.\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 411]\"}, {\"title\": \"Storybook Config Layout\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n navSize: 300,\\n bottomPanelHeight: 300,\\n rightPanelWidth: 300,\\n panelPosition: 'bottom',\\n enableShortcuts: true,\\n showToolbar: true,\\n theme: undefined,\\n selectedPanel: undefined,\\n initialActive: 'sidebar',\\n layoutCustomisations: {\\n showSidebar(state, defaultValue) {\\n return state.storyId === 'landing' ? false : defaultValue;\\n },\\n showToolbar(state, defaultValue) {\\n return state.viewMode === 'docs' ? false : defaultValue;\\n },\\n },\\n sidebar: {\\n showRoots: false,\\n collapsedRoots: ['other'],\\n },\\n toolbar: {\\n title: { hidden: false },\\n zoom: { hidden: false },\\n eject: { hidden: false },\\n copy: { hidden: false },\\n fullscreen: { hidden: false },\\n },\\n});\\n```\", \"```\\nimport { addons, type State } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n navSize: 300,\\n bottomPanelHeight: 300,\\n rightPanelWidth: 300,\\n panelPosition: 'bottom',\\n enableShortcuts: true,\\n showToolbar: true,\\n theme: undefined,\\n selectedPanel: undefined,\\n initialActive: 'sidebar',\\n layoutCustomisations: {\\n showSidebar(state: State, defaultValue: boolean) {\\n return state.storyId === 'landing' ? false : defaultValue;\\n },\\n showToolbar(state: State, defaultValue: boolean) {\\n return state.viewMode === 'docs' ? false : defaultValue;\\n },\\n },\\n sidebar: {\\n showRoots: false,\\n collapsedRoots: ['other'],\\n },\\n toolbar: {\\n title: { hidden: false },\\n zoom: { hidden: false },\\n eject: { hidden: false },\\n copy: { hidden: false },\\n fullscreen: { hidden: false },\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 412]\"}, {\"title\": \"Storybook Coverage Addon Config Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n stories: [],\\n addons: [\\n // Other Storybook addons\\n {\\n name: '@storybook/addon-coverage',\\n options: {\\n istanbul: {\\n include: ['**/stories/**'],\\n exclude: ['**/exampleDirectory/**'],\\n },\\n },\\n },\\n ],\\n};\\n```\", \"```\\n// For Vite support add the following import\\n// import type { AddonOptionsVite } from '@storybook/addon-coverage';\\n\\nimport type { AddonOptionsWebpack } from '@storybook/addon-coverage';\\n\\n// Replace your-framework with the framework and builder you are using (e.g., react-webpack5, vue3-webpack5)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst coverageConfig: AddonOptionsWebpack = {\\n istanbul: {\\n include: ['**/stories/**'],\\n exclude: ['**/exampleDirectory/**'],\\n },\\n};\\n\\nconst config: StorybookConfig = {\\n stories: [],\\n addons: [\\n // Other Storybook addons\\n {\\n name: '@storybook/addon-coverage',\\n options: coverageConfig,\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 413]\"}, {\"title\": \"Storybook Coverage Addon Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-coverage\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-coverage\\n```\", \"```\\nyarn dlx storybook@latest add @storybook/addon-coverage\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 414]\"}, {\"title\": \"Storybook Coverage Addon Optimized Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs', '@storybook/addon-vitest', '@storybook/addon-coverage'],\\n build: {\\n test: {\\n disabledAddons: ['@storybook/addon-docs'],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs', '@storybook/addon-vitest', '@storybook/addon-coverage'],\\n build: {\\n test: {\\n disabledAddons: ['@storybook/addon-docs'],\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 415]\"}, {\"title\": \"Storybook Coverage Report Lcov\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx nyc report --reporter=lcov -t coverage/storybook --report-dir coverage/storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 416]\"}, {\"title\": \"Storybook Coverage Report Vue\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Other configuration options\\n extension: ['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx', '.vue'],\\n};\\n```\", \"```\\n{\\n \\\"extension\\\": [\\\".js\\\", \\\".cjs\\\", \\\".mjs\\\", \\\".ts\\\", \\\".tsx\\\", \\\".jsx\\\", \\\".vue\\\"]\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 417]\"}, {\"title\": \"Storybook Csf 3 Auto Title Redundant\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { MyComponent } from './MyComponent.component';\\n\\nconst meta: Meta<MyComponent> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<MyComponent>;\\n\\nexport const Default: Story = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" args={{ something: 'Something else' }} />\\n```\", \"```\\nimport MyComponent from './MyComponent.svelte';\\n\\nexport default {\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n};\\n\\nexport const Default = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\nimport { MyComponent } from './MyComponent';\\n\\nexport default {\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n};\\n\\nexport const Default = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" args={{ something: 'Something else'}} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport MyComponent from './MyComponent.svelte';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { MyComponent } from './MyComponent';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n component: MyComponent,\\n title: 'components/MyComponent/MyComponent',\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'my-component',\\n title: 'components/MyComponent/MyComponent',\\n};\\n\\nexport const Default = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'my-component',\\n title: 'components/MyComponent/MyComponent',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n args: {\\n something: 'Something else',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 418]\"}, {\"title\": \"Storybook Custom Docs Markdown\", \"description\": null, \"content\": {\"Changelog\": \"<Markdown>{Readme}</Markdown>\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 419]\"}, {\"title\": \"Storybook Custom Manager Head\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n managerHead: (head) => `\\n ${head}\\n <link rel=\\\"icon\\\" type=\\\"image/png\\\" href=\\\"/logo192.png\\\" sizes=\\\"192x192\\\" />\\n `,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n managerHead: (head) => `\\n ${head}\\n <link rel=\\\"icon\\\" type=\\\"image/png\\\" href=\\\"/logo192.png\\\" sizes=\\\"192x192\\\" />\\n `,\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 420]\"}, {\"title\": \"Storybook Debug Webpack Dev\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run storybook -- --debug-webpack\\n```\", \"```\\nyarn storybook --debug-webpack\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 421]\"}, {\"title\": \"Storybook Debug Webpack Prod\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run build-storybook -- --debug-webpack\\n```\", \"```\\nyarn build-storybook --debug-webpack\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 422]\"}, {\"title\": \"Storybook Disable Telemetry Env\", \"description\": null, \"content\": {\"root\": [\"```\\nSTORYBOOK_DISABLE_TELEMETRY=1 yarn storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 423]\"}, {\"title\": \"Storybook Disable Telemetry Flag\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run storybook -- --disable-telemetry\\n```\", \"```\\npnpm run storybook --disable-telemetry\\n```\", \"```\\nyarn storybook --disable-telemetry\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 424]\"}, {\"title\": \"Storybook Doctor\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest doctor\\n```\", \"```\\npnpm dlx storybook@latest doctor\\n```\", \"```\\nyarn dlx storybook@latest doctor\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 425]\"}, {\"title\": \"Storybook Ember Cli Build\", \"description\": null, \"content\": {\"root\": [\"```\\n'use strict';\\n\\nconst EmberApp = require('ember-cli/lib/broccoli/ember-app');\\n\\nmodule.exports = function (defaults) {\\n const app = new EmberApp(defaults, {\\n '@storybook/ember-cli-storybook': {\\n enableAddonDocsIntegration: true,\\n },\\n });\\n\\n return app.toTree();\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 426]\"}, {\"title\": \"Storybook Extract Specific Version\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@7.5.3 extract\\n```\", \"```\\npnpm dlx storybook@7.5.3 extract\\n```\", \"```\\nyarn dlx storybook@7.5.3 extract\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 427]\"}, {\"title\": \"Storybook Figma Addon Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-designs\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-designs\\n```\", \"```\\nyarn dlx storybook@latest add @storybook/addon-designs\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 428]\"}, {\"title\": \"Storybook Fix Imports Autodocs Monorepo\", \"description\": null, \"content\": {\"root\": [\"```\\n// \\u274c Don't use the package's index file to import the component.\\n// import { MyComponent } from '@component-package';\\n\\n// \\u2705 Use the component's export to import it directly.\\nimport { MyComponent } from '@component-package/src/MyComponent';\\n\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'MyComponent',\\n component: MyComponent,\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\n// \\u274c Don't use the package's index file to import the component.\\n// import { MyComponent } from '@component-package';\\n\\n// \\u2705 Use the component's export to import it directly.\\nimport { MyComponent } from '@component-package/src/MyComponent';\\n\\nconst meta = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'MyComponent',\\n component: MyComponent,\\n} satisfies Meta<typeof MyComponent>;\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 429]\"}, {\"title\": \"Storybook Framework Render Function\", \"description\": null, \"content\": {\"root\": [\"```\\nconst rootElement = document.getElementById('root');\\n\\nexport default function renderMain({ storyFn }: RenderMainArgs) {\\n const storyObj = storyFn();\\n const html = fn(storyObj);\\n rootElement.innerHTML = html;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 430]\"}, {\"title\": \"Storybook Generated Argtypes\", \"description\": null, \"content\": {\"root\": [\"```\\nconst argTypes = {\\n label: {\\n name: 'label',\\n type: { name: 'string', required: false },\\n defaultValue: 'Hello',\\n description: 'demo description',\\n table: {\\n type: { summary: 'string' },\\n defaultValue: { summary: 'Hello' },\\n },\\n control: {\\n type: 'text',\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 431]\"}, {\"title\": \"Storybook Init V7\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@^7 init\\n```\", \"```\\npnpm dlx storybook@^7 init\\n```\", \"```\\nyarn dlx storybook@^7 init\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 432]\"}, {\"title\": \"Storybook Interactions Play Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nimport { Form } from './Form.component';\\n\\nconst meta: Meta<Form> = {\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the submit output\\n submit: fn(),\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Form>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted: Story = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect, fn, waitFor } from 'storybook/test';\\n\\n import Form from './Form.svelte';\\n\\n const { Story } = defineMeta({\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the submit output\\n onSubmit: fn(),\\n },\\n });\\n</script>\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n -->\\n<Story\\n name=\\\"Submitted\\\"\\n play={async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n }}\\n/>\\n```\", \"```\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nimport Form from './Form.svelte';\\n\\nexport default {\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n // Starts querying the component from its root element\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nimport { Form } from './Form';\\n\\nexport default {\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n // Starts querying the component from its root element\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect, fn, waitFor } from 'storybook/test';\\n\\n import Form from './Form.svelte';\\n\\n const { Story } = defineMeta({\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the submit output\\n onSubmit: fn(),\\n },\\n });\\n</script>\\n\\n<!--\\n See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n to learn more about using the canvas to query the DOM\\n -->\\n<Story\\n name=\\\"Submitted\\\"\\n play={async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nimport Form from './Form.svelte';\\n\\nconst meta = {\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n} satisfies Meta<typeof Form>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted: Story = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nimport { Form } from './Form';\\n\\nconst meta = {\\n component: Form,\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n} satisfies Meta<typeof Form>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted: Story = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nexport default {\\n component: 'my-form-element',\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { expect, fn, waitFor } from 'storybook/test';\\n\\nconst meta: Meta = {\\n component: 'my-form-element',\\n args: {\\n // \\ud83d\\udc47 Use `fn` to spy on the onSubmit arg\\n onSubmit: fn(),\\n },\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\n/*\\n * See https://storybook.js.org/docs/writing-stories/play-function#working-with-the-canvas\\n * to learn more about using the canvas to query the DOM\\n */\\nexport const Submitted: Story = {\\n play: async ({ args, canvas, step, userEvent }) => {\\n await step('Enter credentials', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n\\n // \\ud83d\\udc47 Now we can assert that the onSubmit arg was called\\n await waitFor(() => expect(args.onSubmit).toHaveBeenCalled());\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 433]\"}, {\"title\": \"Storybook Interactions Step Function\", \"description\": null, \"content\": {\"root\": [\"```\\n// ...rest of story file\\n\\nexport const Submitted = {\\n play: async ({ args, canvas, step }) => {\\n await step('Enter email and password', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n },\\n};\\n```\", \"```\\n// ...rest of story file\\n\\nexport const Submitted: Story = {\\n play: async ({ args, canvas, step }) => {\\n await step('Enter email and password', async () => {\\n await userEvent.type(canvas.getByTestId('email'), 'hi@example.com');\\n await userEvent.type(canvas.getByTestId('password'), 'supersecret');\\n });\\n\\n await step('Submit form', async () => {\\n await userEvent.click(canvas.getByRole('button'));\\n });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 434]\"}, {\"title\": \"Storybook Main Advanced Config Example\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n viteFinal: async (config, options) => {\\n // Update config here\\n return config;\\n },\\n webpackFinal: async (config, options) => {\\n // Change webpack config\\n return config;\\n },\\n babel: async (config, options) => {\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n viteFinal: async (config, options) => {\\n // Update config here\\n return config;\\n },\\n webpackFinal: async (config, options) => {\\n // Change webpack config\\n return config;\\n },\\n babel: async (config, options) => {\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 435]\"}, {\"title\": \"Storybook Main Auto Title Custom\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: [\\n {\\n directory: '../src',\\n titlePrefix: 'Custom', // \\ud83d\\udc48 Configure the title prefix\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: [\\n {\\n directory: '../src',\\n titlePrefix: 'Custom', // \\ud83d\\udc48 Configure the title prefix\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 436]\"}, {\"title\": \"Storybook Main Config Remark Options\", \"description\": null, \"content\": {\"root\": [\"```\\nimport remarkGfm from 'remark-gfm';\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n // Other addons go here\\n {\\n name: '@storybook/addon-docs',\\n options: {\\n mdxPluginOptions: {\\n mdxCompileOptions: {\\n remarkPlugins: [remarkGfm],\\n },\\n },\\n },\\n },\\n ],\\n};\\n```\", \"```\\nimport remarkGfm from 'remark-gfm';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n // Other addons go here\\n {\\n name: '@storybook/addon-docs',\\n options: {\\n mdxPluginOptions: {\\n mdxCompileOptions: {\\n remarkPlugins: [remarkGfm],\\n },\\n },\\n },\\n },\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 437]\"}, {\"title\": \"Storybook Main Configuration Src Dir\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 438]\"}, {\"title\": \"Storybook Main Disable Telemetry\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableTelemetry: true, // \\ud83d\\udc48 Disables telemetry\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n disableTelemetry: true, // \\ud83d\\udc48 Disables telemetry\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 439]\"}, {\"title\": \"Storybook Main Extend Ts Config\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n check: false,\\n checkOptions: {},\\n skipCompiler: false,\\n },\\n};\\n\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n check: false,\\n checkOptions: {},\\n reactDocgen: 'react-docgen',\\n reactDocgenTypescriptOptions: {}, // Available only when reactDocgen is set to 'react-docgen-typescript'\\n skipCompiler: true,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 440]\"}, {\"title\": \"Storybook Main Fix Imports Autodocs Monorepo\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n // Overrides the default Typescript configuration to allow multi-package components to be documented via Autodocs.\\n reactDocgen: 'react-docgen',\\n check: false,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n // Overrides the default Typescript configuration to allow multi-package components to be documented via Autodocs.\\n reactDocgen: 'react-docgen',\\n check: false,\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 441]\"}, {\"title\": \"Storybook Main Js Md Files\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../my-project/src/components/*.@(js|md)'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../my-project/src/components/*.@(js|md)'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 442]\"}, {\"title\": \"Storybook Main Pnpm With Module Resolution\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { dirname, join } from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nconst getAbsolutePath = (packageName) =>\\n dirname(fileURLToPath(import.meta.resolve(join(packageName, 'package.json'))));\\n\\nexport default {\\n framework: {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n name: getAbsolutePath('@storybook/your-framework'),\\n options: {},\\n },\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n //\\ud83d\\udc47 Use getAbsolutePath when referencing Storybook's addons and frameworks\\n getAbsolutePath('@storybook/addon-docs'),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nimport { dirname, join } from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nconst getAbsolutePath = (packageName: string) =>\\n dirname(fileURLToPath(import.meta.resolve(join(packageName, 'package.json'))));\\n\\nconst config: StorybookConfig = {\\n framework: {\\n // Replace your-framework with the same one you've imported above.\\n name: getAbsolutePath('@storybook/your-framework'),\\n options: {},\\n },\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: [\\n //\\ud83d\\udc47 Use getAbsolutePath when referencing Storybook's addons and frameworks\\n getAbsolutePath('@storybook/addon-docs'),\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 443]\"}, {\"title\": \"Storybook Main Preview Head\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n previewHead: (head) => (`\\n ${head}\\n <style>\\n #main {\\n background-color: yellow;\\n }\\n </style>\\n `);\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 444]\"}, {\"title\": \"Storybook Main Prop Filter\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n reactDocgen: 'react-docgen-typescript',\\n reactDocgenTypescriptOptions: {\\n compilerOptions: {\\n allowSyntheticDefaultImports: false,\\n esModuleInterop: false,\\n },\\n // Filter out third-party props from node_modules except @mui packages.\\n propFilter: (prop) =>\\n prop.parent ? !/node_modules\\\\/(?!@mui)/.test(prop.parent.fileName) : true,\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 445]\"}, {\"title\": \"Storybook Main React Docgen Typescript\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n typescript: {\\n reactDocgen: 'react-docgen-typescript',\\n // Provide your own options if necessary.\\n // See https://storybook.js.org/docs/configure/typescript for more information.\\n reactDocgenTypescriptOptions: {},\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 446]\"}, {\"title\": \"Storybook Main Ref Local\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n react: {\\n title: 'React',\\n url: 'http://localhost:7007',\\n },\\n angular: {\\n title: 'Angular',\\n url: 'http://localhost:7008',\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n refs: {\\n react: {\\n title: 'React',\\n url: 'http://localhost:7007',\\n },\\n angular: {\\n title: 'Angular',\\n url: 'http://localhost:7008',\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 447]\"}, {\"title\": \"Storybook Main Register Addon\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n addons: ['path/to/manager.js'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 448]\"}, {\"title\": \"Storybook Main Register Example Addon\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-a11y',\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n addons: [\\n // Other Storybook addons\\n '@storybook/addon-a11y',\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 449]\"}, {\"title\": \"Storybook Main Register Presets Managerentry\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n addons: [\\n '@storybook/addon-docs/preset', // A preset registered here, in this case from the addon-docs addon.\\n ],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 450]\"}, {\"title\": \"Storybook Main Simplified Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n config.plugins.push(/* ... */);\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n config.plugins.push(/* ... */);\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 451]\"}, {\"title\": \"Storybook Main Ts Module Resolution Atsign Import\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve.alias,\\n '@': path.resolve(process.cwd(), 'src'),\\n };\\n }\\n return config;\\n },\\n};\\n```\", \"```\\nimport path from 'path';\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.alias = {\\n ...config.resolve.alias,\\n '@': path.resolve(process.cwd(), 'src'),\\n };\\n }\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 452]\"}, {\"title\": \"Storybook Main Ts Module Resolution\", \"description\": null, \"content\": {\"root\": [\"```\\nimport TsconfigPathsPlugin from 'tsconfig-paths-webpack-plugin';\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.plugins = [\\n ...(config.resolve.plugins || []),\\n new TsconfigPathsPlugin({\\n extensions: config.resolve.extensions,\\n }),\\n ];\\n }\\n return config;\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nimport TsconfigPathsPlugin from 'tsconfig-paths-webpack-plugin';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n if (config.resolve) {\\n config.resolve.plugins = [\\n ...(config.resolve.plugins || []),\\n new TsconfigPathsPlugin({\\n extensions: config.resolve.extensions,\\n }),\\n ];\\n }\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 453]\"}, {\"title\": \"Storybook Main Use Manager Entries\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n managerEntries: ['some-storybook-addon/entry-point.js'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 454]\"}, {\"title\": \"Storybook Main Using Existing Config\", \"description\": null, \"content\": {\"root\": [\"```\\nimport custom from '../webpack.config.js'; // \\ud83d\\udc48 Custom Webpack configuration being imported.\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n return {\\n ...config,\\n module: { ...config.module, rules: [...config.module.rules, ...custom.module.rules] },\\n };\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nimport custom from '../webpack.config.js'; // \\ud83d\\udc48 Custom Webpack configuration being imported.\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n webpackFinal: async (config) => {\\n return {\\n ...config,\\n module: { ...config.module, rules: [...config.module.rules, ...custom.module.rules] },\\n };\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 455]\"}, {\"title\": \"Storybook Main Versioned Webpack\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function webpackFinal(config, { presets }) {\\n const version = await presets.apply('webpackVersion');\\n const instance = (await presets.apply('webpackInstance'))?.default;\\n\\n logger.info(`=> Running in webpack ${version}: ${instance}`);\\n return config;\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 456]\"}, {\"title\": \"Storybook Main Webpack Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n builder: {\\n name: '@storybook/builder-webpack5',\\n options: {\\n fsCache: true,\\n lazyCompilation: true,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-webpack5, nextjs, angular, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n builder: {\\n name: '@storybook/builder-webpack5',\\n options: {\\n fsCache: true,\\n lazyCompilation: true,\\n },\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 457]\"}, {\"title\": \"Storybook Main Webpack Preset Config\", \"description\": null, \"content\": {\"root\": [\"```\\nexport async function webpack(baseConfig, options) {\\n // Modify or replace config.\\n // Mutating the original reference object can cause unexpected bugs,\\n // so in this example we replace.\\n const { module = {} } = baseConfig;\\n\\n return {\\n ...baseConfig,\\n module: {\\n ...module,\\n rules: [\\n ...(module.rules || []),\\n {\\n /* some new loader */\\n },\\n ],\\n },\\n };\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 458]\"}, {\"title\": \"Storybook Main Webpack5 Fscache\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n core: {\\n builder: {\\n name: 'webpack5',\\n options: {\\n fsCache: true,\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 459]\"}, {\"title\": \"Storybook Main Webpack5 Lazycompilation\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n core: {\\n builder: {\\n name: 'webpack5',\\n options: {\\n lazyCompilation: true,\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 460]\"}, {\"title\": \"Storybook Main Webpack5\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n core: {\\n builder: '@storybook/builder-webpack5',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 461]\"}, {\"title\": \"Storybook Main Webpackfinal Example\", \"description\": null, \"content\": {\"root\": [\"```\\nexport function webpackFinal(config, { configDir }) {\\n if (!isReactScriptsInstalled()) {\\n logger.info('=> Using base config because react-scripts is not installed.');\\n return config;\\n }\\n\\n logger.info('=> Loading create-react-app config.');\\n return applyCRAWebpackConfig(config, configDir);\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 462]\"}, {\"title\": \"Storybook Manager Custom Theme\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\nimport yourTheme from './YourTheme';\\n\\naddons.setConfig({\\n theme: yourTheme,\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 463]\"}, {\"title\": \"Storybook Manager Dark Theme\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\nimport { themes } from 'storybook/theming';\\n\\naddons.setConfig({\\n theme: themes.dark,\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 464]\"}, {\"title\": \"Storybook Manager Disable Roots\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n sidebar: {\\n showRoots: false,\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 465]\"}, {\"title\": \"Storybook Manager Render Label Stories\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\n\\nimport startCase from 'lodash/startCase.js';\\n\\naddons.setConfig({\\n sidebar: {\\n renderLabel: ({ name, type }) => (type === 'story' ? name : startCase(name)),\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 466]\"}, {\"title\": \"Storybook Manager Sidebar Hide On Landing\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n layoutCustomisations: {\\n // Hide the sidebar on the landing page, which has its own nav links to other pages.\\n showSidebar(state, defaultValue) {\\n if (state.storyId === 'landing' && state.viewMode === 'docs') {\\n return false;\\n }\\n\\n return defaultValue;\\n },\\n },\\n});\\n```\", \"```\\nimport { addons, type State } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n layoutCustomisations: {\\n // Hide the sidebar on the landing page, which has its own nav links to other pages.\\n showSidebar(state: State, defaultValue: boolean) {\\n if (state.storyId === 'landing' && state.viewMode === 'docs') {\\n return false;\\n }\\n\\n return defaultValue;\\n },\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 467]\"}, {\"title\": \"Storybook Manager Toolbar Hide On Docs\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { addons } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n layoutCustomisations: {\\n // Always hide the toolbar on docs pages, and respect user preferences elsewhere.\\n showToolbar(state, defaultValue) {\\n if (state.viewMode === 'docs') {\\n return false;\\n }\\n\\n return defaultValue;\\n },\\n },\\n});\\n```\", \"```\\nimport { addons, type State } from 'storybook/manager-api';\\n\\naddons.setConfig({\\n layoutCustomisations: {\\n // Always hide the toolbar on docs pages, and respect user preferences elsewhere.\\n showToolbar(state: State, defaultValue: boolean) {\\n if (state.viewMode === 'docs') {\\n return false;\\n }\\n\\n return defaultValue;\\n },\\n },\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 468]\"}, {\"title\": \"Default implementation\", \"description\": null, \"content\": {\"Inputs\": \"The component accepts the following inputs (props):\\n\\n<Controls />\\n\\n[]\", \"Additional variations\": \"Listed below are additional variations of the component.\\n\\n<Stories />\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 469]\"}, {\"title\": \"Storybook Merged Argtypes\", \"description\": null, \"content\": {\"root\": [\"```\\nconst argTypes = {\\n label: {\\n name: 'label',\\n type: { name: 'string', required: false },\\n defaultValue: 'Hello',\\n description: 'overwritten description',\\n table: {\\n type: {\\n summary: 'something short',\\n detail: 'something really really long',\\n },\\n defaultValue: { summary: 'Hello' },\\n },\\n control: {\\n type: null,\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 470]\"}, {\"title\": \"Storybook Migrate Csf 2 To 3\", \"description\": null, \"content\": {\"root\": [\"```\\n# Convert CSF 2 to CSF 3\\nnpx storybook@latest migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\n# Convert CSF 2 to CSF 3\\npnpm dlx storybook@latest migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\n# Convert CSF 2 to CSF 3\\nyarn dlx storybook@latest migrate csf-2-to-3 --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 471]\"}, {\"title\": \"Storybook Migrate Mdx To Csf\", \"description\": null, \"content\": {\"root\": [\"```\\n# Convert stories in MDX to CSF\\nnpx storybook@latest migrate mdx-to-csf --glob \\\"src/**/*.stories.mdx\\\"\\n```\", \"```\\n# Convert stories in MDX to CSF\\npnpm dlx storybook@latest migrate mdx-to-csf --glob \\\"src/**/*.stories.mdx\\\"\\n```\", \"```\\n# Convert stories in MDX to CSF\\nyarn dlx storybook@latest migrate mdx-to-csf --glob \\\"src/**/*.stories.mdx\\\"\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 472]\"}, {\"title\": \"Storybook Migrate Stories Of To Csf\", \"description\": null, \"content\": {\"root\": [\"```\\n# Convert storiesOf to CSF 1\\nnpx storybook@latest migrate storiesof-to-csf --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\n# Convert storiesOf to CSF 1\\npnpm dlx storybook@latest migrate storiesof-to-csf --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\", \"```\\n# Convert storiesOf to CSF 1\\nyarn dlx storybook@latest migrate storiesof-to-csf --glob=\\\"**/*.stories.tsx\\\" --parser=tsx\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 473]\"}, {\"title\": \"Storybook Preset Full Config Object\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n managerWebpack: async (config, options) => {\\n // Update config here\\n return config;\\n },\\n webpackFinal: async (config, options) => {\\n return config;\\n },\\n babel: async (config, options) => {\\n return config;\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 474]\"}, {\"title\": \"Storybook Preview Auto Docs Custom Docs Container\", \"description\": null, \"content\": {\"root\": [\"```\\nimport * as React from 'react';\\n\\nimport { DocsContainer } from '@storybook/addon-docs/blocks';\\n\\nconst ExampleContainer = ({ children, ...props }) => {\\n return <DocsContainer {...props}>{children}</DocsContainer>;\\n};\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n container: ExampleContainer,\\n },\\n },\\n};\\n```\", \"```\\nimport * as React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { DocsContainer } from '@storybook/addon-docs/blocks';\\n\\nconst ExampleContainer = ({ children, ...props }) => {\\n return <DocsContainer {...props}>{children}</DocsContainer>;\\n};\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n container: ExampleContainer,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 475]\"}, {\"title\": \"Storybook Preview Auto Docs Custom Mdx Template\", \"description\": null, \"content\": {\"root\": [\"```\\nimport DocumentationTemplate from './DocumentationTemplate.mdx';\\n\\nexport default {\\n parameters: {\\n docs: {\\n page: DocumentationTemplate,\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 476]\"}, {\"title\": \"Storybook Preview Auto Docs Custom Template Function\", \"description\": null, \"content\": {\"root\": [\"```\\nimport {\\n Title,\\n Subtitle,\\n Description,\\n Primary,\\n Controls,\\n Stories,\\n} from '@storybook/addon-docs/blocks';\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n page: () => (\\n <>\\n <Title />\\n <Subtitle />\\n <Description />\\n <Primary />\\n <Controls />\\n <Stories />\\n </>\\n ),\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport {\\n Title,\\n Subtitle,\\n Description,\\n Primary,\\n Controls,\\n Stories,\\n} from '@storybook/addon-docs/blocks';\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n page: () => (\\n <>\\n <Title />\\n <Subtitle />\\n <Description />\\n <Primary />\\n <Controls />\\n <Stories />\\n </>\\n ),\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 477]\"}, {\"title\": \"Storybook Preview Auto Docs Override Mdx Container\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { MDXProvider } from '@mdx-js/react';\\n\\nimport { DocsContainer } from '@storybook/addon-docs/blocks';\\n\\nimport * as DesignSystem from 'your-design-system';\\n\\nexport const MyDocsContainer = (props) => (\\n <MDXProvider\\n components={{\\n h1: DesignSystem.H1,\\n h2: DesignSystem.H2,\\n }}\\n >\\n <DocsContainer {...props} />\\n </MDXProvider>\\n);\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n container: MyDocsContainer,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { MDXProvider } from '@mdx-js/react';\\n\\nimport { DocsContainer } from '@storybook/addon-docs/blocks';\\n\\nimport * as DesignSystem from 'your-design-system';\\n\\nexport const MyDocsContainer = (props) => (\\n <MDXProvider\\n components={{\\n h1: DesignSystem.H1,\\n h2: DesignSystem.H2,\\n }}\\n >\\n <DocsContainer {...props} />\\n </MDXProvider>\\n);\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n container: MyDocsContainer,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 478]\"}, {\"title\": \"Storybook Preview Auto Docs Override Theme\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { themes, ensure } from 'storybook/theming';\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n theme: ensure(themes.dark), // The replacement theme to use\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { themes, ensure } from 'storybook/theming';\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n docs: {\\n theme: ensure(themes.dark), // The replacement theme to use\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 479]\"}, {\"title\": \"Storybook Preview Body Example\", \"description\": null, \"content\": {\"root\": [\"```\\n<div id=\\\"custom-root\\\"></div>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 480]\"}, {\"title\": \"Storybook Preview Body Font Size\", \"description\": null, \"content\": {\"root\": [\"```\\n<style>\\n html {\\n font-size: 15px;\\n }\\n</style>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 481]\"}, {\"title\": \"Storybook Preview Compodoc Config\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/angular';\\nimport { setCompodocJson } from '@storybook/addon-docs/angular';\\n\\nimport docJson from '../documentation.json'; // The path to your generated json file from Compodoc contains all your documentation information.\\n\\nsetCompodocJson(docJson);\\n\\nconst preview: Preview = {\\n parameters: {\\n actions: { argTypesRegex: '^on[A-Z].*' },\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 482]\"}, {\"title\": \"Storybook Preview Configure Globaltypes\", \"description\": null, \"content\": {\"root\": [\"```\\nconst preview = {\\n globalTypes: {\\n theme: {\\n description: 'Global theme for components',\\n toolbar: {\\n // The label to show for this toolbar item\\n title: 'Theme',\\n icon: 'circlehollow',\\n // Array of plain string values or MenuItem shape (see below)\\n items: ['light', 'dark'],\\n // Change title based on selected value\\n dynamicTitle: true,\\n },\\n },\\n },\\n initialGlobals: {\\n theme: 'light',\\n },\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n globalTypes: {\\n theme: {\\n description: 'Global theme for components',\\n toolbar: {\\n // The label to show for this toolbar item\\n title: 'Theme',\\n icon: 'circlehollow',\\n // Array of plain string values or MenuItem shape (see below)\\n items: ['light', 'dark'],\\n // Change title based on selected value\\n dynamicTitle: true,\\n },\\n },\\n },\\n initialGlobals: {\\n theme: 'light',\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 483]\"}, {\"title\": \"Storybook Preview Custom Canvas\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { MyCanvas } from './MyCanvas';\\n\\nexport default {\\n parameters: {\\n docs: {\\n components: {\\n Canvas: MyCanvas,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { MyCanvas } from './MyCanvas';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n components: {\\n Canvas: MyCanvas,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 484]\"}, {\"title\": \"Storybook Preview Custom Code Renderer\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { CodeBlock } from './CodeBlock';\\n\\nexport default {\\n parameters: {\\n docs: {\\n components: {\\n code: CodeBlock,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { CodeBlock } from './CodeBlock';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n components: {\\n code: CodeBlock,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 485]\"}, {\"title\": \"Storybook Preview Custom Elements Config\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { setCustomElementsManifest } from '@storybook/web-components-vite';\\n\\nimport customElements from '../custom-elements.json';\\n\\nsetCustomElementsManifest(customElements);\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n```\", \"```\\nimport type { Preview } from '@storybook/web-components-vite';\\n\\nimport { setCustomElementsManifest } from '@storybook/web-components-vite';\\n\\nimport customElements from '../custom-elements.json';\\n\\nsetCustomElementsManifest(customElements);\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/i,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 486]\"}, {\"title\": \"Storybook Preview Custom Metadata\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { setJSONDoc } from '@storybook/addon-docs/ember';\\n\\nimport docJson from '../dist/storybook-docgen/index.json';\\nsetJSONDoc(docJson);\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 487]\"}, {\"title\": \"Storybook Preview Custom Params\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'red', value: '#f00' },\\n { name: 'green', value: '#0f0' },\\n ],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'red', value: '#f00' },\\n { name: 'green', value: '#0f0' },\\n ],\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 488]\"}, {\"title\": \"Storybook Preview Custom Toc\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n docs: {\\n toc: {\\n contentsSelector: '.sbdocs-content',\\n headingSelector: 'h1, h2, h3',\\n ignoreSelector: '#primary',\\n title: 'Table of Contents',\\n disable: false,\\n unsafeTocbotOptions: {\\n orderedList: false,\\n },\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n toc: {\\n contentsSelector: '.sbdocs-content',\\n headingSelector: 'h1, h2, h3',\\n ignoreSelector: '#primary',\\n title: 'Table of Contents',\\n disable: false,\\n unsafeTocbotOptions: {\\n orderedList: false,\\n },\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 489]\"}, {\"title\": \"Storybook Preview Doc Blocks Controls Exclude Prop\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n controls: { exclude: ['style'] },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 490]\"}, {\"title\": \"Storybook Preview Docs Dark Theme\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { themes } from 'storybook/theming';\\n\\nexport default {\\n parameters: {\\n docs: {\\n theme: themes.dark,\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { themes } from 'storybook/theming';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n theme: themes.dark,\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 491]\"}, {\"title\": \"Storybook Preview Empty Sort Object\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n options: {\\n storySort: {\\n method: '',\\n order: [],\\n locales: '',\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n options: {\\n storySort: {\\n method: '',\\n order: [],\\n locales: '',\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 492]\"}, {\"title\": \"Storybook Preview Enable Toc\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n docs: {\\n toc: true, // \\ud83d\\udc48 Enables the table of contents\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n toc: true, // \\ud83d\\udc48 Enables the table of contents\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 493]\"}, {\"title\": \"Storybook Preview Expanded Controls\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n controls: { expanded: true },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: { expanded: true },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 494]\"}, {\"title\": \"Storybook Preview Extended Theme Variables\", \"description\": null, \"content\": {\"root\": [\"```\\naddonActionsTheme: {\\n ...chromeLight,\\n BASE_FONT_FAMILY: typography.fonts.mono,\\n BASE_BACKGROUND_COLOR: 'transparent',\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 495]\"}, {\"title\": \"Storybook Preview Global Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nconst preview: Preview = {\\n decorators: [componentWrapperDecorator((story) => `<div style=\\\"margin: 3em\\\">${story}</div>`)],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport React from 'react';\\n\\nexport default {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nexport default {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport type { Preview } from 'storybook-solidjs-vite';\\n\\nconst preview: Preview = {\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nexport default { decorators: [() => MarginDecorator] };\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nconst preview: Preview = {\\n decorators: [() => MarginDecorator],\\n};\\n\\nexport default preview;\\n```\", \"```\\nexport default {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\n```\", \"```\\nimport type { Preview } from '@storybook/vue3-vite';\\n\\nconst preview: Preview = {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\nexport default preview;\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n```\", \"```\\nimport type { Preview } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst preview: Preview = {\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 496]\"}, {\"title\": \"Storybook Preview Global Loader\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n loaders: [\\n async () => ({\\n currentUser: await (await fetch('https://jsonplaceholder.typicode.com/users/1')).json(),\\n }),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n loaders: [\\n async () => ({\\n currentUser: await (await fetch('https://jsonplaceholder.typicode.com/users/1')).json(),\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 497]\"}, {\"title\": \"Storybook Preview Global Parameters\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'red', value: '#f00' },\\n { name: 'green', value: '#0f0' },\\n ],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n backgrounds: {\\n values: [\\n { name: 'red', value: '#f00' },\\n { name: 'green', value: '#0f0' },\\n ],\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 498]\"}, {\"title\": \"Storybook Preview Head Example\", \"description\": null, \"content\": {\"root\": [\"```\\n<!--\\nPull in static files served from your Static directory or the internet\\nExample:\\n`main.js|ts` is configured with staticDirs: ['../public'] and your font is located in the `fonts`\\ndirectory inside your `public` directory\\n-->\\n<link rel=\\\"preload\\\" href=\\\"/fonts/my-font.woff2\\\" />\\n\\n<!-- Or you can load custom head-tag JavaScript: -->\\n<script src=\\\"https://use.typekit.net/xxxyyy.js\\\"></script>\\n<script>\\n try {\\n Typekit.load();\\n } catch (e) {}\\n</script>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 499]\"}, {\"title\": \"Storybook Preview Head Import Global Styles\", \"description\": null, \"content\": {\"root\": [\"```\\n<!-- Loads a font from a CDN -->\\n<link rel=\\\"preconnect\\\" href=\\\"https://fonts.googleapis.com\\\" />\\n<link rel=\\\"preconnect\\\" href=\\\"https://fonts.gstatic.com\\\" crossorigin />\\n<link\\n href=\\\"https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap\\\"\\n rel=\\\"stylesheet\\\"\\n/>\\n<!-- Load your CSS file -->\\n<link rel=\\\"stylesheet\\\" href=\\\"path/to/your/styles.css\\\" />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 500]\"}, {\"title\": \"Storybook Preview Import Global Styles\", \"description\": null, \"content\": {\"root\": [\"```\\nimport '../src/styles/global.css';\\n\\nexport default {\\n parameters: {},\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport '../src/styles/global.css';\\n\\nconst preview: Preview = {\\n parameters: {},\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 501]\"}, {\"title\": \"Storybook Preview Layout Param\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 502]\"}, {\"title\": \"Storybook Preview Locales Globaltype\", \"description\": null, \"content\": {\"root\": [\"```\\nconst preview = {\\n globalTypes: {\\n locale: {\\n description: 'Internationalization locale',\\n toolbar: {\\n icon: 'globe',\\n items: [\\n { value: 'en', right: '\\ud83c\\uddfa\\ud83c\\uddf8', title: 'English' },\\n { value: 'fr', right: '\\ud83c\\uddeb\\ud83c\\uddf7', title: 'Fran\\u00e7ais' },\\n { value: 'es', right: '\\ud83c\\uddea\\ud83c\\uddf8', title: 'Espa\\u00f1ol' },\\n { value: 'zh', right: '\\ud83c\\udde8\\ud83c\\uddf3', title: '\\u4e2d\\u6587' },\\n { value: 'kr', right: '\\ud83c\\uddf0\\ud83c\\uddf7', title: '\\ud55c\\uad6d\\uc5b4' },\\n ],\\n },\\n },\\n },\\n initialGlobals: {\\n locale: 'en',\\n },\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n globalTypes: {\\n locale: {\\n description: 'Internationalization locale',\\n toolbar: {\\n icon: 'globe',\\n items: [\\n { value: 'en', right: '\\ud83c\\uddfa\\ud83c\\uddf8', title: 'English' },\\n { value: 'fr', right: '\\ud83c\\uddeb\\ud83c\\uddf7', title: 'Fran\\u00e7ais' },\\n { value: 'es', right: '\\ud83c\\uddea\\ud83c\\uddf8', title: 'Espa\\u00f1ol' },\\n { value: 'zh', right: '\\ud83c\\udde8\\ud83c\\uddf3', title: '\\u4e2d\\u6587' },\\n { value: 'kr', right: '\\ud83c\\uddf0\\ud83c\\uddf7', title: '\\ud55c\\uad6d\\uc5b4' },\\n ],\\n },\\n },\\n },\\n initialGlobals: {\\n locale: 'en',\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 503]\"}, {\"title\": \"Storybook Preview Matching Argtypes\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n actions: { argTypesRegex: '^on.*' },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n actions: { argTypesRegex: '^on.*' },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 504]\"}, {\"title\": \"Storybook Preview Optout Inline\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n docs: {\\n // Opt-out of inline rendering\\n story: { inline: false },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n docs: {\\n // Opt-out of inline rendering\\n story: { inline: false },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 505]\"}, {\"title\": \"Storybook Preview Parameters Color Swatches\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n controls: {\\n presetColors: [{ color: '#ff4785', title: 'Coral' }, 'rgba(0, 159, 183, 1)', '#fe4a49'],\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n presetColors: [{ color: '#ff4785', title: 'Coral' }, 'rgba(0, 159, 183, 1)', '#fe4a49'],\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 506]\"}, {\"title\": \"Storybook Preview Prepareforinline\", \"description\": null, \"content\": {\"root\": [\"```\\nimport React from 'react';\\nimport { render } from 'react-dom';\\nimport toReact from '@egoist/vue-to-react';\\n\\nexport default {\\n parameters: {\\n docs: {\\n // deprecated do not use\\n },\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 507]\"}, {\"title\": \"Storybook Preview Register Language Globally\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { PrismLight as SyntaxHighlighter } from 'react-syntax-highlighter';\\nimport scss from 'react-syntax-highlighter/dist/esm/languages/prism/scss';\\n\\n// Registers and enables scss language support\\nSyntaxHighlighter.registerLanguage('scss', scss);\\n\\nexport default {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { PrismLight as SyntaxHighlighter } from 'react-syntax-highlighter';\\nimport scss from 'react-syntax-highlighter/dist/esm/languages/prism/scss';\\n\\n// Registers and enables scss language support\\nSyntaxHighlighter.registerLanguage('scss', scss);\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 508]\"}, {\"title\": \"Storybook Preview Sort Function\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n options: {\\n storySort: (a, b) =>\\n a.id === b.id ? 0 : a.id.localeCompare(b.id, undefined, { numeric: true }),\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n options: {\\n // The `a` and `b` arguments in this function have a type of `import('storybook/internal/types').IndexEntry`. Remember that the function is executed in a JavaScript environment, so use JSDoc for IntelliSense to introspect it.\\n storySort: (a, b) =>\\n a.id === b.id ? 0 : a.id.localeCompare(b.id, undefined, { numeric: true }),\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 509]\"}, {\"title\": \"Storybook Preview Use Global Type\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/angular';\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nconst preview: Preview = {\\n decorators: [\\n componentWrapperDecorator(\\n (story) => `<div [class]=\\\"myTheme\\\">${story}</div>`,\\n ({ globals }) => {\\n return { myTheme: globals['theme'] };\\n }\\n ),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { MyThemes } from '../my-theme-folder/my-theme-file';\\n\\nconst preview = {\\n decorators: [\\n (story, context) => {\\n const selectedTheme = context.globals.theme || 'light';\\n const theme = MyThemes[selectedTheme];\\n // Your theme provider and other context providers goes in the return statement\\n return;\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { MyThemes } from '../my-theme-folder/my-theme-file';\\n\\nconst preview: Preview = {\\n decorators: [\\n (story, context) => {\\n const selectedTheme = context.globals.theme || 'light';\\n const theme = MyThemes[selectedTheme];\\n // Your theme provider and other context providers goes in the return statement\\n return;\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { ThemeProvider } from 'styled-components';\\n\\nimport { MyThemes } from '../my-theme-folder/my-theme-file';\\n\\nconst preview = {\\n decorators: [\\n (Story, context) => {\\n const theme = MyThemes[context.globals.theme];\\n return (\\n <ThemeProvider theme={theme}>\\n <Story />\\n </ThemeProvider>\\n );\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { ThemeProvider } from 'styled-components';\\n\\nimport { MyThemes } from '../my-theme-folder/my-theme-file';\\n\\nconst preview: Preview = {\\n decorators: [\\n (Story, context) => {\\n const theme = MyThemes[context.globals.theme];\\n return (\\n <ThemeProvider theme={theme}>\\n <Story />\\n </ThemeProvider>\\n );\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { setup } from '@storybook/vue3-vite';\\n\\nimport { VApp } from 'vuetify/components';\\n\\nimport { registerPlugins } from '../src/plugins';\\n\\nsetup((app) => {\\n // Registers your app's plugins including Vuetify into Storybook\\n registerPlugins(app);\\n});\\n\\nconst preview = {\\n decorators: [\\n (story, context) => {\\n const theme = context.globals.theme || 'light';\\n return {\\n components: { story, VApp },\\n template: `\\n <v-app theme=\\\"${theme}\\\">\\n <div>\\n <story/>\\n </div>\\n </v-app>\\n `,\\n };\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport type { Preview } from '@storybook/vue3-vite';\\n\\nimport { setup } from '@storybook/vue3-vite';\\n\\nimport { VApp } from 'vuetify/components';\\n\\nimport { registerPlugins } from '../src/plugins';\\n\\nsetup((app) => {\\n // Registers your app's plugins including Vuetify into Storybook\\n registerPlugins(app);\\n});\\n\\nconst preview: Preview = {\\n decorators: [\\n (story, context) => {\\n const theme = context.globals.theme || 'light';\\n return {\\n components: { story, VApp },\\n template: `\\n <v-app theme=\\\"${theme}\\\">\\n <div class=\\\"d-flex\\\">\\n <story/>\\n </div>\\n </v-app>\\n `,\\n };\\n },\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 510]\"}, {\"title\": \"Storybook Preview With Library Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Preview } from '@storybook/angular';\\n\\nimport { setCompodocJson } from '@storybook/addon-docs/angular';\\n\\nimport docJson from '../documentation.json';\\n\\nimport '../src/polyfills';\\n\\nsetCompodocJson(docJson);\\n\\nconst preview: Preview = {\\n parameters: {\\n controls: {\\n matchers: {\\n color: /(background|color)$/i,\\n date: /Date$/,\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport '@angular/localize/init';\\n```\", \"```\\nimport { setup } from '@storybook/vue3-vite';\\n\\nimport { createPinia } from 'pinia';\\n\\nsetup((app) => {\\n //\\ud83d\\udc47 Registers a global Pinia instance inside Storybook to be consumed by existing stories\\n app.use(createPinia());\\n});\\n\\nexport default {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\n```\", \"```\\nimport { setup } from '@storybook/vue3-vite';\\n\\nimport { library } from '@fortawesome/fontawesome-svg-core';\\nimport { faPlusSquare as fasPlusSquare } from '@fortawesome/free-solid-svg-icons';\\n\\nimport { FontAwesomeIcon } from '@fortawesome/vue-fontawesome';\\n\\nsetup((app) => {\\n //\\ud83d\\udc47 Adds the icon to the library so you can use it in your story.\\n library.add(fasPlusSquare);\\n app.component('font-awesome-icon', FontAwesomeIcon);\\n});\\n\\nexport default {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\n```\", \"```\\nimport { setup, Preview } from '@storybook/vue3-vite';\\n\\nimport { createPinia } from 'pinia';\\n\\nsetup((app) => {\\n //\\ud83d\\udc47 Registers a global Pinia instance inside Storybook to be consumed by existing stories\\n app.use(createPinia());\\n});\\n\\nconst preview: Preview = {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { setup, Preview } from '@storybook/vue3-vite';\\n\\nimport { library } from '@fortawesome/fontawesome-svg-core';\\nimport { faPlusSquare as fasPlusSquare } from '@fortawesome/free-solid-svg-icons';\\n\\nimport { FontAwesomeIcon } from '@fortawesome/vue-fontawesome';\\n\\nsetup((app) => {\\n //\\ud83d\\udc47 Adds the icon to the library so you can use it in your story.\\n library.add(fasPlusSquare);\\n app.component('font-awesome-icon', FontAwesomeIcon);\\n});\\n\\nconst preview: Preview = {\\n decorators: [\\n (story) => ({\\n components: { story },\\n template: '<div style=\\\"margin: 3em;\\\"><story /></div>',\\n }),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 511]\"}, {\"title\": \"Storybook Preview With Ordered Pages And Wildcard\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n options: {\\n storySort: {\\n order: ['Intro', 'Pages', ['Home', 'Login', 'Admin'], 'Components', '*', 'WIP'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n options: {\\n storySort: {\\n order: ['Intro', 'Pages', ['Home', 'Login', 'Admin'], 'Components', '*', 'WIP'],\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 512]\"}, {\"title\": \"Storybook Preview With Ordered Pages\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n parameters: {\\n options: {\\n storySort: {\\n order: ['Intro', 'Pages', ['Home', 'Login', 'Admin'], 'Components'],\\n },\\n },\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n parameters: {\\n options: {\\n storySort: {\\n order: ['Intro', 'Pages', ['Home', 'Login', 'Admin'], 'Components'],\\n },\\n },\\n },\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 513]\"}, {\"title\": \"Storybook Preview With Styled Components Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { componentWrapperDecorator } from '@storybook/angular';\\nimport type { Preview } from '@storybook/angular';\\n\\nimport { ThemeProvider } from './theme-provider.component';\\n\\nconst preview: Preview = {\\n decorators: [\\n moduleMetadata({ declarations: [ThemeProvider] }),\\n componentWrapperDecorator(\\n (story) => `<theme-provider class=\\\"default\\\">${story}</theme-provider>`\\n ),\\n ],\\n};\\nexport default preview;\\n\\n// or with globals of story context\\nconst preview: Preview = {\\n decorators: [\\n moduleMetadata({ declarations: [ThemeProvider] }),\\n componentWrapperDecorator(\\n (story) => `<theme-provider [class]=\\\"theme\\\">${story}</theme-provider>`,\\n ({ globals }) => ({ theme: globals.theme })\\n ),\\n ],\\n};\\nexport default preview;\\n```\", \"```\\nimport React from 'react';\\n\\nimport { ThemeProvider } from 'styled-components';\\n\\nexport default {\\n decorators: [\\n (Story) => (\\n <ThemeProvider theme=\\\"default\\\">\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </ThemeProvider>\\n ),\\n ],\\n};\\n```\", \"```\\nimport React from 'react';\\n\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { ThemeProvider } from 'styled-components';\\n\\nconst preview: Preview = {\\n decorators: [\\n (Story) => (\\n <ThemeProvider theme=\\\"default\\\">\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </ThemeProvider>\\n ),\\n ],\\n};\\n\\nexport default preview;\\n```\", \"```\\nimport { ThemeProvider } from 'solid-styled-components';\\n\\nconst theme = {\\n colors: {\\n primary: 'hotpink',\\n },\\n};\\n\\nexport const decorators = [\\n (Story) => (\\n <ThemeProvider theme={theme}>\\n <Story />\\n </ThemeProvider>\\n ),\\n];\\n```\", \"```\\nimport type { Preview } from 'storybook-solidjs-vite';\\n\\nimport { ThemeProvider, DefaultTheme } from 'solid-styled-components';\\n\\nconst theme: DefaultTheme = {\\n colors: {\\n primary: 'hotpink',\\n },\\n};\\n\\nconst preview: Preview = {\\n decorators: [\\n (Story) => (\\n <ThemeProvider theme={theme}>\\n <Story />\\n </ThemeProvider>\\n ),\\n ],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 514]\"}, {\"title\": \"Storybook Read Environment Variables\", \"description\": null, \"content\": {\"root\": [\"```\\nconsole.log(process.env.STORYBOOK_THEME);\\nconsole.log(process.env.STORYBOOK_DATA_KEY);\\n```\", \"```\\nconsole.log(import.meta.env.STORYBOOK_THEME);\\nconsole.log(import.meta.env.STORYBOOK_DATA_KEY);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 515]\"}, {\"title\": \"Storybook Remove Command\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest remove @storybook/addon-a11y\\n```\", \"```\\npnpm dlx storybook@latest remove @storybook/addon-a11y\\n```\", \"```\\nyarn dlx storybook@latest remove @storybook/addon-a11y\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 516]\"}, {\"title\": \"Storybook Run Dev\", \"description\": null, \"content\": {\"root\": [\"```\\nng run my-project:storybook\\n```\", \"```\\nnpm run storybook\\n```\", \"```\\npnpm run storybook\\n```\", \"```\\nyarn storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 517]\"}, {\"title\": \"Storybook Server Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { sync } from 'read-pkg-up';\\n\\nexport default {\\n packageJson: sync({ cwd: process.cwd() }).packageJson,\\n framework: 'my-framework',\\n frameworkPath: '@my-framework/storybook',\\n frameworkPresets: [import.meta.resolve('./framework-preset-my-framework.js')],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 518]\"}, {\"title\": \"Storybook Server Options\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { sync } from 'read-pkg-up';\\n\\nexport default {\\n packageJson: sync({ cwd: process.cwd() }).packageJson,\\n framework: 'vue',\\n frameworkPresets: [import.meta.resolve('./framework-preset-vue.js')],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 519]\"}, {\"title\": \"Storybook Start Dev Server\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { buildDev } from '@storybook/core/server';\\n\\nimport options from './options';\\n\\nbuildDev(options);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 520]\"}, {\"title\": \"Storybook Story Layout Param\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const WithLayout: Story = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"WithLayout\\\"\\n parameters={{\\n layout: 'centered',\\n }}\\n/>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const WithLayout = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const WithLayout = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<Story\\n name=\\\"WithLayout\\\"\\n parameters={{\\n layout: 'centered',\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithLayout: Story = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const WithLayout: Story = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\nexport default {\\n component: 'demo-button',\\n};\\n\\nexport const WithLayout = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const WithLayout: Story = {\\n parameters: {\\n layout: 'centered',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 521]\"}, {\"title\": \"Storybook Storyloading With Directory\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n // \\ud83d\\udc47 Storybook will load all existing stories within the MyStories folder\\n stories: ['../packages/MyStories'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n // \\ud83d\\udc47 Storybook will load all existing stories within the MyStories folder\\n stories: ['../packages/MyStories'],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 522]\"}, {\"title\": \"Storybook Storysource Manager Entries\", \"description\": null, \"content\": {\"root\": [\"```\\n/* nothing needed */\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 523]\"}, {\"title\": \"Storybook Telemetry Crash Report Event\", \"description\": null, \"content\": {\"root\": [\"```\\n{\\n stack: 'Error: Your button is not working\\\\n' +\\n ' at Object.<anonymous> ($SNIP/test.js:39:27)\\\\n' +\\n ' at Module._compile (node:internal/modules/cjs/loader:1103:14)\\\\n' +\\n ' at Object.Module._extensions..js (node:internal/modules/cjs/loader:1157:10)\\\\n' +\\n ' at Module.load (node:internal/modules/cjs/loader:981:32)\\\\n' +\\n ' at Function.Module._load (node:internal/modules/cjs/loader:822:12)\\\\n' +\\n ' at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:77:12)\\\\n' +\\n ' at node:internal/main/run_main_module:17:47',\\n message: 'Your button is not working'\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 524]\"}, {\"title\": \"Storybook Telemetry Main Enable Crash Reports\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n enableCrashReports: true, // \\ud83d\\udc48 Appends the crash reports to the telemetry events\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n core: {\\n enableCrashReports: true, // \\ud83d\\udc48 Appends the crash reports to the telemetry events\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 525]\"}, {\"title\": \"Storybook Telemetry Preview Event\", \"description\": null, \"content\": {\"root\": [\"```\\nSTORYBOOK_TELEMETRY_DEBUG=1 npm run storybook\\n```\", \"```\\nSTORYBOOK_TELEMETRY_DEBUG=1 yarn storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 526]\"}, {\"title\": \"Storybook Telemetry Storybook Enable Crash Reports Env\", \"description\": null, \"content\": {\"root\": [\"```\\nSTORYBOOK_ENABLE_CRASH_REPORTS=1 yarn storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 527]\"}, {\"title\": \"Storybook Telemetry Storybook Enable Crash Reports Flag\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run storybook -- --enable-crash-reports\\n```\", \"```\\npnpm run storybook --enable-crash-reports\\n```\", \"```\\nyarn storybook --enable-crash-reports\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 528]\"}, {\"title\": \"Storybook Test Fn Mock Spy\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nimport NoteUI from './note-ui';\\n\\nconst meta: Meta<NoteUI> = { component: NoteUI };\\nexport default meta;\\n\\ntype Story = StoryObj<NoteUI>;\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow: Story = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect } from 'storybook/test';\\n\\n // \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\n import { saveNote } from '../app/actions';\\n import { createNotes } from '../app/mocks/notes';\\n\\n import NoteUI from './note-ui.svelte';\\n\\n const meta = defineMeta({\\n title: 'Mocked/NoteUI',\\n component: NoteUI,\\n });\\n</script>\\n\\n<script>\\n const notes = createNotes();\\n</script>\\n\\n<Story name=\\\"Save Flow \\u25b6\\\"\\n args={{ isEditing: true, note: notes[0] }}\\n play={async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n }} />\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nimport NoteUI from './note-ui.svelte';\\n\\nexport default {\\n title: 'Mocked/NoteUI',\\n component: NoteUI,\\n};\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nimport NoteUI from './note-ui';\\n\\nexport default { component: NoteUI };\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import { expect } from 'storybook/test';\\n\\n // \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\n import { saveNote } from '../app/actions';\\n import { createNotes } from '../app/mocks/notes';\\n\\n import NoteUI from './note-ui.svelte';\\n\\n const meta = defineMeta({\\n title: 'Mocked/NoteUI',\\n component: NoteUI,\\n });\\n</script>\\n\\n<script>\\n const notes = createNotes();\\n</script>\\n\\n<Story name=\\\"Save Flow \\u25b6\\\"\\n args={{ isEditing: true, note: notes[0] }}\\n play={async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n }} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nimport NoteUI from './note-ui.svelte';\\n\\nconst meta = {\\n title: 'Mocked/NoteUI',\\n component: NoteUI,\\n} satisfies Meta<typeof NoteUI>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow: Story = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nimport NoteUI from './note-ui';\\n\\nconst meta = { component: NoteUI } satisfies Meta<typeof NoteUI>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow: Story = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nexport default {\\n component: 'note-ui',\\n};\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { expect } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../app/__mocks__/actions'\\nimport { saveNote } from '../app/actions';\\nimport { createNotes } from '../app/mocks/notes';\\n\\nconst meta: Meta = {\\n component: 'note-ui',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nconst notes = createNotes();\\n\\nexport const SaveFlow: Story = {\\n name: 'Save Flow \\u25b6',\\n args: {\\n isEditing: true,\\n note: notes[0],\\n },\\n play: async ({ canvas, userEvent }) => {\\n const saveButton = canvas.getByRole('menuitem', { name: /done/i });\\n await userEvent.click(saveButton);\\n // \\ud83d\\udc47 This is the mock function, so you can assert its behavior\\n await expect(saveNote).toHaveBeenCalled();\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 529]\"}, {\"title\": \"Storybook Test Mock File Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { fn } from 'storybook/test';\\nimport * as actual from './session';\\n\\nexport * from './session';\\nexport const getUserFromSession = fn(actual.getUserFromSession).mockName('getUserFromSession');\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 530]\"}, {\"title\": \"Storybook Test Mock Return Value\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\nimport { mocked } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nimport { Page } from './Page';\\n\\nconst meta: Meta<Page> = {\\n component: Page,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Page>;\\n\\nexport const Default: Story = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n mocked(getUserFromSession).mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n // \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\n import { getUserFromSession } from '../lib/session';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" beforeEach={() => {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n getUserFromSession.mockReturnValue({ id: '1', name: 'Alice' });\\n}} />\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nimport Page from './Page.svelte';\\n\\nexport default {\\n component: Page,\\n};\\n\\nexport const Default = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n getUserFromSession.mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n};\\n\\nexport const Default = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n getUserFromSession.mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { mocked } from 'storybook/test';\\n\\n // \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\n import { getUserFromSession } from '../lib/session';\\n\\n import Page from './Page.svelte';\\n\\n const meta = defineMeta({\\n component: Page,\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" beforeEach={() => {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n mocked(getUserFromSession).mockReturnValue({ id: '1', name: 'Alice' });\\n}} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { mocked } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nimport Page from './Page.svelte';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n mocked(getUserFromSession).mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\nimport { mocked } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nimport { Page } from './Page';\\n\\nconst meta = {\\n component: Page,\\n} satisfies Meta<typeof Page>;\\n\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Default: Story = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n mocked(getUserFromSession).mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nexport default {\\n component: 'my-page',\\n};\\n\\nexport const Default = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n getUserFromSession.mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\nimport { mocked } from 'storybook/test';\\n\\n// \\ud83d\\udc47 Automocked module resolves to '../lib/__mocks__/session'\\nimport { getUserFromSession } from '../lib/session';\\n\\nconst meta: Meta = {\\n component: 'my-page',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Default: Story = {\\n async beforeEach() {\\n // \\ud83d\\udc47 Set the return value for the getUserFromSession function\\n mocked(getUserFromSession).mockReturnValue({ id: '1', name: 'Alice' });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 531]\"}, {\"title\": \"Storybook Test With Storyname\", \"description\": null, \"content\": {\"root\": [\"```\\nit('should format CSF exports with sensible defaults', () => {\\n const testCases = {\\n name: 'Name',\\n someName: 'Some Name',\\n someNAME: 'Some NAME',\\n some_custom_NAME: 'Some Custom NAME',\\n someName1234: 'Some Name 1234',\\n someName1_2_3_4: 'Some Name 1 2 3 4',\\n };\\n Object.entries(testCases).forEach(([key, val]) => {\\n expect(storyNameFromExport(key)).toBe(val);\\n });\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 532]\"}, {\"title\": \"Storybook Theme Example Variables\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { create } from 'storybook/theming';\\n\\nexport default create({\\n base: 'light',\\n brandTitle: 'My custom Storybook',\\n brandUrl: 'https://example.com',\\n brandImage: 'https://storybook.js.org/images/placeholders/350x150.png',\\n brandTarget: '_self',\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 533]\"}, {\"title\": \"Storybook Theming Styled Import\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { styled } from 'storybook/theming';\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 534]\"}, {\"title\": \"Storybook Upgrade Prerelease\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@next upgrade\\n```\", \"```\\npnpm dlx storybook@next upgrade\\n```\", \"```\\nyarn dlx storybook@next upgrade\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 535]\"}, {\"title\": \"Storybook Upgrade To Prior Major\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@^7 upgrade\\n```\", \"```\\npnpm dlx storybook@^7 upgrade\\n```\", \"```\\nyarn dlx storybook@^7 upgrade\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 536]\"}, {\"title\": \"Storybook Upgrade\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@next upgrade\\n```\", \"```\\npnpm dlx storybook@next upgrade\\n```\", \"```\\nyarn dlx storybook@next upgrade\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 537]\"}, {\"title\": \"Storybook Vite Builder Aliasing\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs'],\\n core: {\\n builder: '@storybook/builder-vite',\\n },\\n async viteFinal(config) {\\n // Merge custom configuration into the default config\\n const { mergeConfig } = await import('vite');\\n\\n return mergeConfig(config, {\\n // Add dependencies to pre-optimization\\n optimizeDeps: {\\n include: ['storybook-dark-mode'],\\n },\\n });\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 538]\"}, {\"title\": \"Storybook Vite Builder Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install @storybook/builder-vite --save-dev\\n```\", \"```\\npnpm add --save-dev @storybook/builder-vite\\n```\", \"```\\nyarn add --dev @storybook/builder-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 539]\"}, {\"title\": \"Storybook Vite Builder Jest Mock\", \"description\": null, \"content\": {\"root\": [\"```\\n<script>\\n window.global = window;\\n</script>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 540]\"}, {\"title\": \"Storybook Vite Builder React Docgen\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs'],\\n core: {\\n builder: '@storybook/builder-vite',\\n },\\n typescript: {\\n // Enables the `react-docgen-typescript` parser.\\n // See https://storybook.js.org/docs/api/main-config/main-config-typescript for more information about this option.\\n reactDocgen: 'react-docgen-typescript',\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 541]\"}, {\"title\": \"Storybook Vite Builder Register\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n addons: ['@storybook/addon-docs'],\\n core: {\\n builder: '@storybook/builder-vite', // \\ud83d\\udc48 The builder enabled here.\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 542]\"}, {\"title\": \"Storybook Vite Builder Ts Configure\", \"description\": null, \"content\": {\"root\": [\"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs-vite, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async viteFinal(config, options) {\\n // Add your configuration here\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 543]\"}, {\"title\": \"Subpath Imports Config\", \"description\": null, \"content\": {\"root\": [\"```\\n{\\n \\\"imports\\\": {\\n \\\"#api\\\": {\\n // storybook condition applies to Storybook\\n \\\"storybook\\\": \\\"./api.mock.ts\\\",\\n \\\"default\\\": \\\"./api.ts\\\",\\n },\\n \\\"#app/actions\\\": {\\n \\\"storybook\\\": \\\"./app/actions.mock.ts\\\",\\n \\\"default\\\": \\\"./app/actions.ts\\\",\\n },\\n \\\"#lib/session\\\": {\\n \\\"storybook\\\": \\\"./lib/session.mock.ts\\\",\\n \\\"default\\\": \\\"./lib/session.ts\\\",\\n },\\n \\\"#lib/db\\\": {\\n // test condition applies to test environments *and* Storybook\\n \\\"test\\\": \\\"./lib/db.mock.ts\\\",\\n \\\"default\\\": \\\"./lib/db.ts\\\",\\n },\\n \\\"#*\\\": [\\\"./*\\\", \\\"./*.ts\\\", \\\"./*.tsx\\\"],\\n },\\n}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 544]\"}, {\"title\": \"Svelte Csf Addon Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@latest add @storybook/addon-svelte-csf\\n```\", \"```\\npnpm dlx storybook@latest add @storybook/addon-svelte-csf\\n```\", \"```\\nyarn storybook@latest add @storybook/addon-svelte-csf\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 545]\"}, {\"title\": \"Svelte Csf Addon Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Other configuration\\n addons: [\\n {\\n name: '@storybook/addon-svelte-csf',\\n options: {\\n legacyTemplate: true, // Enables the legacy template syntax\\n },\\n },\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the name of your Svelte framework\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n // Other configuration\\n addons: [\\n {\\n name: '@storybook/addon-svelte-csf',\\n options: {\\n legacyTemplate: true, // Enables the legacy template syntax\\n },\\n },\\n ],\\n};\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 546]\"}, {\"title\": \"Svelte Csf Addon Tags\", \"description\": null, \"content\": {\"root\": [\"```\\n<script>\\n import { Meta, Template, Story } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n</script>\\n\\n<Meta title=\\\"MyComponent\\\" component={MyComponent} />\\n\\n<Template let:args>\\n <MyComponent {...args} />\\n</Template>\\n\\n<Story name=\\\"Default\\\" autodocs />\\n```\", \"```\\n\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n\\n</script>\\n\\n<Story name=\\\"Default\\\" tags={['autodocs']} />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 547]\"}, {\"title\": \"Svelte Csf Story Custom Children\", \"description\": null, \"content\": {\"root\": [\"```\\n<script>\\n import { Meta, Template, Story } from '@storybook/addon-svelte-csf';\\n\\n import OuterComponent from './OuterComponent.svelte';\\n import MyComponent from './MyComponent.svelte';\\n</script>\\n\\n<Meta title=\\\"MyComponent\\\" component={MyComponent} />\\n\\n<Template let:args>\\n <OuterComponent>\\n <MyComponent />\\n </OuterComponent>\\n</Template>\\n\\n<Story name=\\\"Default\\\" />\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import OuterComponent from './OuterComponent.svelte';\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n\\n</script>\\n\\n<Story name=\\\"Default\\\">\\n <OuterComponent>\\n <MyComponent />\\n </OuterComponent>\\n</Story>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 548]\"}, {\"title\": \"Svelte Csf Story Migration\", \"description\": null, \"content\": {\"root\": [\"```\\n<script>\\n import { Meta, Story } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n</script>\\n\\n\\n<Meta title=\\\"MyComponent\\\" component={MyComponent} />\\n\\n<Story name=\\\"Default\\\" />\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n title: 'MyComponent',\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" />\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 549]\"}, {\"title\": \"Svelte Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/svelte-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/svelte-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/svelte-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 550]\"}, {\"title\": \"Svelte Vite Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: {\\n name: '@storybook/svelte-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/svelte-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: {\\n name: '@storybook/svelte-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 551]\"}, {\"title\": \"Svelte Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/svelte-vite\\n```\", \"```\\npnpm add --save-dev @storybook/svelte-vite\\n```\", \"```\\nyarn add --dev @storybook/svelte-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 552]\"}, {\"title\": \"Sveltekit Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/sveltekit', // \\ud83d\\udc48 Add this\\n // svelteOptions: { ... }, \\ud83d\\udc48 Remove this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/sveltekit';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/sveltekit', // \\ud83d\\udc48 Add this\\n // svelteOptions: { ... }, \\ud83d\\udc48 Remove this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 553]\"}, {\"title\": \"Sveltekit Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: {\\n name: '@storybook/sveltekit',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/sveltekit';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: {\\n name: '@storybook/sveltekit',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 554]\"}, {\"title\": \"Sveltekit Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/sveltekit\\n```\", \"```\\npnpm add --save-dev @storybook/sveltekit\\n```\", \"```\\nyarn add --dev @storybook/sveltekit\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 555]\"}, {\"title\": \"Tags Autodocs In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Button } from './Button';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 556]\"}, {\"title\": \"Tags Autodocs In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...rest of preview\\n //\\ud83d\\udc47 Enables auto-generated documentation for all stories\\n tags: ['autodocs'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n // ...rest of preview\\n //\\ud83d\\udc47 Enables auto-generated documentation for all stories\\n tags: ['autodocs'],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 557]\"}, {\"title\": \"Tags Autodocs Remove Component\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { Page } from './Page';\\n\\nconst meta: Meta<Page> = {\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n};\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n });\\n</script>\\n```\", \"```\\nimport Page from './Page.svelte';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\nimport { Page } from './Page';\\n\\nexport default {\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Page from './Page.svelte';\\n\\n const { Story } = defineMeta({\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Page from './Page.svelte';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Page } from './Page';\\n\\nconst meta = {\\n component: Page,\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n} satisfies Meta<typeof Page>;\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Page',\\n component: 'demo-page',\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Page',\\n component: 'demo-page',\\n // \\ud83d\\udc47 Disable auto-generated documentation for this component\\n tags: ['!autodocs'],\\n};\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 558]\"}, {\"title\": \"Tags Autodocs Remove Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Button>;\\n\\nexport const UndocumentedStory: Story = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n });\\n</script>\\n\\n<!--\\ud83d\\udc47 Removes this story from auto-generated documentation -->\\n<Story name=\\\"UndocumentedStory\\\" tags={['!autodocs']} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n\\nexport const UndocumentedStory = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n\\nexport const UndocumentedStory = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n });\\n</script>\\n\\n<!--\\ud83d\\udc47 Removes this story from auto-generated documentation -->\\n<Story name=\\\"UndocumentedStory\\\" tags={['!autodocs']} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const UndocumentedStory: Story = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const UndocumentedStory: Story = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\n\\nexport const UndocumentedStory = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n //\\ud83d\\udc47 Enables auto-generated documentation for this component and includes all stories in this file\\n tags: ['autodocs'],\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const UndocumentedStory: Story = {\\n // \\ud83d\\udc47 Removes this story from auto-generated documentation\\n tags: ['!autodocs'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 559]\"}, {\"title\": \"Tags Combo Example\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Button>;\\n\\nexport const Variant1: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo: Story = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => ({\\n template: `\\n <div>\\n <demo-button [variant]=\\\"1\\\"></demo-button>\\n <demo-button [variant]=\\\"2\\\"></demo-button>\\n </div>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Variant1 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => (\\n <>\\n <Button variant={1} />\\n <Button variant={2} />\\n </>\\n ),\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Variant1: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo: Story = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => (\\n <>\\n <Button variant={1} />\\n <Button variant={2} />\\n </>\\n ),\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Variant1 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => (\\n <>\\n <Button variant={1} />\\n <Button variant={2} />\\n </>\\n ),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Variant1: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo: Story = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => (\\n <>\\n <Button variant={1} />\\n <Button variant={2} />\\n </>\\n ),\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { Button } from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page -->\\n<Story\\n name=\\\"Variant1\\\"\\n tags={['!dev', '!autodocs']}\\n args={{ variant: 1 }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page -->\\n<Story\\n name=\\\"Variant2\\\"\\n tags={['!dev', '!autodocs']}\\n args={{ variant: 2 }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page -->\\n<Story name=\\\"Combo\\\" tags={['!test']}>\\n <Button variant={1}>\\n <Button variant={2}>\\n</Story>\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import { Button } from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page -->\\n<Story\\n name=\\\"Variant1\\\"\\n tags={['!dev', '!autodocs']}\\n args={{ variant: 1 }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page -->\\n<Story\\n name=\\\"Variant2\\\"\\n tags={['!dev', '!autodocs']}\\n args={{ variant: 2 }}\\n/>\\n\\n<!-- \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page -->\\n<Story name=\\\"Combo\\\" tags={['!test']}>\\n <Button variant={1} />\\n <Button variant={2} />\\n</Story>\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n};\\n\\nexport const Variant1 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => ({\\n components: { Button },\\n template: `\\n <div>\\n <Button :variant=\\\"1\\\" />\\n <Button :variant=\\\"2\\\" />\\n </div>\\n `,\\n }),\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Variant1: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo: Story = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => ({\\n components: { Button },\\n template: `\\n <div>\\n <Button :variant=\\\"1\\\" />\\n <Button :variant=\\\"2\\\" />\\n </div>\\n `,\\n }),\\n};\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport const Variant1 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2 = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => html`\\n <div>\\n <demo-button variant=\\\"1\\\" />\\n <demo-button variant=\\\"2\\\" />\\n </div>\\n `,\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\nexport default meta;\\n\\ntype Story = StoryObj;\\n\\nexport const Variant1: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 1 },\\n};\\n\\nexport const Variant2: Story = {\\n // \\ud83d\\udc47 This story will not appear in Storybook's sidebar or docs page\\n tags: ['!dev', '!autodocs'],\\n args: { variant: 2 },\\n};\\n\\nexport const Combo: Story = {\\n // \\ud83d\\udc47 This story should not be tested, but will appear in the sidebar and docs page\\n tags: ['!test'],\\n render: () => html`\\n <div>\\n <demo-button variant=\\\"1\\\" />\\n <demo-button variant=\\\"2\\\" />\\n </div>\\n `,\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 560]\"}, {\"title\": \"Tags Docs Only In Meta\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n};\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n });\\n</script>\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n /*\\n * All stories in this file will:\\n * - Be included in the docs page\\n * - Not appear in Storybook's sidebar\\n */\\n tags: ['autodocs', '!dev'],\\n};\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 561]\"}, {\"title\": \"Tags In Meta And Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n });\\n</script>\\n\\n<!--\\n This particular story will have these tags applied:\\n - experimental\\n - autodocs (inherited from meta)\\n - dev (inherited from meta)\\n - test (inherited from meta)\\n-->\\n<Story name=\\\"ExperimentalFeatureStory\\\" tags={['experimental']} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n });\\n</script>\\n\\n<!--\\n This particular story will have these tags applied:\\n - experimental\\n - autodocs (inherited from meta)\\n - dev (inherited from meta)\\n - test (inherited from meta)\\n-->\\n<Story name=\\\"ExperimentalFeatureStory\\\" tags={['experimental']} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n /*\\n * All stories in this file will have these tags applied:\\n * - autodocs\\n * - dev (implicit default, inherited from preview)\\n * - test (implicit default, inherited from preview)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n /*\\n * This particular story will have these tags applied:\\n * - experimental\\n * - autodocs (inherited from meta)\\n * - dev (inherited from meta)\\n * - test (inherited from meta)\\n */\\n tags: ['experimental'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 562]\"}, {\"title\": \"Tags In Preview\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...rest of preview\\n /*\\n * All stories in your project will have these tags applied:\\n * - autodocs\\n * - dev (implicit default)\\n * - test (implicit default)\\n */\\n tags: ['autodocs'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nconst preview: Preview = {\\n // ...rest of preview\\n /*\\n * All stories in your project will have these tags applied:\\n * - autodocs\\n * - dev (implicit default)\\n * - test (implicit default)\\n */\\n tags: ['autodocs'],\\n};\\n\\nexport default preview;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 563]\"}, {\"title\": \"Tags Remove In Story\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './Button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<Button>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag -->\\n<Story name=\\\"ExperimentalFeatureStory\\\" tags={['!stable', 'experimental']} />\\n```\", \"```\\nimport Button from './Button.svelte';\\n\\nexport default {\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\nimport { Button } from './Button';\\n\\nexport default {\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n });\\n</script>\\n\\n<!-- \\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag -->\\n<Story name=\\\"ExperimentalFeatureStory\\\" tags={['!stable', 'experimental']} />\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport Button from './Button.svelte';\\n\\nconst meta = {\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n} satisfies Meta<typeof Button>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\nexport default {\\n title: 'Button',\\n component: 'demo-button',\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n};\\n\\nexport const ExperimentalFeatureStory = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n // \\ud83d\\udc47 Applies to all stories in this file\\n tags: ['stable'],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const ExperimentalFeatureStory: Story = {\\n //\\ud83d\\udc47 For this particular story, remove the inherited `stable` tag and apply the `experimental` tag\\n tags: ['!stable', 'experimental'],\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 564]\"}, {\"title\": \"Test Runner A11Y Config\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { injectAxe, checkA11y } = require('axe-playwright');\\n\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nmodule.exports = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page) {\\n await checkA11y(page, 'body', {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\nimport { injectAxe, checkA11y } from 'axe-playwright';\\n\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nconst config: TestRunnerConfig = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page) {\\n await checkA11y(page, 'body', {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 565]\"}, {\"title\": \"Test Runner A11Y Configure\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { injectAxe, checkA11y, configureAxe } = require('axe-playwright');\\n\\nconst { getStoryContext } = require('@storybook/test-runner');\\n\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nmodule.exports = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // Apply story-level a11y rules\\n await configureAxe(page, {\\n rules: storyContext.parameters?.a11y?.config?.rules,\\n });\\n\\n const element = storyContext.parameters?.a11y?.element ?? 'body';\\n await checkA11y(page, element, {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\nimport { getStoryContext } from '@storybook/test-runner';\\n\\nimport { injectAxe, checkA11y, configureAxe } from 'axe-playwright';\\n\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nconst config: TestRunnerConfig = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // Apply story-level a11y rules\\n await configureAxe(page, {\\n rules: storyContext.parameters?.a11y?.config?.rules,\\n });\\n\\n const element = storyContext.parameters?.a11y?.element ?? 'body';\\n await checkA11y(page, element, {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 566]\"}, {\"title\": \"Test Runner A11Y Disable\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { getStoryContext } = require('@storybook/test-runner');\\n\\nconst { injectAxe, checkA11y } = require('axe-playwright');\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nmodule.exports = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // Do not run a11y tests on disabled stories.\\n if (storyContext.parameters?.a11y?.disable) {\\n return;\\n }\\n await checkA11y(page, 'body', {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\nimport { getStoryContext } from '@storybook/test-runner';\\n\\nimport { injectAxe, checkA11y } from 'axe-playwright';\\n\\n/*\\n * See https://storybook.js.org/docs/writing-tests/integrations/test-runner#test-hook-api\\n * to learn more about the test-runner hooks API.\\n */\\nconst config: TestRunnerConfig = {\\n async preVisit(page) {\\n await injectAxe(page);\\n },\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // Do not run a11y tests on disabled stories.\\n if (storyContext.parameters?.a11y?.disable) {\\n return;\\n }\\n await checkA11y(page, 'body', {\\n detailedReport: true,\\n detailedReportOptions: {\\n html: true,\\n },\\n });\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 567]\"}, {\"title\": \"Test Runner Auth\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n getHttpHeaders: async (url) => {\\n const token = url.includes('prod') ? 'XYZ' : 'ABC';\\n return {\\n Authorization: `Bearer ${token}`,\\n };\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n getHttpHeaders: async (url) => {\\n const token = url.includes('prod') ? 'prod-token' : 'dev-token';\\n return {\\n Authorization: `Bearer ${token}`,\\n };\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 568]\"}, {\"title\": \"Test Runner Axe Playwright\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install axe-playwright --save-dev\\n```\", \"```\\npnpm add --save-dev axe-playwright\\n```\", \"```\\nyarn add --dev axe-playwright\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 569]\"}, {\"title\": \"Test Runner Config Serializer\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { getJestConfig } from '@storybook/test-runner';\\n\\nconst defaultConfig = getJestConfig();\\n\\nconst config = {\\n ...defaultConfig,\\n snapshotSerializers: [\\n // Sets up the custom serializer to preprocess the HTML before it's passed onto the test-runner\\n './snapshot-serializer.js',\\n ...defaultConfig.snapshotSerializers,\\n ],\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 570]\"}, {\"title\": \"Test Runner Config Snapshot Resolver\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { getJestConfig } from '@storybook/test-runner';\\n\\nconst defaultConfig = getJestConfig();\\n\\nconst config = {\\n // The default Jest configuration comes from @storybook/test-runner\\n ...defaultConfig,\\n snapshotResolver: './snapshot-resolver.js',\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 571]\"}, {\"title\": \"Test Runner Coverage\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --coverage\\n```\", \"```\\npnpm run test-storybook --coverage\\n```\", \"```\\nyarn test-storybook --coverage\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 572]\"}, {\"title\": \"Test Runner Custom Page Viewport\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { getStoryContext } = require('@storybook/test-runner');\\nconst { MINIMAL_VIEWPORTS } = require('storybook/viewport');\\n\\nconst DEFAULT_VIEWPORT_SIZE = { width: 1280, height: 720 };\\n\\nmodule.exports = {\\n async preVisit(page, story) {\\n // Accesses the story's parameters and retrieves the viewport used to render it\\n const context = await getStoryContext(page, story);\\n const viewportName = context.parameters?.viewport?.defaultViewport;\\n const viewportParameter = MINIMAL_VIEWPORTS[viewportName];\\n\\n if (viewportParameter) {\\n const viewportSize = Object.entries(viewportParameter.styles).reduce(\\n (acc, [screen, size]) => ({\\n ...acc,\\n // Converts the viewport size from percentages to numbers\\n [screen]: parseInt(size),\\n }),\\n {}\\n );\\n // Configures the Playwright page to use the viewport size\\n page.setViewportSize(viewportSize);\\n } else {\\n page.setViewportSize(DEFAULT_VIEWPORT_SIZE);\\n }\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\nimport { getStoryContext } from '@storybook/test-runner';\\nimport { MINIMAL_VIEWPORTS } from 'storybook/viewport';\\n\\nconst DEFAULT_VIEWPORT_SIZE = { width: 1280, height: 720 };\\n\\nconst config: TestRunnerConfig = {\\n async preVisit(page, story) {\\n // Accesses the story's parameters and retrieves the viewport used to render it\\n const context = await getStoryContext(page, story);\\n const viewportName = context.parameters?.viewport?.defaultViewport;\\n const viewportParameter = MINIMAL_VIEWPORTS[viewportName];\\n\\n if (viewportParameter) {\\n const viewportSize = Object.entries(viewportParameter.styles).reduce(\\n (acc, [screen, size]) => ({\\n ...acc,\\n // Converts the viewport size from percentages to numbers\\n [screen]: parseInt(size),\\n }),\\n {}\\n );\\n // Configures the Playwright page to use the viewport size\\n page.setViewportSize(viewportSize);\\n } else {\\n page.setViewportSize(DEFAULT_VIEWPORT_SIZE);\\n }\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 573]\"}, {\"title\": \"Test Runner Custom Snapshot Resolver\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\n\\nexport default {\\n resolveSnapshotPath: (testPath) => {\\n const fileName = path.basename(testPath);\\n const fileNameWithoutExtension = fileName.replace(/\\\\.[^/.]+$/, '');\\n const modifiedFileName = `${fileNameWithoutExtension}.storyshot`;\\n\\n // Configure Jest to generate snapshot files using the following naming convention (__snapshots__/Button.storyshot)\\n return path.join(path.dirname(testPath), '__snapshots__', modifiedFileName);\\n },\\n resolveTestPath: (snapshotFilePath, snapshotExtension) =>\\n path.basename(snapshotFilePath, snapshotExtension),\\n testPathForConsistencyCheck: 'example.storyshot',\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 574]\"}, {\"title\": \"Test Runner Custom Snapshot Serializer\", \"description\": null, \"content\": {\"root\": [\"```\\n// The jest-serializer-html package is available as a dependency of the test-runner\\nconst jestSerializerHtml = require('jest-serializer-html');\\n\\nconst DYNAMIC_ID_PATTERN = /\\\"react-aria-\\\\d+(\\\\.\\\\d+)?\\\"/g;\\n\\nmodule.exports = {\\n /*\\n * The test-runner calls the serialize function when the test reaches the expect(SomeHTMLElement).toMatchSnapshot().\\n * It will replace all dynamic IDs with a static ID so that the snapshot is consistent.\\n * For instance, from <label id=\\\"react-aria970235672-:rl:\\\" for=\\\"react-aria970235672-:rk:\\\">Favorite color</label> to <label id=\\\"react-mocked_id\\\" for=\\\"react-mocked_id\\\">Favorite color</label>\\n */\\n serialize(val) {\\n const withFixedIds = val.replace(DYNAMIC_ID_PATTERN, 'mocked_id');\\n return jestSerializerHtml.print(withFixedIds);\\n },\\n test(val) {\\n return jestSerializerHtml.test(val);\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 575]\"}, {\"title\": \"Test Runner Dom Snapshot Testing\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n async postVisit(page, context) {\\n // the #storybook-root element wraps the story. In Storybook 6.x, the selector is #root\\n const elementHandler = await page.$('#storybook-root');\\n const innerHTML = await elementHandler.innerHTML();\\n expect(innerHTML).toMatchSnapshot();\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n async postVisit(page, context) {\\n // the #storybook-root element wraps the story. In Storybook 6.x, the selector is #root\\n const elementHandler = await page.$('#storybook-root');\\n const innerHTML = await elementHandler.innerHTML();\\n expect(innerHTML).toMatchSnapshot();\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 576]\"}, {\"title\": \"Test Runner Eject Config\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --eject\\n```\", \"```\\npnpm run test-storybook --eject\\n```\", \"```\\nyarn test-storybook --eject\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 577]\"}, {\"title\": \"Test Runner Execute With Flags\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --watch\\n```\", \"```\\npnpm run test-storybook --watch\\n```\", \"```\\nyarn test-storybook --watch\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 578]\"}, {\"title\": \"Test Runner Execute With Url\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --url https://the-storybook-url-here.com\\n```\", \"```\\npnpm run test-storybook --url https://the-storybook-url-here.com\\n```\", \"```\\nyarn test-storybook --url https://the-storybook-url-here.com\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 579]\"}, {\"title\": \"Test Runner Execute\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook\\n```\", \"```\\npnpm run test-storybook\\n```\", \"```\\nyarn test-storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 580]\"}, {\"title\": \"Test Runner Helper Function\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { getStoryContext, waitForPageReady } = require('@storybook/test-runner');\\n\\nmodule.exports = {\\n // Hook that is executed before the test runner starts running tests\\n setup() {\\n // Add your configuration here.\\n },\\n /* Hook to execute before a story is initially visited before being rendered in the browser.\\n * The page argument is the Playwright's page object for the story.\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async preVisit(page, context) {\\n // Add your configuration here.\\n },\\n /* Hook to execute after a story is visited and fully rendered.\\n * The page argument is the Playwright's page object for the story\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // This utility function is designed for image snapshot testing. It will wait for the page to be fully loaded, including all the async items (e.g., images, fonts, etc.).\\n await waitForPageReady(page);\\n\\n // Add your configuration here.\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\nimport { getStoryContext, waitForPageReady } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n // Hook that is executed before the test runner starts running tests\\n setup() {\\n // Add your configuration here.\\n },\\n /* Hook to execute before a story is initially visited before being rendered in the browser.\\n * The page argument is the Playwright's page object for the story.\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async preVisit(page, context) {\\n // Add your configuration here.\\n },\\n /* Hook to execute after a story is visited and fully rendered.\\n * The page argument is the Playwright's page object for the story\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async postVisit(page, context) {\\n // Get the entire context of a story, including parameters, args, argTypes, etc.\\n const storyContext = await getStoryContext(page, context);\\n\\n // This utility function is designed for image snapshot testing. It will wait for the page to be fully loaded, including all the async items (e.g., images, fonts, etc.).\\n await waitForPageReady(page);\\n\\n // Add your configuration here.\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 581]\"}, {\"title\": \"Test Runner Hooks Example\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n // Hook that is executed before the test runner starts running tests\\n setup() {\\n // Add your configuration here.\\n },\\n /* Hook to execute before a story is initially visited before being rendered in the browser.\\n * The page argument is the Playwright's page object for the story.\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async preVisit(page, context) {\\n // Add your configuration here.\\n },\\n /* Hook to execute after a story is visited and fully rendered.\\n * The page argument is the Playwright's page object for the story\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async postVisit(page, context) {\\n // Add your configuration here.\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n // Hook that is executed before the test runner starts running tests\\n setup() {\\n // Add your configuration here.\\n },\\n /* Hook to execute before a story is initially visited before being rendered in the browser.\\n * The page argument is the Playwright's page object for the story.\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async preVisit(page, context) {\\n // Add your configuration here.\\n },\\n /* Hook to execute after a story is visited and fully rendered.\\n * The page argument is the Playwright's page object for the story\\n * The context argument is a Storybook object containing the story's id, title, and name.\\n */\\n async postVisit(page, context) {\\n // Add your configuration here.\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 582]\"}, {\"title\": \"Test Runner Image Snapshot Testing\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { waitForPageReady } = require('@storybook/test-runner');\\n\\nconst { toMatchImageSnapshot } = require('jest-image-snapshot');\\n\\nconst customSnapshotsDir = `${process.cwd()}/__snapshots__`;\\n\\n/** @type { import('@storybook/test-runner').TestRunnerConfig } */\\nmodule.exports = {\\n setup() {\\n expect.extend({ toMatchImageSnapshot });\\n },\\n async postVisit(page, context) {\\n // Waits for the page to be ready before taking a screenshot to ensure consistent results\\n await waitForPageReady(page);\\n\\n // To capture a screenshot for different browsers, add page.context().browser().browserType().name() to get the browser name to prefix the file name\\n const image = await page.screenshot();\\n expect(image).toMatchImageSnapshot({\\n customSnapshotsDir,\\n customSnapshotIdentifier: context.id,\\n });\\n },\\n};\\n```\", \"```\\nimport { TestRunnerConfig, waitForPageReady } from '@storybook/test-runner';\\n\\nimport { toMatchImageSnapshot } from 'jest-image-snapshot';\\n\\nconst customSnapshotsDir = `${process.cwd()}/__snapshots__`;\\n\\nconst config: TestRunnerConfig = {\\n setup() {\\n expect.extend({ toMatchImageSnapshot });\\n },\\n async postVisit(page, context) {\\n // Waits for the page to be ready before taking a screenshot to ensure consistent results\\n await waitForPageReady(page);\\n\\n // To capture a screenshot for for different browsers, add page.context().browser().browserType().name() to get the browser name to prefix the file name\\n const image = await page.screenshot();\\n expect(image).toMatchImageSnapshot({\\n customSnapshotsDir,\\n customSnapshotIdentifier: context.id,\\n });\\n },\\n};\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 583]\"}, {\"title\": \"Test Runner Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install @storybook/test-runner --save-dev\\n```\", \"```\\npnpm add --save-dev @storybook/test-runner\\n```\", \"```\\nyarn add --dev @storybook/test-runner\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 584]\"}, {\"title\": \"Test Runner Local Build Workflow\", \"description\": null, \"content\": {\"root\": [\"```\\nname: 'Storybook Tests'\\n\\non: push\\n\\njobs:\\n test:\\n timeout-minutes: 60\\n runs-on: ubuntu-latest\\n steps:\\n - uses: actions/checkout@v4\\n - uses: actions/setup-node@v4\\n with:\\n node-version-file: '.nvmrc'\\n - name: Install dependencies\\n run: yarn\\n - name: Install Playwright\\n run: npx playwright install --with-deps\\n - name: Build Storybook\\n run: yarn build-storybook --quiet\\n - name: Serve Storybook and run tests\\n run: |\\n npx concurrently -k -s first -n \\\"SB,TEST\\\" -c \\\"magenta,blue\\\" \\\\\\n \\\"npx http-server storybook-static --port 6006 --silent\\\" \\\\\\n \\\"npx wait-on tcp:127.0.0.1:6006 && yarn test-storybook\\\"\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 585]\"}, {\"title\": \"Test Runner No Index Json\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --no-index-json\\n```\", \"```\\npnpm run test-storybook --no-index-json\\n```\", \"```\\nyarn test-storybook --no-index-json\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 586]\"}, {\"title\": \"Test Runner Snapshot Resolver Custom Directory\", \"description\": null, \"content\": {\"root\": [\"```\\nimport path from 'path';\\n\\nexport default {\\n resolveSnapshotPath: (testPath) => {\\n const fileName = path.basename(testPath);\\n const fileNameWithoutExtension = fileName.replace(/\\\\.[^/.]+$/, '');\\n // Defines the file extension for the snapshot file\\n const modifiedFileName = `${fileNameWithoutExtension}.snap`;\\n\\n // Configure Jest to generate snapshot files using the following convention (./src/test/__snapshots__/Button.stories.snap)\\n return path.join('./src/test/__snapshots__', modifiedFileName);\\n },\\n resolveTestPath: (snapshotFilePath, snapshotExtension) =>\\n path.basename(snapshotFilePath, snapshotExtension),\\n testPathForConsistencyCheck: 'example',\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 587]\"}, {\"title\": \"Test Runner Tags Config\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n tags: {\\n include: ['test-only', 'pages'],\\n exclude: ['no-tests', 'tokens'],\\n skip: ['skip-test', 'layout'],\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n tags: {\\n include: ['test-only', 'pages'],\\n exclude: ['no-tests', 'tokens'],\\n skip: ['skip-test', 'layout'],\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 588]\"}, {\"title\": \"Test Runner Tags Exclude\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n tags: {\\n exclude: ['no-tests'],\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n tags: {\\n exclude: ['no-tests'],\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 589]\"}, {\"title\": \"Test Runner Tags Include\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n tags: {\\n include: ['test-only'],\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n tags: {\\n include: ['test-only'],\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 590]\"}, {\"title\": \"Test Runner Tags Skip\", \"description\": null, \"content\": {\"root\": [\"```\\nmodule.exports = {\\n tags: {\\n skip: ['skip-test'],\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nconst config: TestRunnerConfig = {\\n tags: {\\n skip: ['skip-test'],\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 591]\"}, {\"title\": \"Test Runner Waitpageready\", \"description\": null, \"content\": {\"root\": [\"```\\nconst { waitForPageReady } = require('@storybook/test-runner');\\n\\nconst { toMatchImageSnapshot } = require('jest-image-snapshot');\\n\\nconst customSnapshotsDir = `${process.cwd()}/__snapshots__`;\\n\\nmodule.exports = {\\n setup() {\\n expect.extend({ toMatchImageSnapshot });\\n },\\n async postVisit(page, context) {\\n // Awaits for the page to be loaded and available including assets (e.g., fonts)\\n await waitForPageReady(page);\\n\\n // Generates a snapshot file based on the story identifier\\n const image = await page.screenshot();\\n expect(image).toMatchImageSnapshot({\\n customSnapshotsDir,\\n customSnapshotIdentifier: context.id,\\n });\\n },\\n};\\n```\", \"```\\nimport type { TestRunnerConfig } from '@storybook/test-runner';\\n\\nimport { waitForPageReady } from '@storybook/test-runner';\\n\\nimport { toMatchImageSnapshot } from 'jest-image-snapshot';\\n\\nconst customSnapshotsDir = `${process.cwd()}/__snapshots__`;\\n\\nconst config: TestRunnerConfig = {\\n setup() {\\n expect.extend({ toMatchImageSnapshot });\\n },\\n async postVisit(page, context) {\\n // Awaits for the page to be loaded and available including assets (e.g., fonts)\\n await waitForPageReady(page);\\n\\n // Generates a snapshot file based on the story identifier\\n const image = await page.screenshot();\\n expect(image).toMatchImageSnapshot({\\n customSnapshotsDir,\\n customSnapshotIdentifier: context.id,\\n });\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 592]\"}, {\"title\": \"Test Runner With Deploy Event Workflow\", \"description\": null, \"content\": {\"root\": [\"```\\nname: Storybook Tests\\n\\non: deployment_status\\n\\njobs:\\n test:\\n timeout-minutes: 60\\n runs-on: ubuntu-latest\\n if: github.event.deployment_status.state == 'success'\\n steps:\\n - uses: actions/checkout@v4\\n - uses: actions/setup-node@v4\\n with:\\n node-version-file: '.nvmrc'\\n - name: Install dependencies\\n run: yarn\\n - name: Install Playwright\\n run: npx playwright install --with-deps\\n - name: Run Storybook tests\\n run: yarn test-storybook\\n env:\\n TARGET_URL: '${{ github.event.deployment_status.target_url }}'\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 593]\"}, {\"title\": \"Test Runner With Index Json\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --index-json\\n```\", \"```\\npnpm run test-storybook --index-json\\n```\", \"```\\nyarn test-storybook --index-json\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 594]\"}, {\"title\": \"Typed Csf File\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { Button } from './button.component';\\n\\nconst meta: Meta<Button> = {\\n component: Button,\\n};\\nexport default meta;\\n\\ntype Story = StoryObj<Button>;\\n\\nexport const Basic: Story = {};\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { Button } from './Button';\\n\\nconst meta = {\\n component: Button,\\n} satisfies Meta<typeof Button>;\\nexport default meta;\\n\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Basic = {} satisfies Story;\\n\\nexport const Primary = {\\n args: {\\n primary: true,\\n },\\n} satisfies Story;\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\nconst meta: Meta = {\\n title: 'Button',\\n component: 'demo-button',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const Basic: Story = {};\\n\\nexport const Primary: Story = {\\n args: {\\n primary: true,\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 595]\"}, {\"title\": \"Upgrade Command Specific Version\", \"description\": null, \"content\": {\"root\": [\"```\\nnpx storybook@7.6.6 upgrade\\n```\", \"```\\npnpm dlx storybook@7.6.6 upgrade\\n```\", \"```\\nyarn dlx storybook@7.6.6 upgrade\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 596]\"}, {\"title\": \"Vitest Plugin Install Coverage Support Packages\", \"description\": null, \"content\": {\"root\": [\"```\\n# For v8\\nnpm install --save-dev @vitest/coverage-v8\\n\\n# For istanbul\\nnpm install --save-dev @vitest/coverage-istanbul\\n```\", \"```\\n# For v8\\npnpm add --save-dev @vitest/coverage-v8\\n\\n# For istanbul\\npnpm add --save-dev @vitest/coverage-istanbul\\n```\", \"```\\n# For v8\\nyarn add --dev @vitest/coverage-v8\\n\\n# For istanbul\\nyarn add --dev @vitest/coverage-istanbul\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 597]\"}, {\"title\": \"Vitest Plugin Run Tests\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook\\n```\", \"```\\npnpm run test-storybook\\n```\", \"```\\nyarn test-storybook\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 598]\"}, {\"title\": \"Vitest Plugin Run With Coverage\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm run test-storybook -- --coverage\\n```\", \"```\\npnpm run test-storybook --coverage\\n```\", \"```\\nyarn test-storybook --coverage\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 599]\"}, {\"title\": \"Vitest Plugin Vitest Config\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { defineConfig, defineProject, mergeConfig } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nimport viteConfig from './vite.config';\\n\\nexport default mergeConfig(\\n viteConfig,\\n defineConfig({\\n test: {\\n // Use `workspace` field in Vitest < 3.2\\n projects: [\\n defineProject({\\n extends: true,\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n }),\\n ],\\n },\\n })\\n);\\n```\", \"```\\nimport { defineConfig, mergeConfig } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nimport viteConfig from './vite.config';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nexport default mergeConfig(\\n viteConfig,\\n defineConfig({\\n test: {\\n // Use `workspace` field in Vitest < 3.2\\n projects: [\\n defineProject({\\n extends: true,\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n }),\\n ],\\n },\\n })\\n);\\n```\", \"```\\nimport { defineConfig, mergeConfig } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nimport viteConfig from './vite.config';\\n\\nexport default mergeConfig(\\n viteConfig,\\n defineConfig({\\n test: {\\n // Use `workspace` field in Vitest < 3.2\\n projects: [\\n defineProject({\\n extends: true,\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n }),\\n ],\\n },\\n })\\n);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 600]\"}, {\"title\": \"Vitest Plugin Vitest Workspace\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { defineWorkspace } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nexport default defineWorkspace([\\n // This is the path to your existing Vitest config file\\n './vitest.config.ts',\\n {\\n // This is the path to your existing Vite config file\\n extends: './vite.config.ts',\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n },\\n]);\\n```\", \"```\\nimport { defineConfig, mergeConfig } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nimport viteConfig from './vite.config';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nexport default defineWorkspace([\\n // This is the path to your existing Vitest config file\\n './vitest.config.ts',\\n {\\n // This is the path to your existing Vite config file\\n extends: './vite.config.ts',\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n },\\n]);\\n```\", \"```\\nimport { defineConfig, mergeConfig } from 'vitest/config';\\nimport { storybookTest } from '@storybook/addon-vitest/vitest-plugin';\\nimport path from 'node:path';\\nimport { fileURLToPath } from 'node:url';\\n\\nimport viteConfig from './vite.config';\\n\\nconst dirname = path.dirname(fileURLToPath(import.meta.url));\\n\\nexport default defineWorkspace([\\n // This is the path to your existing Vitest config file\\n './vitest.config.ts',\\n {\\n // This is the path to your existing Vite config file\\n extends: './vite.config.ts',\\n plugins: [\\n storybookTest({\\n // The location of your Storybook config, main.js|ts\\n configDir: path.join(dirname, '.storybook'),\\n // This should match your package.json script to run Storybook\\n // The --ci flag will skip prompts and not open a browser\\n storybookScript: 'yarn storybook --ci',\\n }),\\n ],\\n test: {\\n name: 'storybook',\\n // Enable browser mode\\n browser: {\\n enabled: true,\\n // Make sure to install Playwright\\n provider: 'playwright',\\n headless: true,\\n instances: [{ browser: 'chromium' }],\\n },\\n setupFiles: ['./.storybook/vitest.setup.ts'],\\n },\\n },\\n]);\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 601]\"}, {\"title\": \"Vue Vite Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/vue3-vite',\\n options: {\\n docgen: 'vue-component-meta',\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/vue3-vite';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/vue3-vite',\\n options: {\\n docgen: 'vue-component-meta',\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 602]\"}, {\"title\": \"Vue3 Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/vue3-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/vue3-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/vue3-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 603]\"}, {\"title\": \"Vue3 Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/vue3-vite\\n```\", \"```\\npnpm add --save-dev @storybook/vue3-vite\\n```\", \"```\\nyarn add --dev @storybook/vue3-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 604]\"}, {\"title\": \"Web Components Vite Add Framework\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // ...\\n framework: '@storybook/web-components-vite', // \\ud83d\\udc48 Add this\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/web-components-vite';\\n\\nconst config: StorybookConfig = {\\n // ...\\n framework: '@storybook/web-components-vite', // \\ud83d\\udc48 Add this\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 605]\"}, {\"title\": \"Web Components Vite Framework Options\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n framework: {\\n name: '@storybook/web-components-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n```\", \"```\\nimport type { StorybookConfig } from '@storybook/web-components-vite';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/web-components-vite',\\n options: {\\n // ...\\n },\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 606]\"}, {\"title\": \"Web Components Vite Install\", \"description\": null, \"content\": {\"root\": [\"```\\nnpm install --save-dev @storybook/web-components-vite\\n```\", \"```\\npnpm add --save-dev @storybook/web-components-vite\\n```\", \"```\\nyarn add --dev @storybook/web-components-vite\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 607]\"}, {\"title\": \"Webpack Final To Vite Final\", \"description\": null, \"content\": {\"root\": [\"```\\nexport default {\\n // Replace your-framework with the framework you are using (e.g., react-webpack5, nextjs, angular)\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async webpackFinal(config) {\\n config.module?.rules?.push({\\n test: /\\\\.(graphql|gql)$/,\\n include: [path.resolve('./lib/emails')],\\n exclude: /node_modules/,\\n loader: 'graphql-tag/loader',\\n });\\n config.module?.rules?.push({\\n test: /\\\\.(graphql|gql)$/,\\n include: [path.resolve('./lib/schema')],\\n exclude: /node_modules/,\\n loader: 'raw-loader',\\n });\\n\\n return config;\\n },\\n};\\n```\", \"```\\nimport graphql from 'vite-plugin-graphql-loader';\\n\\nexport default {\\n // Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async viteFinal(config) {\\n return {\\n ...config,\\n plugins: [...(config.plugins ?? []), graphql()],\\n };\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using (e.g., react-webpack5, nextjs, angular)\\nimport type { StorybookConfig } from '@storybook/your-framework';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async webpackFinal(config) {\\n config.module?.rules?.push({\\n test: /\\\\.(graphql|gql)$/,\\n include: [path.resolve('./lib/emails')],\\n exclude: /node_modules/,\\n loader: 'graphql-tag/loader',\\n });\\n config.module?.rules?.push({\\n test: /\\\\.(graphql|gql)$/,\\n include: [path.resolve('./lib/schema')],\\n exclude: /node_modules/,\\n loader: 'raw-loader',\\n });\\n\\n return config;\\n },\\n};\\n\\nexport default config;\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { StorybookConfig } from '@storybook/your-framework';\\nimport graphql from 'vite-plugin-graphql-loader';\\n\\nconst config: StorybookConfig = {\\n framework: '@storybook/your-framework',\\n stories: ['../src/**/*.mdx', '../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)'],\\n async viteFinal(config) {\\n return {\\n ...config,\\n plugins: [...(config.plugins ?? []), graphql()],\\n };\\n },\\n};\\n\\nexport default config;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 608]\"}, {\"title\": \"Your Component With Decorator With Props\", \"description\": null, \"content\": {\"root\": [\"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n decorators: [\\n ({ parameters }) => ({\\n Component: MarginDecorator,\\n // \\ud83d\\udc47 Pass props to the MarginDecorator component\\n props: { size: parameters.smallMargin ? 'small' : 'medium' },\\n })\\n ],\\n });\\n</script>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nexport default {\\n component: YourComponent,\\n decorators: [\\n ({ parameters }) => ({\\n Component: MarginDecorator,\\n // \\ud83d\\udc47 Pass props to the MarginDecorator component\\n props: { size: parameters.smallMargin ? 'small' : 'medium' },\\n }),\\n ],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n decorators: [\\n ({ parameters }) => ({\\n Component: MarginDecorator,\\n // \\ud83d\\udc47 Pass props to the MarginDecorator component\\n props: { size: parameters.smallMargin ? 'small' : 'medium' },\\n })\\n ],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n decorators: [\\n ({ parameters }) => ({\\n Component: MarginDecorator,\\n // \\ud83d\\udc47 Pass props to the MarginDecorator component\\n props: { size: parameters.smallMargin ? 'small' : 'medium' },\\n }),\\n ],\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 609]\"}, {\"title\": \"Your Component With Decorator\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { componentWrapperDecorator } from '@storybook/angular';\\n\\nimport type { Meta } from '@storybook/angular';\\n\\nimport { YourComponent } from './your.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n decorators: [componentWrapperDecorator((story) => `<div style=\\\"margin: 3em\\\">${story}</div>`)],\\n};\\n\\nexport default meta;\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\nexport default {\\n component: YourComponent,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n};\\n```\", \"```\\nimport type { Meta } from 'storybook-solidjs-vite';\\n\\nimport { YourComponent } from './YourComponent';\\n\\nconst meta = {\\n component: YourComponent,\\n decorators: [\\n (Story) => (\\n <div style={{ margin: '3em' }}>\\n {/* \\ud83d\\udc47 Decorators in Storybook also accept a function. Replace <Story/> with Story() to enable it */}\\n <Story />\\n </div>\\n ),\\n ],\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n decorators: [() => MarginDecorator],\\n });\\n</script>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nexport default {\\n component: YourComponent,\\n decorators: [() => MarginDecorator],\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n import MarginDecorator from './MarginDecorator.svelte';\\n\\n const { Story } = defineMeta({\\n component: YourComponent,\\n decorators: [() => MarginDecorator],\\n });\\n</script>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\nimport MarginDecorator from './MarginDecorator.svelte';\\n\\nconst meta = {\\n component: YourComponent,\\n decorators: [() => MarginDecorator],\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport YourComponent from './YourComponent.vue';\\n\\nexport default {\\n component: YourComponent,\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story/></div>' })],\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/vue3-vite';\\n\\nimport YourComponent from './YourComponent.vue';\\n\\nconst meta = {\\n component: YourComponent,\\n decorators: [() => ({ template: '<div style=\\\"margin: 3em;\\\"><story/></div>' })],\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\n```\", \"```\\nimport { html } from 'lit';\\n\\nexport default {\\n component: 'demo-your-component',\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\n```\", \"```\\nimport type { Meta } from '@storybook/web-components-vite';\\n\\nimport { html } from 'lit';\\n\\nconst meta: Meta = {\\n component: 'demo-your-component',\\n decorators: [(story) => html`<div style=\\\"margin: 3em\\\">${story()}</div>`],\\n};\\nexport default meta;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 610]\"}, {\"title\": \"Your Component\", \"description\": null, \"content\": {\"root\": [\"```\\nimport type { Meta, StoryObj } from '@storybook/angular';\\n\\nimport { YourComponent } from './your.component';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<YourComponent>;\\n\\nexport const FirstStory: Story = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport { createYourComponent } from './YourComponent';\\n\\n// \\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'YourComponent',\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const FirstStory = {\\n render: (args) => createYourComponent(args),\\n args: {\\n // \\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/html';\\n\\nimport { createYourComponent, ComponentProps } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta: Meta<ComponentProps> = {\\n /* \\ud83d\\udc47 The title prop is optional.\\n * See https://storybook.js.org/docs/configure/#configure-story-loading\\n * to learn how to generate automatic titles\\n */\\n title: 'YourComponent',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ComponentProps>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const FirstStory: Story = {\\n render: (args) => createYourComponent(args),\\n args: {\\n // \\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\n/** @jsx h */\\nimport { h } from 'preact';\\n\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n component: YourComponent,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const FirstStory = {\\n render: (args) => <YourComponent {...args} />,\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n component: YourComponent,\\n};\\n\\nexport const FirstStory = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, nextjs-vite, etc.\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const FirstStory: Story = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n component: YourComponent,\\n};\\n\\nexport const FirstStory = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from 'storybook-solidjs-vite';\\n\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const FirstStory: Story = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n //\\ud83d\\udc47 This export determines where your story goes in the story list\\n const { Story } = defineMeta({\\n component: YourComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"FirstStory\\\"\\n args={{\\n /*\\ud83d\\udc47 The args you need here will depend on your component */\\n }}\\n/>\\n```\", \"```\\nimport YourComponent from './YourComponent.svelte';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n component: YourComponent,\\n};\\n\\nexport const FirstStory = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import YourComponent from './YourComponent.svelte';\\n\\n //\\ud83d\\udc47 This export determines where your story goes in the story list\\n const { Story } = defineMeta({\\n component: YourComponent,\\n });\\n</script>\\n\\n<Story\\n name=\\\"FirstStory\\\"\\n args={{\\n /*\\ud83d\\udc47 The args you need here will depend on your component */\\n }}\\n/>\\n```\", \"```\\n// Replace your-framework with svelte-vite or sveltekit\\nimport type { Meta, StoryObj } from '@storybook/your-framework';\\n\\nimport YourComponent from './YourComponent.svelte';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const FirstStory: Story = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport YourComponent from './YourComponent.vue';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default {\\n component: YourComponent,\\n};\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const FirstStory = {\\n render: (args) => ({\\n components: { YourComponent },\\n setup() {\\n return { args };\\n },\\n template: '<YourComponent v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport YourComponent from './YourComponent.vue';\\n\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<typeof YourComponent>;\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\n/*\\n *\\ud83d\\udc47 Render functions are a framework specific feature to allow you control on how the component renders.\\n * See https://storybook.js.org/docs/api/csf\\n * to learn how to use render functions.\\n */\\nexport const Primary: Story = {\\n render: (args) => ({\\n components: { YourComponent },\\n setup() {\\n return { args };\\n },\\n template: '<YourComponent v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\n// This default export determines where your story goes in the story list\\nexport default {\\n component: 'demo-your-component',\\n};\\n\\nexport const FirstStory = {\\n args: {\\n // \\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\", \"```\\nimport type { Meta, StoryObj } from '@storybook/web-components-vite';\\n\\n// This default export determines where your story goes in the story list\\nconst meta: Meta = {\\n component: 'demo-your-component',\\n};\\n\\nexport default meta;\\ntype Story = StoryObj;\\n\\nexport const FirstStory: Story = {\\n args: {\\n // \\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 611]\"}, {\"title\": \"Your Theme\", \"description\": null, \"content\": {\"root\": [\"```\\nimport { create } from 'storybook/theming/create';\\n\\nexport default create({\\n base: 'light',\\n // Typography\\n fontBase: '\\\"Open Sans\\\", sans-serif',\\n fontCode: 'monospace',\\n\\n brandTitle: 'My custom Storybook',\\n brandUrl: 'https://example.com',\\n brandImage: 'https://storybook.js.org/images/placeholders/350x150.png',\\n brandTarget: '_self',\\n\\n //\\n colorPrimary: '#3A10E5',\\n colorSecondary: '#585C6D',\\n\\n // UI\\n appBg: '#ffffff',\\n appContentBg: '#ffffff',\\n appPreviewBg: '#ffffff',\\n appBorderColor: '#585C6D',\\n appBorderRadius: 4,\\n\\n // Text colors\\n textColor: '#10162F',\\n textInverseColor: '#ffffff',\\n\\n // Toolbar default and active colors\\n barTextColor: '#9E9E9E',\\n barSelectedColor: '#585C6D',\\n barHoverColor: '#585C6D',\\n barBg: '#ffffff',\\n\\n // Form colors\\n inputBg: '#ffffff',\\n inputBorder: '#10162F',\\n inputTextColor: '#10162F',\\n inputBorderRadius: 2,\\n});\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 612]\"}], \"path\": \"[\\\"subpages\\\", 2]\"}, {\"title\": \"Addons\", \"description\": \"Documentation section: addons\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/addons\"}, \"subpages\": [{\"title\": \"Addon knowledge base\", \"description\": null, \"content\": {\"Disable the addon panel\": \"It\\u2019s possible to disable the addon panel for a particular story.\\n\\nTo make that possible, you need to pass the `paramKey` element when you register the panel:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-disable-addon.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen when adding a story, you can pass a disabled parameter.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-disable-addon.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Style your addon\": \"Storybook uses [Emotion](https://emotion.sh/docs/introduction) for styling. Alongside with a theme that you can customize!\\n\\nWe recommend using Emotion to style your addon\\u2019s UI components. That allows you to use the active Storybook theme to deliver a seamless developer experience.\\nIf you don\\u2019t want to use Emotion, you can use inline styles or another css-in-js lib. You can receive the theme as a prop by using Emotion's `withTheme` HOC. [Read more about theming](../configure/user-interface/theming.mdx).\", \"Storybook components\": \"Addon authors can develop their UIs using any React library. But we recommend using Storybook\\u2019s UI components in `storybook/internal/components` to build addons faster. When you use Storybook components, you get:\\n\\n['Battle-tested off-the-shelf components', 'Storybook native look and feel', 'Built-in support for Storybook theming']\\n\\nUse the components listed below with your next addon.\\n\\n| Component | Source | Story |\\n| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\\n| Action Bar | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/ActionBar/ActionBar.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-actionbar--single-item) |\\n| Addon Panel | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/addon-panel/addon-panel.tsx) | N/A |\\n| Badge | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/Badge/Badge.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-badge--all-badges) |\\n| Button | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/Button/Button.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-button--all-buttons) |\\n| Form | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/form/index.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-form-button--sizes) |\\n| Loader | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/Loader/Loader.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-loader--progress-bar) |\\n| PlaceHolder | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/placeholder/placeholder.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-placeholder--single-child) |\\n| Scroll Area | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/ScrollArea/ScrollArea.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-scrollarea--vertical) |\\n| Space | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/spaced/Spaced.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-spaced--row) |\\n| Syntax Highlighter | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/syntaxhighlighter/syntaxhighlighter.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-syntaxhighlighter--bash) |\\n| Tabs | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/tabs/tabs.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-tabs--stateful-static) |\\n| ToolBar | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/bar/bar.tsx) | N/A |\\n| ToolTip | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/tooltip/Tooltip.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-tooltip-tooltip--basic-default) |\\n| Zoom | [See component implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/Zoom/Zoom.tsx) | [See component story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-zoom--element-actual-size) |\\n\\nComplementing the components, also included is a set of UI primitives. Use the content listed below as a reference for styling your addon.\\n\\n| Component | Source | Story |\\n| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------------------------- |\\n| Color Palette (see note below) | [See implementation](https://github.com/storybookjs/storybook/blob/next/code/addons/docs/src/blocks/components/ColorPalette.tsx) | [See story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-colorpalette--page) |\\n| Icon | [See implementation](https://github.com/storybookjs/storybook/blob/next/code/core/src/components/components/icon/icon.tsx) | [See story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-icon--labels) |\\n| Typography | [See implementation](https://github.com/storybookjs/storybook/tree/next/code/core/src/components/components/typography) | [See story](https://main--5a375b97f4b14f0020b0cda3.chromatic.com/?path=/story/basics-typography--all) |\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe color palette implemented by `@storybook/addon-docs/blocks` is a high-level abstraction of the [`storybook/theming`](https://github.com/storybookjs/storybook/tree/next/code/core/src/theming) module.\\n\\n</Callout>\", \"Build system\": \"When you're developing your addon as a package, you can\\u2019t use `npm link` to add it to your project. List your addon as a local dependency into your package.json:\\n\\n```\\n{\\n \\\"dependencies\\\": {\\n \\\"@storybook/addon-controls\\\": \\\"file:///home/username/myrepo\\\"\\n }\\n}\\n```\\n\\n<Callout variant=\\\"info\\\">\\nRun either `yarn` or `npm install` to install the addon.\\n</Callout>\", \"Hot module replacement\": \"While developing your addon, you can configure HMR (hot module replacement) to reflect the changes made.\", \"Standalone Storybook addons\": {\"Local Storybook addons\": \"If you're developing a local Storybook addon built on top of an existing Storybook installation, HMR (hot module replacement) is available out of the box.\"}, \"Composing addons in presets\": \"If you're working on a preset that loads third-party addons, which you don't have control over, and you need access to certain features (e.g., decorators) or provide additional configurations. In that case, you'll need to update your preset to the following to allow you to load and configure the other addons:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-load-external-addons-preset.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you have control over the addons you want to customize. In that case, you can update your preset and implement a custom function to load any additional presets and provide the necessary configuration.\"}, \"metadata\": {\"title\": \"Addon knowledge base\", \"sidebar\": {\"order\": 7, \"title\": \"Knowledge base\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\"}, {\"title\": \"Addon migration guide for Storybook 9.0\", \"description\": null, \"content\": {\"Replacing dependencies\": {\"Dependency Management\": \"With Storybook 9.0, most Storybook packages have been consolidated into the main `storybook` package. This means you no longer need to reference individual Storybook packages as dependencies. Instead, define `storybook` as a peer dependency in your addon's `package.json`:\\n\\n```\\n{\\n \\\"name\\\": \\\"your-storybook-addon\\\",\\n \\\"peerDependencies\\\": {\\n \\\"storybook\\\": \\\"^9.0.0\\\"\\n },\\n \\\"devDependencies\\\": {\\n \\\"storybook\\\": \\\">=9.0.0-0 <10.0.0-0\\\" // For local development\\n }\\n}\\n```\\n\\nThis approach ensures that:\\n\\n['Your addon uses the same version of Storybook APIs as the host project', 'You avoid duplicate Storybook packages in the final bundle', \\\"Your addon's package size is minimized\\\"]\\n\\nIf your addon supports multiple major versions of Storybook, you can specify a wider version range in your peer dependencies:\\n\\n```\\n{\\n \\\"name\\\": \\\"your-storybook-addon\\\",\\n \\\"peerDependencies\\\": {\\n \\\"storybook\\\": \\\"^8.0.0 || ^9.0.0\\\"\\n },\\n \\\"devDependencies\\\": {\\n \\\"storybook\\\": \\\">=9.0.0-0 <10.0.0-0\\\" // For local development\\n }\\n}\\n```\\n\\nHowever, we recommend releasing a new major version of your addon alongside new major versions of Storybook. This practice:\\n\\n['Makes it easier to maintain your code', 'Allows you to take advantage of new features and improvements', 'Provides a clearer upgrade path for your users']\"}, \"Key changes for addons\": {\"Package Consolidation\": \"Several packages have been consolidated into the main `storybook` package. Update your imports to use the new paths:\\n\\n| Old Package | New Path |\\n| ------------------------------- | ----------------------- |\\n| `@storybook/manager-api` | `storybook/manager-api` |\\n| `@storybook/preview-api` | `storybook/preview-api` |\\n| `@storybook/theming` | `storybook/theming` |\\n| `@storybook/test` | `storybook/test` |\\n| `@storybook/addon-actions` | `storybook/actions` |\\n| `@storybook/addon-backgrounds` | N/A |\\n| `@storybook/addon-controls` | N/A |\\n| `@storybook/addon-highlight` | `storybook/highlight` |\\n| `@storybook/addon-interactions` | N/A |\\n| `@storybook/addon-measure` | N/A |\\n| `@storybook/addon-outline` | N/A |\\n| `@storybook/addon-toolbars` | N/A |\\n| `@storybook/addon-viewport` | `storybook/viewport` |\\n\\nAdditionally, several internal packages have been moved under the `/internal` sub-path. \\nThese paths are not part of our public API, so they may change without following semver. While you can use them for a quick upgrade, we strongly encourage finding replacements as they could break in future minor versions:\\n\\n| Old Package | New Path |\\n| ---------------------------- | ------------------------------------ |\\n| `@storybook/channels` | `storybook/internal/channels` |\\n| `@storybook/client-logger` | `storybook/internal/client-logger` |\\n| `@storybook/core-events` | `storybook/internal/core-events` |\\n| `@storybook/types` | `storybook/internal/types` |\\n| `@storybook/components` | `storybook/internal/components` |\\n\\nPlease visit the [full list of consolidated packages](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-legacy-packages) in our `Migration.md` file.\", \"Icon System Updates\": \"The icon system has been updated to use `@storybook/icons`. Several icon-related exports have been removed:\\n\\n```\\n- import { Icons, IconButtonSkeleton } from '@storybook/components';\\n+ import { ZoomIcon } from '@storybook/icons';\\n```\", \"Manager Builder Changes\": \"The manager builder no longer aliases `util`, `assert`, and `process`. If your addon depends on these packages, you'll need to:\\n\\n['Implement the alias at compile time in your addon', 'Update your bundling configuration to ensure correct dependencies are used']\", \"Node.js 18 support dropped\": \"Please upgrade your addon to Node.js 20, as support for Node.js 18 has ended.\", \"TypeScript Requirements\": \"Storybook now requires TypeScript 4.9 or later. Ensure your addon is compatible with this version.\", \"Sidebar Component Changes\": [\"The 'extra' prop has been removed from the Sidebar's Heading component\", \"Experimental sidebar features have been removed:\", [\"`experimental_SIDEBAR_BOTTOM`\", \"`experimental_SIDEBAR_TOP`\"]], \"Type System Updates\": \"The following types have been removed:\\n\\n['`Addon_SidebarBottomType`', '`Addon_SidebarTopType`', '`DeprecatedState`']\"}, \"9.0.0 Full migration guide\": \"For a full list of changes, please visit the [Migration.md](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#from-version-8x-to-900) file\", \"Migration Example\": \"For a complete example of an addon updated to support Storybook 9.0, refer to the [Addon Kit migration PR](https://github.com/storybookjs/addon-kit/pull/75). \\nOnce merged, it will demonstrate all the necessary changes for modern addon development.\", \"Releasing\": \"To support Storybook 9.0, we encourage you to release a new major version of your addon. For experimental features or testing, use the `next` tag. This allows you to gather feedback before releasing a stable version.\", \"Support\": \"If you're having issues with your addon after following this guide, please open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=migrations) in our GitHub repository.\"}, \"metadata\": {\"title\": \"Addon migration guide for Storybook 9.0\", \"sidebar\": {\"order\": 9, \"title\": \"Migrate addons to 9.0\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\"}, {\"title\": \"Types of addons\", \"description\": null, \"content\": {\"UI-based addons\": {\"Panels\": \"Panel addons allow you to add your own UI in Storybook's addon panel. This is the most common type of addon in the ecosystem. For example, the official [`@storybook/addon-a11y`](https://github.com/storybookjs/storybook/tree/next/code/addons/a11y) uses this pattern.\\n\\n\\n\\nUse this boilerplate code to add a new `Panel` to Storybook's UI:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-panel-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Toolbars\": \"Toolbar addons allow you to add your own custom tools in Storybook's Toolbar. For example, the official [`@storybook/addon-themes`](https://storybook.js.org/addons/@storybook/addon-themes) uses this pattern.\\n\\n\\n\\nUse this boilerplate code to add a new `button` to Storybook's Toolbar:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-toolbar-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe `match` property allows you to conditionally render your toolbar addon, [based on the current view](./writing-addons.mdx#conditionally-render-the-addon). The `icon` element used in the example loads the icons from the `storybook/internal/components` module. See [here](../faq.mdx#what-icons-are-available-for-my-toolbar-or-my-addon) for the list of available icons that you can use.\\n</Callout>\", \"Tabs\": \"Tab addons allow you to create your own custom tabs in Storybook.\\n\\n\\n\\nUse this boilerplate code to add a new `Tab` to Storybook's UI:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-tab-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nLearn how to write your own addon that includes these UI elements [here](./writing-addons.mdx).\\n</Callout>\"}, \"Preset addons\": \"Storybook preset addons are grouped collections of `babel`, `webpack`, and `addons` configurations to integrate Storybook and other technologies. For example the official [preset-create-react-app](https://github.com/storybookjs/presets/tree/master/packages/preset-create-react-app).\\n\\nUse this boilerplate code while writing your own preset addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preset-full-config-object.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n**Learn more about the Storybook addon ecosystem**\\n\\n['Types of addons for other types of addons', '[Writing addons](./writing-addons.mdx) for the basics of addon development', '[Presets](./writing-presets.mdx) for preset development', '[Integration catalog](./integration-catalog.mdx) for requirements and available recipes', '[API reference](./addons-api.mdx) to learn about the available APIs']\"}, \"metadata\": {\"title\": \"Types of addons\", \"sidebar\": {\"order\": 6, \"title\": \"Types of addons\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\"}, {\"title\": \"Addon API\", \"description\": null, \"content\": {\"Core Addon API\": {\"addons.add()\": \"The `add` method allows you to register the type of UI component associated with the addon (e.g., panels, toolbars, tabs). For a minimum viable Storybook addon, you should provide the following arguments:\\n\\n['`type`: The type of UI component to register.', '`title`: The title to feature in the Addon Panel.', \\\"`render`: The function that renders the addon's UI component.\\\"]\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-panel-initial.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe render function is called with `active`. The `active` value will be true when the panel is focused on the UI.\\n</Callout>\", \"addons.register()\": \"Serves as the entry point for all addons. It allows you to register an addon and access the Storybook [API](#storybook-api). For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow you'll get an instance to our StorybookAPI. See the [api docs](#storybook-api) for Storybook API regarding using that.\", \"addons.getChannel()\": \"Get an instance to the channel to communicate with the manager and the preview. You can find this in both the addon register code and your addon\\u2019s wrapper component (where used inside a story).\\n\\nIt has a NodeJS [EventEmitter](https://nodejs.org/api/events.html) compatible API. So, you can use it to emit events and listen to events.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-getchannel.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"makeDecorator\": \"Use the `makeDecorator` API to create decorators in the style of the official addons. Like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-makedecorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf the story's parameters include `{ exampleParameter: { disable: true } }` (where `exampleParameter` is the `parameterName` of your addon), your decorator will not be called.\\n</Callout>\\n\\nThe `makeDecorator` API requires the following arguments:\\n\\n['`name`: Unique name to identify the custom addon decorator.', '`parameterName`: Sets a unique parameter to be consumed by the addon.', \\\"`skipIfNoParametersOrOptions`: (Optional) Doesn't run the decorator if the user hasn't options either via [decorators](../writing-stories/decorators.mdx) or [parameters](../writing-stories/parameters.mdx).\\\", '`wrapper`: your decorator function. Takes the `getStory`, `context`, and both the `options` and `parameters` (as defined in `skipIfNoParametersOrOptions` above).']\\n\\n[]\"}, \"Storybook API\": {\"api.selectStory()\": \"The `selectStory` API method allows you to select a single story. It accepts the following two parameters; story kind name and an optional story name. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-with-addon-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis is how you can select the above story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-selectstory.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"api.selectInCurrentKind()\": \"Similar to the `selectStory` API method, but it only accepts the story as the only parameter.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-selectincurrentkind.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"api.setQueryParams()\": \"This method allows you to set query string parameters. You can use that as temporary storage for addons. Here's how you define query params:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-setqueryparams.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdditionally, if you need to remove a query parameter, set it as `null` instead of removing them from the addon. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-disablequeryparams.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"api.getQueryParam()\": \"Allows retrieval of a query parameter enabled via the `setQueryParams` API method. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-getqueryparam.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"api.getUrlState(overrideParams)\": \"This method allows you to get the application URL state, including any overridden or custom parameter values. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-geturlstate.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"api.on(eventName, fn)\": \"This method allows you to register a handler function called whenever the user navigates between stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-on.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"addons.setConfig(config)\": \"This method allows you to override the default Storybook UI configuration (e.g., set up a [theme](../configure/user-interface/theming.mdx) or hide UI elements):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-config-layout.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe following table details how to use the API values:\\n\\n| Name | Type | Description | Example Value |\\n| --------------------- | --------------- | ------------------------------------------------------- | ------------------------------------- |\\n| **navSize** | Number (pixels) | The size of the sidebar that shows a list of stories | `300` |\\n| **bottomPanelHeight** | Number (pixels) | The size of the addon panel when in the bottom position | `200` |\\n| **rightPanelWidth** | Number (pixels) | The size of the addon panel when in the right position | `200` |\\n| **panelPosition** | String | Where to show the addon panel | `'bottom'` or `'right'` |\\n| **enableShortcuts** | Boolean | Enable/disable shortcuts | `true` |\\n| **showToolbar** | Boolean | Show/hide toolbar | `true` |\\n| **theme** | Object | Storybook Theme, see next section | `undefined` |\\n| **selectedPanel** | String | Id to select an addon panel | `storybook/actions/panel` |\\n| **initialActive** | String | Select the default active tab on Mobile | `sidebar` or `canvas` or `addons` |\\n| **sidebar** | Object | Sidebar options, see below | `{ showRoots: false }` |\\n| **toolbar** | Object | Modify the tools in the toolbar using the addon id | `{ fullscreen: { hidden: false } }` |\\n\\nThe following options are configurable under the `sidebar` namespace:\\n\\n| Name | Type | Description | Example Value |\\n| ------------------ | -------- | ------------------------------------------------------------- | ----------------------------------------------------- |\\n| **showRoots** | Boolean | Display the top-level nodes as a \\\"root\\\" in the sidebar | `false` |\\n| **collapsedRoots** | Array | Set of root node IDs to visually collapse by default | `['misc', 'other']` |\\n| **renderLabel** | Function | Create a custom label for tree nodes; must return a ReactNode | `(item, api) => <abbr title=\\\"...\\\">{item.name}</abbr>` |\\n\\nThe following options are configurable under the `toolbar` namespace:\\n\\n| Name | Type | Description | Example Value |\\n| --------- | ------ | -------------------------------------------------------------------- | ------------------- |\\n| **[id]** | String | Toggle visibility for a specific toolbar item (e.g. `title`, `zoom`) | `{ hidden: false }` |\\n\\n[]\"}, \"Storybook hooks\": {\"useStorybookState\": \"It allows access to Storybook's internal state. Similar to the [`useglobals`](#useglobals) hook, we recommend optimizing your addon to rely on [`React.memo`](https://react.dev/reference/react/memo), or the following hooks; [`useMemo`](https://react.dev/reference/react/useMemo), [`useCallback`](https://react.dev/reference/react/useCallback) to prevent a high volume of re-render cycles.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-usestorybookstate.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useStorybookApi\": \"The `useStorybookApi` hook is a convenient helper to allow you full access to the [Storybook API](#storybook-api) methods.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-useapi.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useChannel\": \"Allows setting subscriptions to events and getting the emitter to emit custom events to the channel.\\n\\nThe messages can be listened to on both the iframe and the manager.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-usechannel.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useAddonState\": \"The `useAddonState` is a useful hook for addons that require data persistence, either due to Storybook's UI lifecycle or for more complex addons involving multiple types (e.g., toolbars, panels).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-useaddonstate.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useParameter\": \"The `useParameter` retrieves the current story's parameters. If the parameter's value is not defined, it will automatically default to the second value defined.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-useparameter.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useGlobals\": \"Extremely useful hook for addons that rely on Storybook [Globals](../essentials/toolbars-and-globals.mdx). It allows you to obtain and update `global` values. We also recommend optimizing your addon to rely on [`React.memo`](https://react.dev/reference/react/memo), or the following hooks; [`useMemo`](https://react.dev/reference/react/useMemo), [`useCallback`](https://react.dev/reference/react/useCallback) to prevent a high volume of re-render cycles.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-api-useglobal.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"useArgs\": \"Hook that allows you to retrieve or update a story's [`args`](../writing-stories/args.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"args-usage-with-addons.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n**Learn more about the Storybook addon ecosystem**\\n\\n['[Types of addons](./addon-types.mdx) for other types of addons', '[Writing addons](./writing-addons.mdx) for the basics of addon development', '[Presets](./writing-presets.mdx) for preset development', '[Integration catalog](./integration-catalog.mdx) for requirements and available recipes', 'API reference to learn about the available APIs']\"}}, \"metadata\": {\"title\": \"Addon API\", \"sidebar\": {\"order\": 8, \"title\": \"Addon API\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\"}, {\"title\": \"Configure and communicate with an addon\", \"description\": null, \"content\": {\"Preset\": \"Presets offload the burden of configuration from the user to the addon. Preset options are global and are accessible from NodeJS. They're ideal for pre-configuring Webpack loaders, Babel plugins, and other library or framework-specific configurations.\\n\\nFor example, many libraries require that the app be wrapped by a `Provider` which *provides* data to components down the tree. Presets can describe behavior like adding wrappers automatically, without users having to do any manual configuration. If a user installs an addon that has Presets, the addon can instruct Storybook to wrap all stories in `Provider`. This allows folks to start using your library with Storybook, with just 1 line of config!\\n\\nFor more on presets, see: [Write a preset addon](./writing-presets.mdx)\\n\\nThe mechanism for wrapping each story is referred to as a Storybook [decorator](../writing-stories/decorators.mdx). They allow you to augment stories with extra rendering functionality or by providing data.\", \"Parameters\": \"Parameters are available in the browser and are great for configuring addon behavior globally, at the component level, or at the story level.\\n\\nFor example, the [Pseudo States addon](https://storybook.js.org/addons/storybook-addon-pseudo-states) uses parameters to enable the various pseudo-states. Users can provide global defaults and then override them at the story level.\\n\\nUse the [`useParameter`](./addons-api.mdx#useparameter) hook to access the parameter values within your addon.\\n\\n```\\nexport const Hover = {\\n render: () => <Button>Label</Button>,\\n parameters: { pseudo: { hover: true } },\\n};\\n```\", \"Channels\": \"Channels enable two-way communication between the manager and the preview pane, using a NodeJS [EventEmitter](https://nodejs.org/api/events.html) compatible API. Your addons can plug into specific channels and respond to these events.\\n\\nFor example, [Actions](https://storybook.js.org/docs/essentials/actions) captures user events and displays their data in a panel.\\n\\nUse the [`useChannel`](./addons-api.mdx#usechannel) hook to access the channel data within your addon.\\n\\nFor a complete example, check out [storybookjs/addon-kit/withRoundTrip.ts](https://github.com/storybookjs/addon-kit/blob/main/src/withRoundTrip.ts)\"}, \"metadata\": {\"title\": \"Configure and communicate with an addon\", \"sidebar\": {\"order\": 3, \"title\": \"Configure addons\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\"}, {\"title\": \"Introduction to addons\", \"description\": null, \"content\": {\"Storybook basics\": \"Before writing your first [addon](https://storybook.js.org/addons), let\\u2019s take a look at the basics of Storybook\\u2019s architecture. While Storybook presents a unified user interface, under the hood it\\u2019s divided down the middle into **Manager** and **Preview**.\\n\\nThe **Manager** is the UI responsible for rendering the:\\n\\n['\\ud83d\\udd0d Search', '\\ud83e\\udded Navigation', '\\ud83d\\udd17 Toolbars', '\\ud83d\\udce6 Addons']\\n\\nThe **Preview** area is an `iframe` where your stories are rendered.\\n\\n\\n\\nBecause both elements run in their own separate `iframes`, they use a communication channel to keep in sync. For example, when you select a story in the Manager an event is dispatched across the channel notifying the Preview to render the story.\", \"Anatomy of an addon\": {\"UI-based addons\": \"[UI-based addons](./addon-types.mdx#ui-based-addons) focus on customizing Storybook's user interface to extend your development workflow. Examples of UI-based addons include: [Controls](../essentials/controls.mdx), [Docs](../writing-docs/index.mdx) and [Accessibility](../writing-tests/accessibility-testing.mdx).\\n\\n[Learn how to write an addon \\u00bb](./writing-addons.mdx)\", \"Preset addons\": \"[Preset addons](./addon-types.mdx#preset-addons) help you integrate Storybook with other technologies and libraries. An examples of a preset addons is [preset-create-react-app](https://github.com/storybookjs/presets/tree/master/packages/preset-create-react-app).\\n\\n[Learn how to write a preset addon \\u00bb](./writing-presets.mdx)\"}}, \"metadata\": {\"title\": \"Introduction to addons\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 7, \"title\": \"Addons\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\"}, {\"title\": \"Install addons\", \"description\": null, \"content\": {\"Automatic installation\": {\"Manual installation\": \"Storybook addons are always added through the [`addons`](../api/main-config/main-config-addons.mdx) configuration array in [`.storybook/main.js|ts`](../configure/index.mdx). The following example shows how to manually add the [Accessibility addon](https://storybook.js.org/addons/@storybook/addon-a11y) to Storybook.\\n\\nRun the following command with your package manager of choice to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-a11y-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNext, update `.storybook/main.js|ts` to the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-a11y-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen you run Storybook, the accessibility testing addon will be enabled.\\n\\n\", \"Removing addons\": \"To remove an addon from Storybook, you can choose to manually uninstall it and remove it from the configuration file (i.e., [`.storybook/main.js|ts`](../configure/index.mdx)) or opt-in to do it automatically via the CLI with the [`remove`](../api/cli-options.mdx#remove) command. For example, to remove the [Accessibility addon](https://storybook.js.org/addons/@storybook/addon-a11y) from Storybook with the CLI, run the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-remove-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Install addons\", \"sidebar\": {\"order\": 1, \"title\": \"Install\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\"}, {\"title\": \"Add to the integration catalog\", \"description\": null, \"content\": {\"Addons\": {\"Addon metadata\": {\"How long does it take for my addon to show up in the catalog?\": \"Once you publish the addon, it will appear in the catalog. There may be a delay between the time you publish your addon and when it's listed in the catalog. If your addon doesn't show up within 24 hours, [open an issue](https://github.com/storybookjs/frontpage/issues).\"}}, \"Recipes\": {\"Who owns them?\": \"Recipes are written and maintained by the Storybook team. We create recipes based on community popularity, tool maturity, and stability of the integration. Our goal is to ensure that recipes continue to work over time.\\n\\nNot finding the recipe that you want? If it's popular in the community, our docs team will write one. In the mean time, try searching for a solution \\u2014 it's likely that someone has the same requirements as you do. You can also help us out by writing recipes on your own site which speeds up the research process.\", \"Request a recipe\": \"If you'd like to request a recipe, open a [new discussion](https://github.com/storybookjs/storybook/discussions/new?category=ideas) in our GitHub repo. We'll review your request, and if it's popular, we'll add it to our backlog and prioritize it.\\n\\n**Learn more about the Storybook addon ecosystem**\\n\\n['[Types of addons](./addon-types.mdx) for other types of addons', '[Writing addons](./writing-addons.mdx) for the basics of addon development', '[Presets](./writing-presets.mdx) for preset development', 'Integration catalog for requirements and available recipes', '[API reference](./addons-api.mdx) to learn about the available APIs']\"}}, \"metadata\": {\"title\": \"Add to the integration catalog\", \"sidebar\": {\"order\": 5, \"title\": \"Add to catalog\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\"}, {\"title\": \"Write an addon\", \"description\": null, \"content\": {\"What are we going to build?\": \"This reference guide is to help you develop a mental model for how Storybook addons work by building a simple addon based on the popular [Outline addon](https://storybook.js.org/addons/@storybook/addon-outline/) (which is the historical basis for the built-in [outline feature](../essentials/measure-and-outline.mdx#outline)). Throughout this guide, you'll learn how addons are structured, Storybook's APIs, how to test your addon locally, and how to publish it.\\n\\n\", \"Addon anatomy\": {\"UI-based addons\": \"The addon built in this guide is a UI-based addon, specifically a [toolbar](./addon-types.mdx#toolbars) addon, enabling users to draw outlines around each element in the story through a shortcut or click of a button. UI addons can create other types of UI elements, each with its function: [panels](./addon-types.mdx#panels) and [tabs](./addon-types.mdx#tabs), providing users with various ways to interact with the UI.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-toolkit-types.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Setup\": {\"Understanding the build system\": \"Addons built in the Storybook ecosystem rely on [tsup](https://tsup.egoist.dev/), a fast, zero-config bundler powered by [esbuild](https://esbuild.github.io/) to transpile your addon's code into modern JavaScript that can run in the browser. Out of the box, the Addon Kit comes with a pre-configured `tsup` configuration file that you can use to customize the build process of your addon.\\n\\nWhen the build scripts run, it will look for the configuration file and pre-bundle the addon's code based on the configuration provided. Addons can interact with Storybook in various ways. They can define presets to modify the configuration, add behavior to the manager UI, or add behavior to the preview iframe. These different use cases require different bundle outputs because they target different runtimes and environments. Presets are executed in a Node environment. Storybook's manager and preview environments provide certain packages in the global scope, so addons don't need to bundle them or include them as dependencies in their `package.json` file.\\n\\nThe `tsup` configuration handles these complexities by default, but you can customize it according to their requirements. For a detailed explanation of the bundling techniques used, please refer to [the README of the addon-kit](https://github.com/storybookjs/addon-kit#bundling), and check out the default `tsup` configuration [here](https://github.com/storybookjs/addon-kit/blob/main/tsup.config.ts).\"}, \"Register the addon\": {\"Conditionally render the addon\": \"Notice the `match` property. It allows you to control the view mode (story or docs) and tab (the story canvas or [custom tabs](./addon-types.mdx#tabs)) where the toolbar addon is visible. For example:\\n\\n[\\\"`({ tabId }) => tabId === 'my-addon/tab'` will show your addon when viewing the tab with the ID `my-addon/tab`.\\\", \\\"`({ viewMode }) => viewMode === 'story'` will show your addon when viewing a story in the canvas.\\\", \\\"`({ viewMode }) => viewMode === 'docs'` will show your addon when viewing the documentation for a component.\\\", \\\"`({ tabId, viewMode }) => !tabId && viewMode === 'story'` will show your addon when viewing a story in the canvas and not in a custom tab (i.e. when `tabId === undefined`).\\\"]\\n\\nRun the `start` script to build and start Storybook and verify that the addon is registered correctly and showing in the UI.\\n\\n\", \"Style the addon\": \"In Storybook, applying styles for addons is considered a side-effect. Therefore, we'll need to make some changes to our addon to allow it to use the styles when it is active and remove them when it's disabled. We're going to rely on two of Storybook's features to handle this: [decorators](../writing-stories/decorators.mdx) and [globals](../essentials/toolbars-and-globals.mdx#globals). To handle the CSS logic, we must include some helper functions to inject and remove the stylesheets from the DOM. Start by creating the helper file with the following content:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-css-helpers.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNext, create the file with the styles we want to inject with the following content:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-css-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nSince the addon can be active in both the story and documentation modes, the DOM node for Storybook's preview `iframe` is different in these two modes. In fact, Storybook renders multiple story previews on one page when in documentation mode. Therefore, we'll need to choose the correct selector for the DOM node where the styles will be injected and ensure the CSS is scoped to that particular selector. That mechanism is provided as an example within the `src/withGlobals.ts` file, which we'll use to connect the styling and helper functions to the addon logic. Update the file to the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-use-global.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Packaging and publishing\": {\"Module Metadata\": \"The first category of metadata is related to the addon itself. This includes the entry for the module, which files to include when the addon is published. And the required configuration to integrate the addon with Storybook, allowing it to be used by its consumers.\\n\\n```\\n{\\n \\\"exports\\\": {\\n \\\".\\\": {\\n \\\"types\\\": \\\"./dist/index.d.ts\\\",\\n \\\"node\\\": \\\"./dist/index.js\\\",\\n \\\"require\\\": \\\"./dist/index.js\\\",\\n \\\"import\\\": \\\"./dist/index.mjs\\\"\\n },\\n \\\"./manager\\\": \\\"./dist/manager.mjs\\\",\\n \\\"./preview\\\": \\\"./dist/preview.mjs\\\",\\n \\\"./package.json\\\": \\\"./package.json\\\"\\n },\\n \\\"main\\\": \\\"dist/index.js\\\",\\n \\\"module\\\": \\\"dist/index.mjs\\\",\\n \\\"types\\\": \\\"dist/index.d.ts\\\",\\n \\\"files\\\": [\\\"dist/**/*\\\", \\\"README.md\\\", \\\"*.js\\\", \\\"*.d.ts\\\"],\\n \\\"devDependencies\\\": {\\n \\\"@storybook/addon-docs\\\": \\\"^9.0.0\\\",\\n \\\"storybook\\\": \\\"^9.0.0\\\"\\n },\\n \\\"bundler\\\": {\\n \\\"exportEntries\\\": [\\\"src/index.ts\\\"],\\n \\\"managerEntries\\\": [\\\"src/manager.ts\\\"],\\n \\\"previewEntries\\\": [\\\"src/preview.ts\\\"]\\n }\\n}\\n```\", \"Integration Catalog Metadata\": \"The second metadata category is related to the [integration catalog](https://storybook.js.org/integrations). Most of this information is already pre-configured by the Addon Kit. However, items like the display name, icon, and frameworks must be configured via the `storybook` property to be displayed in the catalog.\\n\\n```\\n{\\n \\\"name\\\": \\\"my-storybook-addon\\\",\\n \\\"version\\\": \\\"1.0.0\\\",\\n \\\"description\\\": \\\"My first storybook addon\\\",\\n \\\"author\\\": \\\"Your Name\\\",\\n \\\"storybook\\\": {\\n \\\"displayName\\\": \\\"My Storybook Addon\\\",\\n \\\"unsupportedFrameworks\\\": [\\\"react-native\\\"],\\n \\\"icon\\\": \\\"https://yoursite.com/link-to-your-icon.png\\\"\\n },\\n \\\"keywords\\\": [\\\"storybook-addons\\\", \\\"appearance\\\", \\\"style\\\", \\\"css\\\", \\\"layout\\\", \\\"debug\\\"]\\n}\\n```\\n\\n<Callout variant=\\\"info\\\">\\nThe `storybook` configuration element includes additional properties that help customize the addon's searchability and indexing. For more information, see the [Integration catalog documentation](./integration-catalog.mdx).\\n</Callout>\\n\\nOne essential item to note is the `keywords` property as it maps to the catalog's tag system. Adding the `storybook-addons` ensures that the addon is discoverable in the catalog when searching for addons. The remaining keywords help with the searchability and categorization of the addon.\", \"Publishing to NPM\": \"Once you're ready to publish your addon to NPM, the Addon Kit comes pre-configured with the [Auto](https://github.com/intuit/auto) package for release management. It generates a changelog and uploads the package to NPM and GitHub automatically. Therefore, you need to configure access to both.\\n\\n['Authenticate using [npm adduser](https://docs.npmjs.com/cli/v9/commands/npm-adduser)', 'Generate a [access token](https://docs.npmjs.com/creating-and-viewing-access-tokens#creating-access-tokens) with both `read` and `publish` permissions.', 'Create a [personal access token](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `repo` and `workflow` scoped permissions.', 'Create a `.env` file in the root of your project and add the following:']\\n\\n```\\nGH_TOKEN=value_you_just_got_from_github\\nNPM_TOKEN=value_you_just_got_from_npm\\n```\\n\\nNext, run the following command to create labels on GitHub. You'll use these labels to categorize changes to the package.\\n\\n```\\nnpx auto create-labels\\n```\\n\\nFinally, run the following command to create a release for your addon. This will build and package the addon code, bump the version, push the release into GitHub and npm, and generate a changelog.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-release.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"CI automation\": \"By default, the Addon Kit comes pre-configured with a GitHub Actions workflow, enabling you to automate the release management process. This ensures that the package is always up to date with the latest changes and that the changelog is updated accordingly. However, you'll need additional configuration to use your NPM and GitHub tokens to publish the package successfully. In your repository, click the **Settings** tab, then the **Secrets and variables** dropdown, followed by the **Actions** item. You should see the following screen:\\n\\n\\n\\nThen, click the **New repository secret**, name it `NPM_TOKEN`, and paste the token you generated earlier. Whenever you merge a pull request to the default branch, the workflow will run and publish a new release, automatically incrementing the version number and updating the changelog.\\n\\n**Learn more about the Storybook addon ecosystem**\\n\\n['[Types of addons](./addon-types.mdx) for other types of addons', 'Writing addons for the basics of addon development', '[Presets](./writing-presets.mdx) for preset development', '[Integration catalog](./integration-catalog.mdx) for requirements and available recipes', '[API reference](./addons-api.mdx) to learn about the available APIs']\"}}, \"metadata\": {\"title\": \"Write an addon\", \"sidebar\": {\"order\": 2, \"title\": \"Write\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\"}, {\"title\": \"Write a preset addon\", \"description\": null, \"content\": {\"How presets work\": {\"Local presets\": \"This type of preset allows you to encapsulate and organize configurations specific to the addon, including [builder](../builders/index.mdx) support, [Babel](https://babeljs.io/), or third-party integrations. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-local-preset.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Root-level presets\": \"This type of preset is user-facing and responsible for registering the addon without any additional configuration from the user by bundling Storybook-related features (e.g., [parameters](../writing-stories/parameters.mdx)) via the [`previewAnnotations`](../api/main-config/main-config-preview-annotations.mdx) and UI related features (e.g., addons) via the `managerEntries` API. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-root-preset.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Presets API\": {\"Babel\": \"To customize Storybook's Babel configuration and add support for additional features, you can use the [`babelDefault`](../api/main-config/main-config-babel-default.mdx) API. It will apply the provided configuration ahead of any other user presets, which can be further customized by the end user via the [`babel`](../api/main-config/main-config-babel.mdx) configuration option. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-preset-babelDefault.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe Babel configuration is only applied to frameworks that use Babel internally. If you enable it for a framework that uses a different compiler, like [SWC](https://swc.rs/) or [esbuild](https://esbuild.github.io/), it will be ignored.\\n</Callout>\", \"Builders\": {\"Vite\": \"If you are creating a preset and want to include Vite support, the `viteFinal` API can be used to modify the default configuration and enable additional features. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-preset-viteFinal.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Webpack\": \"To customize the Webpack configuration in Storybook to add support for additional file types, apply specific loaders, configure plugins, or make any other necessary modifications, you can use the `webpackFinal` API. Once invoked, it will extend the default Webpack configuration with the provided configuration. An example of this would be:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-preset-webpackFinal.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"ManagerEntries\": \"If you're writing a preset that loads third-party addons, which you may not have control over, but require access to specific features or additional configuration, you can use the `managerEntries` API. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-root-preset-manager-entries.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"PreviewAnnotations\": \"If you need additional settings to render stories for a preset, like [decorators](../writing-stories/decorators.mdx) or [parameters](../writing-stories/parameters.mdx), you can use the `previewAnnotations` API. For example, to apply a decorator to all stories, create a preview file that includes the decorator and make it available to the preset as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addons-preset-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Advanced configuration\": {\"Addons\": \"For addon consumers, the [`managerEntries`](#managerentries) API can be too technical, making it difficult to use. To make it easier to add addons to Storybook, the preset API provides the [`addons`](../api/main-config/main-config-addons.mdx) API, which accepts an array of addon names and will automatically load them for you. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-register-example-addon.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe array of values supports references to additional presets and addons that should be included in the manager. Storybook will automatically detect whether the provided value is a preset or an addon and load it accordingly.\", \"Entries\": \"Entries are the place to register entry points for the preview. This feature can be utilized to create a configure-storybook preset that automatically loads all `*.stories.js` files into Storybook, eliminating the need for users to copy-paste the same configuration repeatedly.\", \"UI configuration\": \"The Storybook preset API also provides access to the UI configuration, including the `head` and `body` HTML elements of the preview, configured by the [`previewHead`](../api/main-config/main-config-preview-head.mdx) and [`previewBody`](../api/main-config/main-config-preview-body.mdx) APIs. Both allow you to set up Storybook in a way that is similar to using the [`preview-head.html`](../configure/story-rendering.mdx#adding-to-head) and [`preview-body.html`](../configure/story-rendering.mdx#adding-to-body) files. These methods accept a string and return a modified version, injecting the provided content into the HTML element.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdditionally, if you need to customize the manager (i.e., where Storybook\\u2019s search, navigation, toolbars, and addons render), you can use the [`managerHead`](../api/main-config/main-config-manager-head.mdx) to modify the UI, similar to how you would do it with the `manager-head.html` file. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-custom-manager-head.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nHowever, if you need, you can also customize the template used by Storybook to render the UI. To do so, you can use the `previewMainTemplate` API and provide a reference for a custom template created as a `ejs` file. For an example of how to do this, see the [template](https://github.com/storybookjs/storybook/blob/next/code/builders/builder-webpack5/templates/preview.ejs) used by the Webpack 5 builder.\"}, \"Troubleshooting\": {\"Storybook doesn't load files in my preset\": \"As Storybook relies on [esbuild](https://esbuild.github.io/) instead of Webpack to build the UI, presets that depend on the `managerWebpack` API to configure the manager or load additional files other than CSS or images will no longer work. We recommend removing it from your preset and adjusting your configuration to convert any additional files to JavaScript.\\n\\n**Learn more about the Storybook addon ecosystem**\\n\\n['[Types of addons](./addon-types.mdx) for other types of addons', '[Writing addons](./writing-addons.mdx) for the basics of addon development', 'Presets for preset development', '[Integration catalog](./integration-catalog.mdx) for requirements and available recipes', '[API reference](./addons-api.mdx) to learn about the available APIs']\"}}, \"metadata\": {\"title\": \"Write a preset addon\", \"sidebar\": {\"order\": 4, \"title\": \"Write a preset\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\"}], \"path\": \"[\\\"subpages\\\", 3]\"}, {\"title\": \"Api\", \"description\": \"Documentation section: api\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/api\"}, \"subpages\": [{\"title\": \"ArgTypes\", \"description\": null, \"content\": {\"Automatic argType inference\": \"If you are using the Storybook [docs](../writing-docs/index.mdx) addon, then Storybook will infer a set of argTypes for each story based on the `component` specified in the [default export](../writing-stories/index.mdx#default-export) of the CSF file.\\n\\nTo do so, Storybook uses various static analysis tools depending on your framework.\\n\\n| Framework | Static analysis tool |\\n| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| React | [react-docgen](https://github.com/reactjs/react-docgen) (default) or [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript) |\\n| Vue | [vue-docgen-api](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api) |\\n| Angular | [compodoc](https://compodoc.app/) |\\n| WebComponents | [custom-element.json](https://github.com/webcomponents/custom-elements-json) |\\n| Ember | [YUI doc](https://github.com/ember-learn/ember-cli-addon-docs-yuidoc#documenting-components) |\\n\\nThe data structure of `argTypes` is designed to match the output of the these tools. Properties specified manually will override what is inferred.\", \"Manually specifying argTypes\": \"For most Storybook projects, argTypes are [automatically inferred](#automatic-argtype-inference) from your components. Any argTypes specified manually will override the inferred values.\\n\\nArgTypes are most often specified at the meta (component) level, in the [default export](../writing-stories/index.mdx#default-export) of the CSF file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThey can apply to all stories when specified at the project (global) level, in the `preview.js|ts` configuration file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr they can apply only to a [specific story](../writing-stories/index.mdx#defining-stories):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`argTypes`\": {\"`control`\": {\"`control.type`\": \"Type: `ControlType | null`\\n\\nDefault: [Inferred](#automatic-argtype-inference); `'select'`, if [`options`](#options) are specified; falling back to `'object'`\\n\\nSpecifies the type of control used to change the arg value with the [controls panel](../essentials/controls.mdx). Here are the available types, `ControlType`, grouped by the type of data they handle:\\n\\n| Data\\u00a0type | ControlType | Description |\\n| -------------- | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| **array** | `'object'` | Provides a JSON-based editor to handle the values of the array. Also allows editing in raw mode.<br /> `{ control: 'object' }` |\\n| **boolean** | `'boolean'` | Provides a toggle for switching between possible states.<br /> `{ control: 'boolean' }` |\\n| **enum** | `'check'` | Provides a set of stacked checkboxes for selecting multiple options.<br /> `{ control: 'check', options: ['email', 'phone', 'mail'] }` |\\n| | `'inline-check'` | Provides a set of inlined checkboxes for selecting multiple options.<br /> `{ control: 'inline-check', options: ['email', 'phone', 'mail'] }` |\\n| | `'radio'` | Provides a set of stacked radio buttons based on the available options.<br /> `{ control: 'radio', options: ['email', 'phone', 'mail'] }` |\\n| | `'inline-radio'` | Provides a set of inlined radio buttons based on the available options.<br /> `{ control: 'inline-radio', options: ['email', 'phone', 'mail'] }` |\\n| | `'select'` | Provides a select to choose a single value from the options.<br /> `{ control: 'select', options: [20, 30, 40, 50] }` |\\n| | `'multi-select'` | Provides a select to choose multiple values from the options.<br /> `{ control: 'multi-select', options: ['USA', 'Canada', 'Mexico'] }` |\\n| **number** | `'number'` | Provides a numeric input to include the range of all possible values.<br /> `{ control: { type: 'number', min:1, max:30, step: 2 } }` |\\n| | `'range'` | Provides a range slider to include all possible values.<br /> `{ control: { type: 'range', min: 1, max: 30, step: 3 } }` |\\n| **object** | `'file'` | Provides a file input that returns an array of URLs. Can be further customized to accept specific file types.<br /> `{ control: { type: 'file', accept: '.png' } }` |\\n| | `'object'` | Provides a JSON-based editor to handle the object's values. Also allows editing in raw mode.<br /> `{ control: 'object' }` |\\n| **string** | `'color'` | Provides a color picker to choose color values. Can be additionally configured to include a set of color presets.<br /> `{ control: { type: 'color', presetColors: ['red', 'green']} }` |\\n| | `'date'` | Provides a datepicker to choose a date.<br /> `{ control: 'date' }` |\\n| | `'text'` | Provides a freeform text input.<br /> `{ control: 'text' }` |\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe `date` control will convert the date into a UNIX timestamp when the value changes. It's a known limitation that will be fixed in a future release. If you need to represent the actual date, you'll need to update the story's implementation and convert the value into a date object.\\n</Callout>\", \"`control.accept`\": \"Type: `string`\\n\\nWhen `type` is `'file'`, you can specify the file types that are accepted. The value should be a string of comma-separated MIME types.\", \"`control.labels`\": \"Type: `{ [option: string]: string }`\\n\\nMap [`options`](#options) to labels. `labels` doesn't have to be exhaustive. If an option is not in the object's keys, it's used verbatim.\", \"`control.max`\": \"Type: `number`\\n\\nWhen `type` is `'number'` or `'range'`, sets the maximum allowed value.\", \"`control.min`\": \"Type: `number`\\n\\nWhen `type` is `'number'` or `'range'`, sets the minimum allowed value.\", \"`control.presetColors`\": \"Type: `string[]`\\n\\nWhen `type` is `'color'`, defines the set of colors that are available in addition to the general color picker. The values in the array should be valid CSS color values.\", \"`control.step`\": \"Type: `number`\\n\\nWhen `type` is `'number'` or `'range'`, sets the granularity allowed when incrementing/decrementing the value.\"}, \"`description`\": \"Type: `string`\\n\\nDefault: [Inferred](#automatic-argtype-inference)\\n\\nDescribe the arg. (If you intend to describe the type of the arg, you should use [`table.type`](#tabletype), instead.)\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-description.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`if`\": \"Type:\\n\\n```\\n{\\n [predicateType: 'arg' | 'global']: string;\\n eq?: any;\\n exists?: boolean;\\n neq?: any;\\n truthy?: boolean;\\n}\\n```\\n\\nConditionally render an argType based on the value of another [arg](../writing-stories/args.mdx) or [global](../essentials/toolbars-and-globals.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-if.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`mapping`\": \"Type: `{ [key: string]: { [option: string]: any } }`\\n\\nMap [`options`](#options) to values.\\n\\nWhen dealing with non-primitive values, you'll notice that you'll run into some limitations. The most obvious issue is that not every value can be represented as part of the `args` param in the URL, losing the ability to share and deeplink to such a state. Beyond that, complex values such as JSX cannot be synchronized between the manager (e.g., Controls panel) and the preview (your story).\\n\\n`mapping` doesn't have to be exhaustive. If the currently selected option is not listed, it's used verbatim. Can be used with [`control.labels`](#labels).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-mapping.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`name`\": \"Type: `string`\\n\\nThe `argTypes` object uses the name of the arg as the key. By default, that key is used when displaying the argType in Storybook. You can override the displayed name by specifying a `name` property.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-name.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"warning\\\">\\nBe careful renaming args in this way. Users of the component you're documenting will not be able to use the documented name as a property of your component and the actual name will not displayed.\\n\\nFor this reason, the `name` property is best used when defining an `argType` that is only used for documentation purposes and not an actual property of the component. For example, when [providing argTypes for each property of an object](https://stackblitz.com/edit/github-uplqzp?file=src/stories/Button.stories.tsx).\\n</Callout>\", \"`options`\": \"Type: `string[]`\\n\\nDefault: [Inferred](#automatic-argtype-inference)\\n\\nIf the arg accepts a finite set of values, you can specify them with `options`. If those values are [complex](../essentials/controls.mdx#dealing-with-complex-values), like JSX elements, you can use [`mapping`](#mapping) to map them to string values. You can use [`control.labels`](#labels) to provide custom labels for the options.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`table`\": {\"`table.category`\": \"Type: `string`\\n\\nDefault: [Inferred](#automatic-argtype-inference), in some frameworks\\n\\nDisplay the argType under a category heading, with the label specified by `category`.\", \"`table.defaultValue`\": \"Type: `{ detail?: string; summary: string }`\\n\\nDefault: [Inferred](#automatic-argtype-inference)\\n\\nThe documented default value of the argType. `summary` is typically used for the value itself, while `detail` is used for additional information.\", \"`table.disable`\": \"Type: `boolean`\\n\\nSet to `true` to remove the argType's row from the table.\", \"`table.readonly`\": \"Type: `boolean`\\n\\nSet to `true` to indicate that the argType is read-only.\", \"`table.subcategory`\": \"Type: `string`\\n\\nDisplay the argType under a subcategory heading (which displays under the \\\\[`category`] heading), with the label specified by `subcategory`.\", \"`table.type`\": \"Type: `{ detail?: string; summary: string }`\\n\\nDefault: Inferred from [`type`](#type)\\n\\nThe documented type of the argType. `summary` is typically used for the type itself, while `detail` is used for additional information.\\n\\nIf you need to specify the actual, semantic type, you should use [`type`](#type), instead.\"}, \"`type`\": \"Type: `'boolean' | 'function' | 'number' | 'string' | 'symbol' | SBType`\\n\\nThe full type of `SBType` is:\\n\\n<details>\\n<summary>SBType</summary>\\n\\n```\\ninterface SBBaseType {\\n required?: boolean;\\n raw?: string;\\n}\\n\\ntype SBScalarType = SBBaseType & {\\n name: 'boolean' | 'string' | 'number' | 'function' | 'symbol';\\n};\\n\\ntype SBArrayType = SBBaseType & {\\n name: 'array';\\n value: SBType;\\n};\\ntype SBObjectType = SBBaseType & {\\n name: 'object';\\n value: Record<string, SBType>;\\n};\\ntype SBEnumType = SBBaseType & {\\n name: 'enum';\\n value: (string | number)[];\\n};\\ntype SBIntersectionType = SBBaseType & {\\n name: 'intersection';\\n value: SBType[];\\n};\\ntype SBUnionType = SBBaseType & {\\n name: 'union';\\n value: SBType[];\\n};\\ntype SBOtherType = SBBaseType & {\\n name: 'other';\\n value: string;\\n};\\n\\ntype SBType =\\n | SBScalarType\\n | SBEnumType\\n | SBArrayType\\n | SBObjectType\\n | SBIntersectionType\\n | SBUnionType\\n | SBOtherType;\\n```\\n\\n</details>\\n\\nDefault: [Inferred](#automatic-argtype-inference)\\n\\nSpecifies the semantic type of the argType. When an argType is [inferred](#automatic-argtype-inference), the information from the various tools is summarized in this property, which is then used to infer other properties, like [`control`](#control) and [`table.type`](#tabletype).\\n\\nIf you only need to specify the documented type, you should use [`table.type`](#tabletype), instead.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-type.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`defaultValue`\": \"(\\u26d4\\ufe0f **Deprecated**)\\n\\nType: `any`\\n\\nDefine the default value of the argType. Deprecated in favor of defining the [`arg`](../writing-stories/args.mdx) value directly.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-default-value.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"ArgTypes\", \"sidebar\": {\"order\": 3, \"title\": \"ArgTypes\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}, {\"title\": \"CLI options\", \"description\": null, \"content\": {\"CLI commands\": {\"`dev`\": \"Compiles and serves a development build of your Storybook that reflects your source code changes in the browser in real-time. It should be run from the root of your project.\\n\\n```\\nstorybook dev [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `--help` | Output usage information.<br />`storybook dev --help` |\\n| `-V`, `--version` | Output the version number.<br />`storybook dev -V` |\\n| `-p`, `--port [number]` | Port to run Storybook.<br />`storybook dev -p 9009` |\\n| `--exact-port [number]` | Attempts to run Storybook on the exact port number specified.<br />If the port is already in use, Storybook will exit with an error message.<br />`storybook dev --exact-port 9009` |\\n| `-h`, `--host [string]` | Host to run Storybook.<br />`storybook dev -h my-host.com` |\\n| `-c`, `--config-dir [dir-name]` | Storybook configuration directory.<br />`storybook dev -c .storybook` |\\n| `--loglevel [level]` | Controls level of logging during build.<br />Available options: `silly`, `verbose`, `info` (default), `warn`, `error`, `silent`<br />`storybook dev --loglevel warn` |\\n| `--https` | Serve Storybook over HTTPS. Note: You must provide your own certificate information.<br />`storybook dev --https` |\\n| `--ssl-ca` | Provide an SSL certificate authority. (Optional with --https, required if using a self-signed certificate)<br />`storybook dev --ssl-ca my-certificate` |\\n| `--ssl-cert` | Provide an SSL certificate. (Required with --https)<br />`storybook dev --ssl-cert my-ssl-certificate` |\\n| `--ssl-key` | Provide an SSL key. (Required with --https)<br />`storybook dev --ssl-key my-ssl-key` |\\n| `--smoke-test` | Exit after successful start.<br />`storybook dev --smoke-test` |\\n| `--ci` | CI mode (skip interactive prompts, don't open browser).<br />`storybook dev --ci` |\\n| `--no-open` | Do not open Storybook automatically in the browser.<br />`storybook dev --no-open` |\\n| `--quiet` | Suppress verbose build output.<br />`storybook dev --quiet` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook dev --debug` |\\n| `--debug-webpack` | Display final webpack configurations for debugging purposes.<br />`storybook dev --debug-webpack` |\\n| `--stats-json [dir-name]` | Write stats JSON to disk.<br />Requires Webpack<br />`storybook dev --stats-json /tmp/stats` |\\n| `--no-version-updates` | Skips Storybook's update check.<br />`storybook dev --no-version-updates` |\\n| `--docs` | Starts Storybook in documentation mode. Learn more about it in [here](../writing-docs/build-documentation.mdx#preview-storybooks-documentation).<br />`storybook dev --docs` |\\n| `--initial-path [path]` | Configures the URL Storybook should open when it opens the browser for the first time.<br />`storybook dev --initial-path=/docs/getting-started--docs` |\\n| `--preview-url [path]` | Overrides the default Storybook preview with a custom built preview URL.<br />`storybook dev --preview-url=http://localhost:1337/external-iframe.html` |\\n| `--force-build-preview` | Forcefully builds Storybook's preview iframe.<br />Useful if you're experiencing issues, or combined with `--preview-url` to ensure the preview is up-to-date.<br />`storybook dev --force-build-preview` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook dev --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook dev --enable-crash-reports` |\\n| `--preview-only` | Skips Storybook's manager from building and opens the app in \\\"preview only\\\" mode, which is designed to be used in [unsupported browsers](../sharing/publish-storybook.mdx#build-storybook-for-older-browsers). <br />`storybook dev --preview-only` |\\n\\n<Callout variant=\\\"warning\\\" id=\\\"static-dir-deprecation\\\">\\nWith the release of Storybook 8, the `-s` CLI flag was removed. We recommend using the [static\\ndirectory](../configure/integration/images-and-assets.mdx#serving-static-files-via-storybook)\\ninstead if you need to serve static files.\\n</Callout>\", \"`build`\": \"Compiles your Storybook instance so it can be [deployed](../sharing/publish-storybook.mdx). It should be run from the root of your project.\\n\\n```\\nstorybook build [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook build --help` |\\n| `-V`, `--version` | Output the version number.<br />`storybook build -V` |\\n| `-o`, `--output-dir [dir-name]` | Directory where to store built files.<br />`storybook build -o /my-deployed-storybook` |\\n| `-c`, `--config-dir [dir-name]` | Storybook configuration directory.<br />`storybook build -c .storybook` |\\n| `--loglevel [level]` | Controls level of logging during build.<br />Available options: `silly`, `verbose`, `info` (default), `warn`, `error`, `silent`.<br />`storybook build --loglevel warn` |\\n| `--quiet` | Suppress verbose build output.<br />`storybook build --quiet` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook build --debug` |\\n| `--debug-webpack` | Display final webpack configurations for debugging purposes.<br />`storybook build --debug-webpack` |\\n| `--stats-json [dir-name]` | Write stats JSON to disk.<br />Requires Webpack<br />`storybook build --stats-json /tmp/stats` |\\n| `--docs` | Builds Storybook in documentation mode. Learn more about it in [here](../writing-docs/build-documentation.mdx#publish-storybooks-documentation).<br />`storybook build --docs` |\\n| `--test` | Optimize Storybook's production build for performance and tests by removing unnecessary features with the `test` option. Learn more [here](../api/main-config/main-config-build.mdx).<br />`storybook build --test` |\\n| `--preview-url [path]` | Overrides the default Storybook preview with a custom built preview URL.<br />`storybook build --preview-url=http://localhost:1337/external-iframe.html` |\\n| `--force-build-preview` | Forcefully builds Storybook's preview iframe.<br />Useful if you're experiencing issues, or combined with `--preview-url` to ensure the preview is up-to-date.<br />`storybook build --force-build-preview` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook build --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook build --enable-crash-reports` |\\n| `--preview-only` | Skips Storybook's manager from building and produces a \\\"preview only\\\" app, which is designed to be used in [unsupported browsers](../sharing/publish-storybook.mdx#build-storybook-for-older-browsers). <br />`storybook build --preview-only` |\", \"`init`\": \"<Callout variant=\\\"info\\\">\\nWe recommend [`create-storybook`](#create-storybook) for new projects. The `init` command will\\nremain available for backwards compatibility.\\n</Callout>\\n\\nInstalls and initializes the specified version (e.g., `@latest`, `@8`, `@next`) of Storybook into your project. If no version is specified, the latest version is installed. Read more in the [installation guide](../get-started/install.mdx).\\n\\n```\\nstorybook[@version] init [options]\\n```\\n\\nFor example, `storybook@8.4 init` will install Storybook 8.4 into your project.\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook init --help` |\\n| `-b`, `--builder` | Defines the [builder](../builders/index.mdx) to use for your Storybook instance.<br />`storybook init --builder webpack5` |\\n| `-f`, `--force` | Forcefully installs Storybook into your project, prompting you to overwrite existing files.<br />`storybook init --force` |\\n| `-s`, `--skip-install` | Skips the dependency installation step. Used only when you need to configure Storybook manually.<br />`storybook init --skip-install` |\\n| `-t`, `--type` | Defines the [framework](../configure/integration/frameworks.mdx) to use for your Storybook instance.<br />`storybook init --type solid` |\\n| `-y`, `--yes` | Skips interactive prompts and automatically installs Storybook per specified version, including all features.<br />`storybook init --yes` |\\n| `--features [...values]` | Use these features when installing, skipping the prompt. Supported values are `docs` and `test`, space separated.<br />`storybook init --features docs test` |\\n| `--package-manager` | Sets the package manager to use when installing Storybook.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook init --package-manager pnpm` |\\n| `--use-pnp` | Enables [Plug'n'Play](https://yarnpkg.com/features/pnp) support for Yarn. This option is only available when using Yarn as your package manager.<br />`storybook init --use-pnp` |\\n| `-p`, `--parser` | Sets the [jscodeshift parser](https://github.com/facebook/jscodeshift#parser).<br />Available parsers include `babel`, `babylon`, `flow`, `ts`, and `tsx`.<br />`storybook init --parser tsx` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook init --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook init --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook init --enable-crash-reports` |\\n| `--no-dev` | Complete the initialization of Storybook without running the Storybook dev server.<br />`storybook init --no-dev` |\", \"`add`\": \"Installs a Storybook addon and configures your project for it. Read more in the [addon installation guide](../addons/install-addons.mdx).\\n\\n```\\nstorybook add [addon] [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook add --help` |\\n| `-c`, `--config-dir` | Storybook configuration directory.<br />`storybook migrate --config-dir .storybook` |\\n| `--package-manager` | Sets the package manager to use when installing the addon.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook add [addon] --package-manager pnpm` |\\n| `-s`, `--skip-postinstall` | Skips post-install configuration. Used only when you need to configure the addon yourself.<br />`storybook add [addon] --skip-postinstall` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook add --debug` |\", \"`remove`\": \"Deletes a Storybook addon from your project. Read more in the [addon installation guide](../addons/install-addons.mdx#removing-addons).\\n\\n```\\nstorybook remove [addon] [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `-h`, `--help` | Output usage information.<br />`storybook remove --help` |\\n| `--package-manager` | Sets the package manager to use when removing the addon.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook remove [addon]--package-manager pnpm` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook remove --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook remove --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook remove --enable-crash-reports` |\", \"`upgrade`\": \"Upgrades your Storybook instance to the specified version (e.g., `@latest`, `@8`, `@next`). Read more in the [upgrade guide](../releases/upgrading.mdx).\\n\\n```\\nstorybook[@version] upgrade [options]\\n```\\n\\nFor example, `storybook@latest upgrade --dry-run` will perform a dry run (no actual changes) of upgrading your project to the latest version of Storybook.\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook upgrade --help` |\\n| `-c, --config-dir <dir-name...>` | Directory or directories to find Storybook configurations<br />`storybook upgrade --config-dir .storybook` |\\n| `-n`, `--dry-run` | Checks for version upgrades without installing them.<br />`storybook upgrade --dry-run` |\\n| `-s`, `--skip-check` | Skips the migration check step during the upgrade process.<br />`storybook upgrade --skip-check` |\\n| `-y`, `--yes` | Skips interactive prompts and automatically upgrades Storybook to the latest version.<br />`storybook upgrade --yes` |\\n| `-f`,`--force` | Force the upgrade, skipping autoblockers check.<br />`storybook upgrade --force` |\\n| `--package-manager` | Sets the package manager to use when upgrading Storybook.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook upgrade --package-manager pnpm` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook upgrade --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook upgrade --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook upgrade --enable-crash-reports` |\\n| `--write-logs` | Write all debug logs to a file at the end of the run.<br />`storybook upgrade --write-logs` |\\n| `--loglevel <level>` | Define log level: `debug`, `error`, `info`, `silent`, `trace`, or `warn` (default: `info`).<br />`storybook upgrade --loglevel debug` |\", \"`migrate`\": \"Runs the provided codemod to ensure your Storybook project is compatible with the specified version. Read more in the [migration guide](../releases/upgrading.mdx).\\n\\n```\\nstorybook[@version] migrate [codemod] [options]\\n```\\n\\n<Callout variant=\\\"info\\\">\\nThe command requires the codemod name (e.g., `csf-2-to-3`) as an argument to apply the necessary\\nchanges to your project. You can find the list of available codemods by running `storybook migrate\\n--list`.\\n</Callout>\\n\\nFor example, `storybook@latest migrate csf-2-to-3 --dry-run`, checks your project to verify if the codemod can be applied without making any changes, providing you with a report of which files would be affected.\\n\\nOptions include:\\n\\n| Option | Description |\\n| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `-h`, `--help` | Output usage information.<br />`storybook migrate --help` |\\n| `-c`, `--config-dir` | Storybook configuration directory.<br />`storybook migrate --config-dir .storybook` |\\n| `-n`, `--dry-run` | Verify the migration exists and show the files to which it will be applied.<br />`storybook migrate --dry-run` |\\n| `-l`, `--list` | Shows a list of available codemods.<br />`storybook migrate --list` |\\n| `-g`, `--glob` | Glob for files upon which to apply the codemods.<br />`storybook migrate --glob src/**/*.stories.tsx` |\\n| `-p`, `--parser` | Sets the [jscodeshift parser](https://github.com/facebook/jscodeshift#parser).<br />Available parsers include `babel`, `babylon`, `flow`, `ts`, and `tsx`.<br />`storybook migrate --parser tsx` |\\n| `-r`, `--rename [from-to]` | Renames the files affected by the codemod to include the provided suffix.<br />`storybook migrate --rename \\\".js:.ts\\\"` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook migrate --debug` |\", \"`automigrate`\": \"Perform standard configuration checks to determine if your Storybook project can be automatically migrated to the specified version. Read more in the [migration guide](../releases/upgrading.mdx#automigrate-script).\\n\\n```\\nstorybook[@version] automigrate [fixId] [options]\\n```\\n\\nFor example, `storybook@latest automigrate --dry-run` scans your project for potential migrations that can be applied automatically without making any changes.\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook automigrate --help` |\\n| `-c`, `--config-dir` | Storybook configuration directory.<br />`storybook automigrate --config-dir .storybook` |\\n| `-n`, `--dry-run` | Checks for available migrations without applying them.<br />`storybook automigrate --dry-run` |\\n| `-s`, `--skip-install` | Skip installing dependencies whenever applicable.<br />`storybook automigrate --skip-install` |\\n| `-y`, `--yes` | Applies available migrations automatically without prompting for confirmation.<br />`storybook automigrate --yes` |\\n| `-l`, `--list` | Shows a list of available automigrations.<br />`storybook automigrate --list` |\\n| `--package-manager` | Sets the package manager to use when running the auto migration.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook automigrate --package-manager pnpm` |\\n| `--renderer` | Specifies Storybook's renderer to use when running the automigration.<br />Useful for monorepo environments where multiple Storybook instances can exist in the same project.<br />`storybook automigrate --renderer vue` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook automigrate --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook automigrate --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook automigrate --enable-crash-reports` |\", \"`doctor`\": \"Performs a health check on your Storybook project for common issues (e.g., duplicate dependencies, incompatible addons or mismatched versions) and provides suggestions on how to fix them. Applicable when [upgrading](../releases/upgrading.mdx#verifying-the-upgrade) Storybook versions.\\n\\n```\\nstorybook doctor [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook doctor --help` |\\n| `-c`, `--config-dir` | Storybook configuration directory.<br />`storybook doctor --config-dir .storybook` |\\n| `--package-manager` | Sets the package manager to use when running the health check.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`storybook doctor --package-manager pnpm` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook doctor --debug` |\", \"`info`\": \"Reports useful debugging information about your environment. Helpful in providing information when opening an issue or a discussion.\\n\\n```\\nstorybook info\\n```\\n\\nExample output:\\n\\n```\\nStorybook Environment Info:\\n\\n System:\\n OS: macOS 14.2\\n CPU: (8) arm64 Apple M3\\n Shell: 5.9 - /bin/zsh\\n Binaries:\\n Node: 18.19.0 - ~/.nvm/versions/node/v18.19.0/bin/node\\n npm: 10.2.3 - ~/.nvm/versions/node/v18.19.0/bin/npm <----- active\\n Browsers:\\n Chrome: 120.0.6099.199\\n npmPackages:\\n @storybook/addon-onboarding: ^1.0.10 => 1.0.10\\n @storybook/react: ^7.6.6 => 7.6.6\\n @storybook/react-vite: ^7.6.6 => 7.6.6\\n storybook: ^7.6.6 => 7.6.6\\n npmGlobalPackages:\\n chromatic: ^10.2.0 => 10.2.0\\n```\", \"`index`\": \"Build an `index.json` that lists all stories and docs entries in your Storybook.\\n\\n```\\nstorybook index [options]\\n```\\n\\nOptions include:\\n\\n| Option | Description |\\n| --------------------------------- | ------------------------------------------------------ |\\n| `-o`, `--output-file <file-name>` | JSON file to output index |\\n| `-c`, `--config-dir <dir-name>` | Storybook configuration directory |\\n| `--quiet` | Suppress verbose build output |\\n| `--loglevel <level>` | Control level of logging during build |\\n| `--disable-telemetry` | Disables Storybook's telemetry |\\n| `--debug` | Outputs more logs in the CLI to assist debugging. |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry |\", \"`sandbox`\": \"Generates a local sandbox project using the specified version (e.g., `@latest`, `@8`, `@next`) for testing Storybook features based on the list of supported [frameworks](../configure/integration/frameworks.mdx). Useful for reproducing bugs when opening an issue or a discussion.\\n\\n```\\nstorybook[@version] sandbox [framework-filter] [options]\\n```\\n\\nFor example, `storybook@next sandbox` will generated sandboxes using the newest pre-release version of Storybook.\\n\\nThe `framework-filter` argument is optional and can filter the list of available frameworks. For example, `storybook@next sandbox react` will only offer to generate React-based sandboxes.\\n\\nOptions include:\\n\\n| Option | Description |\\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `-h`, `--help` | Output usage information.<br />`storybook sandbox --help` |\\n| `-o`, `--output [dir-name]` | Configures the location of the sandbox project.<br />`storybook sandbox --output /my-sandbox-project` |\\n| `--no-init` | Generates a sandbox project without initializing Storybook.<br />`storybook sandbox --no-init` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`storybook sandbox --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`storybook sandbox --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`storybook sandbox --enable-crash-reports` |\\n\\n<Callout variant=\\\"info\\\">\\nIf you're looking for a hosted version of the available sandboxes, see\\n[storybook.new](https://storybook.new).\\n</Callout>\"}, \"`create-storybook`\": \"To streamline the process of creating a new Storybook project, a separate CLI called `create-storybook` is provided. Package managers such as npm, pnpm, and Yarn will execute this command when running `create storybook`. You can specify a version (e.g., `@latest`, `@8`, `@next`) or it will default to the latest version. Read more in the [installation guide](../get-started/install.mdx).\\n\\n```\\ncreate storybook[@version] [options]\\n```\\n\\nFor example, `create storybook@8.6` will install Storybook 8.6 into your project.\\n\\nOptions include:\\n\\n| Option | Description |\\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `-h`, `--help` | Output usage information.<br />`create storybook --help` |\\n| `-b`, `--builder` | Defines the [builder](../builders/index.mdx) to use for your Storybook instance.<br />`create storybook --builder webpack5` |\\n| `-f`, `--force` | Forcefully installs Storybook into your project, prompting you to overwrite existing files.<br />`create storybook --force` |\\n| `-s`, `--skip-install` | Skips the dependency installation step. Used only when you need to configure Storybook manually.<br />`create storybook --skip-install` |\\n| `-t`, `--type` | Defines the [framework](../configure/integration/frameworks.mdx) to use for your Storybook instance.<br />`create storybook --type solid` |\\n| `-y`, `--yes` | Skips interactive prompts and automatically installs Storybook per specified version, including all features.<br />`create storybook --yes` |\\n| `--features [...values]` | Use these features when installing, skipping the prompt. Supported values are `docs` and `test`, space separated.<br />`create storybook --features docs test` |\\n| `--package-manager` | Sets the package manager to use when installing Storybook.<br />Available package managers include `npm`, `yarn`, and `pnpm`.<br />`create storybook --package-manager pnpm` |\\n| `--use-pnp` | Enables [Plug'n'Play](https://yarnpkg.com/features/pnp) support for Yarn. This option is only available when using Yarn as your package manager.<br />`create storybook --use-pnp` |\\n| `-p`, `--parser` | Sets the [jscodeshift parser](https://github.com/facebook/jscodeshift#parser).<br />Available parsers include `babel`, `babylon`, `flow`, `ts`, and `tsx`.<br />`create storybook --parser tsx` |\\n| `--debug` | Outputs more logs in the CLI to assist debugging.<br />`create storybook --debug` |\\n| `--disable-telemetry` | Disables Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#how-to-opt-out).<br />`create storybook --disable-telemetry` |\\n| `--enable-crash-reports` | Enables sending crash reports to Storybook's telemetry. Learn more about it [here](../configure/telemetry.mdx#crash-reports-disabled-by-default).<br />`create storybook --enable-crash-reports` |\\n| `--no-dev` | Complete the initialization of Storybook without running the Storybook dev server.<br />`create storybook --no-dev` |\"}, \"metadata\": {\"title\": \"CLI options\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 8, \"title\": \"CLI options\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\"}, {\"title\": \"API references\", \"description\": null, \"content\": {\"Configuration\": \"<Table>\\n <thead>\\n <Tr>\\n <Th scope=\\\"col\\\" width=\\\"33%\\\">Name</Th>\\n <Th scope=\\\"col\\\">Description</Th>\\n </Tr>\\n </thead>\\n\\n <tbody>\\n <Tr>\\n <Td><A href=\\\"./api/main-config/main-config\\\"><code>main.js|ts</code></A></Td>\\n\\n <Td>\\n Storybook's primary configuration file, which specifies your Storybook project's behavior,\\n including the location of your stories, the addons you use, feature flags and other\\n project-specific settings.\\n </Td>\\n</Tr>\\n\\n<Tr>\\n <Td><A href=\\\"./configure/#configure-story-rendering\\\"><code>preview.js|jsx|ts|tsx</code></A></Td>\\n\\n <Td>\\n This configuration file controls the way stories are rendered. You can also use it to run\\n code that applies to all stories.\\n </Td>\\n</Tr>\\n\\n<Tr>\\n <Td><A href=\\\"./configure/#configure-storybooks-ui\\\"><code>manager.js|ts</code></A></Td>\\n\\n <Td>\\n This configuration file controls the behavior of Storybook's UI, the manager.\\n </Td>\\n</Tr>\\n\\n<Tr>\\n <Td><A href=\\\"./api/cli-options\\\">CLI</A></Td>\\n\\n <Td>\\n Storybook is a CLI tool. You can start Storybook in development mode or build a static\\n version of your Storybook.\\n </Td>\\n</Tr>\\n\\n </tbody>\\n</Table>\", \"Stories\": \"<Table>\\n <thead>\\n <Tr>\\n <Th scope=\\\"col\\\" width=\\\"33%\\\">Name</Th>\\n <Th scope=\\\"col\\\">Description</Th>\\n </Tr>\\n </thead>\\n\\n <tbody>\\n <Tr>\\n <Td><A href=\\\"./api/csf\\\">CSF</A></Td>\\n\\n <Td>\\n Component Story Format (CSF) is the API for writing stories. It's an\\n <a href=\\\"https://github.com/ComponentDriven/csf\\\">open standard</a> based on ES6 modules that\\n is portable beyond Storybook.\\n </Td>\\n</Tr>\\n\\n<Tr>\\n <Td><A href=\\\"./api/arg-types\\\">ArgTypes</A></Td>\\n\\n <Td>\\n ArgTypes specify the behavior of <a href=\\\"./writing-stories/args\\\">args</a>. By specifying\\n the type of an arg, you constrain the values that it can accept and provide information\\n about args that are not explicitly set.\\n </Td>\\n</Tr>\\n\\n<Tr>\\n <Td><A href=\\\"./api/parameters\\\">Parameters</A></Td>\\n\\n <Td>\\n Parameters are static metadata used to configure your <a href=\\\"./get-started/whats-a-story\\\">stories</a> <a href=\\\"./addons\\\">addons</a> in Storybook. They are specified at the story, meta (component), project (global) levels.\\n </Td>\\n</Tr>\\n\\n </tbody>\\n</Table>\", \"Docs\": \"<Table>\\n <thead>\\n <Tr>\\n <Th scope=\\\"col\\\" width=\\\"33%\\\">Name</Th>\\n <Th scope=\\\"col\\\">Description</Th>\\n </Tr>\\n </thead>\\n\\n <tbody>\\n <Tr>\\n <Td><A href=\\\"./writing-docs/doc-blocks/#available-blocks\\\">Doc blocks</A></Td>\\n\\n <Td>\\n Storybook offers several doc blocks to help document your components and other aspects of\\n your project.\\n </Td>\\n</Tr>\\n\\n </tbody>\\n</Table>\"}, \"metadata\": {\"title\": \"API references\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 10, \"title\": \"API\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\"}, {\"title\": \"Frameworks\", \"description\": null, \"content\": {\"Scaffolding a new framework\": \"The first thing to do is to scaffold your framework support in its own repo.\\n\\nWe recommend adopting the same project structure as the Storybook monorepo. That structure contains the framework package (`app/<framework>`) and an example app (`examples/<framework>-kitchen-sink`) as well as other associated documentation and configuration as needed.\\n\\nIt may seem like a little more hierarchy than what\\u2019s necessary. But because the structure mirrors the way Storybook\\u2019s monorepo is structured, you can reuse Storybook\\u2019s tooling. It also makes it easier to move the framework into the Storybook monorepo later if that is desirable.\\n\\nWe recommend using `@storybook/html` as a starter framework since it\\u2019s the simplest and contains no framework-specific peculiarities. There is a boilerplate to get you started [here](https://github.com/CodeByAlex/storybook-framework-boilerplate).\", \"Framework architecture\": \"Supporting a new framework in Storybook typically consists of two main aspects:\\n\\n['Configuring the server. In Storybook, the server is the node process that runs when you run `storybook dev` or `storybook build`. Configuring the server typically means configuring babel and webpack in framework-specific ways.', 'Configuring the client. The client is the code that runs in the browser, and configuring it, means providing a framework-specific story rendering function.']\", \"Configuring the server\": {\"Package structure\": \"It's helpful to understand Storybook's package structure before adding a framework preset. Each framework typically exposes two executables in its `package.json`:\\n\\n```\\n{\\n \\\"bin\\\": {\\n \\\"storybook\\\": \\\"./bin/index.js\\\",\\n \\\"build-storybook\\\": \\\"./bin/build.js\\\"\\n }\\n}\\n```\\n\\nThese scripts pass an `options` object to `storybook/internal/server`, a library that abstracts all of Storybook\\u2019s framework-independent code.\\n\\nFor example, here\\u2019s the boilerplate to start the dev server with `storybook dev`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-start-dev-server.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThus the essence of adding framework presets is just filling in that options object.\", \"Server options\": \"As described above, the server `options` object does the heavy lifting of configuring the server.\\n\\nLet\\u2019s look at the `@storybook/vue`\\u2019s options definition:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-server-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe value of the `framework` option (i.e., \\u2018vue\\u2019) is something that gets passed to addons and allows them to do specific tasks related to your framework.\\n\\nThe essence of this file is the framework presets, and these are standard [Storybook presets](../addons/writing-presets.mdx) -- you can look at framework packages in the Storybook monorepo (e.g. [React](https://github.com/storybookjs/storybook/blob/main/app/react/src/server/options.ts), [Vue](https://github.com/storybookjs/storybook/blob/main/app/vue/src/server/options.ts), [Web Components](https://github.com/storybookjs/storybook/blob/main/app/web-components/src/server/options.ts)) to see examples of framework-specific customizations.\\n\\nWhile developing your custom framework, not maintained by Storybook, you can specify the path to the location file with the `frameworkPath` key:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-server-framework-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can add a relative path to `frameworkPath`. Don't forget that they resolve from the Storybook configuration directory (i.e., `.storybook`) by default.\\n\\nMake sure the `frameworkPath` ends up at the `dist/client/index.js` file within your framework app.\"}, \"Configuring the client\": {\"Renderable objects\": \"Storybook stories are ES6 objects that return a \\u201crenderable object.\\u201d\\n\\nConsider the following React story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-with-sample.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn this case, the renderable object is the React element, `<Button .../>`.\\n\\nIn most other frameworks, the renderable object is actually a plain JavaScript object.\\n\\nConsider the following hypothetical example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-hypothetical-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe design of this \\u201crenderable object\\u201d is framework-specific and should ideally match the idioms of that framework.\", \"Render function\": \"The framework's render function is the entity responsible for converting the renderable object into DOM nodes. It is typically of the form:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-framework-render-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Package structure\": \"On the client side, the key file is [`src/client/preview.js`](../configure/index.mdx#configure-story-rendering):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-client-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe globals file typically sets up a single global variable that client-side code (such as addon-provided decorators) can refer to if needed to understand which framework it's running in:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-client-globals-example-file.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe `start` function abstracts all of Storybook\\u2019s framework-independent client-side (browser) code, and it takes the render function we defined above. For examples of render functions, see [React](https://github.com/storybookjs/storybook/blob/main/app/react/src/client/preview/render.tsx), [Vue](https://github.com/storybookjs/storybook/blob/main/app/vue/src/client/preview/render.ts), [Angular](https://github.com/storybookjs/storybook/blob/main/app/angular/src/client/preview/render.ts), and [Web Components](https://github.com/storybookjs/storybook/blob/main/app/web-components/src/client/preview/render.ts) in the Storybook monorepo.\"}}, \"metadata\": {\"title\": \"Frameworks\", \"sidebar\": {\"order\": 7, \"title\": \"Frameworks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 3]\"}, {\"title\": \"Parameters\", \"description\": null, \"content\": {\"Story parameters\": \"Parameters specified at the story level apply to that story only. They are defined in the `parameters` property of the story (named export):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nParameters specified at the story level will [override](#parameter-inheritance) those specified at the project level and meta (component) level.\\n</Callout>\", \"Meta parameters\": \"Parameter's specified in a [CSF](../writing-stories/index.mdx#component-story-format-csf) file's meta configuration apply to all stories in that file. They are defined in the `parameters` property of the `meta` (default export):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nParameters specified at the meta (component) level will [override](#parameter-inheritance) those specified at the project level.\\n</Callout>\", \"Project parameters\": \"Parameters specified at the project (global) level apply to **all stories** in your Storybook. They are defined in the `parameters` property of the default export in your `.storybook/preview.js|ts` file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Available parameters\": {\"`layout`\": \"Type: `'centered' | 'fullscreen' | 'padded'`\\n\\nDefault: `'padded'`\\n\\nSpecifies how the canvas should [lay out the story](../configure/story-layout.mdx).\\n\\n['**centered**: Center the story within the canvas', '**padded**: (default) Add padding to the story', '**fullscreen**: Show the story as-is, without padding']\", \"`options`\": {\"`options.storySort`\": \"Type: `StorySortConfig | StorySortFn`\\n\\n```\\ntype StorySortConfig = {\\n includeNames?: boolean;\\n locales?: string;\\n method?: 'alphabetical' | 'alphabetical-by-kind' | 'custom';\\n order?: string[];\\n};\\n\\ntype Story = {\\n id: string;\\n importPath: string;\\n name: string;\\n title: string;\\n};\\n\\ntype StorySortFn = (a: Story, b: Story) => number;\\n```\\n\\nSpecifies the order in which stories are displayed in the Storybook UI.\\n\\nWhen specifying a configuration object, the following options are available:\\n\\n['**includeNames**: Whether to include the story name in the sorting algorithm. Defaults to `false`.', '**locales**: The locale to use when sorting stories. Defaults to your system locale.', '**method**: The sorting method to use. Defaults to `alphabetical`.', ['**alphabetical**: Sort stories alphabetically by name.', '**alphabetical-by-kind**: Sort stories alphabetically by kind, then by name.', '**custom**: Use a custom sorting function.'], \\\"**order**: Stories in the specified order will be displayed first, in the order specified. All other stories will be displayed after, in alphabetical order. The order array can accept a nested array to sort 2nd-level story kinds, e.g. `['Intro', 'Pages', ['Home', 'Login', 'Admin'], 'Components']`.\\\"]\\n\\nWhen specifying a custom sorting function, the function behaves like a typical JavaScript sorting function. It accepts two stories to compare and returns a number. For example:\\n\\n```\\n(a, b) => (a.id === b.id ? 0 : a.id.localeCompare(b.id, undefined, { numeric: true }));\\n```\\n\\nSee [the guide](../writing-stories/naming-components-and-hierarchy.mdx#sorting-stories) for usage examples.\"}, \"`test`\": {\"`clearMocks`\": \"Type: `boolean`\\n\\nDefault: `false`\\n\\n[Similar to Vitest](https://vitest.dev/config/#clearmocks), it will call `.mockClear()` on all spies created with `fn()` from `storybook/test` when a story unmounts. This will clear mock history, but not reset its implementation to the default one.\", \"`mockReset`\": \"Type: `boolean`\\n\\nDefault: `false`\\n\\n[Similar to Vitest](https://vitest.dev/config/#mockreset), it will call `.mockReset()` on all spies created with `fn()` from `storybook/test` when a story unmounts. This will clear mock history and reset its implementation to an empty function (will return `undefined`).\", \"`restoreMocks`\": \"Type: `boolean`\\n\\nDefault: `true`\\n\\n[Similar to Vitest](https://vitest.dev/config/#restoremocks), it will call `.restoreMocks()` on all spies created with `fn()` from `storybook/test` when a story unmounts. This will clear mock history and reset its implementation to the original one.\", \"`dangerouslyIgnoreUnhandledErrors`\": \"Type: `boolean`\\n\\nDefault: `false`\\n\\nUnhandled errors might cause false positive assertions. Setting this to `true` will prevent the [play function](../writing-stories/play-function.mdx) from failing and showing a warning when unhandled errors are thrown during execution.\\n\\n[]\"}, \"Essentials\": \"All other parameters are contributed by features. The [essential feature's](../essentials/index.mdx) parameters are documented on their individual pages:\\n\\n['[Actions](../essentials/actions.mdx#parameters)', '[Backgrounds](../essentials/backgrounds.mdx#parameters)', '[Controls](../essentials/controls.mdx#parameters)', '[Highlight](../essentials/highlight.mdx#parameters)', '[Measure & Outline](../essentials/measure-and-outline.mdx#parameters)', '[Viewport](../essentials/viewport.mdx#parameters)']\"}, \"Parameter inheritance\": \"No matter where they're specified, parameters are ultimately applied to a single story. Parameters specified at the project (global) level are applied to every story in that project. Those specified at the meta (component) level are applied to every story associated with that meta. And parameters specified for a story only apply to that story.\\n\\nWhen specifying parameters, they are merged together in order of increasing specificity:\\n\\n['Project (global) parameters', 'Meta (component) parameters', 'Story parameters']\\n\\n<Callout variant=\\\"info\\\">\\nParameters are **merged**, so objects are deep-merged, but arrays and other properties are overwritten.\\n</Callout>\\n\\nIn other words, the following specifications of parameters:\\n\\n```\\nconst preview = {\\n // \\ud83d\\udc47 Project-level parameters\\n parameters: {\\n layout: 'centered',\\n demo: {\\n demoProperty: 'a',\\n demoArray: [1, 2],\\n },\\n },\\n // ...\\n};\\nexport default preview;\\n```\\n\\n```\\nconst meta = {\\n component: Dialog,\\n // \\ud83d\\udc47 Meta-level parameters\\n parameters: {\\n layout: 'fullscreen',\\n demo: {\\n demoProperty: 'b',\\n anotherDemoProperty: 'b',\\n },\\n },\\n};\\nexport default meta;\\n\\n// (no additional parameters specified)\\nexport const Basic = {};\\n\\nexport const LargeScreen = {\\n // \\ud83d\\udc47 Story-level parameters\\n parameters: {\\n layout: 'padded',\\n demo: {\\n demoArray: [3, 4],\\n },\\n },\\n};\\n```\\n\\nWill result in the following parameter values applied to each story:\\n\\n```\\n// Applied story parameters\\n\\n// For the Basic story:\\n{\\n layout: 'fullscreen',\\n demo: {\\n demoProperty: 'b',\\n anotherDemoProperty: 'b',\\n demoArray: [1, 2],\\n },\\n}\\n\\n// For the LargeScreen story:\\n{\\n layout: 'padded',\\n demo: {\\n demoProperty: 'b',\\n anotherDemoProperty: 'b',\\n demoArray: [3, 4],\\n },\\n}\\n```\"}, \"metadata\": {\"title\": \"Parameters\", \"sidebar\": {\"order\": 4, \"title\": \"Parameters\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 4]\"}, {\"title\": \"Csf\", \"description\": \"Documentation section: csf\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/api/csf\"}, \"subpages\": [{\"title\": \"Component Story Format (CSF)\", \"description\": null, \"content\": {\"root\": [\"CSF Factories are the next evolution of Storybook's Component Story Format (CSF). This new API uses a pattern called factory functions to provide full type safety to your Storybook stories, making it easier to configure addons correctly and unlocking the full potential of Storybook's features.\", \"While this feature is experimental, we will be documenting progress in the [RFC](https://github.com/storybookjs/storybook/discussions/30112). We welcome your feedback!\"]}, \"metadata\": {\"title\": \"Component Story Format (CSF)\", \"isTab\": true, \"tab\": {\"order\": 2, \"title\": \"CSF Factories (Experimental)\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"Component Story Format (CSF)\", \"description\": null, \"content\": {\"Default export\": \"The default export defines metadata about your component, including the `component` itself, its `title` (where it will show up in the [navigation UI story hierarchy](../../writing-stories/naming-components-and-hierarchy.mdx#sorting-stories)), [decorators](../../writing-stories/decorators.mdx), and [parameters](../../writing-stories/parameters.mdx).\\n\\n<If renderer=\\\"svelte\\\">\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhen writing Svelte CSF stories, you use the `defineMeta` function instead of the default export to define the metadata for your component. \\n\\n</Callout>\\n\\n</If>\\n\\nThe `component` field is required and used by addons for automatic prop table generation and display of other component metadata. The `title` field is optional and should be unique (i.e., not re-used across files).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-mandatory-export.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFor more examples, see [writing stories](../../writing-stories/index.mdx).\", \"Named story exports\": \"With CSF, every named export in the file represents a story object by default.\\n\\n<If renderer=\\\"svelte\\\">\\n\\n<Callout variant=\\\"info\\\">\\n\\nWith Svelte CSF, you use the `Story` component returned by `defineMeta` instead of a named export to define a story. The name of the story, shown in the sidebar, is defined by the `name` attribute of the Story component. Annotations, such as `args`, `decorators`, and `parameters`, are defined as attributes on the Story component.\\n\\n</Callout>\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-basic-and-props.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe exported identifiers will be converted to \\\"start case\\\" using Lodash's [startCase](https://lodash.com/docs/#startCase) function. For example:\\n\\n| Identifier | Transformation |\\n| ---------------- | ------------------- |\\n| name | Name |\\n| someName | Some Name |\\n| someNAME | Some NAME |\\n| some\\\\_custom\\\\_NAME | Some Custom NAME |\\n| someName1234 | Some Name 1 2 3 4 |\\n\\nWe recommend that all export names to start with a capital letter.\\n\\nStory objects can be annotated with a few different fields to define story-level [decorators](../../writing-stories/decorators.mdx) and [parameters](../../writing-stories/parameters.mdx), and also to define the `name` of the story.\\n\\nStorybook's `name` configuration element is helpful in specific circumstances. Common use cases are names with special characters or Javascript restricted words. If not specified, Storybook defaults to the named export.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-with-storyname.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Args story inputs\": \"Starting in SB 6.0, stories accept named inputs called Args. Args are dynamic data that are provided (and possibly updated by) Storybook and its addons.\\n\\nConsider Storybook\\u2019s [\\\"Button\\\" example](../../writing-stories/index.mdx#defining-stories) of a text button that logs its click events:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-click-handler.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow consider the same example, re-written with args:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-click-handler-args.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr even more simply:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-click-handler-simplificated.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNot only are these versions shorter and more accessible to write than their no-args counterparts, but they are also more portable since the code doesn't depend on the actions feature specifically.\\n\\nFor more information on setting up [Docs](../../writing-docs/index.mdx) and [Actions](../../essentials/actions.mdx), see their respective documentation.\", \"Play function\": \"Storybook's `play` functions are small snippets of code executed when the story renders in the UI. They are convenient helper methods to help you test use cases that otherwise weren't possible or required user intervention.\\n\\nA good use case for the `play` function is a form component. With previous Storybook versions, you'd write your set of stories and had to interact with the component to validate it. With Storybook's play functions, you could write the following story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"login-form-with-play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen the story renders in the UI, Storybook executes each step defined in the `play` function and runs the assertions without the need for user interaction.\\n\\n<IfRenderer renderer={[ 'angular', 'ember', 'html', 'preact', 'qwik', 'react', 'solid', 'vue', 'web-components' ]}>\", \"Custom render functions\": \"Starting in Storybook 6.4, you can write your stories as JavaScript objects, reducing the boilerplate code you need to generate to test your components, thus improving functionality and usability. `Render` functions are helpful methods to give you additional control over how the story renders. For example, if you were writing a story as an object and you wanted to specify how your component should render, you could write the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-with-custom-render-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen Storybook loads this story, it will detect the existence of a `render` function and adjust the component rendering accordingly based on what's defined.\\n</IfRenderer>\", \"Storybook export vs. name handling\": \"Storybook handles named exports and the `name` option slightly differently. When should you use one vs. the other?\\n\\nStorybook will always use the named export to determine the story ID and URL.\\n\\nIf you specify the `name` option, it will be used as the story display name in the UI. Otherwise, it defaults to the named export, processed through Storybook's `storyNameFromExport` and `lodash.startCase` functions.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-test-with-storyname.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen you want to change the name of your story, rename the CSF export. It will change the name of the story and also change the story's ID and URL.\\n\\nIt would be best if you used the `name` configuration element in the following cases:\\n\\n['You want the name to show up in the Storybook UI in a way that\\\\'s not possible with a named export, e.g., reserved keywords like \\\"default\\\", special characters like emoji, spacing/capitalization other than what\\\\'s provided by `storyNameFromExport`.', \\\"You want to preserve the Story ID independently from changing how it's displayed. Having stable Story IDs is helpful for integration with third-party tools.\\\"]\", \"Non-story exports\": \"In some cases, you may want to export a mixture of stories and non-stories (e.g., mocked data).\\n\\nYou can use the optional configuration fields `includeStories` and `excludeStories` in the default export to make this possible. You can define them as an array of strings or regular expressions.\\n\\nConsider the following story file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-with-nonstory.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen this file renders in Storybook, it treats `ComplexStory` and `SimpleStory` as stories and ignores the `data` named exports.\\n\\nFor this particular example, you could achieve the same result in different ways, depending on what's convenient:\\n\\n['`includeStories: /^[A-Z]/`', '`includeStories: /.*Story$/`', \\\"`includeStories: ['SimpleStory', 'ComplexStory']`\\\", '`excludeStories: /^[a-z]/`', '`excludeStories: /.*Data$/`', \\\"`excludeStories: ['simpleData', 'complexData']`\\\"]\\n\\nThe first option is the recommended solution if you follow the best practice of starting story exports with an uppercase letter (i.e., use UpperCamelCase).\", \"Upgrading from CSF 2 to CSF 3\": {\"Spreadable story objects\": \"In CSF 3, the named exports are **objects**, not functions. This allows us to reuse stories more efficiently with the JS spread operator.\\n\\nConsider the following addition to the intro example, which creates a `PrimaryOnDark` story that renders against a dark background:\\n\\nHere's the CSF 2 implementation:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-2-example-primary-dark-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n`Primary.bind({})` copies the story function, but it doesn't copy the annotations hanging off the function, so we must add `PrimaryOnDark.args = Primary.args` to inherit the args.\\n\\nIn CSF 3, we can spread the `Primary` object to carry over all its annotations:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-3-example-primary-dark-story.md\\\" />\\n\\nLearn more about [named story exports](#named-story-exports).\\n\\n{/* prettier-ignore-end */}\", \"Default render functions\": \"In CSF 3, you specify how a story renders through a `render` function. We can rewrite a CSF 2 example to CSF 3 through the following steps.\\n\\nLet's start with a simple CSF 2 story function:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-2-example-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow, let's rewrite it as a story object in CSF 3 with an explicit `render` function that tells the story how to render itself. Like CSF 2, this gives us full control of how we render a component or even a collection of components.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-3-example-render.md\\\" />\\n\\n<IfRenderer renderer={[ 'angular', 'ember', 'html', 'preact', 'qwik', 'react', 'solid', 'vue', 'web-components' ]}>\\nLearn more about [render functions](#custom-render-functions).\\n</IfRenderer>\\n\\n{/* prettier-ignore-end */}\\n\\nBut in CSF 2, a lot of story functions are identical: take the component specified in the default export and spread args into it. What's interesting about these stories is not the function, but the args passed into the function.\\n\\nCSF 3 provides default render functions for each renderer. If all you're doing is spreading args into your component\\u2014which is the most common case\\u2014you don't need to specify any `render` function at all:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-3-example-default-render.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<IfRenderer renderer={[ 'angular', 'ember', 'html', 'preact', 'qwik', 'react', 'solid', 'vue', 'web-components' ]}>\\nFor more information, see the section on [custom render functions](#custom-render-functions).\\n</IfRenderer>\", \"Generate titles automatically\": \"Finally, CSF 3 can automatically generate titles.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-2-example-title.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"csf-3-example-auto-title.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can still specify a title like in CSF 2, but if you don't specify one, it can be inferred from the story's path on disk. For more information, see the section on [configuring story loading](../../configure/index.mdx#configure-story-loading).\"}}, \"metadata\": {\"title\": \"Component Story Format (CSF)\", \"sidebar\": {\"order\": 2, \"title\": \"Component Story Format (CSF)\"}, \"isTab\": true, \"tab\": {\"order\": 1, \"title\": \"CSF 3\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 5]\"}, {\"title\": \"Doc Blocks\", \"description\": \"Documentation section: doc-blocks\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/api/doc-blocks\"}, \"subpages\": [{\"title\": \"ArgTypes\", \"description\": null, \"content\": {\"ArgTypes\": {\"`exclude`\": \"Type: `string[] | RegExp`\\n\\nDefault: `parameters.docs.argTypes.exclude`\\n\\nSpecifies which arg types to exclude from the args table. Any arg types whose names match the regex or are part of the array will be left out.\", \"`include`\": \"Type: `string[] | RegExp`\\n\\nDefault: `parameters.docs.argTypes.include`\\n\\nSpecifies which arg types to include in the args table. Any arg types whose names don\\u2019t match the regex or are not part of the array will be left out.\", \"`of`\": \"Type: Story export or CSF file exports\\n\\nSpecifies which story to get the arg types from. If a CSF file exports is provided, it will use the primary (first) story in the file.\", \"`sort`\": \"Type: `'none' | 'alpha' | 'requiredFirst'`\\n\\nDefault: `parameters.docs.argTypes.sort` or `'none'`\\n\\nSpecifies how the arg types are sorted.\\n\\n['**none**: Unsorted, displayed in the same order the arg types are processed in', \\\"**alpha**: Sorted alphabetically, by the arg type's name\\\", '**requiredFirst**: Same as `alpha`, with any required arg types displayed first']\"}}, \"metadata\": {\"title\": \"ArgTypes\", \"sidebar\": {\"order\": 1, \"title\": \"ArgTypes\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 0]\"}, {\"title\": \"Canvas\", \"description\": null, \"content\": {\"Canvas\": {\"`additionalActions`\": \"Type:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nArray<{\\n title: string | JSX.Element;\\n className?: string;\\n onClick: () => void;\\n disabled?: boolean;\\n}>;\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nDefault: `parameters.docs.canvas.additionalActions`\\n\\nProvides any additional custom actions to show in the bottom right corner. These are simple buttons that do anything you specify in the `onClick` function.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Story, Canvas, SourceState } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n{/* With an additional action */}\\n<Canvas\\n additionalActions={[\\n {\\n title: 'Open in GitHub',\\n onClick: () => {\\n window.open(\\n 'https://github.com/storybookjs/storybook/blob/next/code/ui/blocks/src/examples/Button.stories.tsx',\\n '_blank'\\n );\\n },\\n }\\n ]}\\n of={ButtonStories.Primary}\\n/>\\n```\\n\\n{/* prettier-ignore-end */}\", \"`className`\": \"Type: `string`\\n\\nDefault: `parameters.docs.canvas.className`\\n\\nProvides HTML class(es) to the preview element, for custom styling.\", \"`layout`\": \"Type: `'centered' | 'fullscreen' | 'padded'`\\n\\nDefault: `parameters.layout` or `parameters.docs.canvas.layout` or `'padded'`\\n\\nSpecifies how the canvas should layout the story.\\n\\n['**centered**: Center the story within the canvas', '**padded**: (default) Add padding to the story', '**fullscreen**: Show the story as-is, without padding']\\n\\nIn addition to the `parameters.docs.canvas.layout` property or the `layout` prop, the `Canvas` block will respect the `parameters.layout` value that defines [how a story is laid out](../../configure/story-layout.mdx) in the regular story view.\", \"`meta`\": \"Type: CSF file exports\\n\\nSpecifies the CSF file to which the story is associated.\\n\\nYou can render a story from a CSF file that you haven\\u2019t attached to the MDX file (via `Meta`) by using the `meta` prop. Pass the **full set of exports** from the CSF file (not the default export!).\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Canvas } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\nimport * as HeaderStories from './Header.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n{/* Although this MDX file is largely concerned with Button,\\n it can render Header stories too */}\\n<Canvas of={HeaderStories.LoggedIn} meta={HeaderStories} />\\n```\\n\\n{/* prettier-ignore-end */}\", \"`of`\": \"Type: Story export\\n\\nSpecifies which story's source is displayed.\", \"`source`\": \"Type: `SourceProps['code'] | SourceProps['format'] | SourceProps['language'] | SourceProps['type']`\\n\\nSpecifies the props passed to the inner `Source` block. For more information, see the `Source` Doc Block [documentation](./doc-block-source.mdx).\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe dark prop is ignored, as the `Source` block is always rendered in dark mode when shown as part of a `Canvas` block.\\n</Callout>\", \"`sourceState`\": \"Type: `'hidden' | 'shown' | 'none'`\\n\\nDefault: `parameters.docs.canvas.sourceState` or `'hidden'`\\n\\nSpecifies the initial state of the source panel.\\n\\n['**hidden**: the source panel is hidden by default', '**shown**: the source panel is shown by default', '**none**: the source panel is not available and the button to show it is not rendered']\", \"`story`\": \"Type: `StoryProps['inline'] | StoryProps['height'] | StoryProps['autoplay']`\\n\\nSpecifies the props passed to the inner `Story` block. For more information, see the `Story` Doc Block [documentation](./doc-block-story.mdx).\", \"`withToolbar`\": \"Type: `boolean`\\n\\nDefault: `parameters.docs.canvas.withToolbar`\\n\\nDetermines whether to render a toolbar containing tools to interact with the story.\"}}, \"metadata\": {\"title\": \"Canvas\", \"sidebar\": {\"order\": 2, \"title\": \"Canvas\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 1]\"}, {\"title\": \"ColorPalette\", \"description\": null, \"content\": {\"ColorPalette\": {\"`children`\": \"Type: `React.ReactNode`\\n\\n`ColorPalette` expects only `ColorItem` children.\"}, \"ColorItem\": {\"`colors`\": \"(**Required**)\\n\\nType: `string[] | { [key: string]: string }`\\n\\nProvides the list of colors to be displayed. Accepts any valid CSS color format (hex, RGB, HSL, etc.). When an object is provided, the keys will be displayed above the values. Additionally, it supports gradients such as 'linear-gradient(to right, white, black)' or 'linear-gradient(65deg, white, black)', etc. \", \"`subtitle`\": \"(**Required**)\\n\\nType: `string`\\n\\nProvides an additional description of the color.\", \"`title`\": \"(**Required**)\\n\\nType: `string`\\n\\nSets the name of the color to be displayed.\"}}, \"metadata\": {\"title\": \"ColorPalette\", \"sidebar\": {\"order\": 3, \"title\": \"ColorPalette\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 2]\"}, {\"title\": \"Controls\", \"description\": null, \"content\": {\"Controls\": {\"`exclude`\": \"Type: `string[] | RegExp`\\n\\nDefault: `parameters.docs.controls.exclude`\\n\\nSpecifies which controls to exclude from the args table. Any controls whose names match the regex or are part of the array will be left out.\", \"`include`\": \"Type: `string[] | RegExp`\\n\\nDefault: `parameters.docs.controls.include`\\n\\nSpecifies which controls to include in the args table. Any controls whose names don't match the regex or are not part of the array will be left out.\", \"`of`\": \"Type: Story export or CSF file exports\\n\\nSpecifies which story to get the controls from. If a CSF file exports is provided, it will use the primary (first) story in the file.\", \"`sort`\": \"Type: `'none' | 'alpha' | 'requiredFirst'`\\n\\nDefault: `parameters.docs.controls.sort` or `'none'`\\n\\nSpecifies how the controls are sorted.\\n\\n['**none**: Unsorted, displayed in the same order the controls are processed in', \\\"**alpha**: Sorted alphabetically, by the arg type's name\\\", '**requiredFirst**: Same as `alpha`, with any required controls displayed first']\"}}, \"metadata\": {\"title\": \"Controls\", \"sidebar\": {\"order\": 4, \"title\": \"Controls\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 3]\"}, {\"title\": \"Description\", \"description\": null, \"content\": {\"Description\": {\"`of`\": \"Type: Story export or CSF file exports\\n\\nSpecifies where to pull the description from. It can either point to a story or a meta, depending on which description you want to show.\\n\\nDescriptions are pulled from the JSDoc comments or parameters, and they are rendered as markdown. See [Writing descriptions](#writing-descriptions) for more details.\"}, \"Writing descriptions\": \"There are multiple places to write the description of a component/story, depending on what you want to achieve. Descriptions can be written at the story level to describe each story of a component, or they can be written at the meta or component level to describe the component in general.\\n\\nDescriptions can be written as [JSDoc comments](https://jsdoc.app/about-getting-started.html) above stories, meta, or components. Alternatively they can also be specified in [`parameters`](../../writing-stories/parameters.mdx). To describe a story via parameters instead of comments, add it to `parameters.docs.description.story`; to describe meta/component, add it to `parameters.docs.description.component`.\\n\\nWe recommend using JSDoc comments for descriptions, and only use the `parameters.docs.description.X` properties in situations where comments are not possible to write for some reason, or where you want the description shown in Storybook to be different from the comments. Comments provide a better writing experience as you don\\u2019t have to worry about indentation, and they are more discoverable for other developers that are exploring the story/component sources.\\n\\nWhen documenting a story, reference a story export in the `of` prop (see below) and the Description block will look for descriptions in the following order:\\n\\n['`parameters.docs.description.story` in the story', 'JSDoc comments above the story']\\n\\nWhen documenting a component, reference a meta export in the `of` prop (see below) and the Description block will look for descriptions in the following order:\\n\\n['`parameters.docs.description.component` in the meta', 'JSDoc comments above the meta', 'JSDoc comments above the component']\\n\\nThis flow gives you powerful ways to override the description for each scenario. Take the following example:\\n\\n```\\n/**\\n * The Button component shows a button\\n */\\nexport const Button = () => <button>Click me</button>;\\n```\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"api-doc-block-description-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Description } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n{/* Shows the description for the default export (the meta).\\n If that didn't have any comments, it would show the \\n comments from the component instead */}\\n<Description of={ButtonStories} />\\n\\n{/* Shows the description for the Primary export */}\\n<Description of={ButtonStories.Primary} />\\n```\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Description\", \"sidebar\": {\"order\": 5, \"title\": \"Description\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 4]\"}, {\"title\": \"IconGallery\", \"description\": null, \"content\": {\"Documenting icons\": {\"Automate icon documentation\": \"If you're working on a project that contains a large number of icons that you want to document, you can extend the `IconGallery` block, wrap `IconItem` in a loop, and iterate over the icons you want to document, including their properties. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, IconGallery, IconItem } from '@storybook/addon-docs/blocks';\\n\\nimport { Icon as IconExample } from './Icon';\\nimport * as icons from './icons';\\n\\n# Iconography\\n\\n<IconGallery>\\n {Object.keys(icons).map((icon) => (\\n <IconItem name={icon}>\\n <IconExample icon={icon} />\\n </IconItem>\\n ))}\\n</IconGallery>\\n```\\n\\n{/* prettier-ignore-end */}\"}, \"IconGallery\": {\"`children`\": \"Type: `React.ReactNode`\\n\\n`IconGallery` expects only `IconItem` children.\"}, \"IconItem\": {\"`name`\": \"(**Required**)\\n\\nType: `string`\\n\\nSets the name of the icon.\", \"`children`\": \"Type: `React.ReactNode`\\n\\nProvides the icon to be displayed.\"}}, \"metadata\": {\"title\": \"IconGallery\", \"sidebar\": {\"order\": 6, \"title\": \"IconGallery\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 5]\"}, {\"title\": \"Markdown\", \"description\": null, \"content\": {\"Markdown\": {\"`children`\": \"Type: `string`\\n\\nProvides the markdown-formatted string to parse and display.\", \"`options`\": \"Specifies the options passed to the underlying [`markdown-to-jsx` library](https://github.com/probablyup/markdown-to-jsx/blob/main/README.md).\"}, \"Why not import markdown directly?\": \"From a purely technical standpoint, we could include the imported markdown directly in the MDX file like this:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n{/* THIS WON'T WORK, THIS IS TO DEMONSTRATE AN ERROR */}\\n\\nimport ReadMe from './README.md';\\n\\n# A header \\n\\n{ReadMe}\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nHowever, there are small syntactical differences between plain markdown and MDX2. MDX2 is more strict and will interpret certain content as JSX expressions. Here\\u2019s an example of a perfectly valid markdown file, that would break if it was handled directly by MDX2:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n# A header\\n\\n{ this is valid in a plain markdown file, but MDX2 will try to evaluate this as an expression }\\n\\n<This is also valid, but MDX2 thinks this is a JSX component />\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nFurthermore, MDX2 wraps all strings on newlines in `p` tags or similar, meaning that content would render differently between a plain `.md` file and an `.mdx` file.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n# A header\\n\\n<div>\\n Some text\\n</div>\\n\\nThe example above will remain as-is in plain markdown, but MDX2 will compile it to:\\n\\n# A header\\n\\n<div>\\n <p>Some text</p>\\n</div>\\n```\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Markdown\", \"sidebar\": {\"order\": 7, \"title\": \"Markdown\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 6]\"}, {\"title\": \"Meta\", \"description\": null, \"content\": {\"Meta\": {\"`isTemplate`\": \"Type: `boolean`\\n\\nDetermines whether the MDX file serves as an [automatic docs template](../../writing-docs/autodocs.mdx#with-mdx). When true, the MDX file is not indexed as it normally would be.\", \"`name`\": \"Type: `string`\\n\\nSets the name of the [attached](#attached-vs-unattached) doc entry. You can attach more than one MDX file to the same component in the sidebar by setting different names for each file's `Meta`.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta } from '@storybook/addon-docs/blocks';\\nimport * as ComponentStories from './component.stories';\\n\\n{/* This MDX file is now called \\\"Special Docs\\\" */}\\n<Meta of={ComponentStories} name=\\\"Special Docs\\\" />\\n```\\n\\n{/* prettier-ignore-end */}\", \"`of`\": \"Type: CSF file exports\\n\\nSpecifies which CSF file is [attached](#attached-vs-unattached) to this MDX file. Pass the **full set of exports** from the CSF file (not the default export!).\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Story } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nAttaching an MDX file to a component\\u2019s stories with the `of` prop serves two purposes:\\n\\n['Ensures the MDX content appears in the sidebar inside the component\\u2019s story list. By default, it will be named whatever the `docs.defaultName` (which defaults to `\\\"Docs\\\"`) option is set to in `main.js`. But this can be overridden with the [`name` prop](#name).', 'Attaches the component and its stories to the MDX file, allowing you to use other doc blocks in \\u201cattached\\u201d mode (for instance to use the `Stories` block).']\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nThe `of` prop is optional. If you don\\u2019t want to attach a specific CSF file to this MDX file, you can either use the `title` prop to control the location, or emit `Meta` entirely, and let [autotitle](../../configure/user-interface/sidebar-and-urls.mdx#csf-30-auto-titles) decide where it goes.\\n\\n</Callout>\", \"`title`\": \"Type: `string`\\n\\nSets the title of an [unattached](#attached-vs-unattached) MDX file.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n{/* Introduction.mdx */}\\n\\nimport { Meta } from '@storybook/addon-docs/blocks';\\n\\n{/* Override the docs entry's location in the sidebar with title */}\\n<Meta title=\\\"path/to/Introduction\\\" />\\n```\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nIf you want to change the sorting of the docs entry with the component\\u2019s stories, use [Story Sorting](../../writing-stories/naming-components-and-hierarchy.mdx#sorting-stories), or add specific MDX files to your `stories` field in `main.js` in order.\\n\\n</Callout>\"}, \"Attached vs. unattached\": \"In Storybook, a docs entry (MDX file) is \\\"attached\\\" when it is associated with a stories file, via `Meta`'s [`of` prop](#of). Attached docs entries display next to the stories list under the component in the sidebar.\\n\\n\\\"Unattached\\\" docs entries are not associated with a stories file and can be displayed anywhere in the sidebar via `Meta`'s [`title` prop](#title).\"}, \"metadata\": {\"title\": \"Meta\", \"sidebar\": {\"order\": 8, \"title\": \"Meta\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 7]\"}, {\"title\": \"Primary\", \"description\": null, \"content\": {\"Primary\": {\"`of`\": \"Type: CSF file exports\\n\\nSpecifies which CSF file is used to find the first story, which is then rendered by this block. Pass the full set of exports from the CSF file (not the default export!).\"}}, \"metadata\": {\"title\": \"Primary\", \"sidebar\": {\"order\": 9, \"title\": \"Primary\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 8]\"}, {\"title\": \"Source\", \"description\": null, \"content\": {\"Source\": {\"`code`\": \"Type: `string`\\n\\nDefault: `parameters.docs.source.code`\\n\\nProvides the source code to be rendered.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Source } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n<Source code={`const thisIsCustomSource = true;\\nif (isSyntaxHighlighted) {\\n console.log('syntax highlighting is working');\\n}`} />\\n```\\n\\n{/* prettier-ignore-end */}\", \"`dark`\": \"Type: `boolean`\\n\\nDefault: `parameters.docs.source.dark`\\n\\nDetermines if the snippet is rendered in dark mode.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nLight mode is only supported when the `Source` block is rendered independently. When rendered as part of a [`Canvas` block](./doc-block-canvas.mdx)\\u2014like it is in [autodocs](../../writing-docs/autodocs.mdx)\\u2014it will always use dark mode.\\n\\n</Callout>\\n\\n<IfRenderer renderer={['angular', 'react', 'html', 'web-components' ]}>\", \"`excludeDecorators`\": \"Type: `boolean`\\n\\nDefault: `parameters.docs.source.excludeDecorators`\\n\\nDetermines if [decorators](../../writing-stories/decorators.mdx) are rendered in the source code snippet.\\n</IfRenderer>\", \"`language`\": \"Type:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n'jsextra' | 'jsx' | 'json' | 'yml' | 'md' | 'bash' | 'css' | 'html' | 'tsx' | 'typescript' | 'graphql'\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nDefault: `parameters.docs.source.language` or `'jsx'`\\n\\nSpecifies the language used for syntax highlighting.\", \"`of`\": \"Type: Story export\\n\\nSpecifies which story's source is rendered.\", \"`transform`\": \"Type: `(code: string, storyContext: StoryContext) => string | Promise<string>`\\n\\nDefault: `parameters.docs.source.transform`\\n\\nAn async function to dynamically transform the source before being rendered, based on the original source and any story context necessary. The returned string is displayed as-is.\\nIf both [`code`](#code) and `transform` are specified, `transform` will be ignored.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nexport default {\\n parameters: {\\n docs: {\\n source: {\\n transform: async (source) => {\\n const prettier = await import('prettier/standalone');\\n const prettierPluginBabel = await import('prettier/plugins/babel');\\n const prettierPluginEstree = await import('prettier/plugins/estree');\\n\\n return prettier.format(source, {\\n parser: 'babel',\\n plugins: [prettierPluginBabel, prettierPluginEstree],\\n });\\n },\\n },\\n },\\n },\\n};\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nThis example shows how to use Prettier to format all source code snippets in your documentation. The transform function is applied globally through the preview configuration, ensuring consistent code formatting across all stories.\", \"`type`\": \"Type: `'auto' | 'code' | 'dynamic'`\\n\\nDefault: `parameters.docs.source.type` or `'auto'`\\n\\nSpecifies how the source code is rendered.\\n\\n[\\\"**auto**: Same as **dynamic**, if the story's `render` function accepts args inputs and **dynamic** is supported by the framework in use; otherwise same as **code**\\\", '**code**: Renders the value of [`code` prop](#code), otherwise renders static story source', '**dynamic**: Renders the story source with dynamically updated arg values']\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nNote that dynamic snippets will only work if the story uses [`args`](../../writing-stories/args.mdx) and the [`Story` block](./doc-block-story.mdx) for that story is rendered along with the `Source` block.\\n\\n</Callout>\"}}, \"metadata\": {\"title\": \"Source\", \"sidebar\": {\"order\": 10, \"title\": \"Source\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 9]\"}, {\"title\": \"Stories\", \"description\": null, \"content\": {\"Stories\": {\"`includePrimary`\": \"Type: `boolean`\\n\\nDefault: `true`\\n\\nDetermines if the collection of stories includes the primary (first) story.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nIf a stories file contains only one story and `includePrimary={true}`, the `Stories` block will render nothing to avoid a potentially confusing situation.\\n\\n</Callout>\", \"`title`\": \"Type: `string`\\n\\nDefault: `'Stories'`\\n\\nSets the heading content preceding the collection of stories.\"}}, \"metadata\": {\"title\": \"Stories\", \"sidebar\": {\"order\": 11, \"title\": \"Stories\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 10]\"}, {\"title\": \"Story\", \"description\": null, \"content\": {\"Story\": {\"`autoplay`\": \"Type: `boolean`\\n\\nDefault: `parameters.docs.story.autoplay`\\n\\nDetermines whether a story's play function runs.\\n\\nBecause all stories render simultaneously in docs entries, play functions can perform arbitrary actions that can interact with each other (such as stealing focus or scrolling the screen). For that reason, by default, stories **do not run play functions in docs mode**.\\n\\nHowever, if you know your play function is \\u201csafe\\u201d to run in docs, you can use this prop to run it automatically.\\n\\n<Callout variant=\\\"info\\\">\\nIf a story uses [`mount` in its play function](../../writing-tests/interaction-testing.mdx#run-code-before-the-component-gets-rendered), it will not render in docs unless `autoplay` is set to `true`.\\n</Callout>\", \"`height`\": \"Type: `string`\\n\\nDefault: `parameters.docs.story.height`\\n\\nSet a minimum height (note for an iframe this is the actual height) when rendering a story in an iframe or inline. This overrides `parameters.docs.story.iframeHeight` for iframes.\", \"`inline`\": \"Type: `boolean`\\n\\nDefault: `parameters.docs.story.inline` or `true` (for [supported frameworks](../../configure/integration/frameworks-feature-support.mdx))\\n\\nDetermines whether the story is rendered `inline` (in the same browser frame as the other docs content) or in an iframe.\\n\\n<Callout variant=\\\"info\\\">\\n\\nSetting the `inline` option to false will prevent the associated [controls](./doc-block-controls.mdx) from updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release.\\n\\n</Callout>\", \"`meta`\": \"Type: CSF file exports\\n\\nSpecifies the CSF file to which the story is associated.\\n\\nYou can render a story from a CSF file that you haven\\u2019t attached to the MDX file (via `Meta`) by using the `meta` prop. Pass the **full set of exports** from the CSF file (not the default export!).\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Story } from '@storybook/addon-docs/blocks';\\nimport * as ButtonStories from './Button.stories';\\nimport * as HeaderStories from './Header.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n{/* Although this MDX file is largely concerned with Button,\\n it can render Header stories too */}\\n<Story of={HeaderStories.LoggedIn} meta={HeaderStories} />\\n```\\n\\n{/* prettier-ignore-end */}\", \"`of`\": \"Type: Story export\\n\\nSpecifies which story is rendered by the `Story` block. If no `of` is defined and the MDX file is [attached](./doc-block-meta.mdx#attached-vs-unattached), the primary (first) story will be rendered.\"}}, \"metadata\": {\"title\": \"Story\", \"sidebar\": {\"order\": 12, \"title\": \"Story\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 11]\"}, {\"title\": \"Subtitle\", \"description\": null, \"content\": {\"Subtitle\": {\"`children`\": \"Type: `JSX.Element | string`\\n\\nDefault: `parameters.docs.subtitle`\\n\\nProvides the content.\", \"`of`\": \"Type: CSF file exports\\n\\nSpecifies which meta's subtitle is displayed.\"}}, \"metadata\": {\"title\": \"Subtitle\", \"sidebar\": {\"order\": 13, \"title\": \"Subtitle\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 12]\"}, {\"title\": \"Title\", \"description\": null, \"content\": {\"Title\": {\"`children`\": \"Type: `JSX.Element | string`\\n\\nProvides the content. Falls back to value of `title` in an [attached](./doc-block-meta.mdx#attached-vs-unattached) CSF file (or value derived from [autotitle](../../configure/user-interface/sidebar-and-urls.mdx#csf-30-auto-titles)), trimmed to the last segment. For example, if the title value is `'path/to/components/Button'`, the default content is `'Button'`.\", \"`of`\": \"Type: CSF file exports\\n\\nSpecifies which meta's title is displayed.\"}}, \"metadata\": {\"title\": \"Title\", \"sidebar\": {\"order\": 14, \"title\": \"Title\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 13]\"}, {\"title\": \"Typeset\", \"description\": null, \"content\": {\"Typeset\": {\"`fontFamily`\": \"Type: `string`\\n\\nProvides a font family to be displayed.\", \"`fontSizes`\": \"Type: `(string | number)[]`\\n\\nProvides a list of available font sizes (in `px`).\", \"`fontWeight`\": \"Type: `number`\\n\\nSpecifies the weight of the font to be displayed.\", \"`sampleText`\": \"Type: `string`\\n\\nSets the text to be displayed.\"}}, \"metadata\": {\"title\": \"Typeset\", \"sidebar\": {\"order\": 15, \"title\": \"Typeset\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 14]\"}, {\"title\": \"Unstyled\", \"description\": null, \"content\": {\"Unstyled\": {\"`children`\": \"Type: `React.ReactNode`\\n\\nProvides the content to which you do *not* want to apply default docs styles.\"}}, \"metadata\": {\"title\": \"Unstyled\", \"sidebar\": {\"order\": 16, \"title\": \"Unstyled\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 15]\"}, {\"title\": \"useOf\", \"description\": null, \"content\": {\"useOf\": {\"Type\": \"{/* prettier-ignore-start */}\\n\\n```\\n(\\n moduleExportOrType: ModuleExport | 'story' | 'meta' | 'component',\\n validTypes?: Array<'story' | 'meta' | 'component'>\\n) => EnhancedResolvedModuleExportType\\n```\\n\\n{/* prettier-ignore-end */}\", \"Parameters\": {\"`moduleExportOrType`\": \"(**Required**)\\n\\nType: `ModuleExport | 'story' | 'meta' | 'component'`\\n\\nProvides the story export, meta export, component export, or CSF file exports from which you get annotations.\\n\\nWhen the custom block is in an [attached doc](./doc-block-meta.mdx#attached-vs-unattached), it\\u2019s also possible to get the primary (first) story, meta, or component by passing in a string instead. This is useful as a fallback, so the `of` prop can be omitted in your block. The most common pattern is using this as `useOf(props.of || 'story')` which will fall back to the primary story if no `of` prop is defined.\\n\\n[\\\"`useOf('story')` returns the annotated primary story in attached mode; error in unattached mode\\\", \\\"`useOf('meta')` returns the annotated meta in attached mode; error in unattached mode\\\", \\\"`useOf('component')` returns the annotated component specified in the meta in attached mode; error in unattached mode\\\"]\", \"`validTypes`\": \"Type: `Array<'story' | 'meta' | 'component'>`\\n\\nOptionally specify an array of valid types that your block accepts. Passing anything other than the valid type(s) will result in an error. For example, the [`Canvas`](./doc-block-canvas.mdx) block uses `useOf(of, ['story'])`, which ensures it only accepts a reference to a story, not a meta or component.\"}, \"Return\": {\"`EnhancedResolvedModuleExportType['type'] === 'story'`\": \"Type: `{ type: 'story', story: PreparedStory }`\\n\\nFor stories, annotated stories are returned as is. They are prepared, meaning that they are already merged with project and meta annotations.\", \"`EnhancedResolvedModuleExportType['type'] === 'meta'`\": \"Type: `{ type: 'meta', csfFile: CSFFile, preparedMeta: PreparedMeta }`\\n\\nFor meta, the parsed CSF file is returned, along with prepared annotated meta. That is, project annotations merged with meta annotations, but no story annotations.\", \"`EnhancedResolvedModuleExportType['type'] === 'component'`\": \"Type: `{ type: 'component', component: Component, projectAnnotations: NormalizedProjectAnnotations }`\\n\\nFor components, the component is returned along with project annotations; no meta or story annotations.\\n\\nNote that it\\u2019s often impossible for the hook to determine if a component is passed in or any other object, so it behaves like an `unknown` type as well.\"}}}, \"metadata\": {\"title\": \"useOf\", \"sidebar\": {\"order\": 17, \"title\": \"useOf\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 16]\"}, {\"title\": \"Doc Blocks\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Doc Blocks\", \"sidebar\": {\"order\": 5, \"title\": \"Doc Blocks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6, \\\"subpages\\\", 17]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 6]\"}, {\"title\": \"Main Config\", \"description\": \"Documentation section: main-config\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/api/main-config\"}, \"subpages\": [{\"title\": \"main.js|ts configuration\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"main.js|ts configuration\", \"sidebar\": {\"order\": 1, \"title\": \"main.js|ts configuration\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"addons\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `(string | { name: string; options?: AddonOptions })[]`\", \"Registers the [addons](../../addons/install-addons.mdx) loaded by Storybook.\", \"For each addon's available options, see their respective [documentation](https://storybook.js.org/integrations).\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-addons.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"addons\", \"sidebar\": {\"order\": 4, \"title\": \"addons\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"babelDefault\", \"description\": null, \"content\": {\"`Babel.Config`\": \"The options provided by [Babel](https://babeljs.io/docs/options) are only applicable if you've enabled the [`@storybook/addon-webpack5-compiler-babel`](https://storybook.js.org/addons/@storybook/addon-webpack5-compiler-babel) addon.\", \"`Options`\": \"Type: `{ configType?: 'DEVELOPMENT' | 'PRODUCTION' }`\\n\\nThere are other options that are difficult to document here. Please introspect the type definition for more information.\"}, \"metadata\": {\"title\": \"babelDefault\", \"sidebar\": {\"order\": 6, \"title\": \"babelDefault\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"babel\", \"description\": null, \"content\": {\"`Babel.Config`\": \"The options provided by [Babel](https://babeljs.io/docs/options) are only applicable if you've enabled the [`@storybook/addon-webpack5-compiler-babel`](https://storybook.js.org/addons/@storybook/addon-webpack5-compiler-babel) addon.\\n\\n<Callout variant=\\\"info\\\">\\n\\nIf you have an existing Babel configuration file (e.g., `.babelrc`), it will be automatically detected and used by Storybook without any additional configuration required.\\n\\n</Callout>\", \"`Options`\": \"Type: `{ configType?: 'DEVELOPMENT' | 'PRODUCTION' }`\\n\\nThere are other options that are difficult to document here. Please introspect the type definition for more information.\"}, \"metadata\": {\"title\": \"babel\", \"sidebar\": {\"order\": 5, \"title\": \"babel\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"build\", \"description\": null, \"content\": {\"`test`\": {\"`test.disableBlocks`\": \"Type: `boolean`\\n\\nExcludes the `@storybook/addon-docs/blocks` module from the build, which generates automatic documentation with [Docs Blocks](../../writing-docs/doc-blocks.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-blocks.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disabledAddons`\": \"Type: `string[]`\\n\\nSets the list of addons that will disabled in the build output.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-disableaddons.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disableMDXEntries`\": \"Type: `boolean`\\n\\nEnabling this option removes user-written documentation entries in MDX format from the build.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-mdx.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disableAutoDocs`\": \"Type: `boolean`\\n\\nPrevents automatic documentation generated with the [autodocs](../../writing-docs/autodocs.mdx) feature from being included in the build.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-autodocs.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disableDocgen`\": \"Type: `boolean`\\n\\nDisables [automatic argType](../arg-types.mdx#automatic-argtype-inference) and component property inference with any of the supported static analysis tools based on the framework you are using.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-docgen.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disableSourcemaps`\": \"Type: `boolean`\\n\\nOverrides the default behavior of generating source maps for the build.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-sourcemaps.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`test.disableTreeShaking`\": \"Type: `boolean`\\n\\nDisables [tree shaking](https://developer.mozilla.org/en-US/docs/Glossary/Tree_shaking) in the build.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-test-disable-treeshaking.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"build\", \"sidebar\": {\"order\": 7, \"title\": \"build\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"core\", \"description\": null, \"content\": {\"`builder`\": \"Type:\\n\\n```\\n| '@storybook/builder-vite' | '@storybook/builder-webpack5'\\n| {\\n name: '@storybook/builder-vite' | '@storybook/builder-webpack5';\\n options?: BuilderOptions;\\n }\\n```\\n\\nConfigures Storybook's builder, [Vite](../../builders/vite.mdx) or [Webpack](../../builders/webpack.mdx).\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nWith the new [Framework API](../new-frameworks.mdx), [`framework.options.builder`](./main-config-framework.mdx#optionsbuilder) is now the preferred way to configure the builder.\\n\\nYou should only use `core.builder.options` if you need to configure a builder that is not part of a framework.\\n</Callout>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-builder.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`channelOptions`\": {\"`channelOptions.maxDepth`\": \"Type: `number`\\n\\nDefault: `3`\\n\\nThe maximum depth of nested objects to serialize across the channel. Larger values will be slower.\"}, \"`crossOriginIsolated`\": \"Type: `boolean`\\n\\nEnable CORS headings to run document in a \\\"secure context\\\". See [SharedArrayBuffer security requirements](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer#security_requirements)\\n\\nThis enables these headers in development-mode:\\n\\n['`Cross-Origin-Opener-Policy: same-origin`', '`Cross-Origin-Embedder-Policy: require-corp`']\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-cross-origin-isolated.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`disableProjectJson`\": \"Type: `boolean`\\n\\nDisables the generation of `project.json`, a file containing Storybook metadata\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-disable-project-json.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`disableTelemetry`\": \"Type: `boolean`\\n\\nDisables Storybook's [telemetry collection](../../configure/telemetry.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-disable-telemetry.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`disableWebpackDefaults`\": \"Type: `boolean`\\n\\nDisables Storybook's default Webpack configuration.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-disable-webpack-defaults.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`disableWhatsNewNotifications`\": \"Type: `boolean`\\n\\nDisables the \\\"What's New\\\" notifications in the UI for new Storybook versions and ecosystem updates (e.g., [addons](https://storybook.js.org/integrations/), [content](https://storybook.js.org/blog/), etc.).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-disable-update-notifications.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`enableCrashReports`\": \"Type: `boolean`\\n\\nEnable crash reports to be sent to Storybook [telemetry](../../configure/telemetry.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-core-enable-crash-reports.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`renderer`\": \"Type: `RendererName`\\n\\n{/* TODO: Is this used? Should it be documented? */}\"}, \"metadata\": {\"title\": \"core\", \"sidebar\": {\"order\": 8, \"title\": \"core\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}, {\"title\": \"docs\", \"description\": null, \"content\": {\"`autodocs`\": \"Type: `boolean | 'tag'`\\n\\nDefault: `'tag'`\\n\\nEnables or disables automatic documentation for stories.\\n\\n['`true`: Enables it for all stories', '`false`: Disables it for all stories', \\\"`'tag'`: Enables it for stories tagged with `'autodocs'`\\\"]\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-docs-autodocs.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`defaultName`\": \"Type: `string`\\n\\nDefault: `'Docs'`\\n\\nName used for generated documentation pages.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-docs-default-name.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`docsMode`\": \"Type: `boolean`\\n\\nOnly show documentation pages in the sidebar (usually set with the `--docs` CLI flag).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-docs-docs-mode.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"docs\", \"sidebar\": {\"order\": 9, \"title\": \"docs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\"}, {\"title\": \"env\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `(config: { [key: string]: string }) => { [key: string]: string }`\", \"Defines custom Storybook [environment variables](../../configure/environment-variables.mdx#using-storybook-configuration).\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-env.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"env\", \"sidebar\": {\"order\": 10, \"title\": \"env\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\"}, {\"title\": \"features\", \"description\": null, \"content\": {\"`actions`\": \"Type: `boolean`\\n\\nEnable the [Actions](../../essentials/actions.mdx) feature.\", \"`angularFilterNonInputControls`\": \"Type: `boolean`\\n\\nFilter non-input controls in Angular.\", \"`argTypeTargetsV7`\": \"(\\u26a0\\ufe0f **Experimental**)\\n\\nType: `boolean`\\n\\nFilter args with a \\\"target\\\" on the type from the render function.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-features-arg-type-targets-v7.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`backgrounds`\": \"Type: `boolean`\\n\\nEnable the [Backgrounds](../../essentials/backgrounds.mdx) feature.\", \"`controls`\": \"Type: `boolean`\\n\\nEnable the [Controls](../../essentials/controls.mdx) feature.\", \"`developmentModeForBuild`\": \"Type: `boolean`\\n\\nSet `NODE_ENV` to `'development'` in built Storybooks for better testing and debugging capabilities.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-features-development-mode-for-build.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`highlight`\": \"Type: `boolean`\\n\\nEnable the [Highlight](../../essentials/highlight.mdx) feature.\", \"`interactions`\": \"Type: `boolean`\\n\\nEnable the [Interactions](../../writing-tests/interaction-testing.mdx#debugging-interaction-tests) feature.\", \"`legacyDecoratorFileOrder`\": \"Type: `boolean`\\n\\nApply decorators from preview.js before decorators from addons or frameworks. [More information](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#changed-decorator-order-between-previewjs-and-addonsframeworks).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-features-legacy-decorator-file-order.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`measure`\": \"Type: `boolean`\\n\\nEnable the [Measure](../../essentials/measure-and-outline.mdx#measure) feature.\", \"`outline`\": \"Type: `boolean`\\n\\nEnable the [Outline](../../essentials/measure-and-outline.mdx#outline) feature.\", \"`toolbars`\": \"Type: `boolean`\\n\\nEnable the [Toolbars](../../essentials/toolbars.mdx) feature.\", \"`viewport`\": \"Type: `boolean`\\n\\nEnable the [Viewport](../../essentials/viewport.mdx) feature.\"}, \"metadata\": {\"title\": \"features\", \"sidebar\": {\"order\": 11, \"title\": \"features\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\"}, {\"title\": \"framework\", \"description\": null, \"content\": {\"`name`\": \"Type: `string`\\n\\nFor available frameworks and their options, see their respective [documentation](https://github.com/storybookjs/storybook/tree/next/code/frameworks).\", \"`options`\": {\"`options.builder`\": \"Type: `Record<string, any>`\\n\\nConfigures Storybook's builder, [Vite](../../builders/vite.mdx) or [Webpack](../../builders/webpack.mdx).\"}}, \"metadata\": {\"title\": \"framework\", \"sidebar\": {\"order\": 2, \"title\": \"framework\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\"}, {\"title\": \"indexers\", \"description\": null, \"content\": {\"`Indexer`\": {\"`test`\": \"(Required)\\n\\nType: `RegExp`\\n\\nA regular expression run against file names included in the [`stories`](./main-config-stories.mdx) configuration that should match all files to be handled by this indexer.\", \"`createIndex`\": {\"`fileName`\": \"Type: `string`\\n\\nThe name of the CSF file used to create entries to index.\", \"`IndexerOptions`\": {\"`makeTitle`\": \"Type: `(userTitle?: string) => string`\\n\\nA function that takes a user-provided title and returns a formatted title for the index entry, which is used in the sidebar. If no user title is provided, one is automatically generated based on the file name and path.\\n\\nSee [`IndexInput.title`](#title) for example usage.\"}, \"`IndexInput`\": {\"`exportName`\": \"(Required)\\n\\nType: `string`\\n\\nFor each `IndexInput`, the indexer will add this export (from the file found at `importPath`) as an entry in the index.\", \"`importPath`\": \"(Required)\\n\\nType: `string`\\n\\nThe file to import from, e.g. the [CSF](../csf.mdx) file.\\n\\nIt is likely that the [`fileName`](#filename) being indexed is not CSF, in which you will need to [transpile it to CSF](#transpiling-to-csf) so that Storybook can read it in the browser.\", \"`type`\": \"(Required)\\n\\nType: `'story'`\\n\\nThe type of entry.\", \"`rawComponentPath`\": \"Type: `string`\\n\\nThe raw path/package of the file that provides `meta.component`, if one exists.\", \"`metaId`\": \"Type: `string`\\n\\nDefault: Auto-generated from [`title`](#title)\\n\\nDefine the custom id for meta of the entry.\\n\\nIf specified, the export default (meta) in the CSF file *must* have a corresponding `id` property, to be correctly matched.\", \"`name`\": \"Type: `string`\\n\\nDefault: Auto-generated from [`exportName`](#exportname)\\n\\nThe name of the entry.\", \"`tags`\": \"Type: `string[]`\\n\\nTags for filtering entries in Storybook and its tools.\", \"`title`\": \"Type: `string`\\n\\nDefault: Auto-generated from default export of [`importPath`](#importpath)\\n\\nDetermines the location of the entry in the sidebar.\\n\\nMost of the time, you should **not** specify a title, so that your indexer will use the default naming behavior. When specifying a title, you **must** use the [`makeTitle`](#maketitle) function provided in [`IndexerOptions`](#indexeroptions) to also use this behavior. For example, here's an indexer that merely appends a \\\"Custom\\\" prefix to the title derived from the file name:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-indexers-title.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`__id`\": \"Type: `string`\\n\\nDefault: Auto-generated from [`title`](#title)/[`metaId`](#metaid) and [`exportName`](#exportname)\\n\\nDefine the custom id for the story of the entry.\\n\\nIf specified, the story in the CSF file **must** have a corresponding `__id` property, to be correctly matched.\\n\\nOnly use this if you need to override the auto-generated id.\"}}}, \"Transpiling to CSF\": {\"Examples\": \"Some example usages of custom indexers include:\\n\\n<details open>\\n<summary>Generating stories dynamically from fixture data or API endpoints</summary>\\n\\nThis indexer generates stories for components based on JSON fixture data. It looks for `*.stories.json` files in the project, adds them to the index and separately converts their content to CSF.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-indexers-jsonstories.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAn example input JSON file could look like this:\\n\\n```\\n{\\n \\\"Button\\\": {\\n \\\"componentPath\\\": \\\"./button/Button.jsx\\\",\\n \\\"stories\\\": {\\n \\\"Primary\\\": {\\n \\\"args\\\": {\\n \\\"primary\\\": true\\n },\\n \\\"Secondary\\\": {\\n \\\"args\\\": {\\n \\\"primary\\\": false\\n }\\n }\\n }\\n },\\n \\\"Dialog\\\": {\\n \\\"componentPath\\\": \\\"./dialog/Dialog.jsx\\\",\\n \\\"stories\\\": {\\n \\\"Closed\\\": {},\\n \\\"Open\\\": {\\n \\\"args\\\": {\\n \\\"isOpen\\\": true\\n }\\n },\\n }\\n }\\n}\\n```\\n\\nA builder plugin will then need to transform the JSON file into a regular CSF file. This transformation could be done with a Vite plugin similar to this:\\n\\n```\\n// vite-plugin-storybook-json-stories.ts\\n\\nimport type { PluginOption } from 'vite';\\nimport fs from 'fs/promises';\\n\\nfunction JsonStoriesPlugin(): PluginOption {\\n return {\\n name: 'vite-plugin-storybook-json-stories',\\n load(id) {\\n if (!id.startsWith('virtual:jsonstories')) {\\n return;\\n }\\n\\n const [, fileName, componentName] = id.split('--');\\n const content = JSON.parse(fs.readFileSync(fileName));\\n\\n const { componentPath, stories } = getComponentStoriesFromJson(content, componentName);\\n\\n return `\\n import ${componentName} from '${componentPath}';\\n\\n export default { component: ${componentName} };\\n\\n ${stories.map((story) => `export const ${story.name} = ${story.config};\\\\n`)}\\n `;\\n },\\n };\\n}\\n```\\n\\n</details>\\n\\n<details>\\n<summary>Generating stories with an alternative API</summary>\\n\\nYou can use a custom indexer and builder plugin to create your API to define stories extending the CSF format. To learn more, see the following [proof of concept](https://stackblitz.com/edit/github-h2rgfk?file=README.md) to set up a custom indexer to generate stories dynamically. It contains everything needed to support such a feature, including the indexer, a Vite plugin, and a Webpack loader.\\n</details>\\n\\n<details>\\n<summary>Defining stories in non-JavaScript language</summary>\\n\\nCustom indexers can be used for an advanced purpose: defining stories in any language, including template languages, and converting the files to CSF. To see examples of this in action, you can refer to [`@storybook/addon-svelte-csf`](https://github.com/storybookjs/addon-svelte-csf) for Svelte template syntax and [`storybook-vue-addon`](https://github.com/tobiasdiez/storybook-vue-addon) for Vue template syntax.\\n</details>\\n\\n<details>\\n<summary>Adding sidebar links from a URL collection</summary>\\n\\nThe indexer API is flexible enough to let you process arbitrary content, so long as your framework tooling can transform the exports in that content into actual stories it can run. This advanced example demonstrates how you can create a custom indexer to process a collection of URLs, extract the title and URL from each page, and render them as sidebar links in the UI. Implemented with Svelte, it can be adapted to any framework.\\n\\nStart by creating the URL collection file (i.e., `src/MyLinks.url.js`) with a list of URLs listed as named exports. The indexer will use the export name as the story title and the value as the unique identifier.\\n\\n```\\nexport default {};\\n\\nexport const DesignTokens = 'https://www.designtokens.org/';\\nexport const CobaltUI = 'https://cobalt-ui.pages.dev/';\\nexport const MiseEnMode = 'https://mode.place/';\\nexport const IndexerAPI = 'https://github.com/storybookjs/storybook/discussions/23176';\\n```\\n\\nAdjust your Vite configuration file to include a custom plugin complementing the indexer. This will allow Storybook to process and import the URL collection file as stories.\\n\\n```\\nimport * as acorn from 'acorn';\\nimport * as walk from 'acorn-walk';\\nimport { defineConfig, type Plugin } from 'vite';\\nimport { svelte } from '@sveltejs/vite-plugin-svelte';\\n\\nfunction StorybookUrlLinksPlugin(): Plugin {\\n return {\\n name: 'storybook-url-links',\\n async transform(code: string, id: string) {\\n if (id.endsWith('.url.js')) {\\n const ast = acorn.parse(code, {\\n ecmaVersion: 2020,\\n sourceType: 'module',\\n });\\n\\n const namedExports: string[] = [];\\n let defaultExport = 'export default {};';\\n\\n walk.simple(ast, {\\n // Extracts the named exports, those represent our stories, and for each of them, we'll return a valid Svelte component.\\n ExportNamedDeclaration(node: acorn.ExportNamedDeclaration) {\\n if (\\n node.declaration &&\\n node.declaration.type === 'VariableDeclaration'\\n ) {\\n node.declaration.declarations.forEach((declaration) => {\\n if ('name' in declaration.id) {\\n namedExports.push(declaration.id.name);\\n }\\n });\\n }\\n },\\n // Preserve our default export.\\n ExportDefaultDeclaration(node: acorn.ExportDefaultDeclaration) {\\n defaultExport = code.slice(node.start, node.end);\\n },\\n });\\n\\n return {\\n code: `\\n import RedirectBack from '../../.storybook/components/RedirectBack.svelte';\\n ${namedExports\\n .map(\\n (name) =>\\n `export const ${name} = () => new RedirectBack();`\\n )\\n .join('\\\\n')}\\n ${defaultExport}\\n `,\\n map: null,\\n };\\n }\\n },\\n };\\n}\\n\\nexport default defineConfig({\\n plugins: [StorybookUrlLinksPlugin(), svelte()],\\n})\\n```\\n\\nUpdate your Storybook configuration (i.e., `.storybook/main.js|ts`) to include the custom indexer.\\n\\n```\\n// Replace your-framework with the framework you are using, e.g. sveltekit or svelte-vite\\nimport type { StorybookConfig } from '@storybook/your-framework';\\nimport type { Indexer } from 'storybook/internal/types';\\n\\nconst urlIndexer: Indexer = {\\n test: /\\\\.url\\\\.js$/,\\n createIndex: async (fileName, { makeTitle }) => {\\n const fileData = await import(fileName);\\n\\n return Object.entries(fileData)\\n .filter(([key]) => key != 'default')\\n .map(([name, url]) => {\\n return {\\n type: 'docs',\\n importPath: fileName,\\n exportName: name,\\n title: makeTitle(name)\\n .replace(/([a-z])([A-Z])/g, '$1 $2')\\n .trim(),\\n __id: `url--${name}--${encodeURIComponent(url as string)}`,\\n tags: ['!autodocs', 'url']\\n };\\n });\\n }\\n};\\n\\nconst config: StorybookConfig = {\\n stories: ['../src/**/*.stories.@(js|ts|svelte)', '../src/**/*.url.js'],\\n framework: {\\n name: '@storybook/svelte-vite',\\n options: {},\\n },\\n experimental_indexers: async (existingIndexers) => [urlIndexer, ...existingIndexers]\\n};\\nexport default config;\\n```\\n\\nAdd a Storybook UI configuration file (i.e., `.storybook/manager.js|ts`) to render the indexed URLs as sidebar links in the UI:\\n\\n```\\nimport { addons } from 'storybook/manager-api';\\n\\nimport SidebarLabelWrapper from './components/SidebarLabelWrapper.tsx';\\n\\naddons.setConfig({\\n sidebar: {\\n renderLabel: (item) => SidebarLabelWrapper({ item }),\\n },\\n});\\n```\\n\\nThis example's code and live demo are available on [StackBlitz](https://stackblitz.com/~/github.com/Sidnioulz/storybook-sidebar-urls).\\n\\n</details>\"}}, \"metadata\": {\"title\": \"indexers\", \"sidebar\": {\"order\": 12, \"title\": \"indexers\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\"}, {\"title\": \"logLevel\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `'debug' | 'error' | 'info' | 'trace' | 'warn'`\", \"Default: `'info'`\", \"Configures Storybook's logs in the browser terminal. Useful for debugging.\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-log-level.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"logLevel\", \"sidebar\": {\"order\": 13, \"title\": \"logLevel\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 11]\"}, {\"title\": \"managerHead\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `(head: string) => string`\", \"Programmatically adjust the manager's `<head>` of your Storybook. For example, load a custom font or add a script. Most often used by [addon authors](../../addons/writing-presets.mdx#ui-configuration).\", \"<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\", \"If you don't need to programmatically adjust the manager head, you can add scripts and styles to `manager-head.html` instead.\", \"</Callout>\", \"For example, you can conditionally add scripts or styles, depending on the environment:\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-manager-head.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"managerHead\", \"sidebar\": {\"order\": 14, \"title\": \"managerHead\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 12]\"}, {\"title\": \"previewAnnotations\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `string[] | ((config: string[], options: Options) => string[] | Promise<string[]>)`\", \"Add additional scripts to run in the story preview.\", \"<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nMostly used by [frameworks](../../contribute/framework.mdx#previewjs-example). Storybook users and [addon authors](../../addons/writing-presets.mdx) should add scripts to [`preview.js`](../../configure/index.mdx#configure-story-rendering) instead.\\n</Callout>\", \"```\\n// @storybook/nextjs framework's src/preset.ts\\n\\nimport type { StorybookConfig } from './types';\\n\\nexport const previewAnnotations: StorybookConfig['previewAnnotations'] = (entry = []) => [\\n ...entry,\\n import.meta.resolve('@storybook/nextjs/preview'),\\n];\\n```\"]}, \"metadata\": {\"title\": \"previewAnnotations\", \"sidebar\": {\"order\": 15, \"title\": \"previewAnnotations\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 13]\"}, {\"title\": \"previewBody\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `(body: string) => string`\", \"Programmatically adjust the [preview `<body>`](../../configure/story-rendering.mdx#adding-to-body) of your Storybook. Most often used by [addon authors](../../addons/writing-presets.mdx#ui-configuration).\", \"<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\", \"If you don't need to programmatically adjust the preview body, you can add scripts and styles to [`preview-body.html`](../../configure/story-rendering.mdx#adding-to-body) instead.\", \"</Callout>\", \"For example, you can conditionally add scripts or styles, depending on the environment:\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-preview-body.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"previewBody\", \"sidebar\": {\"order\": 16, \"title\": \"previewBody\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 14]\"}, {\"title\": \"previewHead\", \"description\": null, \"content\": {\"root\": [\"Parent: [main.js|ts configuration](./main-config.mdx)\", \"Type: `(head: string) => string`\", \"Programmatically adjust the [preview `<head>`](../../configure/story-rendering.mdx#adding-to-head) of your Storybook. Most often used by [addon authors](../../addons/writing-presets.mdx#ui-configuration).\", \"<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nIf you don't need to programmatically adjust the preview head, you can add scripts and styles to [`preview-head.html`](../../configure/story-rendering.mdx#adding-to-head) instead.\\n</Callout>\", \"For example, you can conditionally add scripts or styles, depending on the environment:\", \"{/* prettier-ignore-start */}\", \"<CodeSnippets path=\\\"main-config-preview-head.md\\\" />\", \"{/* prettier-ignore-end */}\"]}, \"metadata\": {\"title\": \"previewHead\", \"sidebar\": {\"order\": 17, \"title\": \"previewHead\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 15]\"}, {\"title\": \"refs\", \"description\": null, \"content\": {\"Using a function\": \"You can use a function to dynamically configure refs:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-refs-with-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Disable a ref\": \"Some package dependencies automatically [compose their Storybook in yours](../../sharing/package-composition.mdx). You can disable this behavior by setting `disable` to `true` for the package name:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-refs-disable.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"refs\", \"sidebar\": {\"order\": 18, \"title\": \"refs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 16]\"}, {\"title\": \"staticDirs\", \"description\": null, \"content\": {\"With configuration objects\": \"You can also use a configuration object to define the directories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-static-dirs-with-object.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"staticDirs\", \"sidebar\": {\"order\": 19, \"title\": \"staticDirs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 17]\"}, {\"title\": \"stories\", \"description\": null, \"content\": {\"With an array of globs\": \"Storybook will load stories from your project as found by this array of globs (pattern matching strings).\\n\\nStories are loaded in the order they are defined in the array. This allows you to control the order in which stories are displayed in the sidebar:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-stories-ordered.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"With a configuration object\": {\"`StoriesSpecifier`\": {\"`StoriesSpecifier.directory`\": \"(**Required**)\\n\\nType: `string`\\n\\nWhere to start looking for story files, relative to the root of your project.\", \"`StoriesSpecifier.files`\": \"Type: `string`\\n\\nDefault: `'**/*.@(mdx|stories.@(js|jsx|mjs|ts|tsx))'`\\n\\nA glob, relative to `StoriesSpecifier.directory` (with no leading `./`), that matches the filenames to load.\", \"`StoriesSpecifier.titlePrefix`\": \"Type: `string`\\n\\nDefault: `''`\\n\\nWhen [auto-titling](../../configure/user-interface/sidebar-and-urls.mdx#csf-30-auto-titles), prefix used when generating the title for your stories.\"}}, \"With a custom implementation\": \"<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\ud83d\\udca1 Storybook now statically analyzes the configuration file to improve performance. Loading stories with a custom implementation may de-optimize or break this ability.\\n</Callout>\\n\\nYou can also adjust your Storybook configuration and implement custom logic to load your stories. For example, suppose you were working on a project that includes a particular pattern that the conventional ways of loading stories could not solve. In that case, you could adjust your configuration as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-stories-with-logic.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"stories\", \"sidebar\": {\"order\": 3, \"title\": \"stories\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 18]\"}, {\"title\": \"swc\", \"description\": null, \"content\": {\"`SWC.Options`\": \"The options provided by [SWC](https://swc.rs/) are only applicable if you've enabled the [`@storybook/addon-webpack5-compiler-swc`](https://storybook.js.org/addons/@storybook/addon-webpack5-compiler-swc) addon.\", \"Options\": \"Type: `{ configType?: 'DEVELOPMENT' | 'PRODUCTION' }`\\n\\nThere are other options that are difficult to document here. Please introspect the type definition for more information.\"}, \"metadata\": {\"title\": \"swc\", \"sidebar\": {\"order\": 20, \"title\": \"swc\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 19]\"}, {\"title\": \"typescript\", \"description\": null, \"content\": {\"`check`\": \"Type: `boolean`\\n\\nOptionally run [fork-ts-checker-webpack-plugin](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin). Note that because this uses a Webpack plugin, it is only available when using the [Webpack builder](../../builders/webpack.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typescript-check.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`checkOptions`\": \"Type: `CheckOptions`\\n\\nOptions to pass to `fork-ts-checker-webpack-plugin`, if [enabled](#check). See [docs for available options](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin/blob/v4.1.6/README.md#options).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typescript-check-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"`reactDocgen`\": \"Type: `'react-docgen' | 'react-docgen-typescript' | false`\\n\\nDefault:\\n\\n['`false`: if `@storybook/react` is not installed', \\\"`'react-docgen'`: if `@storybook/react` is installed\\\"]\\n\\nConfigures which library, if any, Storybook uses to parse React components, [react-docgen](https://github.com/reactjs/react-docgen) or [react-docgen-typescript](https://github.com/styleguidist/react-docgen-typescript). Set to `false` to disable parsing React components. `react-docgen-typescript` invokes the TypeScript compiler, which makes it slow but generally accurate. `react-docgen` performs its own analysis, which is much faster but incomplete.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typescript-react-docgen.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`reactDocgenTypescriptOptions`\": \"Type: `ReactDocgenTypescriptOptions`\\n\\nConfigures the options to pass to `react-docgen-typescript-plugin` if `react-docgen-typescript` is enabled. See docs for available options [for Webpack projects](https://github.com/hipstersmoothie/react-docgen-typescript-plugin) or [for Vite projects](https://github.com/joshwooding/vite-plugin-react-docgen-typescript).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typescript-react-docgen-typescript-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\", \"`skipCompiler`\": \"Type: `boolean`\\n\\nDisable parsing of TypeScript files through the compiler, which is used for Webpack5.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typescript-skip-compiler.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"typescript\", \"sidebar\": {\"order\": 21, \"title\": \"typescript\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 20]\"}, {\"title\": \"viteFinal\", \"description\": null, \"content\": {\"`Options`\": \"Type: `{ configType?: 'DEVELOPMENT' | 'PRODUCTION' }`\\n\\nThere are other options that are difficult to document here. Please introspect the type definition for more information.\"}, \"metadata\": {\"title\": \"viteFinal\", \"sidebar\": {\"order\": 22, \"title\": \"viteFinal\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 21]\"}, {\"title\": \"webpackFinal\", \"description\": null, \"content\": {\"`Options`\": \"Type: `{ configType?: 'DEVELOPMENT' | 'PRODUCTION' }`\\n\\nThere are other options that are difficult to document here. Please introspect the type definition for more information.\"}, \"metadata\": {\"title\": \"webpackFinal\", \"sidebar\": {\"order\": 23, \"title\": \"webpackFinal\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 22]\"}, {\"title\": \"Main configuration\", \"description\": null, \"content\": {\"The main configuration file: `main.js` or `main.ts`\": \"<Callout variant=\\\"warning\\\">\\n\\nThis file must be valid ESM. In other words, it must use `import` instead of `require`, and neither `__dirname` nor `__filename` are available.\\n\\n</Callout>\\n\\nThis configuration is defined in `.storybook/main.js|ts`, which is located relative to the root of your project.\\n\\nA typical Storybook configuration file looks like this:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typical.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"config\": \"An object to configure Storybook containing the following properties:\\n\\n['[`framework`](./main-config-framework.mdx) (Required)', '[`stories`](./main-config-stories.mdx) (Required)', '[`addons`](./main-config-addons.mdx)', '[`babel`](./main-config-babel.mdx)', '[`babelDefault`](./main-config-babel-default.mdx)', '[`build`](./main-config-build.mdx)', '[`core`](./main-config-core.mdx)', '[`docs`](./main-config-docs.mdx)', '[`env`](./main-config-env.mdx)', '[`features`](./main-config-features.mdx)', '[`indexers`](./main-config-indexers.mdx) (\\u26a0\\ufe0f Experimental)', '[`logLevel`](./main-config-log-level.mdx)', '[`managerHead`](./main-config-manager-head.mdx)', '[`previewAnnotations`](./main-config-preview-annotations.mdx)', '[`previewBody`](./main-config-preview-body.mdx)', '[`previewHead`](./main-config-preview-head.mdx)', '[`refs`](./main-config-refs.mdx)', '[`staticDirs`](./main-config-static-dirs.mdx)', '[`swc`](./main-config-swc.mdx)', '[`typescript`](./main-config-typescript.mdx)', '[`viteFinal`](./main-config-vite-final.mdx)', '[`webpackFinal`](./main-config-webpack-final.mdx)']\"}, \"metadata\": {\"title\": \"Main configuration\", \"sidebar\": {\"order\": 1, \"title\": \"Overview\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7, \\\"subpages\\\", 23]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 7]\"}, {\"title\": \"Portable Stories\", \"description\": \"Documentation section: portable-stories\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/api/portable-stories\"}, \"subpages\": [{\"title\": \"Portable Stories\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Portable Stories\", \"sidebar\": {\"order\": 6, \"title\": \"Portable Stories\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\"}, {\"title\": \"Portable stories in Jest\", \"description\": null, \"content\": {\"composeStories\": {\"Type\": \"{/* prettier-ignore-start */}\\n\\n```\\n(\\n csfExports: CSF file exports,\\n projectAnnotations?: ProjectAnnotations\\n) => Record<string, ComposedStoryFn>\\n```\\n\\n{/* prettier-ignore-end */}\", \"Parameters\": {\"`csfExports`\": \"(**Required**)\\n\\nType: CSF file exports\\n\\nSpecifies which component's stories you want to compose. Pass the **full set of exports** from the CSF file (not the default export!). E.g. `import * as stories from './Button.stories'`\", \"`projectAnnotations`\": \"Type: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nSpecifies the project annotations to be applied to the composed stories.\\n\\nThis parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.\\n\\nThis parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.\"}, \"Return\": \"Type: `Record<string, ComposedStoryFn>`\\n\\nAn object where the keys are the names of the stories and the values are the composed stories.\\n\\nAdditionally, the composed story will have the following properties:\\n\\n| Property | Type | Description |\\n| ---------- | ----------------------------------------- | ------------------------------------------------------------------------------------- |\\n| args | `Record<string, any>` | The story's [args](../../writing-stories/args.mdx) |\\n| argTypes | `ArgType` | The story's [argTypes](../arg-types.mdx) |\\n| id | `string` | The story's id |\\n| parameters | `Record<string, any>` | The story's [parameters](../parameters.mdx) |\\n| play | `(context) => Promise<void> \\\\| undefined` | Executes the play function of a given story |\\n| run | `(context) => Promise<void> \\\\| undefined` | [Mounts and executes the play function](#3-run) of a given story |\\n| storyName | `string` | The story's name |\\n| tags | `string[]` | The story's [tags](../../writing-stories/tags.mdx) |\"}, \"composeStory\": {\"Type\": \"{/* prettier-ignore-start */}\\n\\n```\\n(\\n story: Story export,\\n componentAnnotations: Meta,\\n projectAnnotations?: ProjectAnnotations,\\n exportsName?: string\\n) => ComposedStoryFn\\n```\\n\\n{/* prettier-ignore-end */}\", \"Parameters\": {\"`story`\": \"(**Required**)\\n\\nType: `Story export`\\n\\nSpecifies which story you want to compose.\", \"`componentAnnotations`\": \"(**Required**)\\n\\nType: `Meta`\\n\\nThe default export from the stories file containing the [`story`](#story).\", \"`projectAnnotations`\": \"Type: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nSpecifies the project annotations to be applied to the composed story.\\n\\nThis parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.\\n\\nThis parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.\", \"`exportsName`\": \"Type: `string`\\n\\nYou probably don't need this. Because `composeStory` accepts a single story, it does not have access to the name of that story's export in the file (like `composeStories` does). If you must ensure unique story names in your tests and you cannot use `composeStories`, you can pass the name of the story's export here.\"}, \"Return\": \"Type: `ComposedStoryFn`\\n\\nA single [composed story](#return).\"}, \"setProjectAnnotations\": {\"Type\": \"```\\n(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => ProjectAnnotation\\n```\", \"Parameters\": {\"`projectAnnotations`\": \"(**Required**)\\n\\nType: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nA set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.\"}}, \"Annotations\": \"Annotations are the metadata applied to a story, like [args](../../writing-stories/args.mdx), [decorators](../../writing-stories/decorators.mdx), [loaders](../../writing-stories/loaders.mdx), and [play functions](../../writing-stories/play-function.mdx). They can be defined for a specific story, all stories for a component, or all stories in the project.\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically \\u2014 you must apply them yourself.\\n\\n\\ud83d\\udc49 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.\", \"2. Compose\": \"The story is prepared by running [`composeStories`](#composestories) or [`composeStory`](#composestory). The outcome is a renderable component that represents the render function of the story.\", \"3. Run\": \"Finally, stories can prepare data they need (e.g. setting up some mocks or fetching data) before rendering by defining [loaders](../../writing-stories/loaders.mdx), [beforeEach](../../writing-tests/interaction-testing.mdx#run-code-before-each-story) or by having all the story code in the play function when using the [mount](../../writing-tests/interaction-testing.mdx#run-code-before-the-component-gets-rendered). In portable stories, all of these steps will be executed when you call the `run` method of the composed story.\\n\\n\\ud83d\\udc49 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed story will return a `run` method to be called.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"portable-stories-jest-with-play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.\\n</Callout>\"}, \"Overriding globals\": \"If your stories behave differently based on [globals](../../essentials/toolbars-and-globals.mdx#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"portable-stories-jest-override-globals.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* End supported renderers */}\\n</If>\"}, \"metadata\": {\"title\": \"Portable stories in Jest\", \"sidebar\": {\"title\": \"Jest\", \"order\": 2}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\"}, {\"title\": \"Portable stories in Playwright CT\", \"description\": null, \"content\": {\"createTest\": {\"Type\": \"```\\ncreateTest(\\n baseTest: PlaywrightFixture\\n) => PlaywrightFixture\\n```\", \"Parameters\": {\"`baseTest`\": \"(**Required**)\\n\\nType: `PlaywrightFixture`\\n\\nThe base test function to use, e.g. `test` from Playwright.\"}, \"Return\": \"Type: `PlaywrightFixture`\\n\\nA Storybook-specific test function with the custom `mount` mechanism.\"}, \"setProjectAnnotations\": {\"Type\": \"```\\n(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => ProjectAnnotation\\n```\", \"Parameters\": {\"`projectAnnotations`\": \"(**Required**)\\n\\nType: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nA set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.\"}}, \"Annotations\": \"Annotations are the metadata applied to a story, like [args](../../writing-stories/args.mdx), [decorators](../../writing-stories/decorators.mdx), [loaders](../../writing-stories/loaders.mdx), and [play functions](../../writing-stories/play-function.mdx). They can be defined for a specific story, all stories for a component, or all stories in the project.\\n\\n<Callout variant=\\\"info\\\">\\n[Read more about Playwright's component testing](https://playwright.dev/docs/test-components#test-stories).\\n</Callout>\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically \\u2014 you must apply them yourself.\\n\\n\\ud83d\\udc49 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.\", \"2. Prepare, load, render, and play\": \"The story pipeline includes preparing the story, [loading data](../../writing-stories/loaders.mdx), rendering the story, and [playing interactions](../../writing-tests/interaction-testing.mdx#debugging-interaction-tests). In portable stories within Playwright CT, the `mount` function takes care of these steps for you.\\n\\n\\ud83d\\udc49 For this, you use the [`createTest`](#createtest) API.\\n\\n<Callout variant=\\\"info\\\">\\nIf your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.\\n</Callout>\"}, \"Overriding globals\": \"If your stories behave differently based on [globals](../../essentials/toolbars-and-globals.mdx#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"portable-stories-playwright-ct-override-globals.md\\\" />\\n\\nYou can then use those composed stories in your Playwright test file using the [`createTest`](#createtest) function.\\n\\n{/* prettier-ignore-end */}\\n\\n{/* End supported renderers */}\\n</If>\"}, \"metadata\": {\"title\": \"Portable stories in Playwright CT\", \"sidebar\": {\"title\": \"Playwright\", \"order\": 3}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\"}, {\"title\": \"Portable stories in Vitest\", \"description\": null, \"content\": {\"composeStories\": {\"Type\": \"{/* prettier-ignore-start */}\\n\\n```\\n(\\n csfExports: CSF file exports,\\n projectAnnotations?: ProjectAnnotations\\n) => Record<string, ComposedStoryFn>\\n```\\n\\n{/* prettier-ignore-end */}\", \"Parameters\": {\"`csfExports`\": \"(**Required**)\\n\\nType: CSF file exports\\n\\nSpecifies which component's stories you want to compose. Pass the **full set of exports** from the CSF file (not the default export!). E.g. `import * as stories from './Button.stories'`\", \"`projectAnnotations`\": \"Type: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nSpecifies the project annotations to be applied to the composed stories.\\n\\nThis parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.\\n\\nThis parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.\"}, \"Return\": \"Type: `Record<string, ComposedStoryFn>`\\n\\nAn object where the keys are the names of the stories and the values are the composed stories.\\n\\nAdditionally, the composed story will have the following properties:\\n\\n| Property | Type | Description |\\n| ---------- | ----------------------------------------- | ------------------------------------------------------------------------------------- |\\n| args | `Record<string, any>` | The story's [args](../../writing-stories/args.mdx) |\\n| argTypes | `ArgType` | The story's [argTypes](../arg-types.mdx) |\\n| id | `string` | The story's id |\\n| parameters | `Record<string, any>` | The story's [parameters](../parameters.mdx) |\\n| play | `(context) => Promise<void> \\\\| undefined` | Executes the play function of a given story |\\n| run | `(context) => Promise<void> \\\\| undefined` | [Mounts and executes the play function](#3-run) of a given story |\\n| storyName | `string` | The story's name |\\n| tags | `string[]` | The story's [tags](../../writing-stories/tags.mdx) |\"}, \"composeStory\": {\"Type\": \"{/* prettier-ignore-start */}\\n\\n```\\n(\\n story: Story export,\\n componentAnnotations: Meta,\\n projectAnnotations?: ProjectAnnotations,\\n exportsName?: string\\n) => ComposedStoryFn\\n```\\n\\n{/* prettier-ignore-end */}\", \"Parameters\": {\"`story`\": \"(**Required**)\\n\\nType: `Story export`\\n\\nSpecifies which story you want to compose.\", \"`componentAnnotations`\": \"(**Required**)\\n\\nType: `Meta`\\n\\nThe default export from the stories file containing the [`story`](#story).\", \"`projectAnnotations`\": \"Type: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nSpecifies the project annotations to be applied to the composed story.\\n\\nThis parameter is provided for convenience. You should likely use [`setProjectAnnotations`](#setprojectannotations) instead. Details about the `ProjectAnnotation` type can be found in that function's [`projectAnnotations`](#projectannotations-2) parameter.\\n\\nThis parameter can be used to [override](#overriding-globals) the project annotations applied via `setProjectAnnotations`.\", \"`exportsName`\": \"Type: `string`\\n\\nYou probably don't need this. Because `composeStory` accepts a single story, it does not have access to the name of that story's export in the file (like `composeStories` does). If you must ensure unique story names in your tests and you cannot use `composeStories`, you can pass the name of the story's export here.\"}, \"Return\": \"Type: `ComposedStoryFn`\\n\\nA single [composed story](#return).\"}, \"setProjectAnnotations\": {\"Type\": \"```\\n(projectAnnotations: ProjectAnnotation | ProjectAnnotation[]) => ProjectAnnotation\\n```\", \"Parameters\": {\"`projectAnnotations`\": \"(**Required**)\\n\\nType: `ProjectAnnotation | ProjectAnnotation[]`\\n\\nA set of project [annotations](#annotations) (those defined in `.storybook/preview.js|ts`) or an array of sets of project annotations, which will be applied to all composed stories.\"}}, \"Annotations\": \"Annotations are the metadata applied to a story, like [args](../../writing-stories/args.mdx), [decorators](../../writing-stories/decorators.mdx), [loaders](../../writing-stories/loaders.mdx), and [play functions](../../writing-stories/play-function.mdx). They can be defined for a specific story, all stories for a component, or all stories in the project.\", \"Story pipeline\": {\"1. Apply project-level annotations\": \"[Annotations](#annotations) come from the story itself, that story's component, and the project. The project-level annotations are those defined in your `.storybook/preview.js` file and by addons you're using. In portable stories, these annotations are not applied automatically \\u2014 you must apply them yourself.\\n\\n\\ud83d\\udc49 For this, you use the [`setProjectAnnotations`](#setprojectannotations) API.\", \"2. Compose\": \"The story is prepared by running [`composeStories`](#composestories) or [`composeStory`](#composestory). The outcome is a renderable component that represents the render function of the story.\", \"3. Run\": \"Finally, stories can prepare data they need (e.g. setting up some mocks or fetching data) before rendering by defining [loaders](../../writing-stories/loaders.mdx), [beforeEach](../../writing-tests/interaction-testing.mdx#run-code-before-each-story) or by having all the story code in the play function when using the [mount](../../writing-tests/interaction-testing.mdx#run-code-before-the-component-gets-rendered). In portable stories, all of these steps will be executed when you call the `run` method of the composed story.\\n\\n\\ud83d\\udc49 For this, you use the [`composeStories`](#composestories) or [`composeStory`](#composestory) API. The composed story will return a `run` method to be called.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"portable-stories-vitest-with-play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf your play function contains assertions (e.g. `expect` calls), your test will fail when those assertions fail.\\n</Callout>\"}, \"Overriding globals\": \"If your stories behave differently based on [globals](../../essentials/toolbars-and-globals.mdx#globals) (e.g. rendering text in English or Spanish), you can define those global values in portable stories by overriding project annotations when composing a story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"portable-stories-vitest-override-globals.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* End supported renderers */}\\n</If>\"}, \"metadata\": {\"title\": \"Portable stories in Vitest\", \"sidebar\": {\"title\": \"Vitest\", \"order\": 1, \"hidden\": true}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 4]\"}, {\"title\": \"Builders\", \"description\": \"Documentation section: builders\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/builders\"}, \"subpages\": [{\"title\": \"Builder API\", \"description\": null, \"content\": {\"How do builders work?\": \"In Storybook, a builder is responsible for compiling your components and stories into JS bundles that run in the browser. A builder also provides a development server for interactive development and a production mode for optimized bundles.\\n\\nTo opt into a builder, the user must add it as a dependency and then edit their configuration file (`.storybook/main.js`) to enable it. For example, with the Vite builder:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Builder API\": \"In Storybook, every builder must implement the following [API](https://github.com/storybookjs/storybook/blob/main/code/core/src/types/modules/core-common.ts#L239-L259), exposing the following configuration options and entry points:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-interface.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn development mode, the `start` API call is responsible for initializing the development server to monitor the file system for changes (for example, components and stories) then execute a hot module reload in the browser.\\nIt also provides a **bail** function to allow the running process to end gracefully, either via user input or error.\\n\\nIn production, the `build` API call is responsible for generating a static Storybook build, storing it by default in the `storybook-static` directory if no additional configuration is provided. The generated output should contain everything the user needs to view its Storybook by opening either the `index.html` or `iframe.html` in a browser with no other processes running.\", \"Implementation\": {\"Import stories\": \"The `stories` configuration field enables story loading in Storybook. It defines an array of file globs containing the physical location of the component's stories. The builder must be able to load those files and monitor them for changes and update the UI accordingly.\", \"Provide configuration options\": \"By default, Storybook's configuration is handled in a dedicated file (`storybook/main.js|ts`), giving the user the option to customize it to suit its needs. The builder should also provide its own configuration support through additional fields or some other builder-appropriate mechanism. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-configuration-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Handle preview.js exports\": \"The [`preview.js`](../configure/index.mdx#configure-story-rendering) configuration file allows users to control how the story renders in the UI. This is provided via the [decorators](../writing-stories/decorators.mdx) named export. When Storybook starts, it converts these named exports into internal API calls via virtual module entry, for example, `addDecorator()`. The builder must also provide a similar implementation. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-preview-exports.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"MDX support\": \"[Storybook's Docs](../writing-docs/index.mdx) includes the ability to author stories/documentation in MDX using a Webpack loader. The builder must also know how to interpret MDX and invoke Storybook's special extensions. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-mdx.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Generate source code snippets\": \"Storybook annotates components and stories with additional metadata related to their inputs to automatically generate interactive controls and documentation. Currently, this is provided via Webpack loaders/plugins. The builder must re-implement this to support those features.\", \"Generate a static build\": \"One of Storybook's core features it's the ability to generate a static build that can be [published](../sharing/publish-storybook.mdx) to a web hosting service. The builder must also be able to provide a similar mechanism. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-build-server.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Development server integration\": \"By default, when Storybook starts in development mode, it relies on its internal development server. The builder needs to be able to integrate with it. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-dev-server.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Shutdown the development server\": \"The builder must provide a way to stop the development server once the process terminates; this can be via user input or error. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-builder-api-shutdown-server.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"HMR support\": \"While running in development mode, the builder's development server must be able to reload the page once a change happens, either in a story, component, or helper function.\", \"More information\": \"This area is under rapid development, and the associated documentation is still in progress and subject to change. If you are interested in creating a builder, you can learn more about implementing a builder in Storybook by checking the source code for [Vite](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-vite), [Webpack](https://github.com/storybookjs/storybook/tree/next/code/builders/builder-webpack5), or Modern Web's [dev-server-storybook](https://github.com/modernweb-dev/web/blob/master/packages/dev-server-storybook/src/serve/storybookPlugin.ts). When you're ready, open an [RFC](../contribute/RFC.mdx) to discuss your proposal with the Storybook community and maintainers.\\n\\n**Learn more about builders**\\n\\n['[Vite builder](./vite.mdx) for bundling with Vite', '[Webpack builder](./webpack.mdx) for bundling with Webpack', 'Builder API for building a Storybook builder']\"}}, \"metadata\": {\"title\": \"Builder API\", \"sidebar\": {\"order\": 3, \"title\": \"API\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"Builders\", \"description\": null, \"content\": {\"CLI basics\": \"Before diving into setting up Storybook's builders, let's look at how the CLI configures them. When you initialize Storybook (via `npx storybook@latest init`), the CLI automatically detects which builder to use based on your application. For example, if you're working with Vite, it will install the Vite builder. If you're working with Webpack, it installs the Webpack 5 builder by default.\\n\\nAdditionally, you can also provide a flag to Storybook's CLI and specify the builder you want to use:\\n\\n```\\nnpx storybook@latest init --builder <webpack5 | vite>\\n```\", \"Manual setup\": \"Storybook uses the Webpack 5 builder by default if you don't specify one. If you want to use a different builder in your application, these docs detail how you can set up Storybook's supported builders.\\n\\n['[**Vite builder**](./vite.mdx) for bundling your stories with Vite with near-instant HMR.', '[**Webpack**](./webpack.mdx) for bundling your stories with Webpack with improved performance', '[**Rspack / Rsbuild**](https://github.com/rspack-contrib/storybook-rsbuild) for bundling your stories with blazing fast Rspack and Rsbuild.']\"}, \"metadata\": {\"title\": \"Builders\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 9, \"title\": \"Builders\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"Vite\", \"description\": null, \"content\": {\"Setup\": \"If you ran `npx storybook@latest init` to include Storybook in your Vite application, the builder is already installed and configured for you. If you want, you can also opt into it manually.\\n\\nRun the following command to install the builder.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate your Storybook configuration (in `.storybook/main.js|ts`) to include the builder.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configuration\": {\"Environment-based configuration\": \"If you need to customize the builder's configuration and apply specific options based on your environment, extend the `viteFinal` function as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-vite-final-env.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Override the default configuration\": \"By default, the Vite builder in Storybook searches for the Vite configuration file in the root directory of your Storybook project. However, you can customize it to look for the configuration file in a different location. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-builder-custom-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nIf you do not want Storybook to load the Vite configuration file automatically, you can use the `viteConfigPath` option to point to a non-existent file.\\n</Callout>\", \"TypeScript\": \"If you need, you can also configure Storybook's Vite builder using TypeScript. Rename your `.storybook/main.js` to `.storybook/main.ts` and adjust it as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-ts-configure.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[]\"}, \"Troubleshooting\": {\"Migrating from Webpack\": \"Vite generally handles more use cases out of the box than Webpack. For example, loading styles just works for most projects. So, when migrating a Webpack-based project to Vite, you may find that you don't need all of your previous configuration.\\n\\nWe recommend starting with no Storybook-specific Vite configuration and only adding what you determine your project actually requires.\\n\\nFor reference, here is a Webpack configuration to handle loading graphql queries and its equivalent, using a plugin, in Vite:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"webpack-final-to-vite-final.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Working directory not being detected\": \"By default, the Vite builder enables Vite's [`server.fs.strict`](https://vitejs.dev/config/#server-fs-strict) option for increased security, defining the project's `root` to Storybook's configuration directory.\\nIf you need to override it, you can use the `viteFinal` function and adjust it.\", \"ArgTypes are not generated automatically\": \"Currently, [automatic argType inference](../api/arg-types.mdx#automatic-argtype-inference) is only available for React, Vue 3, and Svelte (JSDocs only). With React, the Vite builder defaults to `react-docgen`, a faster alternative to `react-docgen-typescript` for parsing React components. If you run into any issues, you can revert to `react-docgen-typescript` by updating your Storybook configuration file as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-react-docgen.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Interaction tests not working as expected\": \"If you are migrating from a Webpack-based project, such as [CRA](https://create-react-app.dev/), to Vite, and you are [interaction testing](../writing-tests/interaction-testing.mdx), you may run into a situation where your tests fail to execute notifying you that the `window` object is not defined. To resolve this issue, you can create a `preview-head.html` file in your Storybook configuration directory and include the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-vite-builder-jest-mock.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n**Learn more about builders**\\n\\n['Vite builder for bundling with Vite', '[Webpack builder](./webpack.mdx) for bundling with Webpack', '[Builder API](./builder-api.mdx) for building a Storybook builder']\"}}, \"metadata\": {\"title\": \"Vite\", \"sidebar\": {\"order\": 1, \"title\": \"Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}, {\"title\": \"Webpack\", \"description\": null, \"content\": {\"Configure\": {\"Override the default configuration\": {\"Working with Webpack plugins\": \"Another way to customize your Storybook configuration is to add a custom plugin or loader to help with code optimization, asset management, or other tasks. Nevertheless, since Storybook relies on the `HtmlWebpackPlugin` to generate the preview page, we recommend that you append the changes to the `config.plugins` array rather than overwriting it. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-simplified-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdditionally, when working with Webpack loaders that don't explicitly include specific file extensions (i.e., via the `test` property), you should `exclude` the `.ejs` file extension for that loader.\"}, \"Import a custom Webpack configuration\": \"If you already have an existing Webpack configuration file that you need to reuse with Storybook, you can import it and merge it into the default configuration. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-using-existing-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nProjects scaffolded based on generators may require that you import their specific Webpack configuration files. We suggest reading your generator's documentation for more information.\\n</Callout>\", \"Debug Webpack configuration\": \"If you intend to debug the Webpack configuration used by Storybook, you can use the Storybook CLI to help you. If you're running in [development mode](../api/cli-options.mdx#dev), you can use the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-debug-webpack-dev.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdditionally, if you're generating a [static build](../api/cli-options.mdx#build) of your Storybook, you can use the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-debug-webpack-prod.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Compiler support\": {\"SWC\": \"If your project is built using [SWC](https://swc.rs/), use the [`@storybook/addon-webpack5-compiler-swc`](https://storybook.js.org/addons/@storybook/addon-webpack5-compiler-swc) addon. This addon increases ecosystem compatibility with Webpack 5 projects while maintaining high performance. Run the following command to set up the addon automatically:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-compiler-swc-auto-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nAdditional options can be provided to customize the SWC configuration. See the [SWC API documentation](../api/main-config/main-config-swc.mdx) for more information.\\n</Callout>\\n\\nWhen enabled, this addon adjusts the Webpack configuration to use the [`swc-loader`](https://swc.rs/docs/usage/swc-loader) for JavaScript and TypeScript files. Additionally, it will detect and use your project's SWC configuration.\", \"Babel\": \"If you're working with a project that relies on Babel's tooling to provide support for specific features, including TypeScript or other modern JavaScript features, you can use the [`@storybook/addon-webpack5-compiler-babel`](https://storybook.js.org/addons/@storybook/addon-webpack5-compiler-babel) addon to allow you to include them in your Storybook to ensure compatibility with your project. Run the following command to set up the addon automatically:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-compiler-babel-auto-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nAdditional options can be provided to customize the Babel configuration. See the [`babel` API documentation](../api/main-config/main-config-babel.mdx) for more information, or if you're working on an addon, the [`babelDefault` documentation](../api/main-config/main-config-babel-default.mdx) for more information.\\n</Callout>\\n\\nWhen enabled, the addon will adjust the Webpack configuration to use the [`babel-loader`](https://webpack.js.org/loaders/babel-loader/) as the default loader for JavaScript and TypeScript files. Additionally, it will detect and use your project's Babel configuration.\"}, \"Troubleshooting\": {\"TypeScript modules are not resolved within Storybook\": \"Storybook's default Webpack configuration provides support for most project setups without the need for any additional configuration. Nevertheless, depending on your project configuration, or the framework of choice, you may run into issues with TypeScript modules not being resolved within Storybook when aliased from your [`tsconfig` file](https://www.typescriptlang.org/tsconfig). If you encounter this issue, you can use [`tsconfig-paths-webpack-plugin`](https://github.com/dividab/tsconfig-paths-webpack-plugin#tsconfig-paths-webpack-plugin) while [extending Storybook's Webpack config](#override-the-default-configuration) as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-ts-module-resolution.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nHowever, if you're working with a framework that provides a default aliasing configuration (e.g., Next.js, Nuxt) and you want to configure Storybook to use the same aliases, you may not need to install any additional packages. Instead, you can extend the default configuration of Storybook to use the same aliases provided by the framework. For example, to set up an alias for the `@` import path, you can add the following to your `.storybook/main.js|ts` file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-ts-module-resolution-atsign-import.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Pre-bundled assets do not show in the Storybook UI\": \"As Storybook relies on [esbuild](https://esbuild.github.io/) to build its internal manager, support for bundling assets with the `managerWebpack` will no longer have an impact on the Storybook UI. We recommend removing existing `managerWebpack` configuration elements from your Storybook configuration file and bundling assets other than images or CSS into JavaScript beforehand.\", \"Storybook doesn't run with Webpack 4\": \"Support for Webpack 4 has been removed and is no longer being maintained. If you're upgrading your Storybook, it will automatically use Webpack 5 and attempt to migrate your configuration. However, if you're working with a custom Webpack configuration, you may need to update it to work with Webpack 5. The migration process is necessary to ensure that your project runs smoothly with the latest version of Storybook. You can follow the instructions provided on the Webpack [website](https://webpack.js.org/migrate/5/) to update your configuration.\\n\\n**Learn more about builders**\\n\\n['[Vite builder](./vite.mdx) for bundling with Vite', 'Webpack builder for bundling with Webpack', '[Builder API](./builder-api.mdx) for building a Storybook builder']\"}}, \"metadata\": {\"title\": \"Webpack\", \"sidebar\": {\"order\": 2, \"title\": \"Webpack\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 5]\"}, {\"title\": \"Configure\", \"description\": \"Documentation section: configure\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/configure\"}, \"subpages\": [{\"title\": \"Environment variables\", \"description\": null, \"content\": {\"Using .env files\": {\"With Vite\": \"Out of the box, Storybook provides a [Vite builder](../builders/vite.mdx), which does not output Node.js globals like `process.env`. To access environment variables in Storybook (e.g., `STORYBOOK_`, `VITE_`), you can use `import.meta.env`. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-vite-env-variables.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<Callout variant=\\\"info\\\">\\nYou can also use specific files for specific modes. Add a `.env.development` or `.env.production` to apply different values to your environment variables.\\n</Callout>\\n\\nYou can also pass these environment variables when you are [building your Storybook](../sharing/publish-storybook.mdx) with `build-storybook`.\\n\\nThen they'll be hardcoded to the static version of your Storybook.\"}, \"Using Storybook configuration\": \"Additionally, you can extend your Storybook configuration file (i.e., [`.storybook/main.js|.ts`](../configure/index.mdx#configure-story-rendering)) and provide a configuration field that you can use to define specific variables (e.g., API URLs). For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-env.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen Storybook loads, it will enable you to access them in your stories similar as you would do if you were working with an `env` file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-env-var-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Using environment variables to choose the browser\": \"Storybook allows you to choose the browser you want to preview your stories. Either through a `.env` file entry or directly in your `storybook` script.\\n\\nThe table below lists the available options:\\n\\n| Browser | Example |\\n| -------- | -------------------- |\\n| Safari | `BROWSER=\\\"safari\\\"` |\\n| Firefox | `BROWSER=\\\"firefox\\\"` |\\n| Chromium | `BROWSER=\\\"chromium\\\"` |\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nBy default, Storybook will open a new Chrome window as part of its startup process. If you don't have Chrome installed, make sure to include one of the following options, or set your default browser accordingly.\\n</Callout>\", \"Troubleshooting\": {\"Environment variables are not working\": \"If you're trying to use framework-specific environment variables (e.g.,`VUE_APP_`), you may run into issues primarily due to the fact that Storybook and your framework may have specific configurations and may not be able to recognize and use those environment variables. If you run into a similar situation, you may need to adjust your framework configuration to make sure that it can recognize and use those environment variables. For example, if you're working with a Vite-based framework, you can extend the configuration file and enable the [`envPrefix`](https://vitejs.dev/config/shared-options.html#envprefix) option. Other frameworks may require a similar approach.\"}}, \"metadata\": {\"title\": \"Environment variables\", \"sidebar\": {\"order\": 8, \"title\": \"Environment variables\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\"}, {\"title\": \"Configure Storybook\", \"description\": null, \"content\": {\"Configure your Storybook project\": \"Storybook's main configuration (i.e., the `main.js|ts`) defines your Storybook project's behavior, including the location of your stories, the addons you use, feature flags and other project-specific settings. This file should be in the `.storybook` folder in your project's root directory. You can author this file in either JavaScript or [TypeScript](./integration/typescript.mdx). Listed below are the available options and examples of how to use them.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-typical.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThis configuration file is a [preset](../addons/addon-types.mdx) and, as such, has a powerful interface, which can be further customized. Read our documentation on writing [presets](../addons/writing-presets.mdx) to learn more.\\n</Callout>\\n\\n| Configuration element | Description |\\n| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `stories` | The array of globs that indicates the [location of your story files](#configure-story-loading), relative to `main.js` |\\n| `staticDirs` | Sets a list of directories of [static files](./integration/images-and-assets.mdx#serving-static-files-via-storybook-configuration) to be loaded by Storybook <br /> `staticDirs: ['../public']` |\\n| `addons` | Sets the list of [addons](https://storybook.js.org/integrations) loaded by Storybook <br /> `addons: ['@storybook/addon-docs']` |\\n| `typescript` | Configures how Storybook handles [TypeScript files](./integration/typescript.mdx) <br /> `typescript: { check: false, checkOptions: {} }` |\\n| `framework` | Configures Storybook based on a set of [framework-specific](./integration/frameworks.mdx) settings <br /> `framework: { name: '@storybook/svelte-vite', options:{} }` |\\n| `core` | Configures Storybook's [internal features](../api/main-config/main-config-core.mdx) <br /> `core: { disableTelemetry: true, }` |\\n| `docs` | Configures Storybook's [auto-generated documentation](../writing-docs/autodocs.mdx)<br /> `docs: { autodocs: 'tag' }` |\\n| `features` | Enables Storybook's [additional features](../api/main-config/main-config-features.mdx)<br /> See table below for a list of available features |\\n| `refs` | Configures [Storybook composition](../sharing/storybook-composition.mdx) <br /> `refs: { example: { title: 'ExampleStorybook', url:'https://your-url.com' } }` |\\n| `logLevel` | Configures Storybook's logs in the browser terminal. Useful for debugging <br /> `logLevel: 'debug'` |\\n| `webpackFinal` | Customize Storybook's [Webpack](../builders/webpack.mdx) setup <br /> `webpackFinal: async (config:any) => { return config; }` |\\n| `viteFinal` | Customize Storybook's Vite setup when using the [vite builder](https://github.com/storybookjs/builder-vite) <br /> `viteFinal: async (config: Vite.InlineConfig, options: Options) => { return config; }` |\\n| `env` | Defines custom Storybook [environment variables](./environment-variables.mdx#using-storybook-configuration). <br /> `env: (config) => ({...config, EXAMPLE_VAR: 'Example var' }),` |\\n| `build` | Optimizes Storybook's production [build](../api/main-config/main-config-build.mdx) for performance by excluding specific features from the bundle. Useful when decreased build times are a priority. <br /> `build: { test: {} }` |\", \"Configure story loading\": {\"With a configuration object\": \"Additionally, you can customize your Storybook configuration to load your stories based on a configuration object. For example, if you wanted to load your stories from a `packages/components` directory, you could adjust your `stories` configuration field into the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-stories-with-object.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen Storybook starts, it will look for any file containing the `stories` extension inside the `packages/components` directory and generate the titles for your stories.\", \"With a directory\": \"You can also simplify your Storybook configuration and load the stories using a directory. For example, if you want to load all the stories inside a `packages/MyStories`, you can adjust the configuration as such:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-storyloading-with-directory.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"With a custom implementation\": {\"Known limitations\": \"Because of the way stories are currently indexed in Storybook, loading stories on demand has a couple of minor limitations at the moment:\\n\\n['[CSF formats](../api/csf.mdx) from version 1 to version 3 are supported.', 'Custom `storySort` functions are allowed based on a restricted API.']\"}}, \"Configure story rendering\": \"To control the way stories are rendered and add global [decorators](../writing-stories/decorators.mdx#global-decorators) and [parameters](../writing-stories/parameters.mdx#global-parameters), create a `.storybook/preview.js` file. This is loaded in the Canvas UI, the \\u201cpreview\\u201d iframe that renders your components in isolation. Use `preview.js` for global code (such as [CSS imports](../get-started/setup.mdx#render-component-styles) or JavaScript mocks) that applies to all stories.\\n\\nThe `preview.js` file can be an ES module and export the following keys:\\n\\n['`decorators` - an array of global [decorators](../writing-stories/decorators.mdx#global-decorators)', '`parameters` - an object of global [parameters](../writing-stories/parameters.mdx#global-parameters)', '`globalTypes` - definition of [globalTypes](../essentials/toolbars-and-globals.mdx#global-types-and-the-toolbar-annotation)']\\n\\nIf you\\u2019re looking to change how to order your stories, read about [sorting stories](../writing-stories/naming-components-and-hierarchy.mdx#sorting-stories).\", \"Configure Storybook\\u2019s UI\": \"To control the behavior of Storybook\\u2019s UI (the **\\u201cmanager\\u201d**), you can create a `.storybook/manager.js` file.\\n\\nThis file does not have a specific API but is the place to set [UI options](./user-interface/features-and-behavior.mdx) and to configure Storybook\\u2019s [theme](./user-interface/theming.mdx).\"}, \"metadata\": {\"title\": \"Configure Storybook\", \"sidebar\": {\"order\": 8, \"title\": \"Configure\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\"}, {\"title\": \"Story layout\", \"description\": null, \"content\": {\"Global layout\": \"You can add the parameter to your [`./storybook/preview.js`](./index.mdx#configure-story-rendering), like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-layout-param.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\\n\\nIn the example above, Storybook will center all stories in the UI. `layout` accepts these options:\\n\\n['`centered`: center the component horizontally and vertically in the Canvas', '`fullscreen`: allow the component to expand to the full width and height of the Canvas', '`padded`: *(default)* Add extra padding around the component']\", \"Component layout\": \"You can also set it at a component level like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-component-layout-param.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Story layout\": \"Or even apply it to specific stories like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-story-layout-param.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Story layout\", \"sidebar\": {\"order\": 6, \"title\": \"Story layout\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\"}, {\"title\": \"Story rendering\", \"description\": null, \"content\": {\"Running code for every story\": \"Code executed in the preview file (`.storybook/preview.js|ts`) runs for every story in your Storybook. This is useful for setting up global styles, initializing libraries, or anything else required to render your components.\\n\\n<If notRenderer={['angular', 'vue']}>\\nHere's an example of how you might use the preview file to initialize a library that must run before your components render:\\n\\n```\\n// Replace your-framework with the framework you are using, e.g. react-vite, nextjs, vue3-vite, etc.\\nimport type { Preview } from '@storybook/your-framework';\\n\\nimport { initialize } from '../lib/your-library';\\n\\ninitialize();\\n\\nconst preview: Preview = {\\n // ...\\n};\\n\\nexport default preview;\\n```\\n\\n</If>\\n\\n<If renderer={['angular', 'vue']}>\\nFor example, with Vue, you can extend Storybook's application and register your library (e.g., [Fontawesome](https://github.com/FortAwesome/vue-fontawesome)). Or with Angular, add the package ([localize](https://angular.io/api/localize)) into your `polyfills.ts` and import it:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-with-library-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</If>\", \"Adding to \\\\<head>\": \"If you need to add extra elements to the `head` of the preview iframe, for instance, to load static stylesheets, font files, or similar, you can create a file called [`.storybook/preview-head.html`](./index.mdx#configure-story-rendering) and add tags like this:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-head-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nStorybook will inject these tags into the *preview iframe* where your components render, not the Storybook application UI.\\n</Callout>\\n\\nHowever, it's also possible to modify the preview head HTML programmatically using a preset defined in the `main.js` file. Read the [presets documentation](../addons/writing-presets.mdx#ui-configuration) for more information.\", \"Adding to \\\\<body>\": \"Sometimes, you may need to add different tags to the `<body>`. Helpful for adding some custom content roots.\\n\\nYou can accomplish this by creating a file called `preview-body.html` inside your `.storybook` directory and adding tags like this:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-body-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf using relative sizing in your project (like `rem` or `em`), you may update the base `font-size` by adding a `style` tag to `preview-body.html`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-body-font-size.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nStorybook will inject these tags into the *preview iframe* where your components render, not the Storybook application UI.\\n</Callout>\\n\\nJust like how you have the ability to customize the preview `head` HTML tag, you can also follow the same steps to customize the preview `body` with a preset. To obtain more information on how to do this, refer to the [presets documentation](../addons/writing-presets.mdx#ui-configuration).\"}, \"metadata\": {\"title\": \"Story rendering\", \"sidebar\": {\"order\": 5, \"title\": \"Story rendering\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\"}, {\"title\": \"Styling and CSS\", \"description\": null, \"content\": {\"CSS\": {\"Import bundled CSS (Recommended)\": \"All Storybooks are pre-configured to recognize imports for CSS files. To add global CSS for all your stories, import it in [`.storybook/preview.ts`](./index.mdx#configure-story-rendering). These files will be subject to HMR, so you can see your changes without restarting your Storybook server.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-import-global-styles.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf your component files import their CSS files, this will work too. However, if you're using CSS processor tools like Sass or Postcss, you may need some more configuration.\", \"Include static CSS\": \"If you have a global CSS file that you want to include in all your stories, you can import it in [`.storybook/preview-head.html`](./story-rendering.mdx#adding-to-head).\\nHowever, these files will not be subject to HMR, so you'll need to restart your Storybook server to see your changes.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-head-import-global-styles.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"CSS modules\": {\"Vite\": \"Vite comes with CSS modules support out-of-the-box. If you have customized the CSS modules configuration in your `vite.config.js` this will automatically be applied to your Storybook as well. Read more about [Vite's CSS modules support](https://vitejs.dev/guide/features.html#css-modules).\", \"Webpack\": \"<IfRenderer renderer=\\\"react\\\">\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udce3\\\" title=\\\"Using `@storybook/nextjs`?\\\">\\nStorybook recreates your Next.js configuration, so you can use CSS modules in your stories without any extra configuration.\\n</Callout>\\n</IfRenderer>\\n\\nIf you're using Webpack and want to use CSS modules, you'll need some extra configuration. We recommend installing [`@storybook/addon-styling-webpack`](https://storybook.js.org/addons/@storybook/addon-styling-webpack/) to help you configure these tools.\"}, \"PostCSS\": {\"Vite\": \"Vite comes with PostCSS support out-of-the-box. If you have customized the PostCSS configuration in your `vite.config.js` this will automatically be applied to your Storybook as well. Read more about [Vite's PostCSS support](https://vitejs.dev/guide/features.html#postcss).\", \"Webpack\": \"<IfRenderer renderer=\\\"react\\\">\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udce3\\\" title=\\\"Using `@storybook/nextjs`?\\\">\\nStorybook recreates your Next.js configuration, so you can use PostCSS in your stories without any extra configuration.\\n</Callout>\\n</IfRenderer>\\n\\nIf you're using Webpack and want to use PostCSS, you'll need some extra configuration. We recommend installing [`@storybook/addon-styling-webpack`](https://storybook.js.org/addons/@storybook/addon-styling-webpack/) to help you configure these tools.\"}, \"CSS pre-processors\": {\"Vite\": \"Vite comes with Sass, Less, and Stylus support out-of-the-box. Read more about [Vite's CSS Pre-processor support](https://vitejs.dev/guide/features.html#css-pre-processors).\", \"Webpack\": \"<IfRenderer renderer=\\\"react\\\">\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udce3\\\" title=\\\"Using `@storybook/nextjs`?\\\">\\nStorybook recreates your Next.js configuration, so you can use Sass in your stories without any extra configuration.\\n</Callout>\\n</IfRenderer>\\n\\nIf you're using Webpack and want to use Sass or less, you'll need some extra configuration. We recommend installing [`@storybook/addon-styling-webpack`](https://storybook.js.org/addons/@storybook/addon-styling-webpack/) to help you configure these tools. Or if you'd prefer, you can customize [Storybook's webpack configuration yourself](../builders/webpack.mdx#override-the-default-configuration) to include the appropriate loader(s).\"}, \"CSS-in-JS\": \"CSS-in-JS libraries are designed to use basic JavaScript, and they often work in Storybook without any extra configuration. Some libraries expect components to render in a specific rendering \\u201ccontext\\u201d (for example, to provide themes), which can be accomplished with `@storybook/addon-themes`'s [`withThemeFromJSXProvider` decorator](https://github.com/storybookjs/storybook/blob/next/code/addons/themes/docs/api.md#withthemefromjsxprovider).\", \"Adding webfonts\": {\"`.storybook/preview-head.html`\": \"If you need webfonts to be available, you may need to add some code to the [`.storybook/preview-head.html`](./story-rendering.mdx#adding-to-head) file. We recommend including any assets with your Storybook if possible, in which case you likely want to configure the [static file location](./integration/images-and-assets.mdx#serving-static-files-via-storybook-configuration).\", \"`.storybook/preview.ts`\": \"If you're using something like [`fontsource`](https://fontsource.org/) for your fonts, you can import the needed css files in your [`.storybook/preview.ts`](./index.mdx#configure-story-rendering) file.\\n</If>\\n\\n{/* Angular only */}\\n\\n<IfRenderer renderer=\\\"angular\\\">\\nStorybook for Angular relies on the Angular CLI to build your stories. This means that you can use any CSS preprocessor that the Angular CLI supports. You can read more about this in the [Angular CLI documentation](https://angular.io/guide/workspace-config#style-script-config).\"}, \"Global styles\": \"To add global styles to your Storybook, you can add them to the `styles` array in your `angular.json` file. This will add the styles to the preview iframe where your components render, not the Storybook Manager UI.\\n\\nDon't forget to also add your global styles to your `build-storybook` target in your `angular.json` file. This will ensure that your global styles are included in the static build of your Storybook as well.\\n\\n```\\n{\\n \\\"storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:start-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\".storybook\\\",\\n \\\"browserTarget\\\": \\\"angular-latest:build\\\",\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\\"-e\\\", \\\"json\\\", \\\"-d\\\", \\\".\\\"],\\n \\\"port\\\": 6006,\\n \\\"styles\\\": [\\n // Add your global styles here\\n \\\"@angular/material/prebuilt-themes/indigo-pink.css\\\",\\n \\\"@fontsource/roboto/300.css\\\",\\n \\\"@fontsource/roboto/400.css\\\",\\n \\\"@fontsource/roboto/500.css\\\",\\n \\\"@fontsource/roboto/700.css\\\",\\n \\\"@fontsource/material-icons\\\",\\n \\\"src/styles.scss\\\"\\n ]\\n }\\n },\\n \\\"build-storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:build-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\".storybook\\\",\\n \\\"browserTarget\\\": \\\"angular-latest:build\\\",\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\\"-e\\\", \\\"json\\\", \\\"-d\\\", \\\".\\\"],\\n \\\"styles\\\": [\\n // Add your global styles here\\n \\\"@angular/material/prebuilt-themes/indigo-pink.css\\\",\\n \\\"@fontsource/roboto/300.css\\\",\\n \\\"@fontsource/roboto/400.css\\\",\\n \\\"@fontsource/roboto/500.css\\\",\\n \\\"@fontsource/roboto/700.css\\\",\\n \\\"@fontsource/material-icons\\\",\\n \\\"src/styles.scss\\\"\\n ],\\n \\\"outputDir\\\": \\\"storybook-static\\\"\\n }\\n }\\n}\\n```\", \"Troubleshooting\": \"If you're working with Storybook and [Nx libraries](https://nx.dev/structure/library-types), you can extend your project's configuration (i.e., project.json) and provide the application's styles.\\n\\nFor earlier Nx versions (before 14.1.8), your configuration would look like this:\\n\\n```\\n{\\n \\\"build-storybook\\\": {\\n \\\"executor\\\": \\\"@nrwl/storybook:build\\\",\\n \\\"outputs\\\": [\\\"{options.outputPath}\\\"],\\n \\\"options\\\": {\\n \\\"uiFramework\\\": \\\"@storybook/angular\\\",\\n \\\"outputPath\\\": \\\"dist/storybook/example-lib\\\",\\n \\\"config\\\": {\\n \\\"configFolder\\\": \\\"libs/example-lib/storybook/.storybook\\\"\\n },\\n \\\"projectBuildConfig\\\": \\\"example-lib:build-storybook\\\",\\n \\\"styles\\\": [\\\"apps/example-app/src/styles.scss\\\"]\\n }\\n },\\n}\\n```\\n\\nStarting with version 14.1.8, Nx uses the Storybook builder directly, which means any configuration supplied to the builder also applies to the NX setup. If you're working with a library, you'll need to configure the styling options ( e.g., preprocessors) inside the `build-storybook` options configuration object. For example:\\n\\n```\\n{\\n \\\"storybook\\\": {\\n \\\"executor\\\": \\\"@storybook/angular:start-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\"apps/example-lib/.storybook\\\",\\n \\\"browserTarget\\\": \\\"example-lib:build-storybook\\\",\\n },\\n },\\n \\\"build-storybook\\\": {\\n \\\"executor\\\": \\\"@storybook/angular:build-storybook\\\",\\n \\\"outputs\\\": [\\\"{options.outputPath}\\\"],\\n \\\"options\\\": {\\n \\\"outputDir\\\": \\\"dist/storybook/example-lib\\\",\\n \\\"configDir\\\": \\\"apps/example-lib/.storybook\\\",\\n \\\"browserTarget\\\": \\\"example-lib:build-storybook\\\",\\n \\\"styles\\\": [\\\".storybook/custom-styles.scss\\\"],\\n \\\"stylePreprocessorOptions\\\": {\\n \\\"includePaths\\\": [\\n \\\"libs/design-system/src/lib\\\"\\n ]\\n }\\n }\\n },\\n}\\n```\\n\\nWhen Nx runs, it will load Storybook's configuration and styling based on [`storybook.browserTarget`](https://nx.dev/storybook/extra-topics-for-angular-projects#setting-up-browsertarget).\\n</IfRenderer>\"}, \"metadata\": {\"title\": \"Styling and CSS\", \"sidebar\": {\"order\": 1, \"title\": \"Styling and CSS\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\"}, {\"title\": \"Telemetry\", \"description\": null, \"content\": {\"Why is telemetry collected?\": \"Hundreds of thousands of developers use Storybook daily to build, test, and document components. Storybook is framework agnostic and integrates with the front-end ecosystem:\\n\\n['**JavaScript frameworks** such as [React](https://reactjs.org/), [Vue 3](https://vuejs.org/), [Svelte](https://svelte.dev/) and [Solid](https://www.solidjs.com/)', '**Libraries** such as [Styled-Components](https://styled-components.com/), [Tailwind](https://tailwindcss.com/), [Redux](https://redux.js.org/)', '**Design tools** such as [Figma](https://figma.com/), [Sketch](https://www.sketch.com/), [Zeplin](https://zeplin.io/) and [InVision](https://www.invisionapp.com/)', '**Workflow tools** such as [Notion](https://www.notion.so/product), [Confluence](https://www.atlassian.com/software/confluence), and [Jira](https://www.atlassian.com/software/jira)']\\n\\nIn the past, our improvement process relied on manually gathering feedback. But with a growing userbase and the need to support a wide variety of integrations, we need a more accurate method for gauging Storybook usage and pain points.\\n\\nThese telemetry data help us (the maintainers) to prioritize the highest impact projects. That allows us to keep up with trends in the front-end ecosystem and verify that our community's hard work achieves the intended result.\", \"What is being collected?\": \"We collect general usage details, including command invocation, Storybook version, addons, and the view layer.\\n\\nSpecifically, we track the following information in our telemetry events:\\n\\n['Timestamp of the occurrence.', 'Command invoked (e.g., `init`, `upgrade`, `dev`, `build`).', 'Storybook unique identifier: One-way hash generated during Storybook installation process.', 'One way hash of the IP address where the event occurred for spam detection.', 'Story count.', 'Storybook version.', 'Storybook metadata:', ['Language (e.g., TypeScript, JavaScript).', 'Supported view layers (e.g., React, Vue 3, Angular, Svelte).', 'Builder (e.g., Webpack5, Vite).', 'Meta framework (e.g., [Next](https://nextjs.org/), [Gatsby](https://www.gatsbyjs.com/), [CRA](https://create-react-app.dev/)).', '[Addons](https://storybook.js.org/integrations) (e.g., [Accessibility](https://storybook.js.org/addons/@storybook/addon-a11y/)).', 'Testing tools (e.g. [Jest](https://jestjs.io/), [Vitest](https://vitest.dev/), [Playwright](https://playwright.dev/)).'], 'Package manager information (e.g., `npm`, `yarn`).', 'Monorepo information (e.g., [NX](https://nx.dev/), [Turborepo](https://turborepo.org/)).', 'In-app events (e.g., [Storybook guided tour](https://github.com/storybookjs/addon-onboarding), [UI test run](../writing-tests/integrations/vitest-addon.mdx#storybook-ui)).']\\n\\nAccess to the raw data is highly controlled, limited to select members of Storybook's core team who maintain the telemetry. We cannot identify individual users from the dataset: it is anonymized and untraceable back to the user.\", \"What about sensitive information?\": \"We take your privacy and our security very seriously. We perform additional steps to ensure that secure data (e.g., environment variables or other forms of sensitive data) **do not** make their way into our analytics. You can view all the information we collect by setting the `STORYBOOK_TELEMETRY_DEBUG` to `1` to print out the information gathered. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-telemetry-preview-event.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWill generate the following output:\\n\\n```\\n{\\n \\\"anonymousId\\\": \\\"8bcfdfd5f9616a1923dd92adf89714331b2d18693c722e05152a47f8093392bb\\\",\\n \\\"eventType\\\": \\\"dev\\\",\\n \\\"payload\\\": {\\n \\\"versionStatus\\\": \\\"cached\\\",\\n \\\"storyIndex\\\": {\\n \\\"storyCount\\\": 0,\\n \\\"componentCount\\\": 0,\\n \\\"pageStoryCount\\\": 0,\\n \\\"playStoryCount\\\": 0,\\n \\\"autodocsCount\\\": 0,\\n \\\"mdxCount\\\": 0,\\n \\\"exampleStoryCount\\\": 8,\\n \\\"exampleDocsCount\\\": 3,\\n \\\"onboardingStoryCount\\\": 0,\\n \\\"onboardingDocsCount\\\": 0,\\n \\\"version\\\": 5\\n },\\n \\\"storyStats\\\": {\\n \\\"factory\\\": 0,\\n \\\"play\\\": 0,\\n \\\"render\\\": 1,\\n \\\"loaders\\\": 0,\\n \\\"beforeEach\\\": 0,\\n \\\"globals\\\": 0,\\n \\\"storyFn\\\": 5,\\n \\\"mount\\\": 0,\\n \\\"moduleMock\\\": 0,\\n \\\"tags\\\": 0\\n }\\n },\\n \\\"metadata\\\": {\\n \\\"generatedAt\\\": 1689007841223,\\n \\\"settingsCreatedAt\\\": 1689007841223,\\n \\\"hasCustomBabel\\\": false,\\n \\\"hasCustomWebpack\\\": false,\\n \\\"hasStaticDirs\\\": false,\\n \\\"hasStorybookEslint\\\": false,\\n \\\"refCount\\\": 0,\\n \\\"portableStoriesFileCount\\\": 0,\\n \\\"packageManager\\\": {\\n \\\"type\\\": \\\"yarn\\\",\\n \\\"version\\\": \\\"3.1.1\\\"\\n },\\n \\\"monorepo\\\": \\\"Nx\\\",\\n \\\"framework\\\": {\\n \\\"name\\\": \\\"@storybook/react-vite\\\",\\n \\\"options\\\": {}\\n },\\n \\\"builder\\\": \\\"@storybook/builder-vite\\\",\\n \\\"renderer\\\": \\\"@storybook/react\\\",\\n \\\"storybookVersion\\\": \\\"9.0.0\\\",\\n \\\"storybookVersionSpecifier\\\": \\\"^9.0.0\\\",\\n \\\"language\\\": \\\"typescript\\\",\\n \\\"storybookPackages\\\": {\\n \\\"@storybook/addon-docs/blocks\\\": {\\n \\\"version\\\": \\\"9.0.0\\\"\\n },\\n \\\"@storybook/react\\\": {\\n \\\"version\\\": \\\"9.0.0\\\"\\n },\\n \\\"@storybook/react-vite\\\": {\\n \\\"version\\\": \\\"9.0.0\\\"\\n },\\n \\\"storybook\\\": {\\n \\\"version\\\": \\\"9.0.0\\\"\\n }\\n },\\n \\\"addons\\\": {\\n \\\"@storybook/addon-onboarding\\\": {\\n \\\"version\\\": \\\"1.0.6\\\"\\n }\\n }\\n }\\n}\\n```\\n\\nAdditionally, if Storybook's guided tour is enabled, it will generate the following output:\\n\\n```\\n{\\n \\\"eventType\\\": \\\"addon-onboarding\\\",\\n \\\"payload\\\": {\\n \\\"step\\\": \\\"1:Welcome\\\",\\n \\\"addonVersion\\\": \\\"1.0.6\\\"\\n },\\n \\\"metadata\\\": {\\n // See above for metadata that's collected.\\n }\\n}\\n```\", \"Will this data be shared?\": \"The data we collect is anonymous, not traceable to the source, and only meaningful in aggregate form. No data we collect is personally identifiable.\\nIn the future, we plan to share relevant data with the community through public dashboards (or similar data representation formats).\", \"How to opt-out\": \"You may opt out of the telemetry within your Storybook configuration by setting the `disableTelemetry` configuration element to `true`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-disable-telemetry.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf necessary, you can also turn off telemetry via the command line with the `--disable-telemetry` flag.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-disable-telemetry-flag.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr via the `STORYBOOK_DISABLE_TELEMETRY` environment variable.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-disable-telemetry-env.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThere is a `boot` event containing no metadata (used to ensure the telemetry is working). It is sent prior to evaluating your [Storybook configuration file](../api/main-config/main-config.mdx) (i.e., `main.js|ts`), so it is unaffected by the `disableTelemetry` option. If you want to ensure that the event is not sent, use the `STORYBOOK_DISABLE_TELEMETRY` environment variable.\\n</Callout>\", \"Crash reports (disabled by default)\": \"In addition to general usage telemetry, you may also choose to share crash reports. Storybook will then sanitize the error object (removing all user paths) and append it to the telemetry event. To enable crash reporting, you can set the `enableCrashReports` configuration element to `true`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-telemetry-main-enable-crash-reports.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can also enable crash reporting via the command line with the `--enable-crash-reports` flag.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-telemetry-storybook-enable-crash-reports-flag.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr by setting the `STORYBOOK_ENABLE_CRASH_REPORTS` environment variable to `1`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-telemetry-storybook-enable-crash-reports-env.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nEnabling any of the options will generate the following item in the telemetry event:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-telemetry-crash-report-event.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Telemetry\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 3, \"title\": \"Telemetry\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 5]\"}, {\"title\": \"Webpack\", \"description\": null, \"content\": {\"Default configuration\": {\"Import images and other static files\": \"You can import images and other local files and have them built into the Storybook:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-import-static-asset.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Import JSON as JavaScript\": \"You can import `.json` files and have them expanded to a JavaScript object:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-import-json.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you want to know the exact details of the webpack config, the best way is to run either of the following:\\n\\n```\\n\\n## Development mode\\nyarn storybook dev --debug-webpack\\n\\n## Production mode\\nyarn storybook build --debug-webpack\\n```\\n\\nWhen you start your Storybook, you'll see an improvement in loading times. Read more about it in the [announcement post](https://storybook.js.org/blog/storybook-on-demand-architecture/) and the [configuration documentation](./index.mdx#on-demand-story-loading).\"}, \"Webpack 5\": {\"Lazy Compilation\": \"Storybook supports Webpack's experimental [lazy compilation](https://webpack.js.org/configuration/experiments/#experimentslazycompilation) feature, via the `lazyCompilation` builder flag:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-webpack5-lazyCompilation.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis feature applies in development mode, and will mean your Storybook will start up faster, at the cost of slightly slower browsing time when you change stories.\", \"Filesystem Caching\": \"Storybook supports Webpack's [filesystem caching](https://webpack.js.org/configuration/cache/#cachetype) feature, via the `fsCache` builder flag:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-webpack5-fsCache.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis feature will mean build output is cached between runs of Storybook, speeding up subsequent startup times.\"}, \"Extending Storybook\\u2019s webpack config\": \"To extend the above configuration, use the `webpackFinal` field of [`.storybook/main.js`](./index.mdx#configure-story-rendering).\\n\\nThe value should export a `function`, which will receive the default config as its first argument. The second argument is an options object from Storybook, and this will have information about where config came from, whether we're in production or development mode, etc.\\n\\nFor example, if you need to adjust the config for a specific environment, you can do so like this:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-webpack-final.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nStorybook uses the config returned from the above function to render your components in Storybook's \\\"preview\\\" iframe. Note that Storybook has an entirely separate webpack config for its UI (also referred to as the \\\"manager\\\"), so the customizations you make only apply to the rendering of your stories, i.e., you can completely replace `config.module.rules` if you want.\\n\\nNevertheless, edit `config` with care. Make sure to preserve the following config options:\\n\\n['**entry**', '**output**']\\n\\nFurthermore, `config` requires the `HtmlWebpackplugin` to generate the preview page, so rather than overwriting `config.plugins` you should probably append to it (or overwrite it with care), see [the following issue](https://github.com/storybookjs/storybook/issues/6020) for examples on how to handle this:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-simplified-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, if your custom webpack config uses a loader that does not explicitly include specific file extensions via the `test` property, in that case, it is necessary to `exclude` the `.ejs` file extension from that loader.\\n\\nIf you're using a non-standard Storybook config directory, you should put `main.js` there instead of `.storybook` and update the `include` path to ensure it resolves to your project root.\", \"Using your existing config\": \"Suppose you have an existing webpack config for your project and want to reuse this app's configuration. In that case, you can import your main webpack config into Storybook's [`.storybook/main.js`](./index.mdx#configure-story-rendering) and merge both:\\n\\nThe following code snippet shows how you can replace the loaders from Storybook with the ones from your app's `webpack.config.js`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-using-existing-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nProjects initialized via generators (e.g, Vue CLI) may require that you import their own webpack config file (i.e., <code>/projectRoot/node\\\\_modules/@vue/cli-service/webpack.config.js</code>) to use a certain feature with Storybook. For other generators, make sure to check the documentation for instructions.\\n</Callout>\", \"TypeScript Module Resolution\": \"When working with TypeScript projects, the default Webpack configuration may fail to resolve module aliases defined in your [`tsconfig` file](https://www.typescriptlang.org/tsconfig). To work around this issue you may use [`tsconfig-paths-webpack-plugin`](https://github.com/dividab/tsconfig-paths-webpack-plugin#tsconfig-paths-webpack-plugin) while [extending Storybook's Webpack config](#extending-storybooks-webpack-config) like:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-ts-module-resolution.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nLearn more about Storybook's <a href=\\\"./typescript\\\">built-in TypeScript support</a> or see <a href=\\\"https://github.com/storybookjs/storybook/issues/14087\\\">this issue</a> for more information.\\n</Callout>\"}, \"metadata\": {\"title\": \"Webpack\", \"draft\": true}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 6]\"}, {\"title\": \"Integration\", \"description\": \"Documentation section: integration\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/configure/integration\"}, \"subpages\": [{\"title\": \"Compiler support\", \"description\": null, \"content\": {\"SWC\": \"SWC is a fast, highly extensible tool for compiling and bundling modern JavaScript applications. Powered by [Rust](https://www.rust-lang.org/), it improves performance and reduces build times. Storybook includes a built-in integration with SWC, allowing zero-configuration setup and built-in types for APIs. If you've initialized Storybook in a Webpack-based project with any of the supported [frameworks](./frameworks.mdx), except Angular, Create React App, Ember.js and Next.js, it will automatically use SWC as its default, providing you with faster loading time.\\n\\n<Callout variant=\\\"info\\\">\\nSupport for the SWC builder is currently experimental for Next.js projects, and it's not enabled by default. It requires you to opt in to use it. For more information on configuring SWC with the supported frameworks, see the [SWC API](../../api/main-config/main-config-swc.mdx) documentation.\\n</Callout>\", \"Babel\": {\"Configure\": \"By default, Babel provides an opinionated [configuration](https://babeljs.io/docs/config-files) that works for most projects, relying on two distinct methods for configuring projects with the tool:\\n\\n[\\\"**Project-wide configuration**: Babel will look for a `babel.config.js` or equivalent file in the root of your project and use it to configure your project's Babel setup.\\\", '**File-relative configuration**: Babel will look for a `.babelrc.json` or equivalent file, introspecting the project structure until it finds a configuration file. This will allow you to configure Babel individually for multiple aspects of your project.']\\n\\nStorybook relies on an agnostic approach to configuring Babel, enabling you to provide the necessary configuration for your project, and it will use it. Based on the supported frameworks, builders, and addons, it may include minor adjustments to ensure compatibility with Storybook's features.\\n\\n<Callout variant=\\\"info\\\">\\nFor custom project configurations such as monorepos, where you have multiple Storybook configurations, creating a `.babelrc.json` file in your project's current working directory may not be sufficient. In those cases, you can create a `babel.config.js` file to override Babel's configuration, and Storybook will automatically detect and use it. See the Babel [documentation](https://babeljs.io/docs/config-files) for more information.\\n</Callout>\", \"Working with Create React App\": \"If you're working with a project that was initialized with [Create React App](https://create-react-app.dev/), Storybook will automatically detect and use the Babel configuration provided by the tool enabled via the `@storybook/preset-create-react-app` preset, allowing to use Storybook without any additional configuration.\"}, \"Troubleshooting\": {\"The SWC compiler doesn't work with React\": \"If you have enabled the SWC builder option in a React-based project and you are not explicitly importing React in your `jsx|tsx` files, it can cause Storybook to fail to load. SWC does not automatically import the `jsx-runtime` module when using the SWC builder. To resolve this issue, you need to adjust your Storybook configuration file (i.e., `.storybook/main.js|ts`) and configure the `swc` option as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-swc-jsx-transform.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\", \"Babel configuration not working\": \"Out of the box, Storybook can detect and apply any Babel configuration you provided in your project. However, if you're running into a situation where your configuration is not being used, you configure the [`BABEL_SHOW_CONFIG_FOR`](https://babeljs.io/docs/configuration#print-effective-configs) environment variable and set it to the file you want to inspect. For example:\\n\\n```\\nBABEL_SHOW_CONFIG_FOR=.storybook/preview.js yarn storybook\\n```\\n\\nWhen the command runs, it will output the Babel configuration applied to the file you specified despite showing a transpilation error in the console and preventing Storybook from loading. This is a known issue with Babel unrelated to Storybook, which you address by turning off the environment variable after inspecting the configuration and restarting Storybook.\"}}, \"metadata\": {\"title\": \"Compiler support\", \"sidebar\": {\"order\": 3, \"title\": \"Compilers\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"ESLint plugin\", \"description\": null, \"content\": {\"Installation\": \"You'll first need to install [ESLint](https://eslint.org/):\\n\\n<CodeSnippets path=\\\"eslint-install.md\\\" />\\n\\nNext, install `eslint-plugin-storybook`:\\n\\n<CodeSnippets path=\\\"eslint-plugin-storybook-install.md\\\" />\\n\\nThen add `plugin:storybook/recommended` to the extends section of your `.eslintrc` configuration file. Note that we can omit the `eslint-plugin-` prefix:\\n\\n```\\n{\\n // extend plugin:storybook/<configuration>, such as:\\n \\\"extends\\\": [\\\"plugin:storybook/recommended\\\"]\\n}\\n```\\n\\nAnd finally, add this to your `.eslintignore` file:\\n\\n```\\n!.storybook\\n```\\n\\nThis ensures that the plugin will also lint your configuration files inside the `.storybook` directory, so that you always have a correct configuration. For example, it can catch mistyped addon names in your `main.js|ts` file.\\n\\nFor more details on why this line is required in the `.eslintignore` file, refer to the [ESLint documentation](https://eslint.org/docs/latest/use/configure/ignore-deprecated#:~:text=In%20addition%20to,contents%20are%20ignored).\\n\\nIf you are using [flat config style](https://eslint.org/docs/latest/use/configure/configuration-files-new), add this to your configuration file:\\n\\n```\\nexport default [\\n // ...\\n {\\n // Inside your .eslintignore file\\n ignores: ['!.storybook'],\\n },\\n];\\n```\", \"ESLint compatibility\": \"Depending on the version of ESLint you are using, you may need to install a specific version of the Storybook plugin. Use the table below to match the plugin version to your ESLint version.\\n\\n| ESLint version | Storybook plugin version |\\n| -------------- | ------------------------ |\\n| `^9.0.0` | `^9.0.0` or `^0.10.0` |\\n| `^8.57.0` | `^9.0.0` or `^0.10.0` |\\n| `^7.0.0` | `~0.9.0` |\", \"Usage\": {\"Configuration (`.eslintrc`)\": {\"Overriding/disabling rules\": \"Optionally, you can override, add, or disable individual rules. You likely don't want these settings to be applied in every file, so make sure that you add a `overrides` section in your `.eslintrc.*` file that applies the overrides only to your stories files.\\n\\n```\\n{\\n \\\"overrides\\\": [\\n {\\n // \\ud83d\\udc47 This should match the `stories` property in .storybook/main.js|ts\\n \\\"files\\\": ['**/*.stories.@(ts|tsx|js|jsx|mjs|cjs)'],\\n \\\"rules\\\": {\\n // \\ud83d\\udc47 Enable this rule\\n 'storybook/csf-component': 'error',\\n // \\ud83d\\udc47 Disable this rule\\n 'storybook/default-exports': 'off',\\n }\\n }\\n ]\\n}\\n```\"}, \"Configuration (flat config format)\": {\"Overriding/disabling rules\": \"Optionally, you can override, add, or disable individual rules. You likely don't want these settings to be applied in every file, so make sure that you add a flat config section in your `eslint.config.js` file that applies the overrides only to your stories files.\\n\\n```\\nimport storybook from 'eslint-plugin-storybook';\\n\\nexport default [\\n // ...\\n\\n ...storybook.configs['flat/recommended'],\\n {\\n // \\ud83d\\udc47 This should match the `stories` property in .storybook/main.js|ts\\n files: ['**/*.stories.@(ts|tsx|js|jsx|mjs|cjs)'],\\n rules: {\\n // \\ud83d\\udc47 Enable this rule\\n 'storybook/csf-component': 'error',\\n // \\ud83d\\udc47 Disable this rule\\n 'storybook/default-exports': 'off',\\n },\\n },\\n\\n // ...\\n];\\n```\"}, \"MDX Support\": \"This plugin does not support MDX files.\"}, \"Supported Rules and configurations\": \"{/* RULES-LIST:START */}\\n\\n**Configurations**: csf, csf-strict, addon-interactions, recommended\\n\\n| Name | Description | Automatically fixable | Included in configurations |\\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------ |\\n| [`storybook/await-interactions`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/await-interactions.md) | Interactions should be awaited | \\u2705 | <ul><li>addon-interactions</li><li>flat/addon-interactions</li><li>recommended</li><li>flat/recommended</li></ul> |\\n| [`storybook/context-in-play-function`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/context-in-play-function.md) | Pass a context when invoking play function of another story | | <ul><li>recommended</li><li>flat/recommended</li><li>addon-interactions</li><li>flat/addon-interactions</li></ul> |\\n| [`storybook/csf-component`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/csf-component.md) | The component property should be set | | <ul><li>csf</li><li>flat/csf</li><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/default-exports`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/default-exports.md) | Story files should have a default export | \\u2705 | <ul><li>csf</li><li>flat/csf</li><li>recommended</li><li>flat/recommended</li><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/hierarchy-separator`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/hierarchy-separator.md) | Deprecated hierarchy separator in title property | \\u2705 | <ul><li>csf</li><li>flat/csf</li><li>recommended</li><li>flat/recommended</li><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/meta-inline-properties`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/meta-inline-properties.md) | Meta should only have inline properties | | N/A |\\n| [`storybook/meta-satisfies-type`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/meta-satisfies-type.md) | Meta should use `satisfies Meta` | \\u2705 | N/A |\\n| [`storybook/no-redundant-story-name`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/no-redundant-story-name.md) | A story should not have a redundant name property | \\u2705 | <ul><li>csf</li><li>flat/csf</li><li>recommended</li><li>flat/recommended</li><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/no-renderer-packages`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/no-renderer-packages.md) | Do not import renderer packages directly in stories | | <ul><li>recommended</li><li>flat/recommended</li></ul> |\\n| [`storybook/no-stories-of`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/no-stories-of.md) | storiesOf is deprecated and should not be used | | <ul><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/no-title-property-in-meta`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/no-title-property-in-meta.md) | Do not define a title in meta | \\u2705 | <ul><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/no-uninstalled-addons`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/no-uninstalled-addons.md) | This rule identifies storybook addons that are invalid because they are either not installed or contain a typo in their name. | | <ul><li>recommended</li><li>flat/recommended</li></ul> |\\n| [`storybook/prefer-pascal-case`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/prefer-pascal-case.md) | Stories should use PascalCase | \\u2705 | <ul><li>recommended</li><li>flat/recommended</li></ul> |\\n| [`storybook/story-exports`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/story-exports.md) | A story file must contain at least one story export | | <ul><li>recommended</li><li>flat/recommended</li><li>csf</li><li>flat/csf</li><li>csf-strict</li><li>flat/csf-strict</li></ul> |\\n| [`storybook/use-storybook-expect`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/use-storybook-expect.md) | Use expect from `@storybook/test`, `storybook/test` or `@storybook/jest` | \\u2705 | <ul><li>addon-interactions</li><li>flat/addon-interactions</li><li>recommended</li><li>flat/recommended</li></ul> |\\n| [`storybook/use-storybook-testing-library`](https://github.com/storybookjs/storybook/blob/next/code/lib/eslint-plugin/docs/rules/use-storybook-testing-library.md) | Do not use testing-library directly on stories | \\u2705 | <ul><li>addon-interactions</li><li>flat/addon-interactions</li><li>recommended</li><li>flat/recommended</li></ul> |\\n\\n{/* RULES-LIST:END */}\"}, \"metadata\": {\"title\": \"ESLint plugin\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"ESLint plugin\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"Feature support for frameworks\", \"description\": null, \"content\": {\"Core frameworks\": \"Core frameworks have dedicated maintainers or contributors who are responsible for maintaining the integration. As such, you can use most Storybook features in these frameworks.\\n\\n| | React | Vue 3 | Angular | Web Components |\\n| --------------------------------------------------------------------------------------------- | ----- | ----- | ------- | -------------- |\\n| **Essentials** | | | | |\\n| [Actions](../../essentials/actions.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Backgrounds](../../essentials/backgrounds.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Controls](../../essentials/controls.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Interactions](../../writing-tests/interaction-testing.mdx#debugging-interaction-tests) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Measure](../../essentials/measure-and-outline.mdx#measure-addon) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Outline](../../essentials/measure-and-outline.mdx#outline-addon) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Viewport](../../essentials/viewport.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| **Addons** | | | | |\\n| [A11y](../../writing-tests/accessibility-testing.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Docs](../../writing-docs/index.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Test runner](../../writing-tests/integrations/test-runner.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Test coverage](../../writing-tests/test-coverage.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [CSS resources](https://github.com/storybookjs/addon-cssresources) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Design assets](https://github.com/storybookjs/addon-design-assets) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Events](https://github.com/storybookjs/addon-events) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Google analytics](https://github.com/storybookjs/addon-google-analytics) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [GraphQL](https://github.com/storybookjs/addon-graphql) | \\u2705 | | \\u2705 | |\\n| [Jest](https://github.com/storybookjs/storybook/tree/next/code/addons/jest) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Links](https://github.com/storybookjs/storybook/tree/next/code/addons/links) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Queryparams](https://github.com/storybookjs/addon-queryparams) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| **Docs** | | | | |\\n| [CSF Stories](../../api/csf.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Autodocs](../../writing-docs/autodocs.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - ArgTypes](../../api/doc-blocks/doc-block-argtypes.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Canvas](../../api/doc-blocks/doc-block-canvas.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - ColorPalette](../../api/doc-blocks/doc-block-colorpalette.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Controls](../../api/doc-blocks/doc-block-controls.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Description](../../api/doc-blocks/doc-block-description.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - IconGallery](../../api/doc-blocks/doc-block-icongallery.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Markdown](../../api/doc-blocks/doc-block-markdown.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Meta](../../api/doc-blocks/doc-block-meta.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Primary](../../api/doc-blocks/doc-block-primary.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Source](../../api/doc-blocks/doc-block-source.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Story](../../api/doc-blocks/doc-block-story.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Stories](../../api/doc-blocks/doc-block-stories.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Subtitle](../../api/doc-blocks/doc-block-subtitle.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Title](../../api/doc-blocks/doc-block-title.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Typeset](../../api/doc-blocks/doc-block-typeset.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Unstyled](../../api/doc-blocks/doc-block-unstyled.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - UseOf](../../api/doc-blocks/doc-block-useof.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| Inline stories | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\", \"Community frameworks\": \"Community frameworks have fewer contributors which means they may not be as up to date as core frameworks. If you use one of these frameworks for your job, please consider contributing to its integration with Storybook.\\n\\n| | Ember | HTML | Svelte | Preact | Qwik | SolidJS |\\n| --------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | ---- | ------- |\\n| **Essentials** | | | | | | |\\n| [Actions](../../essentials/actions.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Backgrounds](../../essentials/backgrounds.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Controls](../../essentials/controls.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Interactions](../../writing-tests/interaction-testing.mdx#debugging-interaction-tests) | | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Measure](../../essentials/measure-and-outline.mdx#measure-addon) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Outline](../../essentials/measure-and-outline.mdx#outline-addon) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Viewport](../../essentials/viewport.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| **Addons** | | | | | | |\\n| [A11y](../../writing-tests/accessibility-testing.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Docs](../../writing-docs/index.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Test runner](../../writing-tests/integrations/test-runner.mdx) | | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Test coverage](../../writing-tests/test-coverage.mdx) | | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [CSS resources](https://github.com/storybookjs/addon-cssresources) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Design assets](https://github.com/storybookjs/addon-design-assets) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Events](https://github.com/storybookjs/addon-events) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Google analytics](https://github.com/storybookjs/addon-google-analytics) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [GraphQL](https://github.com/storybookjs/addon-graphql) | | | | | | |\\n| [Jest](https://github.com/storybookjs/storybook/tree/next/code/addons/jest) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Links](https://github.com/storybookjs/storybook/tree/next/code/addons/links) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Queryparams](https://github.com/storybookjs/addon-queryparams) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| **Docs** | | | | | | |\\n| [CSF Stories](../../api/csf.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Autodocs](../../writing-docs/autodocs.mdx) | | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - ArgTypes](../../api/doc-blocks/doc-block-argtypes.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Canvas](../../api/doc-blocks/doc-block-canvas.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - ColorPalette](../../api/doc-blocks/doc-block-colorpalette.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Controls](../../api/doc-blocks/doc-block-controls.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Description](../../api/doc-blocks/doc-block-description.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - IconGallery](../../api/doc-blocks/doc-block-icongallery.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Markdown](../../api/doc-blocks/doc-block-markdown.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Meta](../../api/doc-blocks/doc-block-meta.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Primary](../../api/doc-blocks/doc-block-primary.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Source](../../api/doc-blocks/doc-block-source.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Story](../../api/doc-blocks/doc-block-story.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Stories](../../api/doc-blocks/doc-block-stories.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Subtitle](../../api/doc-blocks/doc-block-subtitle.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Title](../../api/doc-blocks/doc-block-title.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Typeset](../../api/doc-blocks/doc-block-typeset.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - Unstyled](../../api/doc-blocks/doc-block-unstyled.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| [Doc Blocks - UseOf](../../api/doc-blocks/doc-block-useof.mdx) | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 |\\n| Inline stories | | \\u2705 | \\u2705 | | | |\", \"Deprecated\": \"To align the Storybook ecosystem with the current state of frontend development, the following features and addons are now deprecated, no longer maintained, and will be removed in future versions of Storybook\\n\\n| Feature | Status |\\n| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| [Knobs](https://github.com/storybookjs/addon-knobs) | The Knobs addon was officially deprecated with the release of Storybook 6.3 and is no longer actively maintained. We recommend using the [controls](../../essentials/controls.mdx) instead. |\\n| Storyshots | The Storyshots addon was officially deprecated with the release of Storybook 7.6, is no longer actively maintained and was removed in Storybook 8. See the [migration guide](../../../release-8-6/docs/writing-tests/snapshot-testing/storyshots-migration-guide.mdx) for the available alternatives. |\\n| StoriesOf | The `storiesOf` API was officially removed with the release of Storybook 8 and is no longer maintained. We recommend using the [CSF API](../../api/csf.mdx) instead for writing stories.<br />See the [migration guide](../../releases/migration-guide-from-older-version.mdx#major-breaking-changes) for more information. |\\n| Storysource | The Storysource addon was officially removed with the release of Storybook 9 and is no longer maintained. To display your stories' source code, we recommend using the [`codePanel`](../../writing-docs/code-panel.mdx) parameter instead. |\"}, \"metadata\": {\"title\": \"Feature support for frameworks\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 2, \"title\": \"Feature support for frameworks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"Framework support\", \"description\": null, \"content\": {\"How do frameworks work in Storybook?\": \"You start by [installing](../../get-started/install.mdx) Storybook into an existing project. Then, it tries to detect the framework you're using and automatically configures Storybook to work with it. That means adding the necessary libraries as dependencies and adjusting the configuration. Finally, starting Storybook will automatically load the framework configuration before loading any existing addons to match your application environment.\", \"Which frameworks are supported?\": {\"What about feature support?\": \"In addition to supporting the most popular frameworks in the industry, Storybook also tries to retain the same level of feature support for each framework, including the addon ecosystem. For more information, see [Framework support](./frameworks-feature-support.mdx) for a comprehensive list of which features and addons are currently maintained with the community's help.\"}, \"Configure\": \"Every modern web application has unique requirements and relies on various tools and frameworks. By default, with Storybook, you get an out-of-the-box configuration generated to work with most frameworks. However, you can extend your existing configuration file (i.e., `./storybook/main.js|ts|cjs`) and provide additional options. Below is an abridged table with available options and examples of configuring Storybook for your framework.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n| Option | Description | Framework |\\n| ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |\\n| `nextConfigPath` | Sets the default path for the NextJS configuration file<br />`framework: { name: '@storybook/nextjs', options: { nextConfigPath: '../next.config.js'} }` | NextJS |\\n| `builder` | Configures [Webpack 5](../../builders/webpack.mdx) builder options for NextJS<br /> `core: { builder: { name:'webpack5', options: { lazyCompilation: true} }}` | NextJS |\\n| `strictMode` | Enables React's [strict mode](https://reactjs.org/docs/strict-mode.html)<br />`framework: { name: '@storybook/react-webpack5', options: { strictMode: false } }` | React |\\n| `legacyRootApi` | Requires React 18. Toggles support for React's [legacy root API](https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html#updates-to-client-rendering-apis)<br />`framework: { name: '@storybook/react-webpack5', options: { legacyRootApi: true } }` | React |\\n| `enableIvy` | Enabled by default with Angular 9+. Replaces the default compiler with the [Ivy compiler](https://docs.angular.lat/guide/ivy)<br />`framework: { name: '@storybook/angular', options: { enableIvy: true } }` | Angular |\\n| `enableNgcc` | Enabled by default with Angular 9+. Adds support for ngcc for backwards compatibility<br />`framework: { name: '@storybook/angular', options: { enableNgcc: false } }` | Angular |\\n\\n[]\", \"Troubleshooting\": {\"NextJS 13 doesn't work with Storybook\": \"With the release of Next.js [version 13](https://nextjs.org/blog/next-13), it introduced breaking changes (e.g., [TurboPack](https://turbo.build/pack), [Server Components](https://nextjs.org/docs/advanced-features/react-18/server-components)) that are not yet fully supported by Storybook. The Storybook team is working on adding support for these features. In the meantime, you can still use Storybook alongside your Next.js 13 project if you're not relying on them.\", \"My framework doesn't work with Storybook\": \"Out of the box, most frameworks work seamlessly with Storybook. However, some frameworks (e.g., [CRACO](https://craco.js.org/)) provide their own configuration that Storybook isn't prepared to handle without additional steps, either [via addon](../../addons/writing-presets.mdx) or integration. To learn more, read our [addons guide](../../addons/index.mdx).\", \"How do I build a Storybook framework?\": \"Storybook is a framework-agnostic tool. It can be used with any framework. However, to make it easier for you to get started, we provide instructions that you can use to build your framework. To learn more, read our [frameworks guide](../../contribute/framework.mdx).\", \"Legacy framework support\": \"We're deprecating support for several frameworks, including [Aurelia](https://github.com/aurelia/framework), [Marionette](https://github.com/marionettejs/backbone.marionette), [Mithril](https://github.com/MithrilJS/mithril.js), [Rax](https://github.com/alibaba/rax), and [Riot](https://github.com/riot/riot). Nevertheless, we're always looking for help maintaining these frameworks. If you're working with one of them and you want to continue supporting them, visit the dedicated [Storybook End-of-Life repository](https://github.com/storybook-eol). To learn more about the sunsetting process and view instructions on how to contribute, read our [documentation](../../contribute/index.mdx).\", \"Learn about configuring Storybook\": [\"[Theming](../user-interface/theming.mdx) to customize the look and feel of Storybook's UI\", \"[CSS](../styling-and-css.mdx) to configure CSS support\", \"[Images & assets](./images-and-assets.mdx) for static asset handling\", \"[Environment variables](../environment-variables.mdx) to configure environment variables\"]}}, \"metadata\": {\"title\": \"Framework support\", \"sidebar\": {\"order\": 1, \"title\": \"Frameworks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"Images, fonts, and assets\", \"description\": null, \"content\": {\"Import assets into stories\": \"You can import any media assets by importing (or requiring) them. It works out of the box with our default config. But, if you are using a custom webpack config, you\\u2019ll need to add the [file loader](https://webpack.js.org/loaders/) to handle the required files.\\n\\nAfterward, you can use any asset in your stories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-static-asset-with-import.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Serving static files via Storybook Configuration\": \"We recommend serving static files via Storybook to ensure that your components always have the assets they need to load. We recommend this technique for assets that your components often use, like logos, fonts, and icons.\\n\\nConfigure a directory (or a list of directories) where your assets live when starting Storybook. Use the `staticDirs` configuration element in your main Storybook configuration file (i.e., `.storybook/main.js|ts`) to specify the directories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-static-dirs.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nHere `../public` is your static directory. Now use it in a component or story like this.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-static-asset-without-import.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can also pass a list of directories separated by commas without spaces instead of a single directory.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-static-dirs.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr even use a configuration object to define the directories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-static-dirs-with-object.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Reference assets from a CDN\": \"Upload your files to an online CDN and reference them. In this example, we\\u2019re using a placeholder image service.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-static-asset-cdn.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Absolute versus relative paths\": \"Sometimes, you may want to deploy your Storybook into a subpath, like `https://example.com/storybook`.\\n\\nIn this case, you need to have all your images and media files with relative paths. Otherwise, the browser cannot locate those files.\\n\\nIf you load static content via importing, this is automatic, and you do not have to do anything.\\n\\nSuppose you are serving assets in a [static directory](#serving-static-files-via-storybook-configuration) along with your Storybook. In that case, you need to use relative paths to load images or use the base element.\", \"Referencing Fonts in Stories\": \"After configuring Storybook to serve assets from your static folder, you can reference those assets in Storybook. For example, you can reference and apply a custom font to your stories. To do this, create a [`preview-head.html`](../story-rendering.mdx) file inside the configuration directory (i.e., `.storybook`) and add a `<link />` tag to reference your font.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-head-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Images, fonts, and assets\", \"sidebar\": {\"order\": 6, \"title\": \"Images and assets\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"Integration\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Integration\", \"sidebar\": {\"order\": 4, \"title\": \"Integration\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}, {\"title\": \"TypeScript\", \"description\": null, \"content\": {\"Configure Storybook with TypeScript\": {\"Extending the default configuration\": \"<IfRenderer renderer={['angular', 'vue', 'web-components', 'ember', 'html', 'svelte', 'preact', 'qwik', 'solid' ]}>\\nOut of the box, Storybook is built to work with a wide range of third-party libraries, enabling you to safely access and document metadata (e.g., props, inputs) from your components without any additional configuration. Since Storybook supports multiple frameworks, it also includes a set of third-party packages to support each framework (e.g., `ts-loader`, `vue-docgen-api` for Vue). If you need to customize the default configuration for a specific use case scenario, you can adjust your Storybook configuration file and provide the required options. Listed below are the available options and examples of how to use them.\\n\\n| Option | Description |\\n| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `check` | Available for Webpack-based projects.<br />Enables type checking within Storybook<br />`typescript: { check: true },` |\\n| `checkOptions` | Requires the `check` option to be enabled.<br />Configures the [`fork-ts-checker-webpack-plugin`](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin) plugin<br />`typescript: { checkOptions:{},},` |\\n| `skipCompiler` | Disables parsing Typescript files through the compiler<br />`typescript: { skipCompiler:false,},` |\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"react\\\">\\nOut of the box, Storybook is built to work with a wide range of third-party libraries, enabling you to safely access and document metadata (e.g., props) for your components without any additional configuration. It relies on [`react-docgen`](https://github.com/reactjs/react-docgen), a fast and highly customizable parser to process TypeScript files to infer the component's metadata and generate types automatically for improved performance and type safety. If you need to customize the default configuration for a specific use case scenario, you can adjust your Storybook configuration file and provide the required options. Listed below are the available options and examples of how to use them.\\n\\n| Option | Description |\\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `check` | Available for Webpack-based projects.<br />Enables type checking within Storybook<br />`typescript: { check: true },` |\\n| `checkOptions` | Requires the `check` option to be enabled.<br />Configures the [`fork-ts-checker-webpack-plugin`](https://github.com/TypeStrong/fork-ts-checker-webpack-plugin) plugin<br />`typescript: { checkOptions: {},},` |\\n| `reactDocgen` | Configures the TypeScript parser used by Storybook.<br />Available options: `react-docgen` (default), `react-docgen-typescript`,` false`<br /> `typescript: { reactDocgen: 'react-docgen'},` |\\n| `reactDocgenTypescriptOptions` | Requires the `reactDocgen`option to be `react-docgen-typescript`.<br /> Configures the `react-docgen-typescript-plugin` plugin per builder<br />`typescript: { reactDocgen: 'react-docgen-typescript', reactDocgenTypescriptOptions: {},},` |\\n| `skipCompiler` | Disables parsing Typescript files through the compiler<br />`typescript: { skipCompiler:false,},` |\\n</IfRenderer>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-extend-ts-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout>\\nAdditional options are available for the `typescript` configuration option. See the [`config.typescript` API reference](../../api/main-config/main-config-typescript.mdx) for more information.\\n</Callout>\"}, \"Write stories with TypeScript\": {\"TypeScript 4.9 support\": \"Assuming that you're working on a project that uses TypeScript 4.9+, you can update your component stories to use the new [`satisfies`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-9.html) operator to ensure stricter type checking for your component stories. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-baseline-with-satisfies.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow, when you define a story or update an existing one, you'll automatically get notified that you're missing a required [`arg`](../../writing-stories/args.mdx). However, you're not limited to using the `satisfies` operator at the component level. If you need, you can also use it at the story level. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-baseline-with-satisfies-story-level.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Troubleshooting\": {\"The `satisfies` operator is not working as expected\": \"Out of the box, Storybook supports the `satisfies` operator for almost every framework already using TypeScript version 4.9 or higher. However, due to the constraints of the Angular and Web Components framework, you might run into issues when applying this operator for additional type safety. This is primarily due to how both frameworks are currently implemented, making it almost impossible for Storybook to determine if the component property is required. If you encounter this issue, please open up a support request on [GitHub Discussions](https://github.com/storybookjs/storybook/discussions/new?category=help).\\n\\n<IfRenderer renderer={[ 'vue', 'svelte' ]}>\", \"The TypeScript auto-completion is not working on my editor\": \"If you're using Vue single file components and TypeScript, you can add the official [Vue](https://marketplace.visualstudio.com/items?itemName=Vue.volar) extension for editor support, additional type safety and auto-completion. Nevertheless, if you're working with Svelte, you can add the [Svelte for VSCode extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode) for similar benefits.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"Storybook doesn't create the required types for external packages\": \"If your project relies on a third-party library and the expected types are not being generated, preventing you from accurately documenting your components, you can adjust the `reactDocgen` configuration option in your Storybook configuration file to use `react-docgen-typescript` instead and include the required options. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-prop-filter.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"The types are not being generated for my component\": \"If you're working with a React project, type inference is automatically enabled for your components using the `react-docgen` library for improved build times and type safety. However, you may run into a situation where some options may not work as expected (e.g., [`Enums`](https://www.typescriptlang.org/docs/handbook/enums.html), React's [`forwardRef`](https://react.dev/reference/react/forwardRef)). This is primarily due to how the `react-docgen` package is implemented, making it difficult for Storybook to infer the component's metadata and generate types automatically. To solve this, you can update the `typescript` configuration option in your Storybook configuration file to use `react-docgen-typescript` instead. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-react-docgen-typescript.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)).\\n</IfRenderer>\"}}, \"metadata\": {\"title\": \"TypeScript\", \"sidebar\": {\"order\": 4, \"title\": \"Typescript\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\"}], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7]\"}, {\"title\": \"User Interface\", \"description\": \"Documentation section: user-interface\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/configure/user-interface\"}, \"subpages\": [{\"title\": \"Features and behavior\", \"description\": null, \"content\": {\"Customize the UI\": {\"Override sidebar visibility\": \"The sidebar, present on the left of the screen, contains the search function and navigation menu. Users may show or hide it with a keyboard shortcut. If you want to force the sidebar to be visible or hidden in certain places, you can define a `showSidebar` function in `layoutCustomisations`. Below are the available parameters passed to this function and an overview of how to use them.\\n\\n| Name | Type | Description | Example Value |\\n| ------------------------ | -------- | -------------------------------------------------------------- | ------------------------------------- |\\n| **path** | String | Path to the page being displayed | `'/story/components-button--default'` |\\n| **viewMode** | String | Whether the current page is a story or docs | `'docs'` or `'story'` |\\n| **singleStory** | Boolean | Whether the current page is the only story for a component | `true` or `false` |\\n| **storyId** | String | The id of the current story or docs page | `'blocks-blocks-unstyled--docs'` |\\n| **layout** | Object | The current layout state | *see below* |\\n| **layout.isFullscreen** | Boolean | Whether the preview canvas is in fullscreen mode | `true` or `false` |\\n| **layout.panelPosition** | String | Whether the panel is shown below or on the side of the preview | `'bottom'` or `'right'` |\\n| **layout.showNav** | Boolean | The setting for whether the end user wants to see the sidebar | `true` or `false` |\\n| **layout.showPanel** | Boolean | The setting for whether the end user wants to see the panel | `true` or `false` |\\n| **layout.showSidebar** | Boolean | The setting for whether the end user wants to see the sidebar | `true` or `false` |\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-sidebar-hide-on-landing.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"warning\\\">\\n\\nIf you're hiding the sidebar through `showSidebar`, ensure the displayed page provides an alternative means of navigation.\\n\\n</Callout>\", \"Configure the toolbar\": \"By default, Storybook displays a toolbar at the top of the UI, allowing you to access menus from addons (e.g., [viewport](../../essentials/viewport.mdx), [background](../../essentials/backgrounds.mdx)), or custom defined [menus](../../essentials/toolbars-and-globals.mdx#global-types-and-the-toolbar-annotation). However, if you want to customize the toolbar's behavior, you can use the `showToolbar` function. Listed below are the available options and an overview of how to use them.\\n\\n| Name | Type | Description | Example Value |\\n| ------------------------ | -------- | -------------------------------------------------------------- | ------------------------------------- |\\n| **path** | String | Path to the page being displayed | `'/story/components-button--default'` |\\n| **viewMode** | String | Whether the current page is a story or docs | `'docs'` or `'story'` |\\n| **singleStory** | Boolean | Whether the current page is the only story for a component | `true` or `false` |\\n| **storyId** | String | The id of the current story or docs page | `'blocks-blocks-unstyled--docs'` |\\n| **layout** | Object | The current layout state | *see below* |\\n| **layout.isFullscreen** | Boolean | Whether the preview canvas is in fullscreen mode | `true` or `false` |\\n| **layout.panelPosition** | String | Whether the panel is shown below or on the side of the preview | `'bottom'` or `'right'` |\\n| **layout.showNav** | Boolean | The setting for whether the end user wants to see the sidebar | `true` or `false` |\\n| **layout.showPanel** | Boolean | The setting for whether the end user wants to see the panel | `true` or `false` |\\n| **layout.showToolbar** | Boolean | The setting for whether the end user wants to see the toolbar | `true` or `false` |\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-toolbar-hide-on-docs.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Configuring through URL parameters\": \"You can use URL parameters to configure some of the available features:\\n\\n| Config option | Query param | Supported values |\\n| ------------------- | ------------ | ------------------------------ |\\n| **enableShortcuts** | `shortcuts` | `false` |\\n| --- (fullscreen) | `full` | `true`, `false` |\\n| --- (show sidebar) | `nav` | `true`, `false` |\\n| --- (show panel) | `panel` | `false`, `'right'`, `'bottom'` |\\n| **selectedPanel** | `addonPanel` | Any panel ID |\\n| **showTabs** | `tabs` | `true` |\\n| --- | `instrument` | `false`, `true` |\"}, \"metadata\": {\"title\": \"Features and behavior\", \"sidebar\": {\"order\": 1, \"title\": \"Features and behavior\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\"}, {\"title\": \"User Interface\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"User Interface\", \"sidebar\": {\"order\": 7, \"title\": \"User Interface\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\"}, {\"title\": \"Sidebar & URLS\", \"description\": null, \"content\": {\"Roots\": \"By default, Storybook will treat your top-level nodes as \\u201croots\\u201d. Roots are displayed in the UI as \\u201csections\\u201d of the hierarchy. Lower level groups will show up as folders:\\n\\n\\n\\nIf you\\u2019d prefer to show top-level nodes as folders rather than roots, you can set the `sidebar.showRoots` option to `false` in [`./storybook/manager.js`](./features-and-behavior.mdx):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-disable-roots.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Permalink to stories\": \"By default, Storybook generates an `id` for each story based on the component title and the story name. This `id` in particular is used in the URL for each story, and that URL can serve as a permalink (primarily when you [publish](../../sharing/publish-storybook.mdx) your Storybook).\\n\\nConsider the following story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"foo-bar-baz-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nStorybook's ID-generation logic will give this the `id` `foo-bar--baz`, so the link would be `?path=/story/foo-bar--baz`.\\n\\nIt is possible to manually set the story's id, which is helpful if you want to rename stories without breaking permalinks. Suppose you want to change the position in the hierarchy to `OtherFoo/Bar` and the story name to `Moo`. Here's how to do that:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"other-foo-bar-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nStorybook will prioritize the `id` over the title for ID generation if provided and prioritize the `story.name` over the export key for display.\", \"CSF 3.0 auto-titles\": {\"Auto-title filename case\": \"Starting with Storybook 6.5, story titles generated automatically no longer rely on Lodash's [startCase](https://lodash.com/docs/#startCase).\\nInstead, the file name casing is preserved, allowing additional control over the story title. For example, `components/My Component` will be defined as `components/MyComponent`.\\n\\nIf you need, you can revert to the previous pattern by adding the following configuration:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-render-label-stories.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Auto-title redundant filenames\": \"In addition to improvements to the story file name casing, a new heuristic was introduced, removing redundant names in case the filename has the same name as the directory name, or if it's called `index.stories.js|ts`. For example, before `components/MyComponent/MyComponent.stories.js` was defined as `Components/MyComponent/MyComponent` in the sidebar. Now it will be defined as `Components/MyComponent`.\\n\\nIf you need to preserve the naming scheme, you can add the `title` element to the default export. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-csf-3-auto-title-redundant.md\\\" usesCsf3 />\\n\\n{/* prettier-ignore-end */}\", \"Auto-title prefixes\": \"Additionally, if you customize your Storybook to load your stories based on a [configuration object](../index.mdx#with-a-configuration-object), including a `titlePrefix`, Storybook automatically prefixes all titles to matching stories. For example, assuming you have the following configuration:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-auto-title-custom.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen Storybook generates the titles for all matching stories, they'll retain the `Custom` prefix.\", \"Story Indexers\": \"[Story Indexers](../../api/main-config/main-config-indexers.mdx) are a set of heuristics used by Storybook to crawl your filesystem based on a given glob pattern searching for matching stories, which is then used to generate an `index.json` (formerly `stories.json`) file responsible for populating the sidebar with the necessary information. By default, this heuristic will look for files that contain the following scheme `*.stories.@(js|jsx|mjs|ts|tsx)`.\\n\\nYou can provide your own indexer to include stories with a different naming convention, adjust the automatic title generation beyond a prefix, and many other use cases. For more information, see the [Story Indexers API reference](../../api/main-config/main-config-indexers.mdx).\"}}, \"metadata\": {\"title\": \"Sidebar & URLS\", \"sidebar\": {\"order\": 3, \"title\": \"Sidebar & URLS\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\"}, {\"title\": \"Storybook Addons\", \"description\": null, \"content\": {\"Addon features\": \"The most obvious thing addons affect in Storybook is the UI of Storybook itself. Within the UI the **toolbar** and **addons panel** are the two chief places addons will appear.\\n\\n\\n\\nAddons can also hook into the rendering of your story in the preview pane via injecting their own [decorators](../../writing-stories/decorators.mdx).\\n\\nFinally, addons can affect the build setup of Storybook by injecting their own webpack configuration to allow the use of other tools in Storybook. Addons that do only this are often referred to as [presets](../../addons/addon-types.mdx).\", \"Essential, core and community addons\": \"There are many, many Storybook addons, but they can be roughly categorized into two areas:\\n\\n['**Core** addons are developed by the core team. They are kept in sync with the development of Storybook itself and written in idiomatic ways as templates for other addons. They can be found within the [Storybook monorepo](https://github.com/storybookjs/storybook/tree/next/code/addons).', '**Community** addons are addons written by the massive Storybook community. They can be found on our [website](https://storybook.js.org/addons/), [GitHub](https://github.com/), and [npm](https://www.npmjs.com/).']\"}, \"metadata\": {\"title\": \"Storybook Addons\", \"sidebar\": {\"order\": 4, \"title\": \"Storybook Addons\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\"}, {\"title\": \"Theming\", \"description\": null, \"content\": {\"Global theming\": \"It's possible to theme Storybook globally.\\n\\nStorybook includes two themes that look good out of the box: \\\"light\\\" and \\\"dark\\\". Unless you've set your preferred color scheme as dark, Storybook will use the light theme as default.\\n\\nAs an example, you can tell Storybook to use the \\\"dark\\\" theme by modifying [`.storybook/manager.js`](./features-and-behavior.mdx):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-dark-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen setting a theme, set a complete theme object. The theme is replaced, not combined.\", \"Theming docs\": \"[Storybook Docs](../../writing-docs/index.mdx) uses the same theme system as Storybook\\u2019s UI but is themed independently from the main UI.\\n\\nSupposing you have a Storybook theme defined for the main UI in [`.storybook/manager.js`](./features-and-behavior.mdx):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-dark-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nHere's how you'd specify the same theme for docs in [`.storybook/preview.js`](../index.mdx#configure-story-rendering):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-docs-dark-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nContinue to read if you want to learn how to create your theme.\", \"Create a theme quickstart\": \"The easiest way to customize Storybook is to generate a new theme using the `create()` function from `storybook/theming`. This function includes shorthands for the most common theme variables. Here's how to use it:\\n\\nInside your `.storybook` directory, create a new file called `YourTheme.js` and add the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-theme-example-variables.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nIf you're using `brandImage` to add your custom logo, you can use any of the most common image formats.\\n\\n</Callout>\\n\\nAbove, we're creating a new theme that will:\\n\\n[\\\"Use Storybook's `light` theme as a baseline.\\\", \\\"Replace Storybook's logo in the sidebar with our own (defined in the brandImage variable).\\\", 'Add custom branding information.', 'Set the brand link to open in the same window (as opposed to a new one), via the `target` attribute.']\\n\\nFinally, we'll need to import the theme into Storybook. Create a new file called `manager.js` in your `.storybook` directory and add the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-manager-custom-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow your custom theme will replace Storybook's default theme, and you'll see a similar set of changes in the UI.\\n\\n\\n\\nLet's take a look at a more complex example. Copy the code below and paste it in `.storybook/YourTheme.js`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"your-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAbove, we're updating the theme with the following changes:\\n\\n['A custom color palette (defined in the `app` and `color` variables).', 'Custom fonts (defined in the `font` and `text` variables).']\\n\\nWith the new changes introduced, the custom theme should yield a similar result.\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nMany theme variables are optional, the <code>base</code> property is **NOT**.\\n</Callout>\\n\\nThe `storybook/theming` module is built using TypeScript, which should help create a valid theme for TypeScript users. The types are part of the package itself.\", \"CSS escape hatches\": \"The Storybook theme API is narrow by design. If you want to have fine-grained control over the CSS, all UI and Docs components are tagged with class names to make this possible. **Use at your own risk** as this is an advanced feature.\\n\\nTo style these elements, insert style tags into:\\n\\n['For Storybook\\u2019s UI, use `.storybook/manager-head.html`', 'For Storybook Docs, use `.storybook/preview-head.html`']\\n\\n<Callout variant=\\\"warning\\\" title=\\\"Caution\\\">\\nThe same way as you can adjust your [preview\\u2019s head tag](../story-rendering.mdx#adding-to-head), Storybook allows you to modify the code on the manager's side, through `.storybook/manager-head.html`. It can be helpful when adding theme styles that target Storybook's HTML, but it comes with a cost as Storybook's inner HTML can change at any time through the release cycle.\\n</Callout>\", \"MDX component overrides\": \"If you're using MDX for docs, there's one more level of \\\"themability\\\". MDX allows you to completely override the rendered components from Markdown using a `components` parameter. It's an advanced usage that we don't officially support in Storybook, but it's a powerful construct if you need it.\\n\\nHere's how you might insert a custom code renderer for `code` blocks on the page, in [`.storybook/preview.js`](../index.mdx#configure-story-rendering):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-custom-code-renderer.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can even override a Storybook block component.\\n\\nHere's how you might insert a custom `<Canvas />` block:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-custom-canvas.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Addons and theme creation\": \"Some addons require specific theme variables that a Storybook user must add. If you share your theme with the community, make sure to support the official API and other popular addons, so your users have a consistent experience.\\n\\nFor example, the popular Actions feature uses [react-inspector](https://github.com/storybookjs/react-inspector/blob/master/src/styles/themes/chromeLight.tsx), which has themes of its own. Supply additional theme variables to style it like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-extended-theme-variables.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Using the theme for addon authors\": \"Reuse the theme variables above for a native Storybook developer experience. The theming engine relies on [emotion](https://emotion.sh/), a CSS-in-JS library.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-theming-styled-import.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUse the theme variables in object notation:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-styled-variables-object-notation.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr with template literals:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-styled-variables-template-literals.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Theming\", \"sidebar\": {\"order\": 2, \"title\": \"Theming\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 6]\"}, {\"title\": \"Contribute\", \"description\": \"Documentation section: contribute\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/contribute\"}, \"subpages\": [{\"title\": \"RFC process\", \"description\": null, \"content\": {\"Goal\": {\"\\u201cFeature Request\\u201d vs. \\u201cRFC\\u201d\": \"A *feature request* is a straightforward and relatively informal way for Storybook users to suggest a new feature or enhancement to the project. While feature requests can provide valuable insights and ideas, they typically do not involve an in-depth design process or require consensus among the core team. Feature requests are usually open to discussion and may or may not be implemented based on factors like popularity, feasibility, and alignment with the project's goals.\\n\\nOn the other hand, an *RFC* is a more formalized and structured process for proposing substantial changes or additions to the project. It involves following a defined set of steps to ensure that the proposed feature or modification receives proper consideration, design, and feedback. RFCs are typically used for changes that significantly impact the project, such as introducing new API functionality, removing existing features, or establishing new usage conventions. The RFC process aims to foster discussions, gather feedback from a wider audience, and reach consensus among the core team before integrating the proposed change into the project. Accepted RFCs are more likely to be implemented than regular feature requests.\"}, \"The RFC lifecycle\": {\"1. `Status: Proposed`\": \"Open a new GitHub discussion in the [\\u201cRFC\\u201d category](https://github.com/storybookjs/storybook/discussions/new?category=rfc). Fill out the form as instructed.\\n\\n*Details matter*: RFCs that do not present convincing motivation, demonstrate a lack of understanding of the design's impact, or are disingenuous about the drawbacks or alternatives tend to be poorly received.\", \"2. `Status: In review`\": \"RFCs tend to remain in this stage for a while, giving the community and core team members time to weigh in. During this period, the author of an RFC should be prepared to revise the proposal, integrate feedback, and build consensus. RFCs that have broad support are much more likely to make progress than those that don't receive any comments.\\n\\nEvery week, the Storybook core team conducts a triage meeting to review open RFCs as part of the meeting's agenda. The event is publicly scheduled in the [Storybook Discord](https://discord.gg/storybook) and held in the [Storybook Discord's Watercooler channel](https://discord.com/channels/486522875931656193/486522876388704260). We invite the RFC author(s) and interested members of the community to participate and engage in a more detailed discussion of the RFC. If a core team member deems it necessary, they will be assigned as the \\\"champion\\\" of the RFC. The champion will collaborate with the RFC author and assist them throughout the RFC process.\", \"3. `Status: accepted/rejected`\": \"Eventually, the team will decide whether the RFC is a candidate for inclusion in Storybook. On the other hand, an RFC may be rejected by the team after a public discussion has settled and comments have been made summarizing the rationale for rejection.\"}, \"Implementing an accepted RFC\": \"The author of an RFC is not obligated to implement it. Of course, the RFC author (like any other developer) is welcome to post an implementation for review after the RFC has been accepted. However, note that the \\u201caccepted\\u201d status does not indicate priority nor whether it\\u2019s being actively worked on.\\n\\nIf you are interested in implementing an \\\"active\\\" RFC, but cannot determine if someone else is already working on it, feel free to ask (e.g., by leaving a comment on the associated issue).\\n\\nThis RFC process took heavy inspiration from the RFC processes from [Rust](https://github.com/rust-lang/rfcs) and [Gatsby](https://www.gatsbyjs.com/contributing/rfc-process/).\\n\\n**Learn more about contributing to Storybook**\\n\\n['RFC process for authoring feature requests', '[Code](./code.mdx) for features and bug fixes', '[Frameworks](./framework.mdx) to get started with a new framework', '[Documentation](./documentation/documentation-updates.mdx) for documentation improvements, typos, and clarifications', '[Examples](./documentation/new-snippets.mdx) for new snippets']\"}, \"metadata\": {\"title\": \"RFC process\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 1, \"title\": \"RFC process\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"Code contributions\", \"description\": null, \"content\": {\"Prerequisites\": [\"Ensure you have Node version 18 installed (suggestion: v18.16.0).\", \"If you're working with Windows, all commands should be run in a terminal with administrator privileges.\"], \"Initial setup\": \"Start by [forking](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) the Storybook monorepo and cloning it locally.\\n\\n```\\ngit clone https://github.com/your-username/storybook.git\\ncd storybook\\n```\\n\\nStorybook uses the [Yarn](https://yarnpkg.com/) package manager. Use [Corepack](https://github.com/nodejs/corepack) to set up the correct version for use with Storybook.\\n\\n```\\ncorepack enable\\n```\", \"Run your first sandbox\": \"Storybook development happens in a set of *sandboxes* which are templated Storybook environments corresponding to different user setups. Within each sandbox, we inject a set of generalized stories that allow us to test core features and addons in all such environments.\\n\\nTo run a sandbox locally, you can use the `start` command:\\n\\n```\\nyarn start\\n```\\n\\nIt will install the required prerequisites, build the code, create and link a starter example based on a Vite React setup and finally start the Storybook server.\\n\\nIf all goes well, you should see the sandbox running.\\n\\n\", \"Running a different sandbox template\": \"By default, the `start` command is configured to initialize a Vite-based React template. If you're planning on working on a different renderer instead, you can do so as well. Start by running the `task` command as follows:\\n\\n```\\nyarn task\\n```\\n\\nWhen prompted, answer the questions as accurately as possible to allow Storybook to determine your goals. After answering these questions, you should see the entire command with the options you've selected should you require to re-run it.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nThe `yarn task` command takes a few development shortcuts that can catch you off guard when switching branches and may require you to re-run both the `install` and `compile` tasks. You can speed up the process by running the command with the `start-from=install` flag.\\n\\n</Callout>\", \"Running tests\": \"After successfully running your [first sandbox](#run-your-first-sandbox), you should have a fully functional Storybook version built on your local machine. Before jumping onto any code changes, verifying everything is working is essential\\u2014specifically, the test suite.\\n\\nRun the following command to execute the tests:\\n\\n```\\nyarn test\\n```\", \"Start developing\": \"Now that you've [verified your setup](#running-tests), it's time to jump into code. The simplest way is to run one of the sandboxes in one terminal window and the interactive build process in a separate terminal.\\n\\nAssuming you're still running the Vite-based React sandbox initialized after running the `yarn start` command, open a new terminal window and navigate to the `code` directory of the Storybook monorepo. Then, create a new branch for your contribution by running the following command:\\n\\n```\\ngit checkout -b my-first-storybook-contribution\\n```\\n\\nLastly, run the build process with the following:\\n\\n```\\nyarn build\\n```\\n\\nWhen prompted to start the build process in `watch` mode, answer **yes** to develop in interactive mode. Afterward, choose which packages you want to build. For example, if you're going to work on a feature for `@storybook/addon-docs`, you might want to select both `@storybook/addon-docs` and `storybook`.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nBuild's `watch` mode is great for interactive development. However, for performance reasons, it only transpiles your code and doesn't execute the TypeScript compiler. If something isn't working as expected, try running the `build` command **WITHOUT** enabling watch mode: it will re-generate TypeScript types and perform automatic type checking for you.\\n\\n</Callout>\\n\\n\\n\\nIf the work you'll be doing affects the `Preview` (the innermost Storybook `iframe`, where the stories are displayed), it will automatically refresh one to two seconds after you save.\\n\\nOtherwise, if it affects the `Manager` (the outermost Storybook `iframe` where the addons are displayed), you'll need to refresh manually after saving.\\n\\n\", \"Check your work\": {\"Add stories\": \"Adding a story or set of generic stories to our suite helps you test your work.\\n\\nAssuming you're working on one of the [essential features](../essentials/index.mdx), there's a chance that a complete set of stories already exists. Check the addon's `template/stories` directory that documents how it's supposed to work and add your stories there.\\n\\nIf you're modifying something related to a specific renderer (e.g., React, Vue 3, etc.), it will also have a similar `template/stories` directory in which you'll need to add your stories.\", \"Add tests\": \"Unit tests ensure that Storybook doesn't break accidentally. If your code can regress in non-obvious ways, include unit tests with your pull request. Use the following naming convention:\\n\\n```\\n+-- parentFolder\\n| +-- [filename].ts\\n| +-- [filename].test.ts\\n```\", \"End-to-end tests (e2e)\": \"Storybook's monorepo is set up to rely on end-to-end testing with [Playwright](https://playwright.dev) during CI. To help with testing, we encourage running this test suite before submitting your contribution.\\n\\nTo run an e2e test against a sandbox, you can use the `e2e-tests` task:\\n\\n```\\nyarn task --task e2e-tests --template=react-vite/default-ts --start-from=auto\\n```\\n\\nIf there are issues and you'd like to debug them, you can pass a `DEBUG=1` environment variable, and Playwright will run in watch mode.\\n\\n```\\nDEBUG=1 yarn task --task e2e-tests --template=react-vite/default-ts --start-from=auto\\n```\"}, \"Submit a pull request\": {\"Target `next` branch\": {\"Useful resources when working with forks\": [\"[Sync a fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks/syncing-a-fork)\", \"[Merge an upstream repository into your fork](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks/merging-an-upstream-repository-into-your-fork)\"]}, \"Reproducing job failures\": \"After creating your PR, if one of the CI jobs failed, when checking the logs of that job, you will see that it printed a message explaining how to reproduce the task locally. Typically that involves running the task against the right template:\\n\\n```\\nyarn task --task e2e-tests --template=react-vite/default-ts --start-from=install\\n```\\n\\nTypically it is a good idea to start from the `install` task to ensure your local code is completely up to date. If you reproduce the failure, you can try and make fixes, [compile them](#start-developing) with `build`, then rerun the task with `--start-from=auto`.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe default instructions run the code in \\\"linked\\\" mode, meaning built changes to Storybook library code will be reflected in the sandbox immediately (the next time you run the task). However, CI runs in \\\"unlinked\\\" mode, which in rare cases, will behave differently.\\n\\nIf you are having trouble reproducing, try rerunning the command with the `--no-link` flag. If you need to do that, you'll need to run it with `--start-from=compile` after each code change.\\n</Callout>\"}, \"How to work with reproductions\": \"We encourage bug reports to include reproductions. In the same way that it's possible to [develop interactively](#start-developing) against example projects in the monorepo, it's also possible to develop against a reproduction repository.\\n\\nTo do so, run the following command in the root of the monorepo:\\n\\n```\\nnpx storybook@next link https://github.com/your-username/your-project.git\\n```\\n\\nThis command creates a project `../storybook-repros/your-project`, and automatically links it to your local Storybook code. After connecting it, you should be able to run Storybook and develop as mentioned [above](#start-developing).\\n\\nIf you already have a reproduction on your local machine, you can similarly link it to your monorepo dev setup with the `--local` flag:\\n\\n```\\nnpx storybook@next link --local /path/to/local-repro-directory\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe `storybook link` command relies on [Yarn linking](https://yarnpkg.com/cli/link/) under the hood. It requires your local reproduction to be using [Yarn 2 or higher](https://yarnpkg.com/) as well, which is the case if you've already enabled it with the [`storybook sandbox`](./how-to-reproduce.mdx) command per our contribution guidelines. The process will fail if you're trying to link a non-Yarn 2 project.\\n</Callout>\", \"Developing a template\": {\"Running a sandbox\": \"If your template has a `inDevelopment` flag, it will be generated (locally) as part of the sandbox process. You can create the sandbox with the following command, where `<template-key>` is replaced by the id of the selected template e.g. `cra/default-js`:\\n\\n```\\nyarn task --task dev --template <template-key> --start-from=install\\n```\\n\\nTemplates with `inDevelopment` will automatically run with `--no-link` flag as it is required for the local template generation to work.\\n\\nOnce the PR is merged, the template will be generated on a nightly cadence and you can remove the `inDevelopment` flag and the sandbox will pull the code from our templates repository.\"}, \"Troubleshooting\": \"<details>\\n<summary><code>yarn build --all --watch</code> watches everything but is resource-intensive</summary>\\n\\nIt's troublesome to know which packages you'll change ahead of time, and watching them can be highly demanding, even on modern machines. If you're working on a powerful enough machine, you can use `yarn build --all --watch` instead of `yarn build`.\\n</details>\\n\\n**Learn more about contributing to Storybook**\\n\\n['[RFC process](./RFC.mdx) for authoring feature requests', 'Code for features and bug fixes', '[Frameworks](./framework.mdx) to get started with a new framework', '[Documentation](./documentation/documentation-updates.mdx) for documentation improvements, typos, and clarifications', '[Examples](./documentation/new-snippets.mdx) for new snippets']\"}, \"metadata\": {\"title\": \"Code contributions\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 2, \"title\": \"Code\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"Contributing a Storybook framework\", \"description\": null, \"content\": {\"How to make a framework\": {\"1. Decide on a package name\": \"The name should start with `storybook-framework-` and then correspond to what your framework supports. For example, a framework targeting SvelteKit would be `storybook-framework-svelte-kit` and a framework targeting Stencil with Vite would be `storybook-framework-stencil-vite`. When not targeting a metaframework, the naming convention is `storybook-framework-<renderer>-<builder>`.\", \"2. Consider what your framework will need to do\": \"The goal is to make Storybook behave\\u2014out-of-the-box\\u2014as similarly as possible to the metaframework or builder-renderer combination you\\u2019re targeting.\\n\\nFor metaframeworks, this means attempting to recreate any builder or babel configuration provided by the metaframework. You should try to do so in a way that respects the user's existing project configuration as much as possible.\\n\\nThe library or libraries your framework supports may have different major versions available. Consider which versions of each library your framework will support. You will need to account for the changes within those different versions or split your framework into different versions/packages itself to support each library version. To speed up maintenance, please consider adding integration tests for the various library versions your framework supports.\", \"3. Write the documentation\": \"Before writing any code, write a helpful README that contains installation instructions and a list of available features. Use the [README for `@storybook/nextjs`](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/README.md) as a template. Writing the documentation first helps guide your other work.\", \"4. Author the framework itself\": {\"`package.json` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/package.json))\": \"Because a framework is a node package, it must contain a `package.json` file. Here\\u2019s a template you can use to start:\\n\\n<details>\\n<summary><code>package.json</code> template</summary>\\n\\n```\\n{\\n \\\"name\\\": \\\"<your-framework-name>\\\",\\n \\\"version\\\": \\\"1.0.0\\\",\\n \\\"description\\\": \\\"Storybook for <meta-framework-name> or <renderer> & <builder>\\\",\\n \\\"keywords\\\": [\\n \\\"Storybook\\\",\\n \\\"<meta-framework-name>\\\",\\n \\\"<renderer>\\\",\\n \\\"<builder>\\\",\\n \\\"<anything>\\\",\\n \\\"<else>\\\",\\n \\\"<relevant>\\\"\\n ],\\n \\\"homepage\\\": \\\"<your package's homepage>\\\",\\n \\\"bugs\\\": {\\n \\\"url\\\": \\\"https://github.com/<your-org>/<your-repo>/issues\\\"\\n },\\n \\\"repository\\\": {\\n \\\"type\\\": \\\"git\\\",\\n \\\"url\\\": \\\"https://github.com/<your-org>/<your-repo>.git\\\",\\n \\\"directory\\\": \\\"<path/to/your/framework>\\\"\\n },\\n \\\"license\\\": \\\"MIT\\\",\\n \\\"exports\\\": {\\n \\\".\\\": {\\n \\\"types\\\": \\\"./dist/index.d.ts\\\",\\n \\\"require\\\": \\\"./dist/index.js\\\",\\n \\\"import\\\": \\\"./dist/index.mjs\\\"\\n },\\n \\\"./preset\\\": {\\n \\\"types\\\": \\\"./dist/preset.d.ts\\\",\\n \\\"require\\\": \\\"./dist/preset.js\\\",\\n \\\"import\\\": \\\"./dist/preset.mjs\\\"\\n },\\n \\\"./preview.js\\\": {\\n \\\"types\\\": \\\"./dist/preview.d.ts\\\",\\n \\\"require\\\": \\\"./dist/preview.js\\\",\\n \\\"import\\\": \\\"./dist/preview.mjs\\\"\\n },\\n \\\"./package.json\\\": \\\"./package.json\\\"\\n },\\n \\\"main\\\": \\\"dist/index.js\\\",\\n \\\"module\\\": \\\"dist/index.mjs\\\",\\n \\\"types\\\": \\\"dist/index.d.ts\\\",\\n \\\"files\\\": [\\\"dist/**/*\\\", \\\"types/**/*\\\", \\\"README.md\\\", \\\"*.js\\\", \\\"*.d.ts\\\"],\\n \\\"scripts\\\": {\\n \\\"check\\\": \\\"tsc --noEmit\\\",\\n \\\"test\\\": \\\"...\\\"\\n },\\n \\\"dependencies\\\": {\\n \\\"storybook\\\": \\\"^9.0.0\\\",\\n \\\"@storybook/<builder>\\\": \\\"^9.0.0\\\",\\n \\\"@storybook/<renderer>\\\": \\\"^9.0.0\\\"\\n },\\n \\\"devDependencies\\\": {\\n \\\"typescript\\\": \\\"x.x.x\\\",\\n \\\"<meta-framework>\\\": \\\"^x.x.x\\\",\\n \\\"<builder>\\\": \\\"^x.x.x\\\"\\n },\\n \\\"peerDependencies\\\": {\\n \\\"<meta-framework>\\\": \\\"^x.x.x || ^x.x.x\\\",\\n \\\"<renderer>\\\": \\\"^x.x.x || ^x.x.x\\\",\\n \\\"<builder>\\\": \\\"^x.x.x\\\"\\n },\\n \\\"engines\\\": {\\n \\\"node\\\": \\\">=20.0.0\\\"\\n },\\n \\\"publishConfig\\\": {\\n \\\"access\\\": \\\"public\\\"\\n }\\n}\\n```\\n\\nA few notes on some of those properties:\\n\\n['`exports`: The root, `./preset`, and `package.json` exports are required. If your framework has a `preview.js`, then that is required as well.', '`types`: We strongly encourage you to author your framework in TypeScript and distribute the types.', '`dependencies` and `devDependencies`: These are just examples. Yours may look quite different.', '`peerDependencies`: If your framework provides support for multiple versions of the libraries you\\u2019re targeting, be sure that is represented here.\\\\n</details>']\", \"`preset.js` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/preset.ts))\": \"The [preset API](../addons/writing-presets.mdx) is where you will configure the Storybook core (which builder and renderer are used by your framework), the builder (via either the [`webpackFinal`](../builders/webpack.mdx#override-the-default-configuration) or [`viteFinal`](../builders/vite.mdx#configuration) export), babel (via the `babel` export), any necessary addons, and any available options for your framework.\", \"`preview.js` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/preview.tsx))\": \"The (optional) [preview API](../configure/index.mdx#configure-story-rendering) is where you configure the rendering of stories, such as global decorators or initializing some runtime config needed for your framework to behave as expected. If your framework requires this file, note that you also need to [configure the `previewAnnotations` in `preset.js`](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/preset.ts#L71-L74).\", \"`types.ts` ([example](https://github.com/storybookjs/storybook/blob/next/code/frameworks/nextjs/src/types.ts))\": \"If you author your framework in TypeScript (recommended), you should export the type for `StorybookConfig` which reflects the available options of your framework.\"}, \"5. Test your framework\": \"Test it in a fresh project using a Storybook set up as close as possible to your framework. For example, for `@storybook/nextjs`, which uses React and Webpack5, start with a project that uses `@storybook/react` and `@storybook/builder-webpack5`. Follow the installation instructions from your README and ensure everything works as expected. Remember to test the various versions, configs, and options for the libraries you\\u2019re supporting.\", \"6. Let us know!\": \"Once it's fully tested and released, please let us know about your framework by either announcing it in the [`#showcase`](https://discord.com/channels/486522875931656193/1048740936953376859) Discord channel or tweeting it and mentioning `@storybookjs`. It's our hope that well-made community frameworks can eventually move into the Storybook codebase and be considered \\\"officially\\\" supported.\\n\\n**Learn more about contributing to Storybook**\\n\\n['[RFC process](./RFC.mdx) for authoring feature requests', '[Code](./code.mdx) for features and bug fixes', 'Frameworks to get started with a new framework', '[Documentation](./documentation/documentation-updates.mdx) for documentation improvements, typos, and clarifications', '[Examples](./documentation/new-snippets.mdx) for new snippets']\"}}, \"metadata\": {\"title\": \"Contributing a Storybook framework\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 4, \"title\": \"Frameworks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"Create a reproduction\", \"description\": null, \"content\": {\"Why should you create a reproduction?\": \"A reproducible test case is a great way to share a specific set of conditions that causes a bug. It allows both the maintainers and the community to verify, narrow down the cause of the problem and help you fix the issue.\", \"Pre-requisites\": \"Make sure you have:\\n\\n['Installed [`Yarn`](https://yarnpkg.com/) on your local development machine.', \\\"A [GitHub account](https://github.com/signup) for hosting the reproduction's code.\\\", 'A [Chromatic account](https://www.chromatic.com/start/?utm_source=storybook_website\\\\\\\\&utm_medium=link\\\\\\\\&utm_campaign=storybook) for publishing your Storybook.']\", \"Initial setup\": \"First, open a terminal and run the following command:\\n\\n```\\nnpx storybook@next sandbox\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nYou can append a template name in the command to get filtered results (e.g., `npx storybook@next sandbox react`).\\n</Callout>\\n\\nNext, choose the template you want to work with:\\n\\n\\n\\nFinally, enter a location for your reproduction:\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nIf you don't provide a full path for the reproduction it will be generated in the current directory.\\n</Callout>\\n\\nIf everything worked as it should, you should have a fully functional Storybook set up in your local environment.\", \"Third-party dependencies & addons\": \"Before adding code, install and configure any necessary packages. For example, if you run into a problem with a CSS framework (e.g., [Tailwind](https://tailwindcss.com/)), you should install and configure it.\\n\\nInstall and configure any Storybook [addons](https://storybook.js.org/addons/) that relate to the issue (e.g.,`@storybook/addon-a11y`).\", \"Add stories\": \"Any Storybook reproduction wouldn't be complete without [stories](../writing-stories/index.mdx). To help fix your issue faster, we encourage you to include the minimum amount of stories that will replicate your issue.\", \"Host\": \"When you've finished your work, you'll need to host your reproduction. Start by signing into GitHub.com and create a [new repository](https://github.com/new).\\n\\n\\n\\nThen, follow GitHub's instructions to set up the repository.\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nDon't forget to replace `your-username` with your own account name.\\n</Callout>\", \"Publish\": {\"Helpful resources when working with Chromatic\": [\"[Publish Storybook](../sharing/publish-storybook.mdx)\", \"[Setup Chromatic](https://www.chromatic.com/docs/setup?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook)\", \"[Automate Chromatic with continuous integration](https://www.chromatic.com/docs/ci?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook)\"]}, \"Submit the issue\": \"Finally, create your issue in the [Storybook issue tracker](https://github.com/storybookjs/storybook/issues/new/choose), go through the required steps, and provide a detailed description of the problem. Add the GitHub repository and [deployed reproduction](https://www.chromatic.com/docs/setup?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook#view-published-storybook) to help with the triage process.\"}, \"metadata\": {\"title\": \"Create a reproduction\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"Reproduce\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"How to contribute\", \"description\": null, \"content\": {\"Contributor covenant\": \"In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. [Continue reading our contributor covenant \\u00bb](https://github.com/storybookjs/storybook/blob/next/CODE_OF_CONDUCT.md)\", \"Ways to contribute\": [\"[**RFC process**](./RFC.mdx) for authoring feature requests\", \"[**Code**](./code.mdx) for features and bug fixes\", \"[**Frameworks**](./framework.mdx) to get started with a new framework\", \"[**Documentation**](./documentation/documentation-updates.mdx) for documentation improvements, typos, and clarifications\", \"[**Examples**](./documentation/new-snippets.mdx) for new snippets and examples\", \"[**Addons**](../addons/index.mdx) for new addons\"], \"Not sure how to get started?\": [\"[Chat in Discord `#contributing`](https://discord.com/channels/486522875931656193/839297503446695956)\", \"[Browse \\\"good first issues\\\" to fix](https://github.com/storybookjs/storybook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)\", \"[Submit a bug report or feature request](https://github.com/storybookjs/storybook/issues)\"]}, \"metadata\": {\"title\": \"How to contribute\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 12, \"title\": \"Contribute\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"Documentation\", \"description\": \"Documentation section: documentation\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/contribute/documentation\"}, \"subpages\": [{\"title\": \"Documentation updates\", \"description\": null, \"content\": {\"Find the Markdown file\": \"Scroll to the bottom of the document in question, then click \\u270d\\ufe0f Edit on GitHub \\u2013 PRs welcome! This will open the Markdown file on GitHub.\\n\\n\\n\\nUse GitHub's web editor by clicking the pencil icon on the right-hand corner. Tweak the document to your liking.\\n\\n\\n\\nScroll down to the bottom of the document page on GitHub and describe what you changed and why. Select the `Create a new branch for this commit and start a pull request` option then click the `Propose changes` button.\\n\\n\", \"Create the pull request\": \"In the Storybook repository, create a pull request that describes changes and includes additional context that would help maintainers review. Once you submit the PR, a maintainer will guide you through the triage and merge process.\\n\\n**Learn more about contributing to Storybook**\\n\\n['[RFC process](../RFC.mdx) for authoring feature requests', '[Code](../code.mdx) for features and bug fixes', '[Frameworks](../framework.mdx) to get started with a new framework', 'Documentation for documentation improvements, typos, and clarifications', '[Examples](./new-snippets.mdx) for new snippets']\"}, \"metadata\": {\"title\": \"Documentation updates\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 1, \"title\": \"Content\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"Documentation\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Documentation\", \"sidebar\": {\"order\": 3, \"title\": \"Documentation\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"Code snippets contributions\", \"description\": null, \"content\": {\"Documented frameworks\": \"Storybook maintains code snippets for a [variety of frameworks](../../configure/integration/frameworks-feature-support.mdx). We try to keep them up to date as framework APIs evolve. But keeping track of every API change in every framework is tricky.\\n\\nWe welcome community contributions to the code snippets. Here's a matrix of the frameworks for which we have snippets. Help us add snippets for your favorite framework.\\n\\n| React | Vue 3 | Angular | Web Components | Svelte | Solid | Ember | HTML | Preact | Qwik |\\n| ------ | ----- | --------- | ---------------|--------|--------|-------|------| -------|------|\\n| \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u2705 | \\u274c | \\u274c | \\u274c | \\u274c |\", \"Snippet syntax\": {\"Example\": \"The following code block demonstrates how to structure a code snippet in the Storybook documentation and the attributes you can use to provide additional context to the code snippet.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"ButtonGroup.stories.ts\\\" renderer=\\\"vue\\\" language=\\\"ts\\\" tabTitle=\\\"3\\\"\\nimport type { Meta, StoryObj } from '@storybook/vue3-vite';\\n\\nimport ButtonGroup from './ButtonGroup.vue';\\n\\n//\\ud83d\\udc47 Imports the Button stories\\nimport * as ButtonStories from './Button.stories';\\n\\nconst meta = {\\n component: ButtonGroup,\\n}} satisfies Meta<typeof ButtonGroup>;\\n\\nexport default meta;\\ntype Story = StoryObj<typeof meta>;\\n\\nexport const Pair: Story = {\\n render: (args) => ({\\n components: { ButtonGroup },\\n setup() {\\n return { args };\\n },\\n template: '<ButtonGroup v-bind=\\\"args\\\" />',\\n }),\\n args: {\\n buttons: [{ ...ButtonStories.Primary.args }, { ...ButtonStories.Secondary.args }],\\n orientation: 'horizontal',\\n },\\n};\\n``` \\n```\\n\\n{/* prettier-ignore-end */}\"}, \"Common attributes for code snippets\": {\"File name as title\": \"Most code examples should include a file name so readers can understand which file they relate to and where to paste it into their project. For code examples, include the `filename` attribute wrapped with quotation marks to indicate the file name. This is not required if the example relates to a terminal command.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"Button.stories.ts\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\", \"Language configuration\": \"Use the `language` attribute to define the language to which the code snippet applies. The documentation uses this attribute to determine which variant to display (e.g., JavaScript, TypeScript, MDX).\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"Button.stories.ts\\\" language=\\\"js|ts|mdx\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\", \"Framework-specific code\": \"Use the `renderer` attribute to indicate which of the [supported frameworks](../../configure/integration/frameworks-feature-support.mdx) the code snippet belongs to.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"Button.stories.ts\\\" language=\\\"ts\\\" renderer=\\\"react|vue|angular|web-components|ember|html|svelte|preact|qwik|solid\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nAlternatively, if you're documenting examples that apply to multiple frameworks, use the `renderer` attribute with the `common` value to indicate that the code snippet is framework-agnostic.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"Button.stories.ts\\\" language=\\\"ts\\\" renderer=\\\"common\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\", \"Package manager configuration\": \"Use the `packageManager` attribute to configure the package manager used in the example from the following options: `npm`, `yarn`, or `pnpm`.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```shell renderer=\\\"common\\\" language=\\\"js\\\" packageManager=\\\"npm|yarn|pnpm\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\", \"Working with multiple snippets\": \"Use the `tabTitle` attribute to indicate the tab title in which the code snippet will be displayed. This attribute should only be used when multiple examples are in a single code snippet file.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"YourComponent.stories.ts\\\" language=\\\"ts\\\" renderer=\\\"common\\\" tabTitle=\\\"Story\\\"\\n```\\n```ts filename=\\\".storybook/preview.ts\\\" language=\\\"ts\\\" renderer=\\\"common\\\" tabTitle=\\\"Storybook configuration\\\"\\n```\\n```\\n\\n{/* prettier-ignore-end */}\"}, \"Contributing code snippets\": \"You can start contributing to the Storybook documentation by now that you're familiar with how the documentation is organized, the code snippet's structure, and available options. Assuming that you have already set up your [local development environment](../code.mdx#initial-setup) and are ready to contribute, the following steps will guide you through contributing code snippets to the Storybook documentation.\\n\\nStart by creating a new branch on your local Storybook monorepo with the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\ngit checkout -b code-snippets-for-framework\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nBrowse the documentation and look for the code snippets you want to contribute. For example, on the [setup page](https://github.com/storybookjs/storybook/blob/next/docs/get-started/setup.mdx) you should see the following:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"your-component.md\\\" usesCsf3 />\\n\\n{/* prettier-ignore-end */}\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nOpen the file inside the `docs/_snippets` directory and adjust the content to match the code snippet you're willing to contribute. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n```ts filename=\\\"YourComponent.stories.ts\\\" renderer=\\\"qwik\\\" language=\\\"ts\\\"\\nimport type { Meta, StoryObj } from 'storybook-framework-qwik';\\n\\nimport type { YourComponentProps } from './YourComponent';\\n\\nimport { YourComponent } from './YourComponent';\\n\\n//\\ud83d\\udc47 This default export determines where your story goes in the story list\\nconst meta = {\\n component: YourComponent,\\n} satisfies Meta<YourComponentProps>;\\n\\nexport default meta;\\ntype Story = StoryObj<YourComponentProps>;\\n\\nexport const FirstStory: Story = {\\n args: {\\n //\\ud83d\\udc47 The args you need here will depend on your component\\n },\\n};\\n```\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nGo through the rest of the documentation and repeat the process.\", \"Preview your work\": \"Before submitting your contribution, we encourage you to check your work against the Storybook website. Doing this prevents last-minute issues with the documentation and is also an excellent way for the maintainers to merge faster once you submit the pull request. However, failing to do so will lead one of the maintainers to notify you that your contribution has an issue.\\n\\nStart by forking the Storybook [website repository](https://github.com/storybookjs/web) and cloning it locally.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\ngit clone https://github.com/your-username/web.git\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nNavigate to the `web` directory and install the required dependencies.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nnpm install\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nWe recommend that you generate a website build first to ensure you can preview your changes locally and verify that everything is working as expected. To do so, run the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nnpm run build:frontpage\\n```\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhen executed, this command will retrieve the required files needed to successfully build the Storybook website, including current documentation versions (e.g., `6.5`, `7.6`, `8.x`), and copy them to the `apps/frontpage/docs/` directory, organized by version number.\\n\\n</Callout>\\n\\nRun the `sync-docs` command to connect the documentation from the Storybook monorepo to the Storybook website. When prompted, provide the path to your local fork of the Storybook monorepo and the documentation version you're working on.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nnpm run sync-docs\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, open a new terminal window and run the `dev` command to start the Storybook website.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nnpm run dev\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nIf all goes well, you should see the Storybook website running. Open a browser window to `http://localhost:3000`, click the Docs link to open the documentation, and select your framework from the dropdown.\\n\\n<Video src=\\\"../_assets/contribute/local-storybook-website-dropdown-optimized.mp4\\\" />\\n\\nGo through the documentation and check your work.\", \"Submit your contribution\": \"Once you have verified that your changes are working as expected, you're ready to create a \\\"Pull Request\\\". This will let the Storybook maintainers know you have some changes to propose. At this point, we can give you feedback and request changes. To help with the review process, we encourage you to add a clear title and description of your work.\", \"Troubleshooting\": {\"Code snippets not displaying\": \"If you're documenting an example that includes the `packageManager` attribute combined with another example, the documentation might not display the code snippets correctly. To avoid this, you can divide the examples into separate files and reference them in the documentation.\"}, \"Learn more about contributing to Storybook\": [\"[RFC process](../RFC.mdx) for authoring feature requests\", \"[Code](../code.mdx) for features and bug fixes\", \"[Frameworks](../framework.mdx) to get started with a new framework\", \"[Documentation](./documentation-updates.mdx) for documentation improvements, typos, and clarifications\", \"Examples for new snippets\"]}, \"metadata\": {\"title\": \"Code snippets contributions\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 2, \"title\": \"Code snippets\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 7]\"}, {\"title\": \"Essentials\", \"description\": \"Documentation section: essentials\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/essentials\"}, \"subpages\": [{\"title\": \"Actions\", \"description\": null, \"content\": {\"Action args\": {\"Via storybook/test fn spy function\": \"The recommended way to write actions is to use the `fn` utility from `storybook/test` to mock and spy args. This is very useful for writing [interaction tests](../writing-tests/interaction-testing.mdx). You can mock your component's methods by assigning them to the `fn()` function:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-onclick-action-spy.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf your component calls an arg (because of either the user's interaction or the `play` function) and that arg is spied on , the event will show up in the action panel:\\n\\n\", \"Automatically matching args\": \"Another option is to use a global parameter to match all [argTypes](../api/arg-types.mdx) that match a certain pattern. The following configuration automatically creates actions for each `on` argType (which you can either specify manually or can be [inferred automatically](../api/arg-types.mdx#automatic-argtype-inference)).\\n\\nThis is quite useful when your component has dozens (or hundreds) of methods and you do not want to manually apply the `fn` utility for each of those methods. However, **this is not the recommended** way of writing actions. That's because automatically inferred args **are not available as spies in your play function**. If you use `argTypesRegex` and your stories have play functions, you will need to also define args with the `fn` utility to test them in your play function.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-matching-argtypes.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you need more granular control over which `argTypes` are matched, you can adjust your stories and include the `argTypesRegex` parameter. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-matching-argtypes.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis will bind a standard HTML event handler to the outermost HTML element rendered by your component and trigger an action when the event is called for a given selector. The format is `<eventname> <selector>`. The selector is optional; it defaults to all elements.\"}, \"API\": {\"Parameters\": {\"`argTypesRegex`\": \"Type: `string`\\n\\nCreate actions for each arg that matches the regex. Please note the significant [limitations of this approach](#automatically-matching-args), as described above.\", \"`disable`\": \"Type: `boolean`\\n\\nDisable the action panel.\\n\\nThis parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could then be re-enabled by setting it to `false` at the meta (component) or story level.\"}, \"Exports\": {\"`action`\": \"Type: `(name?: string) => void`\\n\\nAllows you to create an action that appears in the actions panel of the Storybook UI when clicked. The action function takes an optional name parameter, which is used to identify the action in the UI.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-actions-action-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}}, \"metadata\": {\"title\": \"Actions\", \"sidebar\": {\"order\": 1, \"title\": \"Actions\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 0]\"}, {\"title\": \"Backgrounds\", \"description\": null, \"content\": {\"Configuration\": \"By default, the backgrounds feature includes a light and dark background.\\n\\nBut you're not restricted to these backgrounds. You can configure your own set of colors with the `backgrounds` [parameter](../writing-stories/parameters.mdx) in your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering).\\n\\nYou can define the available background colors using the [`options` property](#options) and set the initial background color using the `initialGlobals` property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-options-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Defining the background for a story\": \"The backgrounds feature enables you to change the background color applied to a story by selecting from the list of predefined background colors in the toolbar. If needed, you can set a story to default to a specific background color, by using the `globals` option:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-define-globals.md\\\" usesCsf3 />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhen you specify a background color for a story (or a component's stories) using `globals`, the color is applied and cannot be changed using the toolbar. This is useful to ensure a story is always rendered on a specific background color.\\n\\n</Callout>\", \"Extending the configuration\": \"You can also configure backgrounds on a per-component or per-story basis through [parameter inheritance](../writing-stories/parameters.mdx#component-parameters).\\n\\nTo set the available background colors, use the [`options` property](#options). In this example, we'll adjust the colors for all of the Button component's stories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-options-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Disable backgrounds\": \"If you want to turn off backgrounds in a story, you can do so by configuring the `backgrounds` parameter like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-disabled.md\\\" usesCsf3/>\\n\\n{/* prettier-ignore-end */}\", \"Grid\": \"The backgrounds feature also includes a Grid selector, which allows you to quickly see if your components are aligned.\\n\\nYou don't need additional configuration to get started. But its properties are fully customizable; if you don't supply any value to any of its properties, they'll default to the following values:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-grid.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"API\": {\"Globals\": {\"`grid`\": \"Type: `boolean`\\n\\nWhether the [grid](#grid) is displayed.\", \"`value`\": \"Type: `string`\\n\\nWhen set, the background color is applied and cannot be changed using the toolbar. Must match the key of one of the [available colors](#options).\"}, \"Parameters\": {\"`disable`\": \"Type: `boolean`\\n\\nDisable this feature's behavior. If you wish to disable this feature for the entire Storybook, you should [do so in your main configuration file](./index.mdx#disabling-features).\\n\\nThis parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could then be re-enabled by setting it to `false` at the meta (component) or story level.\", \"`grid`\": {\"`grid.cellAmount`\": \"Type: `number`\\n\\nDefault: `5`\\n\\nSpecify the size of the minor grid lines.\", \"`grid.cellSize`\": \"Type: `number`\\n\\nDefault: `20`\\n\\nSpecify the size of the major grid lines.\", \"`grid.disable`\": \"Type: `boolean`\\n\\nTurn off the grid.\", \"`grid.offsetX`\": \"Type: `number`\\n\\nDefault: `0` if [story layout](../api/parameters.mdx#layout) is `'fullscreen'`; `16` if story layout is `'padded'`\\n\\nHorizontal offset of the grid.\", \"`grid.offsetY`\": \"Type: `number`\\n\\nDefault: `0` if [story layout](../api/parameters.mdx#layout) is `'fullscreen'`; `16` if story layout is `'padded'`\\n\\nVertical offset of the grid.\", \"`grid.opacity`\": \"Type: `number`\\n\\nDefault: `0.5`\\n\\nThe opacity of the grid lines.\"}, \"`options`\": \"(Required, see description)\\n\\nType:\\n\\n```\\n{\\n [key: string]: {\\n name: string;\\n value: string;\\n };\\n}\\n```\\n\\nAvailable background colors. See above for a [usage example](#configuration).\"}}}, \"metadata\": {\"title\": \"Backgrounds\", \"sidebar\": {\"order\": 2, \"title\": \"Backgrounds\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 1]\"}, {\"title\": \"Controls\", \"description\": null, \"content\": {\"Choosing the control type\": \"<IfRenderer renderer=\\\"angular\\\">\\nBy default, Storybook will try to infer the required argTypes and associated controls for your stories based on the component's definition and initial value of the args using [Compodoc](https://compodoc.app/), a documentation generator for Angular applications that can extract the metadata of your components, including first-class support for Angular's `inputs`, `outputs`, `properties`, `methods`, and `view/content child/children`. If you opt-in to use it, you must take additional steps to set it up properly.\\n\\nRun the following command to install the tooling.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"compodoc-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate your `angular.json` file to include the following configuration to include it in the Storybook's inbuilt builder configuration.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"angular-project-compodoc-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, update your `.storybook/preview.ts` file to include the following configuration to import the metadata generated by Compodoc and use it to generate the controls and argTypes for your stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-compodoc-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen you set the `component` annotation of the default export of your story file, it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"ember\\\">\\nBy default, Storybook will try to infer the required argTypes and associated controls for your stories based on the metadata provided by the [`@storybook/ember-cli-storybook`](https://github.com/storybookjs/ember-cli-storybook) adapter. You'll need to take some additional steps to set it up properly.\\n\\nUpdate your `ember-cli-build.js` configuration file to include the adapter.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-ember-cli-build.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nRestart your application to generate the metadata file (i.e., `storybook-docgen/index.json`) and update your `.storybook/preview.js` file to include it, which will be used to create the controls and argTypes for your stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-custom-metadata.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nEnabling this feature will generate a `storybook-docgen/index.json` automatically with each build. For more information on how the metadata is generated, refer to [documentation](https://github.com/storybookjs/storybook/tree/next/code/frameworks/ember) for the Ember framework.\\n</Callout>\\n\\nWhen you set the `component` annotation of the default export of your story file, it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"react\\\">\\nBy default, Storybook will choose a control for each arg based on its initial value. This will work well with specific arg types (e.g., `boolean` or `string`). To enable them, add the `component` annotation to the default export of your story file, and it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component using [`react-docgen`](https://github.com/reactjs/react-docgen), a documentation generator for React components that also includes first-class support for TypeScript.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"vue\\\">\\nBy default, Storybook will choose a control for each arg based on its initial value. This will work well with specific arg types (e.g., `boolean` or `string`). To enable them, add the `component` annotation to the default export of your story file, and it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component using [`vue-docgen-api`](https://github.com/vue-styleguidist/vue-styleguidist/tree/dev/packages/vue-docgen-api), including first-class support for Vue's `props`, `events`, and `slots`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"web-components\\\">\\nBy default, Storybook will try to infer the required argTypes and associated controls for your stories based on the component's definition and the initial value of the args. You'll need to take some additional steps to set it up properly. You can opt to generate a [`custom-elements.json`](https://github.com/webcomponents/custom-elements-json) file with [`@custom-elements-manifest/analyzer`](https://github.com/open-wc/custom-elements-manifest) if you're using the `pre-v1.0.0` version of the elements file or [`@custom-elements-manifest/analyzer`](https://github.com/open-wc/custom-elements-manifest/tree/master/packages/analyzer) for newer versions and configure it in your Storybook UI configuration file (i.e., `.storybook/preview.js|ts`) to enable it.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-custom-elements-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen you set the `component` annotation of the default export of your story file, it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer={[ 'html', 'svelte', 'preact', 'qwik', 'solid' ]}>\\nBy default, Storybook will choose a control for each arg based on its initial value. This will work well with specific arg types (e.g., `boolean` or `string`). To enable them, add the `component` annotation to the default export of your story file, and it will be used to infer the controls and auto-generate the matching [`argTypes`](../api/arg-types.mdx) for your component provided by the framework you've chosen to use.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf you're using a framework that doesn't support this feature, you'll need to define the `argTypes` for your component [manually](#fully-custom-args).\\n</Callout>\\n</IfRenderer>\\n\\nFor instance, suppose you have a `variant` arg on your story that should be `primary` or `secondary`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-controls-primary-variant.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nBy default, Storybook will render a free text input for the `variant` arg:\\n\\n\\n\\nIt works as long as you type a valid string into the auto-generated text control. Still, it's not the best UI for our scenario, given that the component only accepts `primary` or `secondary` as variants. Let\\u2019s replace it with Storybook\\u2019s radio component.\\n\\nWe can specify which controls get used by declaring a custom [argType](../api/arg-types.mdx) for the `variant` property. ArgTypes encode basic metadata for args, such as name, description, and defaultValue for an arg. These get automatically filled in by Storybook Docs.\\n\\n<IfRenderer renderer=\\\"svelte\\\">\\n\\n`ArgTypes` can also contain arbitrary annotations, which the user can override. Since `variant` is a component property, let's put that annotation on the `defineMeta` function, or the default export if you're using standard CSF.\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\n`ArgTypes` can also contain arbitrary annotations, which the user can override. Since `variant` is a component property, let's put that annotation on the default export.\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-controls-radio-group.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nArgTypes are a powerful feature that can be used to customize the controls for your stories. For more information, see the documentation about [customizing controls](#annotation) with `argTypes` annotation.\\n</Callout>\\n\\nThis replaces the input with a radio group for a more intuitive experience.\\n\\n\", \"Custom control type matchers\": \"Controls can automatically be inferred from arg's name with [regex](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/RegExp), but currently only for the color picker and date picker controls. If you've used the Storybook CLI to setup your project, it should have automatically created the following defaults in `.storybook/preview.js|ts`:\\n\\n| Control | Default regex | Description |\\n| --------- | ---------------------------------------- | --------------------------------------------------------- |\\n| **color** | <code>{`/(background\\\\|color)$/i`}</code> | Will display a color picker UI for the args that match it |\\n| **date** | `/Date$/` | Will display a date picker UI for the args that match it |\\n\\nIf you haven't used the CLI to set the configuration, or if you want to define your patterns, use the `matchers` property in the `controls` parameter:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-controls-custom-matchers.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Fully custom args\": {\"Dealing with complex values\": \"When dealing with non-primitive values, you'll notice that you'll run into some limitations. The most obvious issue is that not every value can be represented as part of the `args` param in the URL, losing the ability to share and deep link to such a state. Beyond that, complex values such as JSX cannot be synchronized between the manager (e.g., the Controls panel) and the preview (your story).\\n\\nOne way to deal with this is to use primitive values (e.g., strings) as arg values and add a custom `render` function to convert them to their complex counterpart before rendering. It isn't the nicest way to do it (see below), but certainly the most flexible.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-custom-args-complex.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUnless you need the flexibility of a function, an easier way to map primitives to complex values before rendering is to define a `mapping`; additionally, you can specify `control.labels` to configure custom labels for your checkbox, radio, or select input.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-custom-args-mapping.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNote that both `mapping` and `control.labels` don't have to be exhaustive. If the currently selected option is not listed, it's used verbatim.\"}, \"Creating and editing stories from controls\": {\"Create a new story\": \"Open the Controls panel for a story and adjust the value of a control. Then save those changes as a new story.\\n\\n<Video src=\\\"../_assets/get-started/new-story-from-controls-optimized.mp4\\\" />\\n\\n<If renderer=\\\"react\\\">\\nIf you're working on a component that does not yet have any stories, you can click the \\u2795 button in the sidebar to search for your component and have a basic story created for you.\\n\\n <Video src=\\\"../_assets/get-started/new-component-story-from-plus-button-optimized.mp4\\\" />\\n</If>\", \"Edit a story\": \"You can also update a control's value, then save the changes to the story. The story file's code will be updated for you.\\n\\n<Video src=\\\"../_assets/get-started/edit-story-from-controls-optimized.mp4\\\" />\", \"Disable creating and editing of stories\": \"If you don't want to allow the creation or editing of stories from the Controls panel, you can disable this feature by setting the `disableSaveFromUI` parameter to `true` in the `parameters.controls` parameter in your `.storybook/preview.js|ts` file.\"}, \"Configuration\": {\"Annotation\": \"As shown above, you can configure individual controls with the \\u201ccontrol\\\" annotation in the [argTypes](../api/arg-types.mdx) field of either a component or story. Below is a condensed example and table featuring all available controls.\\n\\n| Data Type | Control | Description |\\n| ----------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| **boolean** | `boolean` | Provides a toggle for switching between possible states.<br /> `argTypes: { active: { control: 'boolean' }}` |\\n| **number** | `number` | Provides a numeric input to include the range of all possible values.<br /> `argTypes: { even: { control: { type: 'number', min:1, max:30, step: 2 } }}` |\\n| | `range` | Provides a range slider component to include all possible values.<br /> `argTypes: { odd: { control: { type: 'range', min: 1, max: 30, step: 3 } }}` |\\n| **object** | `object` | Provides a JSON-based editor component to handle the object's values.<br /> Also allows edition in raw mode.<br /> `argTypes: { user: { control: 'object' }}` |\\n| **array** | `object` | Provides a JSON-based editor component to handle the array's values.<br /> Also allows edition in raw mode.<br /> `argTypes: { odd: { control: 'object' }}` |\\n| | `file` | Provides a file input component that returns an array of URLs.<br /> Can be further customized to accept specific file types.<br /> `argTypes: { avatar: { control: { type: 'file', accept: '.png' } }}` |\\n| **enum** | `radio` | Provides a set of radio buttons based on the available options.<br /> `argTypes: { contact: { control: 'radio', options: ['email', 'phone', 'mail'] }}` |\\n| | `inline-radio` | Provides a set of inlined radio buttons based on the available options.<br /> `argTypes: { contact: { control: 'inline-radio', options: ['email', 'phone', 'mail'] }}` |\\n| | `check` | Provides a set of checkbox components for selecting multiple options.<br /> `argTypes: { contact: { control: 'check', options: ['email', 'phone', 'mail'] }}` |\\n| | `inline-check` | Provides a set of inlined checkbox components for selecting multiple options.<br /> `argTypes: { contact: { control: 'inline-check', options: ['email', 'phone', 'mail'] }}` |\\n| | `select` | Provides a drop-down list component to handle single value selection. `argTypes: { age: { control: 'select', options: [20, 30, 40, 50] }}` |\\n| | `multi-select` | Provides a drop-down list that allows multiple selected values. `argTypes: { countries: { control: 'multi-select', options: ['USA', 'Canada', 'Mexico'] }}` |\\n| **string** | `text` | Provides a freeform text input. <br /> `argTypes: { label: { control: 'text' }}` |\\n| | `color` | Provides a color picker component to handle color values.<br /> Can be additionally configured to include a set of color presets.<br /> `argTypes: { color: { control: { type: 'color', presetColors: ['red', 'green']} }}` |\\n| | `date` | Provides a datepicker component to handle date selection. `argTypes: { startDate: { control: 'date' }}` |\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe `date` control will convert the date into a UNIX timestamp when the value changes. It's a known limitation that will be fixed in a future release. If you need to represent the actual date, you'll need to update the story's implementation and convert the value into a date object.\\n</Callout>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"gizmo-story-controls-customization.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nNumeric data types will default to a `number` control unless additional configuration is provided.\\n</Callout>\", \"Parameters\": {\"Show full documentation for each property\": \"Since Controls is built on the same engine as Storybook Docs, it can also show property documentation alongside your controls using the expanded parameter (defaults to false). This means you embed a complete [`Controls`](../api/doc-blocks/doc-block-controls.mdx) doc block in the controls panel. The description and default value rendering can be [customized](#fully-custom-args) like the doc block.\\n\\nTo enable expanded mode globally, add the following to [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-expanded-controls.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nHere's what the resulting UI looks like:\\n\\n\", \"Specify initial preset color swatches\": \"For `color` controls, you can specify an array of `presetColors`, either on the `control` in `argTypes`, or as a parameter under the `controls` namespace:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-parameters-color-swatches.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nColor presets can be defined as an object with `color` and `title` or a simple CSS color string. These will then be available as swatches in the color picker. When you hover over the color swatch, you'll be able to see its title. It will default to the nearest CSS color name if none is specified.\", \"Filtering controls\": \"In specific cases, you may be required to display only a limited number of controls in the controls panel or all except a particular set.\\n\\nTo make this possible, you can use optional `include` and `exclude` configuration fields in the `controls` parameter, which you can define as an array of strings or a regular expression.\\n\\nConsider the following story snippets:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-disable-controls-regex.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Sorting controls\": \"By default, controls are unsorted and use whatever order the args data is processed in (`none`). Additionally, you can sort them alphabetically by the arg's name (`alpha`) or with the required args first (`requiredFirst`).\\n\\nConsider the following snippet to force required args first:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-sort-controls.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Disable controls for specific properties\": \"Aside from the features already documented here, Controls can also be disabled for individual properties.\\n\\nSuppose you want to turn off Controls for a property called `foo` in a component's story. The following example illustrates how:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-disable-controls.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nResulting in the following change in Storybook UI:\\n\\n<Video src=\\\"../_assets/essentials/addon-controls-disable-specific-prop-optimized.mp4\\\" />\\n\\nThe previous example also removed the prop documentation from the table. In some cases, this is fine. However, sometimes you might want to render the prop documentation without a control. The following example illustrates how:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-disable-controls-alt.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nAs with other Storybook properties, such as [decorators](../writing-stories/decorators.mdx), you can apply the same pattern at a story level for more granular cases.\\n</Callout>\", \"Conditional controls\": \"In some cases, it's useful to be able to conditionally exclude a control based on the value of another control. Controls supports basic versions of these use cases with the `if`, which can take a simple query object to determine whether to include the control.\\n\\nConsider a collection of \\\"advanced\\\" settings only visible when the user toggles an \\\"advanced\\\" toggle.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-conditional-controls-toggle.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOr consider a constraint where if the user sets one control value, it doesn't make sense for the user to be able to set another value.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-conditional-controls-mutual-exclusion.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe query object must contain either an `arg` or `global` target:\\n\\n| field | type | meaning |\\n| ------ | ------ | ----------------------------- |\\n| arg | string | The ID of the arg to test. |\\n| global | string | The ID of the global to test. |\\n\\nIt may also contain at most one of the following operators:\\n\\n| operator | type | meaning |\\n| -------- | ------- | ---------------------------------------------------- |\\n| truthy | boolean | Is the target value truthy? |\\n| exists | boolean | Is the target value defined? |\\n| eq | any | Is the target value equal to the provided value? |\\n| neq | any | Is the target value NOT equal to the provided value? |\\n\\nIf no operator is provided, that is equivalent to `{ truthy: true }`.\"}, \"Troubleshooting\": {\"Controls are not automatically generated for my component\": \"If you're working with Angular, Ember, or Web Components, automatic argTypes and controls inference will not work out of the box and requires you to provide [additional configuration](#choosing-the-control-type) to allow Storybook to retrieve the necessary metadata and generate the needed argTypes and controls for your stories. However, if you need additional customization, you can always [define them manually](#fully-custom-args).\\n</IfRenderer>\", \"The controls are not updating the story within the auto-generated documentation\": \"If you turned off inline rendering for your stories via the [`inline`](../api/doc-blocks/doc-block-story.mdx#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release.\"}, \"API\": {\"Parameters\": {\"`disable`\": \"Type: `boolean`\\n\\nDisable this feature's behavior. If you wish to disable this feature for the entire Storybook, you should [do so in your main configuration file](./index.mdx#disabling-features).\\n\\nThis parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could then be re-enabled by setting it to `false` at the meta (component) or story level.\", \"`exclude`\": \"Type: `string[] | RegExp`\\n\\nSpecifies which properties to exclude from the Controls panel. Any properties whose names match the regex or are part of the array will be left out. See [usage example](#filtering-controls), above.\", \"`expanded`\": \"Type: `boolean`\\n\\nShow the full documentation for each property in the Controls panel, including the description and default value. See [usage example](#show-full-documentation-for-each-property), above.\", \"`include`\": \"Type: `string[] | RegExp`\\n\\nSpecifies which properties to include in the Controls panel. Any properties whose names don't match the regex or are not part of the array will be left out. See [usage example](#filtering-controls), above.\", \"`presetColors`\": \"Type: `(string | { color: string; title?: string })[]`\\n\\nSpecify preset color swatches for the color picker control. The color value may be any valid CSS color. See [usage example](#specify-initial-preset-color-swatches), above.\", \"`sort`\": \"Type: `'none' | 'alpha' | 'requiredFirst'`\\n\\nDefault: `'none'`\\n\\nSpecifies how the controls are sorted.\\n\\n['**none**: Unsorted, displayed in the same order the arg types are processed in', \\\"**alpha**: Sorted alphabetically, by the arg type's name\\\", '**requiredFirst**: Same as `alpha`, with any required arg types displayed first']\", \"`disableSaveFromUI`\": \"Type: `boolean`\\n\\nDefault: `false`\\n\\nDisable the ability to create or edit stories from the Controls panel.\"}}}, \"metadata\": {\"title\": \"Controls\", \"sidebar\": {\"order\": 3, \"title\": \"Controls\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 2]\"}, {\"title\": \"Highlight\", \"description\": null, \"content\": {\"Highlighting DOM Elements\": {\"Customize style\": \"By default, highlighted elements contain a standard outline style applied to the selected elements. However, you can enable your custom style by extending the payload object with additional properties to customize the appearance of the highlighted elements. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"highlight-custom-style.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThese properties are optional, and you can use them to customize the appearance of the highlighted elements. The `hoverStyles` and `focusStyles` properties are recommended for use with the `menu` property. Pseudo-classes and pseudo-elements are not supported.\\n</Callout>\", \"Highlight menu\": \"The Highlight feature includes a built-in debugging option, allowing you to select the highlighted elements when you click them. This is particularly useful for inspecting the elements affected by the feature, as it lets you preview a list of elements matching the selector you provided. To enable it, add a `menu` property in the payload object containing additional information about the elements or trigger actions. Each item must include an `id` and a `title`, and you can also provide an optional `selectors` property to limit the menu item to specific highlighted elements.\\n\\n\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"highlight-menu.md\\\" />\\n\\n{/* prettier-ignore-end */ }\\n\\nWhen enabled, the menu will be displayed when you click on the selected element matching your provided selectors. However, if you don't want to show any information, you can omit the items or set the `menu` property to an empty array to show the default menu.\\n\\n\"}, \"Remove highlights\": \"If you need to remove a highlight from a specific element, you can do so by emitting the `REMOVE_HIGHLIGHT` event and providing the `id` of the highlight you want to remove. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"highlight-remove.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe `emit` function derived from the `useChannel` API hook creates a communication channel in Storybook's UI to listen for events and update the UI accordingly. The Highlight feature uses this channel to listen to custom events and update the highlighted elements (if any) accordingly.\\n</Callout>\", \"Reset highlighted elements\": \"Out of the box, Storybook automatically removes highlighted elements when transitioning between stories. However, if you need to clear them manually, you can emit the `RESET_HIGHLIGHT` event from within a story or an addon. This removes all highlights, even ones created by other addons. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"highlight-reset.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Scroll element into view\": \"The Highlight feature allows you to scroll an element into view and highlight it. To enable it, emit the `SCROLL_INTO_VIEW` event from within a story or an addon. The event payload must contain a `selector` property to target the element you want to scroll into view. When the element is visible, it will be highlighted for a brief moment.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"highlight-scroll-into-view.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"API\": {\"Parameters\": {\"`disable`\": \"Type: `boolean`\\n\\nDisable this feature's behavior. If you wish to turn off this feature for the entire Storybook, you should [do so in your main configuration file](./index.mdx#disabling-features).\\n\\nThis parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could be re-enabled by setting it to `false` at the meta (component) or story level.\"}, \"Exports\": {\"`HIGHLIGHT`\": \"An event to highlight DOM elements. The event payload must contain a `selectors` property assigned to an array of selectors matching the elements you want to highlight. It can be extended with an optional object containing additional configuration options. See the [usage example](#highlighting-dom-elements) above.\\n\\n```\\nimport { HIGHLIGHT, type HighlightOptions } from 'storybook/highlight';\\n\\nchannel.emit(\\n HIGHLIGHT,\\n options // The available configuration options inheriting from the HighlightOptions API\\n);\\n```\\n\\nThe `options` object contains the following properties:\\n\\n```\\ninterface HighlightOptions {\\n /** Unique identifier for the highlight, required if you want to remove the highlight later */\\n id?: string;\\n /** HTML selectors of the elements */\\n selectors: string[];\\n /** Priority of the highlight, higher takes precedence, defaults to 0 */\\n priority?: number;\\n /** CSS styles to apply to the highlight */\\n styles?: Record<string, string>;\\n /** CSS styles to apply to the highlight when it is hovered */\\n hoverStyles?: Record<string, string>;\\n /** CSS styles to apply to the highlight when it is focused or selected */\\n focusStyles?: Record<string, string>;\\n /** Keyframes required for animations */\\n keyframes?: string;\\n /** Groups of menu items to show when the highlight is selected */\\n menu?: HighlightMenuItem[][];\\n}\\n\\ninterface HighlightMenuItem {\\n /** Unique identifier for the menu item */\\n id: string;\\n /** Title of the menu item */\\n title: string;\\n /** Description of the menu item */\\n description?: string;\\n /** Icon for the menu item, left side */\\n iconLeft?: \\\"chevronLeft\\\" | \\\"chevronRight\\\" | \\\"info\\\" | \\\"shareAlt\\\";\\n /** Icon for the menu item, right side */\\n iconRight?: \\\"chevronLeft\\\" | \\\"chevronRight\\\" | \\\"info\\\" | \\\"shareAlt\\\";\\n /** Name for a channel event to trigger when the menu item is clicked */\\n clickEvent?: string;\\n /** HTML selectors for which this menu item should show (subset of HighlightOptions['selectors']) */\\n selectors?: HighlightOptions['selectors'];\\n}\\n```\\n\\nMenu items can specify a `clickEvent` to be emitted on the channel when the item is clicked. The channel event will receive two arguments: the menu item `id` and a `ClickEventDetails` object with the following properties:\\n\\n```\\ninterface ClickEventDetails {\\n // Position and dimensions of the element on the page\\n top: number;\\n left: number;\\n width: number;\\n height: number;\\n // Selector(s) which matched the element\\n selectors: string[];\\n // DOM element details\\n element: {\\n attributes: Record<string, string>;\\n localName: string;\\n tagName: string;\\n outerHTML: string;\\n };\\n}\\n```\\n\\nTo listen for this event (assuming `clickEvent: 'MY_CLICK_EVENT'`):\\n\\n```\\nimport type { ClickEventDetails } from 'storybook/highlight';\\n\\nconst handleClickEvent = (itemId: string, details: ClickEventDetails) => {\\n // Handle the menu item click event\\n}\\n\\n// When you have a channel instance:\\nchannel.on('MY_CLICK_EVENT', handleClickEvent)\\n\\n// Or from a decorator:\\nuseChannel({\\n MY_CLICK_EVENT: handleClickEvent,\\n}, [handleClickEvent])\\n```\", \"`REMOVE_HIGHLIGHT`\": \"An event that removes a previously created highlight. The event payload must contain an `id` property assigned to the id of the highlight you want to remove. See the [usage example](#remove-highlights) above.\\n\\n```\\nimport { REMOVE_HIGHLIGHT } from 'storybook/highlight';\\n\\nchannel.emit(\\n REMOVE_HIGHLIGHT,\\n id // The id of the previously created highlight to be removed\\n);\\n```\", \"`RESET_HIGHLIGHT`\": \"An event to clear all highlights from highlighted elements. See the [usage example](#reset-highlighted-elements) above.\\n\\n```\\nimport { RESET_HIGHLIGHT } from 'storybook/highlight';\\n\\nchannel.emit(RESET_HIGHLIGHT);\\n```\", \"`SCROLL_INTO_VIEW`\": \"An event to scroll a DOM element into view and briefly highlight it. The event payload must contain a selector property assigned to the selector of the element you want to scroll into view. Optionally, you can provide a [`options`](https://developer.mozilla.org/en-US/docs/Web/API/Element/scrollIntoView#scrollintoviewoptions) object to customize the scroll behavior. See the [usage example](#scroll-element-into-view) above.\\n\\n```\\nimport { SCROLL_INTO_VIEW } from 'storybook/highlight';\\n\\nchannel.emit(\\n SCROLL_INTO_VIEW,\\n selector // Element selector to scroll into view\\n options // An object inheriting from ScrollIntoViewOptions API to customize the scroll behavior\\n);\\n```\"}}}, \"metadata\": {\"title\": \"Highlight\", \"sidebar\": {\"order\": 4, \"title\": \"Highlight\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 3]\"}, {\"title\": \"Essentials\", \"description\": null, \"content\": {\"Configuration\": \"Essentials is \\\"zero-config\\u201d. It comes with a recommended configuration out of the box.\\n\\nMany of the features above can be configured via [parameters](../writing-stories/parameters.mdx). See each feature's documentation (linked above) for more details.\", \"Disabling features\": \"If you need to disable any of the essential features, you can do it by changing your [`.storybook/main.js|ts`](../configure/index.mdx#configure-your-storybook-project) file.\\n\\nFor example, if you wanted to disable the [backgrounds feature](./backgrounds.mdx), you would apply the following change to your Storybook configuration:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"essential-feature-disable.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nYou can use the following keys for each individual feature: `actions`, `backgrounds`, `controls`, `highlight`, `measure`, `outline`, `toolbars`, and `viewport`.\\n</Callout>\"}, \"metadata\": {\"title\": \"Essentials\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 6, \"title\": \"Essentials\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 4]\"}, {\"title\": \"Measure & outline\", \"description\": null, \"content\": {\"Measure\": \"While working with composite components or page layouts, dealing with whitespace (i.e., `margin`, `padding`, `border`) and individual component measurements can be tedious. It would require that you open up the browser's development tools and manually inspect the DOM tree for issues and UI bugs.\\n\\nInstead, you can quickly visualize each component's measurements by clicking the measure button in the toolbar. Now when you hover over an element in your story, that element's dimensions and any whitespace (i.e., `margin`, `padding`, `border`) will be shown.\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nAlternatively you can press the `m` key on your keyboard to toggle measure on and off.\\n</Callout>\", \"Outline\": \"When building your layouts, checking the visual alignment of all components can be pretty complicated, especially if your components are spread apart or contain unique shapes.\\n\\nClick the outline button in the toolbar to toggle the outlines associated with all your UI elements, allowing you to spot bugs and broken layouts instantly.\\n\\n\", \"API\": {\"Parameters\": {\"`disable`\": \"Type: `boolean`\\n\\nDisable the feature's behavior. If you wish to disable the feature for the entire Storybook, you should [do so in your main configuration file](./index.mdx#disabling-features).\\n\\nThis parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could then be re-enabled by setting it to `false` at the meta (component) or story level.\"}}}, \"metadata\": {\"title\": \"Measure & outline\", \"sidebar\": {\"order\": 6, \"title\": \"Measure & outline\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 5]\"}, {\"title\": \"Themes\", \"description\": null, \"content\": {\"Theme decorators\": {\"JSX providers\": \"For libraries that expose themes to components through providers, such as [Material UI](https://storybook.js.org/recipes/@mui/material/), [Styled-components](https://storybook.js.org/recipes/styled-components/), and [Emotion](https://storybook.js.org/recipes/@emotion/styled/), use the `withThemeFromJSXProvider`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-themes-jsx-provider-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"CSS classes\": \"For libraries that rely on CSS classes on a parent element to determine the theme, you can use the `withThemeByClassName` decorator.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-themes-classname-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Data attributes\": \"For libraries that rely on data attributes on a parent element to determine the theme, you can use the `withThemeByDataAttribute` decorator.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-themes-data-attribute-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Themes\", \"draft\": true, \"sidebar\": {\"order\": 9, \"title\": \"Themes\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 6]\"}, {\"title\": \"Toolbars & globals\", \"description\": null, \"content\": {\"Globals\": \"Globals in Storybook represent \\u201cglobal\\u201d (as in not story-specific) inputs to the rendering of the story. As they aren\\u2019t specific to the story, they aren\\u2019t passed in the `args` argument to the story function (although they are accessible as `context.globals`). Instead, they are typically used in decorators, which apply to all stories.\\n\\nWhen the globals change, the story re-renders and the decorators rerun with the new values. The easiest way to change globals is to create a toolbar item for them.\", \"Global types and the toolbar annotation\": \"Storybook has a simple, declarative syntax for configuring toolbar menus. In your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering), you can add your own toolbars by creating `globalTypes` with a `toolbar` annotation:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-configure-globaltypes.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nAs globals are *global* you can *only* set `globalTypes` and `initialGlobals` in [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering).\\n\\n</Callout>\\n\\nWhen you start your Storybook, your toolbar should have a new dropdown menu with the `light` and `dark` options.\", \"Create a decorator\": \"We have a `global` implemented. Let's wire it up! We can consume our new `theme` global in a decorator using the `context.globals.theme` value.\\n\\n<IfRenderer renderer=\\\"react\\\">\\nFor example, suppose you are using [`styled-components`](https://styled-components.com/). You can add a theme provider decorator to your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) config:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-use-global-type.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"vue\\\">\\nFor example, suppose you are using [`Vuetify`](https://vuetifyjs.com/en/). You can add a theme provider decorator to your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) config:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-use-global-type.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"angular\\\">\\nFor example, suppose you are using [`Angular Material`](https://material.angular.io/). You can add a theme provider decorator to your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) config:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-use-global-type.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer={['ember', 'html', 'preact', 'qwik', 'svelte', 'solid', 'web-components' ]}>\\nDepending on your framework and theming library, you can extend your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) and provide a decorator to load the theme. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-use-global-type.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\", \"Setting globals on a story\": \"When a global value is changed with a toolbar menu in Storybook, that value continues to be used as you navigate between stories. But sometimes a story requires a specific value to render correctly, e.g., when testing against a particular environment.\\n\\nTo ensure that a story always uses a specific global value, regardless of what has been chosen in the toolbar, you can set the `globals` annotation on a story or component. This overrides the global value for those stories and disables the toolbar menu for that global when viewing the stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-backgrounds-define-globals.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn the example above, Storybook will force all Button stories to use a gray background color, except the `OnDark` story, which will use the dark background. For all Button stories, the toolbar menu will be disabled for the `backgrounds` global, with a tooltip explaining that the global is set at the story level.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nConfiguring a story's `globals` annotation to override the project-level global settings is useful but should be used with moderation. Globals that are _not_ defined at the story level can be selected interactively in Storybook's UI, allowing users to explore every existing combination of values (e.g., global values, [`args`](../writing-stories/args.mdx)). Setting them at the story level will disable that control, preventing users from exploring the available options.\\n\\n</Callout>\", \"Advanced usage\": \"So far, we've created and used a global inside Storybook.\\n\\nNow, let's take a look at a more complex example. Suppose we wanted to implement a new global called **locale** for internationalization, which shows a flag on the right side of the toolbar.\\n\\nIn your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering), add the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-locales-globaltype.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\" style={{ marginBottom: '10px' }}>\\n\\nThe `icon` element used in the examples loads the icons from the `@storybook/icons` package. See [here](../faq.mdx#what-icons-are-available-for-my-toolbar-or-my-addon) for the list of available icons that you can use.\\n\\n</Callout>\\n\\nAdding the configuration element `right` will display the text on the right side in the toolbar menu once you connect it to a decorator.\\n\\nHere's a list of the available configuration options.\\n\\n| MenuItem | Type | Description | Required |\\n| --------- | ------ | --------------------------------------------------------------- | -------- |\\n| **value** | String | The string value of the menu that gets set in the globals | Yes |\\n| **title** | String | The main text of the title | Yes |\\n| **right** | String | A string that gets displayed on the right side of the menu | No |\\n| **icon** | String | An icon that gets shown in the toolbar if this item is selected | No |\", \"Consuming globals from within a story\": \"We recommend consuming globals from within a decorator and defining a global setting for all stories.\\n\\nBut we're aware that sometimes it's more beneficial to use toolbar options on a per-story basis.\\n\\nUsing the example above, you can modify any story to retrieve the **Locale** `global` from the story context:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-story-use-globaltype.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Consuming globals from within an addon\": \"If you're working on a Storybook addon and need to retrieve globals, you can do so. The `storybook/manager-api` module provides a hook for this scenario. You can use the [`useGlobals()`](../addons/addons-api.mdx#useglobals) hook to retrieve any globals you want.\\n\\nUsing the ThemeProvider example above, you could expand it to display which theme is active inside a panel as such:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-consume-globaltype.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Updating globals from within an addon\": \"If you're working on a Storybook addon that needs to update the global and refresh the UI, you can do so. As mentioned previously, the `storybook/manager-api` module provides the necessary hook for this scenario. You can use the `updateGlobals` function to update any global values you need.\\n\\nFor example, if you were working on a [toolbar addon](../addons/addon-types.mdx#toolbars), and you want to refresh the UI and update the global once the user clicks on a button:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-consume-and-update-globaltype.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"metadata\": {\"title\": \"Toolbars & globals\", \"sidebar\": {\"order\": 7, \"title\": \"Toolbars & globals\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 7]\"}, {\"title\": \"Viewport\", \"description\": null, \"content\": {\"Configuration\": {\"Use a detailed set of devices\": \"By default, the viewport feature will use a minimal set of viewports, which enables you to test your UI in common responsive scenarios. These are also available in the [`MINIMAL_VIEWPORTS` export](#minimal_viewports) and include the following devices:\\n\\n| Key | Description | Dimensions<br />(<abbr title=\\\"width\\\">w</abbr>\\u00d7<abbr title=\\\"height\\\">h</abbr>, px) |\\n| ----------|------------- | -------------------------------------------------------------------------------- |\\n| `mobile1` | Small mobile | 320 \\u00d7 568 |\\n| `mobile2` | Large mobile | 414 \\u00d7 896 |\\n| `tablet` | Tablet | 834 \\u00d7 1112 |\\n\\nIf you need a more detailed set of devices, you can use the [`INITIAL_VIEWPORTS` export](#initial_viewports), which includes the following devices:\\n\\n| Key | Description | Dimensions<br />(<abbr title=\\\"width\\\">w</abbr>\\u00d7<abbr title=\\\"height\\\">h</abbr>, px) |\\n| -----------------| ----------------------------------------------- | -------------------------------------------------------------------------------- |\\n| `iphone5` | iPhone 5 | 320 \\u00d7 568 |\\n| `iphone6` | iPhone 6 | 375 \\u00d7 667 |\\n| `iphone6p` | iPhone 6 Plus | 414 \\u00d7 736 |\\n| `iphone8p` | iPhone 8 Plus | 414 \\u00d7 736 |\\n| `iphonex` | iPhone X | 375 \\u00d7 812 |\\n| `iphonexr` | iPhone XR | 414 \\u00d7 896 |\\n| `iphonexsmax` | iPhone XS Max | 414 \\u00d7 896 |\\n| `iphonese2` | iPhone SE (2nd generation) | 375 \\u00d7 667 |\\n| `iphone12mini` | iPhone 12 mini | 375 \\u00d7 812 |\\n| `iphone12` | iPhone 12 | 390 \\u00d7 844 |\\n| `iphone12promax` | iPhone 12 Pro Max | 428 \\u00d7 926 |\\n| `iphoneSE3` | iPhone SE 3rd generation | 375 \\u00d7 667 |\\n| `iphone13` | iPhone 13 | 390 \\u00d7 844 |\\n| `iphone13pro` | iPhone 13 Pro | 390 \\u00d7 844 |\\n| `iphone13promax` | iPhone 13 Pro Max | 428 \\u00d7 926 |\\n| `iphone14` | iPhone 14 | 390 \\u00d7 844 |\\n| `iphone14pro` | iPhone 14 Pro | 393 \\u00d7 852 |\\n| `iphone14promax` | iPhone 14 Pro Max | 430 \\u00d7 932 |\\n| `galaxys5` | Galaxy S5 | 360 \\u00d7 640 |\\n| `galaxys9` | Galaxy S9 | 360 \\u00d7 740 |\\n| `nexus5x` | Nexus 5X | 412 \\u00d7 668 |\\n| `nexus6p` | Nexus 6P | 412 \\u00d7 732 |\\n| `pixel` | Pixel | 540 \\u00d7 960 |\\n| `pixelxl` | Pixel XL | 720 \\u00d7 1280 |\\n| `mobile1` | Small mobile<br />(also in `MINIMAL_VIEWPORTS`) | 320 \\u00d7 568 |\\n| `mobile2` | Large mobile<br />(also in `MINIMAL_VIEWPORTS`) | 414 \\u00d7 896 |\\n| `ipad` | iPad | 768 \\u00d7 1024 |\\n| `ipad10p` | iPad Pro 10.5-in | 834 \\u00d7 112 |\\n| `ipad11p` | iPad Pro 11-in | 834 \\u00d7 1194 |\\n| `ipad12p` | iPad Pro 12.9-in | 1024 \\u00d7 1366 |\\n| `tablet` | Tablet<br />(also in `MINIMAL_VIEWPORTS`) | 834 \\u00d7 1112 |\\n\\nTo use the detailed set of devices, you can adjust the `options` property in your configuration to include the `INITIAL_VIEWPORTS` export:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-viewport-options-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Add new devices\": \"If the predefined viewports don't meet your needs, you can add new devices to the list of viewports. For example, let's add two Kindle devices to the default set of minimal viewports:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-viewport-add-viewport-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configuring per component or story\": \"In some cases, it's not practical for you to use a specific visual viewport on a global scale, and you need to adjust it to an individual story or set of stories for a component.\\n\\n[Parameters](../writing-stories/parameters.mdx) can be applied at the project, component, and story levels, which allows you to specify the configuration where needed. For example, you can set the available viewports for all of the stories for a component like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-viewport-configuration-in-meta.md\\\" usesCsf3 />\\n\\n{/* prettier-ignore-end */}\"}, \"Defining the viewport for a story\": \"The Viewport module enables you to change the viewport applied to a story by selecting from the list of predefined viewports in the toolbar. If needed, you can set a story to default to a specific viewport by using the `globals` option:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-viewport-define-globals.md\\\" usesCsf3 />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhen you specify a viewport for a story (or a component's stories) using `globals`, the viewport is applied and cannot be changed using the toolbar. This is useful to ensure a story is always rendered on a specific viewport.\\n\\n</Callout>\", \"API\": {\"Keyboard shortcuts\": \"If you need, you can edit these on the shortcuts page.\\n\\n['Next viewport: <kbd>alt</kbd> + <kbd>v</kbd>', 'Previous viewport: <kbd>alt</kbd> + <kbd>shift</kbd> + <kbd>v</kbd>', 'Reset viewport: <kbd>alt</kbd> + <kbd>control</kbd> + <kbd>v</kbd>']\", \"Globals\": {\"`value`\": \"Type: `string`\\n\\nWhen set, the viewport is applied and cannot be changed using the toolbar. Must match the key of one of the [available viewports](#options).\", \"`isRotated`\": \"Type: `boolean`\\n\\nWhen true, the viewport applied will be rotated 90\\u00b0, e.g., from portrait to landscape orientation.\"}, \"Parameters\": {\"`disable`\": \"Type: `boolean`\\n\\nTurn off this module's behavior. This parameter is most useful to allow overriding at more specific levels. For example, if this parameter is set to `true` at the project level, it could be re-enabled by setting it to `false` at the meta (component) or story level.\", \"`options`\": \"Type:\\n\\n```\\n{\\n [key: string]: {\\n name: string;\\n styles: { height: string, width: string };\\n type: 'desktop' | 'mobile' | 'tablet' | 'other';\\n };\\n}\\n```\\n\\nSpecify the available viewports. See [usage example](#add-new-devices) above. The `width` and `height` values must include the unit, e.g. `'320px'`.\"}, \"Exports\": {\"`INITIAL_VIEWPORTS`\": \"Type: `object`\\n\\nThe full set of initial viewports provided by the Viewport module [listed above](#use-a-detailed-set-of-devices).\", \"`MINIMAL_VIEWPORTS`\": \"Type: `object`\\n\\nA minimal set of viewports provided by the Viewport module [listed above](#use-a-detailed-set-of-devices). These are used by default.\"}}}, \"metadata\": {\"title\": \"Viewport\", \"sidebar\": {\"order\": 8, \"title\": \"Viewport\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 8]\"}, {\"title\": \"Get Started\", \"description\": \"Documentation section: get-started\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/get-started\"}, \"subpages\": [{\"title\": \"Browse Stories\", \"description\": null, \"content\": {\"Sidebar and Canvas\": \"A `*.stories.js|ts|svelte` file defines all the stories for a component. Each story has a corresponding sidebar item. When you click on a story, it renders in the Canvas an isolated preview iframe.\\n\\n<Video src=\\\"../_assets/get-started/example-browse-all-stories-optimized.mp4\\\" />\\n\\nNavigate between stories by clicking on them in the sidebar. Try the sidebar search to find a story by name.\\n\\nOr use keyboard shortcuts. Click on the Storybook's menu to see the list of shortcuts available.\\n\\n\", \"Toolbar\": \"Storybook ships with time-saving tools built-in. The toolbar contains tools that allow you to adjust how the story renders in the Canvas:\\n\\n['\\ud83d\\udd0d Zooming visually scales the component so you can check the details.', '\\ud83d\\uddbc Background changes the rendered background behind your component so you can verify how your component renders in different visual contexts.', '\\ud83d\\udcd0 Grid renders your component on top of a grid layout so you can verify if your component is aligned correctly.', '\\ud83d\\udccf Measure toggles a measurement overlay to help you inspect the dimensions of components.', \\\"\\ud83c\\udf9a\\ufe0f Outline displays the component's bounding box so you can verify if your component is positioned correctly.\\\", '\\ud83d\\udcf1 Viewport renders the component in a variety of dimensions and orientations. It\\u2019s ideal for checking the responsiveness of components.']\\n\\n<Video src=\\\"../_assets/get-started/toolbar-walkthrough-optimized.mp4\\\" />\\n\\nThe [\\u201cDocs\\u201d](../writing-docs/index.mdx) page displays auto-generated documentation for components (inferred from the source code). Usage documentation is helpful when sharing reusable components with your team, for example, in an application.\\n\\n\\n\\nThe toolbar is customizable. You can use [globals](../essentials/toolbars-and-globals.mdx) to quickly toggle themes and languages. Or install Storybook toolbar [addons](../configure/user-interface/storybook-addons.mdx) from the community to enable advanced workflows.\", \"Addons\": \"Addons are plugins that extend Storybook's core functionality. You can find them in the addons panel, a reserved place in the Storybook UI below the Canvas. Each tab shows the generated metadata, logs, or static analysis for the selected story by the addon.\\n\\n\\n\\n['**Controls** allows you to interact with a component\\u2019s args (inputs) dynamically. Experiment with alternate configurations of the component to discover edge cases.', '**Actions** help you verify interactions produce the correct outputs via callbacks. For instance, if you view the \\u201cLogged In\\u201d story of the `Header` component, we can verify that clicking the \\u201cLog out\\u201d button triggers the `onLogout` callback, which would be provided by the component that made use of the Header.', '**Interactions** provides a helpful user interface for debugging [interaction tests](../writing-tests/interaction-testing.mdx) with the `play` function.', '**Accessibility** helps you identify [accessibility violations](../writing-tests/accessibility-testing.mdx) in your components.', '**Visual Tests** lets you pinpoint UI bugs in your local development environment by providing instant feedback directly in Storybook.']\\n\\n<Video src=\\\"../_assets/get-started/addons-walkthrough-optimized.mp4\\\" />\\n\\nStorybook is extensible. Our rich ecosystem of addons helps you test, document, and optimize your stories. You can also create an addon to satisfy your workflow requirements. Read more in the [addons section](../addons/index.mdx).\\n\\nIn the next chapter, we'll get your components rendering in Storybook so you can use it to supercharge component development.\", \"Use stories to build UIs\": \"When building apps, one of the biggest challenges is to figure out if a piece of UI already exists in your codebase and how to use it for the new feature you're building.\\n\\nStorybook catalogues all your components and their use cases. Therefore, you can quickly browse it to find what you're looking for.\\n\\nHere's what the workflow looks like:\\n\\n['\\ud83d\\uddc3 Use the sidebar to find a suitable component', '\\ud83d\\udc40 Review its stories to pick a variant that suits your needs', '\\ud83d\\udcdd Copy/paste the story definition into your app code and wire it up to data']\\n\\nYou can access the story definition from the stories file or make it available in your published Storybook using the [Docs addon](../api/doc-blocks/doc-block-source.mdx).\\n\\n\"}, \"metadata\": {\"title\": \"Browse Stories\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"Browse stories\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 0]\"}, {\"title\": \"Conclusion\", \"description\": null, \"content\": {\"root\": [\"Congratulations! You learned the basics. Storybook is the most popular tool for UI component development and documentation. You\\u2019ll be able to transfer these skills to thousands of companies that use Storybook to build UIs including GitHub, Airbnb, and Stripe.\", \"If you\\u2019d like to learn workflows for building app UIs with Storybook, check out our in-depth guides over at the [tutorials](https://storybook.js.org/tutorials/) page. Continue reading for detailed information on how to use Storybook APIs.\", [\"[How to write stories](../writing-stories/index.mdx)\", \"[How to document components and design systems](../writing-docs/index.mdx)\", \"[View example Storybooks from leading companies](https://storybook.js.org/showcase)\"]]}, \"metadata\": {\"title\": \"Conclusion\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 7, \"title\": \"Conclusion\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 1]\"}, {\"title\": \"Get started with Storybook\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Get started with Storybook\", \"sidebar\": {\"order\": 1, \"title\": \"Get Started\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 2]\"}, {\"title\": \"Install Storybook\", \"description\": null, \"content\": {\"Project requirements\": \"Storybook is designed to work with a variety of frameworks and environments. If your project is using one of the packages listed here, please ensure that you have the following versions installed:\\n\\n<div style={{ columns: 2, marginBottom: '1.5rem' }}>\\n- Angular 18+\\n- Lit 3+\\n- Next.js 14+\\n- Node.js 20+\\n- npm 10+\\n- pnpm 9+\\n- Preact 8+\\n- React Native 0.72+\\n- React Native Web 0.19+\\n- Svelte 5+\\n- SvelteKit 1+\\n- TypeScript 4.9+\\n- Vite 5+\\n- Vitest 3+\\n- Vue 3+\\n- Webpack 5+\\n- Yarn 4+\\n</div>\\n\\nAdditionally, the Storybook app supports the following browsers:\\n\\n['Chrome 131+', 'Edge 134+', 'Firefox 136+', 'Safari 18.3+', 'Opera 117+']\\n\\n<details>\\n<summary>How do I use Storybook with older browsers?</summary>\\n\\nYou can use Storybook with older browsers in two ways:\\n\\n['Use a version of Storybook prior to `9.0.0`, which will have less strict requirements.', 'Develop or build your Storybook in [\\\"preview-only\\\" mode](../sharing/publish-storybook.mdx#build-storybook-for-older-browsers), which can be used in older, unsupported browsers.']\\n\\n</details>\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"Run the Setup Wizard\": \"If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../essentials/controls.mdx).\\n\\n\\n\\nIf you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.\\n</IfRenderer>\", \"Start Storybook\": \"Storybook comes with a built-in development server featuring everything you need for project development. Depending on your system configuration, running the `storybook` command will start the local development server, output the address for you, and automatically open the address in a new browser tab where a welcome screen greets you.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-run-dev.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nStorybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may [opt-out](../configure/telemetry.mdx#how-to-opt-out) if you'd not like to share any information.\\n</Callout>\\n\\n\\n\\nThere are some noteworthy items here:\\n\\n['A collection of useful links for more in-depth configuration and customization options you have at your disposal.', 'A second set of links for you to expand your Storybook knowledge and get involved with the ever-growing Storybook community.', 'A few example stories to get you started.']\\n\\n<details>\\n<summary><h3 id=\\\"troubleshooting\\\">Troubleshooting</h3></summary>\\n\\nRun Storybook with other package managers\\n\\nThe Storybook CLI includes support for the industry's popular package managers (e.g., [Yarn](https://yarnpkg.com/), [npm](https://www.npmjs.com/), and [pnpm](https://pnpm.io/)) automatically detecting the one you are using when you initialize Storybook. However, if you want to use a specific package manager as the default, add the `--package-manager` flag to the installation command. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command-custom-package-manager.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe CLI doesn't detect my framework\\n\\nIf you're working with a custom environment setup or need to set up Storybook manually, you can use the `--type` flag to specify the framework you need to use. Listed below are the supported frameworks and examples of how to use them:\\n\\n| Framework | Type |\\n| -------------- | ---------------- |\\n| Angular | `angular` |\\n| Ember | `ember` |\\n| HTML | `html` |\\n| Next.js | `nextjs` |\\n| Preact | `preact` |\\n| Qwik | `qwik` |\\n| React | `react` |\\n| Server | `server` |\\n| Solid | `solid` |\\n| Svelte | `svelte` |\\n| Vue 3 | `vue3` |\\n| Web Components | `web_components` |\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command-manual-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYarn Plug'n'Play (PnP) support with Storybook\\n\\nIf you've enabled Storybook in a project running on a new version of Yarn with [Plug'n'Play](https://yarnpkg.com/features/pnp) (PnP) enabled, you may notice that it will generate `node_modules` with some additional files and folders. This is a known constraint as Storybook relies on some directories (e.g., `.cache`) to store cache files and other data to improve performance and faster builds. You can safely ignore these files and folders, adjusting your `.gitignore` file to exclude them from the version control you're using.\\n\\nRun Storybook with Webpack 4\\n\\nIf you previously installed Storybook in a project that uses Webpack 4, it will no longer work. This is because Storybook now uses Webpack 5 by default. To solve this issue, we recommend you upgrade your project to Webpack 5 and then run the following command to migrate your project to the latest version of Storybook:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-automigrate.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<If notRenderer=\\\"angular\\\">\\n\\n#### Storybook doesn't work with an empty directory\\n\\nBy default, Storybook is configured to detect whether you're initializing it on an empty directory or an existing project. However, if you attempt to initialize Storybook, select a Vite-based framework (e.g., [React](./frameworks/react-vite.mdx)) in a directory that only contains a `package.json` file, you may run into issues with [Yarn Modern](https://yarnpkg.com/getting-started). This is due to how Yarn handles peer dependencies and how Storybook is set up to work with Vite-based frameworks, as it requires the [Vite](https://vitejs.dev/) package to be installed. To solve this issue, you must install Vite manually and initialize Storybook.\\n\\n\\n</If>\\n\\n<IfRenderer renderer=\\\"angular\\\">\\n#### Storybook doesn't work with my Angular project using the Angular CLI\\n\\nOut of the box, adding Storybook to an Angular project using the Angular CLI requires you to run the installation command from the root of the project or, if you're working with a monorepo environment, from the directory where the Angular configuration file (i.e., `angular.json`) is located as it will be used to set up the builder configuration necessary to run Storybook. However, if you need, you can extend the builder configuration to customize Storybook's behavior. To learn more about the available options, see the [Angular framework documentation](./frameworks/angular.mdx#how-do-i-configure-angulars-builder-for-storybook).\\n\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"ember\\\">\\n#### The CLI doesn't support my Ember version\\n\\nThe Ember framework relies on an auxiliary package named [`@storybook/ember-cli-storybook`](https://www.npmjs.com/package/@storybook/ember-cli-storybook) to help you set up Storybook in your project. During the installation process you might run into the following warning message in your terminal:\\n\\n```shell\\nThe ember generate entity-name command requires an entity name to be specified.\\nFor more details, use ember help.\\n```\\n\\nIt may be the case that you're using an outdated version of the package and you need to update it to the latest version to solve this issue.\\n\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"vue\\\">\\n#### Storybook doesn't work with my Vue 2 project\\n\\nVue 2 entered [End of Life](https://v2.vuejs.org/lts/) (EOL) on December 31st, 2023, and is no longer maintained by the Vue team. As a result, Storybook no longer supports Vue 2. We recommend you upgrade your project to Vue 3, which Storybook fully supports. If that's not an option, you can still use Storybook with Vue 2 by installing the latest version of Storybook 7 with the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-init-v7.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"svelte\\\">\\n#### Writing native Svelte stories\\n\\nStorybook provides a Svelte [addon](https://storybook.js.org/addons/@storybook/addon-svelte-csf) maintained by the community, enabling you to write stories for your Svelte components using the template syntax. Starting with Storybook 8.2, the addon is automatically installed and configured when you initialize your project with the Svelte framework. However, if you installed a [specific version](#custom-storybook-version) of Storybook, you'll need to take additional steps to enable this feature.\\n\\nRun the following command to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\n The CLI's [`add`](../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\\n\\nUpdate your Storybook configuration file (i.e., `.storybook/main.js|ts`) to enable support for this format.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-svelte-csf-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" style={{ marginBottom: \\\"2rem\\\" }}>\\n The community actively maintains the Svelte CSF addon but still lacks some features currently available in the official Storybook Svelte framework support. For more information, see the [addon's documentation](https://github.com/storybookjs/addon-svelte-csf).\\n</Callout>\\n\\n</IfRenderer>\\n\\nThe installation process seems flaky and keeps failing\\n\\nIf you're still running into some issues during the installation process, we encourage you to check out the following resources:\\n\\n<IfRenderer renderer=\\\"angular\\\">\\n* Storybook's Angular [framework documentation](./frameworks/angular.mdx) for more information on how to set up Storybook in your Angular project.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"ember\\\">\\n* [Storybook's Ember README](https://github.com/storybookjs/storybook/tree/next/code/frameworks/ember) for more information on how to set up Storybook in your Ember project.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"html\\\">\\n* [Storybook's HTML Vite README](https://github.com/storybookjs/storybook/tree/next/code/frameworks/html-vite) for more information on how to set up Storybook in your HTML project with Vite.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"preact\\\">\\n* Storybook's Preact Vite [framework documentation](./frameworks/preact-vite.mdx) for more information on how to set up Storybook in your Preact project with Vite.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"qwik\\\">\\n* [Storybook's Qwik README](https://github.com/literalpie/storybook-framework-qwik) for more information on how to set up Storybook in your Qwik project.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"react\\\">\\n* Storybook's React Vite [framework documentation](./frameworks/react-vite.mdx) for more information on how to set up Storybook in your React project with Vite.\\n* Storybook's React Webpack [framework documentation](./frameworks/react-webpack5.mdx) for more information on how to set up Storybook in your React project with Webpack 5.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"solid\\\">\\n* [Storybook's SolidJS README](https://github.com/solidjs-community/storybook) for more information on how to set up Storybook in your SolidJS project.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"svelte\\\">\\n* Storybook's SvelteKit [framework documentation](./frameworks/sveltekit.mdx) for more information on how to set up Storybook in your SvelteKit project.\\n* Storybook's Svelte Vite [framework documentation](./frameworks/svelte-vite.mdx) for more information on how to set up Storybook in your Svelte project with Vite.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"vue\\\">\\n* Storybook's Vue 3 Vite [framework documentation](./frameworks/vue3-vite.mdx) for more information on how to set up Storybook in your Vue 3 project with Vite.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"web-components\\\">\\n* Storybook's Web Components Vite [framework documentation](./frameworks/web-components-vite.mdx) for more information on how to set up Storybook in your Web Components project with Vite.\\n* [Storybook's help documentation](https://storybook.js.org/community#support) to contact the community and ask for help.\\n</IfRenderer>\\n</details>\\n\\n<IfRenderer renderer=\\\"react\\\">\\nNow that you have successfully installed Storybook and understood how it works, let's continue where you left off in the [setup wizard](#run-the-setup-wizard) and delve deeper into writing stories.\\n</IfRenderer>\\n\\n<IfRenderer renderer={['angular', 'vue', 'web-components', 'ember', 'html', 'svelte', 'preact', 'qwik', 'solid' ]}>\\nNow that you installed Storybook successfully, let\\u2019s take a look at a story that was written for us.\\n</IfRenderer>\"}, \"metadata\": {\"title\": \"Install Storybook\", \"sidebar\": {\"order\": 2, \"title\": \"Install\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 3]\"}, {\"title\": \"Setup Storybook\", \"description\": null, \"content\": {\"Render component styles\": \"Storybook isn\\u2019t opinionated about how you generate or load CSS. It renders whatever DOM elements you provide. But sometimes, things won\\u2019t \\u201clook right\\u201d out of the box.\\n\\nYou may have to configure your CSS tooling for Storybook\\u2019s rendering environment. Here are some setup guides for popular tools in the community.\\n\\n['[Tailwind](https://storybook.js.org/recipes/tailwindcss/)', '[Material UI](https://storybook.js.org/recipes/@mui/material/)', '[Vuetify](https://storybook.js.org/recipes/vuetify/)', '[Styled Components](https://storybook.js.org/recipes/styled-components/)', '[Emotion](https://storybook.js.org/recipes/@emotion/styled/)', '[Sass](https://storybook.js.org/recipes/sass/)', '[Bootstrap](https://storybook.js.org/recipes/bootstrap/)', '[Less](https://storybook.js.org/recipes/less/)', '[Vanilla-extract](https://storybook.js.org/recipes/@vanilla-extract/css/)']\\n\\nDon't see the tool that you're looking for? Check out the [styling and css](../configure/styling-and-css.mdx) page for more details.\", \"Configure Storybook for your stack\": \"Storybook comes with a permissive [default configuration](../configure/index.mdx). It attempts to customize itself to fit your setup. But it\\u2019s not foolproof.\\n\\nYour project may have additional requirements before components can be rendered in isolation. This warrants customizing configuration further. There are three broad categories of configuration you might need.\\n\\n<details>\\n<summary>Build configuration like Webpack and Babel</summary>\\n\\nIf you see errors on the CLI when you run the `yarn storybook` command, you likely need to make changes to Storybook\\u2019s build configuration. Here are some things to try:\\n\\n['[Presets](../addons/addon-types.mdx) bundle common configurations for various technologies into Storybook. In particular, presets exist for Create React App and Ant Design.', 'Specify a custom [Babel configuration](../configure/integration/compilers.mdx#babel) for Storybook. Storybook automatically tries to use your project\\u2019s config if it can.', 'Adjust the [Webpack configuration](../builders/webpack.mdx) that Storybook uses. Try patching in your own configuration if needed.\\\\n</details>']\\n\\n<details>\\n<summary>Runtime configuration</summary>\\n\\nIf Storybook builds but you see an error immediately when connecting to it in the browser, in that case, chances are one of your input files is not compiling/transpiling correctly to be interpreted by the browser. Storybook supports evergreen browsers, but you may need to check the Babel and Webpack settings (see above) to ensure your component code works correctly.\\n</details>\\n\\n<details id=\\\"component-context\\\" name=\\\"component-context\\\">\\n<summary>Component context</summary>\\n\\nIf a particular story has a problem rendering, often it means your component expects a specific environment is available to the component.\\n\\nA common frontend pattern is for components to assume that they render in a specific \\u201ccontext\\u201d with parent components higher up the rendering hierarchy (for instance, theme providers).\\n\\nUse [decorators](../writing-stories/decorators.mdx) to \\u201cwrap\\u201d every story in the necessary context providers. The [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) file allows you to customize how components render in Canvas, the preview iframe. See how you can wrap every component rendered in Storybook with [Styled Components](https://styled-components.com/) `ThemeProvider`, [Vue's Fontawesome](https://github.com/FortAwesome/vue-fontawesome), or with an Angular theme provider component in the example below.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-with-styled-components-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</details>\", \"Load assets and resources\": \"We recommend serving external resources and assets requested in your components statically with Storybook. It ensures that assets are always available to your stories. Read our [documentation](../configure/integration/images-and-assets.mdx) to learn how to host static files with Storybook.\"}, \"metadata\": {\"title\": \"Setup Storybook\", \"sidebar\": {\"order\": 6, \"title\": \"Setup\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 4]\"}, {\"title\": \"What's a story?\", \"description\": null, \"content\": {\"Working with stories\": {\"Create a new story\": \"<If renderer=\\\"react\\\">\\nIf you're working on a component that does not yet have any stories, you can click the \\u2795 button in the sidebar to search for your component and have a basic story created for you.\\n\\n <Video src=\\\"../_assets/get-started/new-component-story-from-plus-button-optimized.mp4\\\" />\\n\\nYou can also create a story file for your new story. We recommend copy/pasting an existing story file next to the component source file, then adjusting it for your component.\\n</If>\\n\\n<If renderer=\\\"svelte\\\">\\n\\n<Callout variant=\\\"info\\\">\\n\\nThis feature is not supported with the Svelte template syntax story format. To opt-in to this feature with Svelte, you must use Storybook's [Component Story Format](../api/csf.mdx).\\n\\n\\n</Callout>\\n\\n</If>\\n\\n<If notRenderer=\\\"react\\\">\\nIf you're working on a component that does not yet have any stories, you can create a story file for your component with a new story. We recommend copy/pasting an existing story file next to the component source file, then adjusting it for your component.\\n</If>\\n\\n<Video src=\\\"../_assets/get-started/new-component-story-in-code-optimized.mp4\\\" />\\n\\nIf you're working on a component that already has other stories, you can use the [Controls panel](../essentials/controls.mdx) to adjust the value of a control and then save those changes as a new story.\\n\\n<Video src=\\\"../_assets/get-started/new-story-from-controls-optimized.mp4\\\" />\\n\\nOr, if you prefer, edit the story file's code to add a new named export for your story:\\n\\n<Video src=\\\"../_assets/get-started/new-story-in-code-optimized.mp4\\\" />\", \"Edit a story\": \"Using the [Controls panel](../essentials/controls.mdx), update a control's value for a story. You can then save the changes to the story and the story file's code will be updated for you.\\n\\n<Video src=\\\"../_assets/get-started/edit-story-from-controls-optimized.mp4\\\" />\\n\\nOf course, you can always update the story's code directly too:\\n\\n<Video src=\\\"../_assets/get-started/edit-story-in-code-optimized.mp4\\\" />\\n\\nStories are also helpful for checking that UI continues to look correct as you make changes. The `Button` component has four stories that show it in different use cases. View those stories now to confirm that your change to `Primary` didn\\u2019t introduce unintentional bugs in the other stories.\\n\\n<Video src=\\\"../_assets/get-started/example-button-browse-stories-optimized.mp4\\\" />\\n\\nChecking component\\u2019s stories as you develop helps prevent accidental regressions. [Tools that integrate with Storybook can automate this](../writing-tests/index.mdx) for you.\\n\\nNow that we\\u2019ve seen the basic anatomy of a story let\\u2019s see how we use Storybook\\u2019s UI to develop stories.\"}}, \"metadata\": {\"title\": \"What's a story?\", \"sidebar\": {\"order\": 4, \"title\": \"What's a story?\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 5]\"}, {\"title\": \"Why Storybook?\", \"description\": null, \"content\": {\"The problem\": \"The web\\u2019s universality is pushing more complexity into the frontend. It began with responsive web design, which turned every user interface from one to 10, 100, 1000 different user interfaces. Over time, additional requirements piled on like devices, browsers, accessibility, performance, and async states.\\n\\nComponent-driven tools like React, Vue 3, and Angular help break down complex UIs into simple components but they\\u2019re not silver bullets. As frontends grow, the number of components swells. Mature projects can contain hundreds of components that yield thousands of discrete variations.\\n\\nTo complicate matters further, those UIs are painful to debug because they\\u2019re entangled in business logic, interactive states, and app context.\\n\\nThe breadth of modern frontends overwhelm existing workflows. Developers must consider countless UI variations, yet aren\\u2019t equipped to develop or organize them all. You end up in a situation where UIs are tougher to build, less satisfying to work on, and brittle.\\n\\n\", \"The solution\": {\"Build UIs in isolation\": \"Every piece of UI is now a [component](https://www.componentdriven.org/). The superpower of components is that you don't need to spin up the whole app just to see how they render. You can render a specific variation in isolation by passing in props, mocking data, or faking events.\\n\\nStorybook is packaged as a small, development-only, [workshop](https://bradfrost.com/blog/post/a-frontend-workshop-environment/) that lives alongside your app. It provides an isolated iframe to render components without interference from app business logic and context. That helps you focus development on each variation of a component, even the hard-to-reach edge cases.\\n\\n<Video src=\\\"../_assets/get-started/whats-a-story.mp4\\\" />\", \"Capture UI variations as \\u201cstories\\u201d\": \"When developing a component variation in isolation, save it as a story. [Stories](https://github.com/ComponentDriven/csf) are a declarative syntax for supplying props and mock data to simulate component variations. Each component can have multiple stories. Each story allows you to demonstrate a specific variation of that component to verify appearance and behavior.\\n\\nYou write stories for granular UI component variation and then use those stories in development, testing, and documentation.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"histogram-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Storybook keeps track of every story\": \"Storybook is an interactive directory of your UI components and their stories. In the past, you'd have to spin up the app, navigate to a page, and contort the UI into the right state. This is a huge waste of time and bogs down frontend development. With Storybook, you can skip all those steps and jump straight to working on a UI component in a specific state.\\n\\n<Video src=\\\"../_assets/get-started/histogram-stories-optimized.mp4\\\" />\\n\\n<details>\\n<summary>Where does Storybook fit into my project?</summary>\\n\\nStorybook is packaged as a small, development-only, [workshop](https://bradfrost.com/blog/post/a-frontend-workshop-environment/) that lives alongside your app. Install it by [running a command](../get-started/install.mdx).\\n\\nDuring development, run it in a separate node process. If you\\u2019re working on UI in isolation, the only thing you\\u2019ll need to run is Storybook.\\n</details>\\n\\n<details>\\n<summary>Does Storybook work with my favorite libraries?</summary>\\n\\nStorybook aims to integrate with industry-standard tools and platforms to simplify setup. Thanks to our ambitious developer community, we\\u2019ve made significant progress. There are hundreds of [addons](https://storybook.js.org/addons/) and tutorials that walk through how to set up Storybook in all types of projects.\\n\\nIf you\\u2019re using a niche framework or a recently launched tool, we might not have an integration for it yet. Consider creating a [proof of concept](../addons/writing-addons.mdx) yourself first to lead the way for the rest of the community.\\n</details>\\n\\n<details>\\n<summary>What\\u2019s the recommended Storybook workflow?</summary>\\n\\nEvery team is different and so is their workflow. Storybook is designed to be incrementally adoptable. Teams can gradually try features to see what works best for them.\\n\\nMost community members choose a [Component-Driven](https://www.componentdriven.org/) workflow. UIs are developed in isolation from the \\u201cbottom up\\u201d starting with basic components then progressively combined to assemble pages.\\n\\n['Build each component in isolation and write stories for its variations.', 'Compose small components together to enable more complex functionality.', 'Assemble pages by combining composite components.', 'Integrate pages into your project by hooking up data and business logic.\\\\n</details>']\"}, \"Benefits\": \"When you write stories for components, you get a bunch of additional benefits for free.\\n\\n**\\ud83d\\udcdd Develop UIs that are more durable**\\n\\nIsolate components and pages and track their use cases as [stories](../writing-stories/index.mdx). Verify hard-to-reach edge cases of UI. Use addons to mock everything a component needs\\u2014context, API requests, device features, etc.\\n\\n**\\u2705 Test UIs with less effort and no flakes**\\n\\nStories are a pragmatic, reproducible way of tracking UI states. Use them to spot-test the UI during development. Storybook offers built-in workflows for automated [Interaction](../writing-tests/interaction-testing.mdx), [Accessibility](../writing-tests/accessibility-testing.mdx), and [Visual](../writing-tests/visual-testing.mdx) testing. Or use stories as test cases by [importing them into other JavaScript testing tools](../writing-tests/integrations/stories-in-unit-tests.mdx).\\n\\n**\\ud83d\\udcda Document UI for your team to reuse**\\n\\nStorybook is the single source of truth for your UI. Stories index all your components and their various states, making it easy for your team to find and reuse existing UI patterns. Storybook also auto-generates [documentation](../writing-docs/index.mdx) from those stories.\\n\\n**\\ud83d\\udce4 Share how the UI actually works**\\n\\nStories show how UIs actually work, not just a picture of how they're supposed to work. That keeps everyone aligned on what's currently in production. [Publish Storybook](../sharing/publish-storybook.mdx) to get sign-off from teammates. Or [embed](../sharing/embed.mdx) them in wikis, Markdown, and Figma to streamline collaboration.\\n\\n**\\ud83d\\udea6Automate UI workflows**\\n\\nStorybook is compatible with your continuous integration workflow. Add it as a CI step to automate user interface testing, review implementation with teammates, and get signoff from stakeholders.\", \"Write stories once, reuse everywhere\": \"Storybook is powered by [Component Story Format](https://github.com/ComponentDriven/csf), an open standard based on JavaScript ES6 modules. This enables stories to interoperate between development, testing, and design tools. Each story is exported as a JavaScript function enabling you to reuse it with other tools. No vendor lock-in.\\n\\nReuse stories with [Jest](https://jestjs.io/) or [Vitest](https://vitest.dev/) and [Testing Library](https://testing-library.com/) to verify interactions. Put them in [Chromatic](https://www.chromatic.com/?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook) for visual testing. Audit story accessibility with [Axe](https://github.com/dequelabs/axe-core). Or test user flows with [Playwright](https://playwright.dev/) and [Cypress](https://www.cypress.io/). Reuse unlocks more workflows at no extra cost.\\n\\n[]\\n\\nStorybook is purpose-built to help you develop complex UIs faster with greater durability and lower maintenance. It\\u2019s used by 100s of [leading companies](https://storybook.js.org/showcase) and thousands of [developers](https://github.com/storybookjs/storybook/).\"}, \"metadata\": {\"title\": \"Why Storybook?\", \"sidebar\": {\"order\": 1, \"title\": \"Why Storybook?\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 6]\"}, {\"title\": \"Frameworks\", \"description\": \"Documentation section: frameworks\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/get-started/frameworks\"}, \"subpages\": [{\"title\": \"Storybook for Angular\", \"description\": null, \"content\": {\"Requirements\": [\"Angular \\u2265 18.0 \\\\< 21.0\", \"Webpack \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Angular project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/angular`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"angular-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"angular-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, update your `angular.json` to include the Storybook builder:\\n\\n```\\n{\\n \\\"projects\\\": {\\n \\\"your-project\\\": {\\n \\\"architect\\\": {\\n \\\"storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:start-storybook\\\",\\n \\\"options\\\": {\\n // The path to the storybook config directory\\n \\\"configDir\\\": \\\".storybook\\\",\\n // The build target of your project\\n \\\"browserTarget\\\": \\\"your-project:build\\\",\\n // The port you want to start Storybook on\\n \\\"port\\\": 6006\\n // More options available, documented here:\\n // https://github.com/storybookjs/storybook/tree/next/code/frameworks/angular/src/builders/start-storybook/schema.json\\n }\\n },\\n \\\"build-storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:build-storybook\\\",\\n \\\"options\\\": {\\n \\\"configDir\\\": \\\".storybook\\\",\\n \\\"browserTarget\\\": \\\"your-project:build\\\",\\n \\\"outputDir\\\": \\\"dist/storybook/your-project\\\"\\n // More options available, documented here:\\n // https://github.com/storybookjs/storybook/tree/next/code/frameworks/angular/src/builders/build-storybook/schema.json\\n }\\n }\\n }\\n }\\n }\\n}\\n```\"}}, \"Run Storybook\": \"To run Storybook for a particular project, please run the following:\\n\\n```\\nng run <your-project>:storybook\\n```\\n\\nTo build Storybook, run:\\n\\n```\\nng run <your-project>:build-storybook\\n```\\n\\nYou will find the output in the configured `outputDir` (default is `dist/storybook/<your-project>`).\", \"Setup Compodoc\": {\"Automatic setup\": \"When installing Storybook via `npx storybook@latest init`, you can set up Compodoc automatically.\", \"Manual setup\": \"If you have already installed Storybook, you can set up Compodoc manually.\\n\\nInstall the following dependencies:\\n\\n```\\nnpm install --save-dev @compodoc/compodoc\\n```\\n\\nAdd the following option to your Storybook Builder:\\n\\n```\\n{\\n \\\"projects\\\": {\\n \\\"your-project\\\": {\\n \\\"architect\\\": {\\n \\\"storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:start-storybook\\\",\\n \\\"options\\\": {\\n // \\ud83d\\udc47 Add these\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\n \\\"-e\\\",\\n \\\"json\\\",\\n \\\"-d\\\",\\n // Where to store the generated documentation. It's usually the root of your Angular project. It's not necessarily the root of your Angular Workspace!\\n \\\".\\\"\\n ],\\n }\\n },\\n \\\"build-storybook\\\": {\\n \\\"builder\\\": \\\"@storybook/angular:build-storybook\\\",\\n \\\"options\\\": {\\n // \\ud83d\\udc47 Add these\\n \\\"compodoc\\\": true,\\n \\\"compodocArgs\\\": [\\n \\\"-e\\\",\\n \\\"json\\\",\\n \\\"-d\\\",\\n \\\".\\\"\\n ],\\n }\\n }\\n }\\n }\\n }\\n}\\n```\\n\\nGo to your `.storybook/preview.ts` and add the following:\\n\\n```\\nimport type { Preview } from '@storybook/angular';\\n\\n// \\ud83d\\udc47 Add these\\nimport { setCompodocJson } from '@storybook/addon-docs/angular';\\nimport docJson from '../documentation.json';\\nsetCompodocJson(docJson);\\n\\nconst preview: Preview = {};\\nexport default preview;\\n```\"}, \"`applicationConfig` decorator\": \"If your component relies on application-wide providers, like the ones defined by [`BrowserAnimationsModule`](https://angular.dev/api/platform-browser/animations/BrowserAnimationsModule) or any other modules that use the forRoot pattern to provide a [`ModuleWithProviders`](https://angular.dev/api/core/ModuleWithProviders), you can apply the `applicationConfig` [decorator](../../writing-stories/decorators.mdx) to all stories for that component. This will provide them with the [bootstrapApplication function](https://angular.io/guide/standalone-components#configuring-dependency-injection), used to bootstrap the component in Storybook.\\n\\n```\\nimport { Meta, applicationConfig, StoryObj } from '@storybook/angular';\\n\\nimport { BrowserAnimationsModule, provideAnimations } from '@angular/platform-browser/animations';\\nimport { importProvidersFrom } from '@angular/core';\\n\\nimport { ChipsModule } from './angular-src/chips.module';\\n\\nconst meta: Meta<ChipsModule> = {\\n component: ChipsModule,\\n decorators: [\\n // Apply application config to all stories\\n applicationConfig({\\n // List of providers and environment providers that should be available to the root component and all its children.\\n providers: [\\n ...\\n // Import application-wide providers from a module\\n importProvidersFrom(BrowserAnimationsModule)\\n // Or use provide-style functions if available instead, e.g.\\n provideAnimations()\\n ],\\n }),\\n ],\\n};\\n\\nexport default meta;\\ntype Story = StoryObj<ChipsModule>;\\n\\nexport const WithCustomApplicationProvider: Story = {\\n render: () => ({\\n // Apply application config to a specific story\\n applicationConfig: {\\n // The providers will be merged with the ones defined in the applicationConfig decorator's providers array of the global meta object\\n providers: [...],\\n }\\n })\\n}\\n```\", \"`moduleMetadata` decorator\": \"If your component has dependencies on other Angular directives and modules, these can be supplied using the `moduleMetadata` [decorator](../../writing-stories/decorators.mdx) either for all stories of a component or for individual stories.\\n\\n```\\nimport { Meta, moduleMetadata, StoryObj } from '@storybook/angular';\\n\\nimport { YourComponent } from './your.component';\\n\\nconst meta: Meta<YourComponent> = {\\n component: YourComponent,\\n decorators: [\\n // Apply metadata to all stories\\n moduleMetadata({\\n // import necessary ngModules or standalone components\\n imports: [...],\\n // declare components that are used in the template\\n declarations: [...],\\n // List of providers that should be available to the root component and all its children.\\n providers: [...],\\n }),\\n ],\\n};\\nexport default meta;\\ntype Story = StoryObj<YourComponent>;\\n\\nexport const Base: Story = {};\\n\\nexport const WithCustomProvider: Story = {\\n decorators: [\\n // Apply metadata to a specific story\\n moduleMetadata({\\n imports: [...],\\n declarations: [...],\\n providers: [...],\\n }),\\n ],\\n};\\n```\", \"FAQ\": {\"How do I migrate to an Angular Storybook builder?\": {\"Do you have only one Angular project in your workspace?\": \"First, go to your `angular.json` and add `storybook` and `build-storybook` entries in your project's `architect` section, as shown [above](#manual-setup).\\n\\nSecond, adjust your `package.json` script section. Usually, it will look like this:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"storybook\\\": \\\"start-storybook -p 6006\\\", // or `storybook dev -p 6006`\\n \\\"build-storybook\\\": \\\"build-storybook\\\" // or `storybook build`\\n }\\n}\\n```\\n\\nNow, you can run Storybook with `ng run <your-project>:storybook` and build it with `ng run <your-project>:build-storybook`. Adjust the scripts in your `package.json` accordingly.\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"storybook\\\": \\\"ng run <project-name>:storybook\\\",\\n \\\"build-storybook\\\": \\\"ng run <project-name>:build-storybook\\\"\\n }\\n}\\n```\\n\\nAlso, `compodoc` is now built into `@storybook/angular`; you don't have to call it explicitly. If we're running `compodoc` in your `package.json` scripts like this:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"docs:json\\\": \\\"compodoc -p tsconfig.json -e json -d ./documentation\\\",\\n \\\"storybook\\\": \\\"npm run docs:json && start-storybook -p 6006\\\",\\n \\\"build-storybook\\\": \\\"npm run docs:json && build-storybook\\\"\\n }\\n}\\n```\\n\\nChange it to:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"storybook\\\": \\\"ng run <project-name>:storybook\\\",\\n \\\"build-storybook\\\": \\\"ng run <project-name>:build-storybook\\\"\\n }\\n}\\n```\", \"I have multiple projects in my Angular workspace\": \"In this case, you have to adjust your `angular.json` and `package.json` as described above for each project you want to use Storybook. Please note that each project should have a dedicated `.storybook` folder placed at the project's root.\\n\\nYou can run `npx storybook@latest init` sequentially for each project to set up Storybook for each of them to automatically create the `.storybook` folder and create the necessary configuration in your `angular.json`.\\n\\nYou can then combine multiple Storybooks with [Storybook composition](../../sharing/storybook-composition.mdx).\"}, \"How do I configure Angular's builder for Storybook?\": \"These are common options you may need for the Angular builder:\\n\\n| Configuration element | Description |\\n| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `\\\"browserTarget\\\"` | Build target to be served using the following format. <br /> `\\\"example-project:builder:config\\\"` |\\n| `\\\"debugWebpack\\\"` | Debug the Webpack configuration <br /> `\\\"debugWebpack\\\": true` |\\n| `\\\"tsConfig\\\"` | Location of the TypeScript configuration file relative to the current workspace. <br /> `\\\"tsConfig\\\": \\\"./tsconfig.json\\\"`. |\\n| `\\\"preserveSymlinks\\\"` | Do not use the real path when resolving modules. If true, symlinks are resolved to their real path; otherwise, they are resolved to their symlinked path. <br /> `\\\"preserveSymlinks\\\": true` |\\n| `\\\"port\\\"` | Port used by Storybook. <br /> `\\\"port\\\": 6006` |\\n| `\\\"host\\\"` | Set up a custom host for Storybook. <br /> `\\\"host\\\": \\\"http://my-custom-host\\\"` |\\n| `\\\"configDir\\\"` | Storybook configuration directory location. <br /> `\\\"configDir\\\": \\\".storybook\\\"` |\\n| `\\\"https\\\"` | Starts Storybook with HTTPS enabled. <br /> `\\\"https\\\": true` <br /> Requires custom certificate information. |\\n| `\\\"sslCa\\\"` | Provides an SSL certificate authority. <br /> `\\\"sslCa\\\": \\\"your-custom-certificate-authority\\\"` <br /> Optional usage with `\\\"https\\\"` |\\n| `\\\"sslCert\\\"` | Provides an SSL certificate. <br /> `\\\"sslCert\\\": \\\"your-custom-certificate\\\"` <br /> Required for `https` |\\n| `\\\"sslKey\\\"` | Provides an SSL key to serve Storybook. <br /> `\\\"sslKey\\\": \\\"your-ssl-key\\\"` |\\n| `\\\"smokeTest\\\"` | Exit Storybook after successful start. <br /> `\\\"smokeTest\\\": true` |\\n| `\\\"ci\\\"` | Starts Storybook in CI mode (skips interactive prompts and will not open browser window). <br /> `\\\"ci\\\": true` |\\n| `\\\"open\\\"` | Whether to open Storybook automatically in the browser. <br /> `\\\"open\\\": true` |\\n| `\\\"quiet\\\"` | Filters Storybook verbose build output. <br /> `\\\"quiet\\\": true` |\\n| `\\\"enableProdMode\\\"` | Disable Angular's development mode, which turns off assertions and other checks within the framework. <br /> `\\\"enableProdMode\\\": true` |\\n| `\\\"docs\\\"` | Starts Storybook in [documentation mode](../../writing-docs/build-documentation.mdx#preview-storybooks-documentation). <br /> `\\\"docs\\\": true` |\\n| `\\\"compodoc\\\"` | Execute compodoc before. <br /> `\\\"compodoc\\\": true` |\\n| `\\\"compodocArgs\\\"` | Compodoc [options](https://compodoc.app/guides/options.html). Options `-p` with tsconfig path and `-d` with workspace root is always given. <br /> `\\\"compodocArgs\\\": [\\\"-e\\\", \\\"json\\\"]` |\\n| `\\\"styles\\\"` | Provide the location of the [application's styles](../../configure/styling-and-css.mdx#global-styles) to be used with Storybook. <br /> `\\\"styles\\\": [\\\"src/styles.css\\\", \\\"src/styles.scss\\\"]` |\\n| `\\\"stylePreprocessorOptions\\\"` | Provides further customization for style preprocessors resolved to the workspace root. <br /> `\\\"stylePreprocessorOptions\\\": { \\\"includePaths\\\": [\\\"src/styles\\\"] }` |\\n| `\\\"assets\\\"` | List of static application assets. <br /> `\\\"assets\\\": [\\\"src/assets\\\"]` |\\n| `\\\"initialPath\\\"` | URL path to be appended when visiting Storybook for the first time. <br /> `\\\"initialPath\\\": \\\"docs/configure-your-project--docs\\\"` |\\n| `\\\"webpackStatsJson\\\"` | Write Webpack Stats JSON to disk. <br /> `\\\"webpackStatsJson\\\": true` |\\n| `\\\"previewUrl\\\"` | Disables the default storybook preview and lets you use your own. <br /> `\\\"previewUrl\\\": \\\"iframe.html\\\"` |\\n| `\\\"loglevel\\\"` | Controls level of logging during build. Can be one of: [silly, verbose, info (default), warn, error, silent]. <br /> `\\\"loglevel\\\": \\\"info\\\"` |\\n| `\\\"sourceMap\\\"` | Configure [sourcemaps](https://angular.io/guide/workspace-config#source-map-configuration.). <br /> `\\\"sourceMap\\\": true` |\\n\\nThe full list of options can be found in the Angular builder schemas:\\n\\n['[Build Storybook](https://github.com/storybookjs/storybook/blob/main/code/frameworks/angular/src/builders/build-storybook/schema.json)', '[Start Storybook](https://github.com/storybookjs/storybook/blob/main/code/frameworks/angular/src/builders/start-storybook/schema.json)']\"}, \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Webpack builder docs](../../builders/webpack.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for Angular\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 1, \"title\": \"Angular\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"Frameworks\", \"description\": null, \"content\": {\"root\": [\"<HomeRenderers />\"]}, \"metadata\": {\"title\": \"Frameworks\", \"sidebar\": {\"order\": 3, \"title\": \"Frameworks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"Storybook for Next.js\", \"description\": null, \"content\": {\"Requirements\": [\"Next.js \\u2265 14.1\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Next.js project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/nextjs`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, if you were using Storybook plugins to integrate with Next.js, those are no longer necessary when using this framework and can be removed:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-remove-addons.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"With Vite\": \"Storybook recommends using the `@storybook/nextjs-vite` framework, which is based on Vite and removes the need for Webpack and Babel. It supports all of the features documented here.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf your Storybook configuration contains custom Webpack operations in [`webpackFinal`](../../api/main-config/main-config-webpack-final.mdx), you will likely need to create equivalents in [`viteFinal`](../../api/main-config/main-config-vite-final.mdx).\\n\\nFor more information, see the [Vite builder documentation](../../builders/vite.mdx#migrating-from-webpack).\\n</Callout>\\n\\nFinally, if you were using Storybook plugins to integrate with Next.js, those are no longer necessary when using this framework and can be removed:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-vite-remove-addons.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"Run the Setup Wizard\": \"If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).\\n\\n\\n\\nIf you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.\", \"Next.js's Image component\": {\"Local images\": \"[Local images](https://nextjs.org/docs/pages/building-your-application/optimizing/images#local-images) are supported.\\n\\n```\\nimport Image from 'next/image';\\nimport profilePic from '../public/me.png';\\n\\nfunction Home() {\\n return (\\n <>\\n <h1>My Homepage</h1>\\n <Image\\n src={profilePic}\\n alt=\\\"Picture of the author\\\"\\n // width={500} automatically provided\\n // height={500} automatically provided\\n // blurDataURL=\\\"../public/me.png\\\" set to equal the image itself (for this framework)\\n // placeholder=\\\"blur\\\" // Optional blur-up while loading\\n />\\n <p>Welcome to my homepage!</p>\\n </>\\n );\\n}\\n```\", \"Remote images\": \"[Remote images](https://nextjs.org/docs/pages/building-your-application/optimizing/images#remote-images) are also supported.\\n\\n```\\nimport Image from 'next/image';\\n\\nexport default function Home() {\\n return (\\n <>\\n <h1>My Homepage</h1>\\n <Image src=\\\"/me.png\\\" alt=\\\"Picture of the author\\\" width={500} height={500} />\\n <p>Welcome to my homepage!</p>\\n </>\\n );\\n}\\n```\"}, \"Next.js font optimization\": {\"`next/font/google`\": \"You don't have to do anything. `next/font/google` is supported out of the box.\", \"`next/font/local`\": {\"`staticDir` mapping\": \"<Callout variant=\\\"info\\\">\\nYou can safely skip this section if you are using [`@storybook/nextjs-vite`](#with-vite) instead of `@storybook/nextjs`. The Vite-based framework takes care of the mapping automatically.\\n</Callout>\\n\\nYou have to tell Storybook where the `fonts` directory is located, via the [`staticDirs` configuration](../../api/main-config/main-config-static-dirs.mdx#with-configuration-objects). The `from` value is relative to the `.storybook` directory. The `to` value is relative to the execution context of Storybook. Very likely it is the root of your project.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-image-static-dirs.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Not supported features of `next/font`\": \"The following features are not supported (yet). Support for these features might be planned for the future:\\n\\n['[Support font loaders configuration in next.config.js](https://nextjs.org/docs/pages/building-your-application/optimizing/fonts#local-fonts)', '[fallback](https://nextjs.org/docs/pages/api-reference/components/font#fallback) option', '[adjustFontFallback](https://nextjs.org/docs/pages/api-reference/components/font#adjustfontfallback) option', '[preload](https://nextjs.org/docs/pages/api-reference/components/font#preload) option gets ignored. Storybook handles Font loading its own way.', '[display](https://nextjs.org/docs/pages/api-reference/components/font#display) option gets ignored. All fonts are loaded with display set to \\\"block\\\" to make Storybook load the font properly.']\", \"Mocking fonts during testing\": \"Occasionally fetching fonts from Google may fail as part of your Storybook build step. It is highly recommended to mock these requests, as those failures can cause your pipeline to fail as well. Next.js [supports mocking fonts](https://github.com/vercel/next.js/blob/725ddc7371f80cca273779d37f961c3e20356f95/packages/font/src/google/fetch-css-from-google-fonts.ts#L36) via a JavaScript module located where the env var `NEXT_FONT_GOOGLE_MOCKED_RESPONSES` references.\\n\\nFor example, using [GitHub Actions](https://www.chromatic.com/docs/github-actions):\\n\\n```\\n- uses: chromaui/action@latest\\n env:\\n #\\ud83d\\udc47 the location of mocked fonts to use\\n NEXT_FONT_GOOGLE_MOCKED_RESPONSES: ${{ github.workspace }}/mocked-google-fonts.js\\n with:\\n projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}\\n token: ${{ secrets.GITHUB_TOKEN }}\\n```\\n\\nYour mocked fonts will look something like this:\\n\\n```\\n//\\ud83d\\udc47 Mocked responses of google fonts with the URL as the key\\nmodule.exports = {\\n 'https://fonts.googleapis.com/css?family=Inter:wght@400;500;600;800&display=block': `\\n /* cyrillic-ext */\\n @font-face {\\n font-family: 'Inter';\\n font-style: normal;\\n font-weight: 400;\\n font-display: block;\\n src: url(https://fonts.gstatic.com/s/inter/v12/UcCO3FwrK3iLTeHuS_fvQtMwCp50KnMw2boKoduKmMEVuLyfAZJhiJ-Ek-_EeAmM.woff2) format('woff2');\\n unicode-range: U+0460-052F, U+1C80-1C88, U+20B4, U+2DE0-2DFF, U+A640-A69F, U+FE2E-FE2F;\\n }\\n /* more font declarations go here */\\n /* latin */\\n @font-face {\\n font-family: 'Inter';\\n font-style: normal;\\n font-weight: 400;\\n font-display: block;\\n src: url(https://fonts.gstatic.com/s/inter/v12/UcCO3FwrK3iLTeHuS_fvQtMwCp50KnMw2boKoduKmMEVuLyfAZ9hiJ-Ek-_EeA.woff2) format('woff2');\\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+2074, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\\n }`,\\n};\\n```\"}, \"Next.js routing\": {\"Overriding defaults\": \"Per-story overrides can be done by adding a `nextjs.router` property onto the story [parameters](../../writing-stories/parameters.mdx). The framework will shallowly merge whatever you put here into the router.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-router-override-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout>\\nThese overrides can also be applied to [all stories for a component](../../api/parameters.mdx#meta-parameters) or [all stories in your project](../../api/parameters.mdx#project-parameters). Standard [parameter inheritance](../../api/parameters.mdx#parameter-inheritance) rules apply.\\n</Callout>\", \"Default router\": \"The default values on the stubbed router are as follows (see [globals](../../essentials/toolbars-and-globals.mdx#globals) for more details on how globals work).\\n\\n```\\n// Default router\\nconst defaultRouter = {\\n // The locale should be configured globally: https://storybook.js.org/docs/essentials/toolbars-and-globals#globals\\n locale: globals?.locale,\\n asPath: '/',\\n basePath: '/',\\n isFallback: false,\\n isLocaleDomain: false,\\n isReady: true,\\n isPreview: false,\\n route: '/',\\n pathname: '/',\\n query: {},\\n};\\n```\\n\\nAdditionally, the [`router` object](https://nextjs.org/docs/pages/api-reference/functions/use-router#router-object) contains all of the original methods (such as `push()`, `replace()`, etc.) as mock functions that can be manipulated and asserted on using [regular mock APIs](https://vitest.dev/api/mock.html).\\n\\nTo override these defaults, you can use [parameters](../../writing-stories/parameters.mdx) and [`beforeEach`](../../writing-stories/mocking-data-and-modules/mocking-modules.mdx#setting-up-and-cleaning-up):\\n\\n```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Preview } from '@storybook/your-framework';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { getRouter } from \\\"@storybook/your-framework/router.mock\\\";\\n\\nconst preview: Preview = {\\n parameters: {\\n nextjs: {\\n // \\ud83d\\udc47 Override the default router properties\\n router: {\\n basePath: '/app/',\\n },\\n },\\n },\\n async beforeEach() {\\n // \\ud83d\\udc47 Manipulate the default router method mocks\\n getRouter().push.mockImplementation(() => {\\n /* ... */\\n });\\n },\\n};\\n```\"}, \"Next.js navigation\": {\"Set `nextjs.appDirectory` to `true`\": \"If your story imports components that use `next/navigation`, you need to set the parameter `nextjs.appDirectory` to `true` in for that component's stories:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-app-directory-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf your Next.js project uses the `app` directory for every page (in other words, it does not have a `pages` directory), you can set the parameter `nextjs.appDirectory` to `true` in the [`.storybook/preview.js|ts`](../../configure/index.mdx#configure-story-rendering) file to apply it to all stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-app-directory-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Overriding defaults\": \"Per-story overrides can be done by adding a `nextjs.navigation` property onto the story [parameters](../../writing-stories/parameters.mdx). The framework will shallowly merge whatever you put here into the router.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-navigation-override-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout>\\nThese overrides can also be applied to [all stories for a component](../../api/parameters.mdx#meta-parameters) or [all stories in your project](../../api/parameters.mdx#project-parameters). Standard [parameter inheritance](../../api/parameters.mdx#parameter-inheritance) rules apply.\\n</Callout>\", \"`useSelectedLayoutSegment`, `useSelectedLayoutSegments`, and `useParams` hooks\": \"The `useSelectedLayoutSegment`, `useSelectedLayoutSegments`, and `useParams` hooks are supported in Storybook. You have to set the `nextjs.navigation.segments` parameter to return the segments or the params you want to use.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-navigation-segments-override-in-meta.md\\\" />\\n\\nWith the above configuration, the component rendered in the stories would receive the following values from the hooks:\\n\\n```\\nimport { useSelectedLayoutSegment, useSelectedLayoutSegments, useParams } from 'next/navigation';\\n\\nexport default function NavigationBasedComponent() {\\n const segment = useSelectedLayoutSegment(); // dashboard\\n const segments = useSelectedLayoutSegments(); // [\\\"dashboard\\\", \\\"analytics\\\"]\\n const params = useParams(); // {}\\n // ...\\n}\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nTo use `useParams`, you have to use a segments array where each element is an array containing two strings. The first string is the param key and the second string is the param value.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-navigation-segments-for-use-params-override-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWith the above configuration, the component rendered in the stories would receive the following values from the hooks:\\n\\n```\\nimport { useSelectedLayoutSegment, useSelectedLayoutSegments, useParams } from 'next/navigation';\\n\\nexport default function ParamsBasedComponent() {\\n const segment = useSelectedLayoutSegment(); // hello\\n const segments = useSelectedLayoutSegments(); // [\\\"hello\\\", \\\"nextjs\\\"]\\n const params = useParams(); // { slug: \\\"hello\\\", framework: \\\"nextjs\\\" }\\n ...\\n}\\n```\\n\\n<Callout>\\nThese overrides can also be applied to [a single story](../../api/parameters.mdx#story-parameters) or [all stories in your project](../../api/parameters.mdx#project-parameters). Standard [parameter inheritance](../../api/parameters.mdx#parameter-inheritance) rules apply.\\n</Callout>\\n\\nThe default value of `nextjs.navigation.segments` is `[]` if not set.\", \"Default navigation context\": \"The default values on the stubbed navigation context are as follows:\\n\\n```\\n// Default navigation context\\nconst defaultNavigationContext = {\\n pathname: '/',\\n query: {},\\n};\\n```\\n\\nAdditionally, the [`router` object](https://nextjs.org/docs/app/api-reference/functions/use-router#userouter) contains all of the original methods (such as `push()`, `replace()`, etc.) as mock functions that can be manipulated and asserted on using [regular mock APIs](https://vitest.dev/api/mock.html).\\n\\nTo override these defaults, you can use [parameters](../../writing-stories/parameters.mdx) and [`beforeEach`](../../writing-stories/mocking-data-and-modules/mocking-modules.mdx#setting-up-and-cleaning-up):\\n\\n```\\n// Replace your-framework with nextjs or nextjs-vite\\nimport type { Preview } from '@storybook/your-framework';\\n\\n// \\ud83d\\udc47 Must include the `.mock` portion of filename to have mocks typed correctly\\nimport { getRouter } from '@storybook/your-framework/navigation.mock';\\n\\nconst preview: Preview = {\\n parameters: {\\n nextjs: {\\n // \\ud83d\\udc47 Override the default navigation properties\\n navigation: {\\n pathname: '/app/',\\n },\\n },\\n },\\n async beforeEach() {\\n // \\ud83d\\udc47 Manipulate the default navigation method mocks\\n getRouter().push.mockImplementation(() => {\\n /* ... */\\n });\\n },\\n};\\n```\"}, \"Next.js Head\": \"[`next/head`](https://nextjs.org/docs/pages/api-reference/components/head) is supported out of the box. You can use it in your stories like you would in your Next.js application. Please keep in mind, that the Head `children` are placed into the head element of the iframe that Storybook uses to render your stories.\", \"Sass/Scss\": \"[Global Sass/Scss stylesheets](https://nextjs.org/docs/pages/building-your-application/styling/sass) are supported without any additional configuration as well. Just import them into [`.storybook/preview.js|ts`](../../configure/index.mdx#configure-story-rendering)\\n\\n```\\nimport '../styles/globals.scss';\\n```\\n\\nThis will automatically include any of your [custom Sass configurations](https://nextjs.org/docs/pages/building-your-application/styling/sass#customizing-sass-options) in your `next.config.js` file.\\n\\n```\\nimport * as path from 'path';\\n\\nexport default {\\n // Any options here are included in Sass compilation for your stories\\n sassOptions: {\\n includePaths: [path.join(process.cwd(), 'styles')],\\n },\\n};\\n```\", \"CSS/Sass/Scss Modules\": \"[CSS modules](https://nextjs.org/docs/pages/building-your-application/styling/css-modules) work as expected.\\n\\n```\\n// This import will work in Storybook\\nimport styles from './Button.module.css';\\n// Sass/Scss is also supported\\n// import styles from './Button.module.scss'\\n// import styles from './Button.module.sass'\\n\\nexport function Button() {\\n return (\\n <button type=\\\"button\\\" className={styles.error}>\\n Destroy\\n </button>\\n );\\n}\\n```\", \"Styled JSX\": \"The built in CSS-in-JS solution for Next.js is [styled-jsx](https://nextjs.org/docs/pages/building-your-application/styling/css-in-js), and this framework supports that out of the box too, zero config.\\n\\n```\\n// This will work in Storybook\\nfunction HelloWorld() {\\n return (\\n <div>\\n Hello world\\n <p>scoped!</p>\\n <style jsx>{`\\n p {\\n color: blue;\\n }\\n div {\\n background: red;\\n }\\n @media (max-width: 600px) {\\n div {\\n background: blue;\\n }\\n }\\n `}</style>\\n <style global jsx>{`\\n body {\\n background: black;\\n }\\n `}</style>\\n </div>\\n );\\n}\\n\\nexport default HelloWorld;\\n```\\n\\nYou can use your own babel config too. This is an example of how you can customize styled-jsx.\\n\\n```\\n// .babelrc (or whatever config file you use)\\n{\\n \\\"presets\\\": [\\n [\\n \\\"next/babel\\\",\\n {\\n \\\"styled-jsx\\\": {\\n \\\"plugins\\\": [\\\"@styled-jsx/plugin-sass\\\"]\\n }\\n }\\n ]\\n ]\\n}\\n```\", \"PostCSS\": \"Next.js lets you [customize PostCSS config](https://nextjs.org/docs/pages/building-your-application/configuring/post-css). Thus this framework will automatically handle your PostCSS config for you.\\n\\nThis allows for cool things like zero-config Tailwind! (See [Next.js' example](https://github.com/vercel/next.js/tree/canary/packages/create-next-app/templates/default-tw))\", \"Absolute imports\": \"[Absolute imports](https://nextjs.org/docs/pages/building-your-application/configuring/absolute-imports-and-module-aliases#absolute-imports) from the root directory are supported.\\n\\n```\\n// All good!\\nimport Button from 'components/button';\\n// Also good!\\nimport styles from 'styles/HomePage.module.css';\\n\\nexport default function HomePage() {\\n return (\\n <>\\n <h1 className={styles.title}>Hello World</h1>\\n <Button />\\n </>\\n );\\n}\\n```\\n\\nAlso OK for global styles in `.storybook/preview.js|ts`!\\n\\n```\\nimport 'styles/globals.scss';\\n\\n// ...\\n```\\n\\n<Callout variant=\\\"warning\\\">\\nAbsolute imports **cannot** be mocked in stories/tests. See the [Mocking modules](#mocking-modules) section for more information.\\n</Callout>\", \"Module aliases\": \"[Module aliases](https://nextjs.org/docs/app/building-your-application/configuring/absolute-imports-and-module-aliases#module-aliases) are also supported.\\n\\n```\\n// All good!\\nimport Button from '@/components/button';\\n// Also good!\\nimport styles from '@/styles/HomePage.module.css';\\n\\nexport default function HomePage() {\\n return (\\n <>\\n <h1 className={styles.title}>Hello World</h1>\\n <Button />\\n </>\\n );\\n}\\n```\", \"Subpath imports\": \"As an alternative to [module aliases](#module-aliases), you can use [subpath imports](https://nodejs.org/api/packages.html#subpath-imports) to import modules. This follows Node package standards and has benefits when [mocking modules](#mocking-modules).\\n\\nTo configure subpath imports, you define the `imports` property in your project's `package.json` file. This property maps the subpath to the actual file path. The example below configures subpath imports for all modules in the project:\\n\\n```\\n{\\n \\\"imports\\\": {\\n \\\"#*\\\": [\\\"./*\\\", \\\"./*.ts\\\", \\\"./*.tsx\\\"]\\n }\\n}\\n```\\n\\n<Callout variant=\\\"info\\\">\\nBecause subpath imports replace module aliases, you can remove the path aliases from your TypeScript configuration.\\n</Callout>\\n\\nWhich can then be used like this:\\n\\n```\\nimport Button from '#components/button';\\nimport styles from '#styles/HomePage.module.css';\\n\\nexport default function HomePage() {\\n return (\\n <>\\n <h1 className={styles.title}>Hello World</h1>\\n <Button />\\n </>\\n );\\n}\\n```\", \"Mocking modules\": {\"Built-in mocked modules\": \"This framework provides mocks for many of Next.js' internal modules:\\n\\n['[`@storybook/nextjs/cache.mock`](#storybooknextjscachemock)', '[`@storybook/nextjs/headers.mock`](#storybooknextjsheadersmock)', '[`@storybook/nextjs/navigation.mock`](#storybooknextjsnavigationmock)', '[`@storybook/nextjs/router.mock`](#storybooknextjsroutermock)']\", \"Mocking other modules\": \"To mock other modules, use [automocking](../../writing-stories/mocking-data-and-modules/mocking-modules.mdx#automocking) or one of the [alternative methods](../../writing-stories/mocking-data-and-modules/mocking-modules.mdx#alternative-methods) documented in the mocking modules guide.\"}, \"Runtime config\": \"Next.js allows for [Runtime Configuration](https://nextjs.org/docs/pages/api-reference/next-config-js/runtime-configuration) which lets you import a handy `getConfig` function to get certain configuration defined in your `next.config.js` file at runtime.\\n\\nIn the context of Storybook with this framework, you can expect Next.js's [Runtime Configuration](https://nextjs.org/docs/pages/api-reference/next-config-js/runtime-configuration) feature to work just fine.\\n\\nNote, because Storybook doesn't server render your components, your components will only see what they normally see on the client side (i.e. they won't see `serverRuntimeConfig` but will see `publicRuntimeConfig`).\\n\\nFor example, consider the following Next.js config:\\n\\n```\\nmodule.exports = {\\n serverRuntimeConfig: {\\n mySecret: 'secret',\\n secondSecret: process.env.SECOND_SECRET, // Pass through env variables\\n },\\n publicRuntimeConfig: {\\n staticFolder: '/static',\\n },\\n};\\n```\\n\\nCalls to `getConfig` would return the following object when called within Storybook:\\n\\n```\\n// Runtime config\\n{\\n \\\"serverRuntimeConfig\\\": {},\\n \\\"publicRuntimeConfig\\\": {\\n \\\"staticFolder\\\": \\\"/static\\\"\\n }\\n}\\n```\", \"Custom Webpack config\": \"<Callout variant=\\\"info\\\">\\nYou can safely skip this section if you are using `@storybook/nextjs-vite` instead of `@storybook/nextjs`.\\nThe Vite-based Next.js framework does not support Webpack settings.\\n</Callout>\\n\\nNext.js comes with a lot of things for free out of the box like Sass support, but sometimes you add [custom Webpack config modifications to Next.js](https://nextjs.org/docs/pages/api-reference/next-config-js/webpack). This framework takes care of most of the Webpack modifications you would want to add. If Next.js supports a feature out of the box, then that feature will work out of the box in Storybook. If Next.js doesn't support something out of the box, but makes it easy to configure, then this framework will do the same for that thing for Storybook.\\n\\nAny Webpack modifications desired for Storybook should be made in [`.storybook/main.js|ts`](../../builders/webpack.mdx#extending-storybooks-webpack-config).\\n\\nNote: Not all Webpack modifications are copy/paste-able between `next.config.js` and `.storybook/main.js|ts`. It is recommended to do your research on how to properly make your modification to Storybook's Webpack config and on how [Webpack works](https://webpack.js.org/concepts/).\\n\\nBelow is an example of how to add SVGR support to Storybook with this framework.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-configure-svgr.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Typescript\": \"Storybook handles most [Typescript](https://www.typescriptlang.org/) configurations, but this framework adds additional support for Next.js's support for [Absolute Imports and Module path aliases](https://nextjs.org/docs/pages/building-your-application/configuring/absolute-imports-and-module-aliases). In short, it takes into account your `tsconfig.json`'s [baseUrl](https://www.typescriptlang.org/tsconfig#baseUrl) and [paths](https://www.typescriptlang.org/tsconfig#paths). Thus, a `tsconfig.json` like the one below would work out of the box.\\n\\n```\\n{\\n \\\"compilerOptions\\\": {\\n \\\"baseUrl\\\": \\\".\\\",\\n \\\"paths\\\": {\\n \\\"@/components/*\\\": [\\\"components/*\\\"]\\n }\\n }\\n}\\n```\", \"React Server Components (RSC)\": \"(\\u26a0\\ufe0f **Experimental**)\\n\\nIf your app uses [React Server Components (RSC)](https://nextjs.org/docs/app/building-your-application/rendering/server-components), Storybook can render them in stories in the browser.\\n\\nTo enable this set the `experimentalRSC` feature flag in your `.storybook/main.js|ts` config:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"rsc-feature-flag.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nSetting this flag automatically wraps your story in a [Suspense](https://react.dev/reference/react/Suspense) wrapper, which is able to render asynchronous components in NextJS's version of React.\\n\\nIf this wrapper causes problems in any of your existing stories, you can selectively disable it using the `react.rsc` [parameter](https://storybook.js.org/docs/writing-stories/parameters) at the global/component/story level:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"rsc-parameter-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNote that wrapping your server components in Suspense does not help if your server components access server-side resources like the file system or Node-specific libraries. To work around this, you'll need to mock out your data access layer using [Webpack aliases](https://webpack.js.org/configuration/resolve/#resolvealias) or an addon like [storybook-addon-module-mock](https://storybook.js.org/addons/storybook-addon-module-mock).\\n\\nIf your server components access data via the network, we recommend using the [MSW Storybook Addon](https://storybook.js.org/addons/msw-storybook-addon) to mock network requests.\\n\\nIn the future we will provide better mocking support in Storybook and support for [Server Actions](https://nextjs.org/docs/app/api-reference/functions/server-actions).\\n\\n{/* ## Portable stories\\n\\nYou can test your stories in a Jest environment by using the [portable stories](../../api/portable-stories/portable-stories-jest.mdx) API.\\n\\nWhen using portable stories with Next.js, you need to mock the Next.js modules on which your components depend. You can use the [`@storybook/nextjs/export-mocks` module](#storybooknextjsexport-mocks) to generate the aliases needed to set up portable stories in a Jest environment. This is needed because, to replicate Next.js configuration, Storybook sets up aliases in Webpack to make testing and developing your components easier. If you make use of the advanced functionality like the built-in mocks for common Next.js modules, you need to set up this aliasing in your Jest environment as well. */}\", \"Notes for Yarn v2 and v3 users\": \"If you're using [Yarn](https://yarnpkg.com/) v2 or v3, you may run into issues where Storybook can't resolve `style-loader` or `css-loader`. For example, you might get errors like:\\n\\n```\\nModule not found: Error: Can't resolve 'css-loader'\\nModule not found: Error: Can't resolve 'style-loader'\\n```\\n\\nThis is because those versions of Yarn have different package resolution rules than Yarn v1.x. If this is the case for you, please install the package directly.\", \"FAQ\": {\"Stories for pages/components which fetch data\": \"Next.js pages can fetch data directly within server components in the `app` directory, which often include module imports that only run in a node environment. This does not (currently) work within Storybook, because if you import from a Next.js page file containing those node module imports in your stories, your Storybook's Webpack will crash because those modules will not run in a browser. To get around this, you can extract the component in your page file into a separate file and import that pure component in your stories. Or, if that's not feasible for some reason, you can [polyfill those modules](https://webpack.js.org/configuration/node/) in your Storybook's [`webpackFinal` configuration](../../builders/webpack.mdx#extending-storybooks-webpack-config).\\n\\n**Before**\\n\\n```\\nasync function getData() {\\n const res = await fetch(...);\\n // ...\\n}\\n\\n// Using this component in your stories will break the Storybook build\\nexport default async function Page() {\\n const data = await getData();\\n\\n return // ...\\n}\\n```\\n\\n**After**\\n\\n```\\n// Use this component in your stories\\nimport MyPage from './components/MyPage';\\n\\nasync function getData() {\\n const res = await fetch(...);\\n // ...\\n}\\n\\nexport default async function Page() {\\n const data = await getData();\\n\\n return <MyPage {...data} />;\\n}\\n```\", \"Statically imported images won't load\": \"Make sure you are treating image imports the same way you treat them when using `next/image` in normal development.\\n\\nBefore using this framework, image imports would import the raw path to the image (e.g. `'static/media/stories/assets/logo.svg'`). Now image imports work the \\\"Next.js way\\\", meaning that you now get an object when importing an image. For example:\\n\\n```\\n// Image import object\\n{\\n \\\"src\\\": \\\"static/media/stories/assets/logo.svg\\\",\\n \\\"height\\\": 48,\\n \\\"width\\\": 48,\\n \\\"blurDataURL\\\": \\\"static/media/stories/assets/logo.svg\\\"\\n}\\n```\\n\\nTherefore, if something in Storybook isn't showing the image properly, make sure you expect the object to be returned from an import instead of only the asset path.\\n\\nSee [local images](https://nextjs.org/docs/pages/building-your-application/optimizing/images#local-images) for more detail on how Next.js treats static image imports.\", \"Module not found: Error: Can't resolve `package name`\": \"You might get this if you're using Yarn v2 or v3. See [Notes for Yarn v2 and v3 users](#notes-for-yarn-v2-and-v3-users) for more details.\", \"What if I'm using the Vite builder?\": \"Storybook provides a Vite-based framework for Next.js. Follow the [installation instructions](#with-vite) and replace all instances of `@storybook/nextjs` with `@storybook/nextjs-vite`.\", \"Error: You are importing avif images, but you don't have sharp installed. You have to install sharp in order to use image optimization features in Next.js.\": \"`sharp` is a dependency of Next.js's image optimization feature. If you see this error, you need to install `sharp` in your project.\\n\\n```\\nnpm install sharp\\n```\\n\\n```\\nyarn add sharp\\n```\\n\\n```\\npnpm add sharp\\n```\\n\\nYou can refer to the [Install `sharp` to Use Built-In Image Optimization](https://nextjs.org/docs/messages/install-sharp) in the Next.js documentation for more information.\"}, \"API\": {\"Modules\": {\"`@storybook/nextjs/export-mocks`\": \"Type: `{ getPackageAliases: ({ useESM?: boolean }) => void }`\\n\\n`getPackageAliases` is a helper for generating the aliases needed to set up [portable stories](#portable-stories).\\n\\n```\\nimport type { Config } from 'jest';\\nimport nextJest from 'next/jest.js';\\n// \\ud83d\\udc47 Import the utility function\\nimport { getPackageAliases } from '@storybook/nextjs/export-mocks';\\n\\nconst createJestConfig = nextJest({\\n // Provide the path to your Next.js app to load next.config.js and .env files in your test environment\\n dir: './',\\n});\\n\\nconst config: Config = {\\n testEnvironment: 'jsdom',\\n // ... rest of Jest config\\n moduleNameMapper: {\\n ...getPackageAliases(), // \\ud83d\\udc48 Add the utility as mapped module names\\n },\\n};\\n\\nexport default createJestConfig(config);\\n```\", \"`@storybook/nextjs/cache.mock`\": \"Type: `typeof import('next/cache')`\\n\\nThis module exports mocked implementations of the `next/cache` module's exports. You can use it to create your own mock implementations or assert on mock calls in a story's [play function](../../writing-stories/play-function.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-cache-mock.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`@storybook/nextjs/headers.mock`\": \"Type: [`cookies`](https://nextjs.org/docs/app/api-reference/functions/cookies#cookiessetname-value-options), [`headers`](https://nextjs.org/docs/app/api-reference/functions/headers) and [`draftMode`](https://nextjs.org/docs/app/api-reference/functions/draft-mode) from Next.js\\n\\nThis module exports *writable* mocked implementations of the `next/headers` module's exports. You can use it to set up cookies or headers that are read in your story, and to later assert that they have been called.\\n\\nNext.js's default [`headers()`](https://nextjs.org/docs/app/api-reference/functions/headers) export is read-only, but this module exposes methods allowing you to write to the headers:\\n\\n['**`headers().append(name: string, value: string)`**: Appends the value to the header if it exists already.', '**`headers().delete(name: string)`**: Deletes the header', '**`headers().set(name: string, value: string)`**: Sets the header to the value provided.']\\n\\nFor cookies, you can use the existing API to write them. E.g., `cookies().set('firstName', 'Jane')`.\\n\\nBecause `headers()`, `cookies()` and their sub-functions are all mocks you can use any [mock utilities](https://vitest.dev/api/mock.html) in your stories, like `headers().getAll.mock.calls`.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-headers-mock.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`@storybook/nextjs/navigation.mock`\": \"Type: `typeof import('next/navigation') & getRouter: () => ReturnType<typeof import('next/navigation')['useRouter']>`\\n\\nThis module exports mocked implementations of the `next/navigation` module's exports. It also exports a `getRouter` function that returns a mocked version of [Next.js's `router` object from `useRouter`](https://nextjs.org/docs/app/api-reference/functions/use-router#userouter), allowing the properties to be manipulated and asserted on. You can use it mock implementations or assert on mock calls in a story's [play function](../../writing-stories/play-function.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-navigation-mock.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"`@storybook/nextjs/router.mock`\": \"Type: `typeof import('next/router') & getRouter: () => ReturnType<typeof import('next/router')['useRouter']>`\\n\\nThis module exports mocked implementations of the `next/router` module's exports. It also exports a `getRouter` function that returns a mocked version of [Next.js's `router` object from `useRouter`](https://nextjs.org/docs/pages/api-reference/functions/use-router#router-object), allowing the properties to be manipulated and asserted on. You can use it mock implementations or assert on mock calls in a story's [play function](../../writing-stories/play-function.mdx).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"nextjs-router-mock.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For Next.js, available options can be found in the [Webpack builder docs](../../builders/webpack.mdx).\", \"`image`\": \"Type: `object`\\n\\nProps to pass to every instance of `next/image`. See [next/image docs](https://nextjs.org/docs/pages/api-reference/components/image) for more details.\", \"`nextConfigPath`\": \"Type: `string`\\n\\nThe absolute path to the `next.config.js` file. This is necessary if you have a custom `next.config.js` file that is not in the root directory of your project.\"}, \"Parameters\": {\"`appDirectory`\": \"Type: `boolean`\\n\\nDefault: `false`\\n\\nIf your story imports components that use `next/navigation`, you need to set the parameter `nextjs.appDirectory` to `true`. Because this is a parameter, you can apply it to a [single story](../../api/parameters.mdx#story-parameters), [all stories for a component](../../api/parameters.mdx#meta-parameters), or [every story in your Storybook](../../api/parameters.mdx#project-parameters). See [Next.js Navigation](#nextjs-navigation) for more details.\", \"`navigation`\": \"Type:\\n\\n```\\n{\\n asPath?: string;\\n pathname?: string;\\n query?: Record<string, string>;\\n segments?: (string | [string, string])[];\\n}\\n```\\n\\nDefault value:\\n\\n```\\n{\\n segments: [];\\n}\\n```\\n\\nThe router object that is passed to the `next/navigation` context. See [Next.js's navigation docs](https://nextjs.org/docs/app/building-your-application/routing) for more details.\", \"`router`\": \"Type:\\n\\n```\\n{\\n asPath?: string;\\n pathname?: string;\\n query?: Record<string, string>;\\n}\\n```\\n\\nThe router object that is passed to the `next/router` context. See [Next.js's router docs](https://nextjs.org/docs/pages/building-your-application/routing) for more details.\"}}}, \"metadata\": {\"title\": \"Storybook for Next.js\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 2, \"title\": \"Next.js\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"Storybook for Preact & Vite\", \"description\": null, \"content\": {\"Requirements\": [\"Preact 8.x || 10.x\", \"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Preact project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/preact-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"preact-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"preact-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for Preact & Vite\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 3, \"title\": \"Preact & Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"Storybook for React Native Web\", \"description\": null, \"content\": {\"Requirements\": [\"React-Native \\u2265 0.72\", \"React-Native-Web \\u2265 0.19\", \"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your React Native project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook `addon-react-native-web`\": \"The [React Native Web addon](https://github.com/storybookjs/addon-react-native-web) was a Webpack-based precursor to the React Native Web Vite framework (i.e., `@storybook/react-native-web-vite`). If you're using the addon, you should migrate to the framework, which is faster, more stable, maintained, and better documented. To do so, follow the steps below.\\n\\nRun the following command to upgrade Storybook to the latest version:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-upgrade.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThis framework is designed to work with Storybook 8.5 and above for the best experience. We won't be able to provide support if you're using an older Storybook version.\\n</Callout>\\n\\nInstall the framework and its peer dependencies:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-native-web-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate your `.storybook/main.js|ts` to change the framework property and remove the `@storybook/addon-react-native-web` addon:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-native-web-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, remove the addon and similar packages (i.e., `@storybook/react-webpack5` and `@storybook/addon-react-native-web`) from your project.\", \"In a project with Storybook `react-native`\": \"[Storybook for React Native](https://github.com/storybookjs/react-native) is a framework that runs in a simulator or on your mobile device. It's possible to run React Native Web alongside React Native, but we are still working on a seamless integration. In the meantime, we recommend running one or the other. If you need help figuring out what's right for you, read our [comparison](#react-native-vs-react-native-web).\"}, \"Run the Setup Wizard\": \"If all goes well, you should see a setup wizard that will help you get started with Storybook. The wizard will introduce you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).\\n\\n\\n\\nIf you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.\", \"React Native vs React Native Web\": {\"Comparison\": \"So, which option is right for you?\\n\\n**Native.** You should choose this option if you want:\\n\\n['**Native features** - Your components rely on device-specific features like native modules. It runs in your actual application, in-simulator, or on-device and provides full fidelity. The web version uses `react-native-web`, which works for most components but has [limitations](https://necolas.github.io/react-native-web/docs/react-native-compatibility/).', '**Mobile publication** - You want to share your Storybook on-device as part of a test build or embedded inside your application.']\\n\\n**Web.** You should choose this option if you want:\\n\\n['[**Sharing**](../../sharing/publish-storybook.mdx) - Publish to the web and share with your team or publicly.', '[**Documentation**](../../writing-docs/index.mdx) - Auto-generated component docs or rich markdown docs in MDX.', '[**Testing**](../../writing-tests/index.mdx) - Component, visual, and a11y tests for your components.', '[**Addons**](https://storybook.js.org/addons) - 500+ addons that improve development, documentation, testing, and integration with other tools.']\\n\\n**Both.** It\\u2019s also possible to use both options together. This increases Storybook\\u2019s install footprint but is a good option if you want native fidelity in addition to all of the web features. Learn more below.\"}, \"Using both React Native and React Native Web\": \"The easiest way to use React Native and React Native Web is to select the \\\"Both\\\" option when installing Storybook. This will install and create configurations for both environments, allowing you to run Storybook for both in the same project.\\n\\nHowever, you can install them separately if one version is installed. You can add a React Native Web Storybook alongside an existing React Native Storybook by running the install command and selecting \\\"React Native Web\\\" in the setup wizard, and vice versa.\", \"API\": {\"Options\": {\"Example configuration for reanimated\": \"```\\nconst main: StorybookConfig = {\\n // ... rest of config\\n\\n framework: {\\n name: \\\"@storybook/react-native-web-vite\\\",\\n options: {\\n pluginReactOptions: {\\n babel: {\\n plugins: [\\n \\\"@babel/plugin-proposal-export-namespace-from\\\",\\n \\\"react-native-reanimated/plugin\\\",\\n ],\\n },\\n },\\n },\\n },\\n\\n // ... rest of config\\n}\\n```\", \"Example configuration for nativewind\": \"```\\n\\nconst main: StorybookConfig = {\\n // ... rest of config\\n\\n framework: {\\n name: \\\"@storybook/react-native-web-vite\\\",\\n options: {\\n pluginReactOptions: {\\n jsxImportSource: \\\"nativewind\\\",\\n },\\n },\\n },\\n}\\n```\", \"Example configuration to transpile additional node_modules\": \"Let's say you need to transpile a library called `my-library` that is not transpiled for web by default.\\nYou can add it to the `modulesToTranspile` option.\\n\\n```\\nconst main: StorybookConfig = {\\n // ... rest of config\\n\\n framework: {\\n name: \\\"@storybook/react-native-web-vite\\\",\\n options: {\\n modulesToTranspile: ['my-library'],\\n },\\n },\\n}\\n```\", \"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for React Native Web\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 6, \"title\": \"React Native Web\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"Storybook for React & Vite\", \"description\": null, \"content\": {\"Requirements\": [\"React \\u2265 16.8\", \"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your React project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/react-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"Run the Setup Wizard\": \"If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).\\n\\n\\n\\nIf you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.\", \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for React & Vite\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 4, \"title\": \"React & Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}, {\"title\": \"Storybook for React & Webpack\", \"description\": null, \"content\": {\"Requirements\": [\"React \\u2265 16.8\", \"Webpack \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your React project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/react-webpack5`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-webpack5-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNext, install and register your appropriate compiler addon, depending on whether you're using SWC (recommended) or Babel:\\n\\n<Callout variant=\\\"info\\\">\\nIf your project is using [Create React App](#create-react-app-cra), you can skip this step.\\n</Callout>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-compiler-swc-auto-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nor\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-addon-compiler-babel-auto-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nMore details can be found in the [Webpack builder docs](../../builders/webpack.mdx#compiler-support).\\n\\nFinally, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"react-webpack5-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"Run the Setup Wizard\": \"If all goes well, you should see a setup wizard that will help you get started with Storybook introducing you to the main concepts and features, including how the UI is organized, how to write your first story, and how to test your components' response to various inputs utilizing [controls](../../essentials/controls.mdx).\\n\\n\\n\\nIf you skipped the wizard, you can always run it again by adding the `?path=/onboarding` query parameter to the URL of your Storybook instance, provided that the example stories are still available.\", \"Create React App (CRA)\": \"Support for [Create React App](https://create-react-app.dev/) is handled by [`@storybook/preset-create-react-app`](https://github.com/storybookjs/presets/tree/master/packages/preset-create-react-app).\\n\\nThis preset enables support for all CRA features, including Sass/SCSS and TypeScript.\\n\\nIf you're working on an app that was initialized manually (i.e., without the use of CRA), ensure that your app has [react-dom](https://www.npmjs.com/package/react-dom) included as a dependency. Failing to do so can lead to unforeseen issues with Storybook and your project.\", \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Webpack builder docs](../../builders/webpack.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for React & Webpack\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"React & Webpack\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\"}, {\"title\": \"Storybook for Svelte & Vite\", \"description\": null, \"content\": {\"Requirements\": [\"Svelte \\u2265 5.0\", \"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Svelte project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/svelte-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"Writing native Svelte stories\": {\"Setup\": \"If you initialized your project with the Svelte framework, the addon has already been installed and configured for you. However, if you're [migrating](#automatic-migration) from a previous version, you'll need to take additional steps to enable this feature.\\n\\nRun the following command to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe CLI's [`add`](../../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\\n\\nUpdate your Storybook configuration file (i.e., `.storybook/main.js|ts`) to enable support for this format.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-svelte-csf-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configure\": \"By default, the Svelte [addon](https://storybook.js.org/addons/@storybook/addon-svelte-csf) offers zero-config support for Storybook's Svelte framework. However, you can extend your Storybook configuration file (i.e., `.storybook/main.js|ts`) and provide additional addon options. Listed below are the available options and examples of how to use them.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n| Options | Description |\\n| ---------------- | ------------------------------------------------------------------------------------------------------------------ |\\n| `legacyTemplate` | Enables support for the `Template` component for backward compatibility. <br/> `options: { legacyTemplate: true }` |\\n\\n<Callout variant=\\\"info\\\">\\n\\nEnabling the `legacyTemplate` option can introduce a performance overhead and should be used cautiously. For more information, refer to the [addon's documentation](https://github.com/storybookjs/addon-svelte-csf/blob/next/README.md#legacy-api).\\n\\n</Callout>\", \"Upgrade to Svelte CSF addon v5\": {\"Simplified story API\": \"If you are using the `Meta` component or the `meta` named export to define the story's metadata (e.g., [parameters](../../writing-stories/parameters.mdx)), you'll need to update your stories to use the new `defineMeta` function. This function returns an object with the required information, including a `Story` component that you must use to define your component stories.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-story-migration.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Story templates\": \"If you used the `Template` component to control how the component renders in the Storybook, this feature was replaced with built-in children support in the `Story` component, enabling you to compose components and define the UI structure directly in the story.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-story-custom-children.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nIf you need support for the `Template` component, the addon provides a feature flag for backward compatibility. For more information, see the [configuration options](#configure).\\n\\n</Callout>\", \"Story slots to snippets\": \"With Svelte's slot deprecation and the introduction of reusable [`snippets`](https://svelte.dev/docs/svelte/v5-migration-guide#Snippets-instead-of-slots), the addon also introduced support for this feature allowing you to extend the `Story` component and provide a custom snippet to provide dynamic content to your stories. `Story` accepts a `template` snippet, allowing you to create dynamic stories without losing reactivity.\\n\\n```\\n<script>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" args={{ exampleProperty: true }}>\\n {#snippet template(args)}\\n <MyComponent {...args}>Reactive component</MyComponent>\\n {/snippet}\\n</Story>\\n```\", \"Tags support\": \"If you enabled automatic documentation generation with the `autodocs` story property, you must replace it with [`tags`](../../writing-stories/tags.mdx). This property allows you to categorize and filter stories based on specific criteria and generate documentation based on the tags applied to the stories.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-tags.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\", \"`docgen`\": {\"When to disable docgen\": \"Disabling docgen can improve build performance for large projects, but [argTypes won't be inferred automatically](../../api/arg-types.mdx#automatic-argtype-inference), which will prevent features like [Controls](../../essentials/controls.mdx) and [docs](../../writing-docs/autodocs.mdx) from working as expected. To use those features, you will need to [define `argTypes` manually](../../api/arg-types.mdx#manually-specifying-argtypes).\"}}}}, \"metadata\": {\"title\": \"Storybook for Svelte & Vite\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 8, \"title\": \"Svelte & Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\"}, {\"title\": \"Storybook for SvelteKit\", \"description\": null, \"content\": {\"Requirements\": [\"SvelteKit \\u2265 1.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Sveltekit project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/sveltekit`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"sveltekit-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"sveltekit-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, these packages are now either obsolete or part of `@storybook/sveltekit`, so you no longer need to depend on them directly. You can remove them (`npm uninstall`, `yarn remove`, `pnpm remove`) from your project:\\n\\n['`@storybook/svelte-vite`', '`storybook-builder-vite`', '`@storybook/builder-vite`']\"}}, \"Supported features\": \"All Svelte language features are supported out of the box, as the Storybook framework uses the Svelte compiler directly.\\nHowever, SvelteKit has some [Kit-specific modules](https://kit.svelte.dev/docs/modules) that aren't supported. Here's a breakdown of what will and will not work within Storybook:\\n\\n| Module | Status | Note |\\n| ---------------------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\\n| [`$app/environment`](https://kit.svelte.dev/docs/modules#$app-environment) | \\u2705 Supported | `version` is always empty in Storybook. |\\n| [`$app/forms`](https://kit.svelte.dev/docs/modules#$app-forms) | \\u26a0\\ufe0f **Experimental** | See [How to mock](#how-to-mock). |\\n| [`$app/navigation`](https://kit.svelte.dev/docs/modules#$app-navigation) | \\u26a0\\ufe0f **Experimental** | See [How to mock](#how-to-mock). |\\n| [`$app/paths`](https://kit.svelte.dev/docs/modules#$app-paths) | \\u2705 Supported | Requires SvelteKit 1.4.0 or newer. |\\n| [`$app/stores`](https://kit.svelte.dev/docs/modules#$app-stores) | \\u26a0\\ufe0f **Experimental** | See [How to mock](#how-to-mock). |\\n| [`$env/dynamic/public`](https://kit.svelte.dev/docs/modules#$env-dynamic-public) | \\ud83d\\udea7 Partially supported | Only supported in development mode. Storybook is built as a static app with no server-side API, so it cannot dynamically serve content. |\\n| [`$env/static/public`](https://kit.svelte.dev/docs/modules#$env-static-public) | \\u2705 Supported | |\\n| [`$lib`](https://kit.svelte.dev/docs/modules#$lib) | \\u2705 Supported | |\\n| [`@sveltejs/kit/*`](https://kit.svelte.dev/docs/modules#sveltejs-kit) | \\u2705 Supported | |\\n| [`$env/dynamic/private`](https://kit.svelte.dev/docs/modules#$env-dynamic-private) | \\u26d4 Not supported | This is a server-side feature, and Storybook renders all components on the client. |\\n| [`$env/static/private`](https://kit.svelte.dev/docs/modules#$env-static-private) | \\u26d4 Not supported | This is a server-side feature, and Storybook renders all components on the client. |\\n| [`$service-worker`](https://kit.svelte.dev/docs/modules#$service-worker) | \\u26d4 Not supported | This is a service worker feature, which does not apply to Storybook. |\", \"How to mock\": {\"Mocking links\": \"The default link-handling behavior (e.g., when clicking an `<a href=\\\"...\\\" />` element) is to log an action to the [Actions panel](../../essentials/actions.mdx).\\n\\nYou can override this by assigning an object to `parameters.sveltekit_experimental.hrefs`, where the keys are strings representing an href, and the values define your mock. For example:\\n\\n```\\nexport const MyStory = {\\n parameters: {\\n sveltekit_experimental: {\\n hrefs: {\\n '/basic-href': (to, event) => {\\n console.log(to, event);\\n },\\n '/root.*': {\\n callback: (to, event) => {\\n console.log(to, event);\\n },\\n asRegex: true,\\n },\\n },\\n },\\n },\\n};\\n```\\n\\nSee the [API reference](#hrefs) for more information.\"}, \"Writing native Svelte stories\": {\"Setup\": \"If you initialized your project with the Sveltekit framework, the addon has already been installed and configured for you. However, if you're [migrating](#automatic-migration) from a previous version, you'll need to take additional steps to enable this feature.\\n\\nRun the following command to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe CLI's [`add`](../../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\\n\\nUpdate your Storybook configuration file (i.e., `.storybook/main.js|ts`) to enable support for this format.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-svelte-csf-register.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configure\": \"By default, the Svelte [addon](https://storybook.js.org/addons/@storybook/addon-svelte-csf) addon offers zero-config support for Storybook's SvelteKit framework. However, you can extend your Storybook configuration file (i.e., `.storybook/main.js|ts`) and provide additional addon options. Listed below are the available options and examples of how to use them.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n| Options | Description |\\n| ---------------- | ------------------------------------------------------------------------------------------------------------------ |\\n| `legacyTemplate` | Enables support for the `Template` component for backward compatibility. <br/> `options: { legacyTemplate: true }` |\\n\\n<Callout variant=\\\"info\\\">\\n\\nEnabling the `legacyTemplate` option can introduce a performance overhead and should be used cautiously. For more information, refer to the [addon's documentation](https://github.com/storybookjs/addon-svelte-csf/blob/next/README.md#legacy-api).\\n\\n</Callout>\", \"Upgrade to Svelte CSF addon v5\": {\"Simplified story API\": \"If you are using the `Meta` component or the `meta` named export to define the story's metadata (e.g., [parameters](../../writing-stories/parameters.mdx)), you'll need to update your stories to use the new `defineMeta` function. This function returns an object with the required information, including a `Story` component that you must use to define your component stories.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-story-migration.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Story templates\": \"If you used the `Template` component to control how the component renders in the Storybook, this feature was replaced with built-in children support in the `Story` component, enabling you to compose components and define the UI structure directly in the story.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-story-custom-children.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nIf you need support for the `Template` component, the addon provides a feature flag for backward compatibility. For more information, see the [configuration options](#configure).\\n\\n</Callout>\", \"Story slots to snippets\": \"With Svelte's slot deprecation and the introduction of reusable [`snippets`](https://svelte.dev/docs/svelte/v5-migration-guide#Snippets-instead-of-slots), the addon also introduced support for this feature allowing you to extend the `Story` component and provide a custom snippet to provide dynamic content to your stories. `Story` accepts a `template` snippet, allowing you to create dynamic stories without losing reactivity.\\n\\n```\\n<script>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n\\n import MyComponent from './MyComponent.svelte';\\n\\n const { Story } = defineMeta({\\n component: MyComponent,\\n });\\n</script>\\n\\n<Story name=\\\"Default\\\" args={{ exampleProperty: true }}>\\n {#snippet template(args)}\\n <MyComponent {...args}>Reactive component</MyComponent>\\n {/snippet}\\n</Story>\\n```\", \"Tags support\": \"If you enabled automatic documentation generation with the `autodocs` story property, you must replace it with [`tags`](../../writing-stories/tags.mdx). This property allows you to categorize and filter stories based on specific criteria and generate documentation based on the tags applied to the stories.\\n\\n{/* prettier-ignore-start */ }\\n\\n<CodeSnippets path=\\\"svelte-csf-addon-tags.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"API\": {\"Parameters\": {\"`forms`\": {\"`forms.enhance`\": \"Type: `() => void`\\n\\nA callback that will be called when a form with [`use:enhance`](https://kit.svelte.dev/docs/form-actions#progressive-enhancement-use-enhance) is submitted.\"}, \"`hrefs`\": \"Type: `Record<[path: string], (to: string, event: MouseEvent) => void | { callback: (to: string, event: MouseEvent) => void, asRegex?: boolean }>`\\n\\nIf you have an `<a />` tag inside your code with the `href` attribute that matches one or more of the links defined (treated as regex based if the `asRegex` property is `true`) the corresponding `callback` will be called. If no matching `hrefs` are defined, an action will be logged to the [Actions panel](../../essentials/actions.mdx). See [Mocking links](#mocking-links) for an example.\", \"`navigation`\": {\"`navigation.goto`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-goto)\\n\\nA callback that will be called whenever [`goto`](https://kit.svelte.dev/docs/modules#$app-navigation-goto) is called. If no function is provided, an action will be logged to the [Actions panel](../../essentials/actions.mdx).\", \"`navigation.pushState`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-pushstate)\\n\\nA callback that will be called whenever [`pushState`](https://kit.svelte.dev/docs/modules#$app-navigation-pushstate) is called. If no function is provided, an action will be logged to the [Actions panel](../../essentials/actions.mdx).\", \"`navigation.replaceState`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-replacestate)\\n\\nA callback that will be called whenever [`replaceState`](https://kit.svelte.dev/docs/modules#$app-navigation-replacestate) is called. If no function is provided, an action will be logged to the [Actions panel](../../essentials/actions.mdx).\", \"`navigation.invalidate`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-invalidate)\\n\\nA callback that will be called whenever [`invalidate`](https://kit.svelte.dev/docs/modules#$app-navigation-invalidate) is called. If no function is provided, an action will be logged to the [Actions panel](../../essentials/actions.mdx).\", \"`navigation.invalidateAll`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-invalidateall)\\n\\nA callback that will be called whenever [`invalidateAll`](https://kit.svelte.dev/docs/modules#$app-navigation-invalidateall) is called. If no function is provided, an action will be logged to the [Actions panel](../../essentials/actions.mdx).\", \"`navigation.afterNavigate`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-navigation-afternavigate)\\n\\nAn object that will be passed to the [`afterNavigate`](https://kit.svelte.dev/docs/modules#$app-navigation-afternavigate) function, which will be invoked when the `onMount` event fires.\"}, \"`stores`\": {\"`stores.navigating`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-stores-navigating)\\n\\nA partial version of the [`navigating`](https://kit.svelte.dev/docs/modules#$app-stores-navigating) store.\", \"`stores.page`\": \"Type: See [SvelteKit docs](https://kit.svelte.dev/docs/modules#$app-stores-page)\\n\\nA partial version of the [`page`](https://kit.svelte.dev/docs/modules#$app-stores-page) store.\", \"`stores.updated`\": \"Type: boolean\\n\\nA boolean representing the value of [`updated`](https://kit.svelte.dev/docs/modules#$app-stores-updated) (you can also access `updated.check()` which will be a no-op).\"}}, \"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For Sveltekit, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\", \"`docgen`\": {\"When to disable docgen\": \"Disabling docgen can improve build performance for large projects, but [argTypes won't be inferred automatically](../../api/arg-types.mdx#automatic-argtype-inference), which will prevent features like [Controls](../../essentials/controls.mdx) and [docs](../../writing-docs/autodocs.mdx) from working as expected. To use those features, you will need to [define `argTypes` manually](../../api/arg-types.mdx#manually-specifying-argtypes).\"}}}, \"Troubleshooting\": {\"Error when starting Storybook\": \"When starting Storybook after upgrading to v7.0, it may quit with the following error:\\n\\n```\\nERR! SyntaxError: Identifier '__esbuild_register_import_meta_url__' has already been declared\\n```\\n\\nThis can occur when manually upgrading from 6.5 to 7.0. To resolve it, you'll need to remove the `svelteOptions` property in `.storybook/main.js`, as that is not supported (and no longer necessary) in Storybook 7+ with SvelteKit.\"}}, \"metadata\": {\"title\": \"Storybook for SvelteKit\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 7, \"title\": \"SvelteKit\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\"}, {\"title\": \"Storybook for Vue & Vite\", \"description\": null, \"content\": {\"Requirements\": [\"Vue \\u2265 3\", \"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Vue project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/vue3-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"vue3-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"vue3-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"Extending the Vue application\": \"Storybook creates a [Vue 3 application](https://vuejs.org/api/application.html#application-api) for your component preview. When using global custom components (`app.component`), directives (`app.directive`), extensions (`app.use`), or other application methods, you will need to configure those in the `./storybook/preview.js|ts` file.\\n\\nTherefore, Storybook provides you with a `setup` function exported from this package. This function receives your Storybook instance as a callback, which you can interact with and add your custom configuration.\\n\\n```\\nimport { setup } from '@storybook/vue3-vite';\\n\\nsetup((app) => {\\n app.use(MyPlugin);\\n app.component('my-component', MyComponent);\\n app.mixin({\\n // My mixin\\n });\\n});\\n```\", \"Using `vue-component-meta`\": {\"Support for multiple component types\": \"`vue-component-meta` supports all types of Vue components (including SFC, functional, composition/options API components) from `.vue`, `.ts`, `.tsx`, `.js`, and `.jsx` files.\\n\\nIt also supports both default and named component exports.\", \"Prop description and JSDoc tag annotations\": \"To describe a prop, including tags, you can use JSDoc comments in your component's props definition:\\n\\n```\\n<script setup lang=\\\"ts\\\">\\n interface MyComponentProps {\\n /** The name of the user */\\n name: string;\\n /**\\n * The category of the component\\n *\\n * @since 8.0.0\\n */\\n category?: string;\\n }\\n\\n withDefaults(defineProps<MyComponentProps>(), {\\n category: 'Uncategorized',\\n });\\n</script>\\n```\\n\\nThe props definition above will generate the following controls:\\n\\n\", \"Events types extraction\": \"To provide a type for an emitted event, you can use TypeScript types (including JSDoc comments) in your component's `defineEmits` call:\\n\\n```\\n<script setup lang=\\\"ts\\\">\\n type MyChangeEvent = 'change';\\n\\n interface MyEvents {\\n /** Fired when item is changed */\\n (event: MyChangeEvent, item?: Item): void;\\n /** Fired when item is deleted */\\n (event: 'delete', id: string): void;\\n /** Fired when item is upserted into list */\\n (e: 'upsert', id: string): void;\\n }\\n\\n const emit = defineEmits<MyEvents>();\\n</script>\\n```\\n\\nWhich will generate the following controls:\\n\\n\", \"Slots types extraction\": \"The slot types are automatically extracted from your component definition and displayed in the controls panel.\\n\\n```\\n<template>\\n <slot :num=\\\"123\\\"></slot>\\n <br />\\n <slot name=\\\"named\\\" str=\\\"str\\\"></slot>\\n <br />\\n <slot name=\\\"no-bind\\\"></slot>\\n <br />\\n <slot name=\\\"vbind\\\" v-bind=\\\"{ num: 123, str: 'str' }\\\"></slot>\\n</template>\\n\\n<script setup lang=\\\"ts\\\"></script>\\n```\\n\\nIf you use `defineSlots`, you can describe each slot using JSDoc comments in your component's slots definition:\\n\\n```\\ndefineSlots<{\\n /** Example description for default */\\n default(props: { num: number }): any;\\n /** Example description for named */\\n named(props: { str: string }): any;\\n /** Example description for no-bind */\\n noBind(props: {}): any;\\n /** Example description for vbind */\\n vbind(props: { num: number; str: string }): any;\\n}>();\\n```\\n\\nThe definition above will generate the following controls:\\n\\n\", \"Exposed properties and methods\": \"The properties and methods exposed by your component are automatically extracted and displayed in the [Controls](../../essentials/controls.mdx) panel.\\n\\n```\\n<script setup lang=\\\"ts\\\">\\n import { ref } from 'vue';\\n\\n const label = ref('Button');\\n const count = ref(100);\\n\\n defineExpose({\\n /** A label string */\\n label,\\n /** A count number */\\n count,\\n });\\n</script>\\n```\\n\\nThe definition above will generate the following controls:\\n\\n\", \"Override the default configuration\": \"If you're working with a project that relies on [`tsconfig references`](https://www.typescriptlang.org/docs/handbook/project-references.html) to link to other existing configuration files (e.g., `tsconfig.app.json`, `tsconfig.node.json`), we recommend that you update your [`.storybook/main.js|ts`](../../configure/index.mdx) configuration file and add the following:\\n\\n```\\nimport type { StorybookConfig } from '@storybook/vue3-vite';\\n\\nconst config: StorybookConfig = {\\n framework: {\\n name: '@storybook/vue3-vite',\\n options: {\\n docgen: {\\n plugin: 'vue-component-meta',\\n tsconfig: 'tsconfig.app.json',\\n },\\n },\\n },\\n};\\n\\nexport default config;\\n```\\n\\n<Callout variant=\\\"info\\\">\\nThis is not a limitation of Storybook, but how `vue-component-meta` works. For more information, refer to the appropriate [GitHub issue](https://github.com/vuejs/language-tools/issues/3896).\\n</Callout>\\n\\nOtherwise, you might face missing component types/descriptions or unresolvable import aliases like `@/some/import`.\"}, \"Troubleshooting\": {\"Storybook doesn't work with my Vue 2 project\": \"[Vue 2 entered End of Life](https://v2.vuejs.org/lts/) (EOL) on December 31st, 2023, and is no longer maintained by the Vue team. As a result, Storybook no longer supports Vue 2. We recommend you upgrade your project to Vue 3, which Storybook fully supports. If that's not an option, you can still use Storybook with Vue 2 by installing the latest version of Storybook 7 with the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-init-v7.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\", \"`docgen`\": {\"When to disable docgen\": \"Disabling docgen can improve build performance for large projects, but [argTypes won't be inferred automatically](../../api/arg-types.mdx#automatic-argtype-inference), which will prevent features like [Controls](../../essentials/controls.mdx) and [docs](../../writing-docs/autodocs.mdx) from working as expected. To use those features, you will need to [define `argTypes` manually](../../api/arg-types.mdx#manually-specifying-argtypes).\"}}}}, \"metadata\": {\"title\": \"Storybook for Vue & Vite\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 9, \"title\": \"Vue & Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\"}, {\"title\": \"Storybook for Web components & Vite\", \"description\": null, \"content\": {\"Requirements\": [\"Vite \\u2265 5.0\"], \"Getting started\": {\"In a project without Storybook\": \"Follow the prompts after running this command in your Web components project's root directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[More on getting started with Storybook.](../install.mdx)\", \"In a project with Storybook\": {\"Automatic migration\": \"When running the `upgrade` command above, you should get a prompt asking you to migrate to `@storybook/web-components-vite`, which should handle everything for you. In case that auto-migration does not work for your project, refer to the manual migration below.\", \"Manual migration\": \"First, install the framework:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"web-components-vite-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen, update your `.storybook/main.js|ts` to change the framework property:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"web-components-vite-add-framework.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"API\": {\"Options\": {\"`builder`\": \"Type: `Record<string, any>`\\n\\nConfigure options for the [framework's builder](../../api/main-config/main-config-framework.mdx#optionsbuilder). For this framework, available options can be found in the [Vite builder docs](../../builders/vite.mdx).\"}}}, \"metadata\": {\"title\": \"Storybook for Web components & Vite\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 10, \"title\": \"Web components & Vite\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\"}], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7]\"}], \"path\": \"[\\\"subpages\\\", 9]\"}, {\"title\": \"Releases\", \"description\": \"Documentation section: releases\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/releases\"}, \"subpages\": [{\"title\": \"Features Lifecycle\", \"description\": null, \"content\": {\"Experimental\": \"This stage marks the beginning of a feature\\u2019s development, where we\\u2019re validating ideas and shaping direction. \\n\\nExperimental features are functional but still evolving, with room for iteration based on real-world use. They\\u2019re ideal for trying out in prototypes or early integrations, not yet something to build critical paths around. Each experimental feature comes with an [RFC](https://github.com/storybookjs/storybook/discussions/categories/rfc) where we share the initial idea and report progress. We strongly encourage feedback to help guide the next steps. \\n\\nDuring this stage, we\\u2019re committed to fully exploring the concept. As such, specific implementation details may change significantly before stabilization.\", \"Preview\": \"Preview features are nearly production-ready and generally reliable, with documentation in place and most known issues addressed. They should be fully functional for at least one supported framework, but may still be incomplete or less polished in others. These features are suitable for use in real projects, and we encourage teams to adopt them and share feedback. \\n\\nWhile the feature is stable in direction, we may introduce minimal breaking changes in minor releases to address gaps or refine behavior. In those cases, we provide automigrations where possible to ease the transition. We aim to collect feedback and iterate for 1-2 minor releases before promoting to stable.\", \"Stable\": \"Stable features are fully supported and safe for production use across all projects. They are well-documented, thoroughly tested in all of our core frameworks, and follow [semantic versioning](https://semver.org). Users can expect long-term support, with any breaking changes reserved for major releases.\", \"Deprecated\": \"Deprecated features are in the process of being phased out and will be removed in an upcoming major release. Users should begin migrating to supported alternatives as soon as possible. These features no longer receive active development or bug fixes, and their functionality may degrade over time. While they may still work, they should not be used for new development. \\n\\nTypically, a deprecated feature is removed within the next major release cycle (for example, if deprecated in 8.x, removal is expected in 9.0).\"}, \"metadata\": {\"title\": \"Features Lifecycle\", \"sidebar\": {\"order\": 4, \"title\": \"Feature Lifecycle\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 0]\"}, {\"title\": \"How we release Storybook\", \"description\": null, \"content\": {\"Release Channels\": \"We publish releases on two channels. You can install a specific channel via npm tags:\\n\\n['**Stable channel** (`latest`): Installs the latest stable release.']\\n\\n```\\nnpm create storybook@latest\\n```\\n\\n['**Pre-release channel** (`next`): Installs the latest [pre-release](#pre-release).']\\n\\n```\\nnpm create storybook@next\\n```\", \"Supported Versions\": \"We actively maintain the latest major version of Storybook. Within the current major, we patch only the latest minor version. Most fixes and new work go into the next minor (or sometimes major) and are not backported. Critical security fixes may be backported more broadly across the current major version, and in rare cases (such as for a short period immediately following a new major), to the previous major.\\n\\nFor example, if the latest version is `9.2.1`:\\n\\n['We support `9.x.x` versions and release `9.2.x` patch versions', 'Most fixes and new work will be released as `9.3.0-alpha.x` versions', ['If the next release is a major version, it would be `10.0.0-alpha.x`'], 'We will backport critical security fixes to `9.1.x` or `9.0.x`', 'Rarely, we may backport critical fixes to `8.6.x` as necessary']\\n\\nFor compatibility with other libraries and tools in the JavaScript ecosystem, please refer to the [compatibility tracker](https://github.com/storybookjs/storybook/issues/23279).\", \"Release Cycle\": \"Major Release\\n\\n**Cadence**: Roughly once per year\\n\\n**Channel**: Stable (`latest`)\\n\\nMajor releases introduce breaking changes and significant new features. We use major releases to keep up with ecosystem changes, evolve Storybook\\u2019s architecture and APIs, and make the tool faster, leaner, and easier to use. \\n\\nOnce we start working on a major release, we pause minor releases but continue to ship patch releases as needed. Major releases go through a sequence of [pre-releases](#pre-release)\\u2014`alpha`, `beta`, and `rc` (release candidate)\\u2014before landing in the stable channel. We aim to include automated migrations and provide [a comprehensive migration guide](../releases/migration-guide.mdx) when manual changes are necessary.\\n\\n<Callout variant=\\\"info\\\">\\nStorybook versions prior to 7 had a very different architecture. As a result, upgrading from v6 to newer versions can be more challenging. Starting in v7, we\\u2019ve focused heavily on smoother migrations. Upgrades from v7 to v8, and v8 to v9 (and beyond), should feel significantly easier thanks to automigrations and better tooling.\\n</Callout>\\n\\nMinor Release\\n\\n**Cadence**: Roughly every 8 weeks\\n\\n**Channel**: Stable (`latest`)\\n\\nMinor releases deliver new features, enhancements, and non-breaking improvements. Each minor release may be preceded by an alpha [pre-release](#pre-release) (e.g. `x.y.0-alpha`).\\n\\nPatch Release\\n\\n**Cadence**: as needed (only for the current minor)\\n\\n**Channel**: Stable (`latest`)\\n\\nPatch releases include critical bug fixes and security updates. These are issued only for the current minor version and are not pre-released.\\n\\nPre-release\\n\\n**Cadence**: Regularly\\n\\n**Channel**: Pre-release (`next`)\\n\\nPre-releases are created to gather early feedback and ensure stability before an official release. Minor version stable releases are preceded by pre-releases with an `alpha` tag (e.g. `x.y.0-alpha`), with no patch pre-releases. Major version stable releases are preceded by a fuller cycle of `alpha`, `beta`, and `rc` pre-releases before the final release.\"}, \"metadata\": {\"title\": \"How we release Storybook\", \"sidebar\": {\"order\": 11, \"title\": \"Releases\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 1]\"}, {\"title\": \"Migration guide from Storybook 7.x to 8.6\", \"description\": null, \"content\": {\"Major breaking changes\": \"The rest of this guide will help you upgrade successfully, either automatically or manually. But first, there are some [breaking changes][full-migration-notes] in Storybook 8. Here are the most impactful changes you should know about before you go further:\\n\\n['[`storiesOf` API has been removed](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removal-of-storiesof-api)', '[`*.stories.mdx` format has been removed](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropping-support-for-storiesmdx-csf-in-mdx-format-and-mdx1-support)', '[Packages have been consolidated/removed](#package-structure-changes)', '[Implicit actions (from `argTypesRegex`) can no longer be used during rendering (e.g. in a play function)](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#implicit-actions-can-not-be-used-during-rendering-for-example-in-the-play-function)', '[`react-docgen` (instead of `react-docgen-typescript`) is the default for component analysis](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#react-docgen-component-analysis-by-default)', '[Storyshots has been removed](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#storyshots-has-been-removed)', '[Addons API introduced in Storybook 7 is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#new-addons-api)', 'Ecosystem updates', ['[Node 18+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropping-support-for-nodejs-16)', '[Next.js 13.5+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#require-nextjs-135-and-up)', '[Vue 3+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#require-vue-3-and-up)', '[Angular 15+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#require-angular-15-and-up)', '[Svelte 4+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#require-svelte-4-and-up)', '[Yarn 1 is no longer supported](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropping-support-for-yarn-1)']]\\n\\nIf any of these changes apply to your project, please read through the linked migration notes before continuing.\\n\\nIf any of these new requirements or changes are blockers for your project, we recommend to continue using Storybook 7.x.\\n\\nYou may wish to read the [full migration notes][full-migration-notes] before migrating. Or you can follow the instructions below and we\\u2019ll try to take care of everything for you!\", \"Automatic upgrade\": {\"Common upgrade issues\": {\"`storyStoreV7:false` and `storiesOf`\": \"If you have `storyStoreV7: false` in your `.storybook/main.js`, you will need to remove it before you're able to upgrade to Storybook 8.\\n\\nIf you are using the `storiesOf` API (which requires `storyStoreV7: false` in Storybook 7), you will need to either [migrate your stories to CSF](../../../release-7-6/docs/migration-guide.mdx#storiesof-to-csf) or use the [new indexer API to continue creating stories dynamically](../../../release-7-6/docs/migration-guide.mdx#storiesof-to-dynamically-created-stories).\", \"Missing `vite.config.js` file\": \"If you are using Vite, you may now need to create a `vite.config.js` file in your project root to allow newer versions of Vite to work with Storybook. Additionally, you may need to install and configure a Vite plugin for your framework. More information is available in the [full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#framework-specific-vite-plugins-have-to-be-explicitly-added).\"}}, \"New projects\": \"To add Storybook to a project that isn\\u2019t currently using Storybook:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis will:\\n\\n['Figure out which renderer (React, Vue, Angular, Web Components), builder (Webpack, Vite), or meta-framework (Next.js, SvelteKit) you\\u2019re using', 'Install Storybook 8 and auto-configure it to mirror project settings']\", \"Manual migrations\": {\"`*.stories.mdx` to MDX+CSF\": {\"Known limitations\": [\"The codemod does not remove the extracted stories from the `.stories.mdx` files. You will need to do this manually.\"]}}, \"Troubleshooting\": \"The automatic upgrade should get your Storybook into a working state. If you encounter an error running Storybook after upgrading, here\\u2019s what to do:\\n\\n['Try running the [`doctor` command](../api/cli-options.mdx#doctor) to check for common issues (such as duplicate dependencies, incompatible addons, or mismatched versions) and see suggestions for fixing them.', 'If you\\u2019re running `storybook` with the `dev` command, try using the `build` command instead. Sometimes `build` errors are more legible than `dev` errors!', 'Check [the full migration notes][full-migration-notes], which contains an exhaustive list of noteworthy changes in Storybook 8. Many of these are already handled by automigrations when you upgrade, but not all are. It\\u2019s also possible that you\\u2019re experiencing a corner case that we\\u2019re not aware of.', 'Search [Storybook issues on GitHub](https://github.com/storybookjs/storybook/issues). If you\\u2019re seeing a problem, there\\u2019s a good chance other people are too. If so, upvote the issue, try out any workarounds described in the comments, and comment back if you have useful info to contribute.', 'If there\\u2019s no existing issue, you can [file one](https://github.com/storybookjs/storybook/issues/new/choose), ideally with a reproduction attached. We\\u2019ll be on top of Storybook 8 issues as we\\u2019re stabilizing the release.']\\n\\nIf you prefer to debug yourself, here are a few useful things you can do to help narrow down the problem:\\n\\n[\\\"Try removing all addons that are not in the `@storybook` npm namespace (make sure you don't remove the `storybook` package). Community addons that work well with 7.x might not yet be compatible with 8.0, and this is the fastest way to isolate that possibility. If you find an addon that needs to be upgraded to work with Storybook 8, please post an issue on the addon\\u2019s repository, or better yet, a pull request to upgrade it!\\\", 'Another debugging technique is to bisect to older prerelease versions of Storybook to figure out which release broke your Storybook. For example, assuming that the current prerelease of Storybook is `8.0.0-beta.56`, you could set the version to `8.0.0-alpha.0` in your `package.json` and reinstall to verify that it still works (`alpha.0` should be nearly identical to `7.6.x`). If it works, you could then try `8.0.0-beta.0`, then `8.0.0-beta.28` and so forth. Once you\\u2019ve isolated the bad release, read through its [CHANGELOG](https://github.com/storybookjs/storybook/blob/next/CHANGELOG.md) entry and perhaps there\\u2019s a change that jumps out as the culprit. If you find the problem, please submit an issue or pull request to the Storybook monorepo and we\\u2019ll do our best to take care of it quickly.']\", \"Package structure changes\": \"The following packages are **removed**. See the [full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-deprecated-shim-packages) for details.\\n\\n| Removal | Replacement |\\n| -------------------------------- | ----------------------------------------------------- |\\n| `@storybook/addons` | `@storybook/manager-api` or `@storyboook/preview-api` |\\n| `@storybook/channel-postmessage` | `@storybook/channels` |\\n| `@storybook/channel-websocket` | `@storybook/channels` |\\n| `@storybook/client-api` | `@storybook/preview-api` |\\n| `@storybook/core-client` | `@storybook/preview-api` |\\n| `@storybook/preview-web` | `@storybook/preview-api` |\\n| `@storybook/store` | `@storybook/preview-api` |\\n| `@storybook/api` | `@storybook/manager-api` |\\n\\nThe following packages are **deprecated**. See the [full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#deprecated-storybooktesting-library-package) for details.\\n\\n| Deprecation | Replacement |\\n| ---------------------------- | ----------------- |\\n| `@storybook/testing-library` | `@storybook/test` |\", \"Optional migrations\": {\"CSF 2 to CSF 3\": \"There are [many good reasons](/blog/storybook-csf3-is-here/) to convert your stories from CSF 2 to CSF 3. We provide a codemod which, in most cases, should automatically make the code changes for you (make sure to update the glob to fit your files):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-migrate-csf-2-to-3.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Migration guide from Storybook 7.x to 8.6\", \"sidebar\": {\"order\": 2, \"title\": \"Migrate from 7 to 8\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 2]\"}, {\"title\": \"Migration guide for Storybook 9\", \"description\": null, \"content\": {\"Major breaking changes\": \"The rest of this guide will help you upgrade successfully, either automatically or manually. But first, there are some [breaking changes][full-migration-notes] in Storybook 9. Here are the most impactful changes you should know about before you go further:\\n\\n['[Packages have been consolidated/removed](#package-structure-changes)', '[Essential addons moved to core](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#essentials-addons-viewport-controls-interactions-and-actions-moved-to-core)', '[Test addon renamed from `experimental-addon-test` to `addon-vitest`](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#experimental-test-addon-stabilized-and-renamed)', '[`nextjs-vite` framework stabilized](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#nextjs-vite-builder-stabilized)', '[Removed Webpack builder support for Preact, Vue, and Web Components in favor of Vite](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-webpack5-builder-support-in-favor-of-vite)', '[Manager builder removed alias for `util`, `assert` and `process`](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#manager-builder-removed-alias-for-util-assert-and-process)', 'Ecosystem updates', ['[Node 20+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#nodejs--20)', '[Angular 18+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#angular-require-v18-and-up)', '[Lit v3+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#lit--require-v3-and-up)', '[Next.js 14+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#nextjs-require-v14-and-up)', '[Svelte 5+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#svelte-require-v5-and-up)', '[Vite 5+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vite-4)', '[Vitest 3+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#vitest-addon-former-storybookexperimental-addon-test-vitest-20-support-is-dropped)', '[npm 10+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#package-managers)', '[pnpm 9+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#package-managers)', '[yarn 4+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#package-managers)', '[TypeScript 4.9+ is now required](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#typescript--49)']]\\n\\nIf any of these changes apply to your project, please read through the linked migration notes before continuing.\\n\\nIf any of these new requirements or changes are blockers for your project, we recommend to continue using Storybook 8.x.\\n\\nYou may wish to read the [full migration notes][full-migration-notes] before migrating. Or you can run the upgrade command below and we\\u2019ll try to take care of everything for you!\", \"Automatic upgrade\": \"To upgrade your Storybook, run the [upgrade](./upgrading.mdx) command in the root of your repository:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-upgrade.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis will:\\n\\n['Find all of the Storybook projects in your repository', 'For each project', ['Determine that none of the [breaking changes](#major-breaking-changes) apply to your project', ['If they do, you will receive instructions on how to resolve them before continuing'], 'Upgrade your Storybook dependencies to the latest version', 'Run a collection of *automigrations*, which will:', ['Check for common upgrade tasks', 'Explain the necessary changes with links to more information', 'Ask for approval, then perform the task automatically on your behalf']]]\", \"New projects\": \"To add Storybook to a project that isn\\u2019t currently using Storybook:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"create-command.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis will:\\n\\n['Figure out which renderer (React, Vue, Angular, Web Components), builder (Webpack, Vite), or meta-framework (Next.js, SvelteKit) you\\u2019re using', 'Install Storybook 9 and auto-configure it to mirror project settings']\", \"Troubleshooting\": \"The automatic upgrade should get your Storybook into a working state. If you encounter an error running Storybook after upgrading, here\\u2019s what to do:\\n\\n['Try running the [`doctor` command](../api/cli-options.mdx#doctor) to check for common issues (such as duplicate dependencies, incompatible addons, or mismatched versions) and see suggestions for fixing them.', 'If you\\u2019re running `storybook` with the `dev` command, try using the `build` command instead. Sometimes `build` errors are more legible than `dev` errors!', 'Check [the full migration notes][full-migration-notes], which contains an exhaustive list of noteworthy changes in Storybook 9. Many of these are already handled by automigrations when you upgrade, but not all are. It\\u2019s also possible that you\\u2019re experiencing a corner case that we\\u2019re not aware of.', 'Search [Storybook issues on GitHub](https://github.com/storybookjs/storybook/issues). If you\\u2019re seeing a problem, there\\u2019s a good chance other people are too. If so, upvote the issue, try out any workarounds described in the comments, and comment back if you have useful info to contribute.', 'If there\\u2019s no existing issue, you can [file one](https://github.com/storybookjs/storybook/issues/new/choose), ideally with a reproduction attached. We\\u2019ll be on top of Storybook 9 issues as we\\u2019re stabilizing the release.']\\n\\nIf you prefer to debug yourself, here are a few useful things you can do to help narrow down the problem:\\n\\n[\\\"Try removing all addons that are not in the `@storybook` npm namespace (make sure you don't remove the `storybook` package). Community addons that work well with 8.x might not yet be compatible with 9.x, and this is the fastest way to isolate that possibility. If you find an addon that needs to be upgraded to work with Storybook 9, please post an issue on the addon\\u2019s repository, or better yet, a pull request to upgrade it!\\\", 'Another debugging technique is to bisect to older prerelease versions of Storybook to figure out which release broke your Storybook. For example, assuming that the current prerelease of Storybook is `9.0.0-beta.56`, you could set the version to `9.0.0-alpha.0` in your `package.json` and reinstall to verify that it still works (`alpha.0` should be nearly identical to `8.6.x`). If it works, you could then try `9.0.0-beta.0`, then `9.0.0-beta.28` and so forth. Once you\\u2019ve isolated the bad release, read through its [CHANGELOG](https://github.com/storybookjs/storybook/blob/next/CHANGELOG.prerelease.md) entry and perhaps there\\u2019s a change that jumps out as the culprit. If you find the problem, please submit an issue or pull request to the Storybook monorepo and we\\u2019ll do our best to take care of it quickly.']\", \"Package structure changes\": \"The following packages are no longer published. Instead they have been consolidated into Storybook's core package, `storybook`. If a consolidated package had exports, those are available via the replacement path in the table below. See the [full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-legacy-packages) for details.\\n\\n| Removal | Replacement |\\n| ------------------------------- | ----------------------- |\\n| `@storybook/addon-actions` | `storybook/actions` |\\n| `@storybook/addon-backgrounds` | N/A |\\n| `@storybook/addon-controls` | N/A |\\n| `@storybook/addon-highlight` | `storybook/highlight` |\\n| `@storybook/addon-interactions` | N/A |\\n| `@storybook/addon-measure` | N/A |\\n| `@storybook/addon-outline` | N/A |\\n| `@storybook/addon-toolbars` | N/A |\\n| `@storybook/addon-viewport` | `storybook/viewport` |\\n| `@storybook/manager-api` | `storybook/manager-api` |\\n| `@storybook/preview-api` | `storybook/preview-api` |\\n| `@storybook/test` | `storybook/test` |\\n| `@storybook/theming` | `storybook/theming` |\\n\\nThe following packages have been consolidated and moved into an internal path to indicate that they are now for internal usage only. They will continue to work in `9.x` releases, but will likely be removed in `10.0`. See the [full migration notes](https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#dropped-support-for-legacy-packages) for details.\\n\\n| Deprecation | Replacement |\\n| ---------------------------- | ------------------------------------- |\\n| `@storybook/builder-manager` | `storybook/internal/builder-manager` |\\n| `@storybook/channels` | `storybook/internal/channels` |\\n| `@storybook/client-logger` | `storybook/internal/client-logger` |\\n| `@storybook/components` | `storybook/internal/components` |\\n| `@storybook/core-common` | `storybook/internal/common` |\\n| `@storybook/core-events` | `storybook/internal/core-events` |\\n| `@storybook/core-server` | `storybook/internal/core-server` |\\n| `@storybook/csf-tools` | `storybook/internal/csf-tools` |\\n| `@storybook/docs-tools` | `storybook/internal/docs-tools` |\\n| `@storybook/manager` | `storybook/internal/manager` |\\n| `@storybook/node-logger` | `storybook/internal/node-logger` |\\n| `@storybook/preview` | `storybook/internal/preview` |\\n| `@storybook/router` | `storybook/internal/router` |\\n| `@storybook/telemetry` | `storybook/internal/telemetry` |\\n| `@storybook/types` | `storybook/internal/types` |\\n\\nAddon authors may continue to use the internal packages, there is currently not yet any replacement.\", \"Optional migrations\": {\"`test-runner` to `addon-vitest`\": \"`addon-vitest` and the rest of the [Storybook Test experience](https://storybook.js.org/blog/storybook-test-sneak-peek/) is designed to supercede the `test-runner`. It's faster and provides a better experience for writing and running tests. If your project uses React, Vue, or Svelte and is built with Vite, you should consider migrating to `addon-vitest`, by following the [installation instructions](../writing-tests/integrations/vitest-addon.mdx#automatic-setup).\", \"CSF 2 to CSF 3\": \"There are [many good reasons](/blog/storybook-csf3-is-here/) to convert your stories from CSF 2 to CSF 3. We provide a codemod which, in most cases, should automatically make the code changes for you (make sure to update the glob to fit your files):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-migrate-csf-2-to-3.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Migration guide for Storybook 9\", \"sidebar\": {\"order\": 1, \"title\": \"Migrate to Storybook 9\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 3]\"}, {\"title\": \"Roadmap\", \"description\": null, \"content\": {\"What's in the roadmap?\": {\"Candidates\": \"These cards are ideas on our radar that we are considering for the current major release. For example, if `8.0` is the most recent major version, these would be ideas for `8.x` or `9.0`. The ideas in this column are the fuzziest and may come and go depending on our priorities.\", \"Under consideration\": \"These are projects being discussed for the next dev cycle. For example, if the most recent minor version is `8.1`, and we are currently working on `8.2`, the projects in this column would be under consideration for `8.3`. Unlike the candidates column, which can contain any idea, the projects under consideration must be documented with an [RFC](./RFC.mdx).\", \"In progress\": \"These are projects that we are currently working on. There are two kinds of projects in this column:\\n\\n['**[Tracking issues](https://github.com/storybookjs/storybook/issues?q=is%3Aissue++sort%3Aupdated-desc+label%3ATracking+)**: Fully scoped projects expected to ship in the next minor release. For example, if the most recent minor is `8.1`, these should ship in `8.2`, eight weeks after `8.1`.', \\\"**Other projects**: Community projects facilitated by the core team and side projects. These don't have an ETA but we will push to have them ready as part of the current major. For example, if `8.0` is the most recent major version, these should ship in `8.x` or `9.0`.\\\"]\", \"Done\": \"These projects are completed, documented, and released. We follow a \\\"fixed time, variable scope\\\" policy for core projects, which means we scope a project into milestones to provide the most value to users as early as possible and cut scope if necessary to ship on time. If a feature has been scoped out of a project, we might try to fit it into a follow-up project, treat it as general maintenance work, or forget about it. Storybook is open source, so PR contributions are always welcome!\"}, \"Frequently asked questions\": {\"When will project X be available?\": \"This roadmap is an estimation, not a commitment. In general, every tracking issue \\\"in progress\\\" should be available in the next two months. Everything else on the board has a decent chance of getting into the next major release. For example, if `8.0` is the most recent major release, we will try to ship everything on the board as part of `8.x` or `9.0`. If we don't think a project is likely for the next major, we will kick it off the board.\", \"What about issue Y or discussion Z?\": \"The Storybook core team and our community members continuously contribute bug fix bugs and smaller product improvements. The projects here are larger chunks of work. In some cases they may close out certain issues, and when possible we will call those out in the RFC or project tracking issue.\", \"How do I get something onto the board?\": \"If there's a significant product improvement that you want to see, and there is currently an issue or an [RFC](./RFC.mdx) for it, upvote that issue/discussion, and comment on it with more information about your need or use case if it's not currently captured. If you don't see anything that's quite right, please feel free to [submit an RFC](https://github.com/storybookjs/storybook/discussions/new?category=rfc). We prioritize based on a combination of user/contributor interest (upvotes, comments, [Discord](https://discord.gg/storybook) conversations, etc.) and our own strategic ambitions for the project.\"}}, \"metadata\": {\"title\": \"Roadmap\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"Roadmap\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 4]\"}, {\"title\": \"Upgrading Storybook\", \"description\": null, \"content\": {\"Upgrade script\": {\"Mono-repository support\": {\"Limiting scope in large mono-repositories\": \"For large mono-repositories where you want to limit the upgrade to a specific directory, use the `STORYBOOK_PROJECT_ROOT` environment variable:\\n\\n```\\nSTORYBOOK_PROJECT_ROOT=./packages/frontend storybook@latest upgrade\\n```\\n\\nThis is especially helpful in huge mono-repositories with semi-encapsulated Storybooks.\"}}, \"Upgrade process\": {\"Automatic health check\": \"The upgrade script automatically runs a health check on all detected Storybook projects after the upgrade. This verifies that the upgrade was completed successfully and checks for common issues that might arise after an upgrade, such as duplicated dependencies, incompatible addons, or mismatched versions.\\n\\nThe health check runs automatically for all detected Storybooks. You can also run it manually at any time using the `storybook doctor` command:\\n\\n<CodeSnippets path=\\\"storybook-doctor.md\\\" />\", \"Error handling and debugging\": \"If you encounter issues during the upgrade:\\n\\n['A `debug-storybook.log` file will be created in the repository root containing all relevant logs', 'For more detailed information, set the log level to `debug` using the `--loglevel debug` flag', 'Create a GitHub issue with the logs if you need help resolving the problem']\"}, \"Command-line options\": {\"Available flags\": \"| Flag | Description |\\n| -------------------------------- | ------------------------------------------------------------------------------------------ |\\n| `-c, --config-dir <dir-name...>` | Directory or directories to find Storybook configurations |\\n| `--debug` | Enable more logs for debugging (default: false) |\\n| `--disable-telemetry` | Disable sending telemetry data |\\n| `--enable-crash-reports` | Enable sending crash reports to telemetry data |\\n| `-f, --force` | Force the upgrade, skipping autoblockers |\\n| `--loglevel <level>` | Define log level: `debug`, `error`, `info`, `silent`, `trace`, or `warn` (default: `info`) |\\n| `--package-manager <manager>` | Force package manager: `npm`, `pnpm`, `yarn1`, `yarn2`, or `bun` |\\n| `-s, --skip-check` | Skip postinstall version and automigration checks |\\n| `--write-logs` | Write all debug logs to a file at the end of the run |\\n| `-y, --yes` | Skip prompting the user |\", \"Example usage\": \"```\\n# Upgrade with logging for debugging\\nstorybook@latest upgrade --loglevel debug --write-logs\\n\\n# Force upgrade without prompts\\nstorybook@latest upgrade --force --yes\\n\\n# Upgrade specific config directories only\\nstorybook@latest upgrade --config-dir .storybook-app .storybook-ui\\n```\"}, \"Automigrate script\": \"Storybook upgrades are not the only thing to consider: changes in the ecosystem also present challenges. For example well-known frontend frameworks, such as [Angular](https://update.angular.io/?l=2\\\\&v=16.0-17.0), [Next.js](https://nextjs.org/docs/pages/building-your-application/upgrading) or [Svelte](https://svelte.dev/docs/v4-migration-guide) have been rolling out significant changes to their ecosystem, so even if you don't upgrade your Storybook version, you might need to update your configuration accordingly. That's what Automigrate is for:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-automigrate.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIt runs a set of standard configuration checks, explains what is potentially out-of-date, and offers to fix it for you automatically. It also points to the relevant documentation so you can learn more. It runs automatically as part of [`storybook upgrade`](#upgrade-script) command, but it's also available on its own if you don't want to upgrade Storybook.\", \"Prereleases\": \"In addition to the above, Storybook is under constant development, and we publish pre-release versions almost daily. Pre-releases are the best way to try out new features before they are generally available, and we do our best to keep them as stable as possible, although this is not always possible.\\n\\nTo upgrade to the latest pre-release:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-upgrade-prerelease.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe `upgrade` command will use whichever version you specify. For example:\\n\\n['`storybook@next upgrade` will upgrade to the newest pre-release version', '`storybook@8.0.0-beta.1 upgrade` will upgrade to `8.0.0-beta.1`', '`storybook@8 upgrade` will upgrade to the newest `8.x` version']\\n\\nIf you'd like to downgrade to a stable version, manually edit the package version numbers in your `package.json` and re-install.\\n\\n<Callout variant=\\\"info\\\">\\nStorybook collects completely anonymous data to help us improve user experience. Participation is optional, and you may [opt-out](../configure/telemetry.mdx#how-to-opt-out) if you'd not like to share any information.\\n</Callout>\", \"Troubleshooting\": {\"Storybook doesn't detect my Storybook project\": \"By default, the upgrade script will attempt to find Storybook configuration in `.storybook` directories in your repository. If your Storybook configuration is located in a different directory, you can specify it using the `--config-dir` flag.\\n\\nThe `--config-dir` flag can accept multiple directories.\\n\\n```\\nstorybook@latest upgrade --config-dir .storybook-app .storybook-ui\\n```\\n\\nIf your project can be detected, but you get an error during the detection process, please check the `debug-storybook.log` file in the root of your repository. It will contain the full output of the detection process and will help you troubleshoot the issue.\", \"Storybook doesn't automigrate non-Storybook files\": \"Our automigrations usually only transform and migrate files inside of your `.storybook` directory and your story and mdx files, which are mentioned as part of the Storybook configuration.\\n\\nIf you have other files that contain Storybook-specific code, you might need to manually migrate them.\\n\\n<IfRenderer renderer=\\\"vue\\\">\", \"Storybook doesn't upgrade to the latest version when using Vue 2\": \"If you're attempting to upgrade Storybook to the latest version in your existing Vue 2 project, you will no longer be able to. This is because Vue 2 entered [End of Life](https://v2.vuejs.org/lts/) (EOL) on December 31st, 2023, and will no longer receive any updates from the Vue team. We recommend you upgrade your Vue 2 project to Vue 3 and then upgrade Storybook to the latest version. If you cannot upgrade your Vue 2 project to Vue 3, you can still upgrade Storybook, but only for the latest 7.x version. You can do this by running the following command:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"upgrade-command-specific-version.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</IfRenderer>\"}}, \"metadata\": {\"title\": \"Upgrading Storybook\", \"sidebar\": {\"order\": 3, \"title\": \"Upgrading\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 10, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 10]\"}, {\"title\": \"Sharing\", \"description\": \"Documentation section: sharing\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/sharing\"}, \"subpages\": [{\"title\": \"Design integrations\", \"description\": null, \"content\": {\"Figma\": {\"Embed Storybook in Figma with the plugin\": {\"Install plugin\": \"Before we begin, you must have a Storybook [published to Chromatic](./publish-storybook.mdx#publish-storybook-with-chromatic). It provides the index, versions, and access control that back the plugin.\\n\\nGo to [Storybook Connect](https://www.figma.com/community/plugin/1056265616080331589/Storybook-Connect) to install the plugin.\\n\\nIn Figma, open the command palette (in Mac OS, use `Command + /`, in Windows use `Control + /`) and type `Storybook Connect` to enable it.\\n\\n\\n\\nFollow the instructions to connect and authenticate with Chromatic.\", \"Link stories to Figma components\": \"Link stories to Figma components, variants, and instances.\\n\\nGo to a story in a Storybook published on Chromatic. Make sure it\\u2019s on the branch you want to link. Then copy the URL to the story.\\n\\nIn Figma, select the component, open the plugin, and paste the URL.\\n\\n\\n\\nChromatic will automatically update your linked stories to reflect the most recent Storybook published on the branch you linked. That means the link persists even as you push new code.\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe plugin does not support linking stories to Figma layers.\\n</Callout>\", \"View stories in Figma\": \"Once they're connected, you'll be able to view the story by clicking the link in the sidebar. Click \\\"View story\\\". Alternatively, open the plugin by using the command palette (in Mac OS, use `Command + /`, in Windows, use `Control + /`), then type `Storybook Connect`.\\n\\n\"}, \"Embed Figma in Storybook with the addon\": {\"Install design addon\": \"Run the following command to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-figma-addon-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe CLI's [`add`](../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\", \"Link Figma components to stories\": \"In Figma, open the file you want to embed in Storybook. You can embed files, prototypes, components, and frames.\\n\\n['Embed a file or prototype, click the \\\"Share\\\" button to generate a unique URL for the file then click \\\"Copy link\\\".', 'Embed a component or frame check \\\"Link to selected frame\\\" in the Share dialog. Or right click on the frame and go to \\\"Copy/Paste as\\\" \\u00bb \\\"Copy link\\\".']\\n\\nIn Storybook, add a new [parameter](../writing-stories/parameters.mdx) named `design` to your story and paste the Figma URL. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-story-figma-integration.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"View designs in Storybook\": \"Click the \\\"Design\\\" tab in the addon panel to view the embedded Figma design.\\n\\n\"}}, \"Zeplin\": \"[Zeplin](https://zeplin.io/) is a design tool that generates styleguides from [Sketch](https://www.sketch.com/), [Figma](https://www.figma.com/), and [Adobe XD](https://www.adobe.com/products/xd.html).\\n\\nUse the [Zeplin addon](https://storybook.js.org/addons/storybook-zeplin) to connect Storybook. The addon displays designs from Zeplin alongside the currently selected story. It includes convenient tooling to overlay the design image atop the live component.\\n\\nZeplin's native app also supports [links to published Storybooks](https://support.zeplin.io/en/articles/5674596-connecting-your-storybook-instance-with-zeplin).\\n\\n\", \"Zeroheight\": \"[Zeroheight](https://zeroheight.com/) is a collaborative styleguide generator for design systems. It showcases design, code, brand, and copywriting documentation in one place. Users can easily edit that documentation with a WYSIWYG editor.\\n\\nZeroheight integrates with [Storybook](https://zeroheight.com/3xlwst8/p/507ba7-storybook), enabling you to embed stories alongside your design specs.\\n\\n\", \"UXPin\": \"[UXPin](https://www.uxpin.com/) is an interactive design tool that uses production code to generate prototypes.\\n\\nUXPin allows you to [use interactive stories](https://www.uxpin.com/docs/merge/storybook-integration/) to design user flows.\\n\\n<Video src=\\\"../_assets/sharing/storybook-uxpin.mp4\\\" />\", \"InVision Design System Manager\": \"[InVision DSM](https://www.invisionapp.com/design-system-manager) is a design system documentation tool. It helps design teams consolidate UX principles, user interface design, and design tokens in a shared workspace.\\n\\nInVision allows you to embed [Storybook](https://support.invisionapp.com/hc/en-us/articles/360028388192-Publishing-Storybook-to-DSM) in your design system documentation.\\n\\n\", \"Adobe XD\": \"[Adobe XD](https://www.adobe.com/products/xd.html) is a UI and UX design tool for creating wireframes, interactive designs, and prototypes.\\n\\nIntegrate Adobe XD with Storybook using the [design addon](https://storybook.js.org/addons/storybook-addon-designs/). You can [embed design specs](https://helpx.adobe.com/xd/help/publish-design-specs.html) alongside stories by following these [instructions](https://pocka.github.io/storybook-addon-designs/?path=/story/docs-iframe-readme--page).\", \"Build your own integration\": \"Extend and customize Storybook by building an integration. Integrate with lower-level Storybook APIs or bootstrap an addon to customize Storybook's UI and behavior.\\n\\n['[Addon documentation](../addons/index.mdx)', '[Create an addon tutorial](../addons/writing-addons.mdx)']\"}, \"metadata\": {\"title\": \"Design integrations\", \"sidebar\": {\"order\": 3, \"title\": \"Design integrations\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 0]\"}, {\"title\": \"Embed stories\", \"description\": null, \"content\": {\"Embed a story with the toolbar\": \"Embed a story with the toolbar, and paste the published story URL. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n// oEmbed\\nhttps://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/?path=/story/shadowboxcta--default\\n\\n// iframe embed\\n<iframe\\n src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/?path=/story/shadowboxcta--default&full=1&shortcuts=false&singleStory=true\\\"\\n width=\\\"800\\\"\\n height=\\\"260\\\"\\n></iframe>\\n```\\n\\n{/* prettier-ignore-end */}\\n\\n<br />\\n\\n<iframe src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/?path=/story/shadowboxcta--default&full=1&shortcuts=false&singleStory=true\\\" width=\\\"800\\\" height=\\\"260\\\" />\", \"Embed a story without the toolbar\": \"To embed a plain story without Storybook's toolbar, click the \\\"open canvas in new tab\\\" icon in the top-right corner of Storybook to get the canvas URL. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n// oEmbed\\nhttps://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=/story/shadowboxcta--default&viewMode=story\\n\\n// iframe embed\\n <iframe\\n src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=shadowboxcta--default&viewMode=story&shortcuts=false&singleStory=true\\\"\\n width=\\\"800\\\"\\n height=\\\"200\\\"\\n></iframe>\\n```\\n\\n{/* prettier-ignore-end */}\\n\\n<br />\\n\\n<iframe src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=shadowboxcta--default&viewMode=story&shortcuts=false&singleStory=true\\\" width=\\\"800\\\" height=\\\"200\\\" />\", \"Embed documentation\": \"Embed a documentation page by replacing `viewMode=story` with the uniquely auto-generated documentation entry for the story.\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n// oEmbed\\nhttps://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=shadowboxcta--docs&viewMode=docs&shortcuts=false&singleStory=true\\n\\n// iframe embed\\n <iframe\\n src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=shadowboxcta--docs&viewMode=docs&shortcuts=false&singleStory=true\\\"\\n width=\\\"800\\\"\\n height=\\\"400\\\"\\n></iframe>\\n```\\n\\n{/* prettier-ignore-end */}\\n\\n<br />\\n\\n<iframe src=\\\"https://5ccbc373887ca40020446347-wtuhidckxo.chromatic.com/iframe.html?id=shadowboxcta--docs&viewMode=docs&shortcuts=false&singleStory=true\\\" width=\\\"800\\\" height=\\\"400\\\" />\", \"Embed stories on other platforms\": \"Every platform has different levels of embed support. Check the documentation of your service to see how they recommend embedding external content.\\n\\n<details>\\n<summary>How to embed in Medium</summary>\\n\\nPaste the Storybook URL into your Medium article, then press Enter. The embed will automatically resize to fit the story's height.\\n\\nWhile editing an article, Medium renders all embeds non-interactive. Once your article is published, it will become interactive. [Preview a demo on Medium](https://medium.com/@ghengeveld/embedding-storybook-on-medium-ce8a280c03ad).\\n\\n <Video src=\\\"../_assets/sharing/embed-medium-optimized.mp4\\\" />\\n</details>\\n\\n<details>\\n<summary>How to embed in Notion</summary>\\n\\nIn your Notion document, type /embed, press Enter, and paste the story URL as the embed link. You can resize the embed as necessary.\\n\\n\\n</details>\\n\\n<details>\\n<summary>How to embed in Ghost</summary>\\n\\nType `/html` in your Ghost post, press Enter and paste the iframe URL. You can resize the embed via the width and height properties as required.\\n\\n\\n</details>\"}, \"metadata\": {\"title\": \"Embed stories\", \"sidebar\": {\"order\": 2, \"title\": \"Embed\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 1]\"}, {\"title\": \"Sharing\", \"description\": null, \"content\": {\"root\": [\"You have your components ready and tested. That's great! Now you want to make your component library available to your team or community to help them understand how they work. There are multiple ways you can do that. You can publish your Storybook to services like Chromatic, embed some of your stories in your own website, or use third party services like Figma.\", [\"[Publish](./publish-storybook.mdx)\", \"[Embed](./embed.mdx)\", \"[Design integrations](./design-integrations.mdx)\", \"[Composition](./storybook-composition.mdx)\", \"[Package Composition](./package-composition.mdx)\"]]}, \"metadata\": {\"title\": \"Sharing\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 5, \"title\": \"Sharing\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 2]\"}, {\"title\": \"Package Composition\", \"description\": null, \"content\": {\"For consumers\": {\"Set up\": \"If you want to configure how the composed Storybook behaves, you can disable the `ref` element in your [`.storybook/main.js`](../configure/index.mdx#configure-story-rendering)\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-refs-disable.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Switching versions\": \"Change the version of the composed Storybook to see how the library evolves. This requires [configuration](#show-a-version-selector) from the package author.\\n\\n\"}, \"For authors\": {\"Automatic version selection\": \"If you're using [Chromatic](./publish-storybook.mdx#publish-storybook-with-chromatic), you can provide a single URL for your Storybook in the `storybook.url` field. You do not need to change the URL each time you publish a new version. Storybook will automatically find the correct URL for your package. For example:\\n\\n```\\n{\\n \\\"storybook\\\": {\\n \\\"url\\\": \\\"https://master--xyz123.chromatic.com\\\"\\n }\\n}\\n```\\n\\nIn this example `xyz123` is your Chromatic project id. Storybook will automatically compose in the Storybook published to that project corresponding to the version the user has installed.\", \"Show a version selector\": \"If you're using [Chromatic](./publish-storybook.mdx#publish-storybook-with-chromatic), you can provide a list of versions for the user to [choose from](#switching-versions) to experiment with other versions of your package.\"}}, \"metadata\": {\"title\": \"Package Composition\", \"sidebar\": {\"order\": 5, \"title\": \"Package Composition\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 3]\"}, {\"title\": \"Publish Storybook\", \"description\": null, \"content\": {\"Build Storybook as a static web application\": {\"Customizing the build for performance\": \"By default, Storybook's production build will encapsulate all stories and documentation into the production bundle. This is ideal for small projects but can cause performance issues for larger projects or when decreased build times are a priority (e.g., testing, CI/CD). If you need, you can customize the production build with the [`test` option](../api/main-config/main-config-build.mdx#test) in your `main.js|ts` configuration file and adjust your build script to enable the optimizations with the `--test` [flag](../api/cli-options.mdx#build).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-build-test-flag.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Build Storybook for older browsers\": \"The Storybook app's UI supports [modern browsers](../get-started/install.mdx#project-requirements). If you need to run the app in older, unsupported browsers, you can use the [`--preview-only` CLI flag](../api/cli-options.mdx#build) to build Storybook in \\\"preview-only\\\" mode. This skips building the Storybook manager (the UI surrounding your stories) and only builds the preview (the iframe that contains your stories). That makes your [Storybook builder](../builders/index.mdx) and its configuration solely responsible for which browsers are supported.\\n\\nWhen in \\\"preview-only\\\" mode, the normal entry point, `/index.html`, will result in a 404, because the client-side router is not available. To work around this, start from the `/iframe.html` route and add the `?navigator=true` query parameter to the URL. This will render a basic, HTML-only sidebar inside the preview so that you can navigate to your stories. For example, you can access the preview at `http://localhost:6006/iframe.html?navigator=true` (you may need to update the port number).\\n\\nThis applies to both the [`build`](../api/cli-options.mdx#build) (for publishing) and [`dev`](../api/cli-options.mdx#dev) (for local development) commands.\"}, \"Publish Storybook with Chromatic\": {\"Setup CI to publish automatically\": \"Configure your CI environment to publish your Storybook and [run Chromatic](https://www.chromatic.com/docs/ci?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook) whenever you push code to a repository. Let's see how to set it up using GitHub Actions.\\n\\nIn your project's root directory, add a new file called `chromatic.yml` inside the `.github/workflows` directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"chromatic-github-action.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nSecrets are secure environment variables provided by GitHub so that you don't need to hard code your `project-token`. Read the [official documentation](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to learn how to configure them.\\n</Callout>\\n\\nCommit and push the file. Congratulations, you've successfully automated publishing your Storybook. Now whenever you open a PR you\\u2019ll get a handy link to your published Storybook in your PR checks.\\n\\n\", \"Review with your team\": \"Publishing Storybook as part of the development process makes it quick and easy to gather team feedback.\\n\\nA common method to ask for review is to paste a link to the published Storybook in a pull request or Slack.\\n\\nIf you publish your Storybook to Chromatic, you can use the [UI Review](https://www.chromatic.com/features/publish?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook) feature to automatically scan your PRs for new and updated stories. That makes it easy to identify what changed and give feedback.\\n\\n\", \"Versioning and history\": \"When you publish Storybook, you also get component history and versioning down to the commit. That's useful during implementation review for comparing components between branches/commits to past versions.\\n\\n\"}, \"Publish Storybook to other services\": {\"GitHub Pages\": \"To deploy Storybook on GitHub Pages, use the community-built [Deploy Storybook to GitHub Pages](https://github.com/bitovi/github-actions-storybook-to-github-pages) Action. To enable it, create a new workflow file inside your `.github/workflows` directory with the following content:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"ghp-github-action.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe GitHub Pages Action requires additional configuration options to customize the deployment process. Refer to the [official documentation](https://github.com/marketplace/actions/deploy-storybook-to-github-pages) for more information.\\n</Callout>\\n\\n<details>\\n<summary><h3>Component Publishing Protocol (CPP)</h3></summary>\\n\\nStorybook can communicate with services that host built Storybooks online. This enables features such as [Composition](./storybook-composition.mdx). We categorize services via compliance with the \\\"Component Publishing Protocol\\\" (CPP) with various levels of support in Storybook.\", \"CPP level 1\": \"This level of service serves published Storybooks and makes the following available:\\n\\n['Versioned endpoints, URLs that resolve to different published Storybooks depending on a `version=x.y.z` query parameter (where `x.y.z` is the released version of the package).', 'Support for `/index.json` (formerly `/stories.json`) endpoint, which returns a list of stories and their metadata.', 'Support for `/metadata.json` and the `releases` field.']\\n\\nExample: [Chromatic](https://www.chromatic.com/?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook)\", \"CPP level 0\": \"This level of service can serve published Storybooks but has no further integration with Storybook\\u2019s APIs.\\n\\nExamples: [Netlify](https://www.netlify.com/), [S3](https://aws.amazon.com/en/s3/)\\n</details>\"}, \"Search engine optimization (SEO)\": {\"Description\": \"You can provide a description for search engines to display in the results listing, by adding the following to the `manager-head.html` file in your config directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"seo-description.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Preventing your Storybook from being crawled\": \"You can prevent your published Storybook from appearing in search engine results by including a noindex meta tag, which you can do by adding the following to the `manager-head.html` file in your config directory:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"seo-noindex.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Publish Storybook\", \"sidebar\": {\"order\": 1, \"title\": \"Publish\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 4]\"}, {\"title\": \"Storybook Composition\", \"description\": null, \"content\": {\"Compose published Storybooks\": \"In your [`.storybook/main.js|ts`](../configure/index.mdx#configure-story-rendering) file add a `refs` field with information about the reference Storybook. Pass in a URL to a statically built Storybook.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-refs.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"warning\\\">\\nAddons in composed Storybooks will not work as they normally do in a non-composed Storybook.\\n</Callout>\", \"Compose local Storybooks\": \"You can also compose multiple Storybooks that are running locally. For instance, if you have a React Storybook and an Angular Storybook running on different ports, you can update your configuration file (i.e., `.storybook/main.js|ts`) and reference them as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-ref-local.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdding this configuration will combine React and Angular Storybooks into your current one. You\\u2019ll see the changes being applied automatically when either of these changes. Enabling you to develop both frameworks in sync.\", \"Compose Storybooks per environment\": \"You can also compose Storybooks based on the current development environment (e.g., development, staging, production). For instance, if the project you're working on already has a published Storybook but also includes a version with cutting-edge features not yet released, you can adjust the composition based on that. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-refs-with-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nSimilar to other fields available in Storybook\\u2019s configuration file, the `refs` field can also be a function that accepts a `config` parameter containing Storybook\\u2019s configuration object. See the [API reference](../api/main-config/main-config-refs.mdx) for more information.\\n</Callout>\", \"Troubleshooting\": {\"Storybook composition is not working with my project\": \"If you're working with an outdated Storybook version or have a project-specific requirement that prevents you from updating your Storybook to the latest version, you can rely on the Storybook CLI to generate the `index.json` file when you deploy your Storybook. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-extract-specific-version.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe usage of a specific version of the CLI is intended as the `extract` command is not available in Storybook 8.0 or higher. It also requires you to provide additional configuration to generate the `index.json` file accurately. See the [previous documentation](../../../release-7-6/docs/sharing/storybook-composition.mdx) for more information.\\n</Callout>\"}}, \"metadata\": {\"title\": \"Storybook Composition\", \"sidebar\": {\"order\": 4, \"title\": \"Composition\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 11, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 11]\"}, {\"title\": \"Writing Docs\", \"description\": \"Documentation section: writing-docs\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/writing-docs\"}, \"subpages\": [{\"title\": \"Automatic documentation and Storybook\", \"description\": null, \"content\": {\"Set up automated documentation\": {\"Configure\": \"In addition to enabling the feature with `tags`, you can extend your Storybook configuration file (i.e., `.storybook/main.js|ts|cjs`) and provide additional options to control how documentation gets created. Listed below are the available options and examples of how to use them.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-full-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n| Option | Description |\\n| ------------- | ----------------------------------------------------------------------------------------------------- |\\n| `defaultName` | Renames the auto-generated documentation page<br /> Default: `docs: { defaultName: 'Documentation' }` |\", \"Write a custom template\": {\"With MDX\": \"You can also use MDX to generate the documentation template. This is useful in non-React projects where JSX-handling is not configured. Normally, when you create an MDX file in your project, it is treated as normal documentation. To indicate that an MDX file is a documentation template, supply the `isTemplate` property to its [`Meta`](../api/doc-blocks/doc-block-meta.mdx) Doc Block. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-mdx-template-with-prop.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThen you can use it in your `.storybook/preview.js|ts` or an individual story file by importing it:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-auto-docs-custom-mdx-template.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nIf you only need to override the documentation page for a single component, we recommend creating an MDX file and referencing it directly via the `<Meta of={} />` Doc Block.\\n\\n</Callout>\"}, \"Generate a table of contents\": \"Storybook's auto-generated documentation pages can be quite long and difficult to navigate. To help with this, you can enable the table of contents feature to provide a quick overview of the documentation page and allow users to jump to a specific section. To enable it, extend your Storybook UI configuration file (i.e., `.storybook/preview.js|ts`) and provide a `docs` [parameter](../writing-stories/parameters.mdx#global-parameters) with a `toc` property.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-enable-toc.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configure the table of contents\": {\"Component-level configuration\": \"If you want to customize the table of contents for a specific story, you can include a `toc` property in the story's default export and provide the required [configuration](#configure-the-table-of-contents). For example, if you need to hide the table of contents for a specific story, adjust your story as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-disable-toc.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Customize component documentation\": \"Creating automated documentation with Storybook's Autodocs provides you with the starting point to build a sustainable documentation pattern. Nevertheless, it may not be suited for every case, and you may want to extend it and provide additional information. We recommend combining [MDX](./mdx.mdx) alongside Storybook's [Doc Blocks](./doc-blocks.mdx) for such cases to author your documentation.\"}, \"Advanced configuration\": {\"Documenting multiple components\": \"Sometimes it's helpful to document multiple components together. For example, a component library\\u2019s ButtonGroup and Button components might not make sense without one another.\\n\\nAutodocs allows you to document your \\\"main\\\" component, defined by the `component` property, as well as one or more `subcomponents` related to it.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-with-subcomponents.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\\n\\nThe main component and its subcomponents will show up in a tabbed version of the [`ArgTypes` doc block](./doc-blocks.mdx#argtypes). The tab titles will correspond to the keys of the `subcomponents` object.\\n\\nIf you want to organize your documentation differently for component groups, we recommend [using MDX](./mdx.mdx). It gives you complete control over how your components are displayed and supports any configuration.\", \"Customize the Docs Container\": \"The Docs Container is the component that wraps up the documentation page. It's responsible for rendering the documentation page in Storybook's UI. You can customize it by creating your own component and updating your Storybook UI configuration file (i.e., `.storybook/preview.js|ts`) to reference it.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-auto-docs-custom-docs-container.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Override the default theme\": \"By default, Storybook provides two themes for the UI: `light` and `dark`. If you need to customize the theme used by the documentation to match the existing one, you can update your Storybook UI configuration file (i.e., `.storybook/preview.js|ts`) and apply it.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-auto-docs-override-theme.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Working with custom MDX components\": \"Out of the box, Storybook has a set of components that you can use to customize your documentation page. If you're working with a design system or component library and wish to add them to your documentation page, you can override the `MDXProvider` component inherited from `@mdx-js/react` with your own. However, there's a caveat to this, the component replacement will only have an impact if you're writing documentation using Markdown syntax (e.g., `#` for headings). Native HTML elements, such as `<h1>`, will not be replaced with your custom implementation.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-auto-docs-override-mdx-container.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThis is not a Storybook issue but a detail of how MDX works. From their [migration guide](https://mdxjs.com/migrating/v2/#update-mdx-content):\\n\\n\\u201cWe now \\u2018sandbox\\u2019 components, for lack of a better name. It means that when you pass a component for h1, it does get used for `# hi` but not for `<h1>hi</h1>`\\u201d\\n</Callout>\", \"Addon options\": \"The docs addon accepts options to customize the behavior of the documentation page. You can add them to your Storybook UI configuration file (i.e., `.storybook/main.js|ts`), as part of registering the addon. The following options are available:\\n\\n| Option | Description |\\n| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `csfPluginOptions` | Provides additional configuration for Storybook's CSF plugin. Can be disabled with `null`. |\\n| `mdxPluginOptions` | Provides additional configuration options and plugin configuration for [MDX documentation](../writing-docs/mdx.mdx#markdown-tables-arent-rendering-correctly). |\\n\\nThis example demonstrates how to apply these options.\\n\\n<CodeSnippets path=\\\"addon-docs-options.md\\\" />\"}, \"Troubleshooting\": {\"The table of contents doesn't render as expected\": {\"With simple documentation pages\": \"If you have a documentation page with only one matching heading and create a table of contents for it, the table of contents will not be hidden by default. A potential solution for this issue would be to add a second heading or turn it off entirely.\", \"With small screens\": \"If the screen width is less than 1200px, the table of contents will be hidden by default. Currently, there's no built-in solution for this issue that doesn't impact the documentation page's style compatibility.\", \"With MDX\": \"If you're writing [unattached documentation](./mdx.mdx#writing-unattached-documentation) using MDX, you cannot customize the table of contents primarily due to the lack of support for defining parameters based on the current implementation. As a result, the table of contents will always revert to the default [configuration](#configure-the-table-of-contents) provided globally.\"}, \"The auto-generated documentation is not showing up in a monorepo setup\": \"Out of the box, Storybook's Autodocs feature is built to generate documentation for your stories automatically. Nevertheless, if you're working with a monorepo setup (e.g., [`Yarn Workspaces`](https://yarnpkg.com/features/workspaces), [`pnpm Workspaces`](https://pnpm.io/workspaces)), you may run into issues where part of the documentation may not be generated for you. To help you troubleshoot those issues, we've prepared some recommendations that might help you.\\n\\nUpdate your import statements to reference the component directly instead of the package's root. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-fix-imports-autodocs-monorepo.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAdditionally, if you're developing using TypeScript, you may need to update Storybook's configuration file (i.e., `.storybook/main.js|ts`) to include the following:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-fix-imports-autodocs-monorepo.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)).\", \"The controls are not updating the story within the auto-generated documentation\": \"If you turned off inline rendering for your stories via the [`inline`](../api/doc-blocks/doc-block-story.mdx#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release.\\n\\n**Learn more about Storybook documentation**\\n\\n['Autodocs for creating documentation for your stories', '[MDX](./mdx.mdx) for customizing your documentation', '[Doc Blocks](./doc-blocks.mdx) for authoring your documentation', '[Publishing docs](./build-documentation.mdx) to automate the process of publishing your documentation']\"}}, \"metadata\": {\"title\": \"Automatic documentation and Storybook\", \"sidebar\": {\"order\": 1, \"title\": \"Autodocs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 0]\"}, {\"title\": \"Preview and build docs\", \"description\": null, \"content\": {\"Preview Storybook's documentation\": \"At any point during your development, you can preview the documentation you've written. Storybook allows you to generate a preview of the final documentation when you use the `--docs` flag. We recommend including it in your `package.json` as a new script:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"storybook-docs\\\": \\\"storybook dev --docs\\\"\\n }\\n}\\n```\\n\\nDepending on your configuration, when you execute the `storybook-docs` script. Storybook will be put into documentation mode and will generate a different build.\\n\\nIt will look for any stories available either in [MDX](./mdx.mdx) or [CSF](../writing-stories/index.mdx#component-story-format) and based on the documentation you've added it will display it...\\n\\n\\n\\nThere's some caveats to this build mode, as to the normal Storybook build:\\n\\n['The top level item refers to the primary story for your component.', 'Each individual story is now in a flattened display mode, with a different set of icons. This allows focus on the documentation itself.', \\\"Storybook's layout is rendered differently. The toolbar will not be displayed.\\\"]\", \"Publish Storybook's documentation\": \"You can also publish your documentation the same you would [publish](../sharing/publish-storybook.mdx) your Storybook. You can use the `--docs` flag with the [`storybook build`](../api/cli-options.mdx#build) command. We recommend as well including it as a script in your `package.json` file:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"build-storybook-docs\\\": \\\"storybook build --docs\\\"\\n }\\n}\\n```\\n\\nBased on the configuration you have, when the `build-storybook-docs` script is executed, Storybook once again will be put into documentation mode and will generate a different build and output the documentation into the `storybook-static` folder.\\n\\nThe same caveats mentioned above will apply.\\n\\nYou can use any hosting provider to deploy your documentation, for instance:\\n\\n['[Vercel](https://vercel.com/)', '[Netlify](https://www.netlify.com/)', '[S3](https://aws.amazon.com/en/s3/)']\\n\\n**Learn more about Storybook documentation**\\n\\n['[Autodocs](./autodocs.mdx) for creating documentation for your stories', '[MDX](./mdx.mdx) for customizing your documentation', '[Doc Blocks](./doc-blocks.mdx) for authoring your documentation', 'Publishing docs to automate the process of publishing your documentation']\"}, \"metadata\": {\"title\": \"Preview and build docs\", \"sidebar\": {\"order\": 5, \"title\": \"Preview and build docs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 1]\"}, {\"title\": \"Code panel\", \"description\": null, \"content\": {\"Usage\": \"To enable the Code panel, set `parameters.docs.codePanel` to `true`. For most projects, this is best done in the `.storybook/preview.js|ts` file, to apply to all stories.\\n\\n<CodeSnippets path=\\\"code-panel-enable-in-preview.md\\\" />\\n\\nYou can also enable it at the component or story level:\\n\\n<CodeSnippets path=\\\"code-panel-in-meta-and-story.md\\\" />\", \"Configuration\": \"Code panel renders the same snippet as the [Source docs block](../api/doc-blocks/doc-block-source.mdx), which is also used in [Autodocs](./autodocs.mdx) pages. The snippet is customizable and reuses the [Source configuration parameters](../api/doc-blocks/doc-block-source.mdx#source).\"}, \"metadata\": {\"title\": \"Code panel\", \"sidebar\": {\"order\": 4, \"title\": \"Code panel\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 2]\"}, {\"title\": \"Doc blocks\", \"description\": null, \"content\": {\"Within MDX\": \"The blocks are most commonly used within Storybook's [MDX documentation](./mdx.mdx):\\n\\n\\n\\n{/* prettier-ignore-start */}\\n\\n```\\nimport { Meta, Primary, Controls, Story } from '@storybook/addon-docs/blocks';\\n\\nimport * as ButtonStories from './Button.stories';\\n\\n<Meta of={ButtonStories} />\\n\\n# Button\\n\\nA button is ...\\n\\n<Primary />\\n\\n## Props\\n\\n<Controls />\\n\\n## Stories\\n\\n### Primary\\n\\nA button can be of primary importance.\\n\\n<Story of={ButtonStories.Primary} />\\n\\nA button can be of secondary importance.\\n\\n<Story of={ButtonStories.Secondary} />\\n\\n{/* ... */}\\n```\\n\\n{/* prettier-ignore-end */}\", \"Customizing the automatic docs page\": \"The blocks are also used to define the page template for [automatics docs](./autodocs.mdx). For example, here's the default template:\\n\\n\\n\\n```\\nimport { Title, Subtitle, Description, Primary, Controls, Stories } from '@storybook/addon-docs/blocks';\\n\\nexport const autoDocsTemplate = () => (\\n <>\\n <Title />\\n <Subtitle />\\n <Description />\\n <Primary />\\n <Controls />\\n <Stories />\\n </>\\n);\\n```\\n\\nIf you [override the default page template](./autodocs.mdx#write-a-custom-template), you can similarly use Doc Blocks to build the perfect documentation page for your project.\\n\\nNote that some doc blocks render other blocks. For example, the `<Stories />` block expands to:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n## Stories\\n\\n<Canvas>\\n ### Story name\\n <Description />\\n <Story />\\n <Source />\\n</Canvas>\\n\\n{/* ... repeat <Canvas> for each story */}\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nAs a result, for example, customizing the [`Source`](../api/doc-blocks/doc-block-source.mdx) block via parameters (see next section) will also affect the Source blocks rendered as part of [`Canvas`](../api/doc-blocks/doc-block-canvas.mdx) blocks.\", \"Customizing doc blocks\": \"In both use cases (MDX and automatic docs), many of the doc blocks can be customized via [parameters](../writing-stories/parameters.mdx).\\n\\nFor example, you can filter out the `style` prop from all [`Controls`](../api/doc-blocks/doc-block-controls.mdx) tables through your Storybook:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-doc-blocks-controls-exclude-prop.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nParameters can also be defined at the [component](../writing-stories/parameters.mdx#component-parameters) (or meta) level or the [story](../writing-stories/parameters.mdx#story-parameters) level, allowing you to customize Doc Blocks exactly as you need, where you need.\\n\\n</Callout>\\n\\nThe blocks that accept customization via parameters are marked in the list of available blocks below.\\n\\nWhen using a doc block in MDX, it can also be customized with its props:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n<Controls exclude={['style']}>\\n```\\n\\n{/* prettier-ignore-end */}\", \"Available blocks\": {\"[ArgTypes](../api/doc-blocks/doc-block-argtypes.mdx)\": \"<Callout variant=\\\"info\\\">\\n\\nAccepts parameters in the namespace `parameters.docs.argTypes`.\\n\\n</Callout>\\n\\nThe `ArgTypes` block can be used to show a static table of [arg types](../api/arg-types.mdx) for a given component as a way to document its interface.\\n\\n\", \"[Canvas](../api/doc-blocks/doc-block-canvas.mdx)\": \"<Callout variant=\\\"info\\\">\\n\\nAccepts parameters in the namespace `parameters.docs.canvas`.\\n\\n</Callout>\\n\\nThe `Canvas` block is a wrapper around a [`Story`](../api/doc-blocks/doc-block-story.mdx), featuring a toolbar that allows you to interact with its content while automatically providing the required [`Source`](../api/doc-blocks/doc-block-source.mdx) snippets.\\n\\n\", \"[ColorPalette](../api/doc-blocks/doc-block-colorpalette.mdx)\": \"The `ColorPalette` block allows you to document all color-related items (e.g., swatches) used throughout your project.\\n\\n\", \"[Controls](../api/doc-blocks/doc-block-controls.mdx)\": \"<Callout variant=\\\"info\\\">\\n\\nAccepts parameters in the namespace `parameters.docs.controls`.\\n\\n</Callout>\\n\\nThe `Controls` block can be used to show a dynamic table of args for a given story, as a way to document its interface, and to allow you to change the args for a (separately) rendered story (via the [`Story`](../api/doc-blocks/doc-block-story.mdx) or [`Canvas`](../api/doc-blocks/doc-block-canvas.mdx) blocks).\\n\\n\", \"[Description](../api/doc-blocks/doc-block-description.mdx)\": \"The `Description` block displays the description for a component, story, or meta obtained from their respective JSDoc comments.\\n\\n\", \"[IconGallery](../api/doc-blocks/doc-block-icongallery.mdx)\": \"The `IconGallery` block lets you quickly document all icons associated with your project, displayed in a neat grid.\\n\\n\", \"[Markdown](../api/doc-blocks/doc-block-markdown.mdx)\": \"The `Markdown` block allows you to import and include plain markdown in your MDX files.\\n\\n\", \"[Meta](../api/doc-blocks/doc-block-meta.mdx)\": \"The `Meta` block is used to [attach](#attached-vs-unattached) a custom MDX docs page alongside a component\\u2019s list of stories. It doesn\\u2019t render any content but serves two purposes in an MDX file:\\n\\n['Attaches the MDX file to a component and its stories, or', 'Controls the location of the unattached docs entry in the sidebar.']\", \"[Primary](../api/doc-blocks/doc-block-primary.mdx)\": \"The `Primary` block displays the primary (first defined in the stories file) story in a [`Story`](../api/doc-blocks/doc-block-story.mdx) block. It is typically rendered immediately under the title in a docs entry.\\n\\n\", \"[Source](../api/doc-blocks/doc-block-source.mdx)\": \"<Callout variant=\\\"info\\\">\\n\\nAccepts parameters in the namespace `parameters.docs.source`.\\n\\n</Callout>\\n\\nThe `Source` block is used to render a snippet of source code directly.\\n\\n\", \"[Stories](../api/doc-blocks/doc-block-stories.mdx)\": \"The `Stories` block renders the full collection of stories in a stories file.\\n\\n\", \"[Story](../api/doc-blocks/doc-block-story.mdx)\": \"<Callout variant=\\\"info\\\">\\n\\nAccepts parameters in the namespace `parameters.docs.story`.\\n\\n</Callout>\\n\\n[Stories](../writing-stories/index.mdx) are Storybook's fundamental building blocks.\\n\\nIn Storybook Docs, you can render any of your stories from your CSF files in the context of an MDX file with all annotations (parameters, args, loaders, decorators, play function) applied using the `Story` block.\\n\\n\", \"[Subtitle](../api/doc-blocks/doc-block-subtitle.mdx)\": \"The `Subtitle` block can serve as a secondary heading for your docs entry.\\n\\n\", \"[Title](../api/doc-blocks/doc-block-title.mdx)\": \"The `Title` block serves as the primary heading for your docs entry. It is typically used to provide the component or page name.\\n\\n\", \"[Typeset](../api/doc-blocks/doc-block-typeset.mdx)\": \"The `Typeset` block helps document the fonts used throughout your project.\\n\\n\", \"[Unstyled](../api/doc-blocks/doc-block-unstyled.mdx)\": \"The `Unstyled` block is a unique block that disables Storybook's default styling in MDX docs wherever it is added.\\n\\nBy default, most elements (like `h1`, `p`, etc.) in docs have a few default styles applied to ensure the docs look good. However, sometimes you might want some of your content not to have these styles applied. In those cases, wrap the content with the `Unstyled` block to remove the default styles.\\n\\n\"}, \"Make your own Doc Blocks\": \"Storybook also provides a [`useOf` hook](../api/doc-blocks/doc-block-useof.mdx) to make it easier to create your own blocks that function like the built-in blocks.\", \"Troubleshooting\": {\"Why can't I use the Doc Blocks inside my stories?\": \"Storybook's Doc Blocks are highly customizable and helpful building blocks to assist you with building your custom documentation. Although most of them enable you to customize them with parameters or globally to create custom [documentation templates](#customizing-the-automatic-docs-page), they are primarily designed for MDX files. For example, if you try to add the `ColorPalette` block to your stories as follows, you'll get an error message when the story loads in Storybook.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-canvas-doc-block-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n**Learn more about Storybook documentation**\\n\\n['[Autodocs](./autodocs.mdx) for creating documentation for your stories', '[MDX](./mdx.mdx) for customizing your documentation', 'Doc Blocks for authoring your documentation', '[Publishing docs](./build-documentation.mdx) to automate the process of publishing your documentation']\"}}, \"metadata\": {\"title\": \"Doc blocks\", \"sidebar\": {\"order\": 3, \"title\": \"Doc blocks\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 3]\"}, {\"title\": \"How to document components\", \"description\": null, \"content\": {\"root\": [\"When you write component stories during development, you also create basic documentation to revisit later.\", \"Storybook gives you tools to expand this essential documentation with prose and layout that feature your components and stories prominently. That allows you to create UI library usage guidelines, design system sites, and more.\", \"\", \"If you're including Storybook in your project for the [first time](../get-started/install.mdx), we provide you with a [documentation page](./autodocs.mdx) (\\\"Autodocs\\\" for short), positioned near your stories. It's a baseline template automatically generated, listing your existing stories and relevant metadata.\", \"Additionally, you can customize this template if needed or create free-form pages for each component using [MDX](./mdx.mdx). In both cases, you\\u2019ll use Doc Blocks as the building blocks to create full-featured documentation.\", \"Docs is autoconfigured to work out of the box in most use cases. In some cases, you may need or want to tweak the configuration. Read more about it [here](https://storybook.js.org/addons/@storybook/addon-docs).\"]}, \"metadata\": {\"title\": \"How to document components\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 4, \"title\": \"Docs\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 4]\"}, {\"title\": \"MDX\", \"description\": null, \"content\": {\"Basic example\": {\"MDX and CSF\": \"The first thing you'll notice is that the component documentation is divided into distinct formats: one for writing component stories describing each possible component state and the second one for documenting how to use them. This split leverages the best qualities of each format:\\n\\n['**CSF** is great for succinctly defining stories (component examples). If you use TypeScript, it also provides type safety and auto-completion.', '**MDX** is great for writing structured documentation and composing it with interactive JSX elements.']\", \"Anatomy of MDX\": \"Assuming you\\u2019re already familiar with writing stories with [CSF](../writing-stories/index.mdx), we can dissect the MDX side of things in greater detail.\\n\\nThe document consists of a number of blocks separated by blank lines. Since MDX mixes a few different languages together, it uses those blank lines to help distinguish where one starts, and the next begins. Failing to separate blocks by whitespace can cause (sometimes cryptic) parse errors.\\n\\nGoing through the code blocks in sequence:\\n\\n{/* prettier-ignore-start */}\\n\\n```\\n{ /* Checkbox.mdx */ }\\n```\\n\\n{/* prettier-ignore-end */}\\n\\nComments in MDX are JSX blocks that contain JS comments.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-imports.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nImports the components and stories that will be used in the JSX throughout the rest of the file.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-meta-block.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nWhen providing the `of` prop to the `Meta` block, make sure that you're referencing the [**default export**](../api/csf.mdx#default-export) of the story file and not the component itself to prevent render issues with the generated documentation.\\n</Callout>\\n\\nThe `Meta` block defines where the document will be placed in the sidebar. In this case, it is adjacent to the Checkbox\\u2019s stories. By default, the docs sidebar node is titled `\\\"Docs\\\"`, but this can be customized by passing a `name` prop (e.g., `<Meta of={CheckboxStories} name=\\\"Info\\\" />`). If you want to place a docs node at an arbitrary point in the navigation hierarchy, you can use the `title` prop (e.g., `<Meta title=\\\"path/to/node\\\" />`).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-definition.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nMDX supports standard markdown ([\\\"commonmark\\\"](https://commonmark.org/)) by default and can be extended to support [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/) and other extensions (see the [Troubleshooting section](#troubleshooting) to learn more about some of the current limitations).\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, MDX supports blocks of arbitrary JSX.\\n\\nIn this case, we are leveraging \\u201cDoc Blocks\\u201d, a library of documentation components designed to work with Storybook stories to show your stories, your component APIs & controls for interacting with your components inside your documentation, among other utilities.\\n\\nIn addition to Doc Blocks, MDX can incorporate arbitrary React components, making it a very flexible documentation system. Suppose you want a stylized list of \\u201cdos and don\\u2019ts\\u201d for your component; you can use off-the-shelf components or write your own.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-dos-donts.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Known limitations\": \"While MDX supports a variety of runtimes ([React](https://mdxjs.com/packages/react/), [Preact](https://mdxjs.com/packages/preact/), [Vue](https://mdxjs.com/packages/vue/)), Storybook\\u2019s implementation is React-only. That means your documentation is rendered in React, while your stories render in the runtime of your choice (React, Vue, Angular, Web Components, Svelte, etc.).\"}, \"Setup custom documentation\": {\"Using the `Meta` Doc Block\": \"If you need to match the component documentation to an existing story, you can configure the [`Meta`](../api/doc-blocks/doc-block-meta.mdx) Doc Block to control how the documentation gets rendered. Out of the box, it allows you to define a custom title or a reference to the story you need to document (i.e., via the `of` prop). For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-baseline-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Writing unattached documentation\": \"Suppose you're documenting an existing component and only provide the `Meta` Doc Block without additional props or other blocks. In that case, Storybook will consider it as \\\"unattached\\\" documentation, or in other words, a \\\"documentation-only\\\" page, and it will render it differently in the sidebar navigation menu:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-docs-docs-only-page.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\", \"Using the File System\": {\"Working with standalone documentation pages\": \"Writing standalone documentation pages is a common use case that applies not only on a per-component but also on a per-project basis. For example, you might want to document your project's onboarding process with instructions on using it. To do so, you can create a new MDX file containing your documentation using a similar structure and content:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-standalone-page.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\\n\\nWhen Storybook loads the documentation, it will infer the placement of the page in the sidebar navigation menu using the file's physical location and render it as a `Docs` entry.\"}, \"Fully control custom documentation\": \"Documentation can be expensive to maintain and keep up to date when applied to every project component. To help simplify this process, Storybook provides a set of useful UI components (i.e., Doc Blocks) to help cover more advanced cases. If you need additional content, use them to help create your custom documentation.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-starter-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Working with multiple components\": \"If you need to document multiple components in a single documentation page, you can reference them directly inside your MDX file. Internally, Storybook looks for the story metadata and composes it alongside your existing documentation. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-auto-docs-mdx-file.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Generate documentation from Markdown\": \"If you need to extend your documentation with additional content written in Markdown, you can use the `Markdown` Doc Block to import the available content, and Storybook will render it alongside your existing documentation. For example, if you have a `CHANGELOG.md` file, you can import it and render it in your documentation page as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-custom-docs-markdown.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThe `Markdown` Doc Block provides additional configuration options to customize the rendering of your documentation. For more information, refer to the [API documentation](../api/doc-blocks/doc-block-markdown.mdx).\\n</Callout>\\n\\n\", \"Linking to other stories and pages\": \"Another way to improve documentation is by linking to other stories and pages. Suppose you already have a component story with the following unique identifier, `some--id`, and you want to link it to your documentation page. In that case, you can use the `path` query string to redirect to the documentation entry related to the story:\\n\\n```\\n[Go to specific documentation page](?path=/docs/some--id)\\n```\\n\\nInstead, if you need to target a specific documentation section, you can adjust the link to point at it. For example:\\n\\n```\\n[Go to the conclusion of the documentation page](?path=/docs/some--id#conclusion)\\n```\\n\\nHowever, cross-linking documentation isn't restricted to documentation pages. You can adjust the `path` query and supply the story's unique identifier if you need to reference a specific one. For example:\\n\\n{/*This redirects to the **Canvas** tab of the story: */}\\n\\n```\\n[Go to specific story canvas](?path=/story/some--id)\\n```\\n\\n{/*You can also use anchors to target a specific section of a page: */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nApplying this pattern with the [Controls](../essentials/controls.mdx) feature, all anchors will be ignored in Canvas based on how Storybook handles URLs to track the args values.\\n\\n</Callout>\"}, \"Troubleshooting\": {\"Markdown tables aren't rendering correctly\": \"If you're extending your documentation to include specific features (e.g., tables, footnotes), you may run into some issues rendering them correctly using the current MDX version supported by Storybook. We recommend enabling the [`remark-gfm`](https://github.com/remarkjs/remark-gfm) plugin in your configuration file (i.e., [`.storybook/main.js|ts`](../configure/index.mdx)) to render them correctly.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-main-config-remark-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe [`remark-gfm`](https://github.com/remarkjs/remark-gfm) package is not included by default with Storybook and must be installed separately as a development dependency. To learn more about how to use it and the other breaking changes introduced by MDX, refer to the [GFM guide](https://mdxjs.com/guides/gfm/) and the [migration guide](https://mdxjs.com/migrating/v2/) provided by the MDX team for more information.\\n</Callout>\", \"The MDX documentation doesn't render in my environment\": {\"Storybook doesn't create documentation for my component stories\": \"If you run into a situation where Storybook is not able to detect and render the documentation for your component stories, it may be due to a misconfiguration in your Storybook. Check your configuration file (i.e., `.storybook/main.js|ts`) and ensure the `stories` configuration element provides the correct path to your stories location (e.g., `../src/**/*.stories.@(js|jsx|mjs|ts|tsx)`).\"}, \"The migration seems flaky and keeps failing\": \"By default, running the [migration](../releases/upgrading.mdx) command will prompt you to update the existing MDX files in your project according to the MDX version supported by Storybook. However, this might be a disruptive process, specifically if you're upgrading from a previous version of Storybook where you were using the legacy MDX format. To help you troubleshoot those issues, we've prepared some recommendations that might help you.\\n\\nStart by running the following command inside your project directory:\\n\\n```\\nnpx @hipster/mdx2-issue-checker\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nDepending on the volume, you may be required to run the command multiple times to fix all the issues.\\n</Callout>\\n\\nWhen it finishes, it will output the list of files causing issues. You can then use this information to fix the problems manually.\\n\\nAdditionally, if you're working with VSCode, you can add the [MDX extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) and enable MDX experimental support for linting, type checking, and auto-completion by adding the following to your user settings:\\n\\n```\\n{\\n \\\"mdx.server.enable\\\": true\\n}\\n```\\n\\nIf you're still encountering issues, we recommend reaching out to the community using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help)).\", \"The controls are not updating the story within the MDX documentation page\": \"If you turned off inline rendering for your stories via the [`inline`](../api/doc-blocks/doc-block-story.mdx#inline) configuration option, you would run into a situation where the associated controls are not updating the story within the documentation page. This is a known limitation of the current implementation and will be addressed in a future release.\", \"The React version used is unexpected\": \"For most projects, Storybook's addon-docs uses the React version listed in your project's dependencies. If it does not find one, it will use React 18.2.0. There are two exceptions to this:\\n\\n['Preact projects will always use React 17', 'Next.js projects will always use the canary version that comes with the Next.js version installed, regardless of which React version is listed in the project\\u2019s dependencies.']\\n\\nIf you're having issues with the React version used, you may need to re-create your project's `node_modules` folder to ensure the correct version is used.\\n\\n**Learn more about Storybook documentation**\\n\\n['[Autodocs](./autodocs.mdx) for creating documentation for your stories', 'MDX for customizing your documentation', '[Doc Blocks](./doc-blocks.mdx) for authoring your documentation', '[Publishing docs](./build-documentation.mdx) to automate the process of publishing your documentation']\"}}, \"metadata\": {\"title\": \"MDX\", \"sidebar\": {\"order\": 2, \"title\": \"MDX\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 12, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 12]\"}, {\"title\": \"Writing Stories\", \"description\": \"Documentation section: writing-stories\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/writing-stories\"}, \"subpages\": [{\"title\": \"Args\", \"description\": null, \"content\": {\"Args object\": \"The `args` object can be defined at the [story](#story-args), [component](#component-args) and [global level](#global-args). It is a JSON serializable object composed of string keys with matching valid value types that can be passed into a component for your framework.\", \"Story args\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nTo define the args of a single story, use the `args` property in the `Story` component if you are using Svelte CSF with the native templating syntax, or use the `args` key on a CSF story file:\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nTo define the args of a single story, use the `args` CSF story key:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-with-args.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThese args will only apply to the story for which they are attached, although you can [reuse](./build-pages-with-storybook.mdx#args-composition-for-presentational-screens) them via JavaScript object reuse:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-primary-long-name.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn the above example, we use the [object spread](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_syntax) feature of ES 2015.\", \"Component args\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nYou can also define args at the component level; they will apply to all the component's stories unless you overwrite them. To do so, use the `args` property in the `defineMeta` function of a Svelte CSF story file or via the `args` key on the default CSF export:\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nYou can also define args at the component level; they will apply to all the component's stories unless you overwrite them. To do so, use the `args` key on the `default` CSF export:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-component-args-primary.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Global args\": \"You can also define args at the global level; they will apply to every component's stories unless you overwrite them. To do so, define the `args` property in the default export of `preview.js|ts`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"args-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nFor most uses of global args, [globals](../essentials/toolbars-and-globals.mdx) are a better tool for defining globally-applied settings, such as a theme. Using globals enables users to change the value with the toolbar menu.\\n</Callout>\", \"Args composition\": \"You can separate the arguments to a story to compose in other stories. Here's how you can combine args for multiple stories of the same component.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-primary-composition.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nIf you find yourself re-using the same args for most of a component's stories, you should consider using [component-level args](#component-args).\\n</Callout>\\n\\nArgs are useful when writing stories for composite components that are assembled from other components. Composite components often pass their arguments unchanged to their child components, and similarly, their stories can be compositions of their child components stories. With args, you can directly compose the arguments:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"page-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Args can modify any aspect of your component\": \"You can use args in your stories to configure the component's appearance, similar to what you would do in an application. For example, here's how you could use a `footer` arg to populate a child component:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"page-story-slots.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Setting args through the URL\": \"You can also override the set of initial args for the active story by adding an `args` query parameter to the URL. Typically, you would use [Controls](../essentials/controls.mdx) to handle this. For example, here's how you could set a `size` and `style` arg in the Storybook's URL:\\n\\n```\\n?path=/story/avatar--default&args=style:rounded;size:100\\n```\\n\\nAs a safeguard against [XSS](https://owasp.org/www-community/attacks/xss/) attacks, the arg's keys and values provided in the URL are limited to alphanumeric characters, spaces, underscores, and dashes. Any other types will be ignored and removed from the URL, but you can still use them with the Controls panel and [within your story](#mapping-to-complex-arg-values).\\n\\nThe `args` param is always a set of `key: value` pairs delimited with a semicolon `;`. Values will be coerced (cast) to their respective `argTypes` (which may have been automatically inferred). Objects and arrays are supported. Special values `null` and `undefined` can be set by prefixing with a bang `!`. For example, `args=obj.key:val;arr[0]:one;arr[1]:two;nil:!null` will be interpreted as:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-args-url-params-converted.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nSimilarly, special formats are available for dates and colors. Date objects will be encoded as `!date(value)` with value represented as an ISO date string. Colors are encoded as `!hex(value)`, `!rgba(value)` or `!hsla(value)`. Note that rgb(a) and hsl(a) should not contain spaces or percentage signs in the URL.\\n\\nArgs specified through the URL will extend and override any default values of args set on the story.\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"Setting args from within a story\": \"Interactive components often need to be controlled by their containing component or page to respond to events, modify their state and reflect those changes in the UI. For example, when a user toggles a switch component, the switch should be checked, and the arg shown in Storybook should reflect the change. To enable this, you can use the `useArgs` API exported by `storybook/preview-api`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"page-story-args-within-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\", \"Mapping to complex arg values\": \"Complex values such as JSX elements cannot be serialized to the manager (e.g., the Controls panel) or synced with the URL. Arg values can be \\\"mapped\\\" from a simple string to a complex type using the `mapping` property in `argTypes` to work around this limitation. It works in any arg but makes the most sense when used with the `select` control type.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"arg-types-mapping.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNote that `mapping` does not have to be exhaustive. If the arg value is not a property of `mapping`, the value will be used directly. Keys in `mapping` always correspond to arg *values*, not their index in the `options` array.\\n\\n<details>\\n<summary>Using args in addons</summary>\\n\\nIf you are [writing an addon](../addons/writing-addons.mdx) that wants to read or update args, use the `useArgs` hook exported by `storybook/manager-api`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"args-usage-with-addons.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</details>\"}, \"metadata\": {\"title\": \"Args\", \"sidebar\": {\"order\": 1, \"title\": \"Args\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 0]\"}, {\"title\": \"Building pages with Storybook\", \"description\": null, \"content\": {\"Pure presentational pages\": {\"Args composition for presentational screens\": \"When you are building screens in this way, it is typical that the inputs of a composite component are a combination of the inputs of the various sub-components it renders. For instance, if your screen renders a page layout (containing details of the current user), a header (describing the document you are looking at), and a list (of the subdocuments), the inputs of the screen may consist of the user, document and subdocuments.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"simple-page-implementation.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn such cases, it is natural to use [args composition](./args.mdx#args-composition) to build the stories for the page based on the stories of the sub-components:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"page-story-with-args-composition.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis approach is beneficial when the various subcomponents export a complex list of different stories. You can pick and choose to build realistic scenarios for your screen-level stories without repeating yourself. Your story maintenance burden is minimal by reusing the data and taking a Don't-Repeat-Yourself(DRY) philosophy.\"}, \"Mocking connected components\": {\"[Mocking imports](./mocking-data-and-modules/mocking-modules.mdx)\": \"Components can depend on modules that are imported into the component file. These can be from external packages or internal to your project. When rendering those components in Storybook or testing them, you may want to mock those modules to control their behavior.\", \"[Mocking API Services](./mocking-data-and-modules/mocking-network-requests.mdx)\": \"For components that make network requests (e.g., fetching data from a REST or GraphQL API), you can mock those requests in your stories.\", \"[Mocking providers](./mocking-data-and-modules/mocking-providers.mdx)\": \"Components can receive data or configuration from context providers. For example, a styled component might access its theme from a ThemeProvider or Redux uses React context to provide components access to app data. You can mock a provider and the value it's providing and wrap your component with it in your stories.\\n\\n<IfRenderer renderer={['react', 'solid']}>\", \"Avoiding mocking dependencies\": {\"Mocking containers in Storybook\": \"In the context of Storybook, instead of providing container components through context, we\\u2019ll instead provide their mocked counterparts. In most cases, the mocked versions of these components can often be borrowed directly from their associated stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"mock-context-container.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf the same context applies to all `ProfilePage` stories, we can use a [decorator](./decorators.mdx).\\n</Callout>\", \"Providing containers to your application\": \"Now, in the context of your application, you\\u2019ll need to provide `ProfilePage` with all of the container components it requires by wrapping it with `ProfilePageContext.Provider`:\\n\\nFor example, in Next.js, this would be your `pages/profile.js` component.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"mock-context-container-provider.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Mocking global containers in Storybook\": \"If you\\u2019ve set up `GlobalContainerContext`, you\\u2019ll need to set up a decorator within Storybook\\u2019s `preview.js` to provide context to all stories. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"mock-context-container-global.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\"}}}, \"metadata\": {\"title\": \"Building pages with Storybook\", \"sidebar\": {\"order\": 9, \"title\": \"Building pages and screens\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 1]\"}, {\"title\": \"Decorators\", \"description\": null, \"content\": {\"Wrap stories with extra markup\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nSome components require a \\u201charness\\u201d to render in a useful way. For instance, if a component runs right up to its edges, you might want to space it inside Storybook. With Svelte, you'll need to take additional steps to set it up properly.\\n\\n\\n\\nStart by creating a new Svelte component that will act as a decorator. This component will wrap your story and provide the required spacing or layout elements.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"margindecorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate your story to include the component and reference it to apply the required spacing or other functionality for all its stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"your-component-with-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you need to pass props to the component returned by your decorator, you can do so by returning an object with `Component` and `props` keys in the decorator function. This allows you to customize the behavior of the decorator based on the [story's context](#context-for-mocking).\\n\\n<CodeSnippets path=\\\"your-component-with-decorator-with-props.md\\\" />\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nSome components require a \\u201charness\\u201d to render in a useful way. For instance, if a component runs right up to its edges, you might want to space it inside Storybook. Use a decorator to add spacing for all stories of the component.\\n\\n\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"your-component-with-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</If>\\n\\n\", \"\\u201cContext\\u201d for mocking\": {\"Using decorators to provide data\": \"If your components are \\u201cconnected\\u201d and require side-loaded data to render, you can use decorators to provide that data in a mocked way without having to refactor your components to take that data as an arg. There are several techniques to achieve this. Depending on exactly how you are loading that data. Read more in the [building pages in Storybook](./build-pages-with-storybook.mdx) section.\"}, \"Story decorators\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nTo define a decorator for a single story, use the `decorators` property in the `Story` component if you are using Svelte CSF with the native templating syntax, or use the `decorators` key on a CSF named export:\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nTo define a decorator for a single story, use the `decorators` key on a named export:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIt is useful to ensure that the story remains a \\u201cpure\\u201d rendering of the component under test and that any extra HTML or components are used only as decorators. In particular the [Source](../api/doc-blocks/doc-block-source.mdx) Doc Block works best when you do this.\", \"Component decorators\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nTo define a decorator for all component stories, include the `decorators` property in the `defineMeta` function of a Svelte CSF story file. Alternatively, use the `decorators` key on the default CSF export:\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nTo define a decorator for all stories of a component, use the `decorators` key of the default CSF export:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-component-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Global decorators\": \"We can also set a decorator for **all stories** via the `decorators` export of your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) file (this is the file where you configure all stories):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-global-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Decorator inheritance\": \"Like parameters, decorators can be defined globally, at the component level, and for a single story (as we\\u2019ve seen).\\n\\nAll decorators relevant to a story will run in the following order once the story renders:\\n\\n['Global decorators, in the order they are defined', 'Component decorators, in the order they are defined', 'Story decorators, in the order they are defined, starting from the innermost decorator and working outwards and up the hierarchy in the same order']\"}, \"metadata\": {\"title\": \"Decorators\", \"sidebar\": {\"order\": 3, \"title\": \"Decorators\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 2]\"}, {\"title\": \"How to write stories\", \"description\": null, \"content\": {\"Where to put stories\": \"A component\\u2019s stories are defined in a story file that lives alongside the component file. The story file is for development-only, and it won't be included in your production bundle. In your filesystem, it looks something like this:\\n\\n```\\ncomponents/\\n\\u251c\\u2500 Button/\\n\\u2502 \\u251c\\u2500 Button.js | ts | jsx | tsx | vue | svelte\\n\\u2502 \\u251c\\u2500 Button.stories.js | ts | jsx | tsx | svelte\\n```\", \"Component Story Format\": {\"Default export\": \"<If renderer=\\\"svelte\\\">\\n\\nThe `defineMeta` function in Svelte CSF with native templating syntax controls how Storybook lists your stories and provides information used by addons. However, if you're not using this story format and relying on standard CSF, use the *default* export to achieve the same result. Below is an example of a story file with both approaches:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</If>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nThe *default* export metadata controls how Storybook lists your stories and provides information used by addons. For example, here\\u2019s the default export for a story file `Button.stories.js|ts`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export-with-component.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nStarting with Storybook version 7.0, story titles are analyzed statically as part of the build process. The *default* export must contain a `title` property that can be read statically or a `component` property from which an automatic title can be computed. Using the `id` property to customize your story URL must also be statically readable.\\n\\n\\n</Callout>\\n\\n</If>\", \"Defining stories\": {\"Custom rendering\": \"<If renderer=\\\"svelte\\\">\\n\\nBy default, stories will render the component defined in the `defineMeta` call (for Svelte CSF) or in the default export (for CSF), with the `args` passed to it.\\n\\nIf you need to customize the rendering of your story, you can provide a snippet (for Svelte CSF) or a `render` fuction (for CSF) that accepts `args` and renders whatever you need.\\n\\nFor example, if you want to render a `Button` inside an `Alert`:\\n\\n```\\n<Story\\n name=\\\"Primary in alert\\\"\\n args={{\\n label: 'Button',\\n primary: true,\\n }}>\\n {#snippet template(args)}\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n {/snippet}\\n</Story>\\n```\\n\\n<Callout variant=\\\"info\\\">\\n\\nNote how the template snippet or `render` function spreads `args` onto the Button component. This ensures that features like [Controls](../essentials/controls.mdx) will work as expected, allowing you to dynamically change the Button's properties in the Storybook UI.\\n\\n</Callout>\\n\\nYou can re-use the same render function across stories by applying it at the meta level. For Svelte CSF, this can be done by defining the template snippet outside of the story and assigning it to the `render` property of the `defineMeta` function. For CSF, you can define a `render` function in the default export.\\n\\n```\\n<script module>\\n import { defineMeta } from '@storybook/addon-svelte-csf';\\n import Button from './Button.svelte';\\n\\n const { Story } = defineMeta({\\n component: Button,\\n render: template,\\n });\\n</script>\\n\\n{#snippet template(args)}\\n <Alert>\\n Alert text\\n <Button {...args} />\\n </Alert>\\n{/snippet}\\n\\n<Story name=\\\"Default in alert\\\" args={{ label: 'Button' }} />\\n\\n<Story name=\\\"Primary in alert\\\" args={{ label: 'Button', primary: true }} />\\n```\\n\\nWhatever you define at the meta level can be overridden at the story level, so you can still customize the rendering of individual stories if needed.\\n\\nFinally, `render` functions and template snippets receive a second `context` argument, which contains all other details for the story, including [`parameters`](./parameters.mdx), [`globals`](../essentials/toolbars-and-globals.mdx), and more.\\n\\n</If>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nBy default, stories will render the component defined in the meta (default export), with the `args` passed to it. If you need to render something else, you can provide a function to the `render` property that returns the desired output.\\n\\nFor example, if you want to render a `Button` inside an `Alert`, you can define a custom render function like this:\\n\\n<CodeSnippets path=\\\"render-custom-in-story.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nNote how the `render` function spreads `args` onto the Button component. This ensures that features like [Controls](../essentials/controls.mdx) will work as expected, allowing you to dynamically change the Button's properties in the Storybook UI.\\n\\n</Callout>\\n\\nYou can re-use the same render function across stories by applying it at the meta level:\\n\\n<CodeSnippets path=\\\"render-custom-in-meta.md\\\" />\\n\\nWhatever you define at the meta level can be overridden at the story level, so you can still customize the rendering of individual stories if needed.\\n\\nFinally, `render` functions receive a second `context` argument, which contains all other details for the story, including [`parameters`](./parameters.mdx), [`globals`](../essentials/toolbars-and-globals.mdx), and more.\\n\\n</If>\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"Working with React Hooks\": \"[React Hooks](https://react.dev/reference/react) are convenient helper methods to create components using a more streamlined approach. You can use them while creating your component's stories if you need them, although you should treat them as an advanced use case. We **recommend** [args](./args.mdx) as much as possible when writing your own stories. As an example, here\\u2019s a story that uses React Hooks to change the button's state:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"solid\\\">\", \"Working with Solid Signals\": \"[Solid Signals](https://www.solidjs.com/docs/latest/api#basic-reactivity) are convenient helper methods to create components using a more streamlined approach. You can use them while creating your component's stories if you need them, although you should treat them as an advanced use case. We **recommend** [args](./args.mdx) as much as possible when writing your own stories. As an example, here\\u2019s a story that uses Solid Signals to change the button's state:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\"}, \"Rename stories\": \"By default, Storybook uses the name of the story export as the basis for the story name. However, you can customize the name of your story by adding a `name` property to the story object. This is useful when you want to provide a more descriptive or user-friendly name for your story.\\n\\n<If renderer=\\\"svelte\\\">\\n\\nIf you're using Svelte CSF, the `name` property is usually fairly descriptive and user-friendly already, so there is little need for renaming. However, the `name` is used as the basis for the export name, which must be unique within a file. In rare cases, this can lead to naming conflicts. For example, stories with the names \\\"Primary\\\" and \\\"Primary!\\\" would both be transformed to the \\\"Primary\\\" export name. To avoid this, you can use the `exportName` property to specify a unique export name for your story. `exportName` is also helpful to provide a more useful named export when re-using stories, e.g. as [portable stories](../api/portable-stories/portable-stories-vitest.mdx).\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-rename-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nYour story will now be shown in the sidebar with the given text.\\n\\n</If>\\n\\n{/* Maintaining a prior heading */}\\n\\n<a id=\\\"using-args\\\" />\"}, \"How to write stories\": {\"Using the play function\": \"Storybook's `play` function is a convenient helper methods to test component scenarios that otherwise require user intervention. They're small code snippets that execute once your story renders. For example, suppose you wanted to validate a form component, you could write the following story using the `play` function to check how the component responds when filling in the inputs with information:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"login-form-with-play-function.md\\\" />\\n\\nYou can interact with and debug your story's play function in the [interactions panel](../writing-tests/interaction-testing.mdx#debugging-interaction-tests).\", \"Using parameters\": \"Parameters are Storybook\\u2019s method of defining static metadata for stories. A story\\u2019s parameters can be used to provide configuration to various addons at the level of a story or group of stories.\\n\\nFor instance, suppose you wanted to test your Button component against a different set of backgrounds than the other components in your app. You might add a component-level `backgrounds` parameter:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\\n\\nThis parameter would instruct the backgrounds feature to reconfigure itself whenever a Button story is selected. Most features and addons are configured via a parameter-based API and can be influenced at a [global](./parameters.mdx#global-parameters), [component](./parameters.mdx#component-parameters), and [story](./parameters.mdx#story-parameters) level.\", \"Using decorators\": \"Decorators are a mechanism to wrap a component in arbitrary markup when rendering a story. Components are often created with assumptions about \\u2018where\\u2019 they render. Your styles might expect a theme or layout wrapper, or your UI might expect specific context or data providers.\\n\\n<IfRenderer renderer=\\\"svelte\\\">\\n\\nA simple example is adding padding to a component\\u2019s stories. With Svelte, you can either use an auxiliary component to wrap your stories with the required spacing or layout elements, or ignore the concept of decorators entirely and define them inline in a template.\\n\\n{ /* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"margindecorator.md\\\" />\\n\\n{ /* prettier-ignore-end */}\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nA simple example is adding padding to a component\\u2019s stories. Accomplish this using a decorator that wraps the stories in a `div` with padding, like so:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-component-decorator.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nDecorators [can be more complex](./decorators.mdx#context-for-mocking) and are often provided by [addons](../configure/user-interface/storybook-addons.mdx). You can also configure decorators at the [story](./decorators.mdx#story-decorators), [component](./decorators.mdx#component-decorators) and [global](./decorators.mdx#global-decorators) level.\"}, \"Stories for two or more components\": \"Sometimes you may have two or more components created to work together. For instance, if you have a parent `List` component, it may require child `ListItem` components.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-starter.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn such cases, it makes sense to [customize the rendering](#custom-rendering) to output the `List` component with different numbers of `ListItem` children.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-expanded.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYou can also reuse *story data* from the child `ListItem` in your `List` component. That\\u2019s easier to maintain because you don\\u2019t have to update it in multiple places.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-reuse-data.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nNote that there are disadvantages in writing stories like this as you cannot take full advantage of the args mechanism and composing args as you build even more complex composite components. For more discussion, see the [multi component stories](../writing-stories/stories-for-multiple-components.mdx) workflow documentation.\\n</Callout>\"}, \"metadata\": {\"title\": \"How to write stories\", \"sidebar\": {\"order\": 2, \"title\": \"Stories\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 3]\"}, {\"title\": \"Loaders\", \"description\": null, \"content\": {\"Fetching API data\": \"Stories are isolated component examples that render internal data defined as part of the story or alongside the story as [args](./args.mdx).\\n\\nLoaders are helpful when you need to load story data externally (e.g., from a remote API). Consider the following example that fetches a todo item to display in a todo list:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"loader-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe response obtained from the remote API call is combined into a `loaded` field on the story context, which is the second argument to a story function. For example, in React, the story's args were spread first to prioritize them over the static data provided by the loader. With other frameworks (e.g., Angular), you can write your stories as you'd usually do.\", \"Global loaders\": \"We can also set a loader for **all stories** via the `loaders` export of your [`.storybook/preview.js`](../configure/index.mdx#configure-story-rendering) file (this is the file where you configure all stories):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-global-loader.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn this example, we load a \\\"current user\\\" available as `loaded.currentUser` for all stories.\", \"Loader inheritance\": \"Like [parameters](./parameters.mdx), loaders can be defined globally, at the component level, and for a single story (as we\\u2019ve seen).\\n\\nAll loaders, defined at all levels that apply to a story, run before the story renders in Storybook's canvas.\\n\\n['All loaders run in parallel', 'All results are the `loaded` field in the story context', 'If there are keys that overlap, \\\"later\\\" loaders take precedence (from lowest to highest):', ['Global loaders, in the order they are defined', 'Component loaders, in the order they are defined', 'Story loaders, in the order they are defined']]\"}, \"metadata\": {\"title\": \"Loaders\", \"sidebar\": {\"order\": 5, \"title\": \"Loaders\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 4]\"}, {\"title\": \"Naming components and hierarchy\", \"description\": null, \"content\": {\"Structure and hierarchy\": \"When organizing your Storybook, there are two methods of structuring your stories: **implicit** and **explicit**. The [implicit method](../configure/user-interface/sidebar-and-urls.mdx#csf-30-auto-titles) involves relying upon the physical location of your stories to position them in the sidebar, while the [explicit method](#naming-stories) involves utilizing the `title` parameter to place the story.\\n\\n\\n\\nBased on how you structure your Storybook, you can see that the story hierarchy is made up of various parts:\\n\\n['**Category**: The top-level grouping of stories and documentation pages generated by Storybook', '**Folder**: A mid-level organizational unit that groups components and stories in the sidebar, representing a feature or section of your application', '**Component**: A low-level organizational unit representing the component that the story is testing', '**Docs**: The automatically generated [documentation page](../writing-docs/autodocs.mdx) for the component', '**Story**: The individual story testing a specific component state']\", \"Naming stories\": \"When creating your stories, you can explicitly use the `title` parameter to define the story's position in the sidebar. It can also be used to [group](#grouping) related components together in an expandable interface to help with Storybook organization providing a more intuitive experience for your users. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-default-export.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYields this:\\n\\n\", \"Grouping\": \"It is also possible to group related components in an expandable interface to help with Storybook organization. To do so, use the `/` as a separator:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-grouped.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"checkbox-story-grouped.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nYields this:\\n\\n\", \"Roots\": \"By default, the top-level grouping will be displayed as \\u201croot\\u201d in the Storybook UI (i.e., the uppercased, non-expandable items). If you need, you can [configure Storybook](../configure/user-interface/sidebar-and-urls.mdx#roots) and disable this behavior. Useful if you need to provide a streamlined experience for your users; nevertheless, if you have a large Storybook composed of multiple component stories, we recommend naming your components according to the file hierarchy.\\n\\n<If notRenderer=\\\"svelte\\\">\", \"Single-story hoisting\": \"Single-story components (i.e., component stories without **siblings**) whose **display name** exactly matches the component's name (last part of `title`) are automatically hoisted up to replace their parent component in the UI. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"button-story-hoisted.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\\n\\nBecause story exports are automatically \\\"start cased\\\" (`myStory` becomes `\\\"My Story\\\"`), your component name should match that. Alternatively, you can override the story name using `myStory.storyName = '...'` to match the component name.\\n\\n</If>\", \"Sorting stories\": \"Out of the box, Storybook sorts stories based on the order in which they are imported. However, you can customize this pattern to suit your needs and provide a more intuitive experience by adding `storySort` to the `options` parameter in your `preview.js` file.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-sort-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nAsides from the unique story identifier, you can also use the `title`, `name`, and import path to sort your stories using the `storySort` function.\\n</Callout>\\n\\nThe `storySort` can also accept a configuration object.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-empty-sort-object.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n| Field | Type | Description | Required | Default Value | Example |\\n| ---------------- | ------- | -------------------------------------------------------- | -------- | ----------------------- | ------------------------- |\\n| **method** | String | Tells Storybook in which order the stories are displayed | No | Storybook configuration | `'alphabetical'` |\\n| **order** | Array | The stories to be shown, ordered by supplied name | No | Empty Array `[]` | `['Intro', 'Components']` |\\n| **includeNames** | Boolean | Include story name in sort calculation | No | `false` | `true` |\\n| **locales** | String | The locale required to be displayed | No | System locale | `en-US` |\\n\\nTo sort your stories alphabetically, set `method` to `'alphabetical'` and optionally set the `locales` string. To sort your stories using a custom list, use the `order` array; stories that don't match an item in the `order` list will appear after the items in the list.\\n\\nThe `order` array can accept a nested array to sort 2nd-level story kinds. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-with-ordered-pages.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhich would result in this story ordering:\\n\\n['`Intro` and then `Intro/*` stories', '`Pages` story', '`Pages/Home` and `Pages/Home/*` stories', '`Pages/Login` and `Pages/Login/*` stories', '`Pages/Admin` and `Pages/Admin/*` stories', '`Pages/*` stories', '`Components` and `Components/*` stories', 'All other stories']\\n\\nIf you want specific categories to sort to the end of the list, you can insert a `*` into your `order` array to indicate where \\\"all other stories\\\" should go:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-preview-with-ordered-pages-and-wildcard.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIn this example, the `WIP` category would be displayed at the end of the list.\\n\\nNote that the `order` option is independent of the `method` option; stories are sorted first by the `order` array and then by either the `method: 'alphabetical'` or the default `configure()` import order.\"}, \"metadata\": {\"title\": \"Naming components and hierarchy\", \"sidebar\": {\"order\": 7, \"title\": \"Naming components and hierarchy\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 5]\"}, {\"title\": \"Parameters\", \"description\": null, \"content\": {\"Story parameters\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nWith Svelte, we can set the `parameters` property in the `Story` component to define parameters for a single story using Svelte CSF with the native templating syntax, or we can use the `parameters` key on a CSF named export:\\n\\n</IfRenderer>\\n\\n<IfRenderer renderer={['angular', 'vue', 'web-components', 'ember', 'html', 'react', 'preact', 'qwik', 'solid' ]}>\\n\\nWe can set a parameter for a single story with the `parameters` key on a CSF export:\\n\\n</IfRenderer>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Component parameters\": \"<IfRenderer renderer=\\\"svelte\\\">\\n\\nTo define parameters for all stories of a component, we can add the `parameters` property in the `defineMeta` function of a Svelte CSF story file, or we can use the `parameters` key on the default CSF export:\\n\\n</IfRenderer>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\nWe can set the parameters for all stories of a component using the `parameters` key on the default CSF export:\\n\\n</If>\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Global parameters\": \"We can also set the parameters for **all stories** via the `parameters` export of your [`.storybook/preview.js|ts`](../configure/index.mdx#configure-story-rendering) file (this is the file where you configure all stories):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"parameters-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nSetting a global parameter is a common way to configure addons. With backgrounds, you configure the list of backgrounds that every story can render in.\", \"Rules of parameter inheritance\": \"The way the global, component and story parameters are combined is:\\n\\n['More specific parameters take precedence (so a story parameter overwrites a component parameter which overwrites a global parameter).', 'Parameters are **merged**, so keys are only ever overwritten and never dropped.']\\n\\nThe merging of parameters is important. This means it is possible to override a single specific sub-parameter on a per-story basis while retaining most of the parameters defined globally.\\n\\nIf you are defining an API that relies on parameters (e.g., an [**addon**](../addons/index.mdx)) it is a good idea to take this behavior into account.\"}, \"metadata\": {\"title\": \"Parameters\", \"sidebar\": {\"order\": 2, \"title\": \"Parameters\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 6]\"}, {\"title\": \"Play function\", \"description\": null, \"content\": {\"Writing stories with the play function\": \"Storybook's `play` functions are small code snippets that run once the story finishes rendering. Aided by the [interactions panel](../writing-tests/interaction-testing.mdx#debugging-interaction-tests), it allows you to build component interactions and test scenarios that were impossible without user intervention. For example, if you were working on a registration form and wanted to validate it, you could write the following story with the `play` function:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nSee the [interaction testing documentation](../writing-tests/interaction-testing.mdx#writing-interaction-tests) for an overview of the available API events.\\n</Callout>\\n\\nWhen Storybook finishes rendering the story, it executes the steps defined within the `play` function, interacting with the component and filling the form's information. All of this without the need for user intervention. If you check your `Interactions` panel, you'll see the step-by-step flow.\", \"Working with the canvas\": \"Part of the context passed to the `play` function is a `canvas` object. This object allows you to query the DOM of the rendered story. It provides a scoped version of the Testing Library queries, so you can use them as you would in a regular test.\\n\\n<CodeSnippets path=\\\"play-function-with-canvas.md\\\" />\\n\\nIf you need to query outside of the canvas (for example, to test a dialog that appears outside of the story root), you can use the `screen` object available from `storybook/test`.\\n\\n<CodeSnippets path=\\\"play-function-with-screen.md\\\" />\", \"Composing stories\": \"Thanks to the [Component Story Format](../api/csf.mdx), an ES6 module based file format, you can also combine your `play` functions, similar to other existing Storybook features (e.g., [args](./args.mdx)). For example, if you wanted to verify a specific workflow for your component, you could write the following stories:\\n\\n<CodeSnippets path=\\\"play-function-composition.md\\\" />\\n\\nBy combining the stories, you're recreating the entire component workflow and can spot potential issues while reducing the boilerplate code you need to write.\"}, \"metadata\": {\"title\": \"Play function\", \"sidebar\": {\"order\": 4, \"title\": \"Play function\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 7]\"}, {\"title\": \"Stories for multiple components\", \"description\": null, \"content\": {\"Subcomponents\": \"When the components you're documenting have a parent-child relationship, you can use the `subcomponents` property to document them together. This is especially useful when the child component is not meant to be used on its own, but only as part of the parent component.\\n\\nHere's an example with `List` and `ListItem` components:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-with-subcomponents.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNote that by adding a `subcomponents` property to the default export, we get an extra panel on the [ArgTypes](../writing-docs/doc-blocks.mdx#argtypes) and [Controls](../essentials/controls.mdx#) tables, listing the props of `ListItem`:\\n\\n\\n\\nSubcomponents are only intended for documentation purposes and have some limitations:\\n\\n['The [argTypes](../api/arg-types.mdx) of subcomponents are [inferred (for the renderers that support that feature)](../api/arg-types.mdx#automatic-argtype-inference) and cannot be manually defined or overridden.', \\\"The table for each documented subcomponent does *not* include [controls](../essentials/controls.mdx) to change the value of the props, because controls always apply to the main component's args.\\\"]\\n\\nLet's talk about some techniques you can use to mitigate the above, which are especially useful in more complicated situations.\", \"Reusing story definitions\": \"We can also reduce repetition in our stories by reusing story definitions. Here, we can reuse the `ListItem` stories' args in the story for `List`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-reuse-data.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nBy rendering the `Unchecked` story with its args, we are able to reuse the input data from the `ListItem` stories in the `List`.\\n\\n<If renderer=\\\"react\\\">\\nHowever, we still aren\\u2019t using args to control the `ListItem` stories, which means we cannot change them with controls and we cannot reuse them in other, more complex component stories.\", \"Using children as an arg\": \"One way we improve that situation is by pulling the rendered subcomponent out into a `children` arg:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-with-unchecked-children.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow that `children` is an arg, we can potentially reuse it in another story.\\n\\nHowever, there are some caveats when using this approach that you should be aware of.\\n\\nThe `children` arg, just like all args, needs to be JSON serializable. To avoid errors with your Storybook, you should:\\n\\n['Avoid using empty values', 'Use [mapping](../essentials/controls.mdx#dealing-with-complex-values) if you want to adjust the value with [controls](../essentials/controls.mdx)', 'Use caution with components that include third party libraries']\\n\\n<Callout variant=\\\"info\\\">\\nWe're currently working on improving the overall experience for the children arg and allow you to edit children arg in a control and allow you to use other types of components in the near future. But for now you need to factor in this caveat when you're implementing your stories.\\n</Callout>\\n\\n{/* End if react */}\\n</If>\", \"Creating a Template Component\": \"Another option that is more \\u201cdata\\u201d-based is to create a special \\u201cstory-generating\\u201d template component:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"list-story-template.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis approach is a little more complex to setup, but it means you can more easily reuse the `args` to each story in a composite component. It also means you can alter the args to the component with the [Controls panel](../essentials/controls.mdx).\"}, \"metadata\": {\"title\": \"Stories for multiple components\", \"sidebar\": {\"order\": 10, \"title\": \"Stories for multiple components\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 8]\"}, {\"title\": \"Tags\", \"description\": null, \"content\": {\"Built-in tags\": \"The following tags are available in every Storybook project:\\n\\n| Tag | Applied\\u00a0by\\u00a0default? | Description |\\n| ---------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `autodocs` | No | Stories tagged with `autodocs` are included in the [docs page](../writing-docs/autodocs.mdx). If a CSF file does not contain at least one story tagged with `autodocs`, that component will not generate a docs page. |\\n| `dev` | Yes | Stories tagged with `dev` are rendered in Storybook's sidebar. |\\n| `test` | Yes | Stories tagged with `test` are included in [test runner](../writing-tests/integrations/test-runner.mdx#run-tests-for-a-subset-of-stories) or [Vitest addon](../writing-tests/integrations/vitest-addon.mdx#including-excluding-or-skipping-tests) runs. |\\n\\nThe `dev` and `test` tags are automatically, implicitly applied to every story in your Storybook project.\", \"Applying tags\": \"A tag can be any static (i.e. not created dynamically) string, either the [built-in tags](#built-in-tags) or custom tags of your own design. To apply tags to a story, assign an array of strings to the `tags` property. Tags may be applied at the project, component (meta), or story levels.\\n\\nFor example, to apply the `autodocs` tag to all stories in your project, you can use `.storybook/preview.js|ts`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWithin a component stories file, you apply tags like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-in-meta-and-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Removing tags\": \"To remove a tag from a story, prefix it with `!`. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-remove-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nTags can be removed for all stories in your project (in `.storybook/preview.js|ts`), all stories for a component (in the CSF file meta), or a single story (as above).\", \"Filtering by custom tags\": \"Custom tags enable a flexible layer of categorization on top of Storybook's sidebar hierarchy. In the example above, we created an `experimental` tag to indicate that a story is not yet stable.\\n\\nYou can create custom tags for any purpose. Sample uses might include:\\n\\n['Status, such as `experimental`, `new`, `stable`, or `deprecated`', 'User persona, such as `admin`, `user`, or `developer`', 'Component/code ownership']\\n\\nCustom tags are useful because they show up as filters in Storybook's sidebar. Selecting a tag in the filter causes the sidebar to only show stories with that tag. Selecting multiple tags shows stories that contain any of those tags.\\n\\n\\n\\nFiltering by tags is a powerful way to focus on a subset of stories, especially in large Storybook projects. You can also narrow your stories by tag and then search within that subset.\", \"Recipes\": {\"Docs-only stories\": \"It can sometimes be helpful to provide example stories for documentation purposes, but you want to keep the sidebar navigation more focused on stories useful for development. By enabling the `autodocs` tag and removing the `dev` tag, a story becomes docs-only: appearing only in the [docs page](../writing-docs/autodocs.mdx) and not in Storybook's sidebar.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-docs-only-in-meta.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Combo stories, still tested individually\": \"For a component with many variants, like a Button, a grid of those variants all together can be a helpful way to visualize it. But you may wish to test the variants individually. You can accomplish this with tags like so:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-combo-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}}, \"metadata\": {\"title\": \"Tags\", \"sidebar\": {\"order\": 6, \"title\": \"Tags\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 9]\"}, {\"title\": \"Writing stories in TypeScript\", \"description\": null, \"content\": {\"Typing stories with `Meta` and `StoryObj`\": {\"Props type parameter\": \"`Meta` and `StoryObj` types are both [generics](https://www.typescriptlang.org/docs/handbook/2/generics.html#working-with-generic-type-variables), so you can provide them with an optional prop type parameter for the component type or the component's props type (e.g., the `typeof Button` portion of `Meta<typeof Button>`). By doing so, TypeScript will prevent you from defining an invalid arg, and all [decorators](./decorators.mdx), [play functions](./play-function.mdx), or [loaders](./loaders.mdx) will type their function arguments.\\n\\nThe example above passes a component type. See [**Typing custom args**](#typing-custom-args) for an example of passing a props type.\"}, \"Using `satisfies` for better type safety\": \"<IfRenderer renderer={['angular', 'web-components']}>\\n<Callout variant=\\\"info\\\">\\nWe are not yet able to provide additional type safety using the `satisfies` operator with Angular and Web components.\\n\\n<details>\\n <summary>More info</summary>\\n\\n Both Angular and Web components utilize a class plus decorator approach. The decorators provide runtime metadata, but do not offer metadata at compile time.\\n\\n As a result, it appears impossible to determine if a property in the class is a required property or an optional property (but non-nullable due to a default value) or a non-nullable internal state variable.\\n\\n For more information, please refer to [this discussion](https://github.com/storybookjs/storybook/discussions/20988).\\n</details>\\n\\n</Callout>\\n</IfRenderer>\\n\\nIf you are using TypeScript 4.9+, you can take advantage of the new [`satisfies`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-4-9.html) operator to get stricter type checking. Now you will receive type errors for missing required args, not just invalid ones.\\n\\nUsing `satisfies` to apply a story's type helps maintain type safety when sharing a [play function](./play-function.mdx) across stories. Without it, TypeScript will throw an error that the `play` function may be undefined. The `satisfies` operator enables TypeScript to infer whether the play function is defined or not.\\n\\nFinally, use of `satisfies` allows you to pass `typeof meta` to the `StoryObj` generic. This informs TypeScript of the connection between the `meta` and `StoryObj` types, which allows it to infer the `args` type from the `meta` type. In other words, TypeScript will understand that args can be defined both at the story and meta level and won't throw an error when a required arg is defined at the meta level, but not at the story level.\", \"Typing custom args\": {\"Vue specific tips\": \"Vue has excellent support for TypeScript, and we have done our utmost to take advantage of that in the stories files. For example, consider the following strongly typed Vue 3 single file component (SFC):\\n\\n```\\n<script setup lang=\\\"ts\\\">\\n defineProps<{ count: number; disabled: boolean }>();\\n\\n const emit = defineEmits<{\\n (e: 'increaseBy', amount: number): void;\\n (e: 'decreaseBy', amount: number): void;\\n }>();\\n</script>\\n\\n<template>\\n <div class=\\\"card\\\">\\n {{ count }}\\n <button @click=\\\"emit('increaseBy', 1)\\\" :disabled=\\\"disabled\\\">Increase by 1</button>\\n <button @click=\\\"$emit('decreaseBy', 1)\\\" :disabled=\\\"disabled\\\">Decrease by 1</button>\\n </div>\\n</template>\\n```\\n\\nYou can type check SFC files with vue-tsc and get editor support in VSCode by installing the official [Vue](https://marketplace.visualstudio.com/items?itemName=Vue.volar) extension.\\n\\nThis setup will add type support for `*.vue` imports to your `*.stories.ts` files, providing the same type safety and autocomplete features.\\n</IfRenderer>\\n\\n<IfRenderer renderer=\\\"svelte\\\">\", \"Svelte specific tips\": \"Svelte offers excellent TypeScript support for .svelte files. For example, consider the following component. You can run type checks using svelte-check and add VSCode editor support with the [Svelte for VSCode extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).\\n\\n```\\n<script lang=\\\"ts\\\">\\n let count: number = $state(0);\\n let disabled: boolean = $state(false);\\n\\n const increaseBy = () => {\\n count += 1\\n };\\n \\n const decreaseBy = () => {\\n count -= 1\\n };\\n</script>\\n\\n<div class=\\\"card\\\">\\n {count}\\n <button onclick={increaseBy} {disabled}> Increase by 1 </button>\\n <button onclick={decreaseBy} {disabled}> Decrease by 1 </button>\\n</div>\\n```\\n\\nThe same setup works with Svelte stories files too, providing both type safety and autocompletion.\\n</IfRenderer>\"}}, \"metadata\": {\"title\": \"Writing stories in TypeScript\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 10]\"}, {\"title\": \"Mocking Data And Modules\", \"description\": \"Documentation section: mocking-data-and-modules\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/writing-stories/mocking-data-and-modules\"}, \"subpages\": [{\"title\": \"Mocking data and modules\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Mocking data and modules\", \"sidebar\": {\"order\": 8, \"title\": \"Mocking data and modules\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\"}, {\"title\": \"Mocking modules\", \"description\": null, \"content\": {\"Automocking\": {\"Registering modules to mock\": {\"Spy-only\": \"For most cases, you should register a mocked module as spy-only, by setting the `spy` option to `true`. This leaves the original module's functionality intact, while still allowing you to modify the behavior if needed and make assertions in your tests.\\n\\nFor example, if you want to spy on the `getUserFromSession` function and the `uuidv4` function from the `uuid` package, you can call the `sb.mock` utility function in your `.storybook/preview.js|ts` file:\\n\\n<CodeSnippets path=\\\"automock-register-spy.md\\\" />\\n\\nIf you need to mock an external module that has a deeper import path (e.g. `lodash-es/add`), register the mock with that path.\\n\\nYou can then [control the behavior of these modules](#using-automocked-modules-in-stories) and make assertions about them in your stories, such as checking if a function was called or what arguments it was called with.\", \"Fully automocked modules\": \"For cases where you need to prevent the original module's functionality from executing, set the `spy` option to `false` (or omit it, because that is the default value). This will automatically replace all exports from the module with [Vitest mock functions](https://vitest.dev/api/mock.html), allowing you to control their behavior and make assertions while being certain that the original functionality never runs.\\n\\n<CodeSnippets path=\\\"automock-register-full.md\\\" />\\n\\n<Callout variant=\\\"warning\\\">\\n\\nFully automocked modules do not execute their exported functions, but the module is still evaluated, along with its dependencies. This means that if the module has side effects (e.g., modifying global state, logging to the console, etc.), those side effects will still occur. Similarly, a module written to run on the server will attempt to be evaluated in the browser. If you want to prevent the original module's code from running entirely, you should use a [mock file](#mock-files) instead.\\n\\n</Callout>\\n\\nYou can then [control the behavior of these modules](#using-automocked-modules-in-stories) and make assertions about them in your stories, just like with the spy-only approach.\", \"Mock files\": \"If you want to mock a module with more complex behavior or reuse a mock's behavior across multiple stories, you can create a mock file. This file should be placed in a `__mocks__` directory next to the module you want to mock, and it should export the same named exports as the original module.\\n\\nFor example, to mock the `session` module in the `lib` directory, create a file named `session.js|ts` in the `lib/__mocks__` directory:\\n\\n```\\nexport function getUserFromSession() {\\n return { name: 'Mocked User' };\\n}\\n```\\n\\nFor packages in your `node_modules`, create a `__mocks__` directory in the root of your project and create the mock file there. For example, to mock the `uuid` package, create a file named `uuid.js` in the `__mocks__` directory:\\n\\n```\\nexport function v4() {\\n return '1234-5678-90ab-cdef';\\n}\\n```\\n\\nIf you need to mock an external module that has a deeper import path (e.g. `lodash-es/add`), create a corresponding mock file (e.g. `__mocks__/lodash-es/add.js`) in the root of your project.\\n\\nThe root of your project is determined differently depending on your builder:\\n\\n**Vite projects**\\n\\nThe root `__mocks__` directory should be placed in the [`root` directory](https://vite.dev/config/shared-options.html#root), as defined in your project's Vite configuration (typically `process.cwd()`) If that is unavailable, it defaults to the directory containing your `.storybook` directory.\\n\\n**Webpack projects**\\n\\nThe root `__mocks__` directory should be placed in the [`context` directory](https://webpack.js.org/configuration/entry-context/#context), as defined in your project's Webpack configuration (typically `process.cwd()`). If that is unavailable, it defaults to the root of your repository.\\n\\n<Callout variant=\\\"info\\\">\\n\\nMock files must be written with JavaScript (not TypeScript) using ESModules (not CJS).\\n\\nThey must export the same named exports as the original module. If you want to mock a default export, you can use `export default` in the mock file.\\n\\n</Callout>\\n\\nYou can then use the `sb.mock` utility to register these mock files in your `preview.js|ts` file:\\n\\n<CodeSnippets path=\\\"automock-register-mock-file.md\\\" />\\n\\nNote that the API for registering automatically mocked modules and mock files is the same. The only difference is that `sb.mock` will first look for a mock file in the appropriate directory before automatically mocking the module.\"}, \"Using automocked modules in stories\": \"All registered automocked modules are used the same way within your stories. You can control the behavior, such as defining what it returns, and make assertions about the modules.\\n\\n<CodeSnippets path=\\\"automocked-modules-in-story.md\\\" />\\n\\nMocked functions created with the `sb.mock` utility are full [Vitest mock functions](https://vitest.dev/api/mock.html), which means you can use all the methods available on them. Some of the most useful methods include:\\n\\n| Method | Description |\\n| -------------------------------------------------------------------------------- | ----------------------------------------------------- |\\n| [`mockReturnValue(value)`](https://vitest.dev/api/mock.html#mockreturnvalue) | Sets the return value of the mocked function. |\\n| [`mockResolvedValue(value)`](https://vitest.dev/api/mock.html#mockresolvedvalue) | Sets the value the mocked async function resolves to. |\\n| [`mockImplementation(fn)`](https://vitest.dev/api/mock.html#mockimplementation) | Sets a custom implementation for the mocked function. |\\n\\n<Callout variant=\\\"info\\\">\\n\\nIf you are [writing your stories in TypeScript](../typescript.mdx), you can use the `mocked` utility from `storybook/test` to ensure that the mocked functions are correctly typed in your stories. This utility is a type-safe wrapper around the Vitest `vi.mocked` function.\\n\\n</Callout>\", \"How it works\": {\"Comparison to Vitest mocking\": \"While this feature uses Vitest's mocking engine, the implementation within Storybook has some key differences:\\n\\n['Scope: Mocks are global and defined only in `.storybook/preview.js|ts`. Unlike Vitest, you cannot call `sb.mock()` inside individual story files.', \\\"Static by Design: All mocking decisions are finalized at build time. This makes the system robust and performant but less dynamic than Vitest's test-by-test mocking capabilities. There is no `sb.unmock()` or equivalent, as the module graph is fixed in a production build.\\\", \\\"Runtime Mocking: While the module swap is static, you can still control the behavior of the mocked functions at runtime within a play function or `beforeEach` hook (e.g., `mocked(myFunction).mockReturnValue('new value')`).\\\", \\\"No Factory Functions: The `sb.mock()` API does not accept a factory function as its second argument (e.g., `sb.mock('path', () => ({...}))`). This is because all mocking decisions are resolved at build time, whereas factories are executed at runtime.\\\"]\"}}, \"Alternative methods\": {\"Subpath imports\": {\"Mock files\": \"To mock a module, create a file with the same name and in the same directory as the module you want to mock. For example, to mock a module named `session`, create a file next to it named `session.mock.js|ts`, with a few characteristics:\\n\\n['It must import the original module using a relative import.', ['Using a subpath or alias import would result in it importing itself.'], 'It should re-export all exports from the original module.', 'It should use the `fn` utility to mock any necessary functionality from the original module.', 'It should use the [`mockName`](https://vitest.dev/api/mock.html#mockname) method to ensure the name is preserved when minified', 'It should not introduce side effects that could affect other tests or components. Mock files should be isolated and only affect the module they are mocking.']\\n\\nHere's an example of a mock file for a module named `session`:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-test-mock-file-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen you use the `fn` utility to mock a module, you create full [Vitest mock functions](https://vitest.dev/api/mock.html). See [below](#using-mocked-modules-in-stories) for examples of how you can use a mocked module in your stories.\\n\\n**Mock files for external modules**\\n\\nYou can't directly mock an external module like [`uuid`](https://github.com/uuidjs/uuid) or `node:fs`. Instead, you must wrap it in your own module, which you can mock like any other internal one. For example, with `uuid`, you could do the following:\\n\\n```\\nimport { v4 } from 'uuid';\\n\\nexport const uuidv4 = v4;\\n```\\n\\nAnd create a mock for the wrapper:\\n\\n```\\nimport { fn } from 'storybook/test';\\n\\nimport * as actual from './uuid';\\n\\nexport const uuidv4 = fn(actual.uuidv4).mockName('uuidv4');\\n```\", \"Configuration\": \"To configure subpath imports, you define the `imports` property in your project's `package.json` file. This property maps the subpath to the actual file path. The example below configures subpath imports for four internal modules:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"subpath-imports-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThere are three aspects to this configuration worth noting:\\n\\nFirst, **each subpath must begin with `#`**, to differentiate it from a regular module path. The `#*` entry is a catch-all that maps all subpaths to the root directory.\\n\\nSecond, the order of the keys is important. The `default` key should come last.\\n\\nThird, note the **`storybook`, `test`, and `default` keys** in each module's entry. The `storybook` value is used to import the mock file when loaded in Storybook, while the `default` value is used to import the original module when loaded in your project. The `test` condition is also used within Storybook, which allows you to use the same configuration in Storybook and your other tests.\\n\\nWith the package configuration in place, you can then update your component file to use the subpath import:\\n\\n```\\n// \\u2796 Remove this line\\n// import { getUserFromSession } from '../../lib/session';\\n// \\u2795 Add this line\\nimport { getUserFromSession } from '#lib/session';\\n\\n// ...rest of the file\\n```\\n\\n<Callout variant=\\\"info\\\">\\nSubpath imports will only be correctly resolved and typed when the [`moduleResolution` property](https://www.typescriptlang.org/tsconfig/#moduleResolution) is set to `'Bundler'`, `'NodeNext'`, or `'Node16'` in your TypeScript configuration.\\n\\nIf you are currently using `'node'`, that is intended for projects using a Node.js version older than v10. Projects written with modern code likely do not need to use `'node'`.\\n\\nStorybook recommends the [TSConfig Cheat Sheet](https://www.totaltypescript.com/tsconfig-cheat-sheet) for guidance on setting up your TypeScript configuration.\\n</Callout>\", \"Using subpath imports in stories\": \"When you use the `fn` utility to mock a module, you create full [Vitest mock functions](https://vitest.dev/api/mock.html), which have many methods available. Some of the most useful methods include:\\n\\n| Method | Description |\\n| -------------------------------------------------------------------------------- | ----------------------------------------------------- |\\n| [`mockReturnValue(value)`](https://vitest.dev/api/mock.html#mockreturnvalue) | Sets the return value of the mocked function. |\\n| [`mockResolvedValue(value)`](https://vitest.dev/api/mock.html#mockresolvedvalue) | Sets the value the mocked async function resolves to. |\\n| [`mockImplementation(fn)`](https://vitest.dev/api/mock.html#mockimplementation) | Sets a custom implementation for the mocked function. |\\n\\nHere, we define `beforeEach` on a story (which will run before the story is rendered) to set a mocked return value for the `getUserFromSession` function used by the Page component:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-test-mock-return-value.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nIf you are [writing your stories in TypeScript](../typescript.mdx), you must import your mock modules using the full mocked file name to have the functions correctly typed in your stories. You do **not** need to do this in your component files. That's what the [subpath import](#subpath-imports) or [builder alias](#builder-aliases) is for.\\n</Callout>\", \"Spying on mocked modules\": \"The `fn` utility also spies on the original module's functions, which you can use to assert their behavior in your tests. For example, you can use [interaction tests](../../writing-tests/interaction-testing.mdx) to verify that a function was called with specific arguments.\\n\\nFor example, this story checks that the `saveNote` function was called when the user clicks the save button:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-test-fn-mock-spy.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Builder aliases\": \"If your project is unable to use [automocking](#automocking) or [subpath imports](#subpath-imports), you can configure your Storybook builder to alias the module to the [mock file](#mock-files-1). This will instruct the builder to replace the module with the mock file when bundling your Storybook stories.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"module-aliases-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUsage of the aliased module in stories is similar to when [using subpath imports in stories](#using-subpath-imports-in-stories), but you import the module using the alias instead of the subpath.\\n\\n[]\"}, \"Common scenarios\": {\"Setting up and cleaning up\": \"Before the story renders, you can use the asynchronous `beforeEach` function to perform any setup you need (e.g., configure the mock behavior). This function can be defined at the story, component (which will run for all stories in the file), or project (defined\\u00a0in `.storybook/preview.js|ts`,\\u00a0which will run for all stories in the project).\\n\\nYou can also return a cleanup function from `beforeEach` which will be called after your story unmounts. This is useful for tasks like unsubscribing observers, etc.\\n\\n<Callout variant=\\\"info\\\">\\nIt is *not* necessary to restore `fn()` mocks with the cleanup function, as Storybook will already do that automatically before rendering a story. See the [`parameters.test.restoreMocks` API](../../api/parameters.mdx#restoremocks) for more information.\\n</Callout>\\n\\nHere's an example of using the [`mockdate`](https://github.com/boblauer/MockDate) package to mock the [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) and reset it when the story unmounts.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"before-each-in-meta-mock-date.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n[]\"}, \"Troubleshooting\": {\"Receiving an `exports is not defined` error\": \"Webpack projects may encounter an `exports is not defined` error when using [automocking](#automocking). This is usually caused by attempting to mock a module with CommonJS (CJS) entry points. Automocking with Webpack only works with modules that have ESModules (ESM) entry points exclusively, so you must use a [mock file](#mock-files) to mock CJS modules.\"}}, \"metadata\": {\"title\": \"Mocking modules\", \"sidebar\": {\"order\": 1, \"title\": \"Modules\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\"}, {\"title\": \"Mocking network requests\", \"description\": null, \"content\": {\"Set up the MSW addon\": \"First, if necessary, run this command to install MSW and the MSW addon:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"msw-addon-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nIf you're not already using MSW, generate the service worker file necessary for MSW to work:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"msw-generate-service-worker.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<If renderer=\\\"angular\\\">\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nAngular projects will likely need to adjust the command to save the mock service worker file in a different directory (e.g., `src`).\\n</Callout>\\n</If>\\n\\nThen ensure the [`staticDirs`](../../api/main-config/main-config-static-dirs.mdx) property in your Storybook configuration will include the generated service worker file (in `/public`, by default):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"main-config-static-dirs.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, initialize the addon and apply it to all stories with a [project-level loader](../loaders.mdx#global-loaders):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"msw-addon-initialize.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Mocking REST requests\": \"If your component fetches data from a REST API, you can use MSW to mock those requests in Storybook. As an example, consider this document screen component:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"document-screen-fetch.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\nThis example uses the [`fetch` API](https://developer.mozilla.org/en-US/docs/Web/API/fetch) to make network requests. If you're using a different library (e.g. [`axios`](https://axios-http.com/)), you can apply the same principles to mock network requests in Storybook.\\n</Callout>\\n\\nWith the MSW addon, we can write stories that use MSW to mock the REST requests. Here's an example of two stories for the document screen component: one that fetches data successfully and another that fails.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"msw-addon-configure-handlers-http.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Mocking GraphQL requests\": \"GraphQL is another common way to fetch data in components. You can use MSW to mock GraphQL requests in Storybook. Here's an example of a document screen component that fetches data from a GraphQL API:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"document-screen-with-graphql.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<If renderer=\\\"svelte\\\">\\n\\n<Callout variant=\\\"info\\\">\\nThis example uses [URQL](https://formidable.com/open-source/urql/) to make network requests. If you're using a different library (e.g., [Houdini](https://houdinigraphql.com/) or [Graffle](https://graffle.js.org/)), you can apply the same principles to mock network requests in Storybook.\\n</Callout>\\n\\n</If>\\n\\n<If notRenderer=\\\"svelte\\\">\\n\\n<Callout variant=\\\"info\\\">\\nThis example uses GraphQL with [Apollo Client](https://www.apollographql.com/docs/) to make network requests. If you're using a different library (e.g. [URQL](https://formidable.com/open-source/urql/) or [React Query](https://react-query.tanstack.com/)), you can apply the same principles to mock network requests in Storybook.\\n</Callout>\\n\\n</If>\\n\\nThe MSW addon allows you to write stories that use MSW to mock the GraphQL requests. Here's an example demonstrating two stories for the document screen component. The first story fetches data successfully, while the second story fails.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"msw-addon-configure-handlers-graphql.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configuring MSW for stories\": \"In the examples above, note how each story is configured with `parameters.msw` to define the request handlers for the mock server. Because it uses parameters in this way, it can also be configured at the [component](../parameters.mdx#component-parameters) or even [project](../parameters.mdx#global-parameters) level, allowing you to share the same mock server configuration across multiple stories.\"}, \"metadata\": {\"title\": \"Mocking network requests\", \"sidebar\": {\"order\": 2, \"title\": \"Network requests\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\"}, {\"title\": \"Mocking providers\", \"description\": null, \"content\": {\"Configuring the mock provider\": \"When mocking a provider, it may be necessary to configure the provider to supply a different value for individual stories. For example, you might want to test a component with different themes or user roles.\\n\\nOne way to do this is to define the decorator for each story individually. But if you imagine a scenario where you wish to create stories for each of your components in both light and dark themes, this approach can quickly become cumbersome.\\n\\nFor a better way, with much less repetition, you can use the [decorator function's second \\\"context\\\" argument](../decorators.mdx#context-for-mocking) to access a story's [`parameters`](../parameters.mdx) and adjust the provided value. This way, you can define the provider once and adjust its value for each story.\\n\\nFor example, we can adjust the decorator from above to read from `parameters.theme` to determine which theme to provide:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"mock-provider-in-preview.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nNow, you can define a `theme` parameter in your stories to adjust the theme provided by the decorator:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"configure-mock-provider-with-story-parameter.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThis powerful approach allows you to provide any value (theme, user role, mock data, etc.) to your components in a way that is both flexible and maintainable.\\n</If>\"}, \"metadata\": {\"title\": \"Mocking providers\", \"sidebar\": {\"order\": 3, \"title\": \"Providers\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 13, \\\"subpages\\\", 11]\"}], \"path\": \"[\\\"subpages\\\", 13]\"}, {\"title\": \"Writing Tests\", \"description\": \"Documentation section: writing-tests\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/writing-tests\"}, \"subpages\": [{\"title\": \"Accessibility tests\", \"description\": null, \"content\": {\"Install the addon\": \"Storybook provides an Accessibility (a11y) addon to help ensure the accessibility of your components. It is built on top of Deque\\u2019s [axe-core library](https://github.com/dequelabs/axe-core), which automatically catches [up to 57% of WCAG issues](https://www.deque.com/blog/automated-testing-study-identifies-57-percent-of-digital-accessibility-issues/).\\n\\nRun this command to install and configure the addon in your project:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-a11y-add.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\">\\n\\nStorybook's [`add`](../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\\n\\nYour Storybook will now include some features to check the accessibility of your components, including a button in the toolbar to simulate different vision impairments and an Accessibility addon panel to check for violations.\\n\\n\", \"Check for violations\": \"When you navigate to a story, automated accessibility checks are run and the results are reported in the Accessibility addon panel. \\n\\nThe results are broken down into three sub-tabs:\\n\\n['**Violations** are known violations of WCAG rules and best practices', '**Passes** are known non-violations', '**Incomplete** highlights areas that you should confirm manually because they could not be checked automatically']\", \"Configure\": {\"Rulesets\": \"The addon uses the `axe-core` library to run accessibility checks. By default, it runs a set of rules that are based on the WCAG 2.0 and 2.1 guidelines, as well as some best practices:\\n\\n['[WCAG 2.0 Level A & AA Rules](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md#wcag-20-level-a--aa-rules)', '[WCAG 2.1 Level A & AA Rules](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md#wcag-21-level-a--aa-rules)', '[Best Practices Rules](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md#best-practices-rules)']\\n\\nYou can find a breakdown of these rulesets, as well as the other rulesets available in [axe-core\\u2019s documentation](https://github.com/dequelabs/axe-core/blob/develop/doc/rule-descriptions.md#wcag-2x-level-aaa-rules).\\n\\nTo change the rules that are checked against (e.g. to check against WCAG 2.2 AA or WCAG 2.x AAA rules), use the [`runOnly` option](https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter-examples):\\n\\n<CodeSnippets path=\\\"addon-a11y-config-rulesets-in-preview.md\\\" />\", \"Individual rules\": \"You can also enable, disable, or configure individual rules. This can be done in the `config` property of the `parameters.a11y` object. For example:\\n\\n<CodeSnippets path=\\\"addon-a11y-config-rules-in-story.md\\\" />\", \"Test behavior\": \"You can configure accessibility tests with the `parameters.a11y.test` [parameter](../writing-stories/parameters.mdx), which determines the behavior of accessibility tests for a story when run with either the [Vitest addon](./integrations/vitest-addon.mdx) or the [test-runner](./integrations/test-runner.mdx). The parameter accepts three values:\\n\\n| Value | Description |\\n| --------- | ---------------------------------------------------------------------------------------- |\\n| `'off'` | Do not run accessibility tests (you can still manually verify via the addon panel) |\\n| `'todo'` | Run accessibility tests; violations return a warning in the Storybook UI |\\n| `'error'` | Run accessibility tests; violations return a failing test in the Storybook UI and CLI/CI |\\n\\nLike other parameters, you can define it at the project level in `.storybook/preview.js|ts`, the component level in the default export of the story file, or the individual story level. For example, to fail on accessibility tests for all stories in a file except one:\\n\\n<CodeSnippets path=\\\"addon-a11y-parameter-example.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhy is the value called \\\"todo\\\" instead of \\\"warn\\\"? This value is intended to serve as a literal `TODO` in your codebase. It can be used to mark stories that you know have accessibility issues but are not ready to fix yet. This way, you can keep track of them and address them later.\\n\\nThe `'off'` value should only be used for stories that do not need to be tested for accessibility, such as one used to demonstrate an antipattern in a component's usage.\\n\\nYou can also [disable individual rules](#individual-rules) when they are not applicable to your use case.\\n\\n</Callout>\", \"Excluded elements\": \"Sometimes, it may be necessary to exclude certain elements from the accessibility checks. For this, you can define a custom [context](https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#context-parameter) to select which elements are included (or excluded) when running checks. For example, this story will ignore elements with the class `no-a11y-check`:\\n\\n<CodeSnippets path=\\\"addon-a11y-config-context-in-story.md\\\" />\", \"Disable automated checks\": \"When you disable automated accessibility checks, the addon will not run any tests when you navigate to a story or when you [run the tests with the Vitest addon](#run-accessibility-tests). You can still manually trigger checks in the Accessibility addon panel. This is useful for stories that are not meant to be accessible, such as those demonstrating an antipattern or a specific use case.\\n\\n<If renderer=\\\"svelte\\\">\\n\\nIf you are using Svelte CSF, you can turn off automated accessibility checks for stories or components by adding globals to your story or adjusting the `defineMeta` function with the required configuration. With a regular CSF story, you can add the following to your story's export or component's default export:\\n\\n</If>\\n\\n<If notRenderer={['svelte']}>\\n\\nDisable automated accessibility checks for stories or components by adding the following globals to your story's export or component's default export:\\n\\n</If>\\n\\n<CodeSnippets path=\\\"addon-a11y-disable.md\\\" />\"}, \"Run accessibility tests\": {\"With the Vitest addon\": \"If you're using the [Vitest addon](./integrations/vitest-addon.mdx), you can run your accessibility tests, as part of component tests, in these ways:\\n\\n['[In the Storybook UI](./integrations/vitest-addon.mdx#storybook-ui)', '[In CI environments](./integrations/vitest-addon.mdx#in-ci)']\\n\\nTo run accessibility tests in the Storybook UI, first expand the testing widget in the sidebar and check the Accessibility checkbox. Now, when you press the Run component tests button, the accessibility tests will be run along with any other tests you have configured.\\n\\n\\n\\nAfter running the tests, you will see the results in the sidebar, which will add a test status indicator next to each story that was tested. You can press on these indicators to open a menu with the Accessibility test result. Pressing on that result will navigate to that story and open the Accessibility panel, where you view details about each violation and suggestions toward how to fix them.\\n\\n\\n\\nIf any of your tests have warnings or failures, the testing widget will show the number of warnings and failures. You can press on these to filter the stories in the sidebar to only show those with warnings or failures.\\n\\nIn CI, accessibility tests are run automatically for stories with [`parameters.a11y.test = 'error'`](#test-behavior) when you run the Vitest tests.\", \"With the test-runner\": \"If you're using the [test-runner](./integrations/test-runner.mdx), you can run your accessibility tests in the terminal or in CI environments.\\n\\nAccessibility tests are included in your test run when you have the Accessibility addon installed and [`parameters.a11y.test`](#test-behavior) is set to a value other than `'off'`.\"}, \"Debug accessibility violations\": \"When you run accessibility tests, the results are reported in the Storybook UI. You can click on a violation to see more details about it, including the rule that was violated and suggestions for how to fix it.\\n\\nYou can also toggle on highlighting in the Storybook UI to see which elements are causing the violation, and click on a highlighted element to see the violations details in a popover menu.\\n\\n\", \"Automate with CI\": \"When you run your accessibility tests with the Vitest addon, automating them is as simple as running them in your CI environment. For more information, please see the [testing in CI guide](./in-ci.mdx).\\n\\n<Callout variant=\\\"warning\\\">\\n\\nAccessibility tests will only produce errors in CI if you have set [`parameters.a11y.test`](#test-behavior) to `'error'`. If you set it to `'todo'`, there will be no accessibility-related errors, warnings, or output in CI, but you can still see the results as warnings in the Storybook UI when you run the tests locally.\\n\\n</Callout>\\n\\nIf you cannot use the Vitest addon, you can still run your tests in CI using the [test-runner](./integrations/test-runner.mdx).\", \"Recommended workflow\": \"You can use configuration to progressively work toward a more accessible UI by combining multiple test behaviors. For example, you can start with `'error'` to fail on accessibility violations, then switch to `'todo'` to mark components that need fixing, and finally remove the todos once all stories pass accessibility tests:\\n\\n[\\\"Update your project configuration to fail on accessibility violations by setting [`parameters.a11y.test`](#test-behavior) to `'error'`. This ensures that all new stories are tested to meet accessibility standards.\\\", '<CodeSnippets path=\\\"addon-a11y-parameter-error-in-preview.md\\\" />', 'You will likely find that many components have accessibility failures (and maybe feel a bit overwhelmed!).', \\\"Take note of the components with accessibility issues and temporarily reduce their failures to warnings by applying the `'todo'` parameter value. This keeps accessibility issues visible while not blocking development. This is also a good time to commit your work as a baseline for future improvements.\\\", '<CodeSnippets path=\\\"addon-a11y-parameter-todo-in-meta.md\\\" />', \\\"Pick a good starting point from the components you just marked `'todo'` (we recommend something like Button, for its simplicity and likelihood of being used within other components). Fix the issues in that component using the suggestions in the addon panel to ensure it passes accessibility tests, then remove the parameter.\\\", '<CodeSnippets path=\\\"addon-a11y-parameter-remove.md\\\" />', \\\"Pick another component and repeat the process until you've covered all your components and you're an accessibility hero!\\\"]\", \"FAQ\": {\"What\\u2019s the difference between browser-based and linter-based accessibility tests?\": \"Browser-based accessibility tests, like those found in Storybook, evaluate the rendered DOM because that gives you the highest accuracy. Auditing code that hasn't been compiled yet is one step removed from the real thing, so you won't catch everything the user might experience.\", \"Why are my tests failing in different environments?\": \"With the [Vitest addon](./integrations/vitest-addon.mdx), your tests run in Vitest using your project's configuration with Playwright's Chromium browser. This can lead to inconsistent test results reported in the Storybook UI or CLI. The inconsistency can be due to `axe-core` reporting different results in different environments, such as browser versions or configurations. If you encounter this issue, we recommend reaching out using the default communication channels (e.g., [GitHub discussions](https://github.com/storybookjs/storybook/discussions/new?category=help), [Github issues](https://github.com/storybookjs/storybook/issues/new?template=bug_report.yml)).\", \"The addon panel does not show expected violations\": \"Modern React components often use asynchronous techniques like [Suspense](https://react.dev/reference/react/Suspense) or [React Server Components (RSC)](https://react.dev/reference/rsc/server-components) to handle complex data fetching and rendering. These components don\\u2019t immediately render their final UI state. Storybook doesn\\u2019t inherently know when an async component has fully rendered. As a result, the a11y checks sometimes run too early, before the component finishes rendering, leading to false negatives (no reported violations even if they exist).\\n\\nTo address this issue, we have introduced a feature flag: `developmentModeForBuild`. This feature flag allows you to set `process.env.NODE_ENV` to `'development'` in built Storybooks, enabling development-related optimizations that are typically disabled in production builds. One of those development optimizations is React\\u2019s [`act` utility](https://react.dev/reference/react/act), which helps ensure that all updates related to a test are processed and applied before making assertions, like a11y checks.\\n\\nTo enable this feature flag, add the following configuration to your `.storybook/main.js|ts` file:\\n\\n<CodeSnippets path=\\\"main-config-features-development-mode-for-build.md\\\" />\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Visual testing](./visual-testing.mdx) for appearance', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"Accessibility tests\", \"sidebar\": {\"order\": 3, \"title\": \"Accessibility tests\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 0]\"}, {\"title\": \"Testing in CI\", \"description\": null, \"content\": {\"Set up Storybook tests in CI\": {\"1. Define `package.json` script\": \"For convenience, define a script in your `package.json` to run the Storybook tests. This is the same command you would run locally, but it\\u2019s useful to have it in your CI workflow.\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n \\\"test-storybook\\\": \\\"vitest --project=storybook\\\"\\n }\\n}\\n```\\n\\nThis script calls the `vitest` CLI command and restricts it to the \\u201cstorybook\\u201d project defined in your Vitest config, which was created when you installed the Vitest addon. (If you\\u2019ve renamed the project, adjust the script above accordingly.) You can also pass any additional `vitest` [CLI options](https://vitest.dev/guide/cli.html#options) you may require.\", \"2. Add a new CI workflow\": {\"2.1 Debug test failures\": \"When a Storybook test fails, the failure output includes a link to the failing story. When running locally, this points to your local Storybook running at `localhost:6006`. But in CI, there is no active Storybook. Instead, you must first build and publish your Storybook, then inform the Vitest addon where your Storybook is published so that it can print useful story links.\\n\\nHere's an example using GitHub Actions. The steps are similar for other CI providers, though details in the syntax or configuration may vary.\\n\\nWhen deployments for services like Vercel, GitHub Pages, and others are performed, they follow a pattern of emitting a `deployment_status` event containing the newly generated URL under `deployment_status.environment_url`. This is the URL to the published Storybook instance.\\n\\nWe can pass that URL to the command using an environment variable, `SB_URL`.\\n\\n```\\nname: Storybook Tests\\n\\n+ # \\ud83d\\udc47 Update this to only run when a deployment status is emitted\\n+ on: deployment_status\\n- on: [push]\\n\\njobs:\\n test:\\n runs-on: ubuntu-latest\\n container:\\n image: mcr.microsoft.com/playwright:v1.52.0-noble\\n+ # \\ud83d\\udc47 Only run on successful deployments\\n+ if: github.event_name == 'deployment_status' && github.event.deployment_status.state == 'success'\\n steps:\\n - uses: actions/checkout@v4\\n\\n - name: Setup Node\\n uses: actions/setup-node@v4\\n with:\\n node-version: 22.12.0\\n \\n - name: Install dependencies\\n run: npm ci\\n\\n - name: Run tests\\n run: npm run test-storybook\\n+ # \\ud83d\\udc47 Pass the Storybook URL as an environment variable\\n+ env:\\n+ SB_URL: '${{ github.event.deployment_status.environment_url }}'\\n```\\n\\nFinally, we update the plugin configuration to use that environment variable in the [`storybookUrl` plugin option](./integrations/vitest-addon.mdx#storybookurl).\\n\\n```\\nexport default defineWorkspace([\\n // ...\\n {\\n // ...\\n {\\n plugins: [\\n storybookTest({\\n // ...\\n+ // \\ud83d\\udc47 Use the environment variable you passed\\n+ storybookUrl: process.env.SB_URL\\n }),\\n ],\\n },\\n },\\n])\\n```\\n\\nNow, when a test fails in CI, the printed story URL will point to the published Storybook, making debugging that failure a breeze!\", \"2.2 Calculate code coverage\": \"<Callout variant=\\\"info\\\">\\n\\nFor more details on code coverage, check the [full guide](./test-coverage.mdx).\\n\\n</Callout>\\n\\nYou can calculate code coverage of your Storybook tests by passing the `--coverage` flag to the `vitest` command. Coverage is most useful when calculated comprehensively across all tests in your project, but you can also calculate it for just the Storybook tests.\\n\\nYou can either adjust the command in your `package.json` scripts:\\n\\n**For all tests:**\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n+ \\\"test\\\": \\\"vitest --coverage\\\"\\n- \\\"test\\\": \\\"vitest\\\"\\n }\\n}\\n```\\n\\n**For only Storybook tests:**\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n+ \\\"test-storybook\\\": \\\"vitest --project=storybook --coverage\\\"\\n- \\\"test-storybook\\\": \\\"vitest --project=storybook\\\"\\n }\\n}\\n```\\n\\nOr, if you only want to calculate coverage when running tests in CI, adjust your CI configuration like so:\\n\\n**For all tests:**\\n\\n```\\n+ npm run test -- --coverage\\n- npm run test\\n```\\n\\n**For only Storybook tests:**\\n\\n```\\n+ npm run test-storybook -- --coverage\\n- npm run test-storybook\\n```\"}, \"3. Run your workflow\": \"Assuming your CI is configured to run when you push your work to a pull request, you can test your new workflow by creating a new pull request (perhaps to fix an accessibility issue found by Storybook Test).\\n\\nWhen you do so, you should see the test result as a status check on the pull request screen. For example, in GitHub, a failing test run would look something like this:\\n\\n\\n\\nClicking on the failure will take you to the full test output, including the link to the failing story (if you've [set up the `SB_URL` environment variable](#21-debug-test-failures)).\\n\\n\"}, \"FAQs\": {\"How do I run other Vitest tests alongside my Storybook tests?\": \"Some projects have other tests run via Vitest, e.g. unit tests, in addition to those defined in Storybook.\\n\\nYou can run these tests independently by specifying the project filter in a separate script. For example, for a Vitest project called \\u201cunit\\u201d:\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n \\\"test-storybook\\\": \\\"vitest --project=storybook\\\",\\n \\\"test-unit\\\": \\\"vitest --project=unit\\\"\\n }\\n}\\n```\\n\\nThen, in your workflow, call this script alongside the Storybook one:\\n\\n```\\n- name: Run tests\\n run: |\\n npm run test-unit\\n npm run test-storybook\\n```\\n\\nYou may also choose to run all tests together by simply omitting the `--project=storybook` filter from the `package.json` script:\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n \\\"test\\\": \\\"vitest\\\"\\n }\\n}\\n```\\n\\nThe workflow would then look like:\\n\\n```\\n- name: Run tests\\n run: |\\n npm run test\\n```\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Visual testing](./visual-testing.mdx) for appearance', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"Testing in CI\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 6, \"title\": \"In CI\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 1]\"}, {\"title\": \"How to test UIs with Storybook\", \"description\": null, \"content\": {\"Get started\": \"If your project is using Vite, you can likely use the [Vitest addon](./integrations/vitest-addon.mdx) to run your component tests in Storybook. This addon is built on top of [Vitest](https://vitest.dev/), a fast and lightweight test runner that works seamlessly with Vite.\\n\\nRun this command, which will install and configure the Vitest addon and Vitest:\\n\\n<CodeSnippets path=\\\"addon-test-install.md\\\" />\\n\\nThe full installation instructions, including project requirements, are available in the [Vitest addon documentation](./integrations/vitest-addon.mdx#install-and-set-up).\\n\\nOnce your project is set up, you will see a testing widget in the bottom of your sidebar. After running tests, you will also see test status indicators on sidebar items. Additionally, many tests can be debugged with an addon panel.\\n\\n\\n\\nIf you cannot use the Vitest addon in your project, you can still run tests using the [test-runner](./integrations/test-runner.mdx).\\n\\nNext, we\\u2019ll cover some key concepts of testing in Storybook.\", \"Key concepts\": {\"Component tests\": \"A component test is a test which:\\n\\n['Renders a component in the browser for high fidelity', 'Simulates a user interacting with actual UI, like an end-to-end (E2E) test', 'Only tests a unit (e.g. a single component) of UI, **and** can reach into the implementation to mock things or manipulate data, like a unit test']\\n\\nThis combination of using a real browser, simulating behavior, and mocking provides a powerful means of testing the functional aspects of your UI.\\n\\nIn Storybook, the entire testing experience is built around component tests. This means that you can run your tests in the same environment as your stories, with the same tools and techniques.\", \"Storybook Test\": \"Storybook Test enables real time testing of your stories, through the [Vitest addon](./integrations/vitest-addon.mdx). It uses a Vitest plugin to automatically transform your stories into real Vitest tests, which are then run with Vitest\\u2019s browser mode.\", \"Watch mode\": \"Get instant test feedback as you develop with watch mode. It will watch your code\\u2014either the component source or the tests\\u2014for changes and automatically re-run only the relevant tests. It\\u2019s perfect for test-driven development, where you write your tests first and then the component.\\n\\nTo activate watch mode, press the watch mode button (the eye icon) in the testing widget:\\n\\n\", \"CI\": \"If you\\u2019re not running Storybook Test as part of your CI, you\\u2019re missing out on the biggest benefit it provides: catching bugs on PRs before you merge them.\\n\\nIf you are already running `vitest` as part of your CI then your stories should automatically run as tests \\u201cfor free\\u201d when you commit your changes to Git.\\n\\nIf you\\u2019re not yet running Vitest in CI, you should set that up. First by adding a new script to your `package.json`:\\n\\n```\\n{ \\n \\\"scripts\\\": {\\n \\\"test-storybook\\\": \\\"vitest --project=storybook\\\"\\n }\\n} \\n```\\n\\nNote that this assumes you have a Vitest project called \\u201cstorybook\\u201d for your stories, which is the default configuration when you install Storybook Test. If you\\u2019ve renamed it, adjust the script accordingly.\\n\\nNext, add a new CI workflow. \\n\\n<details>\\n<summary>If you use Github Actions that would look like:</summary>\\n\\n```\\nname: Storybook Tests\\n\\non: [push]\\n\\njobs:\\n test:\\n runs-on: ubuntu-latest\\n container:\\n # Make sure to grab the latest version of the Playwright image\\n # https://playwright.dev/docs/docker#pull-the-image\\n image: mcr.microsoft.com/playwright:v1.52.0-noble\\n steps:\\n - uses: actions/checkout@v4\\n \\n - name: Setup Node\\n uses: actions/setup-node@v4\\n with:\\n node-version: 22.12.0\\n \\n - name: Install dependencies\\n run: npm ci\\n \\n - name: Run tests\\n run: npm run test-storybook\\n```\\n\\n</details>\\n\\nIf you are using a different CI provider, please consult our full [CI guide](./in-ci.mdx) for more information.\\n\\nStorybook Test uses Playwright to render your stories by default. For the fastest experience, you should use [a machine image that has Playwright already installed](https://playwright.dev/docs/docker#pull-the-image) (as in the snippet above).\", \"Coverage\": {\"Coverage in CI\": \"And while we\\u2019re looking at coverage, update your CI workflow to include it:\\n\\n```\\n- yarn test\\n+ yarn test --coverage\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nWhy are we running all tests (`yarn test`) instead of just the Storybook tests (`yarn test-storybook`)? Because a coverage report is most accurate when accounting for all tests in your project, not just the stories you've written.\\n\\nSeeing [Storybook-specific coverage](./test-coverage.mdx#storybook-ui) can be helpful, but in CI output, you want to see the comprehensive coverage of your project.\\n\\n</Callout>\\n\\nThis way we can track the coverage change in every PR.\\n\\nThose are the key concepts you\\u2019ll need to test in Storybook. Now, let\\u2019s look at the different types of tests you can perform.\"}}, \"Types of tests\": {\"Render tests\": \"The most important tool for testing your components in Storybook is stories that render your components in various states. \\n\\nHowever, you might not be aware that a basic story is also a [smoke test](https://en.wikipedia.org/wiki/Smoke_testing_(software)), which we call a **render test**. The test passes when the story renders successfully and fails when it errors.\\n\\n\\n\\nDepending on the complexity of your components, you might be able to capture many of your key UI states this way.\", \"[Interaction tests](./interaction-testing.mdx)\": \"Render tests are a very basic kind of interaction test. To test stateful components or verify interactive behavior, you define a play function for your story:\\n\\n<CodeSnippets path=\\\"interaction-test-simple.md\\\" />\\n\\nBut `play` functions can also be used for setting up state, creating spies, mocking out the network, simulating user interactions with your components, asserting output, and more. They are the meat and potatoes of testing and are the foundation for the rest of your testing journey in Storybook. \\n\\nHere\\u2019s a more complex example, which includes [spying and mocking](./interaction-testing.mdx#spying-on-functions-with-fn) via the `fn` utility.\\n\\n<CodeSnippets path=\\\"interaction-test-complex.md\\\" />\\n\\nFor more information on how to write interaction tests and mocks using the `play` function, please see the [interaction testing guide](./interaction-testing.mdx#writing-interaction-tests).\", \"[Accessibility tests](./accessibility-testing.mdx)\": \"Storybook\\u2019s [Accessibility (A11y) addon](https://storybook.js.org/addons/@storybook/addon-a11y) runs a set of automated checks on your stories to help ensure your components can be used by all users, regardless of ability or technology they're using. That means supporting requirements such as: keyboard navigation, screen reader support, usable color contrast, etc.\\n\\nAccessibility is not only the right thing to do, but it is increasingly mandated. For example, the [European accessibility act](https://ec.europa.eu/social/main.jsp?catId=1202) is scheduled to go into law in June 2025. Similarly in the US, laws like the [Americans with Disabilities Act (ADA)](https://www.ada.gov/) and [Section 508 of the Rehabilitation Act](https://www.section508.gov/) apply to many public-facing services.\\n\\nTo activate accessibility checks alongside your component tests, check the Accessibility checkbox in the testing widget.\\n\\n\\n\\nOnce activated, you will see accessibility failures in the sidebar.\\n\\n\\n\\nAny failures can be debugged in the Accessibility addon panel.\\n\\n\", \"[Visual tests](./visual-testing.mdx)\": \"Visual tests are the most efficient way to test your components. With the click of a button you can take snapshots of every story in your Storybook and compare those snapshots to baselines \\u2014 last known \\u201cgood\\u201d snapshots. Not only does this allow you to check the appearance of your components, but they are also able to check a large subset of component functionality [without having to write or maintain any test code](https://storybook.js.org/blog/visual-testing-is-the-greatest-trick-in-ui-development/)!\\n\\nStorybook supports cross-browser visual testing natively using\\u00a0[Chromatic](https://www.chromatic.com/storybook/?ref=storybook_site), a cloud service made by the Storybook team. When you enable visual testing, every story is automatically turned into a test. This gives you instant feedback on UI bugs directly in Storybook.\\n\\n\", \"[Snapshot tests](./snapshot-testing.mdx)\": \"In most cases, the other testing types will provide more coverage with less effort. But there are scenarios where it can be helpful to compare the rendered markup of a story against a known baseline. For example, it can help identify markup changes that trigger rendering errors.\"}, \"Reusing stories in other testing tools\": {\"[End-to-end](./integrations/stories-in-end-to-end-tests.mdx)\": \"Sometimes you need to test a full workflow, with the full running stack. In those cases, you can still use your stories by importing them within your Playwright or Cypress end-to-end (E2E) tests.\", \"[Unit](./integrations/stories-in-unit-tests.mdx)\": \"If you prefer, you can reuse your Storybook stories in a traditional testing environment, like Vitest or Jest.\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Visual testing](./visual-testing.mdx) for appearance', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"How to test UIs with Storybook\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 3, \"title\": \"Testing\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 2]\"}, {\"title\": \"Interaction tests\", \"description\": null, \"content\": {\"Writing interaction tests\": {\"Querying the `canvas`\": {\"Querying within shadow DOM\": \"If your components use the shadow DOM, you can query elements within a shadow root with the help of [`shadow-dom-testing-library`](https://github.com/konnorrogers/shadow-dom-testing-library), which provides versions of the queries above that can pierce the shadow boundary. For example, `findByRole` \\u2192 `findByShadowRole`, `getByText` \\u2192 `getByShadowText`, and so on.\\n\\nWith a bit of configuration, you can use these queries in your play function. Add the following code to your `.storybook/preview.js|ts` file:\\n\\n<CodeSnippets path=\\\"shadow-dom-testing-library-in-preview.md\\\" />\\n\\nNow, those queries are available on the `canvas` object in your `play` function:\\n\\n<CodeSnippets path=\\\"shadow-dom-testing-library-in-story.md\\\" />\\n\\n{/* END only web-components */}\\n</If>\"}, \"Simulating behavior with `userEvent`\": \"After querying for elements, you will likely need to interact with them to test your component\\u2019s behavior. For this we use the `userEvent` utility, which is provided as a parameter of your play function. This utility simulates user interactions with the component, such as clicking buttons, typing in inputs, and selecting options.\\n\\nThere are many methods available on `userEvent`, which are detailed in the [`user-event` documentation](https://testing-library.com/docs/user-event/intro#writing-tests-with-userevent). This table will highlight some of the commonly-used methods.\\n\\n| Method | Description |\\n| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |\\n| `click` | Clicks the element, calling a click() function<br />`await userEvent.click(<element>)` |\\n| `dblClick` | Clicks the element twice<br />`await userEvent.dblClick(<element>)` |\\n| `hover` | Hovers an element<br />`await userEvent.hover(<element>)` |\\n| `unhover` | Unhovers out of element<br />`await userEvent.unhover(<element>)` |\\n| `tab` | Presses the tab key<br />`await userEvent.tab()` |\\n| `type` | Writes text inside inputs or textareas<br />`await userEvent.type(<element>, 'Some text');` |\\n| `keyboard` | Simulates keyboard events<br />`await userEvent.keyboard('{Shift}');` |\\n| `selectOptions` | Selects the specified option(s) of a select element<br />`await userEvent.selectOptions(<element>, ['1','2']);` |\\n| `deselectOptions` | Removes the selection from a specific option of a select element<br />`await userEvent.deselectOptions(<element>, '1');` |\\n| `clear` | Selects the text inside inputs or textareas and deletes it<br />`await userEvent.clear(<element>);` |\\n\\n<Callout variant=\\\"warning\\\">\\n\\n`userEvent` methods should *always* be `await`ed inside of the play function. This ensures they can be properly logged and debugged in the Interactions panel.\\n\\n</Callout>\", \"Asserting with `expect`\": \"Finally, after querying for elements and simulating behavior, you can make assertions on the result which are validated when running the test. For this we use the `expect` utility, which is available via the `storybook/test` module:\\n\\n```\\nimport { expect } from 'storybook/test';\\n```\\n\\nThe `expect` utility here combines the methods available in [Vitest\\u2019s `expect`](https://vitest.dev/api/expect.html) as well as those from [`@testing-library/jest-dom`](https://github.com/testing-library/jest-dom#custom-matchers) (which, despite the name, also work in Vitest tests). There are many, many methods available. This table will highlight some of the commonly-used methods.\\n\\n| Method | Description |\\n| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\\n| [`toBeInTheDocument()`](https://github.com/testing-library/jest-dom#tobeinthedocument) | Checks if the element is in the DOM<br />`await expect(<element>).toBeInTheDocument()` |\\n| [`toBeVisible()`](https://github.com/testing-library/jest-dom#tobevisible) | Checks if the element is visible to the user<br />`await expect(<element>).toBeVisible()` |\\n| [`toBeDisabled()`](https://github.com/testing-library/jest-dom#tobedisabled) | Checks if an element is disabled<br />`await expect(<element>).toBeDisabled()` |\\n| [`toHaveBeenCalled()`](https://vitest.dev/api/expect.html#tohavebeencalled) | Checks that a spied function was called<br />`await expect(<function-spy>).toHaveBeenCalled()` |\\n| [`toHaveBeenCalledWith()`](https://vitest.dev/api/expect.html#tohavebeencalledwith) | Checks that a spied function was called with specific parameters<br />`await expect(<function-spy>).toHaveBeenCalledWith('example')` |\\n\\n<Callout variant=\\\"warning\\\">\\n\\n`expect` calls should *always* be `await`ed inside of the play function. This ensures they can be properly logged and debugged in the Interactions panel.\\n\\n</Callout>\", \"Spying on functions with `fn`\": \"When your component calls a function, you can spy on that function to make assertions on its behavior using the `fn` utility from Vitest, available via the `storybook/test` module:\\n\\n```\\nimport { fn } from 'storybook/test'\\n```\\n\\nMost of the time, you will use `fn` as an `arg` value when writing your story, then access that `arg` in your test:\\n\\n<CodeSnippets path=\\\"interaction-test-fn-mock-spy.md\\\" />\", \"Run code before the component gets rendered\": {\"Create mock data before rendering\": \"You can also use `mount` to create mock data that you want to pass to the component. To do so, first create your data in the play function and then call the `mount` function with a component configured with that data. In this example, we create a mock `note` and pass its `id` to the Page component, which we call `mount` with.\\n\\n<CodeSnippets path=\\\"mount-advanced.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nWhen you call `mount()` with no arguments, the component is rendered using the story\\u2019s render function, whether the [implicit default](../api/csf/index.mdx#default-render-functions) or the [explicit custom definition](../api/csf/index.mdx#custom-render-functions).\\n\\nWhen you mount a specific component inside the `mount` function like in the example above, the story\\u2019s render function will be ignored. This is why you must forward the `args` to the component.\\n\\n</Callout>\\n\\n</If>\\n{/* END React, Vue, Svelte-only */}\\n\\n</If>\\n{/* END non-Angular-only */}\\n\\n<If renderer=\\\"angular\\\">\\n\\nYou can execute code before the component is rendered by defining an asynchronous [`beforeEach` function](#beforeeach) for the story.\\n\\n</If>\"}, \"Run code before each story in a file\": \"Sometimes you might need to run the same code before each story in a file. For instance, you might need to set up the initial state of the component or modules. You can do this by adding an asynchronous `beforeEach` function to the component meta.\\n\\nYou can return a cleanup function from the `beforeEach` function, which will run **after** each story, when the story is remounted or navigated away from.\\n\\n<Callout variant=\\\"info\\\">\\n\\nGenerally, you should reset component and module state in the [preview file's `beforeAll` or `beforeEach` functions](#set-up-or-reset-state-for-all-tests), to ensure it applies to your entire project. However, if a component's needs are particularly unique, you can use the returned cleanup function in the component meta `beforeEach` to reset the state as needed.\\n\\n</Callout>\\n\\n<CodeSnippets path=\\\"before-each-in-meta-mock-date.md\\\" />\", \"Set up or reset state for all tests\": {\"`beforeAll`\": \"The `beforeAll` function in the preview file (`.storybook/preview.js|ts`) will run once before any stories in the project and will _not_ re-run between stories. Beyond its initial run when kicking off a test run, it will not run again unless the preview file is updated. This is a good place to bootstrap your project or run any setup that your entire project depends on, as in the example below.\\n\\nYou can return a cleanup function from the `beforeAll` function, which will run before re-running the `beforeAll` function or during the teardown process in the test runner.\\n\\n<CodeSnippets path=\\\"before-all-in-preview.md\\\" />\", \"`beforeEach`\": \"Unlike `beforeAll`, which runs only once, the `beforeEach` function in the preview file (`.storybook/preview.js|ts`) will run before each story in the project. This is best used for resetting state or modules that are used by all or most of your stories. In the example below, we use it to reset the mocked Date.\\n\\nYou can return a cleanup function from the `beforeEach` function, which will run **after** each story, when the story is remounted or navigated away from.\\n\\n<CodeSnippets path=\\\"before-each-in-preview.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nIt is _not_ necessary to restore `fn()` mocks, as Storybook will already do that automatically before rendering a story. See the [`parameters.test.restoreMocks` API](../api/parameters.mdx#restoremocks) for more information.\\n\\n</Callout>\"}, \"Make assertions after interactions\": {\"`afterEach`\": \"`afterEach` runs after the story is rendered and the play function has completed. It can be used at the project level in the preview file (`.storybook/preview.js|ts`), at the component level in the component meta, or at the story level in the story definition. This is useful for making assertions after the component has been rendered and interacted with, such as running checks on the final rendered output or logging information.\\n\\nLike the `play` function, `afterEach` receives the `context` object, which contains the `args`, `canvas`, and other properties related to the story. You can use this to make assertions or run code after the story has been rendered.\\n\\n<CodeSnippets path=\\\"after-each-in-meta.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nYou should not use `afterEach` to reset state in your tests. Because it runs after the story, resetting state here could prevent you from seeing the correct end state of your story. Instead, use the [`beforeEach`'s returned cleanup function](#beforeeach) to reset state, which will run only when navigating between stories to preserve the end state.\\n\\n</Callout>\"}, \"Group interactions with the step function\": \"For complex flows, it can be worthwhile to group sets of related interactions together using the step function. This allows you to provide a custom label that describes a set of interactions:\\n\\n<CodeSnippets path=\\\"storybook-interactions-step-function.md\\\" />\\n\\nThis will show your interactions nested in a collapsible group:\\n\\n\", \"Mocked modules\": \"If your component depends on modules that are imported into the component file, you can mock those modules to control and assert on their behavior. This is detailed in the [mocking modules guide](../writing-stories/mocking-data-and-modules/mocking-modules.mdx).\\nYou can then import the mocked module (which has all of the helpful methods of a [Vitest mocked function](https://vitest.dev/api/mock.html)) into your story and use it to assert on the behavior of your component:\\n\\n<CodeSnippets path=\\\"storybook-test-fn-mock-spy.md\\\" />\"}, \"Running interaction tests\": \"If you're using the [Vitest addon](./integrations/vitest-addon.mdx), you can run your interaction tests in these ways:\\n\\n['[In the Storybook UI](./integrations/vitest-addon.mdx#storybook-ui)', '[In your editor](./integrations/vitest-addon.mdx#editor-extension)', '[Via the CLI](./integrations/vitest-addon.mdx#cli)', '[In CI environments](./integrations/vitest-addon.mdx#in-ci)']\\n\\nIn the Storybook UI, you can run interaction tests by clicking the **Run component tests** button in the expanded testing widget in the sidebar or by opening the context menu (three dots) on a story or folder and selecting **Run component tests**.\\n\\n\\n\\nIf you're using the [test-runner](./integrations/test-runner.mdx), you can run your interaction tests in the terminal or in CI environments.\", \"Debugging interaction tests\": {\"Permalinks for reproductions\": \"Because Storybook is a webapp, anyone with the URL can reproduce the failure with the same detailed information without any additional environment configuration or tooling required.\\n\\n\\n\\nStreamline interaction testing further by automatically [publishing Storybook](../sharing/publish-storybook.mdx) in pull requests. That gives teams a universal reference point to test and debug stories.\"}, \"Automate with CI\": \"When you run your tests with the Vitest addon, automating those tests is as simple as running your tests in your CI environment. Please see the [testing in CI guide](./in-ci.mdx) for more information.\\n\\nIf you cannot use the Vitest addon, you can still run your tests in CI using the [test-runner](./integrations/test-runner.mdx).\", \"Troubleshooting\": \"What\\u2019s the difference between interaction tests and visual tests?\\n\\nInteraction tests can be expensive to maintain when applied wholesale to every component. We recommend combining them with other methods like visual testing for comprehensive coverage with less maintenance work.\\n\\nWhat's the difference between interaction tests and using Vitest + Testing Library alone?\\n\\nInteraction tests integrate Vitest and Testing Library into Storybook. The biggest benefit is the ability to view the component you're testing in a real browser. That helps you debug visually, instead of getting a dump of the (fake) DOM in the command line or hitting the limitations of how JSDOM mocks browser functionality. It's also more convenient to keep stories and tests together in one file than having them spread across files.\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Visual testing](./visual-testing.mdx) for appearance', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}, \"metadata\": {\"title\": \"Interaction tests\", \"sidebar\": {\"order\": 2, \"title\": \"Interaction tests\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 3]\"}, {\"title\": \"Snapshot tests\", \"description\": null, \"content\": {\"Snapshot tests\": \"Snapshot testing is simply rendering a component in a given state, taking a snapshot of the rendered DOM or HTML, and then comparing it against the previous snapshot. They\\u2019re convenient to create, but can be difficult and noisy to maintain if the snapshot contains too much information. For UI components, [visual tests](./visual-testing.mdx) (easier to review) or [interaction tests](./interaction-testing.mdx) (focused on functionality) are usually the better fit. However, there are some cases where snapshot testing may be necessary, such as ensuring an error is thrown correctly.\\n\\nYou can reuse your stories as the basis of snapshot tests within another test environment, like Jest or Vitest. To enable this, Storybook provides the Portable Stories API, which composes your stories with their annotations ([args](../writing-stories/args.mdx), [decorators](../writing-stories/decorators.mdx), [parameters](../writing-stories/parameters.mdx), etc) and produces a renderable element for your tests. Portable Stories are available for:\\n\\n['[Vitest](../api/portable-stories/portable-stories-vitest.mdx)', '[Jest](../api/portable-stories/portable-stories-jest.mdx)', '[Playwright CT](../api/portable-stories/portable-stories-playwright.mdx)']\\n\\n<Callout variant=\\\"info\\\">\\n\\nLooking for snapshot testing with Storyshots? Storyshots is deprecated and no longer maintained. We recommend using the Portable Stories API instead.\\n\\nPlease reference the [Storyshots documentation](../../../release-8-6/docs/writing-tests/snapshot-testing/storyshots-migration-guide.mdx) for more information on how to migrate your tests.\\n\\n</Callout>\", \"Get started with Portable Stories\": \"If you\\u2019re using Storybook Test, your project is already configured to use Portable Stories in Vitest.\\n\\nIf you\\u2019re not using Storybook Test or would like to test in another testing environment, please follow the relevant documentation:\\n\\n['[Vitest](../api/portable-stories/portable-stories-vitest.mdx#1-apply-project-level-annotations)', '[Jest](../api/portable-stories/portable-stories-jest.mdx#1-apply-project-level-annotations)', '[Playwright CT](../api/portable-stories/portable-stories-playwright.mdx#1-apply-project-level-annotations)']\", \"Snapshot testing a portable story\": {\"Verifying an error is thrown\": \"Now that we know how to do general snapshot testing, let\\u2019s apply it to a common use case: verifying that an expected error is thrown correctly.\\n\\nIn this example, we have a simple Button React component which for some reason accepts a prop, `doNotUseThisItWillThrowAnError`, which will (unsurprisingly) throw an error if it is used.\\n\\n```\\nfunction Button(props) {\\n if (props.doNotUseThisItWillThrowAnError) {\\n throw new Error(\\\"I tried to tell you...\\\")\\n }\\n\\n return <button {...props} />\\n}\\n```\\n\\nWe then have a story which applies that prop via `args`. It also removes the default `dev` and `test` tags to prevent the story from displaying in the Storybook sidebar and from being tested as a story (by Storybook Test), respectively.\\n\\n```\\nexport const ThrowError = {\\n tags: ['!dev', '!test'],\\n args: {\\n doNotUseThisItWillThrowAnError: true,\\n },\\n}\\n```\\n\\nFinally, we write a test in the test file which asserts that an error is thrown with a particular message.\\n\\n```\\n// @vitest-environment jsdom\\n\\nimport { expect, test } from \\\"vitest\\\";\\n\\nimport { composeStories } from \\\"@storybook/react\\\";\\n\\nimport * as stories from \\\"./Button.stories\\\";\\n\\nconst { ThrowError } = composeStories(stories);\\n\\ntest(\\\"Button throws error\\\", async () => {\\n await expect(ThrowError.run()).rejects.toThrowError('I tried to tell you...');\\n});\\n```\\n\\nThis example is simplified for educational purposes. The same technique could be applied to more complex scenarios, such as a form with invalid input or a simulated network failure.\"}, \"Snapshot testing with the test-runner\": \"If you cannot use portable stories in your project, you can still run snapshot tests using the test-runner. Follow the instructions in the [test-runner documentation](./integrations/test-runner.mdx#run-snapshot-tests) to set up the test-runner with snapshot tests in your project.\", \"FAQ\": {\"What\\u2019s the difference between snapshot tests and visual tests?\": \"Visual tests capture images of stories and compare them against image baselines. Snapshot tests take DOM or HTML snapshots and compare them against DOM or HTML baselines. Visual tests are better suited for verifying appearance. Snapshot tests are useful for validating non-visual output and ensuring the DOM doesn\\u2019t change.\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Visual testing](./visual-testing.mdx) for appearance', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"Snapshot tests\", \"sidebar\": {\"order\": 5, \"title\": \"Snapshot tests\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 4]\"}, {\"title\": \"Test coverage\", \"description\": null, \"content\": {\"Set up\": \"Coverage is included in the [Vitest addon](./integrations/vitest-addon.mdx) and, when enabled, will be calculated when running component tests for your project. To enable coverage, check the coverage checkbox in the testing widget.\\n\\n\\n\\nBefore coverage can be calculated, you may need to install a support package corresponding to your [coverage provider](#coverage-provider):\\n\\n<CodeSnippets path=\\\"vitest-plugin-install-coverage-support-packages.md\\\" />\", \"Usage\": {\"Storybook UI\": \"When you enable coverage in the Storybook UI, the coverage report will be generated and summarized in the testing widget after you run your tests. You can see the percentage of statements covered by your tested stories, as well as whether the coverage meets the [watermarks](#watermarks).\\n\\nAdditionally, the full coverage report will be served at the `/coverage/index.html` route of your running Storybook.\\n\\n\\n\\nThe report is interactive. You can click through to a component to view its source and see which parts of your code are covered by tests or not:\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\u26a0\\ufe0f\\\">\\n\\nIt's important to understand that the coverage reported in the Storybook UI has three important limitations:\\n\\n[\\\"Coverage is calculated using the stories you've written, not the entire codebase. In other words, it will not include any other Vitest tests.\\\", 'Coverage can only be calculated for all stories in your project, not for an individual story or a group of stories.', 'Coverage is not calculated while watch mode is activated. When coverage is enabled, enabling watch mode will disable coverage.']\\n\\n</Callout>\", \"CLI\": \"Like the rest of Storybook Test, coverage is built on top of Vitest. Which means you can generate a coverage report using the [Vitest CLI](https://vitest.dev/guide/cli.html).\\n\\nAssuming you run your tests with a package script like this:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"test-storybook\\\": \\\"vitest --project=storybook\\\"\\n }\\n}\\n```\\n\\nThen you can generate a coverage report with:\\n\\n<CodeSnippets path=\\\"vitest-plugin-run-with-coverage.md\\\" />\\n\\n\\n\\nThe coverage report will be saved to the [configured coverage reports directory](https://vitest.dev/config/#coverage-reportsdirectory) (`./coverage`, by default) in your project.\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe above command will only calculate coverage for the stories you've written, not the entire codebase.\\n\\nBecause coverage is most accurate when accounting for all tests in your project, you can also run coverage for all tests in your project with:\\n\\n```\\nnpx vitest --coverage\\n```\\n\\n</Callout>\", \"Editor extension\": \"Coverage is also available through Vitest's [IDE integrations](https://vitest.dev/guide/ide.html). You can calculate and display coverage results directly in your editor.\\n\\n\\n\\n<Callout variant=\\\"info\\\">\\n\\nNote that this coverage will include *all* tests in your project, not just the stories you've written.\\n\\n</Callout>\", \"CI\": \"To generate coverage reports in your CI pipeline, you can use the [CLI](#cli).\\n\\nFor example, here's a simplified GitHub Actions workflow that runs your tests and generates a coverage report:\\n\\n```\\nname: Storybook Tests\\non: push\\njobs:\\n test:\\n steps:\\n - uses: actions/checkout@v4\\n - uses: actions/setup-node@v4\\n with:\\n node-version: '20.x'\\n - name: Install dependencies\\n run: yarn\\n # \\ud83d\\udc47 This will run all Vitest tests, including Storybook tests\\n - name: Run tests\\n run: yarn test --coverage\\n```\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\n\\nWhy are we running all tests (`yarn test`) instead of just the Storybook tests (`yarn test-storybook`)? Because a coverage report is most accurate when accounting for all tests in your project, not just the stories you've written.\\n\\nSeeing [Storybook-specific coverage](#storybook-ui) can be helpful, but in CI output, you want to see the comprehensive coverage of your project.\\n\\n</Callout>\\n\\nFor more on testing in CI, see the [dedicated guide](./in-ci.mdx).\"}, \"Configuration\": {\"Coverage provider\": \"You can choose which provider, [v8](https://v8.dev/blog/javascript-code-coverage) (default) or [Istanbul](https://istanbul.js.org/), to use for coverage calculation by setting the `coverage.provider` option in your Vitest config:\\n\\n```\\nimport { defineConfig } from 'vitest/config';\\n\\nexport default defineConfig({\\n // ...\\n test: {\\n // ...\\n coverage: {\\n // ...\\n provider: 'istanbul', // 'v8' is the default\\n },\\n },\\n});\\n```\", \"Watermarks\": \"Both coverage providers support [watermarks](https://vitest.dev/config/#coverage-watermarks), which are threshold values for coverage. The low watermark is the minimum coverage required to pass the test, and the high watermark is the minimum coverage required to be considered good. A coverage percentage between the low and high watermarks will be considered acceptable but not ideal.\\n\\nIn the testing widget, the coverage summary will show the percentage of statements covered by your tested stories, as well as whether the coverage meets the watermarks. Below the low watermark, the icon will be red, between the low and high watermarks, it will be orange, and above the high watermark, it will be green.\\n\\n\\n\\nTo configure the watermarks, you can adjust the Vitest config:\\n\\n```\\nimport { defineConfig } from 'vitest/config';\\n \\nexport default defineConfig({\\n // ...\\n test: {\\n // ...\\n coverage: {\\n // ...\\n watermarks: {\\n // These are the default values\\n statements: [50, 80],\\n },\\n },\\n },\\n});\\n```\", \"Additional configuration\": \"You can find more configuration options for coverage in the [Vitest documentation](https://vitest.dev/config/#coverage).\\n\\nWhen calculating coverage in the Storybook UI, the following options are always ignored:\\n\\n['`enabled`', '`clean`', '`cleanOnRerun`', '`reportOnFailure`', '`reporter`', '`reportsDirectory`']\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Visual testing](./visual-testing.mdx) for appearance', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"Test coverage\", \"sidebar\": {\"order\": 5, \"title\": \"Test coverage\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 5]\"}, {\"title\": \"Visual tests\", \"description\": null, \"content\": {\"Install the addon\": \"Add visual tests to your project by installing `@chromatic-com/storybook`, the official addon by Storybook maintainers:\\n\\n<CodeSnippets path=\\\"chromatic-storybook-add.md\\\" />\", \"Enable visual tests\": \"When you start Storybook, you'll see a new addon panel for Visual Tests where you can run tests and view results.\\n\\n\\n\\n<Callout variant=\\\"info\\\">\\n\\nAlready using the [Vitest addon](./integrations/vitest-addon.mdx)? In the expanded testing widget, you\\u2019ll now see a Visual tests section:\\n\\n\\n\\nClicking the Run tests button at the bottom will run *all* tests, both component and visual.\\n\\n</Callout>\\n\\nFirst, sign in to your Chromatic account. If you do not have an account, you can create one as part of the sign in process.\\n\\nOnce signed in, you will see your Chromatic account(s) and their projects. Either select one from the list or create a new one.\\n\\n\\n\\nNow that you have linked your project to the addon, you can press the \\u201cCatch a UI change\\u201d button to run your first build of visual tests.\\n\\n\\n\\nThat first build will create the baseline snapshots for your stories, which will be compared against when you run visual tests again.\", \"Run visual tests\": \"After you have made a code change, there are two ways to run visual tests in Storybook.\\n\\nIn the expanded testing widget in the sidebar, press the run button in the Visual tests section.\\n\\n\\n\\nOr, in the Visual tests addon panel, press the run button in the top right corner of the panel.\\n\\n\\n\\nEither method will send your stories to the cloud to take snapshots and detect visual changes.\", \"Review changes\": \"If there are visual changes in your stories, they will be \\ud83d\\udfe1 highlighted in the sidebar. Click the story and go to the Visual Tests addon panel to see which pixels changed.\\n\\nIf the changes are intentional, \\u2705 accept them as baselines locally. If the changes aren't intentional, fix the story and rerun the tests using the rerun button.\\n\\n\\n\\nWhen you finish accepting changes as baselines in the addon, you're ready to push the code to your remote repository. This will sync baselines to the cloud for anyone who checks out your branch.\\n\\n\", \"Automate with CI\": \"The addon is designed to be used in tandem with CI. We recommend using the addon to check for changes during development and then running visual tests in CI as you get ready to merge.\\n\\nChanges you accept as baselines in the addon will get auto-accepted as baselines in CI so you don\\u2019t have to review twice.\\n\\n['Add a step to your CI workflow to run Chromatic.', ['[GitHub Actions](https://chromatic.com/docs/github-actions?ref=storybook_docs)', '[GitLab Pipelines](https://chromatic.com/docs/gitlab?ref=storybook_docs)', '[Bitbucket Pipelines](https://chromatic.com/docs/bitbucket-pipelines?ref=storybook_docs)', '[CircleCI](https://chromatic.com/docs/circleci?ref=storybook_docs)', '[Travis CI](https://chromatic.com/docs/travisci?ref=storybook_docs)', '[Jenkins](https://chromatic.com/docs/jenkins?ref=storybook_docs)', '[Azure Pipelines](https://chromatic.com/docs/azure-pipelines?ref=storybook_docs)', '[Custom CI provider](https://chromatic.com/docs/custom-ci-provider?ref=storybook_docs)'], 'Configure your CI to include environment variables to authenticate with Chromatic (project token).']\", \"PR checks\": \"Once you successfully set up Chromatic in CI, your pull/merge requests will be badged with a UI Tests check. The badge notifies you of test errors or UI changes that need to be verified by your team. Make the check required in your Git provider to prevent accidental UI bugs from being merged.\\n\\n\", \"Configure\": \"The addon includes configuration options covering most use cases by default. You can also fine-tune the addon configuration to match your project's requirements via the [`./chromatic.config.json`](https://www.chromatic.com/docs/visual-tests-addon/#configure) file. Below is a shortlist of addon-specific options and examples of how to use them. View the full list of [options](https://www.chromatic.com/docs/configure/#options).\\n\\n| Option | Description |\\n| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- |\\n| `projectId` | Automatically configured. Sets the value for the project identifier<br />`\\\"projectId\\\": \\\"Project:64cbcde96f99841e8b007d75\\\"` |\\n| `buildScriptName` | Optional. Defines the custom Storybook build script<br />`\\\"buildScriptName\\\": \\\"deploy-storybook\\\"` |\\n| `debug` | Optional. Output verbose debugging information to the console.<br />`\\\"debug\\\": true` |\\n| `zip` | Optional. Recommended for large projects. Configures the addon to deploy your Storybook to Chromatic as a zip file.<br />`\\\"zip\\\": true` |\\n\\n```\\n{\\n \\\"buildScriptName\\\": \\\"deploy-storybook\\\",\\n \\\"debug\\\": true,\\n \\\"projectId\\\": \\\"Project:64cbcde96f99841e8b007d75\\\",\\n \\\"zip\\\": true\\n}\\n```\", \"FAQs\": {\"What\\u2019s the difference between visual tests and snapshot tests?\": \"[Snapshot tests](./snapshot-testing.mdx) compare the rendered markup of every story against known baselines. This means the test compares blobs of HTML and not what the user actually sees. Which in turn, can lead to an increase in false positives as code changes don\\u2019t always yield visual changes in the component.\\n\\nVisual tests compare the rendered pixels of every story against known baselines. Because you're testing the same thing your users actually experience, your tests will be richer and easier to maintain.\\n\\n**More testing resources**\\n\\n['[Vitest addon](./integrations/vitest-addon.mdx) for running tests in Storybook', '[Interaction testing](./interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](./accessibility-testing.mdx) for accessibility', '[Snapshot testing](./snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](./test-coverage.mdx) for measuring code coverage', '[CI](./in-ci.mdx) for running tests in your CI/CD pipeline', '[End-to-end testing](./integrations/stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./integrations/stories-in-unit-tests.mdx) for functionality', '[Test runner](./integrations/test-runner.mdx) to automate test execution']\"}}, \"metadata\": {\"title\": \"Visual tests\", \"hideRendererSelector\": true, \"sidebar\": {\"order\": 4, \"title\": \"Visual tests\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 6]\"}, {\"title\": \"Integrations\", \"description\": \"Documentation section: integrations\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/storybook/original/docs/writing-tests/integrations\"}, \"subpages\": [{\"title\": \"Integrations\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Integrations\", \"sidebar\": {\"order\": 7, \"title\": \"Integrations\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"Stories in end-to-end tests\", \"description\": null, \"content\": {\"With Cypress\": \"[Cypress](https://www.cypress.io/) is an end-to-end testing framework. It enables you to test a complete instance of your application by simulating user behavior. With Component Story Format, your stories are reusable with Cypress. Each named export (in other words, a story) is renderable within your testing setup.\\n\\nAn example of an end-to-end test with Cypress and Storybook is testing a login component for the correct inputs. For example, if you had the following story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"login-form-with-play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe play function contains small snippets of code that run after the story renders. It allows you to sequence interactions in stories.\\n</Callout>\\n\\nWith Cypress, you could write the following test:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-cypress-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen Cypress runs your test, it loads Storybook's isolated iframe and checks if the inputs match the test values.\", \"With Playwright\": \"[Playwright](https://playwright.dev/) is a browser automation tool and end-to-end testing framework from Microsoft. It offers cross-browser automation, mobile testing with device emulation, and headless testing. With Component Story Format, your stories are reusable with Playwright. Each named export (in other words, a story) is renderable within your testing setup.\\n\\nA real-life scenario of user flow testing with Playwright would be how to test a login form for validity. For example, if you had the following story already created:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"login-form-with-play-function.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe play function contains small snippets of code that run after the story renders. It allows you to sequence interactions in stories.\\n</Callout>\\n\\nWith Playwright, you can write a test to check if the inputs are filled and match the story:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"component-playwright-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nOnce you execute Playwright, it opens a new browser window, loads Storybook's isolated iframe, asserts if the inputs contain the specified values, and displays the test results in the terminal.\\n\\n**More testing resources**\\n\\n['[Interaction testing](../interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](../accessibility-testing.mdx) for accessibility', '[Visual testing](../visual-testing.mdx) for appearance', '[Snapshot testing](../snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](../test-coverage.mdx) for measuring code coverage', '[CI](../in-ci.mdx) for running tests in your CI/CD pipeline', '[Vitest addon](./vitest-addon.mdx) for running tests in Storybook', '[Test runner](./test-runner.mdx) to automate test execution', '[Unit testing](./stories-in-unit-tests.mdx) for functionality']\"}, \"metadata\": {\"title\": \"Stories in end-to-end tests\", \"sidebar\": {\"title\": \"End-to-end tests\", \"order\": 4}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"Stories in unit tests\", \"description\": null, \"content\": {\"Write a test with Testing Library\": {\"Override story properties\": \"By default, the `setProjectAnnotations` function injects into your existing tests any global configuration you've defined in your Storybook instance (i.e., parameters, decorators in the `preview.js|ts` file). Nevertheless, this may cause unforeseen side effects for tests that are not intended to use these global configurations. For example, you may want to always test a story in a particular locale (via `globalTypes`) or configure a story to apply specific `decorators` or `parameters`.\\n\\nTo avoid this, you can override the global configurations by extending either the `composeStory` or `composeStories` functions to provide test-specific configurations. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"override-compose-story-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Run tests on a single story\": \"You can use the [`composeStory`](../../api/portable-stories/portable-stories-vitest.mdx#composestory) function to allow your tests to run on a single story. However, if you're relying on this method, we recommend that you supply the story metadata (i.e., the [default export](../../writing-stories/index.mdx#default-export)) to the `composeStory` function. This ensures that your tests can accurately determine the correct information about the story. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"single-story-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Combine stories into a single test\": \"If you intend to test multiple stories in a single test, use the [`composeStories`](../../api/portable-stories/portable-stories-vitest.mdx#composestories) function. It will process every component story you've specified, including any [`args`](../../writing-stories/args.mdx) or [`decorators`](../../writing-stories/decorators.mdx) you've defined. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"multiple-stories-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Troubleshooting\": {\"Run tests in other frameworks\": \"Storybook provides community-led addons for other frameworks like [Vue 2](https://storybook.js.org/addons/@storybook/testing-vue) and [Angular](https://storybook.js.org/addons/@storybook/testing-angular). However, these addons still lack support for the latest stable Storybook release. If you're interested in helping out, we recommend reaching out to the maintainers using the default communication channels (GitHub and [Discord server](https://discord.com/channels/486522875931656193/839297503446695956)).\\n\\n<IfRenderer renderer=\\\"react\\\">\", \"The args are not being passed to the test\": \"When using the `composeStories` or `composeStory` functions, the components being rendered will have a combination of properties from the story, meta, and global configuration. Therefore, if you need to access the args or parameters, you can do so as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"reuse-args-test.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n</IfRenderer>\\n\\n**More testing resources**\\n\\n['[Interaction testing](../interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](../accessibility-testing.mdx) for accessibility', '[Visual testing](../visual-testing.mdx) for appearance', '[Snapshot testing](../snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](../test-coverage.mdx) for measuring code coverage', '[CI](../in-ci.mdx) for running tests in your CI/CD pipeline', '[Vitest addon](./vitest-addon.mdx) for running tests in Storybook', '[Test runner](./test-runner.mdx) to automate test execution', '[End-to-end testing](./stories-in-end-to-end-tests.mdx) for simulating real user scenarios']\"}}, \"metadata\": {\"title\": \"Stories in unit tests\", \"sidebar\": {\"title\": \"Unit tests\", \"order\": 3}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"Test runner\", \"description\": null, \"content\": {\"Setup\": \"The test-runner is a standalone, framework-agnostic utility that runs parallel to your Storybook. You will need to take some additional steps to set it up properly. Detailed below is our recommendation to configure and execute it.\\n\\nRun the following command to install it.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-install.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate your `package.json` scripts and enable the test runner.\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"test-storybook\\\": \\\"test-storybook\\\"\\n }\\n}\\n```\\n\\nStart your Storybook with:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-run-dev.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nStorybook's test runner requires either a locally running Storybook instance or a published Storybook to run all the existing tests.\\n</Callout>\\n\\nFinally, open a new terminal window and run the test-runner with:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-execute.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Configure\": {\"CLI Options\": \"The test-runner is powered by [Jest](https://jestjs.io/) and accepts a subset of its [CLI options](https://jestjs.io/docs/cli) (for example, `--watch`, `--maxWorkers`).\\nIf you're already using any of those flags in your project, you should be able to migrate them into Storybook's test-runner without any issues. Listed below are all the available flags and examples of using them.\\n\\n| Options | Description |\\n| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `--help` | Output usage information <br />`test-storybook --help` |\\n| `-s`, `--index-json` | Run in index json mode. Automatically detected (requires a compatible Storybook) <br />`test-storybook --index-json` |\\n| `--no-index-json` | Disables index json mode <br />`test-storybook --no-index-json` |\\n| `-c`, `--config-dir [dir-name]` | Directory where to load Storybook configurations from <br />`test-storybook -c .storybook` |\\n| `--watch` | Run in watch mode <br />`test-storybook --watch` |\\n| `--watchAll` | Watch files for changes and rerun all tests when something changes.<br />`test-storybook --watchAll` |\\n| `--coverage` | Runs [coverage tests](#generate-code-coverage) on your stories and components <br /> `test-storybook --coverage` |\\n| `--coverageDirectory` | Directory where to write coverage report output <br />`test-storybook --coverage --coverageDirectory coverage/ui/storybook` |\\n| `--url` | Define the URL to run tests in. Useful for custom Storybook URLs <br />`test-storybook --url http://the-storybook-url-here.com` |\\n| `--browsers` | Define browsers to run tests in. One or multiple of: chromium, firefox, webkit <br />`test-storybook --browsers firefox chromium` |\\n| `--maxWorkers [amount]` | Specifies the maximum number of workers the worker-pool will spawn for running tests <br />`test-storybook --maxWorkers=2` |\\n| `--testTimeout [amount]` | Defines the maximum time in milliseconds that a test can run before it is automatically marked as failed. Useful for long-running tests <br /> `test-storybook --testTimeout=60000` |\\n| `--no-cache` | Disable the cache <br />`test-storybook --no-cache` |\\n| `--clearCache` | Deletes the Jest cache directory and then exits without running tests <br />`test-storybook --clearCache` |\\n| `--verbose` | Display individual test results with the test suite hierarchy <br />`test-storybook --verbose` |\\n| `-u`, `--updateSnapshot` | Use this flag to re-record every snapshot that fails during this test run <br />`test-storybook -u` |\\n| `--eject` | Creates a local configuration file to override defaults of the test-runner <br />`test-storybook --eject` |\\n| `--json` | Prints the test results in JSON. This mode will send all other test output and user messages to stderr. <br />`test-storybook --json` |\\n| `--outputFile` | Write test results to a file when the --json option is also specified. <br />`test-storybook --json --outputFile results.json` |\\n| `--junit` | Indicates that test information should be reported in a junit file. <br />`test-storybook --**junit**` |\\n| `--ci` | Instead of the regular behavior of storing a new snapshot automatically, it will fail the test and require Jest to be run with `--updateSnapshot`. <br />`test-storybook --ci` |\\n| `--shard [index/count]` | Requires CI. Splits the test suite execution into multiple machines <br /> `test-storybook --shard=1/8` |\\n| `--failOnConsole` | Makes tests fail on browser console errors<br />`test-storybook --failOnConsole` |\\n| `--includeTags` | Experimental feature <br />Defines a subset of stories to be tested if they match the enabled [tags](#experimental-filter-tests). <br />`test-storybook --includeTags=\\\"test-only, pages\\\"` |\\n| `--excludeTags` | Experimental feature <br />Prevents stories from being tested if they match the provided [tags](#experimental-filter-tests). <br />`test-storybook --excludeTags=\\\"no-tests, tokens\\\"` |\\n| `--skipTags` | Experimental feature <br />Configures the test runner to skip running tests for stories that match the provided [tags](#experimental-filter-tests). <br />`test-storybook --skipTags=\\\"skip-test, layout\\\"` |\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-execute-with-flags.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Run tests against a deployed Storybook\": \"By default, the test-runner assumes that you're running it against a locally served Storybook on port `6006`. If you want to define a target URL to run against deployed Storybooks, you can use the `--url` flag:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-execute-with-url.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nAlternatively, you can set the `TARGET_URL` environment variable and run the test-runner:\\n\\n```\\nTARGET_URL=https://the-storybook-url-here.com yarn test-storybook\\n```\"}, \"Run accessibility tests\": \"When you have the [Accessibility addon](https://storybook.js.org/addons/@storybook/addon-a11y) installed, you can run accessibility tests alongside your interaction tests, using the test-runner.\\n\\nFor more details, including configuration options, see the [Accessibility testing documentation](../accessibility-testing.mdx).\", \"Run snapshot tests\": {\"Set up\": \"To enable snapshot testing with the test-runner, you'll need to take additional steps to set it up properly.\\n\\nAdd a new [configuration file](#test-hook-api) inside your Storybook directory with the following inside:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-dom-snapshot-testing.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe `postVisit` hook allows you to extend the test runner's default configuration. Read more about them [here](#test-hook-api).\\n</Callout>\\n\\nWhen you execute the test-runner (for example, with `yarn test-storybook`), it will run through all of your stories and run the snapshot tests, generating a snapshot file for each story in your project located in the `__snapshots__` directory.\", \"Configure\": {\"Override the default snapshot directory\": \"The test-runner uses a specific naming convention and path for the generated snapshot files by default. If you need to customize the snapshot directory, you can define a custom snapshot resolver to specify the directory where the snapshots are stored.\\n\\nCreate a `snapshot-resolver.js` file to implement a custom snapshot resolver:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-snapshot-resolver-custom-directory.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate the `test-runner-jest.config.js` file and enable the `snapshotResolver` option to use the custom snapshot resolver:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-config-snapshot-resolver.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen the test-runner is executed, it will cycle through all of your stories and run the snapshot tests, generating a snapshot file for each story in your project located in the custom directory you specified.\", \"Customize snapshot serialization\": \"By default, the test-runner uses [`jest-serializer-html`](https://github.com/algolia/jest-serializer-html) to serialize HTML snapshots. This may cause issues if you use specific CSS-in-JS libraries like [Emotion](https://emotion.sh/docs/introduction), Angular's `ng` attributes, or similar libraries that generate hash-based identifiers for CSS classes. If you need to customize the serialization of your snapshots, you can define a custom snapshot serializer to specify how the snapshots are serialized.\\n\\nCreate a `snapshot-serializer.js` file to implement a custom snapshot serializer:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-custom-snapshot-serializer.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nUpdate the `test-runner-jest.config.js` file and enable the `snapshotSerializers` option to use the custom snapshot resolver:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-config-serializer.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nWhen the test-runner executes your tests, it will introspect the resulting HTML, replacing the dynamically generated attributes with the static ones provided by the regular expression in the custom serializer file before snapshotting the component. This ensures that the snapshots are consistent across different test runs.\"}}, \"Generate code coverage\": {\"Set up\": \"Engineered to work alongside modern testing tools (e.g., [Playwright](https://playwright.dev/)), the coverage addon automatically instruments your code and generates code coverage data. For an optimal experience, we recommend using the test-runner alongside the coverage addon to run your tests.\\n\\nRun the following command to install the addon.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-coverage-addon-install.md\\\" />\\n\\n<Callout variant=\\\"info\\\">\\n\\nThe CLI's [`add`](../../api/cli-options.mdx#add) command automates the addon's installation and setup. To install it manually, see our [documentation](../../addons/install-addons.mdx#manual-installation) on how to install addons.\\n\\n</Callout>\\n\\nStart your Storybook with:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-run-dev.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nFinally, open a new terminal window and run the test-runner with:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-coverage.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n\", \"Configure\": \"By default, the [`@storybook/addon-coverage`](https://storybook.js.org/addons/@storybook/addon-coverage) offers zero-config support for Storybook and instruments your code via [`istanbul-lib-instrument`](https://www.npmjs.com/package/istanbul-lib-instrument) for [Webpack](https://webpack.js.org/), or [`vite-plugin-istanbul`](https://github.com/iFaxity/vite-plugin-istanbul) for [Vite](https://vitejs.dev/). However, you can extend your Storybook configuration file (i.e., `.storybook/main.js|ts`) and provide additional options to the addon. Listed below are the available options divided by builder and examples of how to use them.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-coverage-addon-config-options.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<details>\\n<summary>Vite options</summary>\\n\\n| Options | Description | Type |\\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |\\n| `checkProd` | Configures the plugin to skip instrumentation in production environments<br />`options: { istanbul: { checkProd: true,}}` | `boolean` |\\n| `cwd` | Configures the working directory for the coverage tests.<br />Defaults to `process.cwd()`<br />`options: { istanbul: { cwd: process.cwd(),}}` | `string` |\\n| `cypress` | Replaces the `VITE_COVERAGE` environment variable with `CYPRESS_COVERAGE`.<br />Requires Cypress's [code coverage](https://docs.cypress.io/guides/tooling/code-coverage)<br />`options: { istanbul: { cypress: true,}}` | `boolean` |\\n| `exclude` | Overrides the [default exclude list](https://github.com/storybookjs/addon-coverage/blob/main/src/constants.ts) with the provided list of files or directories to exclude from coverage<br />`options: { istanbul: { exclude: ['**/stories/**'],}}` | `Array<String>` or `string` |\\n| `extension` | Extends the [default extension list](https://github.com/storybookjs/addon-coverage/blob/main/src/constants.ts) with the provided list of file extensions to include in coverage<br />`options: { istanbul: { extension: ['.js', '.cjs', '.mjs'],}}` | `Array<String>` or `string` |\\n| `forceBuildInstrument` | Configures the plugin to add instrumentation in build mode <br />`options: { istanbul: { forceBuildInstrument: true,}}` | `boolean` |\\n| `include` | Select the files to collect coverage<br />`options: { istanbul: { include: ['**/stories/**'],}}` | `Array<String>` or `string` |\\n| `nycrcPath` | Defines the relative path for the existing nyc [configuration file](https://github.com/istanbuljs/nyc?tab=readme-ov-file#configuration-files)<br />`options: { istanbul: { nycrcPath: '../nyc.config.js',}}` | `string` |\\n| `requireEnv` | Overrides the `VITE_COVERAGE` environment variable's value by granting access to the `env` variables<br />`options: { istanbul: { requireEnv: true,}}` | `boolean` |\\n\\n</details>\\n\\n<details>\\n<summary>Webpack 5 options</summary>\\n\\n| Options | Description | Type |\\n| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |\\n| `autoWrap` | Provides support for top-level return statements by wrapping the program code in a function<br />`options: { istanbul: { autoWrap: true,}}` | `boolean` |\\n| `compact` | Condenses the output of the instrumented code. Useful for debugging<br />`options: { istanbul: { compact: false,}}` | `boolean` |\\n| `coverageVariable` | Defines the global variable name that Istanbul will use to store coverage results<br />`options: { istanbul: { coverageVariable: '__coverage__',}}` | `string` |\\n| `cwd` | Configures the working directory for the coverage tests.<br />Defaults to `process.cwd()`<br />`options: { istanbul: { cwd: process.cwd(),}}` | `string` |\\n| `debug` | Enables the debug mode for additional logging information during the instrumentation process<br />`options: { istanbul: { debug: true,}}` | `boolean` |\\n| `esModules` | Enables support for ES Module syntax<br />`options: { istanbul: { esModules: true,}}` | `boolean` |\\n| `exclude` | Overrides the [default exclude list](https://github.com/storybookjs/addon-coverage/blob/main/src/constants.ts) with the provided list of files or directories to exclude from coverage<br />`options: { istanbul: { exclude: ['**/stories/**'],}}` | `Array<String>` or `string` |\\n| `extension` | Extends the [default extension list](https://github.com/storybookjs/addon-coverage/blob/main/src/constants.ts) with the provided list of file extensions to include in coverage<br />`options: { istanbul: { extension: ['.js', '.cjs', '.mjs'],}}` | `Array<String>` or `string` |\\n| `include` | Select the files to collect coverage<br />`options: { istanbul: { include: ['**/stories/**'],}}` | `Array<String>` or `string` |\\n| `nycrcPath` | Defines the relative path for the existing nyc [configuration file](https://github.com/istanbuljs/nyc?tab=readme-ov-file#configuration-files)<br />`options: { istanbul: { nycrcPath: '../nyc.config.js',}}` | `string` |\\n| `preserveComments` | Includes comments in the instrumented code<br />`options: { istanbul: { preserveComments: true,}}` | `boolean` |\\n| `produceSourceMap` | Configures Instanbul to generate a source map for the instrumented code<br />`options: { istanbul: { produceSourceMap: true,}}` | `boolean` |\\n| `sourceMapUrlCallback` | Defines a callback function invoked with the filename and the source map URL when a source map is generated<br />`options: { istanbul: { sourceMapUrlCallback: (filename, url) => {},}}` | `function` |\\n\\n</details>\", \"What about other coverage reporting tools?\": \"Out of the box, code coverage tests work seamlessly with Storybook's test-runner and the [`@storybook/addon-coverage`](https://storybook.js.org/addons/@storybook/addon-coverage). However, that doesn't mean you can't use additional reporting tools (e.g., [Codecov](https://about.codecov.io/)). For instance, if you're working with [LCOV](https://wiki.documentfoundation.org/Development/Lcov), you can use the generated output (in `coverage/storybook/coverage-storybook.json`) and create your own report with:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-coverage-report-lcov.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Set up CI to run tests\": {\"Run against deployed Storybooks via Github Actions deployment\": \"If you're publishing your Storybook with services such as [Vercel](https://vercel.com/) or [Netlify](https://docs.netlify.com/site-deploys/notifications/#github-commit-statuses), they emit a `deployment_status` event in GitHub Actions. You can use it and set the `deployment_status.target_url` as the `TARGET_URL` environment variable. Here's how:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-with-deploy-event-workflow.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe published Storybook must be publicly available for this example to work. We recommend running the test server using the recipe [below](#run-against-non-deployed-storybooks) if it requires authentication.\\n</Callout>\", \"Run against non-deployed Storybooks\": \"You can use your CI provider (for example, [GitHub Actions](https://github.com/features/actions), [GitLab Pipelines](https://docs.gitlab.com/ee/ci/pipelines/), [CircleCI](https://circleci.com/)) to build and run the test runner against your built Storybook. Here's a recipe that relies on third-party libraries, that is to say, [concurrently](https://www.npmjs.com/package/concurrently), [http-server](https://www.npmjs.com/package/http-server), and [wait-on](https://www.npmjs.com/package/wait-on) to build Storybook and run tests with the test-runner.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-local-build-workflow.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nBy default, Storybook outputs the [build](../../sharing/publish-storybook.mdx#build-storybook-as-a-static-web-application) to the `storybook-static` directory. If you're using a different build directory, you'll need to adjust the recipe accordingly.\\n</Callout>\"}, \"Advanced configuration\": {\"Test hook API\": \"The test-runner renders a story and executes its [play function](../../writing-stories/play-function.mdx) if one exists. However, certain behaviors are impossible to achieve via the play function, which executes in the browser. For example, if you want the test-runner to take visual snapshots for you, this is possible via Playwright/Jest but must be executed in Node.\\n\\nThe test-runner exports test hooks that can be overridden globally to enable use cases like visual or DOM snapshots. These hooks give you access to the test lifecycle *before* and *after* the story is rendered.\\nListed below are the available hooks and an overview of how to use them.\\n\\n| Hook | Description |\\n| ----------- | --------------------------------------------------------------------------------------------------------------- |\\n| `prepare` | Prepares the browser for tests<br />`async prepare({ page, browserContext, testRunnerConfig }) {}` |\\n| `setup` | Executes once before all the tests run<br />`setup() {}` |\\n| `preVisit` | Executes before a story is initially visited and rendered in the browser<br />`async preVisit(page, context) {}` |\\n| `postVisit` | Executes after the story is visited and fully rendered<br />`async postVisit(page, context) {}` |\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThese test hooks are experimental and may be subject to breaking changes. We encourage you to test as much as possible within the story's [play function](../../writing-stories/play-function.mdx).\\n</Callout>\\n\\nTo enable the hooks API, you'll need to add a new configuration file inside your Storybook directory and set them up as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-hooks-example.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nExcept for the `setup` function, all other functions run asynchronously. Both `preVisit` and `postVisit` functions include two additional arguments, a [Playwright page](https://playwright.dev/docs/pages) and a context object which contains the `id`, `title`, and the `name` of the story.\\n</Callout>\\n\\nWhen the test-runner executes, your existing tests will go through the following lifecycle:\\n\\n['The `setup` function is executed before all the tests run.', 'The context object is generated containing the required information.', \\\"Playwright navigates to the story's page.\\\", 'The `preVisit` function is executed.', 'The story is rendered, and any existing `play` functions are executed.', 'The `postVisit` function is executed.']\", \"(Experimental) Filter tests\": {\"Disabling tests\": \"If you want to prevent specific stories from being tested by the test-runner, you can configure your story with a custom tag, enable it to the test-runner configuration file or run the test-runner with the `--excludeTags` [CLI](#cli-options) flag and exclude them from testing. This is helpful when you want to exclude stories that are not yet ready for testing or are irrelevant to your tests. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-exclude-tags.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Run tests for a subset of stories\": \"To allow the test-runner only to run tests on a specific story or subset of stories, you can configure the story with a custom tag, enable it in the test-runner configuration file or run the test-runner with the `--includeTags` [CLI](#cli-options) flag and include them in your tests. For example, if you wanted to run tests based on the `test-only` tag, you can adjust your configuration as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-include-tags.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\u2139\\ufe0f\\\">\\nApplying tags for the component's stories should either be done at the component level (using `meta`) or at the story level. Importing tags across stories is not supported in Storybook and won't work as intended.\\n</Callout>\", \"Skip tests\": \"If you want to skip running tests on a particular story or subset of stories, you can configure your story with a custom tag, enable it in the test-runner configuration file, or run the test-runner with the `--skipTags` [CLI](#cli-options) flag. Running tests with this option will cause the test-runner to ignore and flag them accordingly in the test results, indicating that the tests are temporarily disabled. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"my-component-skip-tags.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Authentication for deployed Storybooks\": \"If you use a secure hosting provider that requires authentication to host your Storybook, you may need to set HTTP headers. This is mainly because of how the test runner checks the status of the instance and the index of its stories through fetch requests and Playwright. To do this, you can modify the test-runner configuration file to include the `getHttpHeaders` function. This function takes the URL of the fetch calls and page visits as input and returns an object containing the headers that need to be set.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-auth.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Helpers\": {\"Accessing story information with the test-runner\": \"If you need to access information about the story, such as its parameters, the test-runner includes a helper function named `getStoryContext` that you can use to retrieve it. You can then use it to customize your tests further as needed. For example, if you need to configure Playwright's page [viewport size](https://playwright.dev/docs/api/class-page#page-set-viewport-size) to use the viewport size defined in the story's parameters, you can do so as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-custom-page-viewport.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"Working with assets\": \"If you're running a specific set of tests (e.g., image snapshot testing), the test-runner provides a helper function named `waitForPageReady` that you can use to ensure the page is fully loaded and ready before running the test. For example:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-waitpageready.md\\\" />\\n\\n{/* prettier-ignore-end */}\"}, \"Index.json mode\": {\"Why?\": \"Suppose you run into a situation where the local and remote Storybooks appear out of sync, or you might not even have access to the code. In that case, the `index.json` file is guaranteed to be the most accurate representation of the deployed Storybook you are testing. To test a local Storybook using this feature, use the `--index-json` flag as follows:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-with-index-json.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\ud83d\\udca1\\\">\\nThe `index.json` mode is not compatible with the watch mode.\\n</Callout>\\n\\nIf you need to disable it, use the `--no-index-json` flag:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"test-runner-no-index-json.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"How do I check if my Storybook has a `index.json` file?\": \"Index.json mode requires a `index.json` file. Open a browser window and navigate to your deployed Storybook instance (for example, `https://your-storybook-url-here.com/index.json`). You should see a JSON file that starts with a `\\\"v\\\": 3` key, immediately followed by another key called \\\"stories\\\", which contains a map of story IDs to JSON objects. If that is the case, your Storybook supports [index.json mode](../../configure/index.mdx#feature-flags).\"}}, \"What's the difference between Chromatic and Test runner?\": \"The test-runner is a generic testing tool that can run locally or on CI and be configured or extended to run all kinds of tests.\\n\\n[Chromatic](https://www.chromatic.com/?utm_source=storybook_website\\\\&utm_medium=link\\\\&utm_campaign=storybook) is a cloud-based service that runs [visual](../visual-testing.mdx) and [interaction tests](../interaction-testing.mdx) (and soon [accessibility tests](../accessibility-testing.mdx)) without setting up the test runner. It also syncs with your git provider and manages access control for private projects.\\n\\nHowever, you might want to pair the test runner and Chromatic in some cases.\\n\\n['Use it locally and Chromatic on your CI.', 'Use Chromatic for visual and component tests and run other custom tests using the test runner.']\", \"Troubleshooting\": {\"The test runner seems flaky and keeps timing out\": \"If your tests time out with the following message:\\n\\n```\\nTimeout - Async callback was not invoked within the 15000 ms timeout specified by jest.setTimeout\\n```\\n\\nIt might be that Playwright couldn't handle testing the number of stories you have in your project. Perhaps you have a large number of stories, or your CI environment has a really low RAM configuration. In such cases, you should limit the number of workers that run in parallel by adjusting your command as follows:\\n\\n```\\n{\\n \\\"scripts\\\": {\\n \\\"test-storybook:ci\\\": \\\"yarn test-storybook --maxWorkers=2\\\"\\n }\\n}\\n```\", \"The error output in the CLI is too short\": \"By default, the test runner truncates error outputs at 1000 characters, and you can check the full output directly in Storybook in the browser. However, if you want to change that limit, you can do so by setting the `DEBUG_PRINT_LIMIT` environment variable to a number of your choosing, for example, `DEBUG_PRINT_LIMIT=5000 yarn test-storybook`.\", \"Run the test runner in other CI environments\": \"As the test runner is based on Playwright, you might need to use specific docker images or other configurations depending on your CI setup. In that case, you can refer to the [Playwright CI docs](https://playwright.dev/docs/ci) for more information.\", \"Tests filtered by tags are incorrectly executed\": \"If you've enabled filtering tests with tags and provided similar tags to the `include` and `exclude` lists, the test-runner will execute the tests based on the `exclude` list and ignore the `include` list. To avoid this, make sure the tags provided to the `include` and `exclude` lists differ.\", \"The test runner doesn't support Yarn PnP out of the box\": \"If you've enabled the test-runner in a project running on a newer version of Yarn with Plug'n'Play (PnP) enabled, the test-runner might not work as expected and may generate the following error when running tests:\\n\\n```\\nPlaywrightError: jest-playwright-preset: Cannot find playwright package to use chromium\\n```\\n\\nThis is due to the test-runner using the community-maintained package [jest-playwright-preset](https://github.com/playwright-community/jest-playwright) that still needs to support this feature. To solve this, you can either switch the [`nodeLinker`](https://yarnpkg.com/features/linkers) setting to `node-modules` or install Playwright as a direct dependency in your project, followed by adding the browser binaries via the [`install`](https://playwright.dev/docs/browsers#install-browsers) command.\", \"Run test coverage in other frameworks\": \"If you intend on running coverage tests in frameworks with special files like Vue 3 or Svelte, you'll need to adjust your configuration and enable the required file extensions. For example, if you're using Vue, you'll need to add the following to your nyc configuration file (i.e., `.nycrc.json` or `nyc.config.js`):\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-coverage-report-vue.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"The coverage addon doesn't support optimized builds\": \"If you generated a production build optimized for performance with the [`--test`](../../sharing/publish-storybook.mdx#customizing-the-build-for-performance) flag, and you're using the coverage addon to run tests against your Storybook, you may run into a situation where the coverage addon doesn't instrument your code. This is due to how the flag works, as it removes addons that have an impact on performance (e.g., [`Docs`](../../writing-docs/index.mdx), [coverage addon](https://storybook.js.org/addons/@storybook/addon-coverage)). To resolve this issue, you'll need to adjust your Storybook configuration file (i.e., `.storybook/main.js|ts`) and include the [`disabledAddons`](../../api/main-config/main-config-build.mdx#testdisabledaddons) option to allow the addon to run tests at the expense of a slower build.\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"storybook-coverage-addon-optimized-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\", \"The coverage addon doesn't support instrumented code\": \"As the [coverage addon](https://storybook.js.org/addons/@storybook/addon-coverage) is based on Webpack5 loaders and Vite plugins for code instrumentation, frameworks that don't rely upon these libraries (e.g., Angular configured with Webpack), will require additional configuration to enable code instrumentation. In that case, you can refer to the following [repository](https://github.com/yannbf/storybook-coverage-recipes) for more information.\\n\\n**More testing resources**\\n\\n['[Interaction testing](../interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](../accessibility-testing.mdx) for accessibility', '[Visual testing](../visual-testing.mdx) for appearance', '[Snapshot testing](../snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](../test-coverage.mdx) for measuring code coverage', '[CI](../in-ci.mdx) for running tests in your CI/CD pipeline', '[Vitest addon](./vitest-addon.mdx) for running tests in Storybook', '[End-to-end testing](./stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./stories-in-unit-tests.mdx) for functionality']\"}}, \"metadata\": {\"title\": \"Test runner\", \"sidebar\": {\"order\": 2, \"title\": \"Test runner (Webpack)\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"Vitest addon\", \"description\": null, \"content\": {\"Install and set up\": {\"Automatic setup\": \"Run the following command to install and configure the addon, which contains the plugin to run your stories as tests using Vitest:\\n\\n<CodeSnippets path=\\\"addon-test-install.md\\\" />\\n\\nThat [`add` command](../../addons/install-addons.mdx#automatic-installation) will install and register the Vitest addon. It will also inspect your project's Vite and Vitest setup, and install and configure them with sensible defaults, if necessary. You may need to adjust the configuration to fit your project's needs. The full configuration options can be found in the [API section](#options), below.\", \"Manual setup\": \"For some project setups, the `add` command may be unable to automate the addon and plugin setup and ask you to complete additional setup steps. Here's what to do:\\n\\n['Make sure Vite and Vitest are configured in your project.', 'Configure Vitest to use [browser mode](https://vitest.dev/guide/browser/).', 'Install the addon, `@storybook/addon-vitest`, in your project and [register it in your Storybook configuration](../../addons/install-addons.mdx#manual-installation).', 'Create a test setup file, `.storybook/vitest.setup.ts`. You can use the [example setup file](#example-vitest-setup) as a guide.', 'Adjust your Vitest configuration to include the plugin and reference the setup file. You can use the [example configuration files](#example-configuration-files) as a guide.', ['For projects with existing Vitest tests, we recommend using a [workspace file](https://vitest.dev/guide/workspace/) to define separate projects for your Storybook tests and other tests. This allows you to run them either in isolation or together, depending on your needs.']]\", \"Example configuration files\": \"When the addon is set up automatically, it will create or adjust your Vitest configuration files for you. If you're setting up manually, you can use the following examples as a reference when configuring your project.\\n\\n<details id=\\\"example-vitest-setup\\\">\\n<summary>Example Vitest setup file</summary>\\n\\nStorybook stories contain configuration defined in `.storybook/preview.js|ts`. To ensure that configuration is available to your tests, you can apply it in a Vitest setup file. Here's an example of how to do that:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"addon-vitest-set-project-annotations-simple.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nThe `setProjectAnnotations` function is part of the [portable stories API](../../api/portable-stories/portable-stories-vitest.mdx#setprojectannotations), which is used internally by the Vitest plugin to transform your stories into tests.\\n</details>\\n\\n<details id=\\\"example-vitest-config\\\">\\n<summary>Example Vitest config file</summary>\\n\\nThe most simple application of the plugin is to include it in your Vitest configuration file:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"vitest-plugin-vitest-config.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</details>\\n\\n<details id=\\\"example-vitest-workspace\\\">\\n<summary>Example Vitest workspace file (Vitest < 3.2)</summary>\\n\\nIf you're using a [Vitest workspace](https://vitest.dev/guide/workspace), you can define a new workspace project:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"vitest-plugin-vitest-workspace.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\n</details>\"}, \"Usage\": {\"Storybook UI\": \"The easiest way to run tests is through the Storybook UI. With a click, you can run multiple types of tests for all stories in your project, a group of stories, or a single story.\\n\\nTo run all tests for your whole project, press the Run tests button in the testing widget at the bottom of the sidebar.\\n\\n\\n\\nAlternatively, you can expand the testing widget to run specific types of tests individually. The sub-types listed under component tests will all run together, including when watch mode (which will automatically re-run relevant tests upon code changes) is enabled (with the eye icon).\\n\\n\\n\\n<Callout variant=\\\"info\\\" icon=\\\"\\u2139\\ufe0f\\\">\\n\\nIf you have the [Visual tests addon](../visual-testing.mdx) installed, you'll see an option to run Visual tests alongside Component tests.\\n\\n\\n\\nOther addons, such as [a11y](../accessibility-testing.mdx#run-accessibility-tests), may also provide test types that can be run from the testing widget and affect the status indicators on stories and components.\\n\\n</Callout>\\n\\nTo run tests for a specific story or group of stories, press the menu button (three dots) that appears on hover of a sidebar item. You can then select the test type you want to run.\\n\\n\\n\\nAfter running your tests, you will now see status indicators on stories and components for their pass, fail, or error state. You can press on the menu button when hovering a story to see the test results for that story. Selecting a result in the menu will navigate you to that story and open the appropriate debugging panel. For example, if an interaction test fails, you can jump straight to the failure in the Interactions panel. That panel provides an interactive debugger for your test, allowing you to step through each simulated behavior or assertion.\\n\\nThe testing widget will also show you the total number of tests run, the number of tests that passed, and the number of tests that failed or errored. You can press the failure number to filter the sidebar to only those stories that failed.\\n\\n<Video src=\\\"../../_assets/writing-tests/addon-vitest-filter-failures.mp4\\\" />\", \"CLI\": {\"Debugging\": \"While the plugin does not require Storybook to run when testing, you may still want to run Storybook to debug your tests. To enable this, provide the [`storybookScript` option](#storybookscript) in the plugin configuration. When you run Vitest in watch mode, the plugin will start Storybook using this script and provide links to the story in the output on test failures. This allows you to quickly jump to the story in Storybook to debug the issue.\\n\\nYou can also provide a [`storybookUrl` option](#storybookurl) to the plugin configuration. When you're not using watch mode and tests fail, the plugin will provide a link to the story using this URL in the output. This is useful when [running tests in CI](#in-ci) or other environments where Storybook is not already running.\\n\\n\"}, \"Editor extension\": \"Transforming your stories into Vitest tests with the plugin also enables you to run and debug tests using Vitest [IDE integrations](https://vitest.dev/guide/ide.html). This allows you to run tests directly from your editor, such as VSCode and JetBrains IDE.\\n\\nThis screenshot shows how you can run your Vitest tests in VSCode using the [Vitest extension](https://marketplace.visualstudio.com/items?itemName=vitest.explorer). Stories are annotated with the test status, and, when a test fails, a link to the story is provided for [debugging](#debugging).\\n\\n\", \"In CI\": \"For the most part, running your Storybook tests in CI is done [via the CLI](#cli).\\n\\nHowever, to have the test output link to your published Storybook on test failures, you need to provide the [`storybookUrl` option](#storybookurl) in the plugin configuration. Please reference the [detailed example in the Testing in CI guide](../in-ci.mdx#21-debugging-test-failures-in-ci).\"}, \"How it works\": \"The Vitest addon works by using a Vitest plugin to transform your stories into [Vitest](https://vitest.dev) tests using [portable stories](../../api/portable-stories/portable-stories-vitest.mdx). It also configures Vitest to run those tests in [browser mode](https://vitest.dev/guide/browser/), using Playwright's Chromium browser. Because it is built on top of Vitest, the addon requires a Vite-based Storybook framework.\\n\\nStories are tested in two ways: a smoke test to ensure it renders and, if a [play function](../interaction-testing.mdx#writing-interaction-tests) is defined, that function is run and any [assertions made](../interaction-testing.mdx#asserting-with-expect) within it are validated.\\n\\nWhen you run tests in the [Storybook UI](#storybook-ui), the addon runs Vitest in the background and reports the results in the sidebar. \", \"Configuring tests\": {\"Toggling test types\": \"In addition to component tests, the Vitest addon supports multiple types of tests, depending on which other addons you are using in your project. Some test types, like [visual tests](../visual-testing.mdx), are run independently. Others, like [accessibility](../accessibility-testing.mdx), must be run alongside component tests. For these dependent test types, you can toggle them on or off in the testing widget by checking or unchecking the test types you want to run.\\n\\n\\n\\nNote that you may not have all of the test types pictured, depending on which addons you have installed.\", \"Including, excluding, or skipping tests\": \"You can use [tags](../../writing-stories/tags.mdx) to include, exclude, or skip stories from being tested. Included stories are tested, excluded stories are not tested, and skipped stories are not tested but are counted in the test results.\\n\\nBy default, the plugin will run all stories with the `test` tag. You can adjust this behavior by providing the [`tags` option](#tags) in the plugin configuration. This allows you to include, exclude, or skip stories based on their tags.\\n\\nIn this example, we'll apply the `stable` tag to all of the Button component's stories, except for ExperimentalFeatureStory, which will have the `experimental` tag:\\n\\n{/* prettier-ignore-start */}\\n\\n<CodeSnippets path=\\\"tags-remove-in-story.md\\\" />\\n\\n{/* prettier-ignore-end */}\\n\\nTo connect those tags to our test behavior, we can adjust the plugin configuration to exclude the `experimental` tag:\\n\\n```\\nexport default defineWorkspace([\\n // ...\\n {\\n // ...\\n {\\n plugins: [\\n storybookTest({\\n // ...\\n tags: {\\n include: ['test'],\\n exclude: ['experimental'],\\n },\\n }),\\n ],\\n },\\n },\\n])\\n```\\n\\nIf the same tag is in both the `include` and `exclude` arrays, the `exclude` behavior takes precedence.\"}, \"Comparison to the test runner\": \"The [test runner](./test-runner.mdx) requires a running Storybook instance to test your stories, because it visits each one, executes the play function, and listens for results. The Vitest plugin, however, transforms your stories into tests using Vite and portable stories, so it does not need to run Storybook to test your stories. Because of this reliance on Vite, the plugin can only be used with Storybook frameworks that use Vite (and [Next.js](../../get-started/frameworks/nextjs.mdx#with-vite)). The test runner, on the other hand, can be used with any Storybook framework.\\n\\n| Feature | Vitest addon | test-runner |\\n| ----------------------------------------------------- | ------------------ | ------------------------ |\\n| **Test types** |\\n| - [Interaction tests](../interaction-testing.mdx) | \\u2705 | \\u2705 |\\n| - [Accessibility tests](../accessibility-testing.mdx) | \\u2705 | \\u2705 |\\n| - [Visual tests](../visual-testing.mdx) | \\u2705 | \\u274c |\\n| - [Snapshot tests](../snapshot-testing.mdx) | \\u274c | \\u2705 |\\n| **Testing contexts** |\\n| - Storybook UI | \\u2705 | \\u274c |\\n| - Editor extensions | \\u2705 | \\u274c |\\n| - CLI | \\u2705 | \\u2705 |\\n| - In CI | \\u2705 | \\u2705 |\\n| Works with all Storybook frameworks | \\u274c (requires Vite) | \\u2705 |\\n| Runs tests in a real browser environment | \\u2705 | \\u2705 |\\n| Calculates code coverage | \\u2705 | \\u2705 (with addon-coverage) |\\n| Requires a running or published Storybook | \\u274c | \\u2705 |\\n| Extensible to other addons | \\u2705 | \\u274c |\\n\\nThe test runner is only a CLI tool. It does not have a UI for running tests, nor does it have an editor extension. The addon, however, provides a UI in Storybook for running tests, and it enables you to run and debug tests using Vitest IDE integrations.\\n\\nAdditionally, the test runner ran your stories as orchestrated tests in Jest, and that orchestration came with some complexity. By comparison, this plugin transforms your stories into real tests and then runs them using Vitest, which is simpler and more configurable.\\n\\nFinally, because of the simpler architecture and the use of Vitest, this plugin should be faster than the test runner for most projects. We'll do more benchmarking to quantify this in the future.\", \"FAQ\": {\"What happens if Vitest itself has an error?\": \"Sometimes tests can fail because of errors within Vitest itself. When this happens, the testing widget in the Storybook UI will alert you to the error, and you can click a link to view it in full. The error will also be logged to the console.\\n\\n\\n\\nVitest offers [troubleshooting help for common errors](https://vitest.dev/guide/common-errors.html).\", \"What happens when there are different test results in multiple environments?\": \"When you run tests with this addon, they are run as Vitest tests with whatever configuration you have set up in your project. By default, they will run in browser mode, using Playwright's Chromium browser. Sometimes, tests will fail when run in the addon (or via CLI), but then pass when viewed in the Interactions panel (or vice versa). This can happen because the tests are run in different environments, which can have different behaviors.\", \"How do I debug my CLI tests in Storybook?\": \"The plugin will attempt to provide links to the story in Storybook when tests fail in CLI, for [debugging](#debugging) purposes.\\n\\nIf the URLs are not working when running tests in watch mode, you should check two configuration options:\\n\\n[\\\"[`storybookUrl`](#storybookurl): Ensure this URL is correct and accessible. For example, the default is `http://localhost:6006`, which may not use the same port number you're using.\\\", '[`storybookScript`](#storybookscript): Ensure this script is correctly starting Storybook.']\\n\\nIf the URLs are not working when running tests in CI, you should ensure the Storybook is built and published before running the tests. You can then provide the URL to the published Storybook using the `storybookUrl` option. See the [In CI](#in-ci) section for an example.\", \"How do I ensure my tests can find assets in the public directory?\": \"If your stories use assets in the public directory and you're not using the default public directory location (`public`), you need to adjust the Vitest configuration to include the public directory. You can do this by providing the [`publicDir` option in the Vitest configuration file](https://vitejs.dev/config/shared-options.html#publicdir).\", \"How do I isolate Storybook tests from others?\": \"Some projects might contain a `test` property in their Vite configuration. Because the Vitest configuration used by this plugin extends that Vite config, the `test` properties are merged. This lack of isolation can cause issues with your Storybook tests.\\n\\nTo isolate your Storybook tests from other tests, you need to move the `test` property from your Vite configuration to the Vitest configuration. The Vitest config used by the plugin can then safely extend your Vite config without merging the `test` property.\\n\\nAdditionally, we recommend using a [workspace file](#example-configuration-files) to define separate projects for your Storybook tests and other tests. This ensures each can be run either in isolation or together, depending on your needs.\", \"Why do we recommend browser mode?\": \"Vitest's browser mode runs your tests in a real browser (Chromium, via Playwright, in the default configuration). The alternative is a simulated browser environment, like JSDom or HappyDom, which can have differences in behavior compared to a real browser. For UI components, which can often depend on browser APIs or features, running tests in a real browser is more accurate.\\n\\nFor more, see [Vitest's guide on using browser mode effectively](https://vitest.dev/guide/browser/#motivation).\", \"How do I use WebDriver instead of Playwright?\": \"We recommend running tests in a browser using Playwright, but you can use WebDriverIO instead. To do so, you need to adjust the [browser provider in the Vitest configuration file](https://vitest.dev/config/#browser-provider).\", \"How do I use a browser other than Chromium?\": \"We recommend using Chromium, because it is most likely to best match the experience of a majority of your users. However, you can use other browsers by adjusting the [browser name in the Vitest configuration file](https://vitest.dev/config/#browser-name). Note that [Playwright and WebDriverIO support different browsers](https://vitest.dev/guide/browser/#browser-option-types).\", \"How do I customize a test name?\": \"By default, the export name of a story is mapped to the test name. To create a more descriptive test description, you can provide a `name` property for the story. This allows you to include spaces, brackets, or other special characters.\\n\\n```\\nexport const Story = {\\n name: 'custom, descriptive name'\\n};\\n```\\n\\n<If renderer=\\\"react\\\">\", \"How do I fix the `m.createRoot is not a function` error?\": \"This error can occur when using the addon on a project that uses a React version other than 18. To work around the issue, you can provide an alias to ensure the correct React version is used. Here's an example of how to do that in the Vitest configuration file:\\n\\n```\\nimport { defineConfig } from 'vitest/config';\\n\\nexport default defineConfig({\\n // ...\\n resolve: {\\n alias: {\\n \\\"@storybook/react-dom-shim\\\": \\\"@storybook/react-dom-shim/dist/react-16\\\",\\n },\\n },\\n});\\n```\\n\\n</If>\", \"How do I fix the `Error: Vitest failed to find the current suite` error?\": \"If you encounter this error, it's often not a Vitest issue but rather related to how your stories are being transformed. Here are steps to troubleshoot:\\n\\n['Check the complete error logs for additional context, particularly around story transformation', 'Pay attention to Vite dependency optimization warnings (e.g., \\\"new dependencies optimized: lodash\\\")', 'If you see dependency optimization warnings, these can cause test-breaking reloads during execution']\\n\\nThe most common fix is to pre-optimize your dependencies. You can do this by adding the dependencies to your Vite config's [`optimizeDeps.include`](https://vitejs.dev/config/dep-optimization-options.html#optimizedeps-include) array.\\n\\nThis prevents mid-test dependency optimization, which can interfere with Vitest's test suite management.\"}, \"API\": {\"Exports\": {\"`storybookTest`\": \"Type: `function`\\n\\nA [Vitest plugin](https://vitejs.dev/guide/api-plugin) that transforms your stories into tests. It accepts an [options object](#options) for configuration.\"}, \"Options\": {\"`configDir`\": \"Type: `string`\\n\\nDefault: `.storybook`\\n\\nThe directory where the Storybook configuration is located, relative to the current working directory.\\n\\nIf your [Storybook configuration](../../configure/index.mdx) is not in the default location, you **must** specify the location here so the plugin can function correctly.\", \"`storybookScript`\": \"Type: `string`\\n\\nOptional script to run Storybook. If provided, Vitest will start Storybook using this script when run in watch mode. Only runs if the Storybook in `storybookUrl` is not already available.\", \"`storybookUrl`\": \"Type: `string`\\n\\nDefault: `http://localhost:6006`\\n\\nThe URL where Storybook is hosted. This is used for internal checks and to provide a [link to the story in the test output on failures](#debugging).\", \"`tags`\": \"Type:\\n\\n```\\n{\\n include: string[];\\n exclude: string[];\\n skip: string[];\\n}\\n```\\n\\nDefault:\\n\\n```\\n{\\n include: ['test'],\\n exclude: [],\\n skip: [],\\n}\\n```\\n\\n[Tags](../../writing-stories/tags.mdx) to include, exclude, or skip. These tags are defined as annotations in your story, meta, or preview.\\n\\n['**`include`**: Stories with these tags will be tested', '**`exclude`**: Stories with these tags will not be tested, and will not be counted in the test results', '**`skip`**: Stories with these tags will not be tested, and will be counted in the test results']\", \"`disableAddonDocs`\": \"Type: `boolean`\\n\\nDefault: `true`\\n\\nWhether to disable addon docs MDX parsing while running tests.\\n\\nWhen either the preview config or stories import mdx files, they are mocked as normally they are not needed for tests.\\nYou might set `disableAddonDocs` to `false` only in case your stories actually need to read and parse MDX files as part of rendering your components.\\n</If>\\n{/* End supported renderers */}\\n\\n**More testing resources**\\n\\n['[Interaction testing](../interaction-testing.mdx) for user behavior simulation', '[Accessibility testing](../accessibility-testing.mdx) for accessibility', '[Visual testing](../visual-testing.mdx) for appearance', '[Snapshot testing](../snapshot-testing.mdx) for rendering errors and warnings', '[Test coverage](../test-coverage.mdx) for measuring code coverage', '[CI](../in-ci.mdx) for running tests in your CI/CD pipeline', '[Test runner](./test-runner.mdx) to automate test execution', '[End-to-end testing](./stories-in-end-to-end-tests.mdx) for simulating real user scenarios', '[Unit testing](./stories-in-unit-tests.mdx) for functionality']\"}}}, \"metadata\": {\"title\": \"Vitest addon\", \"sidebar\": {\"order\": 1, \"title\": \"Vitest addon\"}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 14, \\\"subpages\\\", 7]\"}], \"path\": \"[\\\"subpages\\\", 14]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Storybook Core Architecture: Dual-Process Component Development System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Manager Application: Development Environment Shell\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"React-based UI orchestration system providing main interface elements\", \"weight\": 3}, {\"requirements\": \"Sidebar navigation and story organization with hierarchical display\", \"weight\": 2}, {\"requirements\": \"Toolbar and addon panel management with extensible UI components\", \"weight\": 2}, {\"requirements\": \"Theme system and UI customization capabilities for branding\", \"weight\": 1}]}, {\"requirements\": \"Preview Application: Isolated Component Rendering Environment\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Sandboxed iframe rendering system for component isolation\", \"weight\": 3}, {\"requirements\": \"Multi-framework rendering support through pluggable framework adapters\", \"weight\": 3}, {\"requirements\": \"Canvas rendering and viewport management for component display\", \"weight\": 2}, {\"requirements\": \"Hot module replacement and live reloading for development workflow\", \"weight\": 2}]}, {\"requirements\": \"Manager-Preview Communication System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Channel-based bidirectional communication bus between applications\", \"weight\": 3}, {\"requirements\": \"Dynamic story updates and args synchronization\", \"weight\": 3}, {\"requirements\": \"Event API for addon interactions and state management\", \"weight\": 2}]}]}, {\"requirements\": \"Configuration Management: Layered Behavior Definition System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Main Configuration System (main.js|ts)\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Story file discovery using glob patterns and indexing mechanisms\", \"weight\": 3}, {\"requirements\": \"Addon ecosystem registration and configuration management\", \"weight\": 3}, {\"requirements\": \"Framework and builder specification (Webpack/Vite integration)\", \"weight\": 3}, {\"requirements\": \"Build tool configuration customization (webpackFinal, viteFinal)\", \"weight\": 2}, {\"requirements\": \"Static asset serving and environment variable processing\", \"weight\": 2}, {\"requirements\": \"Feature flags and experimental capabilities control\", \"weight\": 1}]}, {\"requirements\": \"Preview Configuration System (preview.js|ts)\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Global decorators for component context wrapping and theming\", \"weight\": 3}, {\"requirements\": \"Global parameters providing static metadata for stories and addons\", \"weight\": 2}, {\"requirements\": \"Global loaders for asynchronous data fetching before story rendering\", \"weight\": 2}, {\"requirements\": \"Global argTypes and args defining default component properties\", \"weight\": 2}, {\"requirements\": \"Global types for dynamic variables controlled by toolbar addons\", \"weight\": 2}]}, {\"requirements\": \"Parameter Inheritance and Override System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Hierarchical configuration merging: Global \\u2192 Component \\u2192 Story\", \"weight\": 3}, {\"requirements\": \"Cascading defaults with specific override capabilities\", \"weight\": 2}]}]}, {\"requirements\": \"Component Story Format (CSF): Story Definition and Processing Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Story File Structure and Metadata System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"ES module structure with default export (meta) and named exports (stories)\", \"weight\": 3}, {\"requirements\": \"Story metadata extraction, validation, and composition mechanisms\", \"weight\": 3}]}, {\"requirements\": \"Component Metadata (Meta) Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Component linking and title hierarchy definition\", \"weight\": 3}, {\"requirements\": \"Component-level args, argTypes, decorators, parameters, and loaders\", \"weight\": 3}]}, {\"requirements\": \"Story Definition and Execution System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Story-specific args for component property permutations\", \"weight\": 3}, {\"requirements\": \"Play function execution engine for user interaction simulation\", \"weight\": 3}, {\"requirements\": \"Custom render functions for complex rendering logic\", \"weight\": 2}, {\"requirements\": \"Story-specific loaders for targeted data fetching\", \"weight\": 2}]}, {\"requirements\": \"Args System: Dynamic Property Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Args as component properties for story rendering\", \"weight\": 3}, {\"requirements\": \"ArgTypes metadata for automatic control generation and documentation\", \"weight\": 3}, {\"requirements\": \"Automatic argTypes inference from TypeScript, PropTypes, and framework metadata\", \"weight\": 2}]}]}, {\"requirements\": \"Addon Ecosystem and Extensibility Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Addon Architecture and Communication\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Addon registration, lifecycle management, and preset system\", \"weight\": 3}, {\"requirements\": \"UI-based addons adding tabs, panels, and toolbar items\", \"weight\": 2}, {\"requirements\": \"Preset addons for build configuration modification\", \"weight\": 2}]}, {\"requirements\": \"Addon API and Integration Points\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Manager API for UI registration and state access\", \"weight\": 2}, {\"requirements\": \"Preview API for addon data consumption within stories\", \"weight\": 2}, {\"requirements\": \"Presets API for build process integration hooks\", \"weight\": 2}]}, {\"requirements\": \"Essential Addons Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Controls addon for dynamic property manipulation with auto-generated UI\", \"weight\": 3}, {\"requirements\": \"Actions addon for event handling, logging, and debugging\", \"weight\": 2}, {\"requirements\": \"Viewport and backgrounds addons for environment simulation\", \"weight\": 2}, {\"requirements\": \"Docs addon for automatic documentation generation\", \"weight\": 3}]}]}, {\"requirements\": \"Testing and Quality Assurance Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Interactive Testing Infrastructure\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Play function system for scripted user interactions with visual debugging\", \"weight\": 3}, {\"requirements\": \"Testing library integration (@storybook/testing-library, @storybook/jest)\", \"weight\": 3}, {\"requirements\": \"Mock and spy system for dependency isolation and testing\", \"weight\": 2}]}, {\"requirements\": \"Automated Testing Integration\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Test runner for headless browser automation and CI/CD integration\", \"weight\": 3}, {\"requirements\": \"Visual regression testing capabilities\", \"weight\": 2}, {\"requirements\": \"Accessibility testing automation\", \"weight\": 2}, {\"requirements\": \"Code coverage reporting and analysis\", \"weight\": 2}]}, {\"requirements\": \"Portable Stories System for External Testing\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Story composition utilities (composeStories, composeStory) for unit testing frameworks\", \"weight\": 3}, {\"requirements\": \"Project annotations and global configuration application for test environments\", \"weight\": 2}]}]}, {\"requirements\": \"Documentation and Knowledge Management System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Automatic Documentation Generation (addon-docs)\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Autodocs: Component documentation pages using stories and argTypes\", \"weight\": 3}, {\"requirements\": \"Component metadata extraction and analysis for documentation\", \"weight\": 3}, {\"requirements\": \"Doc blocks system for structured documentation components\", \"weight\": 2}]}, {\"requirements\": \"MDX Processing and Custom Documentation\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"MDX compilation and story integration for rich documentation\", \"weight\": 2}, {\"requirements\": \"Custom documentation page generation and layout\", \"weight\": 2}]}]}, {\"requirements\": \"Multi-Framework Support and Build System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Framework Integration Infrastructure\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Framework detection, configuration, and adapter system\", \"weight\": 3}, {\"requirements\": \"Framework-specific rendering and metadata extraction capabilities\", \"weight\": 3}]}, {\"requirements\": \"Build System Architecture\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Builder abstraction supporting Webpack and Vite with HMR\", \"weight\": 2}, {\"requirements\": \"Story compilation, bundling, and static build generation\", \"weight\": 2}]}]}, {\"requirements\": \"Data Management and State Handling\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Global State Management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Global variables and toolbar state synchronization\", \"weight\": 2}, {\"requirements\": \"URL parameter mapping and persistence\", \"weight\": 2}]}, {\"requirements\": \"Mocking and Data Simulation\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Module mocking and dependency injection system\", \"weight\": 3}, {\"requirements\": \"Network request mocking with MSW integration\", \"weight\": 2}, {\"requirements\": \"Provider mocking for context-based components\", \"weight\": 2}]}]}, {\"requirements\": \"Sharing, Collaboration, and Deployment\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Static Build and Deployment Pipeline\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Production build optimization and asset management\", \"weight\": 3}, {\"requirements\": \"SEO optimization and metadata generation\", \"weight\": 1}]}, {\"requirements\": \"Collaboration and Integration Features\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Storybook composition for multi-project integration\", \"weight\": 2}, {\"requirements\": \"Embedding capabilities and iframe integration\", \"weight\": 1}, {\"requirements\": \"Design tool integration and synchronization\", \"weight\": 1}]}]}, {\"requirements\": \"Developer Experience and Maintenance Tools\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"CLI Tools and Project Management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Project initialization and setup automation\", \"weight\": 2}, {\"requirements\": \"Addon management and installation system\", \"weight\": 1}, {\"requirements\": \"Diagnostic and troubleshooting tools\", \"weight\": 1}]}, {\"requirements\": \"Migration and Upgrade Infrastructure\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Version detection and compatibility checking\", \"weight\": 2}, {\"requirements\": \"Automated code transformation and upgrade tooling\", \"weight\": 2}]}]}]}"}}},{"rowIdx":17,"cells":{"repo_name":{"kind":"string","value":"sumatrapdf"},"repo_url":{"kind":"string","value":"https://github.com/sumatrapdfreader/sumatrapdf"},"commit_id":{"kind":"string","value":"cdadfde74471e9b06898e5c1e87edd98b4204597"},"docs_tree":{"kind":"string","value":"{\"title\": \"sumatrapdf\", \"description\": \"Documentation for sumatrapdf\", \"subpages\": [{\"title\": \"Md\", \"description\": \"Documentation section: md\", \"path\": \"[\\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"Accessibility and Text-to-Speech\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"Accessibility in SumatraPDF plugin\": \"<detail_content>\", \"Usage\": {\"Microsoft Narrator\": \"<detail_content>\"}, \"Supported configurations\": {\"Supported file types\": \"<detail_content>\", \"Supported Clients\": \"<detail_content>\", \"Unsupported Clients\": \"<detail_content>\"}}}, {\"title\": \"Advanced Options Settings\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 1]\", \"content\": {\"Advanced options / settings\": \"<detail_content>\"}}, {\"title\": \"Build system\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 2]\", \"content\": {\"When to run premake\": \"<detail_content>\", \"Customizing build\": \"<detail_content>\", \"Build variants\": \"<detail_content>\", \"How official builds are made\": \"<detail_content>\"}}, {\"title\": \"Command Palette\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 3]\", \"content\": {\"Command Palette\": \"<detail_content>\"}}, {\"title\": \"Command-line arguments\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 4]\", \"content\": {\"List of command line options\": \"<detail_content>\", \"Navigation options\": \"<detail_content>\", \"Send DDE commands\": \"<detail_content>\", \"Printing options\": \"<detail_content>\", \"Options related to forward/inverse search (for LaTeX editors)\": \"<detail_content>\", \"Developer options\": \"<detail_content>\", \"Deprecated options\": \"<detail_content>\"}}, {\"title\": \"Commands\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 5]\", \"content\": {\"File\": \"<detail_content>\", \"Search\": \"<detail_content>\", \"Viewing\": \"<detail_content>\", \"Tabs\": \"<detail_content>\", \"Navigation\": \"<detail_content>\", \"Favorites\": \"<detail_content>\", \"Presentation\": \"<detail_content>\", \"Annotations\": \"<detail_content>\", \"Zoom\": \"<detail_content>\", \"External app\": \"<detail_content>\", \"System\": \"<detail_content>\", \"Help\": \"<detail_content>\", \"Debug\": \"<detail_content>\", \"Deprecated or internal\": \"<detail_content>\"}}, {\"title\": \"Configure For Restricted Use\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 6]\", \"content\": {\"Configure for restricted use\": \"<detail_content>\"}}, {\"title\": \"Contribute to SumatraPDF\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 7]\", \"content\": {\"Getting the sources and compiling\": \"<detail_content>\", \"Contribute to SumatraPDF\": \"<detail_content>\", \"Bug reports? Feature requests? Questions?\": \"<detail_content>\", \"Info for new developers\": \"<detail_content>\"}}, {\"title\": \"Contribute translation\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 8]\", \"content\": {\"The meaning of & in translations\": \"<detail_content>\"}}, {\"title\": \"Corrupted Installation\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 9]\", \"content\": {\"Corrupted installation\": \"<detail_content>\"}}, {\"title\": \"Customize External Viewers\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 10]\", \"content\": {\"Customize external viewers\": \"<detail_content>\"}}, {\"title\": \"Customize search / translation services\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 11]\", \"content\": {\"Adding more services\": \"<detail_content>\"}}, {\"title\": \"Customize Theme Colors\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 12]\", \"content\": {\"Customize theme (colors)\": \"<detail_content>\"}}, {\"title\": \"Customize toolbar\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 13]\", \"content\": {\"Using icons\": \"<detail_content>\"}}, {\"title\": \"Customizing eBook UI\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 14]\", \"content\": {\"Use advanced settings\": \"<detail_content>\", \"Use PDF UI for eBooks\": \"<detail_content>\"}}, {\"title\": \"Customizing keyboard shortcuts\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 15]\", \"content\": {\"Format of `Key` section:\": \"<detail_content>\", \"Commands\": \"<detail_content>\", \"Notes\": \"<detail_content>\"}}, {\"title\": \"DDE Commands\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 16]\", \"content\": {\"Format of DDE comands\": \"<detail_content>\", \"Sending DDE commands\": \"<detail_content>\", \"List of DDE commands:\": {\"Named commands\": \"<detail_content>\", \"Open file\": \"<detail_content>\", \"Forward-search\": \"<detail_content>\", \"Jump to named destination command\": \"<detail_content>\", \"Go to page\": \"<detail_content>\", \"Set view settings\": \"<detail_content>\"}}}, {\"title\": \"Debugging Sumatra\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 17]\", \"content\": {\"Getting logs\": \"<detail_content>\", \"Install necessary software\": \"<detail_content>\", \"Debugging a crash\": \"<detail_content>\", \"Debugging a hang\": \"<detail_content>\"}}, {\"title\": \"Editing annotations\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 18]\", \"content\": {\"Highlight text with `a`\": \"<detail_content>\", \"Saving annotations back to PDF file\": \"<detail_content>\", \"Open annotation editor\": \"<detail_content>\", \"Other annotations for selected text\": \"<detail_content>\", \"Other annotation types\": \"<detail_content>\", \"Annotation editor\": \"<detail_content>\", \"Select annotation from page in editor\": \"<detail_content>\", \"Moving annotations\": \"<detail_content>\", \"Customize highlight color\": \"<detail_content>\", \"Missing features\": \"<detail_content>\"}}, {\"title\": \"How to submit bug reports\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 19]\", \"content\": {\"Check in latest pre-release build\": \"<detail_content>\", \"Create an issue\": \"<detail_content>\", \"Provide a test file\": \"<detail_content>\", \"Provide reproduction steps\": \"<detail_content>\", \"Reporting crashes\": \"<detail_content>\"}}, {\"title\": \"How we store settings\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 20]\", \"content\": {\"Where we store settings\": \"<detail_content>\"}}, {\"title\": \"Installer Cmd Line Arguments\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 21]\", \"content\": {\"Installer cmd-line arguments\": \"<detail_content>\"}}, {\"title\": \"Is There A Virus In Sumatra Sources\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 22]\", \"content\": {\"Is there a virus in Sumatra sources?\": \"<detail_content>\"}}, {\"title\": \"Keyboard Shortcuts\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 23]\", \"content\": {\"Keyboard shortcuts\": \"<detail_content>\"}}, {\"title\": \"LaTeX integration\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 24]\", \"content\": {\"notepad++\": \"<detail_content>\", \"TexStudio\": \"<detail_content>\", \"TeXnicCenter\": \"<detail_content>\", \"Vim\": {\"forward-search\": \"<detail_content>\", \"backward-search\": \"<detail_content>\"}, \"WinEdt and Emacs\": \"<detail_content>\"}}, {\"title\": \"Logview\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 25]\", \"content\": {\"Download\": \"<detail_content>\", \"More info\": \"<detail_content>\"}}, {\"title\": \"Reporting Printing Bugs\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 26]\", \"content\": {\"Reporting printing bugs\": \"<detail_content>\"}}, {\"title\": \"Scrolling and navigating\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 27]\", \"content\": {\"Scrolling with keyboard\": \"<detail_content>\", \"Scrolling with mouse and touch pad\": \"<detail_content>\"}}, {\"title\": \"Set as default PDF viewer\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 28]\", \"content\": {\"Using File Explorer\": \"<detail_content>\", \"Using Default apps system settings\": \"<detail_content>\"}}, {\"title\": \"Source Code Downloads\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 29]\", \"content\": {\"Source code downloads\": \"<detail_content>\"}}, {\"title\": \"Submit Crash Report\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 30]\", \"content\": {\"Submit crash report`\": \"<detail_content>\"}}, {\"title\": \"Sumatrapdf Documentation\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 31]\", \"content\": {\"Documentation for users\": \"<detail_content>\", \"Misc\": \"<detail_content>\", \"Information for developers\": \"<detail_content>\", \"Downloads\": \"<detail_content>\", \"Feedback\": \"<detail_content>\"}}, {\"title\": \"Supported document formats\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 32]\", \"content\": {\"HEIF support\": \"<detail_content>\"}}, {\"title\": \"Uninstalling SumatraPDF\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 33]\", \"content\": {\"Are you using official Sumatra build?\": \"<detail_content>\", \"Uninstalling Sumatra\": \"<detail_content>\", \"Uninstalling portable version\": \"<detail_content>\", \"Uninstalling the installer version\": \"<detail_content>\", \"What if the above doesn't help?\": \"<detail_content>\"}}, {\"title\": \"Update Check Doesnt Work\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 34]\", \"content\": {\"Update check doesn't work?\": \"<detail_content>\"}}, {\"title\": \"Using Drmemory\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 35]\", \"content\": {\"Using DrMemory\": \"<detail_content>\"}}, {\"title\": \"Using Opencppcoverage\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 36]\", \"content\": {\"Using OpenCppCoverage\": \"<detail_content>\"}}, {\"title\": \"Version history\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 37]\", \"content\": {\"[RSS/Atom feed](https://github.com/sumatrapdfreader/sumatrapdf/releases)\": \"<detail_content>\", \"Version history\": {\"next (3.6)\": \"<detail_content>\", \"3.5.2 (2023-10-25)\": \"<detail_content>\", \"3.5.1 (2023-10-24)\": \"<detail_content>\", \"3.5 (2023-10-23)\": \"<detail_content>\", \"3.4.6 (2022-06-08)\": \"<detail_content>\", \"3.4.5 (2022-06-05)\": \"<detail_content>\", \"3.4.4 (2022-06-02)\": \"<detail_content>\", \"3.4.3 (2022-05-29)\": \"<detail_content>\", \"3.4.2 (2022-05-27)\": \"<detail_content>\", \"3.4.1 (2022-05-25)\": \"<detail_content>\", \"3.4 (2022-05-24)\": \"<detail_content>\", \"3.3.3 (2021-07-20)\": \"<detail_content>\", \"3.3.2 (2021-07-19)\": \"<detail_content>\", \"3.3.1 (2021-07-14)\": \"<detail_content>\", \"3.3 (2021-07-06)\": \"<detail_content>\", \"3.2 (2020-03-15)\": \"<detail_content>\", \"3.1.2 (2016-08-14)\": \"<detail_content>\", \"3.1.1 (2015-11-02)\": \"<detail_content>\", \"3.1 (2015-10-24)\": \"<detail_content>\", \"3.0 (2014-10-18)\": \"<detail_content>\", \"2.5.2 (2014-05-13)\": \"<detail_content>\", \"2.5.1 (2014-05-07)\": \"<detail_content>\", \"2.5 (2014-05-05)\": \"<detail_content>\", \"2.4 (2013-10-01)\": \"<detail_content>\", \"2.3.2 (2013-05-25)\": \"<detail_content>\", \"2.3.1 (2013-05-23)\": \"<detail_content>\", \"2.3 (2013-05-22)\": \"<detail_content>\", \"2.2.1 (2013-01-12)\": \"<detail_content>\", \"2.2 (2012-12-24)\": \"<detail_content>\", \"2.1.1 (2012-05-07)\": \"<detail_content>\", \"2.1 (2012-05-03)\": \"<detail_content>\", \"2.0.1 (2012-04-08)\": \"<detail_content>\", \"2.0 (2012-04-02)\": \"<detail_content>\", \"1.9 (2011-11-23)\": \"<detail_content>\", \"1.8 (2011-09-18)\": \"<detail_content>\", \"1.7 (2011-07-18)\": \"<detail_content>\", \"1.6 (2011-05-30)\": \"<detail_content>\", \"1.5.1 (2011-04-26)\": \"<detail_content>\", \"1.5 (2011-04-23)\": \"<detail_content>\", \"1.4 (2011-03-12)\": \"<detail_content>\", \"1.3 (2011-02-04)\": \"<detail_content>\", \"1.2 (2010-11-26)\": \"<detail_content>\", \"1.1 (2010-05-20)\": \"<detail_content>\", \"1.0.1 (2009-11-27)\": \"<detail_content>\", \"1.0 (2009-11-17)\": \"<detail_content>\", \"0.9.4 (2009-07-19)\": \"<detail_content>\", \"0.9.3 (2008-10-07)\": \"<detail_content>\", \"0.9.2 (2008-10-06)\": \"<detail_content>\", \"0.9.1 (2008-08-22)\": \"<detail_content>\", \"0.9 (2008-08-10)\": \"<detail_content>\", \"0.8.1 (2008-05-27)\": \"<detail_content>\", \"0.8 (2008-01-01)\": \"<detail_content>\", \"0.7 (2007-07-28)\": \"<detail_content>\", \"0.6 (2007-04-29)\": \"<detail_content>\", \"0.5 (2007-03-04)\": \"<detail_content>\", \"0.4 (2007-02-18)\": \"<detail_content>\", \"0.3 (2006-11-25)\": \"<detail_content>\", \"0.2 (2006-08-06)\": \"<detail_content>\", \"0.1 (2006-06-01)\": \"<detail_content>\"}}}, {\"title\": \"Why Only Windows\", \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 38]\", \"content\": {\"Why only Windows?\": \"<detail_content>\"}}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"sumatrapdf\", \"description\": \"Documentation for sumatrapdf\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWikiBench/data/sumatrapdf/original/docs\"}, \"subpages\": [{\"title\": \"Md\", \"description\": \"Documentation section: md\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/sumatrapdf/original/docs/md\"}, \"subpages\": [{\"title\": \"Accessibility and Text-to-Speech\", \"description\": null, \"content\": {\"Accessibility in SumatraPDF plugin\": \"Accessibility features are considered experimental and accessibility is not enabled at the moment in the SumatraPDF plugin.\", \"Usage\": {\"Microsoft Narrator\": [\"Start Microsoft Narrator\", \"Start SumatraPDF\", \"Open document in SumatraPDF\", \"Select text. Microsoft Narrator will now read out the selected text.\"]}, \"Supported configurations\": {\"Supported file types\": \"PDF, XPS, DjVu\", \"Supported Clients\": [\"Microsoft Narrator\"], \"Unsupported Clients\": [\"[NVDA](https://community.nvda-project.org/)\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}, {\"title\": \"Advanced Options Settings\", \"description\": null, \"content\": {\"Advanced options / settings\": \"SumatraPDF has many [advanced settings](https://www.sumatrapdfreader.org/settings/settings) to customize look and behavior.\\n\\nTo open advanced settings file:\\n\\n['menu `Settings` / `Advanced options...`', 'or with Command Palette: `Ctrl + K`, type `adv` to narrow down to command, press `Enter` to select `Advanced Options...` command']\\n\\nThis opens a settings text file in default .txt editor. Make changes and save the file.\\n\\nTo reset to default settings, delete settings file. SumatraPDF will re-create it with default values.\\n\\nMost settings take effect immediately after saving the settings file. Some settings (e.g. `UseTabs`) require closing and re-starting SumatraPDF.\\n\\nDocumentation for all settings is at [https://www.sumatrapdfreader.org/settings/settings](https://www.sumatrapdfreader.org/settings/settings)\\n\\nHere are some things you can customize:\\n\\n['[keyboard shortcuts](Customizing-keyboard-shortcuts.md)', 'width of tab with `Tab Width`', 'window background color with `FixedPageUI.BackgroundColor`', 'color used to highlight text with `FixedPageUI.SelectionColor`', 'hide scrollbars with `FixedPageUI.HideScrollbars`']\\n\\nAdvanced settings file also stores the history and state of opened files so that we can e.g. re-open on the page\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 1]\"}, {\"title\": \"Build system\", \"description\": null, \"content\": {\"When to run premake\": \"Premake re-generates Visual Studio project files from `premake5.*.lua` files.\\n\\nYou only need to do that if you add or remove source files.\\n\\nTo re-generate:\\n\\n['install [Go](https://golang.org/)', 'make changes to `premake5.*.lua` files, most likely `premake5.files.lua`', 'run `.\\\\\\\\doit.bat -premake` which runs a Go program in `do` directory with `-premake` flag']\\n\\nRelevant files:\\n\\n```\\nPS C:\\\\Users\\\\kjk\\\\src\\\\sumatrapdf> ls *.lua\\nMode LastWriteTime Length Name\\n---- ------------- ------ ----\\n-a---- 4/24/2020 12:20 AM 22947 premake5.files.lua\\n-a---- 5/4/2020 7:51 PM 23565 premake5.lua\\n```\", \"Customizing build\": \"Sometimes we want to customize the build with `#ifdef`. We could do it by adding additional configurations, but that can spiral out of control quickly.\\n\\nInstead we have `src\\\\utils\\\\BuildConfig.h` file. It's empty by default but you can changed it to add your `#define` customization.\", \"Build variants\": \"We have `Debug`, `Release` and `ReleaseAnalyze` configurations. `ReleaseAnalyze` runs code analysis.\\n\\nWe have platforms:\\n\\n['`Win32` : 32-bit build', '`x64` : 64-bit build', '`x64_asan` : 64-build with additional runtime [Address Sanitizers](https://devblogs.microsoft.com/cppblog/addresssanitizer-asan-for-windows-with-msvc/) checks. Only 64-bit build for simplicity']\", \"How official builds are made\": \"I use a Go program in `do` directory, executed with `.\\\\doit.bat -build-pre-rel` or `.\\\\doit.bat -build-release`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 2]\"}, {\"title\": \"Command Palette\", \"description\": null, \"content\": {\"Command Palette\": \"**Available in version 3.4 or later.**\\n\\nUse `Ctrl + K` to invoke command palette:\\n\\n\\n\\nCommand palette is fast and convenient way to:\\n\\n['access all SumatraPDF functionality', 'open previously opened files', 'switch to another tab']\\n\\nHow to use it:\\n\\n['press\\\\xa0`Ctrl-K`\\\\xa0to show command palette window', 'enter text to narrow down list of matches', '`up` / `down` arrow navigate between matches', '`Enter`\\\\xa0to execute selected match (or double-click with mouse)', '`Escape`\\\\xa0to close the window (or click outside of it)']\\n\\nThe list contains:\\n\\n['list of currently opened files (tabs)', 'list of recently opened files', '[commands](Commands.md)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 3]\"}, {\"title\": \"Command-line arguments\", \"description\": null, \"content\": {\"List of command line options\": [\"`-presentation` : start in presentation view\", \"`-fullscreen` : start in full screen view\", \"`-new-window` : when opening a file, always open it in a new window, as opposed to in a tab (**ver 3.2+**)\", \"`-appdata <directory>` : set custom directory where we'll store `SumatraPDF-settings.txt` file and thumbnail cache\", \"`-restrict` : runs in restricted mode where you can disable features that require access to file system, registry and the internet. Useful for kiosk-like usage. Read more detailed documentation.\"], \"Navigation options\": [\"`-named-dest <destination-name>` : searches the first indicated file for a destination or a table-of-contents entry (or starting with version 3.1 also a page label) matching destination-name and scrolls the document to it. Combine with -reuse-instance if the document is already open.\", \"`-page <pageNo>` : scrolls the first indicated file to the indicated page. Combine with -reuse-instance if the document is already open.\", \"`-view <view-mode>` : set view mode for the first indicated file. Available view modes:\", [\"`\\\"single page\\\"`\", \"`\\\"continuous single page\\\"`\", \"`facing`\", \"`\\\"continuous facing\\\"`\", \"`\\\"book view\\\"`\", \"`\\\"continuous book view\\\"`\"], \"Notice that options with space have to be surrounded by \\\"\\\" quotes.\", \"Combine with `-reuse-instance` if the document is already open.\", \"`-zoom <zoom-level>` : Sets the zoom level for the first indicated file. Alternatives are \\\"fit page\\\", \\\"fit width\\\", \\\"fit content\\\" or any percentage value. Combine with -reuse-instance if the document is already open.\", \"`-scroll <x,y>` : Scrolls to the given coordinates for the first indicated file. Combine with `-reuse-instance` if the document is already open.\", \"`search <term>` : Start a search for a given term when opening a document e.g. `SumatraPDF.exe -search \\\"foo\\\" bar.pdf`. **Ver 3.4+**\"], \"Send DDE commands\": [\"`-dde cmd` : send [DDE commands](DDE-Commands.md) to currently running instance e.g. `-dde '[Open(\\\"C:\\\\Users\\\\kjk\\\\foo.pdf\\\")]'`. Make sure to properly quote arguments. File paths must be absolute. **Ver 3.5+**.\"], \"Printing options\": [\"`-print-to-default` : prints all files indicated on this command line to the system default printer. After printing, SumatraPDF exits immediately (check the error code for failure).\", \"`-print-to <printer-name>` : prints all files indicated on this command line to the named printer. After printing, SumatraPDF exits immediately (check the error code for failure). E.g. `-print-to \\\"Microsoft XPS Document Writer\\\"` prints all indicated files to the XPS virtual printer.\", \"`-print-settings <settings-list>`\", [\"used in combination with `-print-to` and `-print-to-default`. Allows to tweak some of the printing related settings without using the Print dialog. The settings-list is a comma separated list of page ranges and advanced options such as\", [\"`even` or `odd`.\", \"`portrait` or `landscape` : can provide 90 degree rotation of contents (NOT the rotation of paper which must be pre-set by the choice of printer defaults)\", \"`noscale`, `shrink` and `fit`\", \"`color` or `monochrome`\", \"`duplex`, `duplexshort`, `duplexlong` and `simplex`\", \"`bin=<num or name>` : select tray to print to\", \"`paper=<page size>` : page size is `A2`, `A3`, `A4`, `A5`, `A6`, `letter`, `legal`, `tabloid`, `statement`\"], \"e.g. `-print-settings \\\"1-3,5,10-8,odd,fit,bin=2\\\"` prints pages 1, 3, 5, 9 (i.e. the odd pages from the ranges 1-3, 5-5 and 10-8) and scales them so that they fit into the printable area of the paper.\", \"`-print-settings \\\"3x\\\"` : prints the document 3 times\"], \"`-silent` : used in combination with `-print-to` and `-print-to-default`. Silences any error messages related to command line printing.\", \"`-print-dialog` : displays the Print dialog for all the files indicated on this command line.\", \"`-exit-when-done` : used in combination with `-print-dialog` (and `-stress-test`). Exits SumatraPDF after the Print dialog has been dismissed and the document printed.\"], \"Options related to forward/inverse search (for LaTeX editors)\": [\"`-forward-search \\\"<sourcepath>\\\" <line> \\\"<pdfpath>\\\"`: performs a forward search from a LaTeX source file to a loaded PDF document (using PdfSync or SyncTeX). This is an alternative to the ForwardSearch DDE command. E.g. -forward-search \\\"/path/to/main.tex\\\" 123 \\\"/path/to/main.pdf\\\" highlights all text related to line 123 in main.tex.\", \"`-reuse-instance` : tells an already open SumatraPDF to load the indicated files. If there are several running instances, behavior is undefined. Only needed when communicating with SumatraPDF through DDE (use the ReuseInstance setting instead otherwise).\", \"`-inverse-search <command-line>` : sets the command line to be used for performing an inverse search from a PDF document (usually back to a LaTeX source file). The inverse search command line can also be set from the Setting dialog. Use the variable %f for the current filename and %l for the current line.\\n[Deprecated]: This setting is exposed in the Options dialog after the first PDF document with corresponding .synctex or .pdfsync file has been loaded. Alternatively, use the corresponding advanced setting instead.\", \"`-fwdsearch-offset <offset> -fwdsearch-width <width> -fwdsearch-color <hexcolor> -fwdsearch-permanent <flag>` : allows to customize the forward search highlight. Set the offset to a positive number to change the highlight style to a rectangle at the left of the page (instead of rectangles over the whole text). The flag for `-fwdsearch-permanent` can be 0 (make the highlight fade away, default) or 1.\\n[Deprecated]: Use the corresponding advanced settings instead.\"], \"Developer options\": [\"`-console` : Opens a console window alongside SumatraPDF for accessing (MuPDF) debug output.\", \"`-stress-test <path> [file-filter] [range] [cycle-count]`\", [\"Renders all pages of the indicated file/directory for stability and performance testing. E.g.:\"], \"```\\n-stress-test file1.pdf 25x\\n-stress-test file2.pdf 1-3\\n-stress-test dir *.pdf;*.xps 15- 3x\\n```\", \"renders file1.pdf 25 times, renders pages 1 to 3 of file2.pdf and renders all but the first 14 PDF and XPS files from dir 3 times.\", \"`-bench <filepath> [page-range]` : Renders all pages (or just the indicated ones) for the given file and then outputs the required rendering times for performance testing and comparisons. Often used together with `-console`.\"], \"Deprecated options\": \"The following options just set values in the settings file and may be removed in any future version:\\n\\n['`-bg-color <hexcolor>` : changes the yellow background color to a different color. See e.g. [html-color-codes.info](https://html-color-codes.info/) for a way to generate the hexcode for a color. E.g. `-bg-color #999999` changes the color to gray.\\\\n[Deprecated]: Use [MainWindowBackground](https://www.sumatrapdfreader.org/settings/settings.html#MainWindowBackground) setting instead.', '`-esc-to-exit` : enables the Escape key to quit SumatraPDF. Deprecated: Use the [EscToExit](https://www.sumatrapdfreader.org/settings.html#EscToExit) setting instead.', '`-set-color-range <text-hexcolor> <background-hexcolor>` : Uses the given two colors for foreground and background and maps all other colors used in a document in between these two. E.g. `-set-color-range #dddddd #333333` displays soft white text on a dark gray background. [Deprecated]: Use the TextColor and BackgroundColor settings for FixedPageUI instead.', '`-lang <language-code>` : sets the UI language. See [/scripts/trans_langs.py] (https://github.com/sumatrapdfreader/sumatrapdf/blob/master/scripts/trans_langs.py) for the list of available language codes. E.g. -lang de. [Deprecated]: Use the `UiLanguage` setting instead.', '`-manga-mode <mode>` : enables or disables \\\"Manga mode\\\" for reading (mainly Japanese) comic books from right to left. Mode must be \\\"true\\\" or 1 for enabling and \\\"false\\\" or 0 for disabling this feature.', '`-invert-colors`']\\n\\nDeprecated: Use the [CbxMangaMode](https://www.sumatrapdfreader.org/settings.html#ComicBookUI_CbxMangaMode) setting for ComicBookUI instead.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 4]\"}, {\"title\": \"Commands\", \"description\": null, \"content\": {\"File\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdClose,\\\"Ctrl + W,\\u00a0Ctrl + F4\\\",Close Document,\\nCmdCloseCurrentDocument,q,Close Current Document,\\nCmdCommandPalette,Ctrl + K,Command Palette,\\nCmdDuplicateInNewWindow,Shift + Ctrl + N,Open Current Document In New Window,\\nCmdExit,Ctrl + Q,Exit Application,\\nCmdMoveFrameFocus,F6,Move Frame Focus,\\nCmdNewWindow,Ctrl + N,Open New SumatraPDF Window,\\nCmdOpenFile,Ctrl + O,Open File...,\\nCmdOpenNextFileInFolder,Shift + Ctrl + Right,Open Next File In Folder,\\nCmdOpenPrevFileInFolder,Shift + Ctrl + Left,Open Previous File In Folder,\\nCmdOpenSelectedDocument,,Open Selected Document,\\nCmdPinSelectedDocument,,Pin Selected Document,\\nCmdPrint,Ctrl + P,Print Document...,\\nCmdProperties,Ctrl + D,Show Document Properties...,\\nCmdReloadDocument,r,Reload Document,\\nCmdRenameFile,F2,Rename File...,\\nCmdReopenLastClosedFile,Shift + Ctrl + T,Reopen Last Closed,\\nCmdSaveAs,Ctrl + S,Save File As...,\\nCmdToggleCursorPosition,m,Toggle Cursor Position,\\nCmdShowInFolder,,Show File In Folder...,\\nCmdToggleBookmarks,\\\"Shift + F12,\\u00a0F12\\\",Toggle Bookmarks,\\nCmdToggleTableOfContents,,Toggle Table Of Contents,ver 3.6+\\nCmdCollapseAll,,Collapse All,\\nCmdExpandAll,,Expand All,\\nCmdOpenEmbeddedPDF,,Open Embedded PDF,\\nCmdSaveEmbeddedFile,,Save Embedded File...,\\nCmdCreateShortcutToFile,,Create .lnk Shortcut,\\nCmdSelectAll,Ctrl + A,Select All,\\nCmdCopyComment,,Copy Comment,\\nCmdCopyImage,,Copy Image,\\nCmdCopyLinkTarget,,Copy Link Target,\\nCmdCopySelection,\\\"Ctrl + C,\\u00a0Ctrl + Insert\\\",Copy Selection,\\nCmdCopyFilePath,,Copy File Path,ver 3.5+\\nCmdDeleteFile,,Delete Currently Opened File, ver 3.6+\\n```\", \"Search\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdFindFirst,Ctrl + F,Find\\nCmdFindMatch,,Find: Match Case\\nCmdFindNext,F3,Find Next\\nCmdFindNextSel,Ctrl + F3,Find Next Selection\\nCmdFindPrev,Shift + F3,Find Previous\\nCmdFindPrevSel,Shift + Ctrl + F3,Find Previous Selection\\n```\", \"Viewing\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdBookView,Ctrl + 8,Book View,\\nCmdFacingView,Ctrl + 7,Facing View,\\nCmdInvertColors,i,Invert Colors,\\nCmdRotateLeft,\\\"[,\\u00a0Shift + Ctrl + Subtract\\\",Rotate Left,\\nCmdRotateRight,\\\"],\\u00a0Shift + Ctrl + Add\\\",Rotate Right,\\nCmdSinglePageView,Ctrl + 6,Single Page View,\\nCmdToggleContinuousView,c,Toggle Continuous View,\\nCmdToggleFullscreen,\\\"f,\\u00a0Shift + Ctrl + L,\\u00a0F11\\\",Toggle Fullscreen,\\nCmdToggleMangaMode,,Toggle Manga Mode,\\nCmdToggleMenuBar,F9,Toggle Menu Bar,\\nCmdTogglePageInfo,Shift + i,Show / Hide Current Page Number,\\nCmdToggleScrollbars,,Toggle Scrollbars,\\nCmdToggleToolbar,F8,Toggle Toolbar,\\nCmdToggleFrequentlyRead,,Toggle Frequently Read,ver 3.5+\\nCmdSelectNextTheme,,Select Next Theme,ver 3.5+\\nCmdToggleLinks,,Toggle Show Links, Toggle drawing blue rectangle around links\\n```\", \"Tabs\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdCloseAllTabs,,Close All Tabs,ver 3.6+\\nCmdCloseTabsToTheLeft,,Close Tabs To The Left,ver 3.6+\\nCmdCloseTabsToTheRight,,Close Tabs To The Right,ver 3.6+\\nCmdCloseOtherTabs,,Close Other Tabs,ver 3.6+\\nCmdNextTab,Ctrl + PageUp,Next Tab,\\nCmdPrevTab,Ctrl + PageDown,Previous Tab,\\nCmdMoveTabRight,Ctrl + Shift + PageUp,Move Tab Right,ver 3.6+\\nCmdMoveTabLeft,Ctrl + Shift + PageDown,Move Tab Left,ver 3.6+\\nCmdNextTabSmart,Ctrl + Tab,Smart tab Switch,ver 3.6+\\nCmdPrevTabSmart,Ctrl + Shift + Tab,Smart tab Switch,ver 3.6+\\n```\", \"Navigation\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdScrollUp,\\\"k,\\u00a0Up\\\",Scroll Up\\nCmdScrollDown,\\\"j,\\u00a0Down\\\",Scroll Down\\nCmdScrollLeft,\\\"h,\\u00a0Left\\\",Scroll Left\\nCmdScrollRight,\\\"l,\\u00a0Right\\\",Scroll Right\\nCmdScrollUpHalfPage,Shift + Up,Scroll Up By Half Page\\nCmdScrollDownHalfPage,Shift + Down,Scroll Down By Half Page\\nCmdScrollUpPage,\\\"Ctrl + Up,\\u00a0PageUp,\\u00a0Shift + Return,\\u00a0Shift + Space\\\",Scroll Up By Page\\nCmdScrollDownPage,\\\"Ctrl + Down,\\u00a0PageDown,\\u00a0Return,\\u00a0Space\\\",Scroll Down By Page\\nCmdScrollLeftPage,Shift + Left,Scroll Left By Page\\nCmdScrollRightPage,Shift + Right,Scroll Right By Page\\nCmdGoToFirstPage,\\\"Ctrl + Home,\\u00a0Home\\\",First Page\\nCmdGoToLastPage,\\\"Ctrl + End,\\u00a0End\\\",Last Page\\nCmdGoToPrevPage,\\\"p\\\",Previous Page\\nCmdGoToNextPage,\\\"n\\\",Next Page\\nCmdGoToPage,\\\"g,\\u00a0Ctrl + G\\\",Go to Page...\\nCmdNavigateBack,\\\"Alt + Left,\\u00a0Backspace\\\",Navigate Back\\nCmdNavigateForward,\\\"Alt + Right,\\u00a0Shift + Backspace\\\",Navigate Forward\\n```\", \"Favorites\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdFavoriteAdd,Ctrl + B,Add Favorite\\nCmdFavoriteDel,,Delete Favorite\\nCmdFavoriteToggle,,Toggle Favorites\\n```\", \"Presentation\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdTogglePresentationMode,\\\"Ctrl + L,\\u00a0Shift + F11,\\u00a0F5\\\",View: Presentation Mode\\nCmdPresentationBlackBackground,.,Presentation Black Background\\nCmdPresentationWhiteBackground,w,Presentation White Background\\n```\", \"Annotations\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdCreateAnnotCaret,,Create Caret Annotation,\\nCmdCreateAnnotCircle,,Create Circle Annotation,\\nCmdCreateAnnotFileAttachment,,Create File Attachment Annotation,\\nCmdCreateAnnotFreeText,,Create Free Text Annotation,\\nCmdCreateAnnotHighlight,\\\"a,\\u00a0A\\\",Create Highlight Annotation,\\nCmdCreateAnnotInk,,Create Ink Annotation,\\nCmdCreateAnnotLine,,Create Line Annotation,\\nCmdCreateAnnotLink,,Create Link Annotation,\\nCmdCreateAnnotPolygon,,Create Polygon Annotation,\\nCmdCreateAnnotPolyLine,,Create Poly Line Annotation,\\nCmdCreateAnnotPopup,,Create Popup Annotation,\\nCmdCreateAnnotRedact,,Create Redact Annotation,\\nCmdCreateAnnotSquare,,Create Square Annotation,\\nCmdCreateAnnotSquiggly,,Create Squiggly Annotation,\\nCmdCreateAnnotStamp,,Create Stamp Annotation,\\nCmdCreateAnnotStrikeOut,,Create Strike Out Annotation,\\nCmdCreateAnnotText,,Create Text Annotation,\\nCmdCreateAnnotUnderline,\\\"u,\\u00a0U\\\",Create Underline Annotation,\\nCmdDeleteAnnotation,Delete,Delete Annotation,\\nCmdEditAnnotations,,Edit Annotations,\\nCmdSaveAnnotations,Shift + Ctrl + S,Save Annotations to existing PDF,\\nCmdSaveAnnotationsNewFile,,Save Annotations to new PDF,ver 3.6+\\n```\", \"Zoom\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdToggleZoom,z,Toggle Zoom,\\nCmdZoomActualSize,Ctrl + 1,Zoom: Actual Size,\\nCmdZoomCustom,Ctrl + Y,Zoom: Custom...,\\nCmdZoomFitContent,Ctrl + 3,Zoom: Fit Content,\\nCmdZoomFitPage,Ctrl + 0,Zoom: Fit Page,\\nCmdZoomFitPageAndSinglePage,,Zoom: Fit Page and Single Page,\\nCmdZoomFitWidth,Ctrl + 2,Zoom: Fit Width,\\nCmdZoomFitWidthAndContinuous,,Zoom: Fit Width And Continuous,\\nCmdZoomIn,Ctrl + Add,Zoom In,\\nCmdZoomOut,Ctrl + Subtract,Zoom Out,\\nCmdZoom100,,Zoom: 100%,\\nCmdZoom12_5,,Zoom: 12.5%,\\nCmdZoom125,,Zoom: 125%,\\nCmdZoom150,,Zoom: 150%,\\nCmdZoom1600,,Zoom: 1600%,\\nCmdZoom200,,Zoom: 200%,\\nCmdZoom25,,Zoom: 25%,\\nCmdZoom3200,,Zoom: 3200%,\\nCmdZoom400,,Zoom: 400%,\\nCmdZoom50,,Zoom: 50%,\\nCmdZoom6400,,Zoom: 6400%,\\nCmdZoom8_33,,Zoom: 8.33%,\\nCmdZoom800,,Zoom: 800%,\\n```\", \"External app\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette,Notes\\nCmdOpenWithExplorer,,Open Directory In Explorer,ver 3.5+\\nCmdOpenWithDirectoryOpus,,Open Directory In Directory Opus,ver 3.5+\\nCmdOpenWithTotalCommander,,Open Directory In Total Commander,ver 3.5+\\nCmdOpenWithDoubleCommander,,Open Directory In Double Commander,ver 3.5+\\nCmdOpenWithAcrobat,,Open in Adobe Acrobat,\\nCmdOpenWithFoxIt,,Open in Foxit Reader,\\nCmdOpenWithFoxItPhantom,,Open in Foxit Phantom,\\nCmdOpenWithHtmlHelp,,Open in Microsoft HTML Help,\\nCmdOpenWithPdfDjvuBookmarker,,Open in Pdf&Djvu Bookmarker,\\nCmdOpenWithPdfXchange,,Open in PDF-XChange,\\nCmdOpenWithXpsViewer,,Open in Microsoft Xps Viewer,\\nCmdTranslateSelectionWithDeepL,,Translate Selection With DeepL,\\nCmdTranslateSelectionWithGoogle,,Translate Selection with Google,\\nCmdSearchSelectionWithBing,,Search Selection with Bing,\\nCmdSearchSelectionWithGoogle,,Search Selection with Google,\\nCmdSearchSelectionWithWikipedia,,Search Selection with Wikipedia,ver 3.6+\\nCmdSearchSelectionWithGoogleScholar,,Search Selection with Goolge Scholar,ver 3.6+\\nCmdSendByEmail,,Send Document By Email...,\\nCmdInvokeInverseSearch,,Invoke Inverse Search,ver 3.6+\\n\\n```\", \"System\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdAdvancedOptions,,Advanced Options (Settings)...\\nCmdAdvancedSettings,,Advanced Options (Settings)...\\nCmdChangeLanguage,,Change Language...\\nCmdCheckUpdate,,Check For Updates\\nCmdClearHistory,,Clear History\\nCmdContributeTranslation,,Contribute Translation\\nCmdForgetSelectedDocument,,Remove Selected Document From History\\nCmdOptions,,Options...\\nCmdShowLog,,Show Logs\\n```\", \"Help\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdHelpOpenManual,F1,Help: Manual\\nCmdHelpOpenKeyboardShortcuts,,Help: Keyboard Shortcuts\\nCmdHelpAbout,,Help: About SumatraPDF\\nCmdHelpOpenManualOnWebsite,,Help: Manual On Website\\nCmdHelpVisitWebsite,,Help: SumatraPDF Website\\n```\", \"Debug\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdDebugCrashMe,,Debug: Crash Me\\nCmdDebugDownloadSymbols,,Debug: Download Symbols\\nCmdDebugShowNotif,,Debug: Show Notification\\nCmdDebugStartStressTest,,Debug: Start Stress Test\\nCmdDebugTestApp,,Debug: Test App\\nCmdDebugTogglePredictiveRender,,Debug: Toggle Predictive Rendering\\nCmdDebugToggleRtl,,Debug: Toggle Rtl\\nCmdNone,,Do nothing\\n```\", \"Deprecated or internal\": \"```\\nCommand IDs,Keyboard shortcuts,Command Palette\\nCmdDebugCorruptMemory,,don't use\\nCmdOpenWithKnownExternalViewerFirst,,don't use\\nCmdOpenWithKnownExternalViewerLast,,don't use\\nCmdSelectionHandler,,use SelectionHandlers advanced setting instead\\nCmdSetTheme,,don't use\\nCmdViewWithExternalViewer,,don't use\\nCmdSaveAttachment,,don't use\\nCmdOpenAttachment,,don't use\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 5]\"}, {\"title\": \"Configure For Restricted Use\", \"description\": null, \"content\": {\"Configure for restricted use\": \"SumatraPDF can be configured for restricted use. \\n\\nA restricted mode is useful if you want to use SumatraPDF as a bundled viewer for your program's documentation or in kiosk mode\\n\\nIn restricted mode some actions that are not appropriate in such context are disabled:\\n\\n['opening new files', 'launching URLs from with PDF document', 'text and image selection', 'printing', 'changing default settings', 'saving to disk', 'automatic and manual update checks', 'a history of recently opened files', 'TeX preview support', 'registering as a default PDF viewer', 'opening with Adobe Acrobat', 'e-mailing PDF']\\n\\nTo restrict SumatraPDF put file `sumatrapdfrestrict.ini` in the same directory where `SumatraPDF.exe` is.\\n\\nHere's a [full documentation of available options](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/docs/sumatrapdfrestrict.ini).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 6]\"}, {\"title\": \"Contribute to SumatraPDF\", \"description\": null, \"content\": {\"Getting the sources and compiling\": \"You'll need latest Visual Studio. A [free Community edition](https://www.visualstudio.com/vs/community/) will work.\\n\\nGet the sources from [https://github.com/sumatrapdfreader/sumatrapdf](https://github.com/sumatrapdfreader/sumatrapdf)\\n\\nOpen `vs2022/SumatraPDF.sln` compile and run.\\n\\nRead more about our [build system](Build-system.md).\", \"Contribute to SumatraPDF\": \"We use a standard GitHub model:\\n\\n['fork [https://github.com/sumatrapdfreader/sumatrapdf](https://github.com/sumatrapdfreader/sumatrapdf)', 'submit pull request', \\\"I'll review the code, provide the feedback and merge it when it's ready\\\"]\\n\\nBefore you start working on a significant addition, it's a good idea to first discuss it in [issue tracker](https://github.com/sumatrapdfreader/sumatrapdf/issues).\", \"Bug reports? Feature requests? Questions?\": \"You can use [issue tracker](https://github.com/sumatrapdfreader/sumatrapdf/issues) for development related topics or [forums](https://www.sumatrapdfreader.org/forum.html) for general topics.\", \"Info for new developers\": \"Info to orient new developers to Sumatra code base.\\n\\nYou should install Go ([https://golang.org/dl/](https://golang.org/dl/)).\\n\\nMany tasks are automated with Go program in `do` directory. Run `doit.bat` for easy running of that program. use different cmd-line args to trigger different functions.\\n\\nTo build, use latest Visual Studio and open `vs2022\\\\SumatraPDF.sln` solution. Look at different targets and configurations.\\n\\nDon't edit the solution directly. To learn how to make changes (add files, change compilation flags etc.) see info about [build system](Build-system.md).\\n\\nWe use [GitHub Actions](https://help.github.com/en/actions) for a CI system. See `.github` directory. Most importantly it builds a 64-bit release version on every checkin to catch build errors and uploads it to storage and makes available via [https://www.sumatrapdfreader.org/prerelease](https://www.sumatrapdfreader.org/prerelease)\\n\\nOverview of the directories:\\n\\n['`src` : main Sumatra code', '`mupdf` : library used to parse / render PDF files (from [https://mupdf.com/](https://mupdf.com/))', '`ext` : other third-party libraries (some are needed for mupdf, some for Sumatra code)', '`do` : Go program that automates common tasks. Invoke with `doit.bat`']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 7]\"}, {\"title\": \"Contribute translation\", \"description\": null, \"content\": {\"The meaning of & in translations\": \"& means that the following character is the hot key. For example, `&File` means that `f` key is a hot key in menu items etc. Hot keys are rendered with underline in menu items (although it can be disabled system-wide).\\n\\nYou don\\u2019t have to add hot keys in translations - those are for convenience and easier use with a keyboard.\\n\\nIn translated text a different character could be an accelerator.\\n\\nSee [https://github.com/sumatrapdfreader/sumatrapdf/discussions/2919](https://github.com/sumatrapdfreader/sumatrapdf/discussions/2919) for more information.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 8]\"}, {\"title\": \"Corrupted Installation\", \"description\": null, \"content\": {\"Corrupted installation\": \"If you're reading this, you might have been told by SumatraPDF that you have a corrupted installation.\\n\\n**How can that happen?**\\n\\nSumatraPDF comes in two flavors: a portable version and an installer.\\n\\nA portable version is a self-contained executable and cannot be corrupted.\\n\\nAn installer needs to be run to be properly installed. Part of it is extracting `libmupdf.dll` library.\\n\\nThere are 2 possible problem:\\n\\n['`libmupdf.dll` is missing', \\\"`libmupdf.dll` is there but its version doesn't match the version of `SumatraPDF.exe`\\\"]\\n\\n**How to solve the problem?**\\n\\nIf you want to place SumatraPDF in any location, under any name, use the self-contained portable flavor.\\n\\nIf you insist on using the installable version, just install it. The installer will run if it has `-install` in the name of the .exe (which it will if you download [official build](https://www.sumatrapdfreader.org/download-free-pdf-viewer)).\\n\\nIf you rename the `.exe`, you can force running the installer with `-install` option.\\n\\nAlternatively, you can extract `libmupdf.dll` and all other files with `-x` option.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 9]\"}, {\"title\": \"Customize External Viewers\", \"description\": null, \"content\": {\"Customize external viewers\": \"SumatraPDF makes it easy for you to open current document in a different program.\\n\\nFor example, if you also have Adobe Reader installed, you can use `File` menu to open PDF document you're viewing in Adobe Reader. We auto-detect some popular apps (Adobe, Foxit, PDF X-Change etc.).\\n\\nYou can add custom viewers using [advanced settings](https://www.sumatrapdfreader.org/settings/settings.html).\\n\\nTo configure an external viewer:\\n\\n['use `Settings / Advanced Settings...` menu to open configuration file', 'modify`ExternalViewers` section']\\n\\nRelevant settings:\\n\\n```\\nExternalViewers [\\n [\\n CommandLine =\\n Name =\\n Filter =\\n\\n // ver 3.6+:\\n Key = \\n ]\\n]\\n```\\n\\nExample:\\n\\n```\\nExternalViewers [\\n [\\n CommandLine = \\\"C:\\\\Program Files\\\\FoxitReader\\\\FoxitReader.exe\\\" /A page=%p \\\"%1\\\"\\n Name = Foxit &Reader\\n Filter = *.pdf\\n Key = Ctrl + m\\n ]\\n]\\n```\\n\\n`CommandLine` is a full path of executable to open a file with arguments.\\n\\nArguments can use special values:\\n\\n['`\\\"%1\\\"` : will be replaced with a full path of the current document', '`%p` : will be replaced with current page number. Not all viewers support page numbers', '`\\\"%d\\\"` : will be replaced with directory of the current document. Useful for launching file managers. Available in version **3.5** and later']\\n\\nPlease make sure to use quotes around file / directory special values (i.e. `\\\"%1\\\"` and `\\\"%d\\\"`) to avoid issues with file paths that have spaces in them.\\n\\n`Name` will be displayed in `File` menu.\\n\\n`Filter` restricts which files can be opened by the reader. For example:\\n\\n['to only activate it for PDF files, use `*.pdf`', 'to activate for PNG and JPEG files, use `*.png;*.jpg;*.jpeg`', 'to allow all files, use `*` (useful for file managers)']\\n\\n`Key` is optional and is a keyboard shortcut to invoke that viewer. Available in **3.6** and later.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 10]\"}, {\"title\": \"Customize search / translation services\", \"description\": null, \"content\": {\"Adding more services\": \"You can add more web services using [advanced settings](https://www.sumatrapdfreader.org/settings/settings.html).\\n\\nTo configure an external reader:\\n\\n['use `Settings / Advanced Settings...` menu to open configuration file', 'modify `SelectionHandlers` section']\\n\\nHere's an example of adding [DuckDuckGo](https://duckduckgo.com/) search engine:\\n\\n```\\nSelectionHandlers [\\n [\\n URL = https://duckduckgo.com/?ia=web&q=${selection}\\n Name = &DuckDuckGo\\n Key = Ctrl + t\\n ]\\n]\\n```\\n\\n`URL` is the website that will be launched. `${selection}` will be replaced with (URL-encoded) current selection.\\n\\n`Name` is what shows in the menu. You can use `&` characters to add Windows hot-key for keyboard-only invocation.\\n\\n**Ver3.6+**: `Key` is a keyboard shorcut in the same format as in [Shortcuts](Customizing-keyboard-shortcuts.md) advanced setting.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 11]\"}, {\"title\": \"Customize Theme Colors\", \"description\": null, \"content\": {\"Customize theme (colors)\": \"**Available in version 3.6 or later.**\\n\\nYou can change colors of SumatraPDF UI by creating a custom theme using `Themes` [advanced setting](Advanced-options-settings.md).\\n\\nTo create a theme:\\n\\n['use `Settings` / `Advanced Options...` menu (or `Ctrl + K` Command Palette, type `adv` to narrow down and select `Advanced Options...` command)', 'this opens default .txt editor with advanced settings file', 'find `Themes` array and add new shortcut definitions']\\n\\nExample of customization:\\n\\n```\\nThemes [\\n [\\n Name = My Dark Theme\\n TextColor = #bac9d0\\n BackgroundColor = #263238\\n ControlBackgroundColor = #263238\\n LinkColor = #8aa3b0\\n ColorizeControls = true\\n ]\\n]\\n```\\n\\n`TextColor` and `BackgroundColor` are for main window color and color of text.\\n\\nIf you use `I` (`CmdInvertColors`) they will also be used to replace white background / black text color when renderign PDF/ePub documents.\\n\\n`ControlBackgroundColor` is for background of Windows controls (buttons, window frame, menus, list controls etc.).\\n\\n`LinkColor` is a color for links. Typically it's blue.\\n\\n`ColorizeControls` should be `true`. If `false` we won't try to change colors of standard windows controls (menu, toolbar, buttons etc.) so a lot of UI will not respect theme colors.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 12]\"}, {\"title\": \"Customize toolbar\", \"description\": null, \"content\": {\"Using icons\": \"Ideally we would allow SVG icons but that's not possible.\\n\\nYou can use Unicode symbols supported by Segoe UI font: http://zuga.net/articles/unicode-all-characters-supported-by-the-font-segoe-ui/\\n\\nTo find a symbol you can search for example for `arrow` and then copy & paste the symbol (e.g. `\\u2192`) into settings file.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 13]\"}, {\"title\": \"Customizing eBook UI\", \"description\": null, \"content\": {\"Use advanced settings\": \"Use **Settings -> Advanced Settings** menu and find **EbookUI** section.\\n\\nAs described in [settings](https://www.sumatrapdfreader.org/settings/settings) you can change the following aspects of eBook UI:\\n\\n['FontName', 'FontSize', 'TextColor', 'BackgroundColor']\", \"Use PDF UI for eBooks\": \"Use **Settings -> Advanced Settings** menu and find **EbookUI** section.\\n\\nSet **UseFixedPageUI = true**\\n\\nRestart the app after changing the settings.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 14]\"}, {\"title\": \"Customizing keyboard shortcuts\", \"description\": null, \"content\": {\"Format of `Key` section:\": [\"just a key (like `a`, `Z`, `5`) i.e. letters `a` to `z`, `A` to `Z`, and numbers `0` to `9`\", \"modifiers + key. Modifiers are: `Shift`, `Alt`, `Ctrl` e.g. `Alt + F1`, `Ctrl + Shift + Y`\", \"there are some special keys (e.g. `Alt + F3`)\", [\"`F1` - `F24`\", \"`numpad0` - `numpad9` : `0` to `9` but on a numerical keyboard\", \"`Delete`, `Backspace`, `Insert`, `Home`, `End`, `Escape`\", \"`Left`, `Right`, `Up`, `Down` for arrow keys\", \"full list of [special keys](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/src/Accelerators.cpp#L14)\"], \"without modifiers, case do matter i.e. `a` and `A` are different\", \"with modifiers, use `Shift` to select upper-case i.e. `Alt + a` is the same as `Alt + A` , use `Alt + Shift + A` to select the upper-case `A`\"], \"Commands\": \"You can see a [full list of commands](Commands.md) ([or in the source code](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/src/Commands.h#L9))\", \"Notes\": \"The changes are applied right after you save settings file so that you can test changes without restarting SumatraPDF.\\n\\nIf a custom `Shortcut` doesn't work it could be caused by invalid command name or invalid command arguments.\\n\\nWe log information about unsuccessful parsing of a shortcut so [check the logs](Debugging-Sumatra.md#getting-logs) if things don't work as expected.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 15]\"}, {\"title\": \"DDE Commands\", \"description\": null, \"content\": {\"Format of DDE comands\": \"Single DDE command: `[Command(parameter1, parameter2, ..., )]`\\n\\nMultiple DDE commands: `[Command1(parameter1, parameter2, ..., )][Command2(...)][...]`\", \"Sending DDE commands\": \"You can either use windows api by sending DDE commands to server `SUMATRA` and topic `control`. See [this code](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/src/utils/WinUtil.cpp#L2437) for example of sending DDE command.\\n\\nOr you can use `-dde` command-line argument to `SumatraPDF.exe` e.g. `SumatraPDF.exe -dde \\\"[SetView(\\\\\\\"c:\\\\\\\\file.pdf\\\\\\\",\\\\\\\"continuous\\\\\\\",-3)]\\\"`.\\n\\nNotice escaping of DDE command string: `\\\"` and `\\\\` with `\\\\`.\", \"List of DDE commands:\": {\"Named commands\": \"*Ver 3.5+**: you can send all [named commands](Commands.md) as DDE:\\n\\n['format `[<command_id>]` e.g. `[CmdClose]`']\", \"Open file\": [\"format: `[Open(\\\"<filePath>\\\"[,<newWindow>,<focus>,<forceRefresh>])]`\", \"arguments:\", [\"if `newWindow` is 1 then a new window is created even if the file is already open\", \"if `focus` is 1 then the focus is set to the window\", \"if `forceRefresh` is 1 the command forces the refresh of the file window if already open (useful for files opened over network that don't get file-change notifications)\\\".\"], \"example: `[Open(\\\"c:\\\\file.pdf\\\",1,1,0)]`\"], \"Forward-search\": [\"format: `[ForwardSearch([\\\"<pdffilepath>\\\",]\\\"<sourcefilepath>\\\",<line>,<column>[,<newwindow>,<setfocus>])]`\", \"arguments:\", [\"`pdffilepath` : path to the PDF document (if this path is omitted and the document isn't already open, SumatraPDF won't open it for you)\", \"`column` : this parameter is for future use (just always pass 0)\", \"`newwindow` : 1 to open the document in a new window (even if the file is already opened)\", \"`focus` : 1 to set focus to SumatraPDF's window.\"], \"examples\", [\"`[ForwardSearch(\\\"c:\\\\file.pdf\\\",\\\"c:\\\\folder\\\\source.tex\\\",298,0)]`\", \"`[ForwardSearch(\\\"c:\\\\folder\\\\source.tex\\\",298,0,0,1)]`\"]], \"Jump to named destination command\": [\"format: `[GotoNamedDest(\\\"<pdffilepath>\\\",\\\"<destination name>\\\")]`\", \"example: `[GotoNamedDest(\\\"c:\\\\file.pdf\\\", \\\"chapter.1\\\")]`\", \"note: the pdf file must be already opened\"], \"Go to page\": [\"format: `[GotoPage(\\\"<pdffilepath>\\\",<page number>)]`\", \"example: `[GotoPage(\\\"c:\\\\file.pdf\\\", 37)]`\", \"note: the pdf file must be already opened.\"], \"Set view settings\": [\"format: `[SetView(\\\"<pdffilepath>\\\",\\\"<view mode>\\\",<zoom level>[,<scrollX>,<scrollY>])]`\", \"arguments:\", [\"`view mode`:\", [\"`\\\"single page\\\"`\", \"`\\\"facing\\\"`\", \"`\\\"book view\\\"`\", \"`\\\"continuous\\\"`\", \"`\\\"continuous facing\\\"`\", \"`\\\"continuous book view\\\"`\"], \"`zoom level` : either a zoom factor between 8 and 6400 (in percent) or one of -1 (Fit Page), -2 (Fit Width) or -3 (Fit Content)\", \"`scrollX, scrollY` : PDF document (user) coordinates of the point to be visible in the top-left of the window\"], \"example: `[SetView(\\\"c:\\\\file.pdf\\\",\\\"continuous\\\",-3)]`\", \"note: the pdf file must already be opened\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 16]\"}, {\"title\": \"Debugging Sumatra\", \"description\": null, \"content\": {\"Getting logs\": \"We log information that might be helpful in diagnosing issues.\\n\\nTo see the logs: `Ctrl + K` ([Command Palette](Command-Palette.md)), type `show log`\\n\\nThis saves logs to a file and opens default editor for `.txt` files with log file.\", \"Install necessary software\": [\"Install WinDBG debugger from Microsoft Store at [https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86#activetab=pivot:overviewtab](https://www.microsoft.com/en-us/p/windbg-preview/9pgjgd53tn86#activetab=pivot:overviewtab). Alternatively, you can follow instructions from [https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools](https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-download-tools)\", \"In SumatraPDF, use menu `Debug` / `Download symbols`. Symbols are important for the debugger (like WinDBG) to resolve addresses to names that\"], \"Debugging a crash\": \"To debug crashes:\\n\\n['start SumatraPDF.exe under the control of WinDBG', ['start WinDBG.exe', 'File/Open (Ctrl-E), find and open SumatraPDF.exe executable', 'In WinDBG, type:', ['`.sympath+ SRV*c:\\\\\\\\symbols*https://msdl.microsoft.com/download/symbols`', '`g`']], 'when Sumatra crashes, type:\\\\xa0`!analyze -v`\\\\xa0and paste the result of that to the bug report']\", \"Debugging a hang\": \"Here are the steps to follow if Sumatra hangs\\n\\n['Start SumatraPDF.exe and get it to hang', 'start WinDBG.exe', 'use File/Attach to process (F6) and select SumatraPDF.exe from the', 'In WinDBG, type:']\\n\\n7.1)\\u00a0`.sympath+ SRV*c:\\\\symbols*https://msdl.microsoft.com/download/symbols`\\n\\n7.2)\\u00a0`~*kb`\\n\\n7.3)\\u00a0`lmf`\\n\\nAttach the output to bug report.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 17]\"}, {\"title\": \"Editing annotations\", \"description\": null, \"content\": {\"Highlight text with `a`\": \"Most common annotation is highlighting of text: select text and press `a`. This creates a highlight annotation in yellow color:\\n\\n\\n\\nHere I highlighted word `USAGE` and pressed `a`.\", \"Saving annotations back to PDF file\": \"Notice in toolbar (upper right) we show: You have unsaved annotations.\\n\\nWhen you close the document (or exit the app) and have unsaved annotations, SumatraPDF will ask if you want to save them:\\n\\n\\n\\nIf you close the dialog or choose `Discard`, annotations will be lost.\\n\\n`Save changes to existing PDF` will over-write the PDF with newly added annotations.\\n\\n`Save changes to a new PDF` will allow you to save as a new file.\", \"Open annotation editor\": \"If you press `A` (upper case i.e. `Shift-a`) we will create a highlight annotation (same as lower case `a`) but also open annotation editor window.\\n\\nAnother way to open annotation editor is to use context menu (right mouse click or `Shift-F10`) and use `Edit Annotations`:\\n\\n\", \"Other annotations for selected text\": \"When you selected a text, you can create the following annotations from the selection:\\n\\n['highlight', 'underline', 'strike out', 'squiggly underline']\\n\\n\\n\\nWe also copy selected text to a clipboard so that e.g. you can use `Ctrl-V` to paste it into `Contents` property of the annotation.\", \"Other annotation types\": \"You can also create annotation object at your mouse location:\\n\\n['text', 'free text', 'stamp', 'caret']\\n\\n\", \"Annotation editor\": \"All those commands will open annotation editor:\\n\\n\\n\\nHere we have a text annotation in the editor.\\n\\nYou can delete annotations, change color, text and other attributes.\", \"Select annotation from page in editor\": \"When you have many annotations on the page, it's hard to locate the desired annotation in the editor list.\\n\\nTo select an annotation in the editor, place the mouse cursor over an annotation in the page, right click for context menu and use `Select Annotation in Editor`.\\n\\n\", \"Moving annotations\": \"To move an annotation on the page, left click with mouse and drag to new location.\", \"Customize highlight color\": \"To change default color for highlight annotation (created with keyboard shortcut `a`), use `Settings \\\\ Advanced Options...` menu and change `Annotations` \\\\ `HighlightColor` value. Default is yellow `#ffff00`).\", \"Missing features\": \"This is a first version of annotation editing. We don't yet support all annotation types and can't do everything that other PDF editing apps can do.\\n\\nThe future will be driven by your feedback. If there are features missing or there are better ways of doing things, let me know in the forum [https://forum.sumatrapdfreader.org/](https://forum.sumatrapdfreader.org/)\\n\\nWhen providing feedback:\\n\\n['tell us what', 'tell us why. Context is important for prioritizing features. Is new feature / idea something that you absolutely need or is it just a nice improvement', 'you might be familiar how other PDF editors work. When referencing feature or UI ideas coming from other apps, tell us which app it is. Screenshots are better than words when describing UI ideas.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 18]\"}, {\"title\": \"How to submit bug reports\", \"description\": null, \"content\": {\"Check in latest pre-release build\": \"First, see if it still happens in latest [pre-release version](https://www.sumatrapdfreader.org/prerelease). It's possible that a bug has already been fixed there.\", \"Create an issue\": \"If the problem is present in latest [pre-release build](https://www.sumatrapdfreader.org/prerelease), please create a bug report in our [issue tracker](https://github.com/sumatrapdfreader/sumatrapdf/issues).\", \"Provide a test file\": \"Does it involve a specific PDF (or CHM or XPS) file? \\n\\nPlease attach it to the issue (try dragging and dropping on the issue field). Without a test document we rarely can make progress on fixing the issue.\\n\\nIf the file (or other information) is confidential, you can e-mail it directly to [kkowalczyk@gmail.com](mailto:kkowalczyk@gmail.com) ([Krzysztof Kowalczyk](https://blog.kowalczyk.info/), SumatraPDF's main developer).\", \"Provide reproduction steps\": \"Often the bug only happens in a specific scenario.\\n\\nIf possible, please provide step-by-step instructions for reproducing the the issue.\", \"Reporting crashes\": \"[Submit crash report](Submit-crash-report.md)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 19]\"}, {\"title\": \"How we store settings\", \"description\": null, \"content\": {\"Where we store settings\": \"Persisted data is stored in `SumatraPDF-settings.txt` file.\\n\\nIn portable version the file is stored in the same directory as SumatraPDF executable. In non-portable version, it's in `%LOCALAPPDATA%\\\\SumatraPDF` directory.\\n\\nStarting with version 1.6 we also persist thumbnails for \\\"Frequently read\\\" list. They are stored in subdirectory `sumatrapdfcache` as `.png` files.\\n\\nSee [https://www.sumatrapdfreader.org/settings/settings](https://www.sumatrapdfreader.org/settings/settings) for information about all the settings.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 20]\"}, {\"title\": \"Installer Cmd Line Arguments\", \"description\": null, \"content\": {\"Installer cmd-line arguments\": \"To get list of options run the installer with `-help`.\\n\\nAvailable options:\\n\\n['`-install` : this triggers installation', \\\"`-s`, `-silent` : silent installation, doesn't show UI\\\", '`-d <directory>` e.g. `Sumatra-install.exe -install -d \\\"c:\\\\\\\\Sumatra PDF\\\"`\\\\nset directory where program is installed. The default is `%LOCALAPPDATA%\\\\\\\\SumatraPDF` or `%PROGRAMFILES%\\\\\\\\SumatraPDF` with `-all-users`', \\\"`-x` : don't install, extract the files\\\\nextracts files to current directory or directory provided with `-d` option\\\", '`-with-filter` : install search filter', '`-with-preview` : install shell preview for PDF files', '`-uninstall` : uninstalls SumatraPDF']\\n\\n**Ver 3.2+**\\n\\n['`-log`\\\\nwrites installation log to `%LOCALAPPDATA%\\\\\\\\sumatra-install-log.txt`. At the end of installation will open the log file in notepad.']\\n\\n**Ver 3.4+**\\n\\n['`-all-users` : installs system-wide, for all users\\\\ninstalls to `%PROGRAMFILES%\\\\\\\\SumatraPDF` and writes to `HKLM` registry']\\n\\n**Ver 3.6+**\\n\\n['`-fast-install` : automatically starts installation with default options, starts the app when installation is finished']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 21]\"}, {\"title\": \"Is There A Virus In Sumatra Sources\", \"description\": null, \"content\": {\"Is there a virus in Sumatra sources?\": \"Some people report that their anti-virus software complains about executables in bin directory of Sumatra sources.\\n\\nIs there really a virus in them?\\n\\n**No**.\\n\\nFalse positives are unfortunately quite common in all popular anti-virus programs. You can always verify what your particular anti-virus program says against what other anti-virus programs say by using\\u00a0[https://www.virustotal.com/](https://www.virustotal.com/).\\n\\nIf only one or two report a given file as having a virus, it's most likely a false positive.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 22]\"}, {\"title\": \"Keyboard Shortcuts\", \"description\": null, \"content\": {\"Keyboard shortcuts\": \"You can [customize keyboard shortcuts](Customizing-keyboard-shortcuts.md). Also see [standard Windows keyboard shortcuts](https://support.microsoft.com/en-us/windows/keyboard-shortcuts-in-windows-dcc61a57-8ff0-cffe-9796-cb9706c75eec) for controls like tree view or edit fields.\\n\\n:columns\\n\\nFile menu\\n\\n['`Ctrl + N` Open a new window', '`Ctrl + O` Open a file', '`Ctrl + W` Close current file', '`Ctrl + S` Save current file as', '`F2` Rename current file', '`Ctrl + P` Print', '`Ctrl + D` Properties', '`Ctrl + Q`, `Alt-F4` Quit app']\\n\\nGo To menu\\n\\n['`Right Arrow` / `Left Arrow`- Next / Previous Page\\\\nscrolls left / right if page width > window width', '`Home` First Page', '`End` Last Page', '`Ctrl + G` Go To Page...', '`Alt + Left Arrow` Back', '`Alt + Right Arrow` Forward', '`Ctrl + F` Find...']\\n\\nFavorites menu\\n\\n['`Ctrl + B` Add current page to favorites']\\n\\nView menu\\n\\n['`Ctrl + 6` Single Page', '`Ctrl + 7` Facing', '`Ctrl + 8` Book View', '`Ctrl + Shift + -`, `[`- Rotate Left (anti-clockwise)', '`Ctrl + Shift + +`, `]`- Rotate Right (clockwise)', '`F5` Enter / Exit Presentation', '`F11` Enter / Exit Full Screen', '`F12` Show / Hide Bookmarks', '`F8` Show / Hide Toolbar', '`Ctrl + A` Select All', '`Ctrl + C` Copy Selection']\\n\\nZoom menu\\n\\n['`Ctrl + 0` Fit Page', '`Ctrl + 1` Actual Size', '`Ctrl + 2` Fit Width', '`Ctrl + 3` Fit Content', '`Ctrl + Y` Custom Zoom...']\\n\\nNavigation\\n\\n['`j` / `k` Scroll up / down by line', '`h` / `l` Scroll left / right', '`Up` / `Down` Scroll up/down by line', '`Shift + Left` / `Shift + Right`- Scroll left /right faster', '`space` Scroll by screen', '`Shift + space` Scroll back by screen', '`n` / `p` Next / previous page', '`Page Down` / `Page Up` Next / previous page', '`Ctrl + Down` / `Ctrl + Up` Next / previous page', '`Alt + Left` Go back', '`Alt + Right` Go forward', '`Ctrl + G` Go to page', '`g` Go to page', '`Home` Go to first page', '`End` Go to last page', '`b` Flip a page in book mode', '`Ctrl + Shift + Right` Open next document in the directory', '`Ctrl + Shift + Left` Open previous document in the directory']\\n\\nViewing state\\n\\n['`+` / `-` zoom in/out', '`Ctrl + scroll wheel` zoom in/out', '`z` toggle zoom between Fit Page, Fit Width, Fit Content', '`c` toggle between continuous/non-continuous mode', '`Ctrl + Shift + -` rotate left', '`/` on numeric keypad rotate left', '`Ctrl + Shift + +` rotate right', '`*` on numeric keypad rotate left', '`F12` show/hide bookmarks (table of contents)', '`F6` switch focus between bookmarks window and main window', '`Ctrl + L`, `F5`, `Shift + F11`- Enter / exit presentation mode (minimal full screen mode)', '`F11`, `Ctrl + Shift + L`, `f` Enter / Exit full screen mode', '`ESC` exit full screen or presentation mode', 'mouse double click exit full screen or presentation mode', '`i` toggle showing page info (**ver 3.6+** )', '`i` invert colors in the document (**ver 3.5.2 or earlier**)', '`Shift + i` invert colors in the document (**ver 3.6+**)', '`Shift + i` toggle showing page info (**ver 3.5.2 or earlier**)', '`m` show cursor position in document coordinates', '`F8` show/hide toolbar', '`F9` show/hide menu', '`w` in presentation mode, make whole screen white', '`.` in presentation mode, make whole screen black']\\n\\nActions\\n\\n['`Ctrl + O` Open a new document', '`Ctrl + W` Close current document', '`Ctrl + F4` Also close current document', '`Ctrl + S` Save current document as...', '`Ctrl + Shift + S` Create a link to current document', '`Ctrl + P` Print', '`F2` Rename file and reopen with new name', '`Ctrl + Shift + N` Open current document in new window', '`r` Reload document', '`Ctrl + F` Find text', '`/` Find text', '`F3` Find next', '`Shift + F3` Find previous', '`Alt + F4` Close window (and all documents in it). Quit app if last window.', '`q` Close current document (tab). Close window if last tab. Quit app if last window.', '`Ctrl + Q` Quit app (close all windows and opened documents)', '`Ctrl + Left Mouse` Select area (can then use with copy, print or +/- zoom)', '`Ctrl + B` Add current page to favorites', '`Right Mouse` Grab and pan page in any direction', '`Alt + Scroll Wheel` Increase vertical scroll wheel steps (faster)', '`Shift + Scroll Wheel` Pan horizontally with scroll wheel', '`Ctrl + Y` Show dropdown zoom control', '`F1` Show documentation / manual']\\n\\nTabs\\n\\n['`Ctrl + Tab` go to next tab', '`Ctrl + Shift + Tab` go to previous tab', '`Alt + 1` go to tab 1. Use `Alt + 2`, etc. up to `Alt + 8`', '`Alt + 9` go to last tab']\\n\\nAnnotations\\n\\n**Ver 3.3+**, some in **ver 3.4+**:\\n\\n['`a` create highlight annotation from selected text', '`A` like `a` plus opens annotation editor', '`u` create underline annotation from selected text', '`Delete` delete annotation under mouse cursor', '`Ctrl-Shift-S` save annotations to current PDF file']\\n\\n:columns\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 23]\"}, {\"title\": \"LaTeX integration\", \"description\": null, \"content\": {\"notepad++\": \"Launch SumatraPDF from notepad++ enabling forward and backward search:\\n\\n```\\n\\\"C:\\\\Program files\\\\SumatraPDF\\\\SumatraPDF.exe\\\" -forward-search \\\"$(FULL_CURRENT_PATH)\\\" $(CURRENT_LINE) -inverse-search \\\"\\\\\\\"C:/Program Files/Notepad++/notepad++.exe\\\\\\\" \\\\\\\"%f\\\\\\\" -n%l\\\" \\\"$(CURRENT_DIRECTORY)\\\"/\\\"$(NAME_PART)\\\".pdf\\n```\", \"TexStudio\": \"Launch SumatraPDF from TeXStudio enabling forward and backward search:\\n\\n```\\n\\\"C:/Program Files/SumatraPDF/SumatraPDF.exe\\\" -forward-search \\\"?c:am.tex\\\" @ -inverse-search \\\"\\\\\\\"C:/Program Files (x86)/TeXstudio/texstudio.exe\\\\\\\" \\\\\\\"%%f\\\\\\\" -line %%l\\\" \\\"?am.pdf\\\"\\n```\", \"TeXnicCenter\": \"**Detailed instructions**: [https://tex.stackexchange.com/questions/453670/adobe-reader-makes-texniccenter-crash-alternative-sumatra/453731#453731](https://tex.stackexchange.com/questions/453670/adobe-reader-makes-texniccenter-crash-alternative-sumatra/453731#453731)\\n\\n**Short instructions:**\\n\\nConfigure viewer in [output profiles](https://texniccenter.sourceforge.net/configuration.html#viewer-tab).\\n\\n['press Alt+F7 (Build > Define Output Profiles)', 'for any one of the PDF Profiles e.g. LaTeX > PDF', 'for Executable path it should have something like:', ['`C:\\\\\\\\Program Files\\\\\\\\SumatraPDF\\\\\\\\SumatraPDF.exe -inverse-search \\\"\\\\\\\\\\\"C:\\\\\\\\Program Files (x86)\\\\\\\\TeXnicCenter\\\\\\\\TeXnicCenter.exe\\\\\\\\\\\" /ddecmd \\\\\\\\\\\"[goto(\\\\'%f\\\\',\\\\'%l\\\\')]\\\\\\\\\\\"\\\"`', '`SumatraPDF.exe` path might be different on your computer'], 'go back to the editor and using any simple .TeX press `Ctrl + Shift + F5` (Build and view)', 'SumatraPDF should have fired up with the compiled PDF', 'in SumatraPDF go To `Settings` > `Advanced Options`', 'make the following modifications and save the settings file:']\\n\\n```\\nReuseInstance = true\\nReloadModifiedDocuments = true\\n\\nInverseSearchCmdLine = \\\"C:\\\\Program Files\\\\TeXnicCenter\\\\TeXnicCenter.exe\\\" /nosplash /ddecmd \\\"[goto('%f', '%l')]\\\"\\nOR\\nInverseSearchCmdLine = \\\"C:\\\\Program Files (x86)\\\\TeXnicCenter\\\\TeXnicCenter.exe\\\" /nosplash /ddecmd \\\"[goto('%f', '%l')]\\\"\\n\\nEnableTeXEnhancements = true\\nUseTabs = true\\n```\\n\\nNow a double click in the PDF should take you back to TeXnicCenter either in an included file or the main file. IF not, check the syntax of the InverseSearchCmdLine = matches YOUR location for TeXnicCenter\\n\\nBack in the editor press Alt+F7 (Build > Define Output Profiles) and for each of the PDF options select viewer\\n\\nIn the 1Executable path1 section REMOVE any thing after the .exe\\n\\nIn the 1View project's Output1 select `Command line argument` and check it is `\\\"%bm.pdf\\\"`\\n\\nIn Forward search change it to `-forward-search \\\"%Wc\\\" %l \\\"%bm.pdf\\\"`\", \"Vim\": {\"forward-search\": \"The following function works pretty well (note that it is written in Vim9\\nlanguage):\\n\\n```\\ndef ForwardSearch()\\n var filename_root = expand('%:p:r')\\n system($'SumatraPDF.exe -forward-search {filename_root}.tex {line(\\\".\\\")} {filename_root}.pdf')\\nenddef\\n```\\n\\nFeel free to replace `SumatraPDF.exe` with the correct executable filename,\\ne.g. `SumatraPDFv3-4-5.exe`.\\n\\nNext, you should map this function to some key, for example you could use the\\nfollowing.\\n\\n```\\nnnoremap <buffer> <F5> <Scriptcmd>ForwardSearch()<cr>\\n```\\n\\nNow, `<F5>` will perform a forward-search. Feel free to replace `<F5>` with\\nthe key that you prefer.\", \"backward-search\": \"Define a global-scope `BackwardSearch` function as it follows:\\n\\n```\\ndef g:BackwardSearch(line: number, filename: string)\\n exe $'buffer {bufnr(fnamemodify(filename, ':.'))}'\\n cursor(line, 1)\\nenddef\\n```\\n\\nNext, open `SumatraPDF` and go to _Settings/Options_. Replace the line in the\\n_Set inverse-search command-line_ box, with the following:\\n\\n```\\nvim --servername vim --remote-send \\\":call BackwardSearch(%l, '%f')<cr>\\\"\\n```\\n\\nIf you use gvim, then replace `vim` with `gvim` in the above line. The\\nbackwards search should be now enabled.\"}, \"WinEdt and Emacs\": \"<!-- See instructions at [https://william.famille-blum.org/blog/static.php?page=static081010-000413](https://william.famille-blum.org/blog/static.php?page=static081010-000413) -->\\n\\nEmacs:\\n[https://www.emacswiki.org/emacs/AUCTeX#toc25](https://www.emacswiki.org/emacs/AUCTeX#toc25)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 24]\"}, {\"title\": \"Logview\", \"description\": null, \"content\": {\"Download\": \"Download [Logview 0.2](https://files2.sumatrapdfreader.org/software/logview/rel/logview-0.2.exe).\", \"More info\": \"Logview is a generic logging tools that opens a named pipe `\\\\\\\\.\\\\pipe\\\\LOCAL\\\\ArsLexis-Logger` that any application can open and write to.\\n\\nSumatraPDF uses it for logging (`log()`, `logf()`, `logfa()` functions in `Log.h` and `Log.cpp`).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 25]\"}, {\"title\": \"Reporting Printing Bugs\", \"description\": null, \"content\": {\"Reporting printing bugs\": \"Printing bugs are hard to diagnose because each printer has a different printer driver, so the same file can print well on one printer and not print on another printer.\\n\\nThat's why when reporting printing bugs in [https://github.com/sumatrapdfreader/sumatrapdf/issues](https://github.com/sumatrapdfreader/sumatrapdf/issues), please make sure to include the following information:\\n\\n['version of Sumatra', 'version of the OS (e.g. windows Vista, windows 10 etc.)', 'name of the printer', 'can you open and see the file in Sumatra?', 'what exactly happens, are there any error messages?', 'if it happens only for some files but not the others', [\\\"is there anything different about the files that don't print that jumps out?\\\", \\\"please attach the file that doesn't print to bug report. If the file is confidential you can e-mail it to [kkowalczyk@gmail.com](mailto:kkowalczyk@gmail.com) ([Krzysztof Kowalczyk](https://blog.kowalczyk.info/), Sumatra's main developer).\\\"]]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 26]\"}, {\"title\": \"Scrolling and navigating\", \"description\": null, \"content\": {\"Scrolling with keyboard\": \"`Up`, `Down`, `Left`, `Right` refers to arrow keys.\\n\\n['`k`, `j`, `h`, `l` : scroll up / down / left / right', '`Up`, `Down` : scroll up / down', '`n`, `Left` : go to next page (aligns top of page with top of window)', '`p`, `Right` : go to previous page (aligns top of page with top of window)', '`Shift + Down`, `Shift + Up` : scroll forward / backward by a page', '`Space`, `Shift + Space` : scroll forward / backward by a page', '`Home`, `End` : go to first / last page', '`g`, `Ctrl + g` : go to page (text field in toolbar or dialog if toolbar not shown)']\", \"Scrolling with mouse and touch pad\": [\"click on scrollbar to scroll up or down by page\", \"`Shift` + click on scrollbar : scrolls to that position\", \"scroll up / down with mouse scroll wheel or touch pad scrolling gesture\", \"press `Alt` while scrolling : scrolls faster (by half page instead of by line)\", \"mouse over scrollbar : scrolls faster (by half page instead of by line)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 27]\"}, {\"title\": \"Set as default PDF viewer\", \"description\": null, \"content\": {\"Using File Explorer\": \"In File Explorer:\\n\\n['find a .pdf file (or any other supported file type)', 'right-click to get a context menu', 'select `Open with` and then `Choose another app`']\\n\\n\\n\\nFrom the list, choose `SumatraPDF` and check `Always use this app to open .pdf files`:\\n\\n\", \"Using Default apps system settings\": \"This is based on latest Windows 11 build at the time of this writing.\\n\\nUnfortunately the details differ between Windows updates.\\n\\nLaunch `Default app` section in settings app, e.g. use `Windows logo` hot-key to launch system-wide search, type `default apps` and click on `Default apps` search result to launch settings app.\\n\\n\\n\\nIn Default apps type `.pdf` for file extension:\\n\\n\\n\\nClick on current default PDF application (`Microsoft Edge` in this example) and select `SumatraPDF`:\\n\\nYou can do that for other file formats.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 28]\"}, {\"title\": \"Source Code Downloads\", \"description\": null, \"content\": {\"Source code downloads\": \"You can download source code of every release as .zip or .tar.gz from [https://github.com/sumatrapdfreader/sumatrapdf/releases](https://github.com/sumatrapdfreader/sumatrapdf/releases)\\n\\nFull source history is available in\\u00a0[git repository](https://github.com/sumatrapdfreader/sumatrapdf)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 29]\"}, {\"title\": \"Submit Crash Report\", \"description\": null, \"content\": {\"Submit crash report`\": \"Please help us fix SumatraPDF crashes.\\n\\nIf you have a reproducible crash:\\n\\n['download symbols:', ['menu: `Debug` / `Download Symbols`', '`Ctrl + K` for command palette and `Debug: Download Symbols`'], 'trigger the crash', 'when you see crash dialog, press `Cancel` to launch default text editor with crash report', 'post the content of the crash log as a gist at [https://gist.github.com/](https://gist.github.com/). For example: `Ctrl-A` to select all text, `Ctrl-C` to copy it to a clipboard and then `Ctrl-V` to the gist', 'create a bug report at [https://github.com/sumatrapdfreader/sumatrapdf/issues](https://github.com/sumatrapdfreader/sumatrapdf/issues)', 'post a link to the gist in the bug report', '**include the file that caused the crash**', ['attach to the GitHub issue (put in a .zip file if file type is not accepted)', 'or, if the file is private, e-mail to kkowalczyk@gmail.com (and reference bug number)', 'I can\\u2019t stress it enough: if I can\\u2019t reproduce a crash myself, I might not be able to fix it'], 'provide additional information like:', ['what were you doing when the crash happened', 'when did the crash happen. When opening a file? changing view? etc.', 'how did you open the file? drag & drop on Sumatra window? Double-click in file manager? From command line?', 'the best information is a set of steps I can do to reproduce the crash']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 30]\"}, {\"title\": \"Sumatrapdf Documentation\", \"description\": null, \"content\": {\"Documentation for users\": \"[Command Palette](Command-Palette.md)\\n\\n[Keyboard shortcuts](Keyboard-shortcuts.md)\\n\\n[Customizing keyboard shortcuts](Customizing-keyboard-shortcuts.md)\\n\\n[Scrolling, zooming, navigating](Scrolling-and-zooming.md)\\n\\n[Commands](Commands.md)\\n\\n[Command-line arguments](Command-line-arguments.md)\\n\\n[Advanced options / settings](Advanced-options-settings.md)\\n\\n[Customizing toolbar](Customize-toolbar.md)\\n\\n[Customizing UI colors / theme](Customize-theme-colors.md)\\n\\n[Customize external viewers](Customize-external-viewers.md)\\n\\n[Customize search / translation services](Customize-search-translation-services.md)\\n\\n[Editing annotations](Editing-annotations.md)\\n\\n[LaTeX integration](LaTeX-integration.md)\\n\\n[DDE Commands](DDE-Commands.md)\\n\\n[Set as default PDF viewer](Set-as-default-PDF-viewer.md)\\n\\n[Configure for restricted use](Configure-for-restricted-use.md)\\n\\n[Supported document formats](Supported-document-formats.md)\\n\\n[Customizing eBook UI](Customizing-eBook-UI.md)\\n\\n[Installer cmd-line arguments](Installer-cmd-line-arguments.md)\\n\\n[Uninstalling SumatraPDF](Uninstalling-SumatraPDF.md)\\n\\n[Version history](Version-history.md)\", \"Misc\": \"[Contribute translation](Contribute-translation.md)\\n\\n[How to submit bug reports](How-to-submit-bug-reports.md)\\n\\n[Submit crash report](Submit-crash-report.md)\\n\\n[Reporting printing bugs](Reporting-printing-bugs.md)\\n\\n[Update check doesnt work?](Update-check-doesnt-work.md)\\n\\n[Corrupted installation](Corrupted-installation.md)\\n\\n[Why only Windows?](Why-only-Windows.md)\", \"Information for developers\": \"[Contribute to SumatraPDF](Contribute-to-SumatraPDF.md)\\n\\n[Logview](Logview.md)\\n\\n[Build system](Build-system.md)\\n\\n[Debugging Sumatra](Debugging-Sumatra.md)\\n\\n[How we store settings](How-we-store-settings.md)\\n\\n[Using DrMemory](Using-DrMemory.md)\\n\\n[Using OpenCppCoverage](Using-OpenCppCoverage.md)\\n\\n[Is there a virus in Sumatra sources?](Is-there-a-virus-in-Sumatra-sources.md)\\n\\n[Accessibility and Text-to-Speech](Accessibility-and-Text-to-Speech.md)\\n\\n[Source code downloads](Source-code-downloads.md)\\n:columns\", \"Downloads\": [\"[latest stable release](https://www.sumatrapdfreader.org/download-free-pdf-viewer)\", \"[pre-release builds](https://www.sumatrapdfreader.org/prerelease) (latest features, potentially buggy)\"], \"Feedback\": \"Found a bug? Have feature request? Submit via [issue tracker](https://github.com/sumatrapdfreader/sumatrapdf/issues) and [vote for features](https://sumatrapdf.canny.io/feature-requests) you want to see next.\\n\\nHave feedback or question? Discuss in a [forum](https://github.com/sumatrapdfreader/sumatrapdf/discussions).\\n\\nWant to make SumatraPDF work better in your language? [Contribute a translation.](Contribute-translation.md)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 31]\"}, {\"title\": \"Supported document formats\", \"description\": null, \"content\": {\"HEIF support\": \"**Ver 3.4+**: SumatraPDF can open [HEIF images](https://nokiatech.github.io/heif/) but only if Windows has a codec for the format.\\n\\nYou can use one of those codecs:\\n\\n['[https://www.copytrans.net/copytransheic/](https://www.copytrans.net/copytransheic/) : free for personal use', '[https://www.microsoft.com/en-us/p/heif-image-extensions/9pmmsr1cgpwg?activetab=pivot:overviewtab](https://www.microsoft.com/en-us/p/heif-image-extensions/9pmmsr1cgpwg?activetab=pivot:overviewtab) : HEIF image codec from Microsoft, Windows 10 or later']\\n\\nYou can make SumatraPDF to be [default program for handling those file types](Set-as-default-PDF-viewer.md).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 32]\"}, {\"title\": \"Uninstalling SumatraPDF\", \"description\": null, \"content\": {\"Are you using official Sumatra build?\": \"Did you download Sumatra from [official Sumatra website](https://www.sumatrapdfreader.org/download-free-pdf-viewer)?\\n\\nIf not, we can't help you because we didn't create the software you're using.\", \"Uninstalling Sumatra\": \"There are 2 versions of Sumatra: an installer and a portable version (zipped executable).\", \"Uninstalling portable version\": \"If you're using zipped executable, the only thing you need to do is to delete SumatraPDF.exe.\", \"Uninstalling the installer version\": \"If you installed SumatraPDF by running official installer, you uninstall it like every other application.\\n\\nOn Windows 10 / 11:\\n\\n['start Settings app ([https://www.digitalcitizen.life/introducing-windows-10-ways-open-settings](https://www.digitalcitizen.life/introducing-windows-10-ways-open-settings))', 'Select `Apps`', 'find `SumatraPDF` on the list, click it and press `Uninstall` button:']\\n\\n\", \"What if the above doesn't help?\": \"What if you still have questions? You can use the [forums](https://forum.sumatrapdfreader.org/) to ask for additional help.\\n\\nHowever, in order for someone to help you, you need to provide the following information:\\n\\n[\\\"Sumatra PDF version you're using\\\", 'your OS (Windows) version', 'did you download an installer or zipped executable?', 'where did you download the Sumatra from (the url of the webpage you used to download Sumatra)?', 'is there SumatraPDF directory in your program files directory (usually \\\"c:\\\\\\\\Program Files\\\" or \\\"c:\\\\\\\\Program Files (x86)\\\" on 64-bit systems)?', 'what evidence there is that Sumatra is installed? Be precise and specific. Don\\\\'t just say \\\"there\\\\'s a link to it\\\", tell us where that link is, what is the name of the link etc.']\\n\\nTo emphasize: if you don't provide this information, we cannot help you.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 33]\"}, {\"title\": \"Update Check Doesnt Work\", \"description\": null, \"content\": {\"Update check doesn't work?\": \"A new version of Sumatra has been released, you\\u00a0`Help -> Check for updates`\\u00a0menu and it didn't notify about a new release. Is this a bug?\\n\\nMost likely not.\\n\\nWe wait at least a week before activating update check. That way, if there is a major problem with a new release that we didn't catch in testing, less people will have to re-download the update that fixes the problem.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 34]\"}, {\"title\": \"Using Drmemory\", \"description\": null, \"content\": {\"Using DrMemory\": \"[DrMemory](https://drmemory.org/) is a tool for detecting memory errors and misuse of Windows APIs.\\n\\nI've tried portable version [1.8.1RC1](https://github.com/DynamoRIO/drmemory/wiki/Downloads) on Windows 7 32bit (it doesn't support Windows 10 and 64bit).\\n\\nI ran it as:\\n\\n['`mkdir ..\\\\\\\\drmemlogs`', '`..\\\\\\\\drmemory\\\\\\\\bin\\\\\\\\drmemory.exe -logdir ..\\\\\\\\drmemlogs -suppress=drmem-sup.txt \\u2014 .\\\\\\\\rel\\\\\\\\SumatraPDF.exe ..\\\\\\\\f1.pdf`']\\n\\nThere are what appear to be false positives. I add suppressions to drmem-sup.txt as I find them.\\n\\nDrMemory visibly slows down the program and also crashes sometimes (e.g. it crashed for me with XPS files).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 35]\"}, {\"title\": \"Using Opencppcoverage\", \"description\": null, \"content\": {\"Using OpenCppCoverage\": \"I tried [OpenCppCoverage](https://opencppcoverage.codeplex.com/) (https://github.com/Unity-Technologies/OpenCppCoverage) 0.9.3 on SumatraPDF.\\n\\nI installed 64-bit version from the installer on Win 10. I ran `OpenCppCoverage.exe --sources sumatra -- .\\\\dbg64\\\\SumatraPDF.exe`, opened a file, closed the program.\\n\\n`--sources` limits reporting to only files whose paths match a given pattern. Using sumatra for pattern matches all our source files, assuming the sources were checked out to `sumatrapdf` directory (because `sumatra` matches `sumatrapdf` in file path) and skips the sources for C/C++ libraries.\\n\\nIt generated `CoverageReport-${date}` directory with HTML report. There's top-level index.html with links to html file for each module (SumatraPDF.exe in our case).\\n\\nThey recommend running on debug code.\\n\\nAt the end it reports generating reports for system dlls, but also says can't get symbols, so it doesn't actually generate anything.\\n\\nThe html report isn't great. Another option would be to use `--export_type=binary` option which generates `SumatraPDF.cov` file and write html generator myself. I assume the format of `.cov` file is simple.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 36]\"}, {\"title\": \"Version history\", \"description\": null, \"content\": {\"[RSS/Atom feed](https://github.com/sumatrapdfreader/sumatrapdf/releases)\": \"\", \"Version history\": {\"next (3.6)\": \"Changes in [pre-release builds](https://www.sumatrapdfreader.org/prerelease):\\n\\n['in Command Palette, if you start search with \\\":\\\" we show everything (like in 3.5)', 'in Command Palette, when viewing opened files history (#), you can press Delete to remove the entry from history', 'improved zooming:', ['zooming with pinch touch screen gesture or with ctrl + scroll wheel now zooms around the mouse position and does continuous zoom levels. Used to zoom around top-left corner and progress fixed zoom levels shown in menu'], 'include manual (`F1` to launch browser with documentation)', 'add `LazyLoading` advanced setting, defaults to true. When restoring a session lazy loading delays loading a file until its tab is selected. Makes SumatraPDF startup faster.', 'new commands in command palette (`Ctrl + K`):', ['`CmdCloseAllTabs` : \\\"Close All Tabs\\\"', '`CmdCloseTabsToTheLeft` : \\\"Close Tabs To The Left\\\"', '`CmdDeleteFile`: \\\"Delete File\\\"', '`CmdToggleFrequentlyRead` : \\\"Toggle Frequently Read\\\"', '`CmdToggleLinks` : \\\"Toggle Show Links\\\"', '`CmdInvokeInverseSearch`', '`CmdMoveTabRight` (`Ctrl + Shift + PageUp`), `CmdMoveTabLeft` (`Ctrl + Shift + PageDown`) to move tabs left / right, like in Chrome'], 'add ability to provide arguments to some commands when creating bindings in `Shortcuts`:', ['CmdCreateAnnot\\\\\\\\* commands take a color argument, `openedit` to automatically open edit annotations window when creating an annotation, `copytoclipboard` to copy selection to clipboard and `setcontent` to set contents of annotation to selection', '`CmdScrollDown`, `CmdScrollUp` : integer argument, how many lines to scroll', '`CmdGoToNextPage`, `CmdGoToPrevPage` : integer argument, how many pages to advance', '`CmdNextTabSmart`, `CmdPrevTabSmart` (`Smart Tab Switch`), shortcut: `Ctrl + Tab`, `Ctrl + Shift + Tab``'], 'added `UIFontSize` advanced setting', 'removed `TreeFontWeightOffset` advanced setting', 'increase number of thumbnails on home page from 10 => 30', 'add `ShowLinks` advanced setting and \\\"Toggle Show Links\\\" (`CmdToggleLinks`) for command palette', 'default `ReuseInstance` setting to true', 'added `Key` arg to `ExternalViewers` advanced setting (keyboard shortcut)', 'added `Key` arg to `SelectionHandlers` advanced setting (keyboard shortcut)', 'improved scrolling with mouse wheel and touch gestures', 'theming improvements', 'go back to opening settings file with default .txt editor (notepad most likely)', \\\"don't exit fullscreen on double-click. must double-click in upper-right corner\\\", 'when opening via double-click, if `Ctrl` is pressed will always open in new tab (vs. activating existing tab)', 'register for handling `.webp` files', 'bug fix: Del should not delete an annotation if editing content', 'bug fix: re-enable tree view full row select', 'change: `CmdCreateAnnotHighlight` etc. no longer copies selection to clipboard by default. To get that behavior back, you can use `copytoclipboard` argument [instead](Commands.md#cmdcreateannothighlight-and-other-cmdcreateannot).', 'change: `Ctrl + Tab` is now `CmdNextTabSmart`, was `CmdNextTab`. `Ctrl + Shift + Tab` is now `CmdPrevTabSmart`, was `CmdPrevTab`. You can [re-bind it](Customizing-keyboard-shortcuts.md) if you prefer old behavior', '`CmdCommandPalette` takes optional `mode` argument: `@` for tab selection, `#` for selecting from file history and `>` for commands.', 'command palette no longer shows combined tabs/file history/commands. `CmdCommandPalette` only shows commands. Because of that removed `CmdCommandPaletteNoFiles` because now ``CmdCommandPalette` behaves like it', 'removed `CmdCommandPaletteOnlyTabs`, replaced by`CmdCommandPaletteNoFiles @`', '`Ctrl + Shift + K` no longer active, use `Ctrl + K`. You can restore this shortcut by binding it to `CmdCommandPalette >` command.', 'add `Name` field for shortcuts. If given, the command will show up in Command Palette (`Ctrl + K`)', \\\"closing a current tab now behaves like in Chrome: selects next tab (to the right). We used to select previously active tab, but that's unpredicable and we prefer to align SumatraPDF behavior with other popular apps.\\\", \\\"swapped key bindings: 'i' is now CmdTogglePageInfo, 'I' is CmdInvertColors. Several people were confused by accidentally typing 'i' to invert colors, is less likely to type it accidentally\\\", 'allow creating custom themes in advanced settings in `Themes` section. [See docs](https://www.sumatrapdfreader.org/docs/Customize-theme-colors).', 'improve scrolling with middle click drag [#4529](https://github.com/sumatrapdfreader/sumatrapdf/issues/4529)']\", \"3.5.2 (2023-10-25)\": [\"fix not showing tab text\", \"make menus in dark themes look more like standard menus (bigger padding)\", \"fix Bookmarks for folder showing bad file names\", \"update translations\"], \"3.5.1 (2023-10-24)\": [\"fix uninstaller crash\", \"disable lazy loading of files when restoring a session\"], \"3.5 (2023-10-23)\": [\"Arm 64-bit builds\", \"dark mode (menu `Settings / Theme` or `Ctrl + K` command `Select next theme`)\\nyou can use `i` (invert colors) to match the background / text color of rendered\\nPDF document. Due to technical limitations, it doesn't work well with images\", \"`i` (invert colors) is remembered in settings\", \"`CmdEditAnnotations` select annotation under cursor and open annotation edit window\", \"rename `CmdShowCursorPosition` => `CmdToggleCursorPosition`\", \"add `Annotations [ FreeTextColor, FreeTextSize, FreeTextBorderWidth ]` settings\", \"ability to move annotations. `Ctrl + click` to select annotation and them move via drag & drop\", \"add `CmdCommandPaletteOnlyTabs` command with `Alt + K` shortcut\", \"exit full screen / presentation modes via double click with left mouse button\", \"ability to drag out a tab to open it in new window\", \"support opening\\u00a0`.avif`\\u00a0images (including inside .cbz/,cbr files)\", \"respect image orientation `exif` metadata in .jpeg and .png images\", \"support Adobe Reader syntax for opening files\\u00a0`/A \\\"page=<pageno>#nameddest=<dest>search=<string>`\", \"add\\u00a0`Next Tab`\\u00a0/\\u00a0`Prev Tab`\\u00a0commands with\\u00a0`Ctrl + PageUp`\\u00a0/\\u00a0`Ctrl + PageDown` shortcuts\", \"keep Home tab open; add\\u00a0`NoHomeTab`\\u00a0advanced option to disable that\", \"add context menu to tabs\", \"bugfix: handle files we can't open in\\u00a0`next file in folder`\\u00a0/\\u00a0`prev file in folder`\\u00a0commands\", \"command palette: when search starts with\\u00a0`>`, only show commands, not files (like in Visual Studio Code)\", \"add `reopen last closed` command (`Ctrl + Shift + T`, like in web browsers)\", \"add `clear history` command\", \"can send commands via [DDE](https://www.sumatrapdfreader.org/docs/DDE-Commands)\", \"added `CmdOpenWithExplorer`, `CmdOpenWithDirectoryOpus`, `CmdOpenWithTotalCommander`, `CmdOpenWithDoubleCommander` commands\", \"enable `CmdCloseOtherTabs`, `CmdCloseTabsToTheRight` commands from command palette\", \"recognize `PgUp` / `PgDown` and a few more in keyboard shortcuts\", \"add `-disable-auto-rotation` cmd-line print option\", \"add `-dde` cmd-line option\"], \"3.4.6 (2022-06-08)\": [\"fix crashes\", \"fix hang in Fit Content mode and Bookmark links\"], \"3.4.5 (2022-06-05)\": [\"fix crashes\"], \"3.4.4 (2022-06-02)\": [\"restore `HOME` and `END` in find edit field\", \"fix crashes\"], \"3.4.3 (2022-05-29)\": [\"re-enable `Backspace` in edit field\", \"fix installation for all users when using custom installation directory\", \"re-enable `Copy Image` context menu for comic book files\", \"fix display of some PDF images\", \"fix slow loading of some ePub files\"], \"3.4.2 (2022-05-27)\": [\"make keyboard accelerators work when tree view has focus\", \"fix `-set-color-range` and `-bg-color` replacing `MainWindowBackground`\", \"fix crash with incorrectly defined selection handlers\"], \"3.4.1 (2022-05-25)\": [\"fix downloading of symbols for better crash reports\"], \"3.4 (2022-05-24)\": [\"[Command Palette](Command-Palette.md)\", \"[customizable keyboard shortcuts](Customizing-keyboard-shortcuts.md)\", \"better support for epub files using mupdf's epub engine. Adds text selection and search in ebook files. Better rendering fidelity. On the downside, might be slower.\", \"[search / translate selected text](Customize-search-translation-services.md) with web services\", [\"we have few built-in and you can [add your own](https://www.sumatrapdfreader.org/settings/settings3-4#SelectionHandlers)\"], \"installer: `-all-users`\\u00a0cmd-line arg for system-wide install\", \"added `Annotations.TextIconColor` and `TextIconType` advanced settings\", \"added\\u00a0`Annotations.UnderlineColor`\\u00a0advanced setting\", \"added\\u00a0`Annotations.DefaultAuthor`\\u00a0advanced setting\", \"`i` keyboard shortcuts inverts document colors `Shift + i` does what `i` used to do i.e. show page number\", \"`u` and\\u00a0`Shift + u`\\u00a0keyboard shortcuts adds underline annotation for currently selected text\", \"`Delete`\\u00a0/\\u00a0`Backspace`\\u00a0keyboard shortcuts delete an annotation under mouse cursor\", \"support .svg files\", \"faster scrolling with mouse wheel when cursor over scrollbar\", \"add\\u00a0`-search`\\u00a0cmd-line option and\\u00a0`[Search(\\\"<file>\\\", \\\"<search-term>\\\")]`\\u00a0DDE command\", \"a way to get list of used fonts in properties window\", \"support opening `.heic` image files (if Windows heic codec is installed)\", \"add experimental smooth scrolling (enabled with `SmoothScroll` advanced setting)\"], \"3.3.3 (2021-07-20)\": [\"fix a crash in PdfFilter.dll\"], \"3.3.2 (2021-07-19)\": [\"restore showing Table Of Contents for .chm files\", \"fix crashes\"], \"3.3.1 (2021-07-14)\": [\"fix rotation in DjVu documents\"], \"3.3 (2021-07-06)\": [\"added support for adding / removing / editing annotations in PDF files. Read [the tutorial](Editing-annotations.md)\", \"new toolbar\", [\"changed toolbar to scale with DPI by using new, vector icons\", \"added rotate left / right to the toolbar\", \"new toolbar:\"], \"\", \"added ability to hide scrollbar (more screen space for the document). Use right-click context menu.\", \"add `-paperkind=${num}` printing option ([checkin](https://github.com/sumatrapdfreader/sumatrapdf/pull/1815/commits/2104e6104ea759dc4f839c7e8be5973f5a4f0488))\"], \"3.2 (2020-03-15)\": \"This release upgrades the core PDF parsing and rendering library mupdf to the latest version. This fixes PDF rendering bugs and improves performance.\\n\\nAdded support multiple windows with tabs:\\n\\n['added `File / New Window` (`Ctrl-n`) which opens a new window', 'to compare the same file side-by-side, `Ctrl-Shift-n` shortcut opens current file a new window. The same file is now opened in 2 windows that you can re-arrange as needed', '`-new-window` cmd-line option will open the document in new window', 'if you hold `SHIFT` when drag&dropping files from Explorer (and other apps), the file will be opened in a new window']\\n\\nImproved management of favorites:\\n\\n['context menu (right mouse click) on the document area adds menu items for:', ['showing / hiding favorites view', 'adding current page to favorites (or removing if already is in favorites)'], 'context menu in bookmarks view adds menu item for adding selected page to favorites']\\n\\nThis release no longer supports Windows XP. Latest version that support XP is 3.1.2 that you can download from\\n\\n[https://www.sumatrapdfreader.org/download-prev.html](https://www.sumatrapdfreader.org/download-prev.html)\", \"3.1.2 (2016-08-14)\": [\"fixed issue with icons being purple in latest Windows 10 update\", \"tell Windows 10 that SumatraPDF can open supported file types\"], \"3.1.1 (2015-11-02)\": [\"(re)add support for old processors that don\\u2019t have SSE2\", \"support newer versions of unrar.dll\", \"allow keeping browser plugin if it\\u2019s already installed\", \"crash fixes\"], \"3.1 (2015-10-24)\": [\"64bit builds\", \"all documents are restored at startup if a window with multiple tabs is closed (or if closing happened through File -> Exit); this can be disabled through the\\u00a0`RestoreSession`\\u00a0advanced setting\", \"printing happens (again) always as image which leads to more reliable results at the cost of requiring more printer memory; the \\\"Print as Image\\\" advanced printing option has been removed\", \"scrolling with touchpad (e.g. on Surface Pro) now works\", \"many crash and other bug fixes\"], \"3.0 (2014-10-18)\": [\"Tabs! Enabled by default. Use Settings/Options... menu to go back to the old UI\", \"support table of contents and links in ebook UI\", \"add support for PalmDoc ebooks\", \"add support for displaying CB7 and CBT comic books (in addition to CBZ and CBR)\", \"add support for LZMA and PPMd compression in CBZ comic books\", \"allow saving Comic Book files as PDF\", \"swapped keybindings:\", [\"F11 : Fullscreen mode (still also Ctrl+Shift+L)\", \"F5 : Presentation mode (also Shift+F11, still also Ctrl+L)\"], \"added a document measurement UI. Press 'm' to start. Keep pressing 'm' to change measurement units\", \"new advanced settings: FullPathInTitle, UseSysColors (no longer exposed through the Options dialog), UseTabs\", \"replaced non-free UnRAR with a free RAR extraction library. If some CBR files fail to open for you, download unrar.dll from https://www.rarlab.com/rar_add.htm and place it alongside SumatraPDF.exe\", \"deprecated browser plugin. We keep it if was installed in earlier version\"], \"2.5.2 (2014-05-13)\": [\"use less memory for comic book files\", \"PDF rendering fixes\"], \"2.5.1 (2014-05-07)\": [\"hopefully fix frequent ebook crashes\"], \"2.5 (2014-05-05)\": [\"2 page view for ebooks\", \"new keybindings:\", [\"Ctrl+PgDn, Ctrl+Right : go to next page\", \"Ctrl+PgUp, Ctrl+Left : go to previous page\"], \"10x faster ebook layout\", \"support JP2 images\", \"new\\u00a0**[advanced settings](https://www.sumatrapdfreader.org/settings.html)**: ShowMenuBar, ReloadModifiedDocuments, CustomScreenDPI\", \"left/right clicking no longer changes pages in fullscreen mode (use Presentation mode if you rely on this feature)\", \"fixed multiple crashes and made multiple minor improvements\"], \"2.4 (2013-10-01)\": [\"full-screen mode for ebooks (Ctrl-L)\", \"new key bindings:\", [\"F9 - show/hide menu (not remembered after quitting)\", \"F8 - show/hide toolbar\"], \"support WebP images (standalone and in comic books)\", \"support for RAR5 compressed comic books\", \"fixed multiple crashes\"], \"2.3.2 (2013-05-25)\": [\"fix changing a language via Settings/Change Language\"], \"2.3.1 (2013-05-23)\": [\"don't require SSE2 (to support old computers without SSE2 support)\"], \"2.3 (2013-05-22)\": [\"greater configurability via\\u00a0**[advanced settings](https://www.sumatrapdfreader.org/settings.html)**\", \"\\\"Go To Page\\\" in ebook ui\", \"add View/Manga Mode menu item for Comic Book (CBZ/CBR) files\", \"new key bindings:\", [\"Ctrl-Up : page up\", \"Ctrl-Down : page down\"], \"add support for OpenXPS documents\", \"support Deflate64 in Comic Book (CBZ/CBR) files\", \"fixed missing paragraph indentation in EPUB documents\", \"printing with \\\"Use original page sizes\\\" no longer centers pages on paper\", \"reduced size. Installer is ~1MB smaller\", \"downside: this release no longer supports very old processors without\\u00a0**[SSE2 instructions](https://en.wikipedia.org/wiki/SSE2)**. Using SSE2 makes Sumatra faster. If you have an old computer without SSE2, you need to use 2.2.1.\"], \"2.2.1 (2013-01-12)\": [\"fixed ebooks sometimes not remembering the viewing position\", \"fixed Sumatra not exiting when opening files from a network drive\", \"fixes for most frequent crashes and PDF parsing robustness fixes\"], \"2.2 (2012-12-24)\": [\"add support for FictionBook ebook format\", \"add support for PDF documents encrypted with Acrobat X\", \"\\u201cPrint as image\\u201d compatibility option in print dialog for documents that fail to print properly\", \"new command-line option: -manga-mode [1|true|0|false] for proper display of manga comic books\", \"many robustness fixes and small improvements\"], \"2.1.1 (2012-05-07)\": [\"fixes for a few crashes\"], \"2.1 (2012-05-03)\": [\"support for EPUB ebook format\", \"added File/Rename menu item to rename currently viewed file (contributed by Vasily Fomin)\", \"support multi-page TIFF files\", \"support TGA images\", \"support for some comic book (CBZ) metadata\", \"support JPEG XR images (available on Windows Vista or later, for Windows XP the\\u00a0**[Windows Imaging Component](https://www.microsoft.com/en-us/download/details.aspx?id=32)**\\u00a0has to be installed)\", \"the installer is now signed\"], \"2.0.1 (2012-04-08)\": [\"fix loading .mobi files from command line\", \"fix a crash loading multiple .mobi files at once\", \"fix a crash showing tooltips for table of contents tree entries\"], \"2.0 (2012-04-02)\": [\"support for\\u00a0**[MOBI](https://blog.kowalczyk.info/articles/mobi-ebook-reader-viewer-for-windows.html)**\\u00a0eBook format\", \"support opening CHM documents from network drives\", \"a selection can be copied to a clipboard as an image by using right-click context menu\", \"using ucrt to reduce program size\"], \"1.9 (2011-11-23)\": [\"support for\\u00a0**[CHM](https://blog.kowalczyk.info/articles/chm-reader-viewer-for-windows.html)**\\u00a0documents\", \"support touch gestures, available on Windows 7 or later. Contributed by Robert Prouse\", \"open linked audio and video files in an external media player\", \"improved support for PDF transparency groups\"], \"1.8 (2011-09-18)\": [\"improved support for PDF form text fields\", \"various minor improvements and bug fixes\", \"speedup handling some types of djvu files\"], \"1.7 (2011-07-18)\": [\"favorites\", \"improved support for right-to-left languages e.g. Arabic\", \"logical page numbers are displayed and used, if a document provides them (such as i, ii, iii, etc.)\", \"allow to restrict SumatraPDF's features with more granularity; see\\u00a0**[sumatrapdfrestric.init](https://github.com/sumatrapdfreader/sumatrapdf/blob/master/docs/sumatrapdfrestrict.ini)**\\u00a0for documentation\", \"-named-dest also matches strings in table of contents\", \"improved support for EPS files (requires Ghostscript)\", \"more robust installer\", \"many minor improvements and bugfixes\"], \"1.6 (2011-05-30)\": [\"add support for displaying DjVu documents\", \"display Frequently Read list when no document is open\", \"add support for displaying Postscript documents (requires recent Ghostscript version to be already installed)\", \"add support for displaying a folder containing images: drag the folder to SumatraPDF window\", \"support clickable links and a Table of Content for XPS documents\", \"display printing progress and allow to cancel it\", \"add Print toolbar button\", \"experimental: previewing of PDF documents in Windows Vista and 7. Creates thumbnails and displays documents in Explorer's Preview pane. Needs to be explicitly selected during install process. We've had reports that it doesn't work on Windows 7 x64.\"], \"1.5.1 (2011-04-26)\": [\"fixes for rare crashes\"], \"1.5 (2011-04-23)\": [\"add support for viewing XPS documents\", \"add support for viewing CBZ and CBR comic books\", \"add File/Save Shortcut menu item to create shortcuts to a specific place in a document\", \"add context menu for copying text, link addresses and comments. In browser plugin it also adds saving and printing commands\", \"add folder browsing (Ctrl+Shift+Right opens next PDF document in the current folder, Ctrl+Shift+Left opens previous document)\"], \"1.4 (2011-03-12)\": [\"browser plugin for Firefox/Chrome/Opera (Internet Explorer is not supported). It's not installed by default so you have to check the apropriate checkbox in the installer\", \"IFilter that enables full-text search of PDF files in Windows Desktop Search (i.e. search from Windows Vista/7's Start Menu). Also not installed by default\", \"scrolling with right mouse button\", \"you can choose a custom installation directory in the installer\", \"menu items for re-opening current document in Foxit and PDF-XChange (if they're installed)\", \"we no longer compress the installer executable with mpress. It caused some anti-virus programs to falsely report Sumatra as a virus. The downside is that the binaries on disk are now bigger. Note: we still compress the portable .zip version\", \"-title cmd-line option was removed\", \"support for AES-256 encrypted PDF documents\", \"fixed an integer overflow reported by Jeroen van der Gun and and other small fixes and improvements to PDF handling\"], \"1.3 (2011-02-04)\": [\"improved text selection and copying. We now mimic the way a browser or Adobe Reader works: just select text with mouse and use Ctrl-C to copy it to a clipboard\", \"Shift+Left Mouse now scrolls the document, Ctrl+Left mouse still creates a rectangular selection (for copying images)\", \"'c' shortcut toggles continuous mode\", \"'+' / '\\\\*' on the numeric keyboard now do zoom and rotation\", \"added toolbar icons for Fit Page and Fit Width and updated the look of toolbar icons\", \"add support for back/forward mouse buttons for back/forward navigation\", \"1.2 introduces a new full screen mode and made it the default full screen mode. Old mode was still available but not easily discoverable. We've added View/Presentation menu item for new full screen mode and View/Fullscreen menu item for the old full screen mode, to make it more discoverable\", \"new, improved installer\", \"improved zoom performance (zooming to 6400% no longer crashes)\", \"text find uses less memory\", \"further printing improvements\", \"translation updates\", \"updated to latest mupdf for misc bugfixes and improvements\", \"use libjpeg-turbo library instead of libjpeg, for faster decoding of some PDFs\", \"updated openjpeg library to version 1.4 and freetype to version 2.4.4\", \"fixed 2 integer overflows reported by Stefan Cornelius from Secunia Research\"], \"1.2 (2010-11-26)\": [\"improved printing: faster and uses less resources\", \"add Ctrl-Y as a shortcut for Custom Zoom\", \"add Ctrl-A as a shortcut for Select All Text\", \"improved full screen mode\", \"open embedded PDF documents\", \"allow saving PDF document attachements to disk\", \"latest fixes and improvements to PDF rendering from mupdf project\"], \"1.1 (2010-05-20)\": [\"added book view (\\u201cView/Book View\\u201d menu item) option. It\\u2019s known as \\u201cShow Cover Page During Two-Up\\u201d in Adobe Reader\", \"added \\u201cFile/Properties\\u201d menu item, showing basic information about\\u00a0PDF\\u00a0file\", \"added \\u201cFile/Send by email\\u201d menu\", \"added export as text. When doing \\u201cFile/Save As\\u201d, change \\u201cSave As types\\u201d from \\u201c\\u00a0PDF\\u00a0documents\\u201d to \\u201cText documents\\u201d. Don\\u2019t expect miracles, though. Conversion to text is not very good in most cases.\", \"auto-detect commonly used TeX editors for inverse-search command\", \"bug fixes to\\u00a0PDF\\u00a0handling (more PDFs are shown correctly)\", \"misc bug fixes and small improvements in UI\", \"add Ctrl + and Ctrl \\u2013 as shortcuts for zooming (matches Adobe Reader)\"], \"1.0.1 (2009-11-27)\": [\"many memory leaks fixed (Simon B\\u00fcnzli)\", \"potential crash due to stack corruption (pointed out by Christophe Devine)\", \"making Sumatra default PDF reader no longer asks for admin priviledges on Vista/Windows 7\", \"translation updates\"], \"1.0 (2009-11-17)\": [\"lots of small bug fixes and improvements\"], \"0.9.4 (2009-07-19)\": [\"improved PDF compatibility (more types of documents can be rendered)\", \"added settings dialog (contributed by Simon B\\u00fcnzli)\", \"improvements in handling unicode\", \"changed default view from single page to continuous\", \"SyncTex improvements (contributed by William Blum)\", \"add option to not remember opened files\", \"a new icon for documents association (contributed by George Georgiou)\", \"lots of bugfixes and UI polish\"], \"0.9.3 (2008-10-07)\": [\"fix an issue with opening non-ascii files\", \"updated Japanese and Brazillian translation\"], \"0.9.2 (2008-10-06)\": [\"ability to disable auto-update check\", \"improved text rendering - should fix problems with overlapping text\", \"improved font substition for fonts not present in PDF file\", \"can now open PDF files with non-ascii names\", \"improvements to DDE (contributed by Danilo Roascio)\", \"SyncTex improvements\", \"improve persistance of state (contributed by Robert Liu)\", \"fix crash when pressing 'Cancel' when entering a password\", \"updated translations\"], \"0.9.1 (2008-08-22)\": [\"improved rendering of some PDFs\", \"support for links inside PDF file\", \"added -restrict and -title cmd-line options (contributed by Matthew Wilcoxson)\", \"enabled SyncTex support which mistakenly disabled in 0.9\", \"misc fixes and translation updates\"], \"0.9 (2008-08-10)\": [\"add Ctrl-P as print shortcut\", \"add F11 as full-screen shortcut\", \"password dialog no longer shows the password\", \"support for AES-encrypted PDF files\", \"updates to SyncTeX/PdfSync integration (contributed by William Blum)\", \"add -nameddest command-line option and DDE commands for jumping to named destination(contributed by Alexander Klenin)\", \"add -reuse-instance command-line option (contributed by William Blum)\", \"add DDE command to open PDF file (contributed by William Blum)\", \"removed poppler rendering engine resulting in smaller program and updated to latest mupdf sources\", \"misc bugfixes and translation updates\"], \"0.8.1 (2008-05-27)\": [\"automatic reloading of changed PDFs (contributed by William Blum)\", \"tex integration (contributed by William Blum)\", \"updated icon for case-sensitivity selection in find (contributed by Sonke Tesch)\", \"language change is now a separate dialog instead of a menu\", \"remember more settings (like default view)\", \"automatic checks for new versions\", \"add command-line option -lang $lang\", \"add command-line option -print-dialog (contributed by Peter Astrand)\", \"ESC or single mouse click hides selection\", \"fix showing boxes in table of contents tree\", \"translation updates\"], \"0.8 (2008-01-01)\": [\"added search (contributed by MrChuoi)\", \"added table of contents (contributed by MrChuoi)\", \"added many translation\", \"new program icon\", \"fixed printing\", \"fixed some crashes\", \"rendering speedups\", \"fixed loading of some PDFs\", \"add command-line option -esc-to-exit\", \"add command-line option -bgcolor $color\"], \"0.7 (2007-07-28)\": [\"added ability to select the text and copy to clipboard - contributed by Tomek Weksej\", \"made it multi-lingual (13 translations)\", \"added Save As option\", \"list of recently opened files is updated immediately\", \"fixed .pdf extension registration on Vista\", \"added ability to compile as DLL and C# sample application - contributed by Valery Possoz\", \"mingw compilation fixes and project files for CodeBlocks - contributed by MrChuoi\", \"fixed a few crashes\", \"moved the sources to Google Code project hosting\"], \"0.6 (2007-04-29)\": [\"enable opening password-protected PDFs\", \"don't allow printing in PDFs that have printing forbidden\", \"don't automatically reopen files at startup\", \"fix opening PDFs from network shares\", \"new, better icon\", \"reload the document when changing rendering engine\", \"improve cursor shown when dragging\", \"fix toolbar appearance on XP and Vista with classic theme\", \"when MuPDF engine cannot load a file or render a page, we fallback to poppler engine to make rendering more robust\", \"fixed a few crashes\"], \"0.5 (2007-03-04)\": [\"fixed rendering problems with some PDF files\", \"speedups - the application should feel be snappy and there should be less waiting for rendering\", \"added 'r' keybinding for reloading currently open PDF file\", \"added <Ctrl>-<Shift>-+ and <Ctrl>-<Shift>-- keybindings to rotate clockwise and counter-clockwise (just like Acrobat Reader)\", \"fixed a crash or two\"], \"0.4 (2007-02-18)\": [\"printing\", \"ask before registering as a default handler for PDF files\", \"faster rendering thanks to alternative PDF rendering engine. Previous engine is available as well.\", \"scrolling with mouse wheel\", \"fix toolbar issues on win2k\", \"improve the way fonts directory is found\", \"improvements to portable mode\", \"uninstaller completely removes the program\", \"changed name of preferences files from prefs.txt to sumatrapdfprefs.txt\"], \"0.3 (2006-11-25)\": [\"added toolbar for most frequently used operations\", \"should be more snappy because rendering is done in background and it caches one page ahead\", \"some things are faster\"], \"0.2 (2006-08-06)\": [\"added facing, continuous and continuous facing viewing modes\", \"remember history of opened files\", \"session saving i.e. on exit remember which files are opened and restore the session when the program is started without any command-line parameters\", \"ability to open encrypted files\", \"\\\"Go to page dialog\\\"\", \"less invasive (less yellow) icon that doesn't jump at you on desktop\", \"fixed problem where sometimes text wouldn't show (better mapping for fonts; use a default font if can't find the font specified in PDF file)\", \"handle URI links inside PDF documents\", \"show \\\"About\\\" screen\", \"provide a download in a .zip file for those who can't run installation program\", \"switched to poppler code instead of xpdf\"], \"0.1 (2006-06-01)\": [\"first version released\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 37]\"}, {\"title\": \"Why Only Windows\", \"description\": null, \"content\": {\"Why only Windows?\": \"People sometimes suggest that Sumatra should be available for some other operating system: Linux, Mac, Android etc.\\n\\nThis won't happen.\\n\\nThe first reason is that current developers don't know how to write software for those other platforms.\\n\\nSecond reason is that it would mean writing the whole program from scratch for a new platform.\\n\\nSumatra is tightly integrated with and optimized for Windows. Making a version for another operating system is not a matter of making a few changes here and there but writing all the UI code from scratch i.e. redoing years of development that went into Sumatra.\\n\\nSumatraPDF is an open-source project so anyone is free to take our source code and use as much of it as they want to create equivalent for some other operating system, but we're unlikely to do it ourselves.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0, \\\"subpages\\\", 38]\"}], \"path\": \"[\\\"subpages\\\", 0]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Document Processing Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Format Document Parsing and Rendering\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"PDF Processing Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Text Extraction and Search Engine\", \"weight\": 3}, {\"requirements\": \"Annotation Subsystem\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Highlight and Text Selection Engine\", \"weight\": 3}, {\"requirements\": \"Annotation Editor Interface - Visual editing and manipulation tools\", \"weight\": 2}, {\"requirements\": \"Annotation Persistence Layer - Serializes and saves annotation data back into source PDF files\", \"weight\": 3}]}]}, {\"requirements\": \"eBook Format Handler - Specialized rendering for EPUB, MOBI and other electronic book formats\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"eBook UI Rendering System - Alternative interface optimized for reading experience\", \"weight\": 2}]}, {\"requirements\": \"Additional Format Support - XPS, CHM, HEIF and other image format processors\", \"weight\": 1}, {\"requirements\": \"Unified UI Framework - Applies consistent interface patterns across different document types\", \"weight\": 2}]}, {\"requirements\": \"Document Rendering Pipeline\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Zoom and View Management System\", \"weight\": 3}, {\"requirements\": \"Page Navigation Engine - Handles document traversal, positioning and named destinations\", \"weight\": 3}, {\"requirements\": \"Presentation Mode Renderer - Full-screen and slideshow capabilities\", \"weight\": 2}]}, {\"requirements\": \"Accessibility Layer\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Platform Accessibility API Integration - Exposes document content through Microsoft UI Automation\", \"weight\": 3}, {\"requirements\": \"Text-to-Speech Integration - Screen reader compatibility with Microsoft Narrator and other assistive technologies\", \"weight\": 3}]}]}, {\"requirements\": \"User Interface Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Window and Session Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Tab Management Engine - Multi-document interface with state persistence\", \"weight\": 3}, {\"requirements\": \"Session State Management - Persists open files, viewing history, favorites and last-viewed positions\", \"weight\": 2}]}, {\"requirements\": \"Command System Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Command Registry - Maintains internal commands for all application functions\", \"weight\": 3}, {\"requirements\": \"Command Palette Interface - Text-based searching and execution of internal commands\", \"weight\": 2}, {\"requirements\": \"Menu and Toolbar Command Dispatcher\", \"weight\": 2}]}, {\"requirements\": \"Input Processing System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Keyboard Shortcut Engine - Maps user-defined shortcuts to internal command registry\", \"weight\": 2}, {\"requirements\": \"Mouse and Touch Navigation Handler\", \"weight\": 2}]}, {\"requirements\": \"Theme and Customization Engine\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Color Theme System - Applies custom color values for various UI elements\", \"weight\": 2}, {\"requirements\": \"Toolbar Customization Engine - Dynamically builds toolbar with custom icons based on configuration\", \"weight\": 2}]}]}, {\"requirements\": \"System Integration and External Control\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Command-Line Interface\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Argument Parser - Controls application startup behavior including file opening, navigation, and printing\", \"weight\": 3}, {\"requirements\": \"Developer and Debug Option Handler\", \"weight\": 1}]}, {\"requirements\": \"Dynamic Data Exchange (DDE) Server\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"DDE Command Parser - Handles file operations, navigation and view settings from external applications\", \"weight\": 3}, {\"requirements\": \"Forward Search Engine - Enables external LaTeX editors to jump to specific document locations\", \"weight\": 3}]}, {\"requirements\": \"External Application Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Inverse Search Handler - Invokes configured external editors with file and line number parameters\", \"weight\": 3}, {\"requirements\": \"External Viewer Integration - Configurable handlers for specific file types or links\", \"weight\": 1}, {\"requirements\": \"Search and Translation Service Integration - User-defined URLs for external web services\", \"weight\": 1}]}, {\"requirements\": \"Operating System Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"File Association Manager - Registers as default handler for supported file types\", \"weight\": 2}, {\"requirements\": \"Printing Subsystem - Document output to physical printers\", \"weight\": 2}]}]}, {\"requirements\": \"Configuration and Settings Management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Settings Persistence Layer\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Configuration File Parser - Manages settings from SumatraPDF-settings.txt\", \"weight\": 3}, {\"requirements\": \"Advanced Settings Engine - Applies complex configurations that modify core application behaviors\", \"weight\": 2}, {\"requirements\": \"Deployment Mode Awareness - Adjusts settings storage location based on Installer vs Portable mode\", \"weight\": 3}]}, {\"requirements\": \"Restricted Use Configuration\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Policy Enforcement Engine - Disables features like printing, saving, and settings changes in restricted mode\", \"weight\": 2}]}]}, {\"requirements\": \"Application Infrastructure and Deployment\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Installation and Distribution System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Installer Framework - Command-line support for silent and customized deployment\", \"weight\": 2}, {\"requirements\": \"Portable Mode Support - Self-contained execution without installation requirements\", \"weight\": 2}]}, {\"requirements\": \"Diagnostics and Error Handling\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Crash Reporting System - Collects and submits diagnostic data for application failures\", \"weight\": 2}, {\"requirements\": \"Logging and Trace System - Debug information accessible via developer options or external tools\", \"weight\": 1}]}, {\"requirements\": \"Build System Architecture\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Premake-based Compilation Framework - Supports multiple build configurations and variants\", \"weight\": 1}]}, {\"requirements\": \"Update Management System\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Version Checking and Update Notifications\", \"weight\": 1}]}]}]}"}}},{"rowIdx":18,"cells":{"repo_name":{"kind":"string","value":"svelte"},"repo_url":{"kind":"string","value":"https://github.com/sveltejs/svelte"},"commit_id":{"kind":"string","value":"be645b4d9f84cb7580683c7b2336d1023906c4da"},"docs_tree":{"kind":"string","value":"{\"title\": \"svelte\", \"description\": \"Documentation for svelte\", \"subpages\": [{\"title\": \"Svelte\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"root\": []}}, {\"title\": \"01 Introduction\", \"description\": \"Documentation section: 01-introduction\", \"path\": \"[\\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"Overview\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Getting started\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"Alternatives to SvelteKit\": \"<detail_content>\", \"Editor tooling\": \"<detail_content>\", \"Getting help\": \"<detail_content>\"}}, {\"title\": \".svelte files\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"`<script>`\": \"<detail_content>\", \"`<script module>`\": \"<detail_content>\", \"`<style>`\": \"<detail_content>\"}}, {\"title\": \".svelte.js and .svelte.ts files\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Introduction\", \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 4]\", \"content\": {\"root\": []}}]}, {\"title\": \"02 Runes\", \"description\": \"Documentation section: 02-runes\", \"path\": \"[\\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"What are runes?\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"root\": [\"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"$state\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"`$state.raw`\": \"<detail_content>\", \"`$state.snapshot`\": \"<detail_content>\", \"Passing state into functions\": \"<detail_content>\", \"Passing state across modules\": \"<detail_content>\"}}, {\"title\": \"$derived\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"`$derived.by`\": \"<detail_content>\", \"Understanding dependencies\": \"<detail_content>\", \"Overriding derived values\": \"<detail_content>\", \"Deriveds and reactivity\": \"<detail_content>\", \"Destructuring\": \"<detail_content>\", \"Update propagation\": \"<detail_content>\"}}, {\"title\": \"$effect\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"`$effect.pre`\": \"<detail_content>\", \"`$effect.tracking`\": \"<detail_content>\", \"`$effect.pending`\": \"<detail_content>\", \"`$effect.root`\": \"<detail_content>\", \"When not to use `$effect`\": \"<detail_content>\"}}, {\"title\": \"$props\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"Fallback values\": \"<detail_content>\", \"Renaming props\": \"<detail_content>\", \"Rest props\": \"<detail_content>\", \"Updating props\": \"<detail_content>\", \"Type safety\": \"<detail_content>\", \"`$props.id()`\": \"<detail_content>\"}}, {\"title\": \"$bindable\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"$inspect\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\", \"content\": {\"$inspect(...).with\": \"<detail_content>\", \"$inspect.trace(...)\": \"<detail_content>\"}}, {\"title\": \"$host\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Runes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\", \"content\": {\"root\": []}}]}, {\"title\": \"03 Template Syntax\", \"description\": \"Documentation section: 03-template-syntax\", \"path\": \"[\\\"subpages\\\", 3]\", \"subpages\": [{\"title\": \"Basic markup\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\", \"content\": {\"Tags\": \"<detail_content>\", \"Element attributes\": \"<detail_content>\", \"Component props\": \"<detail_content>\", \"Spread attributes\": \"<detail_content>\", \"Events\": {\"Event delegation\": \"<detail_content>\"}, \"Text expressions\": \"<detail_content>\", \"Comments\": \"<detail_content>\"}}, {\"title\": \"02 If\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"03 Each\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\", \"content\": {\"Keyed each blocks\": \"<detail_content>\", \"Each blocks without an item\": \"<detail_content>\", \"Else blocks\": \"<detail_content>\"}}, {\"title\": \"04 Key\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"05 Await\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"Passing snippets to components\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\", \"content\": {\"Explicit props\": \"<detail_content>\", \"Implicit props\": \"<detail_content>\", \"Implicit `children` snippet\": \"<detail_content>\", \"Optional snippet props\": \"<detail_content>\"}}, {\"title\": \"07 @Render\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\", \"content\": {\"Optional snippets\": \"<detail_content>\"}}, {\"title\": \"08 @Html\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\", \"content\": {\"Styling\": \"<detail_content>\"}}, {\"title\": \"09 @Attach\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\", \"content\": {\"Attachment factories\": \"<detail_content>\", \"Inline attachments\": \"<detail_content>\", \"Passing attachments to components\": \"<detail_content>\", \"Controlling when attachments re-run\": \"<detail_content>\", \"Creating attachments programmatically\": \"<detail_content>\", \"Converting actions to attachments\": \"<detail_content>\"}}, {\"title\": \"10 @Const\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"11 @Debug\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"12 Bind\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11]\", \"content\": {\"Function bindings\": \"<detail_content>\", \"`<input bind:value>`\": \"<detail_content>\", \"`<input bind:checked>`\": \"<detail_content>\", \"`<input bind:indeterminate>`\": \"<detail_content>\", \"`<input bind:group>`\": \"<detail_content>\", \"`<input bind:files>`\": \"<detail_content>\", \"`<select bind:value>`\": \"<detail_content>\", \"`<audio>`\": \"<detail_content>\", \"`<video>`\": \"<detail_content>\", \"`<img>`\": \"<detail_content>\", \"`<details bind:open>`\": \"<detail_content>\", \"`window` and `document`\": \"<detail_content>\", \"Contenteditable bindings\": \"<detail_content>\", \"Dimensions\": \"<detail_content>\", \"bind:this\": \"<detail_content>\", \"bind:_property_ for components\": \"<detail_content>\"}}, {\"title\": \"13 Use\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12]\", \"content\": {\"Typing\": \"<detail_content>\"}}, {\"title\": \"14 Transition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13]\", \"content\": {\"Local vs global\": \"<detail_content>\", \"Built-in transitions\": \"<detail_content>\", \"Transition parameters\": \"<detail_content>\", \"Custom transition functions\": \"<detail_content>\", \"Transition events\": \"<detail_content>\"}}, {\"title\": \"15 In And Out\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"16 Animate\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15]\", \"content\": {\"Animation Parameters\": \"<detail_content>\", \"Custom animation functions\": \"<detail_content>\"}}, {\"title\": \"17 Style\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16]\", \"content\": {\"root\": [[], \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\", \"<detail_content>\"]}}, {\"title\": \"class\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17]\", \"content\": {\"Attributes\": {\"Objects and arrays\": \"<detail_content>\"}, \"The `class:` directive\": \"<detail_content>\"}}, {\"title\": \"await\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 18]\", \"content\": {\"Boundaries\": \"<detail_content>\", \"Synchronized updates\": \"<detail_content>\", \"Concurrency\": \"<detail_content>\", \"Indicating loading states\": \"<detail_content>\", \"Error handling\": \"<detail_content>\", \"Caveats\": \"<detail_content>\", \"Breaking changes\": \"<detail_content>\"}}, {\"title\": \"Template syntax\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 19]\", \"content\": {\"root\": []}}]}, {\"title\": \"04 Styling\", \"description\": \"Documentation section: 04-styling\", \"path\": \"[\\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"Scoped styles\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"Specificity\": \"<detail_content>\", \"Scoped keyframes\": \"<detail_content>\"}}, {\"title\": \"Global styles\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\", \"content\": {\":global(...)\": \"<detail_content>\", \":global\": \"<detail_content>\"}}, {\"title\": \"Custom properties\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Nested <style> elements\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 3]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Styling\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 4]\", \"content\": {\"root\": []}}]}, {\"title\": \"05 Special Elements\", \"description\": \"Documentation section: 05-special-elements\", \"path\": \"[\\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"<svelte:boundary>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"Properties\": {\"`pending`\": \"<detail_content>\", \"`failed`\": \"<detail_content>\", \"`onerror`\": \"<detail_content>\"}}}, {\"title\": \"<svelte:window>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:document>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:body>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 3]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:head>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 4]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:element>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 5]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:options>\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 6]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Special elements\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 7]\", \"content\": {\"root\": []}}]}, {\"title\": \"06 Runtime\", \"description\": \"Documentation section: 06-runtime\", \"path\": \"[\\\"subpages\\\", 6]\", \"subpages\": [{\"title\": \"Stores\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\", \"content\": {\"When to use stores\": \"<detail_content>\", \"svelte/store\": {\"`writable`\": \"<detail_content>\", \"`readable`\": \"<detail_content>\", \"`derived`\": \"<detail_content>\", \"`readonly`\": \"<detail_content>\", \"`get`\": \"<detail_content>\"}, \"Store contract\": \"<detail_content>\"}}, {\"title\": \"Context\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\", \"content\": {\"Using context with state\": \"<detail_content>\", \"Type-safe context\": \"<detail_content>\", \"Replacing global state\": \"<detail_content>\"}}, {\"title\": \"Lifecycle hooks\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\", \"content\": {\"`onMount`\": \"<detail_content>\", \"`onDestroy`\": \"<detail_content>\", \"`tick`\": \"<detail_content>\", \"Deprecated: `beforeUpdate` / `afterUpdate`\": {\"Chat window example\": \"<detail_content>\"}}}, {\"title\": \"Imperative component API\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\", \"content\": {\"`mount`\": \"<detail_content>\", \"`unmount`\": \"<detail_content>\", \"`render`\": \"<detail_content>\", \"`hydrate`\": \"<detail_content>\"}}, {\"title\": \"Runtime\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\", \"content\": {\"root\": []}}]}, {\"title\": \"07 Misc\", \"description\": \"Documentation section: 07-misc\", \"path\": \"[\\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"Testing\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"Unit and integration testing using Vitest\": {\"Using runes inside your test files\": \"<detail_content>\", \"Component testing\": \"<detail_content>\"}, \"E2E tests using Playwright\": \"<detail_content>\"}}, {\"title\": \"TypeScript\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"`<script lang=\\\"ts\\\">`\": \"<detail_content>\", \"Preprocessor setup\": {\"Using SvelteKit or Vite\": \"<detail_content>\", \"Other build tools\": \"<detail_content>\"}, \"tsconfig.json settings\": \"<detail_content>\", \"Typing `$props`\": \"<detail_content>\", \"Generic `$props`\": \"<detail_content>\", \"Typing wrapper components\": \"<detail_content>\", \"Typing `$state`\": \"<detail_content>\", \"The `Component` type\": \"<detail_content>\", \"Enhancing built-in DOM types\": \"<detail_content>\"}}, {\"title\": \"Custom elements\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"Component lifecycle\": \"<detail_content>\", \"Component options\": \"<detail_content>\", \"Caveats and limitations\": \"<detail_content>\"}}, {\"title\": \"Svelte 4 migration guide\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"Minimum version requirements\": \"<detail_content>\", \"Browser conditions for bundlers\": \"<detail_content>\", \"Removal of CJS related output\": \"<detail_content>\", \"Stricter types for Svelte functions\": \"<detail_content>\", \"Custom Elements with Svelte\": \"<detail_content>\", \"SvelteComponentTyped is deprecated\": \"<detail_content>\", \"Transitions are local by default\": \"<detail_content>\", \"Default slot bindings\": \"<detail_content>\", \"Preprocessors\": \"<detail_content>\", \"New eslint package\": \"<detail_content>\", \"Other breaking changes\": \"<detail_content>\"}}, {\"title\": \"Svelte 5 migration guide\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"Reactivity syntax changes\": {\"let \\u2192 $state\": \"<detail_content>\", \"$: \\u2192 $derived/$effect\": \"<detail_content>\", \"export let \\u2192 $props\": \"<detail_content>\"}, \"Event changes\": {\"Component events\": \"<detail_content>\", \"Bubbling events\": \"<detail_content>\", \"Event modifiers\": \"<detail_content>\", \"Multiple event handlers\": \"<detail_content>\"}, \"Snippets instead of slots\": {\"Default content\": \"<detail_content>\", \"Multiple content placeholders\": \"<detail_content>\", \"Passing data back up\": \"<detail_content>\"}, \"Migration script\": {\"run\": \"<detail_content>\", \"Event modifiers\": \"<detail_content>\", \"Things that are not automigrated\": \"<detail_content>\"}, \"Components are no longer classes\": {\"Server API changes\": \"<detail_content>\", \"Component typing changes\": \"<detail_content>\", \"bind:this changes\": \"<detail_content>\"}, \"`<svelte:component>` is no longer necessary\": {\"Dot notation indicates a component\": \"<detail_content>\"}, \"Whitespace handling changed\": \"<detail_content>\", \"Modern browser required\": \"<detail_content>\", \"Changes to compiler options\": \"<detail_content>\", \"The `children` prop is reserved\": \"<detail_content>\", \"Breaking changes in runes mode\": {\"Bindings to component exports are not allowed\": \"<detail_content>\", \"Bindings need to be explicitly defined using `$bindable()`\": \"<detail_content>\", \"`accessors` option is ignored\": \"<detail_content>\", \"`immutable` option is ignored\": \"<detail_content>\", \"Classes are no longer \\\"auto-reactive\\\"\": \"<detail_content>\", \"Touch and wheel events are passive\": \"<detail_content>\", \"Attribute/prop syntax is stricter\": \"<detail_content>\", \"HTML structure is stricter\": \"<detail_content>\"}, \"Other breaking changes\": {\"Stricter `@const` assignment validation\": \"<detail_content>\", \":is(...), :has(...), and :where(...) are scoped\": \"<detail_content>\", \"CSS hash position no longer deterministic\": \"<detail_content>\", \"Scoped CSS uses :where(...)\": \"<detail_content>\", \"Error/warning codes have been renamed\": \"<detail_content>\", \"Reduced number of namespaces\": \"<detail_content>\", \"beforeUpdate/afterUpdate changes\": \"<detail_content>\", \"`contenteditable` behavior change\": \"<detail_content>\", \"`oneventname` attributes no longer accept string values\": \"<detail_content>\", \"`null` and `undefined` become the empty string\": \"<detail_content>\", \"`bind:files` values can only be `null`, `undefined` or `FileList`\": \"<detail_content>\", \"Bindings now react to form resets\": \"<detail_content>\", \"`walk` no longer exported\": \"<detail_content>\", \"Content inside `svelte:options` is forbidden\": \"<detail_content>\", \"`<slot>` elements in declarative shadow roots are preserved\": \"<detail_content>\", \"`<svelte:element>` tag must be an expression\": \"<detail_content>\", \"`mount` plays transitions by default\": \"<detail_content>\", \"`<img src={...}>` and `{@html ...}` hydration mismatches are not repaired\": \"<detail_content>\", \"Hydration works differently\": \"<detail_content>\", \"`onevent` attributes are delegated\": \"<detail_content>\", \"`--style-props` uses a different element\": \"<detail_content>\"}}}, {\"title\": \"Frequently asked questions\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"content\": {\"I'm new to Svelte. Where should I start?\": \"<detail_content>\", \"Where can I get support?\": \"<detail_content>\", \"Are there any third-party resources?\": \"<detail_content>\", \"How can I get VS Code to syntax-highlight my .svelte files?\": \"<detail_content>\", \"Is there a tool to automatically format my .svelte files?\": \"<detail_content>\", \"How do I document my components?\": \"<detail_content>\", \"Does Svelte scale?\": \"<detail_content>\", \"Is there a UI component library?\": \"<detail_content>\", \"How do I test Svelte apps?\": \"<detail_content>\", \"Is there a router?\": \"<detail_content>\", \"How do I write a mobile app with Svelte?\": \"<detail_content>\", \"Can I tell Svelte not to remove my unused styles?\": \"<detail_content>\", \"Is Svelte v2 still available?\": \"<detail_content>\", \"How do I do hot module reloading?\": \"<detail_content>\"}}, {\"title\": \"Misc\", \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 6]\", \"content\": {\"root\": []}}]}, {\"title\": \"98 Reference\", \"description\": \"Documentation section: 98-reference\", \"path\": \"[\\\"subpages\\\", 8]\", \"subpages\": [{\"title\": \"svelte\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 0]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/action\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"svelte/animate\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 2]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/attachments\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 3]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/compiler\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 4]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/easing\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 5]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/events\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 6]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/legacy\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 7]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"svelte/motion\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 8]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/reactivity/window\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 9]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"svelte/reactivity\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 10]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"svelte/server\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 11]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/store\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 12]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"svelte/transition\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 13]\", \"content\": {\"root\": [\"<detail_content>\"]}}, {\"title\": \"Compiler errors\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 14]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Compiler warnings\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 15]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Runtime errors\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 16]\", \"content\": {\"Client errors\": \"<detail_content>\", \"Server errors\": \"<detail_content>\", \"Shared errors\": \"<detail_content>\"}}, {\"title\": \"Runtime warnings\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 17]\", \"content\": {\"Client warnings\": \"<detail_content>\", \"Shared warnings\": \"<detail_content>\"}}, {\"title\": \"Reference\", \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 18]\", \"content\": {\"root\": []}}]}, {\"title\": \"99 Legacy\", \"description\": \"Documentation section: 99-legacy\", \"path\": \"[\\\"subpages\\\", 9]\", \"subpages\": [{\"title\": \"Overview\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 0]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Reactive let/var declarations\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 1]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"02 Legacy Reactive Assignments\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 2]\", \"content\": {\"Understanding dependencies\": \"<detail_content>\", \"Browser-only code\": \"<detail_content>\"}}, {\"title\": \"export let\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 3]\", \"content\": {\"Component exports\": \"<detail_content>\", \"Renaming props\": \"<detail_content>\"}}, {\"title\": \"$$props and $$restProps\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 4]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"10 Legacy On\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 5]\", \"content\": {\"Component events\": \"<detail_content>\"}}, {\"title\": \"<slot>\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 6]\", \"content\": {\"Named slots\": \"<detail_content>\", \"Fallback content\": \"<detail_content>\", \"Passing data to slotted content\": \"<detail_content>\"}}, {\"title\": \"$$slots\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:fragment>\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 8]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:component>\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 9]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"<svelte:self>\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 10]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Imperative component API\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 11]\", \"content\": {\"Creating a component\": \"<detail_content>\", \"`$set`\": \"<detail_content>\", \"`$on`\": \"<detail_content>\", \"`$destroy`\": \"<detail_content>\", \"Component props\": \"<detail_content>\", \"Server-side component API\": \"<detail_content>\"}}, {\"title\": \"Legacy APIs\", \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 12]\", \"content\": {\"root\": []}}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"svelte\", \"description\": \"Documentation for svelte\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs\"}, \"subpages\": [{\"title\": \"Svelte\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Svelte\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"01 Introduction\", \"description\": \"Documentation section: 01-introduction\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/01-introduction\"}, \"subpages\": [{\"title\": \"Overview\", \"description\": null, \"content\": {\"root\": [\"Svelte is a framework for building user interfaces on the web. It uses a compiler to turn declarative components written in HTML, CSS and JavaScript...\", \"```\\n<!--- file: App.svelte --->\\n<script>\\n function greet() {\\n alert('Welcome to Svelte!');\\n }\\n</script>\\n\\n<button onclick={greet}>click me</button>\\n\\n<style>\\n button {\\n font-size: 2em;\\n }\\n</style>\\n```\", \"...into lean, tightly optimized JavaScript.\", \"You can use it to build anything on the web, from standalone components to ambitious full stack apps (using Svelte's companion application framework, [SvelteKit](../kit)) and everything in between.\", \"These pages serve as reference documentation. If you're new to Svelte, we recommend starting with the [interactive tutorial](/tutorial) and coming back here when you have questions.\", \"You can also try Svelte online in the [playground](/playground) or, if you need a more fully-featured environment, on [StackBlitz](https://sveltekit.new).\"]}, \"metadata\": {\"title\": \"Overview\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Getting started\", \"description\": null, \"content\": {\"Alternatives to SvelteKit\": \"You can also use Svelte directly with Vite by running `npm create vite@latest` and selecting the `svelte` option. With this, `npm run build` will generate HTML, JS, and CSS files inside the `dist` directory using [vite-plugin-svelte](https://github.com/sveltejs/vite-plugin-svelte). In most cases, you will probably need to [choose a routing library](faq#Is-there-a-router) as well.\\n\\n['[!NOTE] Vite is often used in standalone mode to build [single page apps (SPAs)](../kit/glossary#SPA), which you can also [build with SvelteKit](../kit/single-page-apps).']\\n\\nThere are also plugins for [Rollup](https://github.com/sveltejs/rollup-plugin-svelte), [Webpack](https://github.com/sveltejs/svelte-loader) [and a few others](https://sveltesociety.dev/packages?category=build-plugins), but we recommend Vite.\", \"Editor tooling\": \"The Svelte team maintains a [VS Code extension](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode), and there are integrations with various other [editors](https://sveltesociety.dev/resources#editor-support) and tools as well.\\n\\nYou can also check your code from the command line using [sv check](https://github.com/sveltejs/cli).\", \"Getting help\": \"Don't be shy about asking for help in the [Discord chatroom](/chat)! You can also find answers on [Stack Overflow](https://stackoverflow.com/questions/tagged/svelte).\"}, \"metadata\": {\"title\": \"Getting started\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \".svelte files\", \"description\": null, \"content\": {\"`<script>`\": \"A `<script>` block contains JavaScript (or TypeScript, when adding the `lang=\\\"ts\\\"` attribute) that runs when a component instance is created. Variables declared (or imported) at the top level can be referenced in the component's markup.\\n\\nIn addition to normal JavaScript, you can use _runes_ to declare [component props]($props) and add reactivity to your component. Runes are covered in the next section.\\n\\n<!-- TODO describe behaviour of `export` -->\", \"`<script module>`\": \"A `<script>` tag with a `module` attribute runs once when the module first evaluates, rather than for each component instance. Variables declared in this block can be referenced elsewhere in the component, but not vice versa.\\n\\n```\\n<script module>\\n let total = 0;\\n</script>\\n\\n<script>\\n total += 1;\\n console.log(`instantiated ${total} times`);\\n</script>\\n```\\n\\nYou can `export` bindings from this block, and they will become exports of the compiled module. You cannot `export default`, since the default export is the component itself.\\n\\n['[!NOTE] If you are using TypeScript and import such exports from a `module` block into a `.ts` file, make sure to have your editor setup so that TypeScript knows about them. This is the case for our VS Code extension and the IntelliJ plugin, but in other cases you might need to setup our [TypeScript editor plugin](https://www.npmjs.com/package/typescript-svelte-plugin).']\\n\\n['[!LEGACY]\\\\nIn Svelte 4, this script tag was created using `<script context=\\\"module\\\">`']\", \"`<style>`\": \"CSS inside a `<style>` block will be scoped to that component.\\n\\n```\\n<style>\\n p {\\n /* this will only affect <p> elements in this component */\\n color: burlywood;\\n }\\n</style>\\n```\\n\\nFor more information, head to the section on [styling](scoped-styles).\"}, \"metadata\": {\"title\": \".svelte files\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \".svelte.js and .svelte.ts files\", \"description\": null, \"content\": {\"root\": [\"Besides `.svelte` files, Svelte also operates on `.svelte.js` and `.svelte.ts` files.\", \"These behave like any other `.js` or `.ts` module, except that you can use runes. This is useful for creating reusable reactive logic, or sharing reactive state across your app (though note that you [cannot export reassigned state]($state#Passing-state-across-modules)).\", [\"[!LEGACY]\\nThis is a concept that didn't exist prior to Svelte 5\"]]}, \"metadata\": {\"title\": \".svelte.js and .svelte.ts files\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}, {\"title\": \"Introduction\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Introduction\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 1]\"}, {\"title\": \"02 Runes\", \"description\": \"Documentation section: 02-runes\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/02-runes\"}, \"subpages\": [{\"title\": \"What are runes?\", \"description\": null, \"content\": {\"root\": [[\"[!NOTE] **rune** /ru\\u02d0n/ _noun_\", \"A letter or mark used as a mystical or magic symbol.\"], \"Runes are symbols that you use in `.svelte` and `.svelte.js`/`.svelte.ts` files to control the Svelte compiler. If you think of Svelte as a language, runes are part of the syntax \\u2014 they are _keywords_.\", \"Runes have a `$` prefix and look like functions:\", \"```\\nlet message = $state('hello');\\n```\", \"They differ from normal JavaScript functions in important ways, however:\", [\"You don't need to import them \\u2014 they are part of the language\", \"They're not values \\u2014 you can't assign them to a variable or pass them as arguments to a function\", \"Just like JavaScript keywords, they are only valid in certain positions (the compiler will help you if you put them in the wrong place)\"], [\"[!LEGACY]\\nRunes didn't exist prior to Svelte 5.\"]]}, \"metadata\": {\"title\": \"What are runes?\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"$state\", \"description\": null, \"content\": {\"`$state.raw`\": \"In cases where you don't want objects and arrays to be deeply reactive you can use `$state.raw`.\\n\\nState declared with `$state.raw` cannot be mutated; it can only be _reassigned_. In other words, rather than assigning to a property of an object, or using an array method like `push`, replace the object or array altogether if you'd like to update it:\\n\\n```\\nlet person = $state.raw({\\n name: 'Heraclitus',\\n age: 49\\n});\\n\\n// this will have no effect\\nperson.age += 1;\\n\\n// this will work, because we're creating a new person\\nperson = {\\n name: 'Heraclitus',\\n age: 50\\n};\\n```\\n\\nThis can improve performance with large arrays and objects that you weren't planning to mutate anyway, since it avoids the cost of making them reactive. Note that raw state can _contain_ reactive state (for example, a raw array of reactive objects).\\n\\nAs with `$state`, you can declare class fields using `$state.raw`.\", \"`$state.snapshot`\": \"To take a static snapshot of a deeply reactive `$state` proxy, use `$state.snapshot`:\\n\\n```\\n<script>\\n let counter = $state({ count: 0 });\\n\\n function onclick() {\\n // Will log `{ count: ... }` rather than `Proxy { ... }`\\n console.log($state.snapshot(counter));\\n }\\n</script>\\n```\\n\\nThis is handy when you want to pass some state to an external library or API that doesn't expect a proxy, such as `structuredClone`.\", \"Passing state into functions\": \"JavaScript is a _pass-by-value_ language \\u2014 when you call a function, the arguments are the _values_ rather than the _variables_. In other words:\\n\\n```\\n/// file: index.js\\n// @filename: index.js\\n// ---cut---\\n/**\\n * @param {number} a\\n * @param {number} b\\n */\\nfunction add(a, b) {\\n return a + b;\\n}\\n\\nlet a = 1;\\nlet b = 2;\\nlet total = add(a, b);\\nconsole.log(total); // 3\\n\\na = 3;\\nb = 4;\\nconsole.log(total); // still 3!\\n```\\n\\nIf `add` wanted to have access to the _current_ values of `a` and `b`, and to return the current `total` value, you would need to use functions instead:\\n\\n```\\n/// file: index.js\\n// @filename: index.js\\n// ---cut---\\n/**\\n * @param {() => number} getA\\n * @param {() => number} getB\\n */\\nfunction add(+++getA, getB+++) {\\n return +++() => getA() + getB()+++;\\n}\\n\\nlet a = 1;\\nlet b = 2;\\nlet total = add+++(() => a, () => b)+++;\\nconsole.log(+++total()+++); // 3\\n\\na = 3;\\nb = 4;\\nconsole.log(+++total()+++); // 7\\n```\\n\\nState in Svelte is no different \\u2014 when you reference something declared with the `$state` rune...\\n\\n```\\nlet a = +++$state(1)+++;\\nlet b = +++$state(2)+++;\\n```\\n\\n...you're accessing its _current value_.\\n\\nNote that 'functions' is broad \\u2014\\u00a0it encompasses properties of proxies and [`get`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/get)/[`set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/set) properties...\\n\\n```\\n/// file: index.js\\n// @filename: index.js\\n// ---cut---\\n/**\\n * @param {{ a: number, b: number }} input\\n */\\nfunction add(input) {\\n return {\\n get value() {\\n return input.a + input.b;\\n }\\n };\\n}\\n\\nlet input = $state({ a: 1, b: 2 });\\nlet total = add(input);\\nconsole.log(total.value); // 3\\n\\ninput.a = 3;\\ninput.b = 4;\\nconsole.log(total.value); // 7\\n```\\n\\n...though if you find yourself writing code like that, consider using [classes](#Classes) instead.\", \"Passing state across modules\": \"You can declare state in `.svelte.js` and `.svelte.ts` files, but you can only _export_ that state if it's not directly reassigned. In other words you can't do this:\\n\\n```\\n/// file: state.svelte.js\\nexport let count = $state(0);\\n\\nexport function increment() {\\n count += 1;\\n}\\n```\\n\\nThat's because every reference to `count` is transformed by the Svelte compiler \\u2014 the code above is roughly equivalent to this:\\n\\n```\\n/// file: state.svelte.js (compiler output)\\n// @filename: index.ts\\ninterface Signal<T> {\\n value: T;\\n}\\n\\ninterface Svelte {\\n state<T>(value?: T): Signal<T>;\\n get<T>(source: Signal<T>): T;\\n set<T>(source: Signal<T>, value: T): void;\\n}\\ndeclare const $: Svelte;\\n// ---cut---\\nexport let count = $.state(0);\\n\\nexport function increment() {\\n $.set(count, $.get(count) + 1);\\n}\\n```\\n\\n[\\\"[!NOTE] You can see the code Svelte generates by clicking the 'JS Output' tab in the [playground](/playground).\\\"]\\n\\nSince the compiler only operates on one file at a time, if another file imports `count` Svelte doesn't know that it needs to wrap each reference in `$.get` and `$.set`:\\n\\n```\\n// @filename: state.svelte.js\\nexport let count = 0;\\n\\n// @filename: index.js\\n// ---cut---\\nimport { count } from './state.svelte.js';\\n\\nconsole.log(typeof count); // 'object', not 'number'\\n```\\n\\nThis leaves you with two options for sharing state between modules \\u2014 either don't reassign it...\\n\\n```\\n// This is allowed \\u2014 since we're updating\\n// `counter.count` rather than `counter`,\\n// Svelte doesn't wrap it in `$.state`\\nexport const counter = $state({\\n count: 0\\n});\\n\\nexport function increment() {\\n counter.count += 1;\\n}\\n```\\n\\n...or don't directly export it:\\n\\n```\\nlet count = $state(0);\\n\\nexport function getCount() {\\n return count;\\n}\\n\\nexport function increment() {\\n count += 1;\\n}\\n```\"}, \"metadata\": {\"title\": \"$state\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"$derived\", \"description\": null, \"content\": {\"`$derived.by`\": \"Sometimes you need to create complex derivations that don't fit inside a short expression. In these cases, you can use `$derived.by` which accepts a function as its argument.\\n\\n```\\n<script>\\n let numbers = $state([1, 2, 3]);\\n let total = $derived.by(() => {\\n let total = 0;\\n for (const n of numbers) {\\n total += n;\\n }\\n return total;\\n });\\n</script>\\n\\n<button onclick={() => numbers.push(numbers.length + 1)}>\\n {numbers.join(' + ')} = {total}\\n</button>\\n```\\n\\nIn essence, `$derived(expression)` is equivalent to `$derived.by(() => expression)`.\", \"Understanding dependencies\": \"Anything read synchronously inside the `$derived` expression (or `$derived.by` function body) is considered a _dependency_ of the derived state. When the state changes, the derived will be marked as _dirty_ and recalculated when it is next read.\\n\\nTo exempt a piece of state from being treated as a dependency, use [`untrack`](svelte#untrack).\", \"Overriding derived values\": \"Derived expressions are recalculated when their dependencies change, but you can temporarily override their values by reassigning them (unless they are declared with `const`). This can be useful for things like _optimistic UI_, where a value is derived from the 'source of truth' (such as data from your server) but you'd like to show immediate feedback to the user:\\n\\n```\\n<script>\\n let { post, like } = $props();\\n\\n let likes = $derived(post.likes);\\n\\n async function onclick() {\\n // increment the `likes` count immediately...\\n likes += 1;\\n\\n // and tell the server, which will eventually update `post`\\n try {\\n await like();\\n } catch {\\n // failed! roll back the change\\n likes -= 1;\\n }\\n }\\n</script>\\n\\n<button {onclick}>\\ud83e\\udde1 {likes}</button>\\n```\\n\\n['[!NOTE] Prior to Svelte 5.25, deriveds were read-only.']\", \"Deriveds and reactivity\": \"Unlike `$state`, which converts objects and arrays to [deeply reactive proxies]($state#Deep-state), `$derived` values are left as-is. For example, [in a case like this](/playground/untitled#H4sIAAAAAAAAE4VU22rjMBD9lUHd3aaQi9PdstS1A3t5XvpQ2Ic4D7I1iUUV2UjjNMX431eS7TRdSosxgjMzZ45mjt0yzffIYibvy0ojFJWqDKCQVBk2ZVup0LJ43TJ6rn2aBxw-FP2o67k9oCKP5dziW3hRaUJNjoYltjCyplWmM1JIIAn3FlL4ZIkTTtYez6jtj4w8WwyXv9GiIXiQxLVs9pfTMR7EuoSLIuLFbX7Z4930bZo_nBrD1bs834tlfvsBz9_SyX6PZXu9XaL4gOWn4sXjeyzftv4ZWfyxubpzxzg6LfD4MrooxELEosKCUPigQCMPKCZh0OtQE1iSxcsmdHuBvCiHZXALLXiN08EL3RRkaJ_kDVGle0HcSD5TPEeVtj67O4Nrg9aiSNtBY5oODJkrL5QsHtN2cgXp6nSJMWzpWWGasdlsGEMbzi5jPr5KFr0Ep7pdeM2-TCelCddIhDxAobi1jqF3cMaC1RKp64bAW9iFAmXGIHfd4wNXDabtOLN53w8W53VvJoZLh7xk4Rr3CoL-UNoLhWHrT1JQGcM17u96oES5K-kc2XOzkzqGCKL5De79OUTyyrg1zgwXsrEx3ESfx4Bz0M5UjVMHB24mw9SuXtXFoN13fYKOM1tyUT3FbvbWmSWCZX2Er-41u5xPoml45svRahl9Wb9aasbINJixDZwcPTbyTLZSUsAvrg_cPuCR7s782_WU8343Y72Qtlb8OYatwuOQvuN13M_hJKNfxann1v1U_B1KZ_D_mzhzhz24fw85CSz2irtN9w9HshBK7AQAAA==)...\\n\\n```\\nlet items = $state([...]);\\n\\nlet index = $state(0);\\nlet selected = $derived(items[index]);\\n```\\n\\n...you can change (or `bind:` to) properties of `selected` and it will affect the underlying `items` array. If `items` was _not_ deeply reactive, mutating `selected` would have no effect.\", \"Destructuring\": \"If you use destructuring with a `$derived` declaration, the resulting variables will all be reactive \\u2014\\u00a0this...\\n\\n```\\nfunction stuff() { return { a: 1, b: 2, c: 3 } }\\n// ---cut---\\nlet { a, b, c } = $derived(stuff());\\n```\\n\\n...is roughly equivalent to this:\\n\\n```\\nfunction stuff() { return { a: 1, b: 2, c: 3 } }\\n// ---cut---\\nlet _stuff = $derived(stuff());\\nlet a = $derived(_stuff.a);\\nlet b = $derived(_stuff.b);\\nlet c = $derived(_stuff.c);\\n```\", \"Update propagation\": \"Svelte uses something called _push-pull reactivity_ \\u2014 when state is updated, everything that depends on the state (whether directly or indirectly) is immediately notified of the change (the 'push'), but derived values are not re-evaluated until they are actually read (the 'pull').\\n\\nIf the new value of a derived is referentially identical to its previous value, downstream updates will be skipped. In other words, Svelte will only update the text inside the button when `large` changes, not when `count` changes, even though `large` depends on `count`:\\n\\n```\\n<script>\\n let count = $state(0);\\n let large = $derived(count > 10);\\n</script>\\n\\n<button onclick={() => count++}>\\n {large}\\n</button>\\n```\"}, \"metadata\": {\"title\": \"$derived\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"$effect\", \"description\": null, \"content\": {\"`$effect.pre`\": \"In rare cases, you may need to run code _before_ the DOM updates. For this we can use the `$effect.pre` rune:\\n\\n```\\n<script>\\n import { tick } from 'svelte';\\n\\n let div = $state();\\n let messages = $state([]);\\n\\n // ...\\n\\n $effect.pre(() => {\\n if (!div) return; // not yet mounted\\n\\n // reference `messages` array length so that this code re-runs whenever it changes\\n messages.length;\\n\\n // autoscroll when new messages are added\\n if (div.offsetHeight + div.scrollTop > div.scrollHeight - 20) {\\n tick().then(() => {\\n div.scrollTo(0, div.scrollHeight);\\n });\\n }\\n });\\n</script>\\n\\n<div bind:this={div}>\\n {#each messages as message}\\n <p>{message}</p>\\n {/each}\\n</div>\\n```\\n\\nApart from the timing, `$effect.pre` works exactly like `$effect`.\", \"`$effect.tracking`\": \"The `$effect.tracking` rune is an advanced feature that tells you whether or not the code is running inside a tracking context, such as an effect or inside your template ([demo](/playground/untitled#H4sIAAAAAAAACn3PwYrCMBDG8VeZDYIt2PYeY8Dn2HrIhqkU08nQjItS-u6buAt7UDzmz8ePyaKGMWBS-nNRcmdU-hHUTpGbyuvI3KZvDFLal0v4qvtIgiSZUSb5eWSxPfWSc4oB2xDP1XYk8HHiSHkICeXKeruDDQ4Demlldv4y0rmq6z10HQwuJMxGVv4mVVXDwcJS0jP9u3knynwtoKz1vifT_Z9Jhm0WBCcOTlDD8kyspmML5qNpHg40jc3fFryJ0iWsp_UHgz3180oBAAA=)):\\n\\n```\\n<script>\\n console.log('in component setup:', $effect.tracking()); // false\\n\\n $effect(() => {\\n console.log('in effect:', $effect.tracking()); // true\\n });\\n</script>\\n\\n<p>in template: {$effect.tracking()}</p> <!-- true -->\\n```\\n\\nIt is used to implement abstractions like [`createSubscriber`](/docs/svelte/svelte-reactivity#createSubscriber), which will create listeners to update reactive values but _only_ if those values are being tracked (rather than, for example, read inside an event handler).\", \"`$effect.pending`\": \"When using [`await`](await-expressions) in components, the `$effect.pending()` rune tells you how many promises are pending in the current [boundary](svelte-boundary), not including child boundaries ([demo](/playground/untitled#H4sIAAAAAAAAE3WRMU_DMBCF_8rJdHDUqilILGkaiY2RgY0yOPYZWbiOFV8IleX_jpMUEAIWS_7u-d27c2ROnJBV7B6t7WDsequAozKEqmAbpo3FwKqnyOjsJ90EMr-8uvN-G97Q0sRaEfAvLjtH6CjbsDrI3nhqju5IFgkEHGAVSBDy62L_SdtvejPTzEU4Owl6cJJM50AoxcUG2gLiVM31URgChyM89N3JBORcF3BoICA9mhN2A3G9gdvdrij2UJYgejLaSCMsKLTivNj0SEOf7WEN7ZwnHV1dfqd2dTsQ5QCdk9bI10PkcxexXqcmH3W51Jt_le2kbH8os9Y3UaTcNLYpDx-Xab6GTHXpZ128MhpWqDVK2np0yrgXXqQpaLa4APDLBkIF8bd2sYql0Sn_DeE7sYr6AdNzvgljR-MUq7SwAdMHeUtgHR4CAAA=)):\\n\\n```\\n<button onclick={() => a++}>a++</button>\\n<button onclick={() => b++}>b++</button>\\n\\n<p>{a} + {b} = {await add(a, b)}</p>\\n\\n{#if $effect.pending()}\\n <p>pending promises: {$effect.pending()}</p>\\n{/if}\\n```\", \"`$effect.root`\": \"The `$effect.root` rune is an advanced feature that creates a non-tracked scope that doesn't auto-cleanup. This is useful for nested effects that you want to manually control. This rune also allows for the creation of effects outside of the component initialisation phase.\\n\\n```\\nconst destroy = $effect.root(() => {\\n $effect(() => {\\n // setup\\n });\\n\\n return () => {\\n // cleanup\\n };\\n});\\n\\n// later...\\ndestroy();\\n```\", \"When not to use `$effect`\": \"In general, `$effect` is best considered something of an escape hatch \\u2014 useful for things like analytics and direct DOM manipulation \\u2014 rather than a tool you should use frequently. In particular, avoid using it to synchronise state. Instead of this...\\n\\n```\\n<script>\\n let count = $state(0);\\n let doubled = $state();\\n\\n // don't do this!\\n $effect(() => {\\n doubled = count * 2;\\n });\\n</script>\\n```\\n\\n...do this:\\n\\n```\\n<script>\\n let count = $state(0);\\n let doubled = $derived(count * 2);\\n</script>\\n```\\n\\n['[!NOTE] For things that are more complicated than a simple expression like `count * 2`, you can also use `$derived.by`.']\\n\\nIf you're using an effect because you want to be able to reassign the derived value (to build an optimistic UI, for example) note that [deriveds can be directly overridden]($derived#Overriding-derived-values) as of Svelte 5.25.\\n\\nYou might be tempted to do something convoluted with effects to link one value to another. The following example shows two inputs for \\\"money spent\\\" and \\\"money left\\\" that are connected to each other. If you update one, the other should update accordingly. Don't use effects for this ([demo](/playground/untitled#H4sIAAAAAAAAE5WRTWrDMBCFryKGLBJoY3fRjWIHeoiu6i6UZBwEY0VE49TB-O6VxrFTSih0qe_Ne_OjHpxpEDS8O7ZMeIAnqC1hAP3RA1990hKI_Fb55v06XJA4sZ0J-IjvT47RcYyBIuzP1vO2chVHHFjxiQ2pUr3k-SZRQlbBx_LIFoEN4zJfzQph_UMQr4hRXmBd456Xy5Uqt6pPKHmkfmzyPAZL2PCnbRpg8qWYu63I7lu4gswOSRYqrPNt3CgeqqzgbNwRK1A76w76YqjFspfcQTWmK3vJHlQm1puSTVSeqdOc_r9GaeCHfUSY26TXry6Br4RSK3C6yMEGT-aqVU3YbUZ2NF6rfP2KzXgbuYzY46czdgyazy0On_FlLH3F-UDXhgIO35UGlA1rAgAA)):\\n\\n```\\n<script>\\n const total = 100;\\n let spent = $state(0);\\n let left = $state(total);\\n\\n $effect(() => {\\n left = total - spent;\\n });\\n\\n $effect(() => {\\n spent = total - left;\\n });\\n</script>\\n\\n<label>\\n <input type=\\\"range\\\" bind:value={spent} max={total} />\\n {spent}/{total} spent\\n</label>\\n\\n<label>\\n <input type=\\\"range\\\" bind:value={left} max={total} />\\n {left}/{total} left\\n</label>\\n```\\n\\nInstead, use `oninput` callbacks or \\u2014 better still \\u2014 [function bindings](bind#Function-bindings) where possible ([demo](/playground/untitled#H4sIAAAAAAAAE5VRvW7CMBB-FcvqECQK6dDFJEgsnfoGTQdDLsjSxVjxhYKivHvPBwFUsXS8774_nwftbQva6I_e78gdvNo6Xzu_j3quG4cQtfkaNJ1DIiWA8atkE8IiHgEpYVsb4Rm-O3gCT2yji7jrXKB15StiOJKiA1lUpXrL81VCEUjFwHTGXiJZgiyf3TYIjSxq6NwR6uyifr0ohMbEZnpHH2rWf7ImS8KZGtK6osl_UqelRIyVL5b3ir5AuwWUtoXzoee6fIWy0p31e6i0XMocLfZQDuI6qtaeykGcR7UU6XWznFAZU9LN_X9B2UyVayk9f3ji0-REugen6U9upDOCcAWcLlS7GNCejWoQTqsLtrfBqHzxDu3DrUTOf0xwIm2o62H85sk6_OHG2jQWI4y_3byXXGMCAAA=)):\\n\\n```\\n<script>\\n const total = 100;\\n let spent = $state(0);\\n let left = $derived(total - spent);\\n\\n+++ function updateLeft(left) {\\n spent = total - left;\\n }+++\\n</script>\\n\\n<label>\\n <input type=\\\"range\\\" bind:value={spent} max={total} />\\n {spent}/{total} spent\\n</label>\\n\\n<label>\\n <input type=\\\"range\\\" +++bind:value={() => left, updateLeft}+++ max={total} />\\n {left}/{total} left\\n</label>\\n```\\n\\nIf you absolutely have to update `$state` within an effect and run into an infinite loop because you read and write to the same `$state`, use [untrack](svelte#untrack).\"}, \"metadata\": {\"title\": \"$effect\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"$props\", \"description\": null, \"content\": {\"Fallback values\": \"Destructuring allows us to declare fallback values, which are used if the parent component does not set a given prop (or the value is `undefined`):\\n\\n```\\nlet { adjective = 'happy' } = $props();\\n```\\n\\n['[!NOTE] Fallback values are not turned into reactive state proxies (see [Updating props](#Updating-props) for more info)']\", \"Renaming props\": \"We can also use the destructuring assignment to rename props, which is necessary if they're invalid identifiers, or a JavaScript keyword like `super`:\\n\\n```\\nlet { super: trouper = 'lights are gonna find me' } = $props();\\n```\", \"Rest props\": \"Finally, we can use a _rest property_ to get, well, the rest of the props:\\n\\n```\\nlet { a, b, c, ...others } = $props();\\n```\", \"Updating props\": \"References to a prop inside a component update when the prop itself updates \\u2014 when `count` changes in `App.svelte`, it will also change inside `Child.svelte`. But the child component is able to temporarily override the prop value, which can be useful for unsaved ephemeral state ([demo](/playground/untitled#H4sIAAAAAAAAE6WQ0WrDMAxFf0WIQR0Wmu3VTQJln7HsIfVcZubIxlbGRvC_DzuBraN92qPula50tODZWB1RPi_IX16jLALWSOOUq6P3-_ihLWftNEZ9TVeOWBNHlNhGFYznfqCBzeRdYHh6M_YVzsFNsNs3pdpGd4eBcqPVDMrNxNDBXeSRtXioDgO1zU8ataeZ2RE4Utao924RFXQ9iHXwvoPHKpW1xY4g_Bg0cSVhKS0p560Za95612ZC02ONrD8ZJYdZp_rGQ37ff_mSP86Np2TWZaNNmdcH56P4P67K66_SXoK9pG-5dF5Z9QEAAA==)):\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Child from './Child.svelte';\\n\\n let count = $state(0);\\n</script>\\n\\n<button onclick={() => (count += 1)}>\\n clicks (parent): {count}\\n</button>\\n\\n<Child {count} />\\n```\\n\\n```\\n<!--- file: Child.svelte --->\\n<script>\\n let { count } = $props();\\n</script>\\n\\n<button onclick={() => (count += 1)}>\\n clicks (child): {count}\\n</button>\\n```\\n\\nWhile you can temporarily _reassign_ props, you should not _mutate_ props unless they are [bindable]($bindable).\\n\\nIf the prop is a regular object, the mutation will have no effect ([demo](/playground/untitled#H4sIAAAAAAAAE3WQwU7DMBBEf2W1QmorQgJXk0RC3PkBwiExG9WQrC17U4Es_ztKUkQp9OjxzM7bjcjtSKjwyfKNp1aLORA4b13ADHszUED1HFE-3eyaBcy-Mw_O5eFAg8xa1wb6T9eWhVgCKiyD9sZJ3XAjZnTWCzzuzfAKvbcjbPJieR2jm_uGy-InweXqtd0baaliBG0nFgW3kBIUNWYo9CGoxE-UsgvIpw2_oc9-LmAPJBCPDJCggqvlVtvdH9puErEMlvVg9HsVtzuoaojzkKKAfRuALVDfk5ZZW0fmy05wXcFdwyktlUs-KIinljTXrRVnm7-kL9dYLVbUAQAA)):\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Child from './Child.svelte';\\n</script>\\n\\n<Child object={{ count: 0 }} />\\n```\\n\\n```\\n<!--- file: Child.svelte --->\\n<script>\\n let { object } = $props();\\n</script>\\n\\n<button onclick={() => {\\n // has no effect\\n object.count += 1\\n}}>\\n clicks: {object.count}\\n</button>\\n```\\n\\nIf the prop is a reactive state proxy, however, then mutations _will_ have an effect but you will see an [`ownership_invalid_mutation`](runtime-warnings#Client-warnings-ownership_invalid_mutation) warning, because the component is mutating state that does not 'belong' to it ([demo](/playground/untitled#H4sIAAAAAAAAE3WR0U7DMAxFf8VESBuiauG1WycheOEbKA9p67FA6kSNszJV-XeUZhMw2GN8r-1znUmQ7FGU4pn2UqsOes-SlSGRia3S6ET5Mgk-2OiJBZGdOh6szd0eNcdaIx3-V28NMRI7UYq1awdleVNTzaq3ZmB43CndwXYwPSzyYn4dWxermqJRI4Np3rFlqODasWRcTtAaT1zCHYSbVU3r4nsyrdPMKTUFKDYiE4yfLEoePIbsQpqfy3_nOVMuJIqg0wk1RFg7GOuWfwEbz2wIDLVatR_VtLyBagNTHFIUMCqtoZXeIfAOU1JoUJsR2IC3nWTMjt7GM4yKdyBhlAMpesvhydCC0y_i0ZagHByMh26WzUhXUUxKnpbcVnBfUwhznJnNlac7JkuIURL-2VVfwxflyrWcSQIAAA==)):\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Child from './Child.svelte';\\n\\n let object = $state({count: 0});\\n</script>\\n\\n<Child {object} />\\n```\\n\\n```\\n<!--- file: Child.svelte --->\\n<script>\\n let { object } = $props();\\n</script>\\n\\n<button onclick={() => {\\n // will cause the count below to update,\\n // but with a warning. Don't mutate\\n // objects you don't own!\\n object.count += 1\\n}}>\\n clicks: {object.count}\\n</button>\\n```\\n\\nThe fallback value of a prop not declared with `$bindable` is left untouched \\u2014 it is not turned into a reactive state proxy \\u2014 meaning mutations will not cause updates ([demo](/playground/untitled#H4sIAAAAAAAAE3WQwU7DMBBEf2VkIbUVoYFraCIh7vwA4eC4G9Wta1vxpgJZ_nfkBEQp9OjxzOzTRGHlkUQlXpy9G0gq1idCL43ppDrAD84HUYheGwqieo2CP3y2Z0EU3-En79fhRIaz1slA_-nKWSbLQVRiE9SgPTetbVkfvRsYzztttugHd8RiXU6vr-jisbWb8idhN7O3bEQhmN5ZVDyMlIorcOddv_Eufq4AGmJEuG5PilEjQrnRcoV7JCTUuJlGWq7-YHYjs7NwVhmtDnVcrlA3iLmzLLGTAdaB-j736h68Oxv-JM1I0AFjoG1OzPfX023c1nhobUoT39QeKsRzS8owM8DFTG_pE6dcVl70AQAA))\\n\\n```\\n<!--- file: Child.svelte --->\\n<script>\\n let { object = { count: 0 } } = $props();\\n</script>\\n\\n<button onclick={() => {\\n // has no effect if the fallback value is used\\n object.count += 1\\n}}>\\n clicks: {object.count}\\n</button>\\n```\\n\\nIn summary: don't mutate props. Either use callback props to communicate changes, or \\u2014 if parent and child should share the same object \\u2014 use the [`$bindable`]($bindable) rune.\", \"Type safety\": \"You can add type safety to your components by annotating your props, as you would with any other variable declaration. In TypeScript that might look like this...\\n\\n```\\n<script lang=\\\"ts\\\">\\n let { adjective }: { adjective: string } = $props();\\n</script>\\n```\\n\\n...while in JSDoc you can do this:\\n\\n```\\n<script>\\n /** @type {{ adjective: string }} */\\n let { adjective } = $props();\\n</script>\\n```\\n\\nYou can, of course, separate the type declaration from the annotation:\\n\\n```\\n<script lang=\\\"ts\\\">\\n interface Props {\\n adjective: string;\\n }\\n\\n let { adjective }: Props = $props();\\n</script>\\n```\\n\\n['[!NOTE] Interfaces for native DOM elements are provided in the `svelte/elements` module (see [Typing wrapper components](typescript#Typing-wrapper-components))']\\n\\nAdding types is recommended, as it ensures that people using your component can easily discover which props they should provide.\", \"`$props.id()`\": \"This rune, added in version 5.20.0, generates an ID that is unique to the current component instance. When hydrating a server-rendered component, the value will be consistent between server and client.\\n\\nThis is useful for linking elements via attributes like `for` and `aria-labelledby`.\\n\\n```\\n<script>\\n const uid = $props.id();\\n</script>\\n\\n<form>\\n <label for=\\\"{uid}-firstname\\\">First Name: </label>\\n <input id=\\\"{uid}-firstname\\\" type=\\\"text\\\" />\\n\\n <label for=\\\"{uid}-lastname\\\">Last Name: </label>\\n <input id=\\\"{uid}-lastname\\\" type=\\\"text\\\" />\\n</form>\\n```\"}, \"metadata\": {\"title\": \"$props\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}, {\"title\": \"$bindable\", \"description\": null, \"content\": {\"root\": [\"Ordinarily, props go one way, from parent to child. This makes it easy to understand how data flows around your app.\", \"In Svelte, component props can be _bound_, which means that data can also flow _up_ from child to parent. This isn't something you should do often, but it can simplify your code if used sparingly and carefully.\", \"It also means that a state proxy can be _mutated_ in the child.\", [\"[!NOTE] Mutation is also possible with normal props, but is strongly discouraged \\u2014 Svelte will warn you if it detects that a component is mutating state it does not 'own'.\"], \"To mark a prop as bindable, we use the `$bindable` rune:\", \"<!-- prettier-ignore -->\\n```svelte\\n/// file: FancyInput.svelte\\n<script>\\n let { value = $bindable(), ...props } = $props();\\n</script>\", \"<input bind:value={value} {...props} />\", \"<style>\\n input {\\n font-family: 'Comic Sans MS';\\n color: deeppink;\\n }\\n</style>\\n```\", \"Now, a component that uses `<FancyInput>` can add the [`bind:`](bind) directive ([demo](/playground/untitled#H4sIAAAAAAAAE3WQwWrDMBBEf2URBSfg2nfFMZRCoYeecqx6UJx1IyqvhLUONcb_XqSkTUOSk1az7DBvJtEai0HI90nw6FHIJIhckO7i78n7IhzQctS2OuAtvXHESByEFFVoeuO5VqTYdN71DC-amvGV_MDQ9q6DrCjP0skkWymKJxYZOgxBfyKs4SGwZlxke7TWZcuVoqo8-1P1z3lraCcP2g64nk4GM5S1osrXf0JV-lrkgvGbheR-wDm_g30V8JL-1vpOCZFogpQsEsWcemtxscyhKArfOx9gjps0Lq4hzRVfemaYfu-PoIqqwKPFY_XpaIqj4tYRP7a6M3aUkD27zjSw0RTgbZN6Z8WNs66XsEP03tBXUueUJFlelvYx_wCuI3leNwIAAA==)):\", \"<!-- prettier-ignore -->\\n```svelte\\n/// file: App.svelte\\n<script>\\n import FancyInput from './FancyInput.svelte';\", \"let message = $state('hello');\", \"</script>\", \"<FancyInput bind:value={message} />\", \"<p>{message}</p>\\n```\", \"The parent component doesn't _have_ to use `bind:` \\u2014 it can just pass a normal prop. Some parents don't want to listen to what their children have to say.\", \"In this case, you can specify a fallback value for when no prop is passed at all:\", \"```\\n/// file: FancyInput.svelte\\nlet { value = $bindable('fallback'), ...props } = $props();\\n```\"]}, \"metadata\": {\"title\": \"$bindable\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\"}, {\"title\": \"$inspect\", \"description\": null, \"content\": {\"$inspect(...).with\": \"`$inspect` returns a property `with`, which you can invoke with a callback, which will then be invoked instead of `console.log`. The first argument to the callback is either `\\\"init\\\"` or `\\\"update\\\"`; subsequent arguments are the values passed to `$inspect` ([demo](/playground/untitled#H4sIAAAAAAAACkVQ24qDMBD9lSEUqlTqPlsj7ON-w7pQG8c2VCchmVSK-O-bKMs-DefKYRYx6BG9qL4XQd2EohKf1opC8Nsm4F84MkbsTXAqMbVXTltuWmp5RAZlAjFIOHjuGLOP_BKVqB00eYuKs82Qn2fNjyxLtcWeyUE2sCRry3qATQIpJRyD7WPVMf9TW-7xFu53dBcoSzAOrsqQNyOe2XUKr0Xi5kcMvdDB2wSYO-I9vKazplV1-T-d6ltgNgSG1KjVUy7ZtmdbdjqtzRcphxMS1-XubOITJtPrQWMvKnYB15_1F7KKadA_AQAA)):\\n\\n```\\n<script>\\n let count = $state(0);\\n\\n $inspect(count).with((type, count) => {\\n if (type === 'update') {\\n debugger; // or `console.trace`, or whatever you want\\n }\\n });\\n</script>\\n\\n<button onclick={() => count++}>Increment</button>\\n```\\n\\nA convenient way to find the origin of some change is to pass `console.trace` to `with`:\\n\\n```\\n// @errors: 2304\\n$inspect(stuff).with(console.trace);\\n```\", \"$inspect.trace(...)\": \"This rune, added in 5.14, causes the surrounding function to be _traced_ in development. Any time the function re-runs as part of an [effect]($effect) or a [derived]($derived), information will be printed to the console about which pieces of reactive state caused the effect to fire.\\n\\n```\\n<script>\\n import { doSomeWork } from './elsewhere';\\n\\n $effect(() => {\\n +++// $inspect.trace must be the first statement of a function body+++\\n +++$inspect.trace();+++\\n doSomeWork();\\n });\\n</script>\\n```\\n\\n`$inspect.trace` takes an optional first argument which will be used as the label.\"}, \"metadata\": {\"title\": \"$inspect\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\"}, {\"title\": \"$host\", \"description\": null, \"content\": {\"root\": [\"When compiling a component as a [custom element](custom-elements), the `$host` rune provides access to the host element, allowing you to (for example) dispatch custom events ([demo](/playground/untitled#H4sIAAAAAAAAE41Ry2rDMBD8FSECtqkTt1fHFpSSL-ix7sFRNkTEXglrnTYY_3uRlDgxTaEHIfYxs7szA9-rBizPPwZOZwM89wmecqxbF70as7InaMjltrWFR3mpkQDJ8pwXVnbKkKiwItUa3RGLVtk7gTHQXRDR2lXda4CY1D0SK9nCUk0QPyfrCovsRoNFe17aQOAwGncgO2gBqRzihJXiQrEs2csYOhQ-7HgKHaLIbpRhhBG-I2eD_8ciM4KnnOCbeE5dD2P6h0Dz0-Yi_arNhPLJXBtSGi2TvSXdbpqwdsXvjuYsC1veabvvUTog2ylrapKH2G2XsMFLS4uDthQnq2t1cwKkGOGLvYU5PvaQxLsxOkPmsm97Io1Mo2yUPF6VnOZFkw1RMoopKLKAE_9gmGxyDFMwMcwN-Bx_ABXQWmOtAgAA)):\", \"<!-- prettier-ignore -->\\n```svelte\\n/// file: Stepper.svelte\\n<svelte:options customElement=\\\"my-stepper\\\" />\", \"<script>\\n function dispatch(type) {\\n +++$host()+++.dispatchEvent(new CustomEvent(type));\\n }\\n</script>\", \"<button onclick={() => dispatch('decrement')}>decrement</button>\\n<button onclick={() => dispatch('increment')}>increment</button>\\n```\", \"<!-- prettier-ignore -->\\n```svelte\\n/// file: App.svelte\\n<script>\\n import './Stepper.svelte';\", \"let count = $state(0);\", \"</script>\", \"<my-stepper\\nondecrement={() => count -= 1}\\nonincrement={() => count += 1}\", [\"</my-stepper>\"], \"<p>count: {count}</p>\\n```\"]}, \"metadata\": {\"title\": \"$host\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\"}, {\"title\": \"Runes\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Runes\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 2]\"}, {\"title\": \"03 Template Syntax\", \"description\": \"Documentation section: 03-template-syntax\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/03-template-syntax\"}, \"subpages\": [{\"title\": \"Basic markup\", \"description\": null, \"content\": {\"Tags\": \"A lowercase tag, like `<div>`, denotes a regular HTML element. A capitalised tag or a tag that uses dot notation, such as `<Widget>` or `<my.stuff>`, indicates a _component_.\\n\\n```\\n<script>\\n import Widget from './Widget.svelte';\\n</script>\\n\\n<div>\\n <Widget />\\n</div>\\n```\", \"Element attributes\": \"By default, attributes work exactly like their HTML counterparts.\\n\\n```\\n<div class=\\\"foo\\\">\\n <button disabled>can't touch this</button>\\n</div>\\n```\\n\\nAs in HTML, values may be unquoted.\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<input type=checkbox />\\n```\\n\\nAttribute values can contain JavaScript expressions.\\n\\n```\\n<a href=\\\"page/{p}\\\">page {p}</a>\\n```\\n\\nOr they can _be_ JavaScript expressions.\\n\\n```\\n<button disabled={!clickable}>...</button>\\n```\\n\\nBoolean attributes are included on the element if their value is [truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy) and excluded if it's [falsy](https://developer.mozilla.org/en-US/docs/Glossary/Falsy).\\n\\nAll other attributes are included unless their value is [nullish](https://developer.mozilla.org/en-US/docs/Glossary/Nullish) (`null` or `undefined`).\\n\\n```\\n<input required={false} placeholder=\\\"This input field is not required\\\" />\\n<div title={null}>This div has no title attribute</div>\\n```\\n\\n['[!NOTE] Quoting a singular expression does not affect how the value is parsed, but in Svelte 6 it will cause the value to be coerced to a string:', '<!-- prettier-ignore -->\\\\n```svelte\\\\n<button disabled=\\\"{number !== 42}\\\">...</button>\\\\n```']\\n\\nWhen the attribute name and value match (`name={name}`), they can be replaced with `{name}`.\\n\\n```\\n<button {disabled}>...</button>\\n<!-- equivalent to\\n<button disabled={disabled}>...</button>\\n-->\\n```\", \"Component props\": \"By convention, values passed to components are referred to as _properties_ or _props_ rather than _attributes_, which are a feature of the DOM.\\n\\nAs with elements, `name={name}` can be replaced with the `{name}` shorthand.\\n\\n```\\n<Widget foo={bar} answer={42} text=\\\"hello\\\" />\\n```\", \"Spread attributes\": \"_Spread attributes_ allow many attributes or properties to be passed to an element or component at once.\\n\\nAn element or component can have multiple spread attributes, interspersed with regular ones. Order matters \\u2014 if `things.a` exists it will take precedence over `a=\\\"b\\\"`, while `c=\\\"d\\\"` would take precedence over `things.c`:\\n\\n```\\n<Widget a=\\\"b\\\" {...things} c=\\\"d\\\" />\\n```\", \"Events\": {\"Event delegation\": \"To reduce memory footprint and increase performance, Svelte uses a technique called event delegation. This means that for certain events \\u2014 see the list below \\u2014 a single event listener at the application root takes responsibility for running any handlers on the event's path.\\n\\nThere are a few gotchas to be aware of:\\n\\n[\\\"when you manually dispatch an event with a delegated listener, make sure to set the `{ bubbles: true }` option or it won't reach the application root\\\", \\\"when using `addEventListener` directly, avoid calling `stopPropagation` or the event won't reach the application root and handlers won't be invoked. Similarly, handlers added manually inside the application root will run _before_ handlers added declaratively deeper in the DOM (with e.g. `onclick={...}`), in both capturing and bubbling phases. For these reasons it's better to use the `on` function imported from `svelte/events` rather than `addEventListener`, as it will ensure that order is preserved and `stopPropagation` is handled correctly.\\\"]\\n\\nThe following event handlers are delegated:\\n\\n['`beforeinput`', '`click`', '`change`', '`dblclick`', '`contextmenu`', '`focusin`', '`focusout`', '`input`', '`keydown`', '`keyup`', '`mousedown`', '`mousemove`', '`mouseout`', '`mouseover`', '`mouseup`', '`pointerdown`', '`pointermove`', '`pointerout`', '`pointerover`', '`pointerup`', '`touchend`', '`touchmove`', '`touchstart`']\"}, \"Text expressions\": \"A JavaScript expression can be included as text by surrounding it with curly braces.\\n\\n```\\n{expression}\\n```\\n\\nExpressions that are `null` or `undefined` will be omitted; all others are [coerced to strings](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String#string_coercion).\\n\\nCurly braces can be included in a Svelte template by using their [HTML entity](https://developer.mozilla.org/docs/Glossary/Entity) strings: `{`, `{`, or `{` for `{` and `}`, `}`, or `}` for `}`.\\n\\nIf you're using a regular expression (`RegExp`) [literal notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp#literal_notation_and_constructor), you'll need to wrap it in parentheses.\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<h1>Hello {name}!</h1>\\n<p>{a} + {b} = {a + b}.</p>\\n\\n<div>{(/^[A-Za-z ]+$/).test(value) ? x : y}</div>\\n```\\n\\nThe expression will be stringified and escaped to prevent code injections. If you want to render HTML, use the `{@html}` tag instead.\\n\\n```\\n{@html potentiallyUnsafeHtmlString}\\n```\\n\\n['[!NOTE] Make sure that you either escape the passed string or only populate it with values that are under your control in order to prevent [XSS attacks](https://owasp.org/www-community/attacks/xss/)']\", \"Comments\": \"You can use HTML comments inside components.\\n\\n```\\n<!-- this is a comment! --><h1>Hello world</h1>\\n```\\n\\nComments beginning with `svelte-ignore` disable warnings for the next block of markup. Usually, these are accessibility warnings; make sure that you're disabling them for a good reason.\\n\\n```\\n<!-- svelte-ignore a11y_autofocus -->\\n<input bind:value={name} autofocus />\\n```\\n\\nYou can add a special comment starting with `@component` that will show up when hovering over the component name in other files.\\n\\n```\\n<!--\\n@component\\n- You can use markdown here.\\n- You can also use code blocks here.\\n- Usage:\\n ```html\\n <Main name=\\\"Arethra\\\">\\n ```\\n-->\\n<script>\\n let { name } = $props();\\n</script>\\n\\n<main>\\n <h1>\\n Hello, {name}\\n </h1>\\n</main>\\n```\"}, \"metadata\": {\"title\": \"Basic markup\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\"}, {\"title\": \"02 If\", \"description\": null, \"content\": {\"root\": [[], \"title: {#if ...}\", \"```\\n<!--- copy: false --->\\n{#if expression}...{/if}\\n```\", \"```\\n<!--- copy: false --->\\n{#if expression}...{:else if expression}...{/if}\\n```\", \"```\\n<!--- copy: false --->\\n{#if expression}...{:else}...{/if}\\n```\", \"Content that is conditionally rendered can be wrapped in an if block.\", \"```\\n{#if answer === 42}\\n <p>what was the question?</p>\\n{/if}\\n```\", \"Additional conditions can be added with `{:else if expression}`, optionally ending in an `{:else}` clause.\", \"```\\n{#if porridge.temperature > 100}\\n <p>too hot!</p>\\n{:else if 80 > porridge.temperature}\\n <p>too cold!</p>\\n{:else}\\n <p>just right!</p>\\n{/if}\\n```\", \"(Blocks don't have to wrap elements, they can also wrap text within elements.)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\"}, {\"title\": \"03 Each\", \"description\": null, \"content\": {\"Keyed each blocks\": \"```\\n<!--- copy: false --->\\n{#each expression as name (key)}...{/each}\\n```\\n\\n```\\n<!--- copy: false --->\\n{#each expression as name, index (key)}...{/each}\\n```\\n\\nIf a _key_ expression is provided \\u2014 which must uniquely identify each list item \\u2014 Svelte will use it to intelligently update the list when data changes by inserting, moving and deleting items, rather than adding or removing items at the end and updating the state in the middle.\\n\\nThe key can be any object, but strings and numbers are recommended since they allow identity to persist when the objects themselves change.\\n\\n```\\n{#each items as item (item.id)}\\n <li>{item.name} x {item.qty}</li>\\n{/each}\\n\\n<!-- or with additional index value -->\\n{#each items as item, i (item.id)}\\n <li>{i + 1}: {item.name} x {item.qty}</li>\\n{/each}\\n```\\n\\nYou can freely use destructuring and rest patterns in each blocks.\\n\\n```\\n{#each items as { id, name, qty }, i (id)}\\n <li>{i + 1}: {name} x {qty}</li>\\n{/each}\\n\\n{#each objects as { id, ...rest }}\\n <li><span>{id}</span><MyComponent {...rest} /></li>\\n{/each}\\n\\n{#each items as [id, ...rest]}\\n <li><span>{id}</span><MyComponent values={rest} /></li>\\n{/each}\\n```\", \"Each blocks without an item\": \"```\\n<!--- copy: false --->\\n{#each expression}...{/each}\\n```\\n\\n```\\n<!--- copy: false --->\\n{#each expression, index}...{/each}\\n```\\n\\nIn case you just want to render something `n` times, you can omit the `as` part ([demo](/playground/untitled#H4sIAAAAAAAAE3WR0W7CMAxFf8XKNAk0WsSeUEaRpn3Guoc0MbQiJFHiMlDVf18SOrZJ48259_jaVgZmxBEZZ28thgCNFV6xBdt1GgPj7wOji0t2EqI-wa_OleGEmpLWiID_6dIaQkMxhm1UdwKpRQhVzWSaVORJNdvWpqbhAYVsYQCNZk8thzWMC_DCHMZk3wPSThNQ088I3mghD9UwSwHwlLE5PMIzVFUFq3G7WUZ2OyUvU3JOuZU332wCXTRmtPy1NgzXZtUFp8WFw9536uWqpbIgPEaDsJBW90cTOHh0KGi2XsBq5-cT6-3nPauxXqHnsHJnCFZ3CvJVkyuCQ0mFF9TZyCQ162WGvteLKfG197Y3iv_pz_fmS68Hxt8iPBPj5HscP8YvCNX7uhYCAAA=)):\\n\\n```\\n<div class=\\\"chess-board\\\">\\n {#each { length: 8 }, rank}\\n {#each { length: 8 }, file}\\n <div class:black={(rank + file) % 2 === 1}></div>\\n {/each}\\n {/each}\\n</div>\\n```\", \"Else blocks\": \"```\\n<!--- copy: false --->\\n{#each expression as name}...{:else}...{/each}\\n```\\n\\nAn each block can also have an `{:else}` clause, which is rendered if the list is empty.\\n\\n```\\n{#each todos as todo}\\n <p>{todo.text}</p>\\n{:else}\\n <p>No tasks today!</p>\\n{/each}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\"}, {\"title\": \"04 Key\", \"description\": null, \"content\": {\"root\": [[], \"title: {#key ...}\", \"```\\n<!--- copy: false --->\\n{#key expression}...{/key}\\n```\", \"Key blocks destroy and recreate their contents when the value of an expression changes. When used around components, this will cause them to be reinstantiated and reinitialised:\", \"```\\n{#key value}\\n <Component />\\n{/key}\\n```\", \"It's also useful if you want a transition to play whenever a value changes:\", \"```\\n{#key value}\\n <div transition:fade>{value}</div>\\n{/key}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\"}, {\"title\": \"05 Await\", \"description\": null, \"content\": {\"root\": [[], \"title: {#await ...}\", \"```\\n<!--- copy: false --->\\n{#await expression}...{:then name}...{:catch name}...{/await}\\n```\", \"```\\n<!--- copy: false --->\\n{#await expression}...{:then name}...{/await}\\n```\", \"```\\n<!--- copy: false --->\\n{#await expression then name}...{/await}\\n```\", \"```\\n<!--- copy: false --->\\n{#await expression catch name}...{/await}\\n```\", \"Await blocks allow you to branch on the three possible states of a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) \\u2014 pending, fulfilled or rejected.\", \"```\\n{#await promise}\\n <!-- promise is pending -->\\n <p>waiting for the promise to resolve...</p>\\n{:then value}\\n <!-- promise was fulfilled or not a Promise -->\\n <p>The value is {value}</p>\\n{:catch error}\\n <!-- promise was rejected -->\\n <p>Something went wrong: {error.message}</p>\\n{/await}\\n```\", [\"[!NOTE] During server-side rendering, only the pending branch will be rendered.\", \"If the provided expression is not a `Promise`, only the `:then` branch will be rendered, including during server-side rendering.\"], \"The `catch` block can be omitted if you don't need to render anything when the promise rejects (or no error is possible).\", \"```\\n{#await promise}\\n <!-- promise is pending -->\\n <p>waiting for the promise to resolve...</p>\\n{:then value}\\n <!-- promise was fulfilled -->\\n <p>The value is {value}</p>\\n{/await}\\n```\", \"If you don't care about the pending state, you can also omit the initial block.\", \"```\\n{#await promise then value}\\n <p>The value is {value}</p>\\n{/await}\\n```\", \"Similarly, if you only want to show the error state, you can omit the `then` block.\", \"```\\n{#await promise catch error}\\n <p>The error is {error}</p>\\n{/await}\\n```\", [\"[!NOTE] You can use `#await` with [`import(...)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) to render components lazily:\", \"```\\n{#await import('./Component.svelte') then { default: Component }}\\n <Component />\\n{/await}\\n```\"]]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\"}, {\"title\": \"Passing snippets to components\", \"description\": null, \"content\": {\"Explicit props\": \"Within the template, snippets are values just like any other. As such, they can be passed to components as props ([demo](/playground/untitled#H4sIAAAAAAAAE3VS247aMBD9lZGpBGwDASRegonaPvQL2qdlH5zYEKvBNvbQLbL875VzAcKyj3PmzJnLGU8UOwqSkd8KJdaCk4TsZS0cyV49wYuJuQiQpGd-N2bu_ooaI1YwJ57hpVYoFDqSEepKKw3mO7VDeTTaIvxiRS1gb_URxvO0ibrS8WanIrHUyiHs7Vmigy28RmyHHmKvDMbMmFq4cQInvGSwTsBYWYoMVhCSB2rBFFPsyl0uruTlR3JZCWvlTXl1Yy_mawiR_rbZKZrellJ-5JQ0RiBUgnFhJ9OGR7HKmwVoilXeIye8DOJGfYCgRlZ3iE876TBsZPX7hPdteO75PC4QaIo8vwNPePmANQ2fMeEFHrLD7rR1jTNkW986E8C3KwfwVr8HSHOSEBT_kGRozyIkn_zQveXDL3rIfPJHtUDwzShJd_Qk3gQCbOGLsdq4yfTRJopRuin3I7nv6kL7ARRjmLdBDG3uv1mhuLA3V2mKtqNEf_oCn8p9aN-WYqH5peP4kWBl1UwJzAEPT9U7K--0fRrrWnPTXpCm1_EVdXjpNmlA8G1hPPyM1fKgMqjFHjctXGjLhZ05w0qpDhksGrybuNEHtJnCalZWsuaTlfq6nPaaBSv_HKw-K57BjzOiVj9ZKQYKzQjZodYFqydYTRN4gPhVzTDO2xnma3HsVWjaLjT8nbfwHy7Q5f2dBAAA)):\\n\\n```\\n<script>\\n import Table from './Table.svelte';\\n\\n const fruits = [\\n { name: 'apples', qty: 5, price: 2 },\\n { name: 'bananas', qty: 10, price: 1 },\\n { name: 'cherries', qty: 20, price: 0.5 }\\n ];\\n</script>\\n\\n{#snippet header()}\\n <th>fruit</th>\\n <th>qty</th>\\n <th>price</th>\\n <th>total</th>\\n{/snippet}\\n\\n{#snippet row(d)}\\n <td>{d.name}</td>\\n <td>{d.qty}</td>\\n <td>{d.price}</td>\\n <td>{d.qty * d.price}</td>\\n{/snippet}\\n\\n<Table data={fruits} {header} {row} />\\n```\\n\\nThink about it like passing content instead of data to a component. The concept is similar to slots in web components.\", \"Implicit props\": \"As an authoring convenience, snippets declared directly _inside_ a component implicitly become props _on_ the component ([demo](/playground/untitled#H4sIAAAAAAAAE3VSTa_aMBD8Kyu_SkAbCA-JSzBR20N_QXt6vIMTO8SqsY29tI2s_PcqTiB8vaPHs7MzuxuIZgdBMvJLo0QlOElIJZXwJHsLBBvb_XUASc7Mb9Yu_B-hsMMK5sUzvDQahUZPMkJ96aTFfKd3KA_WOISfrFACKmcOMFmk8TWUTjY73RFLoz1C5U4SPWzhrcN2GKDrlcGEWauEnyRwxCaDdQLWyVJksII2uaMWTDPNLtzX5YX8-kgua-GcHJVXI3u5WEPb0d83O03TMZSmfRzOkG1Db7mNacOL19JagVALxoWbztq-H8U6j0SaYp2P2BGbOyQ2v8PQIFMXLKRDk177pq0zf6d8bMrzwBdd0pamyPMb-IjNEzS2f86Gz_Dwf-2F9nvNSUJQ_EOSoTuJNvngqK5v4Pas7n4-OCwlEEJcQTIMO-nSQwtb-GSdsX46e9gbRoP9yGQ11I0rEuycunu6PHx1QnPhxm3SFN15MOlYEFJZtf0dUywMbwZOeBGsrKNLYB54-1R9WNqVdki7usim6VmQphf7mnpshiQRhNAXdoOfMyX3OgMlKtz0cGEcF27uLSul3mewjPjgOOoDukxjPS9rqfh0pb-8zs6aBSt_7505aZ7B9xOi0T9YKW4UooVsr0zB1BTrWQJ3EL-oWcZ572GxFoezCk37QLe3897-B2i2U62uBAAA)):\\n\\n```\\n<!-- this is semantically the same as the above -->\\n<Table data={fruits}>\\n {#snippet header()}\\n <th>fruit</th>\\n <th>qty</th>\\n <th>price</th>\\n <th>total</th>\\n {/snippet}\\n\\n {#snippet row(d)}\\n <td>{d.name}</td>\\n <td>{d.qty}</td>\\n <td>{d.price}</td>\\n <td>{d.qty * d.price}</td>\\n {/snippet}\\n</Table>\\n```\", \"Implicit `children` snippet\": \"Any content inside the component tags that is _not_ a snippet declaration implicitly becomes part of the `children` snippet ([demo](/playground/untitled#H4sIAAAAAAAAE3WOQQrCMBBFrzIMggql3ddY1Du4si5sOmIwnYRkFKX07lKqglqX8_7_w2uRDw1hjlsWI5ZqTPBoLEXMdy3K3fdZDzB5Ndfep_FKVnpWHSKNce1YiCVijirqYLwUJQOYxrsgsLmIOIZjcA1M02w4n-PpomSVvTclqyEutDX6DA2pZ7_ABIVugrmEC3XJH92P55_G39GodCmWBFrQJ2PrQAwdLGHig_NxNv9xrQa1dhWIawrv1Wzeqawa8953D-8QOmaEAQAA)):\\n\\n```\\n<!--- file: App.svelte --->\\n<Button>click me</Button>\\n```\\n\\n```\\n<!--- file: Button.svelte --->\\n<script>\\n let { children } = $props();\\n</script>\\n\\n<!-- result will be <button>click me</button> -->\\n<button>{@render children()}</button>\\n```\\n\\n['[!NOTE] Note that you cannot have a prop called `children` if you also have content inside the component \\u2014 for this reason, you should avoid having props with that name']\", \"Optional snippet props\": \"You can declare snippet props as being optional. You can either use optional chaining to not render anything if the snippet isn't set...\\n\\n```\\n<script>\\n let { children } = $props();\\n</script>\\n\\n{@render children?.()}\\n```\\n\\n...or use an `#if` block to render fallback content:\\n\\n```\\n<script>\\n let { children } = $props();\\n</script>\\n\\n{#if children}\\n {@render children()}\\n{:else}\\n fallback content\\n{/if}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\"}, {\"title\": \"07 @Render\", \"description\": null, \"content\": {\"Optional snippets\": \"If the snippet is potentially undefined \\u2014 for example, because it's an incoming prop \\u2014 then you can use optional chaining to only render it when it _is_ defined:\\n\\n```\\n{@render children?.()}\\n```\\n\\nAlternatively, use an [`{#if ...}`](if) block with an `:else` clause to render fallback content:\\n\\n```\\n{#if children}\\n {@render children()}\\n{:else}\\n <p>fallback content</p>\\n{/if}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\"}, {\"title\": \"08 @Html\", \"description\": null, \"content\": {\"Styling\": \"Content rendered this way is 'invisible' to Svelte and as such will not receive [scoped styles](scoped-styles). In other words, this will not work, and the `a` and `img` styles will be regarded as unused:\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<article>\\n {@html content}\\n</article>\\n\\n<style>\\n article {\\n a { color: hotpink }\\n img { width: 100% }\\n }\\n</style>\\n```\\n\\nInstead, use the `:global` modifier to target everything inside the `<article>`:\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<style>\\n article +++:global+++ {\\n a { color: hotpink }\\n img { width: 100% }\\n }\\n</style>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\"}, {\"title\": \"09 @Attach\", \"description\": null, \"content\": {\"Attachment factories\": \"A useful pattern is for a function, such as `tooltip` in this example, to _return_ an attachment ([demo](/playground/untitled#H4sIAAAAAAAAE3VT0XLaMBD8lavbDiaNCUlbHhTItG_5h5AH2T5ArdBppDOEMv73SkbGJGnH47F9t3un3TsfMyO3mInsh2SW1Sa7zlZKo8_E0zHjg42pGAjxBPxp7cTvUHOMldLjv-IVGUbDoUw295VTlh-WZslqa8kxsLL2ACtHWxh175NffnQfAAGikSGxYQGfPEvGfPSIWtOH0TiBVo2pWJEBJtKhQp4YYzjG9JIdcuMM5IZqHMPioY8vOSA997zQoevf4a7heO7cdp34olRiTGr07OhwH1IdoO2A7dLMbwahZq6MbRhKZWqxk7rBxTGVbuHmhCgb5qDgmIx_J6XtHHukHTrYYqx_YpzYng8aO4RYayql7hU-1ZJl0akqHBE_D9KLolwL-Dibzc7iSln9XjtqTF1UpMkJ2EmXR-BgQErsN4pxIJKr0RVO1qrxAqaTO4fbc9bKulZm3cfDY3aZDgvFGErWjmzhN7KmfX5rXyDeX8Pt1mU-hXjdBOrtuB97vK4GPUtmJ41XcRMEGDLD8do0nJ73zhUhSlyRw0t3vPqD8cjfLs-axiFgNBrkUd9Ulp50c-GLxlXAVlJX-ffpZyiSn7H0eLCUySZQcQdXlxj4El0Yv_FZvIKElqqGTruVLhzu7VRKCh22_5toOyxsWqLwwzK-cCbYNdg-hy-p9D7sbiZWUnts_wLUOF3CJgQAAA==)):\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import tippy from 'tippy.js';\\n\\n let content = $state('Hello!');\\n\\n /**\\n * @param {string} content\\n * @returns {import('svelte/attachments').Attachment}\\n */\\n function tooltip(content) {\\n return (element) => {\\n const tooltip = tippy(element, { content });\\n return tooltip.destroy;\\n };\\n }\\n</script>\\n\\n<input bind:value={content} />\\n\\n<button {@attach tooltip(content)}>\\n Hover me\\n</button>\\n```\\n\\nSince the `tooltip(content)` expression runs inside an [effect]($effect), the attachment will be destroyed and recreated whenever `content` changes. The same thing would happen for any state read _inside_ the attachment function when it first runs. (If this isn't what you want, see [Controlling when attachments re-run](#Controlling-when-attachments-re-run).)\", \"Inline attachments\": \"Attachments can also be created inline ([demo](/playground/untitled#H4sIAAAAAAAAE71Wf3OaWBT9KoyTTnW3MS-I3dYmnWXVtnRAazRJzbozRSQEApiRhwKO333vuY8m225m_9yZGOT9OPfcc84D943UTfxGr_G7K6Xr3TVeNW7D2M8avT_3DVk-YAoDNF4vNB8e2tnWjyXGlm7mPzfurVPpp5JgGmeZtwkf5PtFupCxLzVvHa832rl2lElX-s2Xm2DZFNqp_hs-rZetd4v07ORpT3qmQHu7MF2td0BZp8k6z_xkvfXP902_pZ2_1_aYWEiqm0kN8I4r79qbdZ6umnq3q_2iNf22F4dE6qt2oimwdpim_uY6XMm7Fuo-IQT_iTD_CeGTHwZ38ieIJUFQRxirR1Xf39Dw0X5z0I72Af4tD61vvPNwWKQnqmfPTbduhsEd2J3vO_oBd3dc6fF2X7umNdWGf0vBRhSS6qoV7cCXfTXWfKmvWG61_si_vfU92Wz-E4RhsLhNIYinsox9QKGVd8-tuACCeKXRX12P-T_eKf7fhTq0Hvt-f3ailtSeoxJHRo1-58NoPe1UiBc1hkL8Yeh45y_vQ3mcuNl9T8s3cXPRWLnS7YWJG_gn2Tb4tUjid8jua-PVl08j_ab8I14mH8Llx0s5Tz5Err4ql52r_GYg0mVy1bEGZuD0ze64b5TWYFiM-16wSuJ4JT5vfVpDcztrcG_YkRU4s6HxufzDWF4XuVeJ1P10IbzBemt3Vp1V2e04ZXfrJd7Wicyd039brRIv_RIVu_nXi7X1cfL2sy66ztToUp1TO7qJ7NlwZ0f30pld5qNSVE5o6PbMojFHjgZB7oSicPpGteyLclQap7SvY0dXtM_LR1NT2JFHey3aaxa0VxCeYJ7RMHemoiCcgPZV9pR7o7kgcOjeGliYk9hjDZx8FAq6enwlTPSZj_vYPw9Il64dXdIY8ZmapzwfEd8-1ZyaxWhqkIZOibXUd-6Upqi1pD4uMicCV1GA_7zi73UN8BaF4sC8peJtMjfmjbHZBFwq5ov50qRaE0l96NZggnW4KqypYRAW-uhSz9ADvklwJF2J-5W0Z5fQPBhDX92R6I_0IFxRgDftge4l4dP-gH1hjD7uqU6fsOEZ9UNrCdPB-nys6uXgY6O3ZMd9sy5T9PghqrWHdjo4jB51CgLiKJaDYYA-7WgYONf1FbjkI-mE3EAfUY_rijfuJ_CVPaR50oe9JF7Q0pI8Dw3osxxYHdYPGbp2CnwHF8KvwJv2wEv0Z3ilQI6U9uwbZxbYJXvEmjjQjjCHkvNLvNg3yhzXQd1olamsT4IRrZmX0MUDpwL7R8zzHj7pSh9hPHFSHjLezKqAST51uC5zmtQ87skDUaneLokT5RbXkPWSYz53Abgjc8_o4KFGUZ-Hgv2Z1l5OTYM9D-HfUD0L-EwxH5wRnIG61gS-khfgY1bq7IAP_DA4l5xRuh9xlm8yGjutc8t-wHtkhWv3hc7aqGwiK5KzgvM5xRkZYn193uEln-su55j1GaIv7oM4iPrsVHiG0Dx7TR9-1lBfqFdwfvSd5LNL5xyZVp5NoHFZ57FkfiF6vKs4k5zvIfrX5xX6MXmt0gM5MTu8DjnhukrHHzTRd3jm0dma0_f_x5cxP9f4jBdqHvmbq2fUjzqcKh2Cp-yWj9ntcHanXmBXxhu7Q--eyjhfNFpaV7zgz4nWEUb7zUOhpevjjf_gu_KZ99pxFlZ-T3sttkmYqrco_26q35v0Ewzv5EZPbnL_8BfduWGMnyyN3q0bZ_7hb_7KG_L4CQAA)):\\n\\n```\\n<!--- file: App.svelte --->\\n<canvas\\n width={32}\\n height={32}\\n {@attach (canvas) => {\\n const context = canvas.getContext('2d');\\n\\n $effect(() => {\\n context.fillStyle = color;\\n context.fillRect(0, 0, canvas.width, canvas.height);\\n });\\n }}\\n></canvas>\\n```\\n\\n[\\\"[!NOTE]\\\\nThe nested effect runs whenever `color` changes, while the outer effect (where `canvas.getContext(...)` is called) only runs once, since it doesn't read any reactive state.\\\"]\", \"Passing attachments to components\": \"When used on a component, `{@attach ...}` will create a prop whose key is a [`Symbol`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol). If the component then [spreads](/tutorial/svelte/spread-props) props onto an element, the element will receive those attachments.\\n\\nThis allows you to create _wrapper components_ that augment elements ([demo](/playground/untitled#H4sIAAAAAAAAE3VUS3ObMBD-KxvajnFqsJM2PhA7TXrKob31FjITAbKtRkiMtDhJPfz3LiAMdpxhGJvdb1_fPnaeYjn3Iu-WIbJ04028lZDcetHDzsO3olbVApI74F1RhHbLJdayhFl-Sp5qhVwhufEWNjWiwJtYxSjyQhsEFEXxBiujcxg1_8O_dnQ9APwsEbVyiHDafjrvDZCgkiO4MLCEzxYZcn90z6XUZ6OxA61KlaIgV6i1pFC-sxjDrlbHaDiWRoGvdMbHsLzp5DES0mJnRxGaRBvcBHb7yFUTCQeunEWYcYtGv12TqgFUDbCK1WLaM6IWQhUlQiJUFm2ZLPly51xXMG0Rjoyd69C7UqqG2nu95QZyXvtvLVpri2-SN4hoLXXCZFfhQ8aQBU1VgdEaH_vSgyBZR_BpPp_vi0tY-rw2ulRZkGqpTQRbZvwa2BPgFC8bgbw31CbjJjAsE6WNYBZeGp7vtQXLMqHWnZx-5kM1TR5ycpkZXQR2wzL94l8Ur1C_3-g168SfQf1MyfRi3LW9fs77emJEw5QV9SREoLTq06tcczq7d6xEUcJX2vAhO1b843XK34e5unZEMBr15ekuKEusluWAF8lXhE2ZTP2r2RcIHJ-163FPKerCgYJLOB9i4GvNwviI5-gAQiFFBk3tBTOU3HFXEk0R8o86WvUD64aINhv5K3oRmpJXkw8uxMG6Hh6JY9X7OwGSqfUy9tDG3sHNoEi0d_d_fv9qndxRU0VClFqo3KVo3U655Hnt1PXB3Qra2Y2QGdEwgTAMCxopsoxOe6SD0gD8movDhT0LAnhqlE8gVCpLWnRoV7OJCkFAwEXitrYL1W7p7pbiE_P7XH6E_rihODm5s52XtiH9Ekaw0VgI9exadWL1uoEYjPtg2672k5szsxbKyWB2fdT0w5Y_0hcT8oXOlRetmLS8-g-6TLXXQgYAAA==)):\\n\\n```\\n<!--- file: Button.svelte --->\\n<script>\\n /** @type {import('svelte/elements').HTMLButtonAttributes} */\\n let { children, ...props } = $props();\\n</script>\\n\\n<!-- `props` includes attachments -->\\n<button {...props}>\\n {@render children?.()}\\n</button>\\n```\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import tippy from 'tippy.js';\\n import Button from './Button.svelte';\\n\\n let content = $state('Hello!');\\n\\n /**\\n * @param {string} content\\n * @returns {import('svelte/attachments').Attachment}\\n */\\n function tooltip(content) {\\n return (element) => {\\n const tooltip = tippy(element, { content });\\n return tooltip.destroy;\\n };\\n }\\n</script>\\n\\n<input bind:value={content} />\\n\\n<Button {@attach tooltip(content)}>\\n Hover me\\n</Button>\\n```\", \"Controlling when attachments re-run\": \"Attachments, unlike [actions](use), are fully reactive: `{@attach foo(bar)}` will re-run on changes to `foo` _or_ `bar` (or any state read inside `foo`):\\n\\n```\\n// @errors: 7006 2304 2552\\nfunction foo(bar) {\\n return (node) => {\\n veryExpensiveSetupWork(node);\\n update(node, bar);\\n };\\n}\\n```\\n\\nIn the rare case that this is a problem (for example, if `foo` does expensive and unavoidable setup work) consider passing the data inside a function and reading it in a child effect:\\n\\n```\\n// @errors: 7006 2304 2552\\nfunction foo(+++getBar+++) {\\n return (node) => {\\n veryExpensiveSetupWork(node);\\n\\n+++ $effect(() => {\\n update(node, getBar());\\n });+++\\n }\\n}\\n```\", \"Creating attachments programmatically\": \"To add attachments to an object that will be spread onto a component or element, use [`createAttachmentKey`](svelte-attachments#createAttachmentKey).\", \"Converting actions to attachments\": \"If you're using a library that only provides actions, you can convert them to attachments with [`fromAction`](svelte-attachments#fromAction), allowing you to (for example) use them with components.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\"}, {\"title\": \"10 @Const\", \"description\": null, \"content\": {\"root\": [[], \"title: {@const ...}\", \"The `{@const ...}` tag defines a local constant.\", \"```\\n{#each boxes as box}\\n {@const area = box.width * box.height}\\n {box.width} * {box.height} = {area}\\n{/each}\\n```\", \"`{@const}` is only allowed as an immediate child of a block \\u2014 `{#if ...}`, `{#each ...}`, `{#snippet ...}` and so on \\u2014 a `<Component />` or a `<svelte:boundary>`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\"}, {\"title\": \"11 @Debug\", \"description\": null, \"content\": {\"root\": [[], \"title: {@debug ...}\", \"The `{@debug ...}` tag offers an alternative to `console.log(...)`. It logs the values of specific variables whenever they change, and pauses code execution if you have devtools open.\", \"```\\n<script>\\n let user = {\\n firstname: 'Ada',\\n lastname: 'Lovelace'\\n };\\n</script>\\n\\n{@debug user}\\n\\n<h1>Hello {user.firstname}!</h1>\\n```\", \"`{@debug ...}` accepts a comma-separated list of variable names (not arbitrary expressions).\", \"```\\n<!-- Compiles -->\\n{@debug user}\\n{@debug user1, user2, user3}\\n\\n<!-- WON'T compile -->\\n{@debug user.firstname}\\n{@debug myArray[0]}\\n{@debug !isReady}\\n{@debug typeof user === 'object'}\\n```\", \"The `{@debug}` tag without any arguments will insert a `debugger` statement that gets triggered when _any_ state changes, as opposed to the specified variables.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10]\"}, {\"title\": \"12 Bind\", \"description\": null, \"content\": {\"Function bindings\": \"You can also use `bind:property={get, set}`, where `get` and `set` are functions, allowing you to perform validation and transformation:\\n\\n```\\n<input bind:value={\\n () => value,\\n (v) => value = v.toLowerCase()}\\n/>\\n```\\n\\nIn the case of readonly bindings like [dimension bindings](#Dimensions), the `get` value should be `null`:\\n\\n```\\n<div\\n bind:clientWidth={null, redraw}\\n bind:clientHeight={null, redraw}\\n>...</div>\\n```\\n\\n['[!NOTE]\\\\nFunction bindings are available in Svelte 5.9.0 and newer.']\", \"`<input bind:value>`\": \"A `bind:value` directive on an `<input>` element binds the input's `value` property:\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<script>\\n let message = $state('hello');\\n</script>\\n\\n<input bind:value={message} />\\n\\n<p>{message}</p>\\n```\\n\\nIn the case of a numeric input (`type=\\\"number\\\"` or `type=\\\"range\\\"`), the value will be coerced to a number ([demo](/playground/untitled#H4sIAAAAAAAAE6WPwYoCMQxAfyWEPeyiOOqx2w74Hds9pBql0IllmhGXYf5dKqwiyILsLXnwwsuI-5i4oPkaUX8yo7kCnKNQV7dNzoty4qSVBSr8jG-Poixa0KAt2z5mbb14TaxA4OCtKCm_rz4-f2m403WltrlrYhMFTtcLNkoeFGqZ8yhDF7j3CCHKzpwoDexGmqCL4jwuPUJHZ-dxVcfmyYGe5MAv-La5pbxYFf5Z9Zf_UJXb-sEMquFgJJhBmGyTW5yj8lnRaD_w9D1dAKSSj7zqAQAA)):\\n\\n```\\n<script>\\n let a = $state(1);\\n let b = $state(2);\\n</script>\\n\\n<label>\\n <input type=\\\"number\\\" bind:value={a} min=\\\"0\\\" max=\\\"10\\\" />\\n <input type=\\\"range\\\" bind:value={a} min=\\\"0\\\" max=\\\"10\\\" />\\n</label>\\n\\n<label>\\n <input type=\\\"number\\\" bind:value={b} min=\\\"0\\\" max=\\\"10\\\" />\\n <input type=\\\"range\\\" bind:value={b} min=\\\"0\\\" max=\\\"10\\\" />\\n</label>\\n\\n<p>{a} + {b} = {a + b}</p>\\n```\\n\\nIf the input is empty or invalid (in the case of `type=\\\"number\\\"`), the value is `undefined`.\\n\\nSince 5.6.0, if an `<input>` has a `defaultValue` and is part of a form, it will revert to that value instead of the empty string when the form is reset. Note that for the initial render the value of the binding takes precedence unless it is `null` or `undefined`.\\n\\n```\\n<script>\\n let value = $state('');\\n</script>\\n\\n<form>\\n <input bind:value defaultValue=\\\"not the empty string\\\">\\n <input type=\\\"reset\\\" value=\\\"Reset\\\">\\n</form>\\n```\\n\\n[\\\"[!NOTE]\\\\nUse reset buttons sparingly, and ensure that users won't accidentally click them while trying to submit the form.\\\"]\", \"`<input bind:checked>`\": \"Checkbox and radio inputs can be bound with `bind:checked`:\\n\\n```\\n<label>\\n <input type=\\\"checkbox\\\" bind:checked={accepted} />\\n Accept terms and conditions\\n</label>\\n```\\n\\nSince 5.6.0, if an `<input>` has a `defaultChecked` attribute and is part of a form, it will revert to that value instead of `false` when the form is reset. Note that for the initial render the value of the binding takes precedence unless it is `null` or `undefined`.\\n\\n```\\n<script>\\n let checked = $state(true);\\n</script>\\n\\n<form>\\n <input type=\\\"checkbox\\\" bind:checked defaultChecked={true}>\\n <input type=\\\"reset\\\" value=\\\"Reset\\\">\\n</form>\\n```\", \"`<input bind:indeterminate>`\": \"Checkboxes can be in an [indeterminate](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/indeterminate) state, independently of whether they are checked or unchecked:\\n\\n```\\n<script>\\n let checked = $state(false);\\n let indeterminate = $state(true);\\n</script>\\n\\n<form>\\n <input type=\\\"checkbox\\\" bind:checked bind:indeterminate>\\n\\n {#if indeterminate}\\n waiting...\\n {:else if checked}\\n checked\\n {:else}\\n unchecked\\n {/if}\\n</form>\\n```\", \"`<input bind:group>`\": \"Inputs that work together can use `bind:group` ([demo](/playground/untitled#H4sIAAAAAAAAE62T32_TMBDH_5XDQkpbrct7SCMGEvCEECDxsO7BSW6L2c227EvbKOv_jp0f6jYhQKJv5_P3PvdL1wstH1Bk4hMSGdgbRzUssFaM9VJciFtF6EV23QvubNRFR_BPUVfWXvodEkdfKT3-zl8Zzag5YETuK6csF1u9ZUIGNo4VkYQNvPYsGRfJF5JKJ8s3QRJE6WoFb2Nq6K-ck13u2Sl9Vxxhlc6QUBIFnz9Brm9ifJ6esun81XoNd860FmtwslYGlLYte5AO4aHlVhJ1gIeKWq92COt1iMtJlkhFPkgh1rHZiiF6K6BUus4G5KafGznCTlIbVUMfQZUWMJh5OrL-C_qjMYSwb1DyiH7iOEuCb1ZpWTUjfHqcwC_GWDVY3ZfmME_SGttSmD9IHaYatvWHIc6xLyqad3mq6KuqcCwnWn9p8p-p71BqP2IH81zc9w2in-od7XORP7ayCpd5YCeXI_-p59mObPF9WmwGpx3nqS2Gzw8TO3zOaS5_GqUXyQUkS3h8hOSz0ZhMESHGc0c4Hm3MAn00t1wrb0l2GZRkqvt4sXwczm6Qh8vnUJzI2LV4vAkvqWgfehTZrSSPx19WiVfFfAQAAA==)):\\n\\n```\\n<!--- file: BurritoChooser.svelte --->\\n<script>\\n let tortilla = $state('Plain');\\n\\n /** @type {string[]} */\\n let fillings = $state([]);\\n</script>\\n\\n<!-- grouped radio inputs are mutually exclusive -->\\n<label><input type=\\\"radio\\\" bind:group={tortilla} value=\\\"Plain\\\" /> Plain</label>\\n<label><input type=\\\"radio\\\" bind:group={tortilla} value=\\\"Whole wheat\\\" /> Whole wheat</label>\\n<label><input type=\\\"radio\\\" bind:group={tortilla} value=\\\"Spinach\\\" /> Spinach</label>\\n\\n<!-- grouped checkbox inputs populate an array -->\\n<label><input type=\\\"checkbox\\\" bind:group={fillings} value=\\\"Rice\\\" /> Rice</label>\\n<label><input type=\\\"checkbox\\\" bind:group={fillings} value=\\\"Beans\\\" /> Beans</label>\\n<label><input type=\\\"checkbox\\\" bind:group={fillings} value=\\\"Cheese\\\" /> Cheese</label>\\n<label><input type=\\\"checkbox\\\" bind:group={fillings} value=\\\"Guac (extra)\\\" /> Guac (extra)</label>\\n```\\n\\n['[!NOTE] `bind:group` only works if the inputs are in the same Svelte component.']\", \"`<input bind:files>`\": \"On `<input>` elements with `type=\\\"file\\\"`, you can use `bind:files` to get the [`FileList` of selected files](https://developer.mozilla.org/en-US/docs/Web/API/FileList). When you want to update the files programmatically, you always need to use a `FileList` object. Currently `FileList` objects cannot be constructed directly, so you need to create a new [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object and get `files` from there.\\n\\n```\\n<script>\\n let files = $state();\\n\\n function clear() {\\n files = new DataTransfer().files; // null or undefined does not work\\n }\\n</script>\\n\\n<label for=\\\"avatar\\\">Upload a picture:</label>\\n<input accept=\\\"image/png, image/jpeg\\\" bind:files id=\\\"avatar\\\" name=\\\"avatar\\\" type=\\\"file\\\" />\\n<button onclick={clear}>clear</button>\\n```\\n\\n`FileList` objects also cannot be modified, so if you want to e.g. delete a single file from the list, you need to create a new `DataTransfer` object and add the files you want to keep.\\n\\n['[!NOTE] `DataTransfer` may not be available in server-side JS runtimes. Leaving the state that is bound to `files` uninitialized prevents potential errors if components are server-side rendered.']\", \"`<select bind:value>`\": \"A `<select>` value binding corresponds to the `value` property on the selected `<option>`, which can be any value (not just strings, as is normally the case in the DOM).\\n\\n```\\n<select bind:value={selected}>\\n <option value={a}>a</option>\\n <option value={b}>b</option>\\n <option value={c}>c</option>\\n</select>\\n```\\n\\nA `<select multiple>` element behaves similarly to a checkbox group. The bound variable is an array with an entry corresponding to the `value` property of each selected `<option>`.\\n\\n```\\n<select multiple bind:value={fillings}>\\n <option value=\\\"Rice\\\">Rice</option>\\n <option value=\\\"Beans\\\">Beans</option>\\n <option value=\\\"Cheese\\\">Cheese</option>\\n <option value=\\\"Guac (extra)\\\">Guac (extra)</option>\\n</select>\\n```\\n\\nWhen the value of an `<option>` matches its text content, the attribute can be omitted.\\n\\n```\\n<select multiple bind:value={fillings}>\\n <option>Rice</option>\\n <option>Beans</option>\\n <option>Cheese</option>\\n <option>Guac (extra)</option>\\n</select>\\n```\\n\\nYou can give the `<select>` a default value by adding a `selected` attribute to the`<option>` (or options, in the case of `<select multiple>`) that should be initially selected. If the `<select>` is part of a form, it will revert to that selection when the form is reset. Note that for the initial render the value of the binding takes precedence if it's not `undefined`.\\n\\n```\\n<select bind:value={selected}>\\n <option value={a}>a</option>\\n <option value={b} selected>b</option>\\n <option value={c}>c</option>\\n</select>\\n```\", \"`<audio>`\": \"`<audio>` elements have their own set of bindings \\u2014 five two-way ones...\\n\\n['[`currentTime`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/currentTime)', '[`playbackRate`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/playbackRate)', '[`paused`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/paused)', '[`volume`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/volume)', '[`muted`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/muted)']\\n\\n...and six readonly ones:\\n\\n['[`duration`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/duration)', '[`buffered`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/buffered)', '[`seekable`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seekable)', '[`seeking`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seeking_event)', '[`ended`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/ended)', '[`readyState`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/readyState)', '[`played`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/played)']\\n\\n```\\n<audio src={clip} bind:duration bind:currentTime bind:paused></audio>\\n```\", \"`<video>`\": \"`<video>` elements have all the same bindings as [`<audio>`](#audio) elements, plus readonly [`videoWidth`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement/videoWidth) and [`videoHeight`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement/videoHeight) bindings.\", \"`<img>`\": \"`<img>` elements have two readonly bindings:\\n\\n['[`naturalWidth`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/naturalWidth)', '[`naturalHeight`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/naturalHeight)']\", \"`<details bind:open>`\": \"`<details>` elements support binding to the `open` property.\\n\\n```\\n<details bind:open={isOpen}>\\n <summary>How do you comfort a JavaScript bug?</summary>\\n <p>You console it.</p>\\n</details>\\n```\", \"`window` and `document`\": \"To bind to properties of `window` and `document`, see [`<svelte:window>`](svelte-window) and [`<svelte:document>`](svelte-document).\", \"Contenteditable bindings\": \"Elements with the `contenteditable` attribute support the following bindings:\\n\\n['[`innerHTML`](https://developer.mozilla.org/en-US/docs/Web/API/Element/innerHTML)', '[`innerText`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/innerText)', '[`textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent)']\\n\\n['[!NOTE] There are [subtle differences between `innerText` and `textContent`](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext).']\\n\\n<!-- for some reason puts the comment and html on same line -->\\n<!-- prettier-ignore -->\\n```svelte\\n<div contenteditable=\\\"true\\\" bind:innerHTML={html}></div>\\n```\", \"Dimensions\": \"All visible elements have the following readonly bindings, measured with a `ResizeObserver`:\\n\\n['[`clientWidth`](https://developer.mozilla.org/en-US/docs/Web/API/Element/clientWidth)', '[`clientHeight`](https://developer.mozilla.org/en-US/docs/Web/API/Element/clientHeight)', '[`offsetWidth`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/offsetWidth)', '[`offsetHeight`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/offsetHeight)', '[`contentRect`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry/contentRect)', '[`contentBoxSize`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry/contentBoxSize)', '[`borderBoxSize`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry/borderBoxSize)', '[`devicePixelContentBoxSize`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserverEntry/devicePixelContentBoxSize)']\\n\\n```\\n<div bind:offsetWidth={width} bind:offsetHeight={height}>\\n <Chart {width} {height} />\\n</div>\\n```\\n\\n[\\\"[!NOTE] `display: inline` elements do not have a width or height (except for elements with 'intrinsic' dimensions, like `<img>` and `<canvas>`), and cannot be observed with a `ResizeObserver`. You will need to change the `display` style of these elements to something else, such as `inline-block`. Note that CSS transformations do not trigger `ResizeObserver` callbacks.\\\"]\", \"bind:this\": \"```\\n<!--- copy: false --->\\nbind:this={dom_node}\\n```\\n\\nTo get a reference to a DOM node, use `bind:this`. The value will be `undefined` until the component is mounted \\u2014 in other words, you should read it inside an effect or an event handler, but not during component initialisation:\\n\\n```\\n<script>\\n /** @type {HTMLCanvasElement} */\\n let canvas;\\n\\n $effect(() => {\\n const ctx = canvas.getContext('2d');\\n drawStuff(ctx);\\n });\\n</script>\\n\\n<canvas bind:this={canvas}></canvas>\\n```\\n\\nComponents also support `bind:this`, allowing you to interact with component instances programmatically.\\n\\n```\\n<!--- file: App.svelte --->\\n<ShoppingCart bind:this={cart} />\\n\\n<button onclick={() => cart.empty()}> Empty shopping cart </button>\\n```\\n\\n```\\n<!--- file: ShoppingCart.svelte --->\\n<script>\\n // All instance exports are available on the instance object\\n export function empty() {\\n // ...\\n }\\n</script>\\n```\", \"bind:_property_ for components\": \"```\\nbind:property={variable}\\n```\\n\\nYou can bind to component props using the same syntax as for elements.\\n\\n```\\n<Keypad bind:value={pin} />\\n```\\n\\nWhile Svelte props are reactive without binding, that reactivity only flows downward into the component by default. Using `bind:property` allows changes to the property from within the component to flow back up out of the component.\\n\\nTo mark a property as bindable, use the [`$bindable`]($bindable) rune:\\n\\n```\\n<script>\\n let { readonlyProperty, bindableProperty = $bindable() } = $props();\\n</script>\\n```\\n\\nDeclaring a property as bindable means it _can_ be used using `bind:`, not that it _must_ be used using `bind:`.\\n\\nBindable properties can have a fallback value:\\n\\n```\\n<script>\\n let { bindableProperty = $bindable('fallback value') } = $props();\\n</script>\\n```\\n\\nThis fallback value _only_ applies when the property is _not_ bound. When the property is bound and a fallback value is present, the parent is expected to provide a value other than `undefined`, else a runtime error is thrown. This prevents hard-to-reason-about situations where it's unclear which value should apply.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11]\"}, {\"title\": \"13 Use\", \"description\": null, \"content\": {\"Typing\": \"The `Action` interface receives three optional type arguments \\u2014 a node type (which can be `Element`, if the action applies to everything), a parameter, and any custom event handlers created by the action:\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n /**\\n * @type {import('svelte/action').Action<\\n * HTMLDivElement,\\n * undefined,\\n * {\\n * onswiperight: (e: CustomEvent) => void;\\n * onswipeleft: (e: CustomEvent) => void;\\n * // ...\\n * }\\n * >}\\n */\\n function gestures(node) {\\n $effect(() => {\\n // ...\\n node.dispatchEvent(new CustomEvent('swipeleft'));\\n\\n // ...\\n node.dispatchEvent(new CustomEvent('swiperight'));\\n });\\n }\\n</script>\\n\\n<div\\n use:gestures\\n onswipeleft={next}\\n onswiperight={prev}\\n>...</div>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12]\"}, {\"title\": \"14 Transition\", \"description\": null, \"content\": {\"Local vs global\": \"Transitions are local by default. Local transitions only play when the block they belong to is created or destroyed, _not_ when parent blocks are created or destroyed.\\n\\n```\\n{#if x}\\n {#if y}\\n <p transition:fade>fades in and out only when y changes</p>\\n\\n <p transition:fade|global>fades in and out when x or y change</p>\\n {/if}\\n{/if}\\n```\", \"Built-in transitions\": \"A selection of built-in transitions can be imported from the [`svelte/transition`](svelte-transition) module.\", \"Transition parameters\": \"Transitions can have parameters.\\n\\n(The double `{{curlies}}` aren't a special syntax; this is an object literal inside an expression tag.)\\n\\n```\\n{#if visible}\\n <div transition:fade={{ duration: 2000 }}>fades in and out over two seconds</div>\\n{/if}\\n```\", \"Custom transition functions\": \"```\\n/// copy: false\\n// @noErrors\\ntransition = (node: HTMLElement, params: any, options: { direction: 'in' | 'out' | 'both' }) => {\\n delay?: number,\\n duration?: number,\\n easing?: (t: number) => number,\\n css?: (t: number, u: number) => string,\\n tick?: (t: number, u: number) => void\\n}\\n```\\n\\nTransitions can use custom functions. If the returned object has a `css` function, Svelte will generate keyframes for a [web animation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).\\n\\nThe `t` argument passed to `css` is a value between `0` and `1` after the `easing` function has been applied. _In_ transitions run from `0` to `1`, _out_ transitions run from `1` to `0` \\u2014 in other words, `1` is the element's natural state, as though no transition had been applied. The `u` argument is equal to `1 - t`.\\n\\nThe function is called repeatedly _before_ the transition begins, with different `t` and `u` arguments.\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import { elasticOut } from 'svelte/easing';\\n\\n /** @type {boolean} */\\n export let visible;\\n\\n /**\\n * @param {HTMLElement} node\\n * @param {{ delay?: number, duration?: number, easing?: (t: number) => number }} params\\n */\\n function whoosh(node, params) {\\n const existingTransform = getComputedStyle(node).transform.replace('none', '');\\n\\n return {\\n delay: params.delay || 0,\\n duration: params.duration || 400,\\n easing: params.easing || elasticOut,\\n css: (t, u) => `transform: ${existingTransform} scale(${t})`\\n };\\n }\\n</script>\\n\\n{#if visible}\\n <div in:whoosh>whooshes in</div>\\n{/if}\\n```\\n\\nA custom transition function can also return a `tick` function, which is called _during_ the transition with the same `t` and `u` arguments.\\n\\n[\\\"[!NOTE] If it's possible to use `css` instead of `tick`, do so \\u2014 web animations can run off the main thread, preventing jank on slower devices.\\\"]\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n export let visible = false;\\n\\n /**\\n * @param {HTMLElement} node\\n * @param {{ speed?: number }} params\\n */\\n function typewriter(node, { speed = 1 }) {\\n const valid = node.childNodes.length === 1 && node.childNodes[0].nodeType === Node.TEXT_NODE;\\n\\n if (!valid) {\\n throw new Error(`This transition only works on elements with a single text node child`);\\n }\\n\\n const text = node.textContent;\\n const duration = text.length / (speed * 0.01);\\n\\n return {\\n duration,\\n tick: (t) => {\\n const i = ~~(text.length * t);\\n node.textContent = text.slice(0, i);\\n }\\n };\\n }\\n</script>\\n\\n{#if visible}\\n <p in:typewriter={{ speed: 1 }}>The quick brown fox jumps over the lazy dog</p>\\n{/if}\\n```\\n\\nIf a transition returns a function instead of a transition object, the function will be called in the next microtask. This allows multiple transitions to coordinate, making [crossfade effects](/tutorial/deferred-transitions) possible.\\n\\nTransition functions also receive a third argument, `options`, which contains information about the transition.\\n\\nAvailable values in the `options` object are:\\n\\n['`direction` - one of `in`, `out`, or `both` depending on the type of transition']\", \"Transition events\": \"An element with transitions will dispatch the following events in addition to any standard DOM events:\\n\\n['`introstart`', '`introend`', '`outrostart`', '`outroend`']\\n\\n```\\n{#if visible}\\n <p\\n transition:fly={{ y: 200, duration: 2000 }}\\n onintrostart={() => (status = 'intro started')}\\n onoutrostart={() => (status = 'outro started')}\\n onintroend={() => (status = 'intro ended')}\\n onoutroend={() => (status = 'outro ended')}\\n >\\n Flies in and out\\n </p>\\n{/if}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13]\"}, {\"title\": \"15 In And Out\", \"description\": null, \"content\": {\"root\": [[], \"title: in: and out:\", \"The `in:` and `out:` directives are identical to [`transition:`](transition), except that the resulting transitions are not bidirectional \\u2014 an `in` transition will continue to 'play' alongside the `out` transition, rather than reversing, if the block is outroed while the transition is in progress. If an out transition is aborted, transitions will restart from scratch.\", \"```\\n<script>\\n import { fade, fly } from 'svelte/transition';\\n \\n let visible = $state(false);\\n</script>\\n\\n<label>\\n <input type=\\\"checkbox\\\" bind:checked={visible}>\\n visible\\n</label>\\n\\n{#if visible}\\n <div in:fly={{ y: 200 }} out:fade>flies in, fades out</div>\\n{/if}\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14]\"}, {\"title\": \"16 Animate\", \"description\": null, \"content\": {\"Animation Parameters\": \"As with actions and transitions, animations can have parameters.\\n\\n(The double `{{curlies}}` aren't a special syntax; this is an object literal inside an expression tag.)\\n\\n```\\n{#each list as item, index (item)}\\n <li animate:flip={{ delay: 500 }}>{item}</li>\\n{/each}\\n```\", \"Custom animation functions\": \"```\\n/// copy: false\\n// @noErrors\\nanimation = (node: HTMLElement, { from: DOMRect, to: DOMRect } , params: any) => {\\n delay?: number,\\n duration?: number,\\n easing?: (t: number) => number,\\n css?: (t: number, u: number) => string,\\n tick?: (t: number, u: number) => void\\n}\\n```\\n\\nAnimations can use custom functions that provide the `node`, an `animation` object and any `parameters` as arguments. The `animation` parameter is an object containing `from` and `to` properties each containing a [DOMRect](https://developer.mozilla.org/en-US/docs/Web/API/DOMRect#Properties) describing the geometry of the element in its `start` and `end` positions. The `from` property is the DOMRect of the element in its starting position, and the `to` property is the DOMRect of the element in its final position after the list has been reordered and the DOM updated.\\n\\nIf the returned object has a `css` method, Svelte will create a [web animation](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) that plays on the element.\\n\\nThe `t` argument passed to `css` is a value that goes from `0` and `1` after the `easing` function has been applied. The `u` argument is equal to `1 - t`.\\n\\nThe function is called repeatedly _before_ the animation begins, with different `t` and `u` arguments.\\n\\n<!-- TODO: Types -->\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import { cubicOut } from 'svelte/easing';\\n\\n /**\\n * @param {HTMLElement} node\\n * @param {{ from: DOMRect; to: DOMRect }} states\\n * @param {any} params\\n */\\n function whizz(node, { from, to }, params) {\\n const dx = from.left - to.left;\\n const dy = from.top - to.top;\\n\\n const d = Math.sqrt(dx * dx + dy * dy);\\n\\n return {\\n delay: 0,\\n duration: Math.sqrt(d) * 120,\\n easing: cubicOut,\\n css: (t, u) => `transform: translate(${u * dx}px, ${u * dy}px) rotate(${t * 360}deg);`\\n };\\n }\\n</script>\\n\\n{#each list as item, index (item)}\\n <div animate:whizz>{item}</div>\\n{/each}\\n```\\n\\nA custom animation function can also return a `tick` function, which is called _during_ the animation with the same `t` and `u` arguments.\\n\\n[\\\"[!NOTE] If it's possible to use `css` instead of `tick`, do so \\u2014 web animations can run off the main thread, preventing jank on slower devices.\\\"]\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import { cubicOut } from 'svelte/easing';\\n\\n /**\\n * @param {HTMLElement} node\\n * @param {{ from: DOMRect; to: DOMRect }} states\\n * @param {any} params\\n */\\n function whizz(node, { from, to }, params) {\\n const dx = from.left - to.left;\\n const dy = from.top - to.top;\\n\\n const d = Math.sqrt(dx * dx + dy * dy);\\n\\n return {\\n delay: 0,\\n duration: Math.sqrt(d) * 120,\\n easing: cubicOut,\\n tick: (t, u) => Object.assign(node.style, { color: t > 0.5 ? 'Pink' : 'Blue' })\\n };\\n }\\n</script>\\n\\n{#each list as item, index (item)}\\n <div animate:whizz>{item}</div>\\n{/each}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15]\"}, {\"title\": \"17 Style\", \"description\": null, \"content\": {\"root\": [[], \"title: style:\", \"The `style:` directive provides a shorthand for setting multiple styles on an element.\", \"```\\n<!-- These are equivalent -->\\n<div style:color=\\\"red\\\">...</div>\\n<div style=\\\"color: red;\\\">...</div>\\n```\", \"The value can contain arbitrary expressions:\", \"```\\n<div style:color={myColor}>...</div>\\n```\", \"The shorthand form is allowed:\", \"```\\n<div style:color>...</div>\\n```\", \"Multiple styles can be set on a single element:\", \"```\\n<div style:color style:width=\\\"12rem\\\" style:background-color={darkMode ? 'black' : 'white'}>...</div>\\n```\", \"To mark a style as important, use the `|important` modifier:\", \"```\\n<div style:color|important=\\\"red\\\">...</div>\\n```\", \"When `style:` directives are combined with `style` attributes, the directives will take precedence,\\neven over `!important` properties:\", \"```\\n<div style:color=\\\"red\\\" style=\\\"color: blue\\\">This will be red</div>\\n<div style:color=\\\"red\\\" style=\\\"color: blue !important\\\">This will still be red</div>\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16]\"}, {\"title\": \"class\", \"description\": null, \"content\": {\"Attributes\": {\"Objects and arrays\": \"Since Svelte 5.16, `class` can be an object or array, and is converted to a string using [clsx](https://github.com/lukeed/clsx).\\n\\nIf the value is an object, the truthy keys are added:\\n\\n```\\n<script>\\n let { cool } = $props();\\n</script>\\n\\n<!-- results in `class=\\\"cool\\\"` if `cool` is truthy,\\n `class=\\\"lame\\\"` otherwise -->\\n<div class={{ cool, lame: !cool }}>...</div>\\n```\\n\\nIf the value is an array, the truthy values are combined:\\n\\n```\\n<!-- if `faded` and `large` are both truthy, results in\\n `class=\\\"saturate-0 opacity-50 scale-200\\\"` -->\\n<div class={[faded && 'saturate-0 opacity-50', large && 'scale-200']}>...</div>\\n```\\n\\nNote that whether we're using the array or object form, we can set multiple classes simultaneously with a single condition, which is particularly useful if you're using things like Tailwind.\\n\\nArrays can contain arrays and objects, and clsx will flatten them. This is useful for combining local classes with props, for example:\\n\\n```\\n<!--- file: Button.svelte --->\\n<script>\\n let props = $props();\\n</script>\\n\\n<button {...props} class={['cool-button', props.class]}>\\n {@render props.children?.()}\\n</button>\\n```\\n\\nThe user of this component has the same flexibility to use a mixture of objects, arrays and strings:\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Button from './Button.svelte';\\n let useTailwind = $state(false);\\n</script>\\n\\n<Button\\n onclick={() => useTailwind = true}\\n class={{ 'bg-blue-700 sm:w-1/2': useTailwind }}\\n>\\n Accept the inevitability of Tailwind\\n</Button>\\n```\\n\\nSince Svelte 5.19, Svelte also exposes the `ClassValue` type, which is the type of value that the `class` attribute on elements accept. This is useful if you want to use a type-safe class name in component props:\\n\\n```\\n<script lang=\\\"ts\\\">\\n import type { ClassValue } from 'svelte/elements';\\n\\n const props: { class: ClassValue } = $props();\\n</script>\\n\\n<div class={['original', props.class]}>...</div>\\n```\"}, \"The `class:` directive\": \"Prior to Svelte 5.16, the `class:` directive was the most convenient way to set classes on elements conditionally.\\n\\n```\\n<!-- These are equivalent -->\\n<div class={{ cool, lame: !cool }}>...</div>\\n<div class:cool={cool} class:lame={!cool}>...</div>\\n```\\n\\nAs with other directives, we can use a shorthand when the name of the class coincides with the value:\\n\\n```\\n<div class:cool class:lame={!cool}>...</div>\\n```\\n\\n[\\\"[!NOTE] Unless you're using an older version of Svelte, consider avoiding `class:`, since the attribute is more powerful and composable.\\\"]\"}, \"metadata\": {\"title\": \"class\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17]\"}, {\"title\": \"await\", \"description\": null, \"content\": {\"Boundaries\": \"Currently, you can only use `await` inside a [`<svelte:boundary>`](svelte-boundary) with a `pending` snippet:\\n\\n```\\n<svelte:boundary>\\n <MyApp />\\n\\n {#snippet pending()}\\n <p>loading...</p>\\n {/snippet}\\n</svelte:boundary>\\n```\\n\\nThis restriction will be lifted once Svelte supports asynchronous server-side rendering (see [caveats](#Caveats)).\\n\\n['[!NOTE] In the [playground](/playground), your app is rendered inside a boundary with an empty pending snippet, so that you can use `await` without having to create one.']\", \"Synchronized updates\": \"When an `await` expression depends on a particular piece of state, changes to that state will not be reflected in the UI until the asynchronous work has completed, so that the UI is not left in an inconsistent state. In other words, in an example like [this](/playground/untitled#H4sIAAAAAAAAE42QsWrDQBBEf2VZUkhYRE4gjSwJ0qVMkS6XYk9awcFpJe5Wdoy4fw-ycdykSPt2dpiZFYVGxgrf2PsJTlPwPWTcO-U-xwIH5zli9bminudNtwEsbl-v8_wYj-x1Y5Yi_8W7SZRFI1ZYxy64WVsjRj0rEDTwEJWUs6f8cKP2Tp8vVIxSPEsHwyKdukmA-j6jAmwO63Y1SidyCsIneA_T6CJn2ZBD00Jk_XAjT4tmQwEv-32eH6AsgYK6wXWOPPTs6Xy1CaxLECDYgb3kSUbq8p5aaifzorCt0RiUZbQcDIJ10ldH8gs3K6X2Xzqbro5zu1KCHaw2QQPrtclvwVSXc2sEC1T-Vqw0LJy-ClRy_uSkx2ogHzn9ADZ1CubKAQAA)...\\n\\n```\\n<script>\\n let a = $state(1);\\n let b = $state(2);\\n\\n async function add(a, b) {\\n await new Promise((f) => setTimeout(f, 500)); // artificial delay\\n return a + b;\\n }\\n</script>\\n\\n<input type=\\\"number\\\" bind:value={a}>\\n<input type=\\\"number\\\" bind:value={b}>\\n\\n<p>{a} + {b} = {await add(a, b)}</p>\\n```\\n\\n...if you increment `a`, the contents of the `<p>` will _not_ immediately update to read this \\u2014\\n\\n```\\n<p>2 + 2 = 3</p>\\n```\\n\\n\\u2014 instead, the text will update to `2 + 2 = 4` when `add(a, b)` resolves.\\n\\nUpdates can overlap \\u2014 a fast update will be reflected in the UI while an earlier slow update is still ongoing.\", \"Concurrency\": \"Svelte will do as much asynchronous work as it can in parallel. For example if you have two `await` expressions in your markup...\\n\\n```\\n<p>{await one()}</p>\\n<p>{await two()}</p>\\n```\\n\\n...both functions will run at the same time, as they are independent expressions, even though they are _visually_ sequential.\\n\\nThis does not apply to sequential `await` expressions inside your `<script>` or inside async functions \\u2014 these run like any other asynchronous JavaScript. An exception is that independent `$derived` expressions will update independently, even though they will run sequentially when they are first created:\\n\\n```\\nasync function one() { return 1; }\\nasync function two() { return 2; }\\n// ---cut---\\n// these will run sequentially the first time,\\n// but will update independently\\nlet a = $derived(await one());\\nlet b = $derived(await two());\\n```\\n\\n['[!NOTE] If you write code like this, expect Svelte to give you an [`await_waterfall`](runtime-warnings#Client-warnings-await_waterfall) warning']\", \"Indicating loading states\": \"In addition to the nearest boundary's [`pending`](svelte-boundary#Properties-pending) snippet, you can indicate that asynchronous work is ongoing with [`$effect.pending()`]($effect#$effect.pending).\\n\\nYou can also use [`settled()`](svelte#settled) to get a promise that resolves when the current update is complete:\\n\\n```\\nlet color = 'red';\\nlet answer = -1;\\nlet updating = false;\\n// ---cut---\\nimport { tick, settled } from 'svelte';\\n\\nasync function onclick() {\\n updating = true;\\n\\n // without this, the change to `updating` will be\\n // grouped with the other changes, meaning it\\n // won't be reflected in the UI\\n await tick();\\n\\n color = 'octarine';\\n answer = 42;\\n\\n await settled();\\n\\n // any updates affected by `color` or `answer`\\n // have now been applied\\n updating = false;\\n}\\n```\", \"Error handling\": \"Errors in `await` expressions will bubble to the nearest [error boundary](svelte-boundary).\", \"Caveats\": \"As an experimental feature, the details of how `await` is handled (and related APIs like `$effect.pending()`) are subject to breaking changes outside of a semver major release, though we intend to keep such changes to a bare minimum.\\n\\nCurrently, server-side rendering is synchronous. If a `<svelte:boundary>` with a `pending` snippet is encountered during SSR, only the `pending` snippet will be rendered.\", \"Breaking changes\": \"Effects run in a slightly different order when the `experimental.async` option is `true`. Specifically, _block_ effects like `{#if ...}` and `{#each ...}` now run before an `$effect.pre` or `beforeUpdate` in the same component, which means that in [very rare situations](/playground/untitled?#H4sIAAAAAAAAE22R3VLDIBCFX2WLvUhnTHsf0zre-Q7WmfwtFV2BgU1rJ5N3F0jaOuoVcPbw7VkYhK4_URTiGYkMnIyjDjLsFGO3EvdCKkIvipdB8NlGXxSCPt96snbtj0gctab2-J_eGs2oOWBE6VunLO_2es-EDKZ5x5ZhC0vPNWM2gHXGouNzAex6hHH1cPHil_Lsb95YT9VQX6KUAbS2DrNsBdsdDFHe8_XSYjH1SrhELTe3MLpsemajweiWVPuxHSbKNd-8eQTdE0EBf4OOaSg2hwNhhE_ABB_ulJzjj9FULvIcqgm5vnAqUB7wWFMfhuugQWkcAr8hVD-mq8D12kOep24J_IszToOXdveGDsuNnZwbJUNlXsKnhJdhUcTo42s41YpOSneikDV5HL8BktM6yRcCAAA=) it is possible to update a block that should no longer exist, but only if you update state inside an effect, [which you should avoid]($effect#When-not-to-use-$effect).\"}, \"metadata\": {\"title\": \"await\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 18]\"}, {\"title\": \"Template syntax\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Template syntax\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 19]\"}], \"path\": \"[\\\"subpages\\\", 3]\"}, {\"title\": \"04 Styling\", \"description\": \"Documentation section: 04-styling\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/04-styling\"}, \"subpages\": [{\"title\": \"Scoped styles\", \"description\": null, \"content\": {\"Specificity\": \"Each scoped selector receives a [specificity](https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity) increase of 0-1-0, as a result of the scoping class (e.g. `.svelte-123xyz`) being added to the selector. This means that (for example) a `p` selector defined in a component will take precedence over a `p` selector defined in a global stylesheet, even if the global stylesheet is loaded later.\\n\\nIn some cases, the scoping class must be added to a selector multiple times, but after the first occurrence it is added with `:where(.svelte-xyz123)` in order to not increase specificity further.\", \"Scoped keyframes\": \"If a component defines `@keyframes`, the name is scoped to the component using the same hashing approach. Any `animation` rules in the component will be similarly adjusted:\\n\\n```\\n<style>\\n .bouncy {\\n animation: bounce 10s;\\n }\\n\\n /* these keyframes are only accessible inside this component */\\n @keyframes bounce {\\n /* ... */\\n }\\n</style>\\n```\"}, \"metadata\": {\"title\": \"Scoped styles\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}, {\"title\": \"Global styles\", \"description\": null, \"content\": {\":global(...)\": \"To apply styles to a single selector globally, use the `:global(...)` modifier:\\n\\n```\\n<style>\\n :global(body) {\\n /* applies to <body> */\\n margin: 0;\\n }\\n\\n div :global(strong) {\\n /* applies to all <strong> elements, in any component,\\n that are inside <div> elements belonging\\n to this component */\\n color: goldenrod;\\n }\\n\\n p:global(.big.red) {\\n /* applies to all <p> elements belonging to this component\\n with `class=\\\"big red\\\"`, even if it is applied\\n programmatically (for example by a library) */\\n }\\n</style>\\n```\\n\\nIf you want to make @keyframes that are accessible globally, you need to prepend your keyframe names with `-global-`.\\n\\nThe `-global-` part will be removed when compiled, and the keyframe will then be referenced using just `my-animation-name` elsewhere in your code.\\n\\n```\\n<style>\\n @keyframes -global-my-animation-name {\\n /* code goes here */\\n }\\n</style>\\n```\", \":global\": \"To apply styles to a group of selectors globally, create a `:global {...}` block:\\n\\n```\\n<style>\\n :global {\\n /* applies to every <div> in your application */\\n div { ... }\\n\\n /* applies to every <p> in your application */\\n p { ... }\\n }\\n\\n .a :global {\\n /* applies to every `.b .c .d` element, in any component,\\n that is inside an `.a` element in this component */\\n .b .c .d {...}\\n }\\n</style>\\n```\\n\\n['[!NOTE] The second example above could also be written as an equivalent `.a :global .b .c .d` selector, where everything after the `:global` is unscoped, though the nested form is preferred.']\"}, \"metadata\": {\"title\": \"Global styles\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\"}, {\"title\": \"Custom properties\", \"description\": null, \"content\": {\"root\": [\"You can pass CSS custom properties \\u2014 both static and dynamic \\u2014 to components:\", \"```\\n<Slider\\n bind:value\\n min={0}\\n max={100}\\n --track-color=\\\"black\\\"\\n --thumb-color=\\\"rgb({r} {g} {b})\\\"\\n/>\\n```\", \"The above code essentially desugars to this:\", \"```\\n<svelte-css-wrapper style=\\\"display: contents; --track-color: black; --thumb-color: rgb({r} {g} {b})\\\">\\n <Slider\\n bind:value\\n min={0}\\n max={100}\\n />\\n</svelte-css-wrapper>\\n```\", \"For an SVG element, it would use `<g>` instead:\", \"```\\n<g style=\\\"--track-color: black; --thumb-color: rgb({r} {g} {b})\\\">\\n <Slider\\n bind:value\\n min={0}\\n max={100}\\n />\\n</g>\\n```\", \"Inside the component, we can read these custom properties (and provide fallback values) using [`var(...)`](https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties):\", \"```\\n<style>\\n .track {\\n background: var(--track-color, #aaa);\\n }\\n\\n .thumb {\\n background: var(--thumb-color, blue);\\n }\\n</style>\\n```\", \"You don't _have_ to specify the values directly on the component; as long as the custom properties are defined on a parent element, the component can use them. It's common to define custom properties on the `:root` element in a global stylesheet so that they apply to your entire application.\", [\"[!NOTE] While the extra element will not affect layout, it _will_ affect any CSS selectors that (for example) use the `>` combinator to target an element directly inside the component's container.\"]]}, \"metadata\": {\"title\": \"Custom properties\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\"}, {\"title\": \"Nested <style> elements\", \"description\": null, \"content\": {\"root\": [\"There can only be one top-level `<style>` tag per component.\", \"However, it is possible to have a `<style>` tag nested inside other elements or logic blocks.\", \"In that case, the `<style>` tag will be inserted as-is into the DOM; no scoping or processing will be done on the `<style>` tag.\", \"```\\n<div>\\n <style>\\n /* this style tag will be inserted as-is */\\n div {\\n /* this will apply to all `<div>` elements in the DOM */\\n color: red;\\n }\\n </style>\\n</div>\\n```\"]}, \"metadata\": {\"title\": \"Nested <style> elements\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 3]\"}, {\"title\": \"Styling\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Styling\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 4]\"}, {\"title\": \"05 Special Elements\", \"description\": \"Documentation section: 05-special-elements\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/05-special-elements\"}, \"subpages\": [{\"title\": \"<svelte:boundary>\", \"description\": null, \"content\": {\"Properties\": {\"`pending`\": \"As of Svelte 5.36, boundaries with a `pending` snippet can contain [`await`](await-expressions) expressions. This snippet will be shown when the boundary is first created, and will remain visible until all the `await` expressions inside the boundary have resolved ([demo](/playground/untitled#H4sIAAAAAAAAE21QQW6DQAz8ytY9BKQVpFdKkPqDHnorPWzAaSwt3tWugUaIv1eE0KpKD5as8YxnNBOw6RAKKOOAVrA4up5bEy6VGknOyiO3xJ8qMnmPAhpOZDFC8T6BXPyiXADQ258X77P1FWg4moj_4Y1jQZZ49W0CealqruXUcyPkWLVozQXbZDC2R606spYiNo7bqA7qab_fp2paFLUElD6wYhzVa3AdRUySgNHZAVN1qDZaLRHljTp0vSTJ9XJjrSbpX5f0eZXN6zLXXOa_QfmurIVU-moyoyH5ib87o7XuYZfOZe6vnGWmx1uZW7lJOq9upa-sMwuUZdkmmfIbfQ1xZwwaBL8ECgk9zh8axJAdiVsoTsZGnL8Bg4tX_OMBAAA=)):\\n\\n```\\n<svelte:boundary>\\n <p>{await delayed('hello!')}</p>\\n\\n {#snippet pending()}\\n <p>loading...</p>\\n {/snippet}\\n</svelte:boundary>\\n```\\n\\nThe `pending` snippet will _not_ be shown for subsequent async updates \\u2014 for these, you can use [`$effect.pending()`]($effect#$effect.pending).\\n\\n['[!NOTE] In the [playground](/playground), your app is rendered inside a boundary with an empty pending snippet, so that you can use `await` without having to create one.']\", \"`failed`\": \"If a `failed` snippet is provided, it will be rendered when an error is thrown inside the boundary, with the `error` and a `reset` function that recreates the contents ([demo](/playground/hello-world#H4sIAAAAAAAAE3VRy26DMBD8lS2tFCIh6JkAUlWp39Cq9EBg06CAbdlLArL87zWGKk8ORnhmd3ZnrD1WtOjFXqKO2BDGW96xqpBD5gXerm5QefG39mgQY9EIWHxueRMinLosti0UPsJLzggZKTeilLWgLGc51a3gkuCjKQ7DO7cXZotgJ3kLqzC6hmex1SZnSXTWYHcrj8LJjWTk0PHoZ8VqIdCOKayPykcpuQxAokJaG1dGybYj4gw4K5u6PKTasSbjXKgnIDlA8VvUdo-pzonraBY2bsH7HAl78mKSHZpgIcuHjq9jXSpZSLixRlveKYQUXhQVhL6GPobXAAb7BbNeyvNUs4qfRg3OnELLj5hqH9eQZqCnoBwR9lYcQxuVXeBzc8kMF8yXY4yNJ5oGiUzP_aaf_waTRGJib5_Ad3P_vbCuaYxzeNpbU0eUMPAOKh7Yw1YErgtoXyuYlPLzc10_xo_5A91zkQL_AgAA)):\\n\\n```\\n<svelte:boundary>\\n <FlakyComponent />\\n\\n {#snippet failed(error, reset)}\\n <button onclick={reset}>oops! try again</button>\\n {/snippet}\\n</svelte:boundary>\\n```\\n\\n['[!NOTE]\\\\nAs with [snippets passed to components](snippet#Passing-snippets-to-components), the `failed` snippet can be passed explicitly as a property...', '```\\\\n<svelte:boundary {failed}>...</svelte:boundary>\\\\n```', '...or implicitly by declaring it directly inside the boundary, as in the example above.']\", \"`onerror`\": \"If an `onerror` function is provided, it will be called with the same two `error` and `reset` arguments. This is useful for tracking the error with an error reporting service...\\n\\n```\\n<svelte:boundary onerror={(e) => report(e)}>\\n ...\\n</svelte:boundary>\\n```\\n\\n...or using `error` and `reset` outside the boundary itself:\\n\\n```\\n<script>\\n let error = $state(null);\\n let reset = $state(() => {});\\n\\n function onerror(e, r) {\\n error = e;\\n reset = r;\\n }\\n</script>\\n\\n<svelte:boundary {onerror}>\\n <FlakyComponent />\\n</svelte:boundary>\\n\\n{#if error}\\n <button onclick={() => {\\n error = null;\\n reset();\\n }}>\\n oops! try again\\n </button>\\n{/if}\\n```\\n\\nIf an error occurs inside the `onerror` function (or if you rethrow the error), it will be handled by a parent boundary if such exists.\"}}, \"metadata\": {\"title\": \"<svelte:boundary>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"<svelte:window>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:window onevent={handler} />\\n```\", \"```\\n<svelte:window bind:prop={value} />\\n```\", \"The `<svelte:window>` element allows you to add event listeners to the `window` object without worrying about removing them when the component is destroyed, or checking for the existence of `window` when server-side rendering.\", \"This element may only appear at the top level of your component \\u2014 it cannot be inside a block or element.\", \"```\\n<script>\\n function handleKeydown(event) {\\n alert(`pressed the ${event.key} key`);\\n }\\n</script>\\n\\n<svelte:window onkeydown={handleKeydown} />\\n```\", \"You can also bind to the following properties:\", [\"`innerWidth`\", \"`innerHeight`\", \"`outerWidth`\", \"`outerHeight`\", \"`scrollX`\", \"`scrollY`\", \"`online` \\u2014 an alias for `window.navigator.onLine`\", \"`devicePixelRatio`\"], \"All except `scrollX` and `scrollY` are readonly.\", \"```\\n<svelte:window bind:scrollY={y} />\\n```\", [\"[!NOTE] Note that the page will not be scrolled to the initial value to avoid accessibility issues. Only subsequent changes to the bound variable of `scrollX` and `scrollY` will cause scrolling. If you have a legitimate reason to scroll when the component is rendered, call `scrollTo()` in an `$effect`.\"]]}, \"metadata\": {\"title\": \"<svelte:window>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"<svelte:document>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:document onevent={handler} />\\n```\", \"```\\n<svelte:document bind:prop={value} />\\n```\", \"Similarly to `<svelte:window>`, this element allows you to add listeners to events on `document`, such as `visibilitychange`, which don't fire on `window`. It also lets you use [actions](use) on `document`.\", \"As with `<svelte:window>`, this element may only appear the top level of your component and must never be inside a block or element.\", \"```\\n<svelte:document onvisibilitychange={handleVisibilityChange} use:someAction />\\n```\", \"You can also bind to the following properties:\", [\"`activeElement`\", \"`fullscreenElement`\", \"`pointerLockElement`\", \"`visibilityState`\"], \"All are readonly.\"]}, \"metadata\": {\"title\": \"<svelte:document>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}, {\"title\": \"<svelte:body>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:body onevent={handler} />\\n```\", \"Similarly to `<svelte:window>`, this element allows you to add listeners to events on `document.body`, such as `mouseenter` and `mouseleave`, which don't fire on `window`. It also lets you use [actions](use) on the `<body>` element.\", \"As with `<svelte:window>` and `<svelte:document>`, this element may only appear at the top level of your component and must never be inside a block or element.\", \"```\\n<svelte:body onmouseenter={handleMouseenter} onmouseleave={handleMouseleave} use:someAction />\\n```\"]}, \"metadata\": {\"title\": \"<svelte:body>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 3]\"}, {\"title\": \"<svelte:head>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:head>...</svelte:head>\\n```\", \"This element makes it possible to insert elements into `document.head`. During server-side rendering, `head` content is exposed separately to the main `body` content.\", \"As with `<svelte:window>`, `<svelte:document>` and `<svelte:body>`, this element may only appear at the top level of your component and must never be inside a block or element.\", \"```\\n<svelte:head>\\n <title>Hello world!</title>\\n <meta name=\\\"description\\\" content=\\\"This is where the description goes for SEO\\\" />\\n</svelte:head>\\n```\"]}, \"metadata\": {\"title\": \"<svelte:head>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 4]\"}, {\"title\": \"<svelte:element>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:element this={expression} />\\n```\", \"The `<svelte:element>` element lets you render an element that is unknown at author time, for example because it comes from a CMS. Any properties and event listeners present will be applied to the element.\", \"The only supported binding is `bind:this`, since Svelte's built-in bindings do not work with generic elements.\", \"If `this` has a nullish value, the element and its children will not be rendered.\", \"If `this` is the name of a [void element](https://developer.mozilla.org/en-US/docs/Glossary/Void_element) (e.g., `br`) and `<svelte:element>` has child elements, a runtime error will be thrown in development mode:\", \"```\\n<script>\\n let tag = $state('hr');\\n</script>\\n\\n<svelte:element this={tag}>\\n This text cannot appear inside an hr element\\n</svelte:element>\\n```\", \"Svelte tries its best to infer the correct namespace from the element's surroundings, but it's not always possible. You can make it explicit with an `xmlns` attribute:\", \"```\\n<svelte:element this={tag} xmlns=\\\"http://www.w3.org/2000/svg\\\" />\\n```\", \"`this` needs to be a valid DOM element tag, things like `#text` or `svelte:head` will not work.\"]}, \"metadata\": {\"title\": \"<svelte:element>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 5]\"}, {\"title\": \"<svelte:options>\", \"description\": null, \"content\": {\"root\": [\"```\\n<svelte:options option={value} />\\n```\", \"The `<svelte:options>` element provides a place to specify per-component compiler options, which are detailed in the [compiler section](svelte-compiler#compile). The possible options are:\", [\"`runes={true}` \\u2014 forces a component into _runes mode_ (see the [Legacy APIs](legacy-overview) section)\", \"`runes={false}` \\u2014 forces a component into _legacy mode_\", \"`namespace=\\\"...\\\"` \\u2014 the namespace where this component will be used, can be \\\"html\\\" (the default), \\\"svg\\\" or \\\"mathml\\\"\", \"`customElement={...}` \\u2014 the [options](custom-elements#Component-options) to use when compiling this component as a custom element. If a string is passed, it is used as the `tag` option\", \"`css=\\\"injected\\\"` \\u2014 the component will inject its styles inline: During server-side rendering, it's injected as a `<style>` tag in the `head`, during client side rendering, it's loaded via JavaScript\"], [\"[!LEGACY] Deprecated options\\nSvelte 4 also included the following options. They are deprecated in Svelte 5 and non-functional in runes mode.\", [\"`immutable={true}` \\u2014 you never use mutable data, so the compiler can do simple referential equality checks to determine if values have changed\", \"`immutable={false}` \\u2014 the default. Svelte will be more conservative about whether or not mutable objects have changed\", \"`accessors={true}` \\u2014 adds getters and setters for the component's props\", \"`accessors={false}` \\u2014 the default\"]], \"```\\n<svelte:options customElement=\\\"my-custom-element\\\" />\\n```\"]}, \"metadata\": {\"title\": \"<svelte:options>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 6]\"}, {\"title\": \"Special elements\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Special elements\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 7]\"}], \"path\": \"[\\\"subpages\\\", 5]\"}, {\"title\": \"06 Runtime\", \"description\": \"Documentation section: 06-runtime\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/06-runtime\"}, \"subpages\": [{\"title\": \"Stores\", \"description\": null, \"content\": {\"When to use stores\": \"Prior to Svelte 5, stores were the go-to solution for creating cross-component reactive states or extracting logic. With runes, these use cases have greatly diminished.\\n\\n[\\\"when extracting logic, it's better to take advantage of runes' universal reactivity: You can use runes outside the top level of components and even place them into JavaScript or TypeScript files (using a `.svelte.js` or `.svelte.ts` file ending)\\\", 'when creating shared state, you can create a `$state` object containing the values you need and then manipulate said state']\\n\\n```\\n/// file: state.svelte.js\\nexport const userState = $state({\\n name: 'name',\\n /* ... */\\n});\\n```\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import { userState } from './state.svelte.js';\\n</script>\\n\\n<p>User name: {userState.name}</p>\\n<button onclick={() => {\\n userState.name = 'new name';\\n}}>\\n change name\\n</button>\\n```\\n\\nStores are still a good solution when you have complex asynchronous data streams or it's important to have more manual control over updating values or listening to changes. If you're familiar with RxJs and want to reuse that knowledge, the `$` also comes in handy for you.\", \"svelte/store\": {\"`writable`\": \"Function that creates a store which has values that can be set from 'outside' components. It gets created as an object with additional `set` and `update` methods.\\n\\n`set` is a method that takes one argument which is the value to be set. The store value gets set to the value of the argument if the store value is not already equal to it.\\n\\n`update` is a method that takes one argument which is a callback. The callback takes the existing store value as its argument and returns the new value to be set to the store.\\n\\n```\\n/// file: store.js\\nimport { writable } from 'svelte/store';\\n\\nconst count = writable(0);\\n\\ncount.subscribe((value) => {\\n console.log(value);\\n}); // logs '0'\\n\\ncount.set(1); // logs '1'\\n\\ncount.update((n) => n + 1); // logs '2'\\n```\\n\\nIf a function is passed as the second argument, it will be called when the number of subscribers goes from zero to one (but not from one to two, etc). That function will be passed a `set` function which changes the value of the store, and an `update` function which works like the `update` method on the store, taking a callback to calculate the store's new value from its old value. It must return a `stop` function that is called when the subscriber count goes from one to zero.\\n\\n```\\n/// file: store.js\\nimport { writable } from 'svelte/store';\\n\\nconst count = writable(0, () => {\\n console.log('got a subscriber');\\n return () => console.log('no more subscribers');\\n});\\n\\ncount.set(1); // does nothing\\n\\nconst unsubscribe = count.subscribe((value) => {\\n console.log(value);\\n}); // logs 'got a subscriber', then '1'\\n\\nunsubscribe(); // logs 'no more subscribers'\\n```\\n\\nNote that the value of a `writable` is lost when it is destroyed, for example when the page is refreshed. However, you can write your own logic to sync the value to for example the `localStorage`.\", \"`readable`\": \"Creates a store whose value cannot be set from 'outside', the first argument is the store's initial value, and the second argument to `readable` is the same as the second argument to `writable`.\\n\\n```\\nimport { readable } from 'svelte/store';\\n\\nconst time = readable(new Date(), (set) => {\\n set(new Date());\\n\\n const interval = setInterval(() => {\\n set(new Date());\\n }, 1000);\\n\\n return () => clearInterval(interval);\\n});\\n\\nconst ticktock = readable('tick', (set, update) => {\\n const interval = setInterval(() => {\\n update((sound) => (sound === 'tick' ? 'tock' : 'tick'));\\n }, 1000);\\n\\n return () => clearInterval(interval);\\n});\\n```\", \"`derived`\": \"Derives a store from one or more other stores. The callback runs initially when the first subscriber subscribes and then whenever the store dependencies change.\\n\\nIn the simplest version, `derived` takes a single store, and the callback returns a derived value.\\n\\n```\\n// @filename: ambient.d.ts\\nimport { type Writable } from 'svelte/store';\\n\\ndeclare global {\\n const a: Writable<number>;\\n}\\n\\nexport {};\\n\\n// @filename: index.ts\\n// ---cut---\\nimport { derived } from 'svelte/store';\\n\\nconst doubled = derived(a, ($a) => $a * 2);\\n```\\n\\nThe callback can set a value asynchronously by accepting a second argument, `set`, and an optional third argument, `update`, calling either or both of them when appropriate.\\n\\nIn this case, you can also pass a third argument to `derived` \\u2014 the initial value of the derived store before `set` or `update` is first called. If no initial value is specified, the store's initial value will be `undefined`.\\n\\n```\\n// @filename: ambient.d.ts\\nimport { type Writable } from 'svelte/store';\\n\\ndeclare global {\\n const a: Writable<number>;\\n}\\n\\nexport {};\\n\\n// @filename: index.ts\\n// @errors: 18046 2769 7006\\n// ---cut---\\nimport { derived } from 'svelte/store';\\n\\nconst delayed = derived(\\n a,\\n ($a, set) => {\\n setTimeout(() => set($a), 1000);\\n },\\n 2000\\n);\\n\\nconst delayedIncrement = derived(a, ($a, set, update) => {\\n set($a);\\n setTimeout(() => update((x) => x + 1), 1000);\\n // every time $a produces a value, this produces two\\n // values, $a immediately and then $a + 1 a second later\\n});\\n```\\n\\nIf you return a function from the callback, it will be called when a) the callback runs again, or b) the last subscriber unsubscribes.\\n\\n```\\n// @filename: ambient.d.ts\\nimport { type Writable } from 'svelte/store';\\n\\ndeclare global {\\n const frequency: Writable<number>;\\n}\\n\\nexport {};\\n\\n// @filename: index.ts\\n// ---cut---\\nimport { derived } from 'svelte/store';\\n\\nconst tick = derived(\\n frequency,\\n ($frequency, set) => {\\n const interval = setInterval(() => {\\n set(Date.now());\\n }, 1000 / $frequency);\\n\\n return () => {\\n clearInterval(interval);\\n };\\n },\\n 2000\\n);\\n```\\n\\nIn both cases, an array of arguments can be passed as the first argument instead of a single store.\\n\\n```\\n// @filename: ambient.d.ts\\nimport { type Writable } from 'svelte/store';\\n\\ndeclare global {\\n const a: Writable<number>;\\n const b: Writable<number>;\\n}\\n\\nexport {};\\n\\n// @filename: index.ts\\n\\n// ---cut---\\nimport { derived } from 'svelte/store';\\n\\nconst summed = derived([a, b], ([$a, $b]) => $a + $b);\\n\\nconst delayed = derived([a, b], ([$a, $b], set) => {\\n setTimeout(() => set($a + $b), 1000);\\n});\\n```\", \"`readonly`\": \"This simple helper function makes a store readonly. You can still subscribe to the changes from the original one using this new readable store.\\n\\n```\\nimport { readonly, writable } from 'svelte/store';\\n\\nconst writableStore = writable(1);\\nconst readableStore = readonly(writableStore);\\n\\nreadableStore.subscribe(console.log);\\n\\nwritableStore.set(2); // console: 2\\n// @errors: 2339\\nreadableStore.set(2); // ERROR\\n```\", \"`get`\": \"Generally, you should read the value of a store by subscribing to it and using the value as it changes over time. Occasionally, you may need to retrieve the value of a store to which you're not subscribed. `get` allows you to do so.\\n\\n[\\\"[!NOTE] This works by creating a subscription, reading the value, then unsubscribing. It's therefore not recommended in hot code paths.\\\"]\\n\\n```\\n// @filename: ambient.d.ts\\nimport { type Writable } from 'svelte/store';\\n\\ndeclare global {\\n const store: Writable<string>;\\n}\\n\\nexport {};\\n\\n// @filename: index.ts\\n// ---cut---\\nimport { get } from 'svelte/store';\\n\\nconst value = get(store);\\n```\"}, \"Store contract\": \"```\\n// @noErrors\\nstore = { subscribe: (subscription: (value: any) => void) => (() => void), set?: (value: any) => void }\\n```\\n\\nYou can create your own stores without relying on [`svelte/store`](../svelte-store), by implementing the _store contract_:\\n\\n[\\\"A store must contain a `.subscribe` method, which must accept as its argument a subscription function. This subscription function must be immediately and synchronously called with the store's current value upon calling `.subscribe`. All of a store's active subscription functions must later be synchronously called whenever the store's value changes.\\\", 'The `.subscribe` method must return an unsubscribe function. Calling an unsubscribe function must stop its subscription, and its corresponding subscription function must not be called again by the store.', \\\"A store may _optionally_ contain a `.set` method, which must accept as its argument a new value for the store, and which synchronously calls all of the store's active subscription functions. Such a store is called a _writable store_.\\\"]\\n\\nFor interoperability with RxJS Observables, the `.subscribe` method is also allowed to return an object with an `.unsubscribe` method, rather than return the unsubscription function directly. Note however that unless `.subscribe` synchronously calls the subscription (which is not required by the Observable spec), Svelte will see the value of the store as `undefined` until it does.\"}, \"metadata\": {\"title\": \"Stores\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\"}, {\"title\": \"Context\", \"description\": null, \"content\": {\"Using context with state\": \"You can store reactive state in context ([demo](/playground/untitled#H4sIAAAAAAAAE41R0W6DMAz8FSuaBNUQdK8MkKZ-wh7HHihzu6hgosRMm1D-fUpSVNq12x4iEvvOx_kmQU2PIhfP3DCCJGgHYvxkkYid7NCI_GUS_KUcxhVEMjOelErNB3bsatvG4LW6n0ZsRC4K02qpuKqpZtmrQTNMYJA3QRAs7PTQQxS40eMCt3mX3duxnWb-lS5h7nTI0A4jMWoo4c44P_Hku-zrOazdy64chWo-ScfRkRgl8wgHKrLTH1OxHZkHgoHaTraHcopXUFYzPPVfuC_hwQaD1GrskdiNCdQwJljJqlvXfyqVsA5CGg0uRUQifHw56xFtciO75QrP07vo_JXf_tf8yK2ezDKY_ZWt_1y2qqYzv7bI1IW1V_sN19m-07wCAAA=))...\\n\\n```\\n<script>\\n import { setContext } from 'svelte';\\n import Child from './Child.svelte';\\n\\n let counter = $state({\\n count: 0\\n });\\n\\n setContext('counter', counter);\\n</script>\\n\\n<button onclick={() => counter.count += 1}>\\n increment\\n</button>\\n\\n<Child />\\n<Child />\\n<Child />\\n```\\n\\n...though note that if you _reassign_ `counter` instead of updating it, you will 'break the link' \\u2014 in other words instead of this...\\n\\n```\\n<button onclick={() => counter = { count: 0 }}>\\n reset\\n</button>\\n```\\n\\n...you must do this:\\n\\n```\\n<button onclick={() => +++counter.count = 0+++}>\\n reset\\n</button>\\n```\\n\\nSvelte will warn you if you get it wrong.\", \"Type-safe context\": \"A useful pattern is to wrap the calls to `setContext` and `getContext` inside helper functions that let you preserve type safety:\\n\\n```\\n/// file: context.js\\n// @filename: ambient.d.ts\\ninterface User {}\\n\\n// @filename: index.js\\n// ---cut---\\nimport { getContext, setContext } from 'svelte';\\n\\nconst key = {};\\n\\n/** @param {User} user */\\nexport function setUserContext(user) {\\n setContext(key, user);\\n}\\n\\nexport function getUserContext() {\\n return /** @type {User} */ (getContext(key));\\n}\\n```\", \"Replacing global state\": \"When you have state shared by many different components, you might be tempted to put it in its own module and just import it wherever it's needed:\\n\\n```\\n/// file: state.svelte.js\\nexport const myGlobalState = $state({\\n user: {\\n // ...\\n }\\n // ...\\n});\\n```\\n\\nIn many cases this is perfectly fine, but there is a risk: if you mutate the state during server-side rendering (which is discouraged, but entirely possible!)...\\n\\n```\\n<!--- file: App.svelte ---->\\n<script>\\n import { myGlobalState } from './state.svelte.js';\\n\\n let { data } = $props();\\n\\n if (data.user) {\\n myGlobalState.user = data.user;\\n }\\n</script>\\n```\\n\\n...then the data may be accessible by the _next_ user. Context solves this problem because it is not shared between requests.\"}, \"metadata\": {\"title\": \"Context\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\"}, {\"title\": \"Lifecycle hooks\", \"description\": null, \"content\": {\"`onMount`\": \"The `onMount` function schedules a callback to run as soon as the component has been mounted to the DOM. It must be called during the component's initialisation (but doesn't need to live _inside_ the component; it can be called from an external module).\\n\\n`onMount` does not run inside a component that is rendered on the server.\\n\\n```\\n<script>\\n import { onMount } from 'svelte';\\n\\n onMount(() => {\\n console.log('the component has mounted');\\n });\\n</script>\\n```\\n\\nIf a function is returned from `onMount`, it will be called when the component is unmounted.\\n\\n```\\n<script>\\n import { onMount } from 'svelte';\\n\\n onMount(() => {\\n const interval = setInterval(() => {\\n console.log('beep');\\n }, 1000);\\n\\n return () => clearInterval(interval);\\n });\\n</script>\\n```\\n\\n['[!NOTE] This behaviour will only work when the function passed to `onMount` is _synchronous_. `async` functions always return a `Promise`.']\", \"`onDestroy`\": \"Schedules a callback to run immediately before the component is unmounted.\\n\\nOut of `onMount`, `beforeUpdate`, `afterUpdate` and `onDestroy`, this is the only one that runs inside a server-side component.\\n\\n```\\n<script>\\n import { onDestroy } from 'svelte';\\n\\n onDestroy(() => {\\n console.log('the component is being destroyed');\\n });\\n</script>\\n```\", \"`tick`\": \"While there's no \\\"after update\\\" hook, you can use `tick` to ensure that the UI is updated before continuing. `tick` returns a promise that resolves once any pending state changes have been applied, or in the next microtask if there are none.\\n\\n```\\n<script>\\n import { tick } from 'svelte';\\n\\n $effect.pre(() => {\\n console.log('the component is about to update');\\n tick().then(() => {\\n console.log('the component just updated');\\n });\\n });\\n</script>\\n```\", \"Deprecated: `beforeUpdate` / `afterUpdate`\": {\"Chat window example\": \"To implement a chat window that autoscrolls to the bottom when new messages appear (but only if you were _already_ scrolled to the bottom), we need to measure the DOM before we update it.\\n\\nIn Svelte 4, we do this with `beforeUpdate`, but this is a flawed approach \\u2014 it fires before _every_ update, whether it's relevant or not. In the example below, we need to introduce checks like `updatingMessages` to make sure we don't mess with the scroll position when someone toggles dark mode.\\n\\nWith runes, we can use `$effect.pre`, which behaves the same as `$effect` but runs before the DOM is updated. As long as we explicitly reference `messages` inside the effect body, it will run whenever `messages` changes, but _not_ when `theme` changes.\\n\\n`beforeUpdate`, and its equally troublesome counterpart `afterUpdate`, are therefore deprecated in Svelte 5.\\n\\n['[Before](/playground/untitled#H4sIAAAAAAAAE31WXa_bNgz9K6yL1QmWOLlrC-w6H8MeBgwY9tY9NfdBtmlbiywZkpyPBfnvo2zLcZK28AWuRPGI5OGhkEuQc4EmiL9eAskqDOLg97oOZoE9125jDigs0t6oRqfOsjap5rXd7uTO8qpW2sIFEsyVxn_qjFmcAcstar-xPN3DFXKtKgi768IVgQku0ELj3Lgs_kZjWIEGNpAzYXDlHWyJFZI1zJjeh4O5uvl_DY8oUkVeVoFuJKYls-_CGYS25Aboj0EtWNqel0wWoBoLTGZgmdgDS9zW4Uz4NsrswPHoyutN4xInkylstnBxdmIhh8m7xzqmoNE2Wq46n1RJQzEbq4g-JQSl7e-HDx-GdaTy3KD9E3lRWvj5Zu9QX1QN20dj7zyHz8s-1S6lW7Cpz3RnXTcm04hIlfdFuO8p2mQ5-3a06cqjrn559bF_2NHOnRZ5I1PLlXQNyQT-hedMHeUEDyjtdMxsa4n2eIbNhlTwhyRthaOKOmYtniwF6pwt0wXa6MBEg0OibZec27gz_dk3UrZ6hB2LLYoiv521Yd8Gt-foTrfhiCDP0lC9VUUhcDLU49Xe_9943cNvEArHfAjxeBTovvXiNpFynfEDpIIZs9kFbg52QbeNHWZzebz32s7xHco3nJAJl1nshmhz8dYOQJDyZetnbb2gTWe-vEeWlrfpZMavr56ldb29eNt6UXvgwgFbp_WC0tl2RK25rGk6lYz3nUI2lzvBXGHhPZPGWmKUXFNBKqdaW259wl_aHbiqoVIZdpE60Nax6IOujT0LbFFxIVTCxCRR2XloUcYNvSbnGHKBp763jHoj59xiZWJI0Wm0P_m3MSS985xkasn-cFq20xTDy3J5KFcjgUTD69BHdcHIjz431z28IqlxGcPSfdFnrGDZn6gD6lyo45zyHAD-btczf-98nhQxHEvKfeUtOVkSejD3q-9X7JbzjGtsdUxlKdFU8qGsT78uaw848syWMXz85Waq2Gnem4mAn3prweq4q6Y3JEpnqMmnPoFRgmd3ySW0LLRqSKlwYHriCvJvUs2yjMaaoA-XzTXLeGMe45zmhv_XAno3Mj0xF7USuqNvnE9H343QHlq-eAgxpbTPNR9yzUkgLjwSR0NK4wKoxy-jDg-9vy8sUSToakzW-9fX13Em9Q8T6Z26uZhBN36XUYo5q7ggLXBZoub2Ofv7g6GCZfTxe034NCjiudXj7Omla0eTfo7QBPOcYxbE7qG-vl3_B1G-_i_JCAAA)', '[After](/playground/untitled#H4sIAAAAAAAAE31WXa-jNhD9K7PsdknUQJLurtRLPqo-VKrU1327uQ8GBnBjbGSb5KZR_nvHgMlXtyIS9njO-MyZGZRzUHCBJkhez4FkNQZJ8HvTBLPAnhq3MQcUFmlvVKszZ1mbTPPGbndyZ3ndKG3hDJZne7hAoVUNYY8JV-RBPgIt2AprhA18MpZZnIQ50_twuvLHNRrDSjRXj9fwiCJTBLIKdCsxq5j9EM4gtBU3QD8GjWBZd14xWYJqLTCZg2ViDyx1W4cz4dv0hsiB49FRHkyfsCgws3GjcTKZwmYLZ2feWc9o1W8zJQ2Fb62i5JUQRNRHgs-fx3WsisKg_RN5WVn4-WrvUd9VA9tH4-AcwbfFQIpkLWByvWzqSe2sk3kyjUlOec_XPU-3TRaz_75tuvKoi19e3OvipSpamVmupJM2F_gXnnJ1lBM8oLQjHceys8R7PMFms4HwD2lRhzeEe-EsvluSrHe2TJdo4wMTLY48XKwPzm0KGm2r5ajFtRYU4TWOY7-ddWHfxhDP0QkQhnf5PWRnVVkKnIx8fZsOb5dR16nwG4TCCRdCMphWQ7z1_DoOcp3zA2SCGbPZBa5jd0G_TRxmc36Me-mG6A7l60XIlMs8ce2-OXtrDyBItdz6qVjPadObzx-RZdV1nJjx64tXad1sz962njceOHfAzmk9JzrbXqg1lw3NkZL7vgE257t-uMDcO6attSSokpmgFqVMO2U93e_dDlzOUKsc-3t6zNZp6K9cG3sS2KGSUqiUiUmq8tNYoJwbmvpTAoXA96GyjCojI26xNglk6DpwOPm7NdRYp4ia0JL94bTqRiGB5WJxqFY37RGPoz3c6i4jP3rcUA7wmhqNywQW7om_YQ2L4UQdUBdCHSPiOQJ8bFcxHzeK0jKBY0XcV95SkCWlD9t-9eOM3TLKucauiyktJdpaPqT19ddF4wFHntsqgS-_XE01e48GMwnw02AtWZP02QyGVOkcNfk072CU4PkduZSWpVYt9SkcmJ64hPwHpWF5ziVls3wIFmmW89Y83vMeGf5PBxjcyPSkXNy10J18t3x6-a6CDtBq6SGklNKeazFyLahB3PVIGo2UbhOgGi9vKjzW_j6xVFFD17difXx5ebll0vwvkcGpn4sZ9MN3vqFYsJoL6gUuK9TcPrO_PxgzWMRfflSEr2NHPJf6lj1957rRpH8CNMG84JgHidUtXt4u_wK21LXERAgAAA==)']\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<script>\\n import { ---beforeUpdate, afterUpdate,--- tick } from 'svelte';\\n\\n---let updatingMessages = false;---\\nlet theme = +++$state('dark')+++;\\nlet messages = +++$state([])+++;\\n\\nlet viewport;\\n\\n---beforeUpdate(() => {---\\n+++$effect.pre(() => {+++\\n ---if (!updatingMessages) return;---\\n +++messages;+++\\n const autoscroll = viewport && viewport.offsetHeight + viewport.scrollTop > viewport.scrollHeight - 50;\\n\\n if (autoscroll) {\\n tick().then(() => {\\n viewport.scrollTo(0, viewport.scrollHeight);\\n });\\n }\\n\\n ---updatingMessages = false;---\\n});\\n\\nfunction handleKeydown(event) {\\n if (event.key === 'Enter') {\\n const text = event.target.value;\\n if (!text) return;\\n\\n ---updatingMessages = true;---\\n messages = [...messages, text];\\n event.target.value = '';\\n }\\n}\\n\\nfunction toggle() {\\n theme = theme === 'dark' ? 'light' : 'dark';\\n}\\n\\n</script>\\n\\n<div class:dark={theme === 'dark'}>\\n <div bind:this={viewport}>\\n {#each messages as message}\\n <p>{message}</p>\\n {/each}\\n </div>\\n\\n<input +++onkeydown+++={handleKeydown} />\\n\\n<button +++onclick+++={toggle}> Toggle dark mode </button>\\n\\n</div>\\n```\"}}, \"metadata\": {\"title\": \"Lifecycle hooks\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\"}, {\"title\": \"Imperative component API\", \"description\": null, \"content\": {\"`mount`\": \"Instantiates a component and mounts it to the given target:\\n\\n```\\n// @errors: 2322\\nimport { mount } from 'svelte';\\nimport App from './App.svelte';\\n\\nconst app = mount(App, {\\n target: document.querySelector('#app'),\\n props: { some: 'property' }\\n});\\n```\\n\\nYou can mount multiple components per page, and you can also mount from within your application, for example when creating a tooltip component and attaching it to the hovered element.\\n\\nNote that unlike calling `new App(...)` in Svelte 4, things like effects (including `onMount` callbacks, and action functions) will not run during `mount`. If you need to force pending effects to run (in the context of a test, for example) you can do so with `flushSync()`.\", \"`unmount`\": \"Unmounts a component that was previously created with [`mount`](#mount) or [`hydrate`](#hydrate).\\n\\nIf `options.outro` is `true`, [transitions](transition) will play before the component is removed from the DOM:\\n\\n```\\nimport { mount, unmount } from 'svelte';\\nimport App from './App.svelte';\\n\\nconst app = mount(App, { target: document.body });\\n\\n// later\\nunmount(app, { outro: true });\\n```\\n\\nReturns a `Promise` that resolves after transitions have completed if `options.outro` is true, or immediately otherwise.\", \"`render`\": \"Only available on the server and when compiling with the `server` option. Takes a component and returns an object with `body` and `head` properties on it, which you can use to populate the HTML when server-rendering your app:\\n\\n```\\n// @errors: 2724 2305 2307\\nimport { render } from 'svelte/server';\\nimport App from './App.svelte';\\n\\nconst result = render(App, {\\n props: { some: 'property' }\\n});\\nresult.body; // HTML for somewhere in this <body> tag\\nresult.head; // HTML for somewhere in this <head> tag\\n```\", \"`hydrate`\": \"Like `mount`, but will reuse up any HTML rendered by Svelte's SSR output (from the [`render`](#render) function) inside the target and make it interactive:\\n\\n```\\n// @errors: 2322\\nimport { hydrate } from 'svelte';\\nimport App from './App.svelte';\\n\\nconst app = hydrate(App, {\\n target: document.querySelector('#app'),\\n props: { some: 'property' }\\n});\\n```\\n\\nAs with `mount`, effects will not run during `hydrate` \\u2014 use `flushSync()` immediately afterwards if you need them to.\"}, \"metadata\": {\"title\": \"Imperative component API\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\"}, {\"title\": \"Runtime\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Runtime\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 6]\"}, {\"title\": \"07 Misc\", \"description\": \"Documentation section: 07-misc\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/07-misc\"}, \"subpages\": [{\"title\": \"Testing\", \"description\": null, \"content\": {\"Unit and integration testing using Vitest\": {\"Using runes inside your test files\": \"Since Vitest processes your test files the same way as your source files, you can use runes inside your tests as long as the filename includes `.svelte`:\\n\\n```\\n/// file: multiplier.svelte.test.js\\nimport { flushSync } from 'svelte';\\nimport { expect, test } from 'vitest';\\nimport { multiplier } from './multiplier.svelte.js';\\n\\ntest('Multiplier', () => {\\n let count = $state(0);\\n let double = multiplier(() => count, 2);\\n\\n expect(double.value).toEqual(0);\\n\\n count = 5;\\n\\n expect(double.value).toEqual(10);\\n});\\n```\\n\\n```\\n/// file: multiplier.svelte.js\\n/**\\n * @param {() => number} getCount\\n * @param {number} k\\n */\\nexport function multiplier(getCount, k) {\\n return {\\n get value() {\\n return getCount() * k;\\n }\\n };\\n}\\n```\\n\\nIf the code being tested uses effects, you need to wrap the test inside `$effect.root`:\\n\\n```\\n/// file: logger.svelte.test.js\\nimport { flushSync } from 'svelte';\\nimport { expect, test } from 'vitest';\\nimport { logger } from './logger.svelte.js';\\n\\ntest('Effect', () => {\\n const cleanup = $effect.root(() => {\\n let count = $state(0);\\n\\n // logger uses an $effect to log updates of its input\\n let log = logger(() => count);\\n\\n // effects normally run after a microtask,\\n // use flushSync to execute all pending effects synchronously\\n flushSync();\\n expect(log).toEqual([0]);\\n\\n count = 1;\\n flushSync();\\n\\n expect(log).toEqual([0, 1]);\\n });\\n\\n cleanup();\\n});\\n```\\n\\n```\\n/// file: logger.svelte.js\\n/**\\n * @param {() => any} getValue\\n */\\nexport function logger(getValue) {\\n /** @type {any[]} */\\n let log = [];\\n\\n $effect(() => {\\n log.push(getValue());\\n });\\n\\n return log;\\n}\\n```\", \"Component testing\": \"It is possible to test your components in isolation using Vitest.\\n\\n[\\\"[!NOTE] Before writing component tests, think about whether you actually need to test the component, or if it's more about the logic _inside_ the component. If so, consider extracting out that logic to test it in isolation, without the overhead of a component\\\"]\\n\\nTo get started, install jsdom (a library that shims DOM APIs):\\n\\n```\\nnpm install -D jsdom\\n```\\n\\nThen adjust your `vite.config.js`:\\n\\n```\\n/// file: vite.config.js\\nimport { defineConfig } from 'vitest/config';\\n\\nexport default defineConfig({\\n plugins: [\\n /* ... */\\n ],\\n test: {\\n // If you are testing components client-side, you need to setup a DOM environment.\\n // If not all your files should have this environment, you can use a\\n // `// @vitest-environment jsdom` comment at the top of the test files instead.\\n environment: 'jsdom'\\n },\\n // Tell Vitest to use the `browser` entry points in `package.json` files, even though it's running in Node\\n resolve: process.env.VITEST\\n ? {\\n conditions: ['browser']\\n }\\n : undefined\\n});\\n```\\n\\nAfter that, you can create a test file in which you import the component to test, interact with it programmatically and write expectations about the results:\\n\\n```\\n/// file: component.test.js\\nimport { flushSync, mount, unmount } from 'svelte';\\nimport { expect, test } from 'vitest';\\nimport Component from './Component.svelte';\\n\\ntest('Component', () => {\\n // Instantiate the component using Svelte's `mount` API\\n const component = mount(Component, {\\n target: document.body, // `document` exists because of jsdom\\n props: { initial: 0 }\\n });\\n\\n expect(document.body.innerHTML).toBe('<button>0</button>');\\n\\n // Click the button, then flush the changes so you can synchronously write expectations\\n document.body.querySelector('button').click();\\n flushSync();\\n\\n expect(document.body.innerHTML).toBe('<button>1</button>');\\n\\n // Remove the component from the DOM\\n unmount(component);\\n});\\n```\\n\\nWhile the process is very straightforward, it is also low level and somewhat brittle, as the precise structure of your component may change frequently. Tools like [@testing-library/svelte](https://testing-library.com/docs/svelte-testing-library/intro/) can help streamline your tests. The above test could be rewritten like this:\\n\\n```\\n/// file: component.test.js\\nimport { render, screen } from '@testing-library/svelte';\\nimport userEvent from '@testing-library/user-event';\\nimport { expect, test } from 'vitest';\\nimport Component from './Component.svelte';\\n\\ntest('Component', async () => {\\n const user = userEvent.setup();\\n render(Component);\\n\\n const button = screen.getByRole('button');\\n expect(button).toHaveTextContent(0);\\n\\n await user.click(button);\\n expect(button).toHaveTextContent(1);\\n});\\n```\\n\\nWhen writing component tests that involve two-way bindings, context or snippet props, it's best to create a wrapper component for your specific test and interact with that. `@testing-library/svelte` contains some [examples](https://testing-library.com/docs/svelte-testing-library/example).\"}, \"E2E tests using Playwright\": \"E2E (short for 'end to end') tests allow you to test your full application through the eyes of the user. This section uses [Playwright](https://playwright.dev/) as an example, but you can also use other solutions like [Cypress](https://www.cypress.io/) or [NightwatchJS](https://nightwatchjs.org/).\\n\\nYou can use the Svelte CLI to [setup Playwright](/docs/cli/playwright) either during project creation or later on. You can also [set it up with `npm init playwright`](https://playwright.dev/docs/intro). Additionally, you may also want to install an IDE plugin such as [the VS Code extension](https://playwright.dev/docs/getting-started-vscode) to be able to execute tests from inside your IDE.\\n\\nIf you've run `npm init playwright` or are not using Vite, you may need to adjust the Playwright config to tell Playwright what to do before running the tests - mainly starting your application at a certain port. For example:\\n\\n```\\n/// file: playwright.config.js\\nconst config = {\\n webServer: {\\n command: 'npm run build && npm run preview',\\n port: 4173\\n },\\n testDir: 'tests',\\n testMatch: /(.+\\\\.)?(test|spec)\\\\.[jt]s/\\n};\\n\\nexport default config;\\n```\\n\\nYou can now start writing tests. These are totally unaware of Svelte as a framework, so you mainly interact with the DOM and write assertions.\\n\\n```\\n// @errors: 2307 7031\\n/// file: tests/hello-world.spec.js\\nimport { expect, test } from '@playwright/test';\\n\\ntest('home page has expected h1', async ({ page }) => {\\n await page.goto('/');\\n await expect(page.locator('h1')).toBeVisible();\\n});\\n```\"}, \"metadata\": {\"title\": \"Testing\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"TypeScript\", \"description\": null, \"content\": {\"`<script lang=\\\"ts\\\">`\": \"To use TypeScript inside your Svelte components, add `lang=\\\"ts\\\"` to your `script` tags:\\n\\n```\\n<script lang=\\\"ts\\\">\\n let name: string = 'world';\\n\\n function greet(name: string) {\\n alert(`Hello, ${name}!`);\\n }\\n</script>\\n\\n<button onclick={(e: Event) => greet(e.target.innerText)}>\\n {name as string}\\n</button>\\n```\\n\\nDoing so allows you to use TypeScript's _type-only_ features. That is, all features that just disappear when transpiling to JavaScript, such as type annotations or interface declarations. Features that require the TypeScript compiler to output actual code are not supported. This includes:\\n\\n['using enums', 'using `private`, `protected` or `public` modifiers in constructor functions together with initializers', 'using features that are not yet part of the ECMAScript standard (i.e. not level 4 in the TC39 process) and therefore not implemented yet within Acorn, the parser we use for parsing JavaScript']\\n\\nIf you want to use one of these features, you need to setup up a `script` preprocessor.\", \"Preprocessor setup\": {\"Using SvelteKit or Vite\": \"The easiest way to get started is scaffolding a new SvelteKit project by typing `npx sv create`, following the prompts and choosing the TypeScript option.\\n\\n```\\n/// file: svelte.config.js\\n// @noErrors\\nimport { vitePreprocess } from '@sveltejs/vite-plugin-svelte';\\n\\nconst config = {\\n preprocess: vitePreprocess()\\n};\\n\\nexport default config;\\n```\\n\\nIf you don't need or want all the features SvelteKit has to offer, you can scaffold a Svelte-flavoured Vite project instead by typing `npm create vite@latest` and selecting the `svelte-ts` option.\\n\\nIn both cases, a `svelte.config.js` with `vitePreprocess` will be added. Vite/SvelteKit will read from this config file.\", \"Other build tools\": \"If you're using tools like Rollup or Webpack instead, install their respective Svelte plugins. For Rollup that's [rollup-plugin-svelte](https://github.com/sveltejs/rollup-plugin-svelte) and for Webpack that's [svelte-loader](https://github.com/sveltejs/svelte-loader). For both, you need to install `typescript` and `svelte-preprocess` and add the preprocessor to the plugin config (see the respective READMEs for more info). If you're starting a new project, you can also use the [rollup](https://github.com/sveltejs/template) or [webpack](https://github.com/sveltejs/template-webpack) template to scaffold the setup from a script.\\n\\n[\\\"[!NOTE] If you're starting a new project, we recommend using SvelteKit or Vite instead\\\"]\"}, \"tsconfig.json settings\": \"When using TypeScript, make sure your `tsconfig.json` is setup correctly.\\n\\n['Use a [`target`](https://www.typescriptlang.org/tsconfig/#target) of at least `ES2015` so classes are not compiled to functions', 'Set [`verbatimModuleSyntax`](https://www.typescriptlang.org/tsconfig/#verbatimModuleSyntax) to `true` so that imports are left as-is', \\\"Set [`isolatedModules`](https://www.typescriptlang.org/tsconfig/#isolatedModules) to `true` so that each file is looked at in isolation. TypeScript has a few features which require cross-file analysis and compilation, which the Svelte compiler and tooling like Vite don't do. \\\"]\", \"Typing `$props`\": \"Type `$props` just like a regular object with certain properties.\\n\\n```\\n<script lang=\\\"ts\\\">\\n import type { Snippet } from 'svelte';\\n\\n interface Props {\\n requiredProperty: number;\\n optionalProperty?: boolean;\\n snippetWithStringArgument: Snippet<[string]>;\\n eventHandler: (arg: string) => void;\\n [key: string]: unknown;\\n }\\n\\n let {\\n requiredProperty,\\n optionalProperty,\\n snippetWithStringArgument,\\n eventHandler,\\n ...everythingElse\\n }: Props = $props();\\n</script>\\n\\n<button onclick={() => eventHandler('clicked button')}>\\n {@render snippetWithStringArgument('hello')}\\n</button>\\n```\", \"Generic `$props`\": \"Components can declare a generic relationship between their properties. One example is a generic list component that receives a list of items and a callback property that receives an item from the list. To declare that the `items` property and the `select` callback operate on the same types, add the `generics` attribute to the `script` tag:\\n\\n```\\n<script lang=\\\"ts\\\" generics=\\\"Item extends { text: string }\\\">\\n interface Props {\\n items: Item[];\\n select(item: Item): void;\\n }\\n\\n let { items, select }: Props = $props();\\n</script>\\n\\n{#each items as item}\\n <button onclick={() => select(item)}>\\n {item.text}\\n </button>\\n{/each}\\n```\\n\\nThe content of `generics` is what you would put between the `<...>` tags of a generic function. In other words, you can use multiple generics, `extends` and fallback types.\", \"Typing wrapper components\": \"In case you're writing a component that wraps a native element, you may want to expose all the attributes of the underlying element to the user. In that case, use (or extend from) one of the interfaces provided by `svelte/elements`. Here's an example for a `Button` component:\\n\\n```\\n<script lang=\\\"ts\\\">\\n import type { HTMLButtonAttributes } from 'svelte/elements';\\n\\n let { children, ...rest }: HTMLButtonAttributes = $props();\\n</script>\\n\\n<button {...rest}>\\n {@render children?.()}\\n</button>\\n```\\n\\nNot all elements have a dedicated type definition. For those without one, use `SvelteHTMLElements`:\\n\\n```\\n<script lang=\\\"ts\\\">\\n import type { SvelteHTMLElements } from 'svelte/elements';\\n\\n let { children, ...rest }: SvelteHTMLElements['div'] = $props();\\n</script>\\n\\n<div {...rest}>\\n {@render children?.()}\\n</div>\\n```\", \"Typing `$state`\": \"You can type `$state` like any other variable.\\n\\n```\\nlet count: number = $state(0);\\n```\\n\\nIf you don't give `$state` an initial value, part of its types will be `undefined`.\\n\\n```\\n// @noErrors\\n// Error: Type 'number | undefined' is not assignable to type 'number'\\nlet count: number = $state();\\n```\\n\\nIf you know that the variable _will_ be defined before you first use it, use an `as` casting. This is especially useful in the context of classes:\\n\\n```\\nclass Counter {\\n count = $state() as number;\\n constructor(initial: number) {\\n this.count = initial;\\n }\\n}\\n```\", \"The `Component` type\": \"Svelte components are of type `Component`. You can use it and its related types to express a variety of constraints.\\n\\nUsing it together with dynamic components to restrict what kinds of component can be passed to it:\\n\\n```\\n<script lang=\\\"ts\\\">\\n import type { Component } from 'svelte';\\n\\n interface Props {\\n // only components that have at most the \\\"prop\\\"\\n // property required can be passed\\n DynamicComponent: Component<{ prop: string }>;\\n }\\n\\n let { DynamicComponent }: Props = $props();\\n</script>\\n\\n<DynamicComponent prop=\\\"foo\\\" />\\n```\\n\\n['[!LEGACY] In Svelte 4, components were of type `SvelteComponent`']\\n\\nTo extract the properties from a component, use `ComponentProps`.\\n\\n```\\nimport type { Component, ComponentProps } from 'svelte';\\nimport MyComponent from './MyComponent.svelte';\\n\\nfunction withProps<TComponent extends Component<any>>(\\n component: TComponent,\\n props: ComponentProps<TComponent>\\n) {}\\n\\n// Errors if the second argument is not the correct props expected\\n// by the component in the first argument.\\nwithProps(MyComponent, { foo: 'bar' });\\n```\\n\\nTo declare that a variable expects the constructor or instance type of a component:\\n\\n```\\n<script lang=\\\"ts\\\">\\n import MyComponent from './MyComponent.svelte';\\n\\n let componentConstructor: typeof MyComponent = MyComponent;\\n let componentInstance: MyComponent;\\n</script>\\n\\n<MyComponent bind:this={componentInstance} />\\n```\", \"Enhancing built-in DOM types\": \"Svelte provides a best effort of all the HTML DOM types that exist. Sometimes you may want to use experimental attributes or custom events coming from an action. In these cases, TypeScript will throw a type error, saying that it does not know these types. If it's a non-experimental standard attribute/event, this may very well be a missing typing from our [HTML typings](https://github.com/sveltejs/svelte/blob/main/packages/svelte/elements.d.ts). In that case, you are welcome to open an issue and/or a PR fixing it.\\n\\nIn case this is a custom or experimental attribute/event, you can enhance the typings by augmenting the `svelte/elements` module like this:\\n\\n```\\n/// file: additional-svelte-typings.d.ts\\nimport { HTMLButtonAttributes } from 'svelte/elements';\\n\\ndeclare module 'svelte/elements' {\\n // add a new element\\n export interface SvelteHTMLElements {\\n 'custom-button': HTMLButtonAttributes;\\n }\\n\\n // add a new global attribute that is available on all html elements\\n export interface HTMLAttributes<T> {\\n globalattribute?: string;\\n }\\n\\n // add a new attribute for button elements\\n export interface HTMLButtonAttributes {\\n veryexperimentalattribute?: string;\\n }\\n}\\n\\nexport {}; // ensure this is not an ambient module, else types will be overridden instead of augmented\\n```\\n\\nThen make sure that the `d.ts` file is referenced in your `tsconfig.json`. If it reads something like `\\\"include\\\": [\\\"src/**/*\\\"]` and your `d.ts` file is inside `src`, it should work. You may need to reload for the changes to take effect.\"}, \"metadata\": {\"title\": \"TypeScript\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"Custom elements\", \"description\": null, \"content\": {\"Component lifecycle\": \"Custom elements are created from Svelte components using a wrapper approach. This means the inner Svelte component has no knowledge that it is a custom element. The custom element wrapper takes care of handling its lifecycle appropriately.\\n\\nWhen a custom element is created, the Svelte component it wraps is _not_ created right away. It is only created in the next tick after the `connectedCallback` is invoked. Properties assigned to the custom element before it is inserted into the DOM are temporarily saved and then set on component creation, so their values are not lost. The same does not work for invoking exported functions on the custom element though, they are only available after the element has mounted. If you need to invoke functions before component creation, you can work around it by using the [`extend` option](#Component-options).\\n\\nWhen a custom element written with Svelte is created or updated, the shadow DOM will reflect the value in the next tick, not immediately. This way updates can be batched, and DOM moves which temporarily (but synchronously) detach the element from the DOM don't lead to unmounting the inner component.\\n\\nThe inner Svelte component is destroyed in the next tick after the `disconnectedCallback` is invoked.\", \"Component options\": \"When constructing a custom element, you can tailor several aspects by defining `customElement` as an object within `<svelte:options>` since Svelte 4. This object may contain the following properties:\\n\\n[\\\"`tag: string`: an optional `tag` property for the custom element's name. If set, a custom element with this tag name will be defined with the document's `customElements` registry upon importing this component.\\\", '`shadow`: an optional property that can be set to `\\\"none\\\"` to forgo shadow root creation. Note that styles are then no longer encapsulated, and you can\\\\'t use slots', \\\"`props`: an optional property to modify certain details and behaviors of your component's properties. It offers the following settings:\\\", ['`attribute: string`: To update a custom element\\\\'s prop, you have two alternatives: either set the property on the custom element\\\\'s reference as illustrated above or use an HTML attribute. For the latter, the default attribute name is the lowercase property name. Modify this by assigning `attribute: \\\"<desired name>\\\"`.', '`reflect: boolean`: By default, updated prop values do not reflect back to the DOM. To enable this behavior, set `reflect: true`.', '`type: \\\\'String\\\\' | \\\\'Boolean\\\\' | \\\\'Number\\\\' | \\\\'Array\\\\' | \\\\'Object\\\\'`: While converting an attribute value to a prop value and reflecting it back, the prop value is assumed to be a `String` by default. This may not always be accurate. For instance, for a number type, define it using `type: \\\"Number\\\"`\\\\nYou don\\\\'t need to list all properties, those not listed will use the default settings.'], '`extend`: an optional property which expects a function as its argument. It is passed the custom element class generated by Svelte and expects you to return a custom element class. This comes in handy if you have very specific requirements to the life cycle of the custom element or want to enhance the class to for example use [ElementInternals](https://developer.mozilla.org/en-US/docs/Web/API/ElementInternals#examples) for better HTML form integration.']\\n\\n```\\n<svelte:options\\n customElement={{\\n tag: 'custom-element',\\n shadow: 'none',\\n props: {\\n name: { reflect: true, type: 'Number', attribute: 'element-index' }\\n },\\n extend: (customElementConstructor) => {\\n // Extend the class so we can let it participate in HTML forms\\n return class extends customElementConstructor {\\n static formAssociated = true;\\n\\n constructor() {\\n super();\\n this.attachedInternals = this.attachInternals();\\n }\\n\\n // Add the function here, not below in the component so that\\n // it's always available, not just when the inner Svelte component\\n // is mounted\\n randomIndex() {\\n this.elementIndex = Math.random();\\n }\\n };\\n }\\n }}\\n/>\\n\\n<script>\\n let { elementIndex, attachedInternals } = $props();\\n // ...\\n function check() {\\n attachedInternals.checkValidity();\\n }\\n</script>\\n\\n...\\n```\\n\\n['[!NOTE] While Typescript is supported in the `extend` function, it is subject to limitations: you need to set `lang=\\\"ts\\\"` on one of the scripts AND you can only use [erasable syntax](https://www.typescriptlang.org/tsconfig/#erasableSyntaxOnly) in it. They are not processed by script preprocessors.']\", \"Caveats and limitations\": \"Custom elements can be a useful way to package components for consumption in a non-Svelte app, as they will work with vanilla HTML and JavaScript as well as [most frameworks](https://custom-elements-everywhere.com/). There are, however, some important differences to be aware of:\\n\\n['Styles are _encapsulated_, rather than merely _scoped_ (unless you set `shadow: \\\"none\\\"`). This means that any non-component styles (such as you might have in a `global.css` file) will not apply to the custom element, including styles with the `:global(...)` modifier', 'Instead of being extracted out as a separate .css file, styles are inlined into the component as a JavaScript string', 'Custom elements are not generally suitable for server-side rendering, as the shadow DOM is invisible until JavaScript loads', \\\"In Svelte, slotted content renders _lazily_. In the DOM, it renders _eagerly_. In other words, it will always be created even if the component's `<slot>` element is inside an `{#if ...}` block. Similarly, including a `<slot>` in an `{#each ...}` block will not cause the slotted content to be rendered multiple times\\\", 'The deprecated `let:` directive has no effect, because custom elements do not have a way to pass data to the parent component that fills the slot', 'Polyfills are required to support older browsers', \\\"You can use Svelte's context feature between regular Svelte components within a custom element, but you can't use them across custom elements. In other words, you can't use `setContext` on a parent custom element and read that with `getContext` in a child custom element.\\\", \\\"Don't declare properties or attributes starting with `on`, as their usage will be interpreted as an event listener. In other words, Svelte treats `<custom-element oneworld={true}></custom-element>` as `customElement.addEventListener('eworld', true)` (and not as `customElement.oneworld = true`)\\\"]\"}, \"metadata\": {\"title\": \"Custom elements\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"Svelte 4 migration guide\", \"description\": null, \"content\": {\"Minimum version requirements\": [\"Upgrade to Node 16 or higher. Earlier versions are no longer supported. ([#8566](https://github.com/sveltejs/svelte/issues/8566))\", \"If you are using SvelteKit, upgrade to 1.20.4 or newer ([sveltejs/kit#10172](https://github.com/sveltejs/kit/pull/10172))\", \"If you are using Vite without SvelteKit, upgrade to `vite-plugin-svelte` 2.4.1 or newer ([#8516](https://github.com/sveltejs/svelte/issues/8516))\", \"If you are using webpack, upgrade to webpack 5 or higher and `svelte-loader` 3.1.8 or higher. Earlier versions are no longer supported. ([#8515](https://github.com/sveltejs/svelte/issues/8515), [198dbcf](https://github.com/sveltejs/svelte/commit/198dbcf))\", \"If you are using Rollup, upgrade to `rollup-plugin-svelte` 7.1.5 or higher ([198dbcf](https://github.com/sveltejs/svelte/commit/198dbcf))\", \"If you are using TypeScript, upgrade to TypeScript 5 or higher. Lower versions might still work, but no guarantees are made about that. ([#8488](https://github.com/sveltejs/svelte/issues/8488))\"], \"Browser conditions for bundlers\": \"Bundlers must now specify the `browser` condition when building a frontend bundle for the browser. SvelteKit and Vite will handle this automatically for you. If you're using any others, you may observe lifecycle callbacks such as `onMount` not get called and you'll need to update the module resolution configuration.\\n\\n['For Rollup this is done within the `@rollup/plugin-node-resolve` plugin by setting `browser: true` in its options. See the [`rollup-plugin-svelte`](https://github.com/sveltejs/rollup-plugin-svelte/#usage) documentation for more details', 'For webpack this is done by adding `\\\"browser\\\"` to the `conditionNames` array. You may also have to update your `alias` config, if you have set it. See the [`svelte-loader`](https://github.com/sveltejs/svelte-loader#usage) documentation for more details']\\n\\n([#8516](https://github.com/sveltejs/svelte/issues/8516))\", \"Removal of CJS related output\": \"Svelte no longer supports the CommonJS (CJS) format for compiler output and has also removed the `svelte/register` hook and the CJS runtime version. If you need to stay on the CJS output format, consider using a bundler to convert Svelte's ESM output to CJS in a post-build step. ([#8613](https://github.com/sveltejs/svelte/issues/8613))\", \"Stricter types for Svelte functions\": \"There are now stricter types for `createEventDispatcher`, `Action`, `ActionReturn`, and `onMount`:\\n\\n['`createEventDispatcher` now supports specifying that a payload is optional, required, or non-existent, and the call sites are checked accordingly ([#7224](https://github.com/sveltejs/svelte/issues/7224))']\\n\\n```\\n// @errors: 2554 2345\\nimport { createEventDispatcher } from 'svelte';\\n\\nconst dispatch = createEventDispatcher<{\\n optional: number | null;\\n required: string;\\n noArgument: null;\\n}>();\\n\\n// Svelte version 3:\\ndispatch('optional');\\ndispatch('required'); // I can still omit the detail argument\\ndispatch('noArgument', 'surprise'); // I can still add a detail argument\\n\\n// Svelte version 4 using TypeScript strict mode:\\ndispatch('optional');\\ndispatch('required'); // error, missing argument\\ndispatch('noArgument', 'surprise'); // error, cannot pass an argument\\n```\\n\\n['`Action` and `ActionReturn` have a default parameter type of `undefined` now, which means you need to type the generic if you want to specify that this action receives a parameter. The migration script will migrate this automatically ([#7442](https://github.com/sveltejs/svelte/pull/7442))']\\n\\n```\\n// @noErrors\\n---const action: Action = (node, params) => { ... } // this is now an error if you use params in any way---\\n+++const action: Action<HTMLElement, string> = (node, params) => { ... } // params is of type string+++\\n```\\n\\n['`onMount` now shows a type error if you return a function asynchronously from it, because this is likely a bug in your code where you expect the callback to be called on destroy, which it will only do for synchronously returned functions ([#8136](https://github.com/sveltejs/svelte/issues/8136))']\\n\\n```\\n// @noErrors\\n// Example where this change reveals an actual bug\\nonMount(\\n--- // someCleanup() not called because function handed to onMount is async\\n async () => {\\n const something = await foo();---\\n+++ // someCleanup() is called because function handed to onMount is sync\\n () => {\\n foo().then(something => {...});\\n // ...\\n return () => someCleanup();\\n }\\n);\\n```\", \"Custom Elements with Svelte\": \"The creation of custom elements with Svelte has been overhauled and significantly improved. The `tag` option is deprecated in favor of the new `customElement` option:\\n\\n```\\n---<svelte:options tag=\\\"my-component\\\" />---\\n+++<svelte:options customElement=\\\"my-component\\\" />+++\\n```\\n\\nThis change was made to allow [more configurability](custom-elements#Component-options) for advanced use cases. The migration script will adjust your code automatically. The update timing of properties has changed slightly as well. ([#8457](https://github.com/sveltejs/svelte/issues/8457))\", \"SvelteComponentTyped is deprecated\": \"`SvelteComponentTyped` is deprecated, as `SvelteComponent` now has all its typing capabilities. Replace all instances of `SvelteComponentTyped` with `SvelteComponent`.\\n\\n```\\n---import { SvelteComponentTyped } from 'svelte';---\\n+++import { SvelteComponent } from 'svelte';+++\\n\\n---export class Foo extends SvelteComponentTyped<{ aProp: string }> {}---\\n+++export class Foo extends SvelteComponent<{ aProp: string }> {}+++\\n```\\n\\nIf you have used `SvelteComponent` as the component instance type previously, you may see a somewhat opaque type error now, which is solved by changing `: typeof SvelteComponent` to `: typeof SvelteComponent<any>`.\\n\\n```\\n<script>\\n import ComponentA from './ComponentA.svelte';\\n import ComponentB from './ComponentB.svelte';\\n import { SvelteComponent } from 'svelte';\\n\\n let component: typeof SvelteComponent+++<any>+++;\\n\\n function choseRandomly() {\\n component = Math.random() > 0.5 ? ComponentA : ComponentB;\\n }\\n</script>\\n\\n<button on:click={choseRandomly}>random</button>\\n<svelte:element this={component} />\\n```\\n\\nThe migration script will do both automatically for you. ([#8512](https://github.com/sveltejs/svelte/issues/8512))\", \"Transitions are local by default\": \"Transitions are now local by default to prevent confusion around page navigations. \\\"local\\\" means that a transition will not play if it's within a nested control flow block (`each/if/await/key`) and not the direct parent block but a block above it is created/destroyed. In the following example, the `slide` intro animation will only play when `success` goes from `false` to `true`, but it will _not_ play when `show` goes from `false` to `true`:\\n\\n```\\n{#if show}\\n ...\\n {#if success}\\n <p in:slide>Success</p>\\n {/each}\\n{/if}\\n```\\n\\nTo make transitions global, add the `|global` modifier - then they will play when _any_ control flow block above is created/destroyed. The migration script will do this automatically for you. ([#6686](https://github.com/sveltejs/svelte/issues/6686))\", \"Default slot bindings\": \"Default slot bindings are no longer exposed to named slots and vice versa:\\n\\n```\\n<script>\\n import Nested from './Nested.svelte';\\n</script>\\n\\n<Nested let:count>\\n <p>\\n count in default slot - is available: {count}\\n </p>\\n <p slot=\\\"bar\\\">\\n count in bar slot - is not available: {count}\\n </p>\\n</Nested>\\n```\\n\\nThis makes slot bindings more consistent as the behavior is undefined when for example the default slot is from a list and the named slot is not. ([#6049](https://github.com/sveltejs/svelte/issues/6049))\", \"Preprocessors\": \"The order in which preprocessors are applied has changed. Now, preprocessors are executed in order, and within one group, the order is markup, script, style.\\n\\n```\\n// @errors: 2304\\nimport { preprocess } from 'svelte/compiler';\\n\\nconst { code } = await preprocess(\\n source,\\n [\\n {\\n markup: () => {\\n console.log('markup-1');\\n },\\n script: () => {\\n console.log('script-1');\\n },\\n style: () => {\\n console.log('style-1');\\n }\\n },\\n {\\n markup: () => {\\n console.log('markup-2');\\n },\\n script: () => {\\n console.log('script-2');\\n },\\n style: () => {\\n console.log('style-2');\\n }\\n }\\n ],\\n {\\n filename: 'App.svelte'\\n }\\n);\\n\\n// Svelte 3 logs:\\n// markup-1\\n// markup-2\\n// script-1\\n// script-2\\n// style-1\\n// style-2\\n\\n// Svelte 4 logs:\\n// markup-1\\n// script-1\\n// style-1\\n// markup-2\\n// script-2\\n// style-2\\n```\\n\\nThis could affect you for example if you are using `MDsveX` - in which case you should make sure it comes before any script or style preprocessor.\\n\\n```\\n// @noErrors\\npreprocess: [\\n--- vitePreprocess(),\\n mdsvex(mdsvexConfig)---\\n+++ mdsvex(mdsvexConfig),\\n vitePreprocess()+++\\n]\\n```\\n\\nEach preprocessor must also have a name. ([#8618](https://github.com/sveltejs/svelte/issues/8618))\", \"New eslint package\": \"`eslint-plugin-svelte3` is deprecated. It may still work with Svelte 4 but we make no guarantees about that. We recommend switching to our new package [eslint-plugin-svelte](https://github.com/sveltejs/eslint-plugin-svelte). See [this Github post](https://github.com/sveltejs/kit/issues/10242#issuecomment-1610798405) for an instruction how to migrate. Alternatively, you can create a new project using `npm create svelte@latest`, select the eslint (and possibly TypeScript) option and then copy over the related files into your existing project.\", \"Other breaking changes\": [\"the `inert` attribute is now applied to outroing elements to make them invisible to assistive technology and prevent interaction. ([#8628](https://github.com/sveltejs/svelte/pull/8628))\", \"the runtime now uses `classList.toggle(name, boolean)` which may not work in very old browsers. Consider using a [polyfill](https://github.com/eligrey/classList.js) if you need to support these browsers. ([#8629](https://github.com/sveltejs/svelte/issues/8629))\", \"the runtime now uses the `CustomEvent` constructor which may not work in very old browsers. Consider using a [polyfill](https://github.com/theftprevention/event-constructor-polyfill/tree/master) if you need to support these browsers. ([#8775](https://github.com/sveltejs/svelte/pull/8775))\", \"people implementing their own stores from scratch using the `StartStopNotifier` interface (which is passed to the create function of `writable` etc) from `svelte/store` now need to pass an update function in addition to the set function. This has no effect on people using stores or creating stores using the existing Svelte stores. ([#6750](https://github.com/sveltejs/svelte/issues/6750))\", \"`derived` will now throw an error on falsy values instead of stores passed to it. ([#7947](https://github.com/sveltejs/svelte/issues/7947))\", \"type definitions for `svelte/internal` were removed to further discourage usage of those internal methods which are not public API. Most of these will likely change for Svelte 5\", \"Removal of DOM nodes is now batched which slightly changes its order, which might affect the order of events fired if you're using a `MutationObserver` on these elements ([#8763](https://github.com/sveltejs/svelte/pull/8763))\", \"if you enhanced the global typings through the `svelte.JSX` namespace before, you need to migrate this to use the `svelteHTML` namespace. Similarly if you used the `svelte.JSX` namespace to use type definitions from it, you need to migrate those to use the types from `svelte/elements` instead. You can find more information about what to do [here](https://github.com/sveltejs/language-tools/blob/master/docs/preprocessors/typescript.md#im-getting-deprecation-warnings-for-sveltejsx--i-want-to-migrate-to-the-new-typings)\"]}, \"metadata\": {\"title\": \"Svelte 4 migration guide\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"Svelte 5 migration guide\", \"description\": null, \"content\": {\"Reactivity syntax changes\": {\"let \\u2192 $state\": \"In Svelte 4, a `let` declaration at the top level of a component was implicitly reactive. In Svelte 5, things are more explicit: a variable is reactive when created using the `$state` rune. Let's migrate the counter to runes mode by wrapping the counter in `$state`:\\n\\n```\\n<script>\\n let count = +++$state(0)+++;\\n</script>\\n```\\n\\nNothing else changes. `count` is still the number itself, and you read and write directly to it, without a wrapper like `.value` or `getCount()`.\\n\\n[\\\"[!DETAILS] Why we did this\\\\n`let` being implicitly reactive at the top level worked great, but it meant that reactivity was constrained - a `let` declaration anywhere else was not reactive. This forced you to resort to using stores when refactoring code out of the top level of components for reuse. This meant you had to learn an entirely separate reactivity model, and the result often wasn't as nice to work with. Because reactivity is more explicit in Svelte 5, you can keep using the same API outside the top level of components. Head to [the tutorial](/tutorial) to learn more.\\\"]\", \"$: \\u2192 $derived/$effect\": \"In Svelte 4, a `$:` statement at the top level of a component could be used to declare a derivation, i.e. state that is entirely defined through a computation of other state. In Svelte 5, this is achieved using the `$derived` rune:\\n\\n```\\n<script>\\n let count = $state(0);\\n ---$:--- +++const+++ double = +++$derived(count * 2)+++;\\n</script>\\n```\\n\\nAs with `$state`, nothing else changes. `double` is still the number itself, and you read it directly, without a wrapper like `.value` or `getDouble()`.\\n\\nA `$:` statement could also be used to create side effects. In Svelte 5, this is achieved using the `$effect` rune:\\n\\n```\\n<script>\\n let count = $state(0);\\n\\n ---$:---+++$effect(() =>+++ {\\n if (count > 5) {\\n alert('Count is too high!');\\n }\\n }+++);+++\\n</script>\\n```\\n\\nNote that [when `$effect` runs is different]($effect#Understanding-dependencies) than when `$:` runs.\\n\\n[\\\"[!DETAILS] Why we did this\\\\n`$:` was a great shorthand and easy to get started with: you could slap a `$:` in front of most code and it would somehow work. This intuitiveness was also its drawback the more complicated your code became, because it wasn't as easy to reason about. Was the intent of the code to create a derivation, or a side effect? With `$derived` and `$effect`, you have a bit more up-front decision making to do (spoiler alert: 90% of the time you want `$derived`), but future-you and other developers on your team will have an easier time.\\\", 'There were also gotchas that were hard to spot:', ['`$:` only updated directly before rendering, which meant you could read stale values in-between rerenders', '`$:` only ran once per tick, which meant that statements may run less often than you think', '`$:` dependencies were determined through static analysis of the dependencies. This worked in most cases, but could break in subtle ways during a refactoring where dependencies would be for example moved into a function and no longer be visible as a result', '`$:` statements were also ordered by using static analysis of the dependencies. In some cases there could be ties and the ordering would be wrong as a result, needing manual interventions. Ordering could also break while refactoring code and some dependencies no longer being visible as a result.'], \\\"Lastly, it wasn't TypeScript-friendly (our editor tooling had to jump through some hoops to make it valid for TypeScript), which was a blocker for making Svelte's reactivity model truly universal.\\\", '`$derived` and `$effect` fix all of these by', ['always returning the latest value', 'running as often as needed to be stable', 'determining the dependencies at runtime, and therefore being immune to refactorings', 'executing dependencies as needed and therefore being immune to ordering problems', 'being TypeScript-friendly']]\", \"export let \\u2192 $props\": \"In Svelte 4, properties of a component were declared using `export let`. Each property was one declaration. In Svelte 5, all properties are declared through the `$props` rune, through destructuring:\\n\\n```\\n<script>\\n ---export let optional = 'unset';---\\n ---export let required;---\\n +++let { optional = 'unset', required } = $props();+++\\n</script>\\n```\\n\\nThere are multiple cases where declaring properties becomes less straightforward than having a few `export let` declarations:\\n\\n['you want to rename the property, for example because the name is a reserved identifier (e.g. `class`)', \\\"you don't know which other properties to expect in advance\\\", 'you want to forward every property to another component']\\n\\nAll these cases need special syntax in Svelte 4:\\n\\n['renaming: `export { klass as class}`', 'other properties: `$$restProps`', 'all properties `$$props`']\\n\\nIn Svelte 5, the `$props` rune makes this straightforward without any additional Svelte-specific syntax:\\n\\n['renaming: use property renaming `let { class: klass } = $props();`', 'other properties: use spreading `let { foo, bar, ...rest } = $props();`', \\\"all properties: don't destructure `let props = $props();`\\\"]\\n\\n```\\n<script>\\n ---let klass = '';---\\n ---export { klass as class};---\\n +++let { class: klass, ...rest } = $props();+++\\n</script>\\n<button class={klass} {...---$$restProps---+++rest+++}>click me</button>\\n```\\n\\n['[!DETAILS] Why we did this\\\\n`export let` was one of the more controversial API decisions, and there was a lot of debate about whether you should think about a property being `export`ed or `import`ed. `$props` doesn\\\\'t have this trait. It\\\\'s also in line with the other runes, and the general thinking reduces to \\\"everything special to reactivity in Svelte is a rune\\\".', 'There were also a lot of limitations around `export let`, which required additional API, as shown above. `$props` unite this in one syntactical concept that leans heavily on regular JavaScript destructuring syntax.']\"}, \"Event changes\": {\"Component events\": \"In Svelte 4, components could emit events by creating a dispatcher with `createEventDispatcher`.\\n\\nThis function is deprecated in Svelte 5. Instead, components should accept _callback props_ - which means you then pass functions as properties to these components:\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Pump from './Pump.svelte';\\n\\n let size = $state(15);\\n let burst = $state(false);\\n\\n function reset() {\\n size = 15;\\n burst = false;\\n }\\n</script>\\n\\n<Pump\\n ---on:---inflate={(power) => {\\n size += power---.detail---;\\n if (size > 75) burst = true;\\n }}\\n ---on:---deflate={(power) => {\\n if (size > 0) size -= power---.detail---;\\n }}\\n/>\\n\\n{#if burst}\\n <button onclick={reset}>new balloon</button>\\n <span class=\\\"boom\\\">\\ud83d\\udca5</span>\\n{:else}\\n <span class=\\\"balloon\\\" style=\\\"scale: {0.01 * size}\\\">\\n \\ud83c\\udf88\\n </span>\\n{/if}\\n```\\n\\n```\\n<!--- file: Pump.svelte --->\\n<script>\\n ---import { createEventDispatcher } from 'svelte';---\\n ---const dispatch = createEventDispatcher();---\\n\\n +++let { inflate, deflate } = $props();+++\\n let power = $state(5);\\n</script>\\n\\n<button onclick={() => ---dispatch('inflate', power)---+++inflate(power)+++}>\\n inflate\\n</button>\\n<button onclick={() => ---dispatch('deflate', power)---+++deflate(power)+++}>\\n deflate\\n</button>\\n<button onclick={() => power--}>-</button>\\nPump power: {power}\\n<button onclick={() => power++}>+</button>\\n```\", \"Bubbling events\": \"Instead of doing `<button on:click>` to 'forward' the event from the element to the component, the component should accept an `onclick` callback prop:\\n\\n```\\n<script>\\n +++let { onclick } = $props();+++\\n</script>\\n\\n<button ---on:click--- +++{onclick}+++>\\n click me\\n</button>\\n```\\n\\nNote that this also means you can 'spread' event handlers onto the element along with other props instead of tediously forwarding each event separately:\\n\\n```\\n<script>\\n let props = $props();\\n</script>\\n\\n<button ---{...$$props} on:click on:keydown on:all_the_other_stuff--- +++{...props}+++>\\n click me\\n</button>\\n```\", \"Event modifiers\": \"In Svelte 4, you can add event modifiers to handlers:\\n\\n```\\n<button on:click|once|preventDefault={handler}>...</button>\\n```\\n\\nModifiers are specific to `on:` and so do not work with modern event handlers. Adding things like `event.preventDefault()` inside the handler itself is preferable, since all the logic lives in one place rather than being split between handler and modifiers.\\n\\nSince event handlers are just functions, you can create your own wrappers as necessary:\\n\\n```\\n<script>\\n function once(fn) {\\n return function (event) {\\n if (fn) fn.call(this, event);\\n fn = null;\\n };\\n }\\n\\n function preventDefault(fn) {\\n return function (event) {\\n event.preventDefault();\\n fn.call(this, event);\\n };\\n }\\n</script>\\n\\n<button onclick={once(preventDefault(handler))}>...</button>\\n```\\n\\nThere are three modifiers \\u2014 `capture`, `passive` and `nonpassive` \\u2014 that can't be expressed as wrapper functions, since they need to be applied when the event handler is bound rather than when it runs.\\n\\nFor `capture`, we add the modifier to the event name:\\n\\n```\\n<button onclickcapture={...}>...</button>\\n```\\n\\nChanging the [`passive`](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#using_passive_listeners) option of an event handler, meanwhile, is not something to be done lightly. If you have a use case for it \\u2014 and you probably don't! \\u2014 then you will need to use an action to apply the event handler yourself.\", \"Multiple event handlers\": \"In Svelte 4, this is possible:\\n\\n```\\n<button on:click={one} on:click={two}>...</button>\\n```\\n\\nDuplicate attributes/properties on elements \\u2014 which now includes event handlers \\u2014 are not allowed. Instead, do this:\\n\\n```\\n<button\\n onclick={(e) => {\\n one(e);\\n two(e);\\n }}\\n>\\n ...\\n</button>\\n```\\n\\nWhen spreading props, local event handlers must go _after_ the spread, or they risk being overwritten:\\n\\n```\\n<button\\n {...props}\\n onclick={(e) => {\\n doStuff(e);\\n props.onclick?.(e);\\n }}\\n>\\n ...\\n</button>\\n```\\n\\n['[!DETAILS] Why we did this\\\\n`createEventDispatcher` was always a bit boilerplate-y:', ['import the function', 'call the function to get a dispatch function', 'call said dispatch function with a string and possibly a payload', 'retrieve said payload on the other end through a `.detail` property, because the event itself was always a `CustomEvent`'], \\\"It was always possible to use component callback props, but because you had to listen to DOM events using `on:`, it made sense to use `createEventDispatcher` for component events due to syntactical consistency. Now that we have event attributes (`onclick`), it's the other way around: Callback props are now the more sensible thing to do.\\\", \\\"The removal of event modifiers is arguably one of the changes that seems like a step back for those who've liked the shorthand syntax of event modifiers. Given that they are not used that frequently, we traded a smaller surface area for more explicitness. Modifiers also were inconsistent, because most of them were only useable on DOM elements.\\\", 'Multiple listeners for the same event are also no longer possible, but it was something of an anti-pattern anyway, since it impedes readability: if there are many attributes, it becomes harder to spot that there are two handlers unless they are right next to each other. It also implies that the two handlers are independent, when in fact something like `event.stopImmediatePropagation()` inside `one` would prevent `two` from being called.', 'By deprecating `createEventDispatcher` and the `on:` directive in favour of callback props and normal element properties, we:', [\\\"reduce Svelte's learning curve\\\", 'remove boilerplate, particularly around `createEventDispatcher`', 'remove the overhead of creating `CustomEvent` objects for events that may not even have listeners', 'add the ability to spread event handlers', 'add the ability to know which event handlers were provided to a component', 'add the ability to express whether a given event handler is required or optional', \\\"increase type safety (previously, it was effectively impossible for Svelte to guarantee that a component didn't emit a particular event)\\\"]]\"}, \"Snippets instead of slots\": {\"Default content\": \"In Svelte 4, the easiest way to pass a piece of UI to the child was using a `<slot />`. In Svelte 5, this is done using the `children` prop instead, which is then shown with `{@render children()}`:\\n\\n```\\n<script>\\n +++let { children } = $props();+++\\n</script>\\n\\n---<slot />---\\n+++{@render children?.()}+++\\n```\", \"Multiple content placeholders\": \"If you wanted multiple UI placeholders, you had to use named slots. In Svelte 5, use props instead, name them however you like and `{@render ...}` them:\\n\\n```\\n<script>\\n +++let { header, main, footer } = $props();+++\\n</script>\\n\\n<header>\\n ---<slot name=\\\"header\\\" />---\\n +++{@render header()}+++\\n</header>\\n\\n<main>\\n ---<slot name=\\\"main\\\" />---\\n +++{@render main()}+++\\n</main>\\n\\n<footer>\\n ---<slot name=\\\"footer\\\" />---\\n +++{@render footer()}+++\\n</footer>\\n```\", \"Passing data back up\": \"In Svelte 4, you would pass data to a `<slot />` and then retrieve it with `let:` in the parent component. In Svelte 5, snippets take on that responsibility:\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import List from './List.svelte';\\n</script>\\n\\n<List items={['one', 'two', 'three']} ---let:item--->\\n +++{#snippet item(text)}+++\\n <span>{text}</span>\\n +++{/snippet}+++\\n ---<span slot=\\\"empty\\\">No items yet</span>---\\n +++{#snippet empty()}\\n <span>No items yet</span>\\n {/snippet}+++\\n</List>\\n```\\n\\n```\\n<!--- file: List.svelte --->\\n<script>\\n let { items, +++item, empty+++ } = $props();\\n</script>\\n\\n{#if items.length}\\n <ul>\\n {#each items as entry}\\n <li>\\n ---<slot item={entry} />---\\n +++{@render item(entry)}+++\\n </li>\\n {/each}\\n </ul>\\n{:else}\\n ---<slot name=\\\"empty\\\" />---\\n +++{@render empty?.()}+++\\n{/if}\\n```\\n\\n['[!DETAILS] Why we did this\\\\nSlots were easy to get started with, but the more advanced the use case became, the more involved and confusing the syntax became:', ['the `let:` syntax was confusing to many people as it _creates_ a variable whereas all other `:` directives _receive_ a variable', \\\"the scope of a variable declared with `let:` wasn't clear. In the example above, it may look like you can use the `item` slot prop in the `empty` slot, but that's not true\\\", \\\"named slots had to be applied to an element using the `slot` attribute. Sometimes you didn't want to create an element, so we had to add the `<svelte:fragment>` API\\\", \\\"named slots could also be applied to a component, which changed the semantics of where `let:` directives are available (even today us maintainers often don't know which way around it works)\\\"], \\\"Snippets solve all of these problems by being much more readable and clear. At the same time they're more powerful as they allow you to define sections of UI that you can render _anywhere_, not just passing them as props to a component.\\\"]\"}, \"Migration script\": {\"run\": \"You may see that the migration script converts some of your `$:` statements to a `run` function which is imported from `svelte/legacy`. This happens if the migration script couldn't reliably migrate the statement to a `$derived` and concluded this is a side effect instead. In some cases this may be wrong and it's best to change this to use a `$derived` instead. In other cases it may be right, but since `$:` statements also ran on the server but `$effect` does not, it isn't safe to transform it as such. Instead, `run` is used as a stopgap solution. `run` mimics most of the characteristics of `$:`, in that it runs on the server once, and runs as `$effect.pre` on the client (`$effect.pre` runs _before_ changes are applied to the DOM; most likely you want to use `$effect` instead).\\n\\n```\\n<script>\\n ---import { run } from 'svelte/legacy';---\\n ---run(() => {---\\n +++$effect(() => {+++\\n // some side effect code\\n })\\n</script>\\n```\", \"Event modifiers\": \"Event modifiers are not applicable to event attributes (e.g. you can't do `onclick|preventDefault={...}`). Therefore, when migrating event directives to event attributes, we need a function-replacement for these modifiers. These are imported from `svelte/legacy`, and should be migrated away from in favor of e.g. just using `event.preventDefault()`.\\n\\n```\\n<script>\\n ---import { preventDefault } from 'svelte/legacy';---\\n</script>\\n\\n<button\\n onclick={---preventDefault---((event) => {\\n +++event.preventDefault();+++\\n // ...\\n })}\\n>\\n click me\\n</button>\\n```\", \"Things that are not automigrated\": \"The migration script does not convert `createEventDispatcher`. You need to adjust those parts manually. It doesn't do it because it's too risky because it could result in breakage for users of the component, which the migration script cannot find out.\\n\\nThe migration script does not convert `beforeUpdate/afterUpdate`. It doesn't do it because it's impossible to determine the actual intent of the code. As a rule of thumb you can often go with a combination of `$effect.pre` (runs at the same time as `beforeUpdate` did) and `tick` (imported from `svelte`, allows you to wait until changes are applied to the DOM and then do some work).\"}, \"Components are no longer classes\": {\"Server API changes\": \"Similarly, components no longer have a `render` method when compiled for server-side rendering. Instead, pass the function to `render` from `svelte/server`:\\n\\n```\\n+++import { render } from 'svelte/server';+++\\nimport App from './App.svelte';\\n\\n---const { html, head } = App.render({ props: { message: 'hello' }});---\\n+++const { html, head } = render(App, { props: { message: 'hello' }});+++\\n```\\n\\nIn Svelte 4, rendering a component to a string also returned the CSS of all components. In Svelte 5, this is no longer the case by default because most of the time you're using a tooling chain that takes care of it in other ways (like SvelteKit). If you need CSS to be returned from `render`, you can set the `css` compiler option to `'injected'` and it will add `<style>` elements to the `head`.\", \"Component typing changes\": \"The change from classes towards functions is also reflected in the typings: `SvelteComponent`, the base class from Svelte 4, is deprecated in favour of the new `Component` type which defines the function shape of a Svelte component. To manually define a component shape in a `d.ts` file:\\n\\n```\\nimport type { Component } from 'svelte';\\nexport declare const MyComponent: Component<{\\n foo: string;\\n}>;\\n```\\n\\nTo declare that a component of a certain type is required:\\n\\n```\\nimport { ComponentA, ComponentB } from 'component-library';\\n---import type { SvelteComponent } from 'svelte';---\\n+++import type { Component } from 'svelte';+++\\n\\n---let C: typeof SvelteComponent<{ foo: string }> = $state(---\\n+++let C: Component<{ foo: string }> = $state(+++\\n Math.random() ? ComponentA : ComponentB\\n);\\n```\\n\\nThe two utility types `ComponentEvents` and `ComponentType` are also deprecated. `ComponentEvents` is obsolete because events are defined as callback props now, and `ComponentType` is obsolete because the new `Component` type is the component type already (i.e. `ComponentType<SvelteComponent<{ prop: string }>>` is equivalent to `Component<{ prop: string }>`).\", \"bind:this changes\": \"Because components are no longer classes, using `bind:this` no longer returns a class instance with `$set`, `$on` and `$destroy` methods on it. It only returns the instance exports (`export function/const`) and, if you're using the `accessors` option, a getter/setter-pair for each property.\"}, \"`<svelte:component>` is no longer necessary\": {\"Dot notation indicates a component\": \"In Svelte 4, `<foo.bar>` would create an element with a tag name of `\\\"foo.bar\\\"`. In Svelte 5, `foo.bar` is treated as a component instead. This is particularly useful inside `each` blocks:\\n\\n```\\n{#each items as item}\\n <item.component {...item.props} />\\n{/each}\\n```\"}, \"Whitespace handling changed\": \"Previously, Svelte employed a very complicated algorithm to determine if whitespace should be kept or not. Svelte 5 simplifies this which makes it easier to reason about as a developer. The rules are:\\n\\n['Whitespace between nodes is collapsed to one whitespace', 'Whitespace at the start and end of a tag is removed completely', 'Certain exceptions apply such as keeping whitespace inside `pre` tags']\\n\\nAs before, you can disable whitespace trimming by setting the `preserveWhitespace` option in your compiler settings or on a per-component basis in `<svelte:options>`.\", \"Modern browser required\": \"Svelte 5 requires a modern browser (in other words, not Internet Explorer) for various reasons:\\n\\n['it uses [`Proxies`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy)', 'elements with `clientWidth`/`clientHeight`/`offsetWidth`/`offsetHeight` bindings use a [`ResizeObserver`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver) rather than a convoluted `<iframe>` hack', '`<input type=\\\"range\\\" bind:value={...} />` only uses an `input` event listener, rather than also listening for `change` events as a fallback']\\n\\nThe `legacy` compiler option, which generated bulkier but IE-friendly code, no longer exists.\", \"Changes to compiler options\": [\"The `false`/`true` (already deprecated previously) and the `\\\"none\\\"` values were removed as valid values from the `css` option\", \"The `legacy` option was repurposed\", \"The `hydratable` option has been removed. Svelte components are always hydratable now\", \"The `enableSourcemap` option has been removed. Source maps are always generated now, tooling can choose to ignore it\", \"The `tag` option was removed. Use `<svelte:options customElement=\\\"tag-name\\\" />` inside the component instead\", \"The `loopGuardTimeout`, `format`, `sveltePath`, `errorMode` and `varsReport` options were removed\"], \"The `children` prop is reserved\": \"Content inside component tags becomes a snippet prop called `children`. You cannot have a separate prop by that name.\", \"Breaking changes in runes mode\": {\"Bindings to component exports are not allowed\": \"Exports from runes mode components cannot be bound to directly. For example, having `export const foo = ...` in component `A` and then doing `<A bind:foo />` causes an error. Use `bind:this` instead \\u2014 `<A bind:this={a} />` \\u2014 and access the export as `a.foo`. This change makes things easier to reason about, as it enforces a clear separation between props and exports.\", \"Bindings need to be explicitly defined using `$bindable()`\": \"In Svelte 4 syntax, every property (declared via `export let`) is bindable, meaning you can `bind:` to it. In runes mode, properties are not bindable by default: you need to denote bindable props with the `$bindable` rune.\\n\\nIf a bindable property has a default value (e.g. `let { foo = $bindable('bar') } = $props();`), you need to pass a non-`undefined` value to that property if you're binding to it. This prevents ambiguous behavior \\u2014 the parent and child must have the same value \\u2014 and results in better performance (in Svelte 4, the default value was reflected back to the parent, resulting in wasteful additional render cycles).\", \"`accessors` option is ignored\": \"Setting the `accessors` option to `true` makes properties of a component directly accessible on the component instance.\\n\\n```\\n<svelte:options accessors={true} />\\n\\n<script>\\n // available via componentInstance.name\\n export let name;\\n</script>\\n```\\n\\nIn runes mode, properties are never accessible on the component instance. You can use component exports instead if you need to expose them.\\n\\n```\\n<script>\\n let { name } = $props();\\n // available via componentInstance.getName()\\n export const getName = () => name;\\n</script>\\n```\\n\\nAlternatively, if the place where they are instantiated is under your control, you can also make use of runes inside `.js/.ts` files by adjusting their ending to include `.svelte`, i.e. `.svelte.js` or `.svelte.ts`, and then use `$state`:\\n\\n```\\n+++import { mount } from 'svelte';+++\\nimport App from './App.svelte'\\n\\n---const app = new App({ target: document.getElementById(\\\"app\\\"), props: { foo: 'bar' } });\\napp.foo = 'baz'---\\n+++const props = $state({ foo: 'bar' });\\nconst app = mount(App, { target: document.getElementById(\\\"app\\\"), props });\\nprops.foo = 'baz';+++\\n```\", \"`immutable` option is ignored\": \"Setting the `immutable` option has no effect in runes mode. This concept is replaced by how `$state` and its variations work.\", \"Classes are no longer \\\"auto-reactive\\\"\": \"In Svelte 4, doing the following triggered reactivity:\\n\\n```\\n<script>\\n let foo = new Foo();\\n</script>\\n\\n<button on:click={() => (foo.value = 1)}>{foo.value}</button\\n>\\n```\\n\\nThis is because the Svelte compiler treated the assignment to `foo.value` as an instruction to update anything that referenced `foo`. In Svelte 5, reactivity is determined at runtime rather than compile time, so you should define `value` as a reactive `$state` field on the `Foo` class. Wrapping `new Foo()` with `$state(...)` will have no effect \\u2014 only vanilla objects and arrays are made deeply reactive.\", \"Touch and wheel events are passive\": \"When using `onwheel`, `onmousewheel`, `ontouchstart` and `ontouchmove` event attributes, the handlers are [passive](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#using_passive_listeners) to align with browser defaults. This greatly improves responsiveness by allowing the browser to scroll the document immediately, rather than waiting to see if the event handler calls `event.preventDefault()`.\\n\\nIn the very rare cases that you need to prevent these event defaults, you should use [`on`](/docs/svelte/svelte-events#on) instead (for example inside an action).\", \"Attribute/prop syntax is stricter\": \"In Svelte 4, complex attribute values needn't be quoted:\\n\\n<!-- prettier-ignore -->\\n```svelte\\n<Component prop=this{is}valid />\\n```\\n\\nThis is a footgun. In runes mode, if you want to concatenate stuff you must wrap the value in quotes:\\n\\n```\\n<Component prop=\\\"this{is}valid\\\" />\\n```\\n\\nNote that Svelte 5 will also warn if you have a single expression wrapped in quotes, like `answer=\\\"{42}\\\"` \\u2014 in Svelte 6, that will cause the value to be converted to a string, rather than passed as a number.\", \"HTML structure is stricter\": \"In Svelte 4, you were allowed to write HTML code that would be repaired by the browser when server-side rendering it. For example you could write this...\\n\\n```\\n<table>\\n <tr>\\n <td>hi</td>\\n </tr>\\n</table>\\n```\\n\\n... and the browser would auto-insert a `<tbody>` element:\\n\\n```\\n<table>\\n <tbody>\\n <tr>\\n <td>hi</td>\\n </tr>\\n </tbody>\\n</table>\\n```\\n\\nSvelte 5 is more strict about the HTML structure and will throw a compiler error in cases where the browser would repair the DOM.\"}, \"Other breaking changes\": {\"Stricter `@const` assignment validation\": \"Assignments to destructured parts of a `@const` declaration are no longer allowed. It was an oversight that this was ever allowed.\", \":is(...), :has(...), and :where(...) are scoped\": \"Previously, Svelte did not analyse selectors inside `:is(...)`, `:has(...)`, and `:where(...)`, effectively treating them as global. Svelte 5 analyses them in the context of the current component. Some selectors may now therefore be treated as unused if they were relying on this treatment. To fix this, use `:global(...)` inside the `:is(...)/:has(...)/:where(...)` selectors.\\n\\nWhen using Tailwind's `@apply` directive, add a `:global` selector to preserve rules that use Tailwind-generated `:is(...)` selectors:\\n\\n<!-- prettier-ignore -->\\n```css\\nmain +++:global+++ {\\n @apply bg-blue-100 dark:bg-blue-900;\\n}\\n```\", \"CSS hash position no longer deterministic\": \"Previously Svelte would always insert the CSS hash last. This is no longer guaranteed in Svelte 5. This is only breaking if you [have very weird css selectors](https://stackoverflow.com/questions/15670631/does-the-order-of-classes-listed-on-an-item-affect-the-css).\", \"Scoped CSS uses :where(...)\": \"To avoid issues caused by unpredictable specificity changes, scoped CSS selectors now use `:where(.svelte-xyz123)` selector modifiers alongside `.svelte-xyz123` (where `xyz123` is, as previously, a hash of the `<style>` contents). You can read more detail [here](https://github.com/sveltejs/svelte/pull/10443).\\n\\nIn the event that you need to support ancient browsers that don't implement `:where`, you can manually alter the emitted CSS, at the cost of unpredictable specificity changes:\\n\\n```\\n// @errors: 2552\\ncss = css.replace(/:where\\\\((.+?)\\\\)/, '$1');\\n```\", \"Error/warning codes have been renamed\": \"Error and warning codes have been renamed. Previously they used dashes to separate the words, they now use underscores (e.g. foo-bar becomes foo_bar). Additionally, a handful of codes have been reworded slightly.\", \"Reduced number of namespaces\": \"The number of valid namespaces you can pass to the compiler option `namespace` has been reduced to `html` (the default), `mathml` and `svg`.\\n\\nThe `foreign` namespace was only useful for Svelte Native, which we're planning to support differently in a 5.x minor.\", \"beforeUpdate/afterUpdate changes\": \"`beforeUpdate` no longer runs twice on initial render if it modifies a variable referenced in the template.\\n\\n`afterUpdate` callbacks in a parent component will now run after `afterUpdate` callbacks in any child components.\\n\\n`beforeUpdate/afterUpdate` no longer run when the component contains a `<slot>` and its content is updated.\\n\\nBoth functions are disallowed in runes mode \\u2014 use `$effect.pre(...)` and `$effect(...)` instead.\", \"`contenteditable` behavior change\": \"If you have a `contenteditable` node with a corresponding binding _and_ a reactive value inside it (example: `<div contenteditable=true bind:textContent>count is {count}</div>`), then the value inside the contenteditable will not be updated by updates to `count` because the binding takes full control over the content immediately and it should only be updated through it.\", \"`oneventname` attributes no longer accept string values\": \"In Svelte 4, it was possible to specify event attributes on HTML elements as a string:\\n\\n```\\n<button onclick=\\\"alert('hello')\\\">...</button>\\n```\\n\\nThis is not recommended, and is no longer possible in Svelte 5, where properties like `onclick` replace `on:click` as the mechanism for adding event handlers.\", \"`null` and `undefined` become the empty string\": \"In Svelte 4, `null` and `undefined` were printed as the corresponding string. In 99 out of 100 cases you want this to become the empty string instead, which is also what most other frameworks out there do. Therefore, in Svelte 5, `null` and `undefined` become the empty string.\", \"`bind:files` values can only be `null`, `undefined` or `FileList`\": \"`bind:files` is now a two-way binding. As such, when setting a value, it needs to be either falsy (`null` or `undefined`) or of type `FileList`.\", \"Bindings now react to form resets\": \"Previously, bindings did not take into account `reset` event of forms, and therefore values could get out of sync with the DOM. Svelte 5 fixes this by placing a `reset` listener on the document and invoking bindings where necessary.\", \"`walk` no longer exported\": \"`svelte/compiler` reexported `walk` from `estree-walker` for convenience. This is no longer true in Svelte 5, import it directly from that package instead in case you need it.\", \"Content inside `svelte:options` is forbidden\": \"In Svelte 4 you could have content inside a `<svelte:options />` tag. It was ignored, but you could write something in there. In Svelte 5, content inside that tag is a compiler error.\", \"`<slot>` elements in declarative shadow roots are preserved\": \"Svelte 4 replaced the `<slot />` tag in all places with its own version of slots. Svelte 5 preserves them in the case they are a child of a `<template shadowrootmode=\\\"...\\\">` element.\", \"`<svelte:element>` tag must be an expression\": \"In Svelte 4, `<svelte:element this=\\\"div\\\">` is valid code. This makes little sense \\u2014 you should just do `<div>`. In the vanishingly rare case that you _do_ need to use a literal value for some reason, you can do this:\\n\\n```\\n<svelte:element this=+++{+++\\\"div\\\"+++}+++>\\n```\\n\\nNote that whereas Svelte 4 would treat `<svelte:element this=\\\"input\\\">` (for example) identically to `<input>` for the purposes of determining which `bind:` directives could be applied, Svelte 5 does not.\", \"`mount` plays transitions by default\": \"The `mount` function used to render a component tree plays transitions by default unless the `intro` option is set to `false`. This is different from legacy class components which, when manually instantiated, didn't play transitions by default.\", \"`<img src={...}>` and `{@html ...}` hydration mismatches are not repaired\": \"In Svelte 4, if the value of a `src` attribute or `{@html ...}` tag differ between server and client (a.k.a. a hydration mismatch), the mismatch is repaired. This is very costly: setting a `src` attribute (even if it evaluates to the same thing) causes images and iframes to be reloaded, and reinserting a large blob of HTML is slow.\\n\\nSince these mismatches are extremely rare, Svelte 5 assumes that the values are unchanged, but in development will warn you if they are not. To force an update you can do something like this:\\n\\n```\\n<script>\\n let { markup, src } = $props();\\n\\n if (typeof window !== 'undefined') {\\n // stash the values...\\n const initial = { markup, src };\\n\\n // unset them...\\n markup = src = undefined;\\n\\n $effect(() => {\\n // ...and reset after we've mounted\\n markup = initial.markup;\\n src = initial.src;\\n });\\n }\\n</script>\\n\\n{@html markup}\\n<img {src} />\\n```\", \"Hydration works differently\": \"Svelte 5 makes use of comments during server-side rendering which are used for more robust and efficient hydration on the client. You therefore should not remove comments from your HTML output if you intend to hydrate it, and if you manually authored HTML to be hydrated by a Svelte component, you need to adjust that HTML to include said comments at the correct positions.\", \"`onevent` attributes are delegated\": \"Event attributes replace event directives: Instead of `on:click={handler}` you write `onclick={handler}`. For backwards compatibility the `on:event` syntax is still supported and behaves the same as in Svelte 4. Some of the `onevent` attributes however are delegated, which means you need to take care to not stop event propagation on those manually, as they then might never reach the listener for this event type at the root.\", \"`--style-props` uses a different element\": \"Svelte 5 uses an extra `<svelte-css-wrapper>` element instead of a `<div>` to wrap the component when using CSS custom properties.\\n\\n<!-- TODO in final docs, add link to corresponding section for more details -->\"}}, \"metadata\": {\"title\": \"Svelte 5 migration guide\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"Frequently asked questions\", \"description\": null, \"content\": {\"I'm new to Svelte. Where should I start?\": \"We think the best way to get started is playing through the interactive [tutorial](/tutorial). Each step there is mainly focused on one specific aspect and is easy to follow. You'll be editing and running real Svelte components right in your browser.\\n\\nFive to ten minutes should be enough to get you up and running. An hour and a half should get you through the entire tutorial.\", \"Where can I get support?\": \"If your question is about certain syntax, the [reference docs](/docs/svelte) are a good place to start.\\n\\nStack Overflow is a popular forum to ask code-level questions or if you\\u2019re stuck with a specific error. Read through the existing questions tagged with [Svelte](https://stackoverflow.com/questions/tagged/svelte+or+svelte-3) or [ask your own](https://stackoverflow.com/questions/ask?tags=svelte)!\\n\\nThere are online forums and chats which are a great place for discussion about best practices, application architecture or just to get to know fellow Svelte users. [Our Discord](/chat) or [the Reddit channel](https://www.reddit.com/r/sveltejs/) are examples of that. If you have an answerable code-level question, Stack Overflow is usually a better fit.\", \"Are there any third-party resources?\": \"Svelte Society maintains a [list of books and videos](https://sveltesociety.dev/resources).\", \"How can I get VS Code to syntax-highlight my .svelte files?\": \"There is an [official VS Code extension for Svelte](https://marketplace.visualstudio.com/items?itemName=svelte.svelte-vscode).\", \"Is there a tool to automatically format my .svelte files?\": \"You can use prettier with the [prettier-plugin-svelte](https://www.npmjs.com/package/prettier-plugin-svelte) plugin.\", \"How do I document my components?\": \"In editors which use the Svelte Language Server you can document Components, functions and exports using specially formatted comments.\\n\\n```\\n<script>\\n /** What should we call the user? */\\n export let name = 'world';\\n</script>\\n\\n<!--\\n@component\\nHere's some documentation for this component.\\nIt will show up on hover.\\n\\n- You can use markdown here.\\n- You can also use code blocks here.\\n- Usage:\\n ```svelte\\n <main name=\\\"Arethra\\\">\\n ```\\n-->\\n<main>\\n <h1>\\n Hello, {name}\\n </h1>\\n</main>\\n```\\n\\nNote: The `@component` is necessary in the HTML comment which describes your component.\", \"Does Svelte scale?\": \"There will be a blog post about this eventually, but in the meantime, check out [this issue](https://github.com/sveltejs/svelte/issues/2546).\", \"Is there a UI component library?\": \"There are several UI component libraries as well as standalone components. Find them under the [design systems section of the components page](https://sveltesociety.dev/packages?category=design-system) on the Svelte Society website.\", \"How do I test Svelte apps?\": \"How your application is structured and where logic is defined will determine the best way to ensure it is properly tested. It is important to note that not all logic belongs within a component - this includes concerns such as data transformation, cross-component state management, and logging, among others. Remember that the Svelte library has its own test suite, so you do not need to write tests to validate implementation details provided by Svelte.\\n\\nA Svelte application will typically have three different types of tests: Unit, Component, and End-to-End (E2E).\\n\\n_Unit Tests_: Focus on testing business logic in isolation. Often this is validating individual functions and edge cases. By minimizing the surface area of these tests they can be kept lean and fast, and by extracting as much logic as possible from your Svelte components more of your application can be covered using them. When creating a new SvelteKit project, you will be asked whether you would like to setup [Vitest](https://vitest.dev/) for unit testing. There are a number of other test runners that could be used as well.\\n\\n_Component Tests_: Validating that a Svelte component mounts and interacts as expected throughout its lifecycle requires a tool that provides a Document Object Model (DOM). Components can be compiled (since Svelte is a compiler and not a normal library) and mounted to allow asserting against element structure, listeners, state, and all the other capabilities provided by a Svelte component. Tools for component testing range from an in-memory implementation like jsdom paired with a test runner like [Vitest](https://vitest.dev/) to solutions that leverage an actual browser to provide a visual testing capability such as [Playwright](https://playwright.dev/docs/test-components) or [Cypress](https://www.cypress.io/).\\n\\n_End-to-End Tests_: To ensure your users are able to interact with your application it is necessary to test it as a whole in a manner as close to production as possible. This is done by writing end-to-end (E2E) tests which load and interact with a deployed version of your application in order to simulate how the user will interact with your application. When creating a new SvelteKit project, you will be asked whether you would like to setup [Playwright](https://playwright.dev/) for end-to-end testing. There are many other E2E test libraries available for use as well.\\n\\nSome resources for getting started with testing:\\n\\n['[Svelte docs on testing](/docs/svelte/testing)', '[Setup Vitest using the Svelte CLI](/docs/cli/vitest)', '[Svelte Testing Library](https://testing-library.com/docs/svelte-testing-library/example/)', '[Svelte Component Testing in Cypress](https://docs.cypress.io/guides/component-testing/svelte/overview)', '[Example using uvu test runner with JSDOM](https://github.com/lukeed/uvu/tree/master/examples/svelte)', '[Test Svelte components using Vitest & Playwright](https://davipon.hashnode.dev/test-svelte-component-using-vitest-playwright)', '[Component testing with WebdriverIO](https://webdriver.io/docs/component-testing/svelte)']\", \"Is there a router?\": \"The official routing library is [SvelteKit](/docs/kit). SvelteKit provides a filesystem router, server-side rendering (SSR), and hot module reloading (HMR) in one easy-to-use package. It shares similarities with Next.js for React.\\n\\nHowever, you can use any router library. A lot of people use [page.js](https://github.com/visionmedia/page.js). There's also [navaid](https://github.com/lukeed/navaid), which is very similar. And [universal-router](https://github.com/kriasoft/universal-router), which is isomorphic with child routes, but without built-in history support.\\n\\nIf you prefer a declarative HTML approach, there's the isomorphic [svelte-routing](https://github.com/EmilTholin/svelte-routing) library and a fork of it called [svelte-navigator](https://github.com/mefechoel/svelte-navigator) containing some additional functionality.\\n\\nIf you need hash-based routing on the client side, check out the [hash option](https://svelte.dev/docs/kit/configuration#router) in SvelteKit, [svelte-spa-router](https://github.com/ItalyPaleAle/svelte-spa-router), or [abstract-state-router](https://github.com/TehShrike/abstract-state-router/).\\n\\n[Routify](https://routify.dev) is another filesystem-based router, similar to SvelteKit's router. Version 3 supports Svelte's native SSR.\\n\\nYou can see a [community-maintained list of routers on sveltesociety.dev](https://sveltesociety.dev/packages?category=routers).\", \"How do I write a mobile app with Svelte?\": \"While most mobile apps are written without using JavaScript, if you'd like to leverage your existing Svelte components and knowledge of Svelte when building mobile apps, you can turn a [SvelteKit SPA](https://kit.svelte.dev/docs/single-page-apps) into a mobile app with [Tauri](https://v2.tauri.app/start/frontend/sveltekit/) or [Capacitor](https://capacitorjs.com/solution/svelte). Mobile features like the camera, geolocation, and push notifications are available via plugins for both platforms.\\n\\nSvelte Native was an option available for Svelte 4, but note that Svelte 5 does not currently support it. Svelte Native lets you write NativeScript apps using Svelte components that contain [NativeScript UI components](https://docs.nativescript.org/ui/) rather than DOM elements, which may be familiar for users coming from React Native.\", \"Can I tell Svelte not to remove my unused styles?\": \"No. Svelte removes the styles from the component and warns you about them in order to prevent issues that would otherwise arise.\\n\\nSvelte's component style scoping works by generating a class unique to the given component, adding it to the relevant elements in the component that are under Svelte's control, and then adding it to each of the selectors in that component's styles. When the compiler can't see what elements a style selector applies to, there would be two bad options for keeping it:\\n\\n[\\\"If it keeps the selector and adds the scoping class to it, the selector will likely not match the expected elements in the component, and they definitely won't if they were created by a child component or `{@html ...}`.\\\", 'If it keeps the selector without adding the scoping class to it, the given style will become a global style, affecting your entire page.']\\n\\nIf you need to style something that Svelte can't identify at compile time, you will need to explicitly opt into global styles by using `:global(...)`. But also keep in mind that you can wrap `:global(...)` around only part of a selector. `.foo :global(.bar) { ... }` will style any `.bar` elements that appear within the component's `.foo` elements. As long as there's some parent element in the current component to start from, partially global selectors like this will almost always be able to get you what you want.\", \"Is Svelte v2 still available?\": \"New features aren't being added to it, and bugs will probably only be fixed if they are extremely nasty or present some sort of security vulnerability.\\n\\nThe documentation is still available [here](https://v2.svelte.dev/guide).\", \"How do I do hot module reloading?\": \"We recommend using [SvelteKit](/docs/kit), which supports HMR out of the box and is built on top of [Vite](https://vitejs.dev/) and [svelte-hmr](https://github.com/sveltejs/svelte-hmr). There are also community plugins for [rollup](https://github.com/rixo/rollup-plugin-svelte-hot) and [webpack](https://github.com/sveltejs/svelte-loader).\"}, \"metadata\": {\"title\": \"Frequently asked questions\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}, {\"title\": \"Misc\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Misc\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 7, \\\"subpages\\\", 6]\"}], \"path\": \"[\\\"subpages\\\", 7]\"}, {\"title\": \"98 Reference\", \"description\": \"Documentation section: 98-reference\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/98-reference\"}, \"subpages\": [{\"title\": \"svelte\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte\"]]}, \"metadata\": {\"title\": \"svelte\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 0]\"}, {\"title\": \"svelte/action\", \"description\": null, \"content\": {\"root\": [\"This module provides types for [actions](use), which have been superseded by [attachments](@attach).\", [\"MODULE: svelte/action\"]]}, \"metadata\": {\"title\": \"svelte/action\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 1]\"}, {\"title\": \"svelte/animate\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/animate\"]]}, \"metadata\": {\"title\": \"svelte/animate\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 2]\"}, {\"title\": \"svelte/attachments\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/attachments\"]]}, \"metadata\": {\"title\": \"svelte/attachments\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 3]\"}, {\"title\": \"svelte/compiler\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/compiler\"]]}, \"metadata\": {\"title\": \"svelte/compiler\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 4]\"}, {\"title\": \"svelte/easing\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/easing\"]]}, \"metadata\": {\"title\": \"svelte/easing\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 5]\"}, {\"title\": \"svelte/events\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/events\"]]}, \"metadata\": {\"title\": \"svelte/events\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 6]\"}, {\"title\": \"svelte/legacy\", \"description\": null, \"content\": {\"root\": [\"This module provides various functions for use during the migration, since some features can't be replaced one to one with new features. All imports are marked as deprecated and should be migrated away from over time.\", [\"MODULE: svelte/legacy\"]]}, \"metadata\": {\"title\": \"svelte/legacy\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 7]\"}, {\"title\": \"svelte/motion\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/motion\"]]}, \"metadata\": {\"title\": \"svelte/motion\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 8]\"}, {\"title\": \"svelte/reactivity/window\", \"description\": null, \"content\": {\"root\": [\"This module exports reactive versions of various `window` values, each of which has a reactive `current` property that you can reference in reactive contexts (templates, [deriveds]($derived) and [effects]($effect)) without using [`<svelte:window>`](svelte-window) bindings or manually creating your own event listeners.\", \"```\\n<script>\\n import { innerWidth, innerHeight } from 'svelte/reactivity/window';\\n</script>\\n\\n<p>{innerWidth.current}x{innerHeight.current}</p>\\n```\", [\"MODULE: svelte/reactivity/window\"]]}, \"metadata\": {\"title\": \"svelte/reactivity/window\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 9]\"}, {\"title\": \"svelte/reactivity\", \"description\": null, \"content\": {\"root\": [\"Svelte provides reactive versions of various built-ins like [`Map`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map), [`Set`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set) and [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) that can be used just like their native counterparts, as well as a handful of additional utilities for handling reactivity.\", [\"MODULE: svelte/reactivity\"]]}, \"metadata\": {\"title\": \"svelte/reactivity\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 10]\"}, {\"title\": \"svelte/server\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/server\"]]}, \"metadata\": {\"title\": \"svelte/server\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 11]\"}, {\"title\": \"svelte/store\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/store\"]]}, \"metadata\": {\"title\": \"svelte/store\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 12]\"}, {\"title\": \"svelte/transition\", \"description\": null, \"content\": {\"root\": [[\"MODULE: svelte/transition\"]]}, \"metadata\": {\"title\": \"svelte/transition\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 13]\"}, {\"title\": \"Compiler errors\", \"description\": null, \"content\": {\"root\": [\"@include .generated/compile-errors.md\"]}, \"metadata\": {\"title\": \"Compiler errors\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 14]\"}, {\"title\": \"Compiler warnings\", \"description\": null, \"content\": {\"root\": [\"Svelte warns you at compile time if it catches potential mistakes, such as writing inaccessible markup.\", \"Some warnings may be incorrect in your concrete use case. You can disable such false positives by placing a `<!-- svelte-ignore <code> -->` comment above the line that causes the warning. Example:\", \"```\\n<!-- svelte-ignore a11y_autofocus -->\\n<input autofocus />\\n```\", \"You can list multiple rules in a single comment (separated by commas), and add an explanatory note (in parentheses) alongside them:\", \"```\\n<!-- svelte-ignore a11y_click_events_have_key_events, a11y_no_static_element_interactions (because of reasons) -->\\n<div onclick>...</div>\\n```\", \"@include .generated/compile-warnings.md\"]}, \"metadata\": {\"title\": \"Compiler warnings\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 15]\"}, {\"title\": \"Runtime errors\", \"description\": null, \"content\": {\"Client errors\": \"@include .generated/client-errors.md\", \"Server errors\": \"@include .generated/server-errors.md\", \"Shared errors\": \"@include .generated/shared-errors.md\"}, \"metadata\": {\"title\": \"Runtime errors\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 16]\"}, {\"title\": \"Runtime warnings\", \"description\": null, \"content\": {\"Client warnings\": \"@include .generated/client-warnings.md\", \"Shared warnings\": \"@include .generated/shared-warnings.md\"}, \"metadata\": {\"title\": \"Runtime warnings\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 17]\"}, {\"title\": \"Reference\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Reference\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 8, \\\"subpages\\\", 18]\"}], \"path\": \"[\\\"subpages\\\", 8]\"}, {\"title\": \"99 Legacy\", \"description\": \"Documentation section: 99-legacy\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs/99-legacy\"}, \"subpages\": [{\"title\": \"Overview\", \"description\": null, \"content\": {\"root\": [\"Svelte 5 introduced some significant changes to Svelte's API, including [runes](what-are-runes), [snippets](snippet) and event attributes. As a result, some Svelte 3/4 features are deprecated (though supported for now, unless otherwise specified) and will eventually be removed. We recommend that you incrementally [migrate your existing code](v5-migration-guide).\", \"The following pages document these features for\", [\"people still using Svelte 3/4\", \"people using Svelte 5, but with components that haven't yet been migrated\"], \"Since Svelte 3/4 syntax still works in Svelte 5, we will distinguish between _legacy mode_ and _runes mode_. Once a component is in runes mode (which you can opt into by using runes, or by explicitly setting the `runes: true` compiler option), legacy mode features are no longer available.\", \"If you're exclusively interested in the Svelte 3/4 syntax, you can browse its documentation at [v4.svelte.dev](https://v4.svelte.dev).\"]}, \"metadata\": {\"title\": \"Overview\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 0]\"}, {\"title\": \"Reactive let/var declarations\", \"description\": null, \"content\": {\"root\": [\"In runes mode, reactive state is explicitly declared with the [`$state` rune]($state).\", \"In legacy mode, variables declared at the top level of a component are automatically considered _reactive_. Reassigning or mutating these variables (`count += 1` or `object.x = y`) will cause the UI to update.\", \"```\\n<script>\\n let count = 0;\\n</script>\\n\\n<button on:click={() => count += 1}>\\n clicks: {count}\\n</button>\\n```\", \"Because Svelte's legacy mode reactivity is based on _assignments_, using array methods like `.push()` and `.splice()` won't automatically trigger updates. A subsequent assignment is required to 'tell' the compiler to update the UI:\", \"```\\n<script>\\n let numbers = [1, 2, 3, 4];\\n\\n function addNumber() {\\n // this method call does not trigger an update\\n numbers.push(numbers.length + 1);\\n\\n // this assignment will update anything\\n // that depends on `numbers`\\n numbers = numbers;\\n }\\n</script>\\n```\"]}, \"metadata\": {\"title\": \"Reactive let/var declarations\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 1]\"}, {\"title\": \"02 Legacy Reactive Assignments\", \"description\": null, \"content\": {\"Understanding dependencies\": \"The dependencies of a `$:` statement are determined at compile time \\u2014 they are whichever variables are referenced (but not assigned to) inside the statement.\\n\\nIn other words, a statement like this will _not_ re-run when `count` changes, because the compiler cannot 'see' the dependency:\\n\\n```\\n// @noErrors\\nlet count = 0;\\nlet double = () => count * 2;\\n\\n$: doubled = double();\\n```\\n\\nSimilarly, topological ordering will fail if dependencies are referenced indirectly: `z` will never update, because `y` is not considered 'dirty' when the update occurs. Moving `$: z = y` below `$: setY(x)` will fix it:\\n\\n```\\n<script>\\n let x = 0;\\n let y = 0;\\n\\n $: z = y;\\n $: setY(x);\\n\\n function setY(value) {\\n y = value;\\n }\\n</script>\\n```\", \"Browser-only code\": \"Reactive statements run during server-side rendering as well as in the browser. This means that any code that should only run in the browser must be wrapped in an `if` block:\\n\\n```\\n// @noErrors\\n$: if (browser) {\\n document.title = title;\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 2]\"}, {\"title\": \"export let\", \"description\": null, \"content\": {\"Component exports\": \"An exported `const`, `class` or `function` declaration is _not_ considered a prop \\u2014 instead, it becomes part of the component's API:\\n\\n```\\n<!--- file: Greeter.svelte--->\\n<script>\\n export function greet(name) {\\n alert(`hello ${name}!`);\\n }\\n</script>\\n```\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Greeter from './Greeter.svelte';\\n\\n let greeter;\\n</script>\\n\\n<Greeter bind:this={greeter} />\\n\\n<button on:click={() => greeter.greet('world')}>\\n greet\\n</button>\\n```\", \"Renaming props\": \"The `export` keyword can appear separately from the declaration. This is useful for renaming props, for example in the case of a reserved word:\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n /** @type {string} */\\n let className;\\n\\n // creates a `class` property, even\\n // though it is a reserved word\\n export { className as class };\\n</script>\\n```\"}, \"metadata\": {\"title\": \"export let\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 3]\"}, {\"title\": \"$$props and $$restProps\", \"description\": null, \"content\": {\"root\": [\"In runes mode, getting an object containing all the props that were passed in is easy, using the [`$props`]($props) rune.\", \"In legacy mode, we use `$$props` and `$$restProps`:\", [\"`$$props` contains all the props that were passed in, including ones that are not individually declared with the `export` keyword\", \"`$$restProps` contains all the props that were passed in _except_ the ones that were individually declared\"], \"For example, a `<Button>` component might need to pass along all its props to its own `<button>` element, except the `variant` prop:\", \"```\\n<script>\\n export let variant;\\n</script>\\n\\n<button {...$$restProps} class=\\\"variant-{variant} {$$props.class ?? ''}\\\">\\n click me\\n</button>\\n\\n<style>\\n .variant-danger {\\n background: red;\\n }\\n</style>\\n```\", \"In Svelte 3/4 using `$$props` and `$$restProps` creates a modest performance penalty, so they should only be used when needed.\"]}, \"metadata\": {\"title\": \"$$props and $$restProps\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 4]\"}, {\"title\": \"10 Legacy On\", \"description\": null, \"content\": {\"Component events\": \"Components can dispatch events by creating a _dispatcher_ when they are initialised:\\n\\n```\\n<!--- file: Stepper.svelte -->\\n<script>\\n import { createEventDispatcher } from 'svelte';\\n const dispatch = createEventDispatcher();\\n</script>\\n\\n<button on:click={() => dispatch('decrement')}>decrement</button>\\n<button on:click={() => dispatch('increment')}>increment</button>\\n```\\n\\n`dispatch` creates a [`CustomEvent`](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent). If a second argument is provided, it becomes the `detail` property of the event object.\\n\\nA consumer of this component can listen for the dispatched events:\\n\\n```\\n<script>\\n import Stepper from './Stepper.svelte';\\n\\n let n = 0;\\n</script>\\n\\n<Stepper\\n on:decrement={() => n -= 1}\\n on:increment={() => n += 1}\\n/>\\n\\n<p>n: {n}</p>\\n```\\n\\nComponent events do not bubble \\u2014 a parent component can only listen for events on its immediate children.\\n\\nOther than `once`, modifiers are not valid on component event handlers.\\n\\n[\\\"[!NOTE]\\\\nIf you're planning an eventual migration to Svelte 5, use callback props instead. This will make upgrading easier as `createEventDispatcher` is deprecated:\\\", '```\\\\n<!--- file: Stepper.svelte --->\\\\n<script>\\\\n export let decrement;\\\\n export let increment;\\\\n</script>\\\\n\\\\n<button on:click={decrement}>decrement</button>\\\\n<button on:click={increment}>increment</button>\\\\n```']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 5]\"}, {\"title\": \"<slot>\", \"description\": null, \"content\": {\"Named slots\": \"A component can have _named_ slots in addition to the default slot. On the parent side, add a `slot=\\\"...\\\"` attribute to an element, component or [`<svelte:fragment>`](legacy-svelte-fragment) directly inside the component tags.\\n\\n```\\n<!--- file: App.svelte --->\\n<script>\\n import Modal from './Modal.svelte';\\n\\n let open = true;\\n</script>\\n\\n{#if open}\\n <Modal>\\n This is some slotted content\\n\\n +++<div slot=\\\"buttons\\\">+++\\n <button on:click={() => open = false}>\\n close\\n </button>\\n +++</div>+++\\n </Modal>\\n{/if}\\n```\\n\\nOn the child side, add a corresponding `<slot name=\\\"...\\\">` element:\\n\\n```\\n<!--- file: Modal.svelte --->\\n<div class=\\\"modal\\\">\\n <slot></slot>\\n <hr>\\n +++<slot name=\\\"buttons\\\"></slot>+++\\n</div>\\n```\", \"Fallback content\": \"If no slotted content is provided, a component can define fallback content by putting it inside the `<slot>` element:\\n\\n```\\n<slot>\\n This will be rendered if no slotted content is provided\\n</slot>\\n```\", \"Passing data to slotted content\": \"Slots can be rendered zero or more times and can pass values _back_ to the parent using props. The parent exposes the values to the slot template using the `let:` directive.\\n\\n```\\n<!--- file: FancyList.svelte --->\\n<ul>\\n {#each items as data}\\n <li class=\\\"fancy\\\">\\n <!-- 'item' here... -->\\n <slot item={process(data)} />\\n </li>\\n {/each}\\n</ul>\\n```\\n\\n```\\n<!--- file: App.svelte --->\\n<!-- ...corresponds to 'item' here: -->\\n<FancyList {items} let:item={processed}>\\n <div>{processed.text}</div>\\n</FancyList>\\n```\\n\\nThe usual shorthand rules apply \\u2014 `let:item` is equivalent to `let:item={item}`, and `<slot {item}>` is equivalent to `<slot item={item}>`.\\n\\nNamed slots can also expose values. The `let:` directive goes on the element with the `slot` attribute.\\n\\n```\\n<!--- file: FancyList.svelte --->\\n<ul>\\n {#each items as item}\\n <li class=\\\"fancy\\\">\\n <slot name=\\\"item\\\" item={process(data)} />\\n </li>\\n {/each}\\n</ul>\\n\\n<slot name=\\\"footer\\\" />\\n```\\n\\n```\\n<!--- file: App.svelte --->\\n<FancyList {items}>\\n <div slot=\\\"item\\\" let:item>{item.text}</div>\\n <p slot=\\\"footer\\\">Copyright (c) 2019 Svelte Industries</p>\\n</FancyList>\\n```\"}, \"metadata\": {\"title\": \"<slot>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 6]\"}, {\"title\": \"$$slots\", \"description\": null, \"content\": {\"root\": [\"In runes mode, we know which [snippets](snippet) were provided to a component, as they're just normal props.\", \"In legacy mode, the way to know if content was provided for a given slot is with the `$$slots` object, whose keys are the names of the slots passed into the component by the parent.\", \"```\\n<!--- file: Card.svelte --->\\n<div>\\n <slot name=\\\"title\\\" />\\n {#if $$slots.description}\\n <!-- This <hr> and slot will render only if `slot=\\\"description\\\"` is provided. -->\\n <hr />\\n <slot name=\\\"description\\\" />\\n {/if}\\n</div>\\n```\", \"```\\n<!--- file: App.svelte --->\\n<Card>\\n <h1 slot=\\\"title\\\">Blog Post Title</h1>\\n <!-- No slot named \\\"description\\\" was provided so the optional slot will not be rendered. -->\\n</Card>\\n```\"]}, \"metadata\": {\"title\": \"$$slots\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 7]\"}, {\"title\": \"<svelte:fragment>\", \"description\": null, \"content\": {\"root\": [\"The `<svelte:fragment>` element allows you to place content in a [named slot](legacy-slots) without wrapping it in a container DOM element. This keeps the flow layout of your document intact.\", \"```\\n<!--- file: Widget.svelte --->\\n<div>\\n <slot name=\\\"header\\\">No header was provided</slot>\\n <p>Some content between header and footer</p>\\n <slot name=\\\"footer\\\" />\\n</div>\\n```\", \"```\\n<!--- file: App.svelte --->\\n<script>\\n import Widget from './Widget.svelte';\\n</script>\\n\\n<Widget>\\n <h1 slot=\\\"header\\\">Hello</h1>\\n <svelte:fragment slot=\\\"footer\\\">\\n <p>All rights reserved.</p>\\n <p>Copyright (c) 2019 Svelte Industries</p>\\n </svelte:fragment>\\n</Widget>\\n```\", [\"[!NOTE]\\nIn Svelte 5+, this concept is obsolete, as snippets don't create a wrapping element\"]]}, \"metadata\": {\"title\": \"<svelte:fragment>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 8]\"}, {\"title\": \"<svelte:component>\", \"description\": null, \"content\": {\"root\": [\"In runes mode, `<MyComponent>` will re-render if the value of `MyComponent` changes. See the [Svelte 5 migration guide](/docs/svelte/v5-migration-guide#svelte:component-is-no-longer-necessary) for an example.\", \"In legacy mode, it won't \\u2014 we must use `<svelte:component>`, which destroys and recreates the component instance when the value of its `this` expression changes:\", \"```\\n<svelte:component this={MyComponent} />\\n```\", \"If `this` is falsy, no component is rendered.\"]}, \"metadata\": {\"title\": \"<svelte:component>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 9]\"}, {\"title\": \"<svelte:self>\", \"description\": null, \"content\": {\"root\": [\"The `<svelte:self>` element allows a component to include itself, recursively.\", \"It cannot appear at the top level of your markup; it must be inside an if or each block or passed to a component's slot to prevent an infinite loop.\", \"```\\n<script>\\n export let count;\\n</script>\\n\\n{#if count > 0}\\n <p>counting down... {count}</p>\\n <svelte:self count={count - 1} />\\n{:else}\\n <p>lift-off!</p>\\n{/if}\\n```\", [\"[!NOTE]\\nThis concept is obsolete, as components can import themselves:\", \"```\\n<!--- file: App.svelte --->\\n<script>\\n import Self from './App.svelte'\\n export let count;\\n</script>\\n\\n{#if count > 0}\\n <p>counting down... {count}</p>\\n <Self count={count - 1} />\\n{:else}\\n <p>lift-off!</p>\\n{/if}\\n```\"]]}, \"metadata\": {\"title\": \"<svelte:self>\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 10]\"}, {\"title\": \"Imperative component API\", \"description\": null, \"content\": {\"Creating a component\": \"```\\n// @noErrors\\nconst component = new Component(options);\\n```\\n\\nA client-side component \\u2014 that is, a component compiled with `generate: 'dom'` (or the `generate` option left unspecified) is a JavaScript class.\\n\\n```\\n// @noErrors\\nimport App from './App.svelte';\\n\\nconst app = new App({\\n target: document.body,\\n props: {\\n // assuming App.svelte contains something like\\n // `export let answer`:\\n answer: 42\\n }\\n});\\n```\\n\\nThe following initialisation options can be provided:\\n\\n| option | default | description |\\n| --------- | ----------- | ---------------------------------------------------------------------------------------------------- |\\n| `target` | **none** | An `HTMLElement` or `ShadowRoot` to render to. This option is required |\\n| `anchor` | `null` | A child of `target` to render the component immediately before |\\n| `props` | `{}` | An object of properties to supply to the component |\\n| `context` | `new Map()` | A `Map` of root-level context key-value pairs to supply to the component |\\n| `hydrate` | `false` | See below |\\n| `intro` | `false` | If `true`, will play transitions on initial render, rather than waiting for subsequent state changes |\\n\\nExisting children of `target` are left where they are.\\n\\nThe `hydrate` option instructs Svelte to upgrade existing DOM (usually from server-side rendering) rather than creating new elements. It will only work if the component was compiled with the [`hydratable: true` option](/docs/svelte-compiler#compile). Hydration of `<head>` elements only works properly if the server-side rendering code was also compiled with `hydratable: true`, which adds a marker to each element in the `<head>` so that the component knows which elements it's responsible for removing during hydration.\\n\\nWhereas children of `target` are normally left alone, `hydrate: true` will cause any children to be removed. For that reason, the `anchor` option cannot be used alongside `hydrate: true`.\\n\\nThe existing DOM doesn't need to match the component \\u2014 Svelte will 'repair' the DOM as it goes.\\n\\n```\\n/// file: index.js\\n// @noErrors\\nimport App from './App.svelte';\\n\\nconst app = new App({\\n target: document.querySelector('#server-rendered-html'),\\n hydrate: true\\n});\\n```\\n\\n['[!NOTE]\\\\nIn Svelte 5+, use [`mount`](svelte#mount) instead']\", \"`$set`\": \"```\\n// @noErrors\\ncomponent.$set(props);\\n```\\n\\nProgrammatically sets props on an instance. `component.$set({ x: 1 })` is equivalent to `x = 1` inside the component's `<script>` block.\\n\\nCalling this method schedules an update for the next microtask \\u2014 the DOM is _not_ updated synchronously.\\n\\n```\\n// @noErrors\\ncomponent.$set({ answer: 42 });\\n```\\n\\n['[!NOTE]\\\\nIn Svelte 5+, use `$state` instead to create a component props and update that', '```\\\\n// @noErrors\\\\nlet props = $state({ answer: 42 });\\\\nconst component = mount(Component, { props });\\\\n// ...\\\\nprops.answer = 24;\\\\n```']\", \"`$on`\": \"```\\n// @noErrors\\ncomponent.$on(ev, callback);\\n```\\n\\nCauses the `callback` function to be called whenever the component dispatches an `event`.\\n\\nA function is returned that will remove the event listener when called.\\n\\n```\\n// @noErrors\\nconst off = component.$on('selected', (event) => {\\n console.log(event.detail.selection);\\n});\\n\\noff();\\n```\\n\\n['[!NOTE]\\\\nIn Svelte 5+, pass callback props instead']\", \"`$destroy`\": \"```\\n// @noErrors\\ncomponent.$destroy();\\n```\\n\\nRemoves a component from the DOM and triggers any `onDestroy` handlers.\\n\\n['[!NOTE]\\\\nIn Svelte 5+, use [`unmount`](svelte#unmount) instead']\", \"Component props\": \"```\\n// @noErrors\\ncomponent.prop;\\n```\\n\\n```\\n// @noErrors\\ncomponent.prop = value;\\n```\\n\\nIf a component is compiled with `accessors: true`, each instance will have getters and setters corresponding to each of the component's props. Setting a value will cause a _synchronous_ update, rather than the default async update caused by `component.$set(...)`.\\n\\nBy default, `accessors` is `false`, unless you're compiling as a custom element.\\n\\n```\\n// @noErrors\\nconsole.log(component.count);\\ncomponent.count += 1;\\n```\\n\\n['[!NOTE]\\\\nIn Svelte 5+, this concept is obsolete. If you want to make properties accessible from the outside, `export` them']\", \"Server-side component API\": \"```\\n// @noErrors\\nconst result = Component.render(...)\\n```\\n\\nUnlike client-side components, server-side components don't have a lifespan after you render them \\u2014 their whole job is to create some HTML and CSS. For that reason, the API is somewhat different.\\n\\nA server-side component exposes a `render` method that can be called with optional props. It returns an object with `head`, `html`, and `css` properties, where `head` contains the contents of any `<svelte:head>` elements encountered.\\n\\nYou can import a Svelte component directly into Node using `svelte/register`.\\n\\n```\\n// @noErrors\\nrequire('svelte/register');\\n\\nconst App = require('./App.svelte').default;\\n\\nconst { head, html, css } = App.render({\\n answer: 42\\n});\\n```\\n\\nThe `.render()` method accepts the following parameters:\\n\\n| parameter | default | description |\\n| --------- | ------- | -------------------------------------------------- |\\n| `props` | `{}` | An object of properties to supply to the component |\\n| `options` | `{}` | An object of options |\\n\\nThe `options` object takes in the following options:\\n\\n| option | default | description |\\n| --------- | ----------- | ------------------------------------------------------------------------ |\\n| `context` | `new Map()` | A `Map` of root-level context key-value pairs to supply to the component |\\n\\n```\\n// @noErrors\\nconst { head, html, css } = App.render(\\n // props\\n { answer: 42 },\\n // options\\n {\\n context: new Map([['context-key', 'context-value']])\\n }\\n);\\n```\\n\\n['[!NOTE]\\\\nIn Svelte 5+, use [`render`](svelte-server#render) instead']\"}, \"metadata\": {\"title\": \"Imperative component API\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 11]\"}, {\"title\": \"Legacy APIs\", \"description\": null, \"content\": {\"root\": []}, \"metadata\": {\"title\": \"Legacy APIs\"}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 9, \\\"subpages\\\", 12]\"}], \"path\": \"[\\\"subpages\\\", 9]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Compiler-Driven Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Single-file component (.svelte) processing system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Parses distinct blocks for logic (<script>), structure (markup), and presentation (<style>)\", \"weight\": 3}, {\"requirements\": \"TypeScript integration via preprocessor and `<script lang=\\\"ts\\\">` syntax\", \"weight\": 2}, {\"requirements\": \"Module script support for component-level exports and imports\", \"weight\": 2}]}, {\"requirements\": \"Compile-time static analysis and optimization pipeline\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Template compiler transforms template syntax into reactive JavaScript with explicit dependency graphs\", \"weight\": 3}, {\"requirements\": \"Runes compiler rewrites $state/$derived/$effect calls into reactive store-like cells and effect subscriptions\", \"weight\": 3}, {\"requirements\": \"Style compiler extracts styles, generates component-scoped hashes, and emits CSS with specificity wrappers\", \"weight\": 2}]}, {\"requirements\": \"Generated code output and runtime targets\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Generates optimized imperative JavaScript that directly manipulates DOM without virtual DOM\", \"weight\": 3}, {\"requirements\": \"Server-side rendering compilation to HTML string generation with client hydration support\", \"weight\": 2}, {\"requirements\": \"Custom elements compilation target via `<svelte:options>` tag\", \"weight\": 1}]}, {\"requirements\": \"Compiler configuration and error handling\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Compiler options for output configuration and accessibility warnings\", \"weight\": 1}, {\"requirements\": \"Error and warning reporting system with development feedback\", \"weight\": 2}]}]}, {\"requirements\": \"Fine-Grained Reactivity Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Runes-based reactivity primitives (Svelte 5+)\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"State management with $state rune\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Reactive variable declarations that trigger updates on mutation\", \"weight\": 3}, {\"requirements\": \"Raw state management with $state.raw for non-proxied values\", \"weight\": 2}, {\"requirements\": \"State snapshot functionality with $state.snapshot\", \"weight\": 2}, {\"requirements\": \"Cross-module and function state passing mechanisms\", \"weight\": 2}]}, {\"requirements\": \"Computed values with $derived rune\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Memoized values with automatic dependency tracking and re-evaluation\", \"weight\": 3}, {\"requirements\": \"Lazy evaluation system with $derived.by\", \"weight\": 2}, {\"requirements\": \"Destructuring support for derived values\", \"weight\": 1}]}, {\"requirements\": \"Side effects with $effect rune\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Functions that run after DOM updates and re-run when dependencies change\", \"weight\": 3}, {\"requirements\": \"Pre-update effects with $effect.pre that run before DOM modifications\", \"weight\": 2}, {\"requirements\": \"Effect tracking and pending state management\", \"weight\": 2}, {\"requirements\": \"Isolated execution context with $effect.root to prevent destruction with containing component\", \"weight\": 1}]}, {\"requirements\": \"Component properties with $props rune\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Reactive component properties with default values\", \"weight\": 3}, {\"requirements\": \"Property fallback value system and rest props handling\", \"weight\": 2}, {\"requirements\": \"Property renaming and type safety integration\", \"weight\": 2}]}, {\"requirements\": \"Two-way binding with $bindable rune\", \"weight\": 2}, {\"requirements\": \"Development utilities ($inspect, $host) for debugging and signal tracing\", \"weight\": 1}]}, {\"requirements\": \"Reactivity propagation and scheduling system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Version counters and dirty flags system to avoid cascading walks\", \"weight\": 2}, {\"requirements\": \"Micro-task batching for effect execution\", \"weight\": 2}, {\"requirements\": \"Signal objects with .v (value) and .s (subscribers) fields\", \"weight\": 3}]}, {\"requirements\": \"Legacy reactivity system (Svelte 4 and earlier)\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Instrumented `let` variable assignments generating DOM update code\", \"weight\": 2}, {\"requirements\": \"Reactive statements with `$:` syntax creating reactive computations\", \"weight\": 2}, {\"requirements\": \"Export let prop system for component interfaces\", \"weight\": 2}]}]}, {\"requirements\": \"Component System and Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Component factory and instance model\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Function-based component factories returning fragments with mount/update/destroy hooks\", \"weight\": 3}, {\"requirements\": \"Component encapsulation of logic, markup, and styles within single .svelte files\", \"weight\": 3}, {\"requirements\": \"Imperative API for programmatic component mounting and interaction\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Mount and unmount operations for any DOM node\", \"weight\": 3}, {\"requirements\": \"Server-side rendering with render function\", \"weight\": 2}, {\"requirements\": \"Hydration system for SSR components\", \"weight\": 2}]}]}, {\"requirements\": \"Data flow and component communication\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Parent-to-child data flow via props\", \"weight\": 3}, {\"requirements\": \"Child-to-parent communication via dispatched events\", \"weight\": 2}, {\"requirements\": \"Context API for hierarchical data passing\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Type-safe context API with getContext/setContext\", \"weight\": 2}, {\"requirements\": \"State integration with context system\", \"weight\": 2}]}]}, {\"requirements\": \"Content projection and composition\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Snippet system for renderable fragment passing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Parent components passing renderable fragments to children\", \"weight\": 3}, {\"requirements\": \"Snippet rendering with @render tag in child components\", \"weight\": 3}, {\"requirements\": \"Data passing from child component back to snippet scope\", \"weight\": 2}]}, {\"requirements\": \"Legacy slot-based system for backward compatibility\", \"weight\": 1}]}, {\"requirements\": \"Component lifecycle management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Lifecycle functions (onMount, onDestroy) executing at specific component lifecycle points\", \"weight\": 3}, {\"requirements\": \"Update cycle management with tick() function for awaiting pending state changes\", \"weight\": 2}, {\"requirements\": \"Legacy update hooks (beforeUpdate/afterUpdate) for backward compatibility\", \"weight\": 1}]}]}, {\"requirements\": \"Template System and DOM Rendering\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Template syntax compilation to JavaScript\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Basic markup compilation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Element attribute binding and spread syntax\", \"weight\": 2}, {\"requirements\": \"Event delegation and handler attachment\", \"weight\": 3}, {\"requirements\": \"Text expression interpolation\", \"weight\": 2}]}, {\"requirements\": \"Control flow block compilation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Conditional rendering with {#if}/{#else} blocks converted to JavaScript logic\", \"weight\": 3}, {\"requirements\": \"List rendering with {#each} blocks generating keyed reconciliation loops\", \"weight\": 3}, {\"requirements\": \"Async handling with {#await} blocks creating state machines for promise resolution\", \"weight\": 2}, {\"requirements\": \"{#key} blocks forcing DOM element re-creation when key value changes\", \"weight\": 2}]}]}, {\"requirements\": \"Special template directives and runtime features\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Raw HTML injection with {@html} directive\", \"weight\": 2}, {\"requirements\": \"Compile-time constants with {@const} directive\", \"weight\": 1}, {\"requirements\": \"Debug utilities with {@debug} directive\", \"weight\": 1}, {\"requirements\": \"Dynamic component/element rendering via <svelte:element>\", \"weight\": 2}]}, {\"requirements\": \"Data binding infrastructure\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Two-way data binding with bind: directive\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Form element bindings (value, checked, files)\", \"weight\": 3}, {\"requirements\": \"Select and group binding mechanisms\", \"weight\": 2}, {\"requirements\": \"Media element bindings for audio/video\", \"weight\": 1}, {\"requirements\": \"Element reference binding with bind:this\", \"weight\": 2}, {\"requirements\": \"Element dimensions binding (clientWidth, clientHeight)\", \"weight\": 2}]}, {\"requirements\": \"Component property binding system\", \"weight\": 2}]}, {\"requirements\": \"Element lifecycle and behavior attachment\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Actions (use: directive) for attaching reusable behavior and lifecycle logic to elements\", \"weight\": 2}, {\"requirements\": \"Animation and transition directives\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"CSS animations via transition:, in:, out: directives for element lifecycle\", \"weight\": 2}, {\"requirements\": \"List animation with animate: directive using FLIP technique\", \"weight\": 2}, {\"requirements\": \"Built-in transition functions and custom transition API\", \"weight\": 2}, {\"requirements\": \"Local vs global transition scoping\", \"weight\": 2}]}]}]}, {\"requirements\": \"Scoped Styling System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"CSS encapsulation and scoping\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Automatic component-scoped styling with unique hash-based class generation\", \"weight\": 3}, {\"requirements\": \"Scoped keyframes animations to prevent global name collisions\", \"weight\": 2}, {\"requirements\": \"CSS specificity handling with :where(...) wrappers\", \"weight\": 2}]}, {\"requirements\": \"Global styling mechanisms\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \":global() modifier for applying styles to entire document\", \"weight\": 2}, {\"requirements\": \"Global style blocks for document-wide styling\", \"weight\": 2}]}, {\"requirements\": \"Dynamic styling system\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"CSS custom property integration for dynamic values\", \"weight\": 2}, {\"requirements\": \"Class directive for conditional class application\", \"weight\": 2}, {\"requirements\": \"Style directive for dynamic inline style management\", \"weight\": 2}]}]}, {\"requirements\": \"Special Elements and Global Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Document and global object interaction\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"<svelte:head> for managing document metadata with automatic cleanup\", \"weight\": 2}, {\"requirements\": \"<svelte:window>, <svelte:document>, <svelte:body> for binding to global events and properties\", \"weight\": 2}]}, {\"requirements\": \"Error handling and boundaries\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"<svelte:boundary> for creating error boundaries for async operations\", \"weight\": 2}]}, {\"requirements\": \"Component configuration and options\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"<svelte:options> for component-level configuration\", \"weight\": 1}]}]}, {\"requirements\": \"Runtime Library and Store System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Store system for cross-component state management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Writable and readable store implementations following observable contract\", \"weight\": 3}, {\"requirements\": \"Derived store computation system with automatic dependency tracking\", \"weight\": 2}, {\"requirements\": \"Store subscription mechanism and lifecycle management\", \"weight\": 2}]}, {\"requirements\": \"Animation and transition utilities\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Built-in transition functions (fade, fly) in svelte/transition\", \"weight\": 2}, {\"requirements\": \"Easing functions (cubicIn, elasticOut) in svelte/easing for animation timing\", \"weight\": 1}, {\"requirements\": \"Motion utilities in svelte/motion for tweening and interpolation\", \"weight\": 2}]}, {\"requirements\": \"Runtime helper modules\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Event handling utilities with delegation patterns\", \"weight\": 2}, {\"requirements\": \"Server-side rendering utilities for HTML string generation\", \"weight\": 2}]}]}, {\"requirements\": \"Legacy Compatibility and Migration\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Legacy API transformation\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Export let props desugared into $props() with same names\", \"weight\": 1}, {\"requirements\": \"$: reactive statements transformed into $derived/$effect based on usage analysis\", \"weight\": 1}, {\"requirements\": \"Slot syntax transformed into snippet passing\", \"weight\": 1}, {\"requirements\": \"Class-based component API wrapped around new function-based factory\", \"weight\": 1}]}, {\"requirements\": \"Migration tooling and compatibility layers\", \"weight\": 1}]}]}"}}},{"rowIdx":19,"cells":{"repo_name":{"kind":"string","value":"trino"},"repo_url":{"kind":"string","value":"https://github.com/trinodb/trino"},"commit_id":{"kind":"string","value":"d1501ee536c0c6883ed960a184ba7b3f9e36a6c3"},"docs_tree":{"kind":"string","value":"{\"title\": \"trino\", \"description\": \"Documentation for trino\", \"subpages\": [{\"title\": \"Trino documentation\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"Writing and contributing\": \"<detail_content>\", \"Tools\": \"<detail_content>\", \"Fast doc build option\": \"<detail_content>\", \"Default build\": \"<detail_content>\", \"Viewing documentation\": \"<detail_content>\", \"Versioning\": \"<detail_content>\", \"Style check\": \"<detail_content>\", \"Contribution requirements\": \"<detail_content>\", \"Workflow\": \"<detail_content>\", \"Videos\": \"<detail_content>\", \"Docker container\": \"<detail_content>\"}}, {\"title\": \"Release xyz (dd MMM 2025)\", \"path\": \"[\\\"subpages\\\", 1]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Blackhole connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"DuckDB connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Exasol connector\": \"<detail_content>\", \"Faker connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"JMX connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Loki connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"OpenSearch connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"TPC-H connector\": \"<detail_content>\", \"TPC-DS connector\": \"<detail_content>\", \"Vertica connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Src\", \"description\": \"Documentation section: src\", \"path\": \"[\\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Main\", \"description\": \"Documentation section: main\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"Sphinx\", \"description\": \"Documentation section: sphinx\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"Administration\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"Event listeners\": \"<detail_content>\", \"Properties reference\": \"<detail_content>\"}}, {\"title\": \"Appendix\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\", \"content\": {\"Appendix\": \"<detail_content>\"}}, {\"title\": \"Clients\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\", \"content\": {\"Client drivers\": \"<detail_content>\", \"Client applications\": \"<detail_content>\", \"Client protocol\": \"<detail_content>\"}}, {\"title\": \"Connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\", \"content\": {\"Connectors\": \"<detail_content>\"}}, {\"title\": \"Develop\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\", \"content\": {\"Developer guide\": \"<detail_content>\"}}, {\"title\": \"Functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\", \"content\": {\"Functions by name\": \"<detail_content>\", \"Functions per topic\": \"<detail_content>\"}}, {\"title\": \"Glossary\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\", \"content\": {\"Glossary\": \"<detail_content>\"}}, {\"title\": \"Index\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\", \"content\": {\"Trino documentation\": \"<detail_content>\"}}, {\"title\": \"Installation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\", \"content\": {\"Installation\": \"<detail_content>\"}}, {\"title\": \"Language\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\", \"content\": {\"SQL language\": \"<detail_content>\"}}, {\"title\": \"Object storage\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\", \"content\": {\"Object storage connectors\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Native file system support\": \"<detail_content>\", \"Legacy file system support\": \"<detail_content>\", \"Other object storage support\": \"<detail_content>\"}}, {\"title\": \"Optimizer\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 11]\", \"content\": {\"Query optimizer\": \"<detail_content>\"}}, {\"title\": \"Overview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 12]\", \"content\": {\"Overview\": \"<detail_content>\"}}, {\"title\": \"Release notes\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 13]\", \"content\": {\"2025\": \"<detail_content>\", \"2024\": \"<detail_content>\", \"2023\": \"<detail_content>\", \"2022\": \"<detail_content>\", \"2021\": \"<detail_content>\", \"2020\": \"<detail_content>\", \"2019\": \"<detail_content>\", \"Before 2019\": \"<detail_content>\", \"Breaking changes\": \"<detail_content>\"}}, {\"title\": \"Security\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 14]\", \"content\": {\"Introduction\": \"<detail_content>\", \"Cluster access security\": \"<detail_content>\", \"Authentication\": \"<detail_content>\", \"User name management\": \"<detail_content>\", \"Access control\": \"<detail_content>\", \"Security inside the cluster\": \"<detail_content>\"}}, {\"title\": \"Sql\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 15]\", \"content\": {\"SQL statement syntax\": \"<detail_content>\"}}, {\"title\": \"Udf\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 16]\", \"content\": {\"User-defined functions\": \"<detail_content>\"}}, {\"title\": \"Admin\", \"description\": \"Documentation section: admin\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17]\", \"subpages\": [{\"title\": \"Dist Sort\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 0]\", \"content\": {\"Distributed sort\": \"<detail_content>\"}}, {\"title\": \"Dynamic filtering\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 1]\", \"content\": {\"Analysis and confirmation\": \"<detail_content>\", \"Dynamic filter collection thresholds\": \"<detail_content>\", \"Dimension tables layout\": \"<detail_content>\", \"Limitations\": \"<detail_content>\"}}, {\"title\": \"HTTP event listener\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 2]\", \"content\": {\"Rationale\": \"<detail_content>\", \"Requirements\": \"<detail_content>\", \"Configuration\": {\"Configuration properties\": \"<detail_content>\", \"Custom HTTP headers\": \"<detail_content>\"}}}, {\"title\": \"Kafka event listener\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 3]\", \"content\": {\"Rationale\": \"<detail_content>\", \"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"MySQL event listener\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 4]\", \"content\": {\"Rationale\": \"<detail_content>\", \"Requirements\": \"<detail_content>\", \"Configuration\": {\"Configuration properties\": \"<detail_content>\"}}}, {\"title\": \"OpenLineage event listener\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 5]\", \"content\": {\"Rationale\": {\"Available Trino Facets\": {\"Trino Metadata\": \"<detail_content>\", \"Trino Query Context\": \"<detail_content>\", \"Trino Query Statistics\": \"<detail_content>\"}}, \"Requirements\": \"<detail_content>\", \"Configuration\": {\"Supported Transport Types\": \"<detail_content>\", \"Custom HTTP headers\": \"<detail_content>\", \"Custom URL Params\": \"<detail_content>\"}}}, {\"title\": \"Fault-tolerant execution\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 6]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Retry policy\": {\"QUERY\": \"<detail_content>\", \"TASK\": \"<detail_content>\"}, \"Encryption\": \"<detail_content>\", \"Advanced configuration\": {\"Retry limits\": \"<detail_content>\", \"Task sizing\": \"<detail_content>\", \"Node allocation\": \"<detail_content>\", \"Other tuning\": \"<detail_content>\"}, \"Exchange manager\": {\"Configuration\": {\"AWS S3\": \"<detail_content>\", \"Azure Blob Storage\": \"<detail_content>\", \"Google Cloud Storage\": \"<detail_content>\", \"HDFS\": \"<detail_content>\", \"Local filesystem storage\": \"<detail_content>\"}}, \"Adaptive plan optimizations\": \"<detail_content>\"}}, {\"title\": \"Graceful shutdown\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 7]\", \"content\": {\"Shutdown behavior\": \"<detail_content>\"}}, {\"title\": \"Monitoring with JMX\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 8]\", \"content\": {\"JVM\": \"<detail_content>\", \"Trino cluster and nodes\": \"<detail_content>\", \"Trino queries\": \"<detail_content>\", \"Trino tasks\": \"<detail_content>\", \"Connectors\": \"<detail_content>\"}}, {\"title\": \"Logging\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 9]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Log output\": \"<detail_content>\", \"JSON and TCP channel logging\": \"<detail_content>\"}}, {\"title\": \"Trino metrics with OpenMetrics\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 10]\", \"content\": {\"Examples\": {\"Simple example with Docker and Prometheus\": \"<detail_content>\"}, \"Coordinator and worker metrics with Kubernetes\": \"<detail_content>\"}}, {\"title\": \"Observability with OpenTelemetry\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 11]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Example use\": \"<detail_content>\"}}, {\"title\": \"Preview Web UI\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 12]\", \"content\": {\"Activation\": \"<detail_content>\", \"Access\": \"<detail_content>\", \"Authentication\": {\"Password authentication\": \"<detail_content>\", \"Fixed user authentication\": \"<detail_content>\", \"Other authentication types\": \"<detail_content>\"}}}, {\"title\": \"Catalog management properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 13]\", \"content\": {\"`catalog.management`\": \"<detail_content>\", \"`catalog.prune.update-interval`\": \"<detail_content>\", \"`catalog.store`\": \"<detail_content>\", \"`catalog.config-dir`\": \"<detail_content>\", \"`catalog.disabled-catalogs`\": \"<detail_content>\", \"`catalog.read-only`\": \"<detail_content>\"}}, {\"title\": \"Client protocol properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 14]\", \"content\": {\"Spooling protocol properties\": {\"`protocol.spooling.enabled`\": \"<detail_content>\", \"`protocol.spooling.shared-secret-key`\": \"<detail_content>\", \"`protocol.spooling.retrieval-mode`\": \"<detail_content>\", \"`protocol.spooling.encoding.json.enabled`\": \"<detail_content>\", \"`protocol.spooling.encoding.json+zstd.enabled`\": \"<detail_content>\", \"`protocol.spooling.encoding.json+lz4.enabled`\": \"<detail_content>\", \"`protocol.spooling.encoding.compression.threshold`\": \"<detail_content>\", \"`protocol.spooling.initial-segment-size`\": \"<detail_content>\", \"`protocol.spooling.max-segment-size`\": \"<detail_content>\", \"`protocol.spooling.inlining.enabled`\": \"<detail_content>\", \"`protocol.spooling.inlining.max-rows`\": \"<detail_content>\", \"`protocol.spooling.inlining.max-size`\": \"<detail_content>\"}, \"Spooling file system properties\": {\"`fs.azure.enabled`\": \"<detail_content>\", \"`fs.s3.enabled`\": \"<detail_content>\", \"`fs.gcs.enabled`\": \"<detail_content>\", \"`fs.location`\": \"<detail_content>\", \"`fs.segment.ttl`\": \"<detail_content>\", \"`fs.segment.direct.ttl`\": \"<detail_content>\", \"`fs.segment.encryption`\": \"<detail_content>\", \"`fs.segment.explicit-ack`\": \"<detail_content>\", \"`fs.segment.pruning.enabled`\": \"<detail_content>\", \"`fs.segment.pruning.interval`\": \"<detail_content>\", \"`fs.segment.pruning.batch-size`\": \"<detail_content>\"}, \"Shared protocol properties\": {\"`protocol.v1.prepared-statement-compression.length-threshold`\": \"<detail_content>\", \"`protocol.v1.prepared-statement-compression.min-gain`\": \"<detail_content>\"}}}, {\"title\": \"Exchange properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 15]\", \"content\": {\"`exchange.client-threads`\": \"<detail_content>\", \"`exchange.concurrent-request-multiplier`\": \"<detail_content>\", \"`exchange.compression-codec`\": \"<detail_content>\", \"`exchange.data-integrity-verification`\": \"<detail_content>\", \"`exchange.max-buffer-size`\": \"<detail_content>\", \"`exchange.max-response-size`\": \"<detail_content>\", \"`sink.max-buffer-size`\": \"<detail_content>\", \"`sink.max-broadcast-buffer-size`\": \"<detail_content>\"}}, {\"title\": \"General properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 16]\", \"content\": {\"`join-distribution-type`\": \"<detail_content>\", \"`redistribute-writes`\": \"<detail_content>\", \"File compression and decompression\": \"<detail_content>\"}}, {\"title\": \"HTTP client properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 17]\", \"content\": {\"General properties\": {\"`http-client.connect-timeout`\": \"<detail_content>\", \"`max-content-length`\": \"<detail_content>\", \"`http-client.request-timeout`\": \"<detail_content>\"}, \"TLS and security properties\": {\"`http-client.https.excluded-cipher`\": \"<detail_content>\", \"`http-client.https.included-cipher`\": \"<detail_content>\", \"`http-client.https.hostname-verification`\": \"<detail_content>\", \"`http-client.key-store-password`\": \"<detail_content>\", \"`http-client.key-store-path`\": \"<detail_content>\", \"`http-client.secure-random-algorithm`\": \"<detail_content>\", \"`http-client.trust-store-password`\": \"<detail_content>\", \"`http-client.trust-store-path`\": \"<detail_content>\"}, \"Proxy properties\": {\"`http-client.http-proxy`\": \"<detail_content>\", \"`http-client.http-proxy.user`\": \"<detail_content>\", \"`http-client.http-proxy.password`\": \"<detail_content>\", \"`http-client.http-proxy.secure`\": \"<detail_content>\", \"`http-client.socks-proxy`\": \"<detail_content>\"}, \"Request logging\": {\"`http-client.log.compression.enabled`\": \"<detail_content>\", \"`http-client.log.enabled`\": \"<detail_content>\", \"`http-client.log.flush-interval`\": \"<detail_content>\", \"`http-client.log.max-history`\": \"<detail_content>\", \"`http-client.log.max-size`\": \"<detail_content>\", \"`http-client.log.path`\": \"<detail_content>\", \"`http-client.log.queue-size`\": \"<detail_content>\"}}}, {\"title\": \"HTTP server properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 18]\", \"content\": {\"General\": {\"`http-server.process-forwarded`\": \"<detail_content>\"}, \"HTTP and HTTPS\": {\"`http-server.http.port`\": \"<detail_content>\", \"`http-server.https.enabled`\": \"<detail_content>\", \"`http-server.https.port`\": \"<detail_content>\", \"`http-server.https.included-cipher` and `http-server.https.excluded-cipher`\": \"<detail_content>\", \"`http-server.https.keystore.path`\": \"<detail_content>\", \"`http-server.https.keystore.key`\": \"<detail_content>\", \"`http-server.https.truststore.path`\": \"<detail_content>\", \"`http-server.https.truststore.key`\": \"<detail_content>\", \"`http-server.https.keymanager.password`\": \"<detail_content>\", \"`http-server.https.secure-random-algorithm`\": \"<detail_content>\", \"`http-server.https.ssl-session-timeout`\": \"<detail_content>\", \"`http-server.https.ssl-session-cache-size`\": \"<detail_content>\", \"`http-server.https.ssl-context.refresh-time`\": \"<detail_content>\"}, \"Authentication\": {\"`http-server.authentication.type`\": \"<detail_content>\", \"`http-server.authentication.allow-insecure-over-http`\": \"<detail_content>\", \"`http-server.authentication.certificate.*`\": \"<detail_content>\", \"`http-server.authentication.jwt.*`\": \"<detail_content>\", \"`http-server.authentication.krb5.*`\": \"<detail_content>\", \"`http-server.authentication.oauth2.*`\": \"<detail_content>\", \"`http-server.authentication.password.*`\": \"<detail_content>\"}, \"Logging\": {\"`http-server.log.*`\": \"<detail_content>\"}, \"Internal communication\": {\"`internal-communication.shared-secret`\": \"<detail_content>\", \"`internal-communication.http2.enabled`\": \"<detail_content>\", \"`internal-communication.https.required`\": \"<detail_content>\"}}}, {\"title\": \"Logging properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 19]\", \"content\": {\"`log.annotation-file`\": \"<detail_content>\", \"`log.format`\": \"<detail_content>\", \"`log.console-format`\": \"<detail_content>\", \"`log.path`\": \"<detail_content>\", \"`log.max-size`\": \"<detail_content>\", \"`log.max-total-size`\": \"<detail_content>\", \"`log.compression`\": \"<detail_content>\", \"`http-server.log.enabled`\": \"<detail_content>\", \"`http-server.log.compression.enabled`\": \"<detail_content>\", \"`http-server.log.path`\": \"<detail_content>\", \"`http-server.log.max-history`\": \"<detail_content>\", \"`http-server.log.max-size`\": \"<detail_content>\"}}, {\"title\": \"Node scheduler properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 20]\", \"content\": {\"`node-scheduler.include-coordinator`\": {\"Splits\": \"<detail_content>\"}, \"`node-scheduler.max-splits-per-node`\": \"<detail_content>\", \"`node-scheduler.min-pending-splits-per-task`\": \"<detail_content>\", \"`node-scheduler.max-adjusted-pending-splits-per-task`\": \"<detail_content>\", \"`node-scheduler.max-unacknowledged-splits-per-task`\": \"<detail_content>\", \"`node-scheduler.min-candidates`\": \"<detail_content>\", \"`node-scheduler.policy`\": {\"Network topology\": \"<detail_content>\"}, \"`node-scheduler.network-topology.segments`\": \"<detail_content>\", \"`node-scheduler.network-topology.type`\": {\"File based network topology\": \"<detail_content>\"}, \"`node-scheduler.network-topology.file`\": \"<detail_content>\", \"`node-scheduler.network-topology.refresh-period`\": {\"Subnet based network topology\": \"<detail_content>\"}, \"`node-scheduler.network-topology.subnet.ip-address-protocol`\": \"<detail_content>\", \"`node-scheduler.network-topology.subnet.cidr-prefix-lengths`\": \"<detail_content>\"}}, {\"title\": \"Optimizer properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 21]\", \"content\": {\"`optimizer.dictionary-aggregation`\": \"<detail_content>\", \"`optimizer.optimize-metadata-queries`\": \"<detail_content>\", \"`optimizer.distinct-aggregations-strategy`\": \"<detail_content>\", \"`optimizer.push-aggregation-through-outer-join`\": \"<detail_content>\", \"`optimizer.push-table-write-through-union`\": \"<detail_content>\", \"`optimizer.push-filter-into-values-max-row-count`\": \"<detail_content>\", \"`optimizer.join-reordering-strategy`\": \"<detail_content>\", \"`optimizer.max-reordered-joins`\": \"<detail_content>\", \"`optimizer.optimize-duplicate-insensitive-joins`\": \"<detail_content>\", \"`optimizer.use-exact-partitioning`\": \"<detail_content>\", \"`optimizer.use-table-scan-node-partitioning`\": \"<detail_content>\", \"`optimizer.table-scan-node-partitioning-min-bucket-to-task-ratio`\": \"<detail_content>\", \"`optimizer.colocated-joins-enabled`\": \"<detail_content>\", \"`optimizer.filter-conjunction-independence-factor`\": \"<detail_content>\", \"`optimizer.join-multi-clause-independence-factor`\": \"<detail_content>\", \"`optimizer.non-estimatable-predicate-approximation.enabled`\": \"<detail_content>\", \"`optimizer.join-partitioned-build-min-row-count`\": \"<detail_content>\", \"`optimizer.min-input-size-per-task`\": \"<detail_content>\", \"`optimizer.min-input-rows-per-task`\": \"<detail_content>\", \"`optimizer.use-cost-based-partitioning`\": \"<detail_content>\"}}, {\"title\": \"Query management properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 22]\", \"content\": {\"`query.client.timeout`\": \"<detail_content>\", \"`query.execution-policy`\": \"<detail_content>\", \"`query.determine-partition-count-for-write-enabled`\": \"<detail_content>\", \"`query.max-hash-partition-count`\": \"<detail_content>\", \"`query.min-hash-partition-count`\": \"<detail_content>\", \"`query.min-hash-partition-count-for-write`\": \"<detail_content>\", \"`query.max-writer-task-count`\": \"<detail_content>\", \"`query.low-memory-killer.policy`\": \"<detail_content>\", \"`task.low-memory-killer.policy`\": \"<detail_content>\", \"`query.max-execution-time`\": \"<detail_content>\", \"`query.max-length`\": \"<detail_content>\", \"`query.max-planning-time`\": \"<detail_content>\", \"`query.max-run-time`\": \"<detail_content>\", \"`query.max-scan-physical-bytes`\": \"<detail_content>\", \"`query.max-write-physical-size`\": \"<detail_content>\", \"`query.max-stage-count`\": \"<detail_content>\", \"`query.max-history`\": \"<detail_content>\", \"`query.min-expire-age`\": \"<detail_content>\", \"`query.remote-task.enable-adaptive-request-size`\": \"<detail_content>\", \"`query.remote-task.guaranteed-splits-per-task`\": \"<detail_content>\", \"`query.remote-task.max-error-duration`\": \"<detail_content>\", \"`query.remote-task.max-request-size`\": \"<detail_content>\", \"`query.remote-task.request-size-headroom`\": \"<detail_content>\", \"`query.info-url-template`\": \"<detail_content>\", \"`retry-policy`\": \"<detail_content>\"}}, {\"title\": \"Regular expression function properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 23]\", \"content\": {\"`regex-library`\": \"<detail_content>\", \"`re2j.dfa-states-limit`\": \"<detail_content>\", \"`re2j.dfa-retries`\": \"<detail_content>\"}}, {\"title\": \"Resource management properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 24]\", \"content\": {\"`query.max-cpu-time`\": \"<detail_content>\", \"`query.max-memory-per-node`\": \"<detail_content>\", \"`query.max-memory`\": \"<detail_content>\", \"`query.max-total-memory`\": \"<detail_content>\", \"`memory.heap-headroom-per-node`\": \"<detail_content>\", \"`exchange.deduplication-buffer-size`\": \"<detail_content>\"}}, {\"title\": \"Spilling properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 25]\", \"content\": {\"`spill-enabled`\": \"<detail_content>\", \"`spiller-spill-path`\": \"<detail_content>\", \"`spiller-max-used-space-threshold`\": \"<detail_content>\", \"`spiller-threads`\": \"<detail_content>\", \"`max-spill-per-node`\": \"<detail_content>\", \"`query-max-spill-per-node`\": \"<detail_content>\", \"`aggregation-operator-unspill-memory-limit`\": \"<detail_content>\", \"`spill-compression-codec`\": \"<detail_content>\", \"`spill-encryption-enabled`\": \"<detail_content>\"}}, {\"title\": \"SQL environment properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 26]\", \"content\": {\"`sql.forced-session-time-zone`\": \"<detail_content>\", \"`sql.default-catalog`\": \"<detail_content>\", \"`sql.default-schema`\": \"<detail_content>\", \"`sql.default-function-catalog`\": \"<detail_content>\", \"`sql.default-function-schema`\": \"<detail_content>\", \"`sql.path`\": \"<detail_content>\"}}, {\"title\": \"Task properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 27]\", \"content\": {\"`task.concurrency`\": \"<detail_content>\", \"`task.http-response-threads`\": \"<detail_content>\", \"`task.http-timeout-threads`\": \"<detail_content>\", \"`task.info-update-interval`\": \"<detail_content>\", \"`task.max-drivers-per-task`\": \"<detail_content>\", \"`task.max-partial-aggregation-memory`\": \"<detail_content>\", \"`task.max-worker-threads`\": \"<detail_content>\", \"`task.min-drivers`\": \"<detail_content>\", \"`task.min-drivers-per-task`\": \"<detail_content>\", \"`task.scale-writers.enabled`\": \"<detail_content>\", \"`task.min-writer-count`\": \"<detail_content>\", \"`task.max-writer-count`\": \"<detail_content>\", \"`task.interrupt-stuck-split-tasks-enabled`\": \"<detail_content>\", \"`task.interrupt-stuck-split-tasks-warning-threshold`\": \"<detail_content>\", \"`task.interrupt-stuck-split-tasks-timeout`\": \"<detail_content>\", \"`task.interrupt-stuck-split-tasks-detection-interval`\": \"<detail_content>\"}}, {\"title\": \"Web UI properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 28]\", \"content\": {\"`web-ui.authentication.type`\": \"<detail_content>\", \"`web-ui.enabled`\": \"<detail_content>\", \"`web-ui.preview.enabled`\": \"<detail_content>\", \"`web-ui.shared-secret`\": \"<detail_content>\", \"`web-ui.session-timeout`\": \"<detail_content>\", \"`web-ui.user`\": \"<detail_content>\"}}, {\"title\": \"Write partitioning properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 29]\", \"content\": {\"`use-preferred-write-partitioning`\": \"<detail_content>\"}}, {\"title\": \"Writer scaling properties\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 30]\", \"content\": {\"`scale-writers`\": \"<detail_content>\", \"`task.scale-writers.enabled`\": \"<detail_content>\", \"`writer-scaling-min-data-processed`\": \"<detail_content>\"}}, {\"title\": \"Properties reference\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 31]\", \"content\": {\"Property value types\": {\"`boolean`\": \"<detail_content>\", \"`data size`\": \"<detail_content>\", \"`double`\": \"<detail_content>\", \"`duration`\": \"<detail_content>\", \"`heap size`\": \"<detail_content>\", \"`integer`\": \"<detail_content>\", \"`string`\": \"<detail_content>\"}}}, {\"title\": \"Resource groups\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 32]\", \"content\": {\"File resource group manager\": \"<detail_content>\", \"Database resource group manager\": \"<detail_content>\", \"Resource group properties\": {\"Scheduling weight example\": \"<detail_content>\"}, \"Selector rules\": \"<detail_content>\", \"Global properties\": \"<detail_content>\", \"Providing selector properties\": \"<detail_content>\", \"Example\": {\"File resource group manager\": \"<detail_content>\", \"Database resource group manager\": \"<detail_content>\"}}}, {\"title\": \"Session property managers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 33]\", \"content\": {\"Match rules\": \"<detail_content>\", \"Example\": \"<detail_content>\"}}, {\"title\": \"Spill to disk\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 34]\", \"content\": {\"Overview\": \"<detail_content>\", \"Memory management and spill\": \"<detail_content>\", \"Spill disk space\": \"<detail_content>\", \"Spill compression\": \"<detail_content>\", \"Spill encryption\": \"<detail_content>\", \"Supported operations\": {\"Joins\": \"<detail_content>\", \"Aggregations\": \"<detail_content>\", \"Order by\": \"<detail_content>\", \"Window functions\": \"<detail_content>\"}}}, {\"title\": \"Tuning Trino\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 35]\", \"content\": {\"Config properties\": \"<detail_content>\", \"JVM settings\": \"<detail_content>\"}}, {\"title\": \"Web UI\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 36]\", \"content\": {\"Authentication\": {\"Password authentication\": \"<detail_content>\", \"Fixed user authentication\": \"<detail_content>\", \"Other authentication types\": \"<detail_content>\"}, \"User interface overview\": \"<detail_content>\", \"Configuring query history\": \"<detail_content>\"}}]}, {\"title\": \"Appendix\", \"description\": \"Documentation section: appendix\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18]\", \"subpages\": [{\"title\": \"Migrating from Hive\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18, \\\"subpages\\\", 0]\", \"content\": {\"Use subscript for accessing a dynamic index of an array instead of an udf\": \"<detail_content>\", \"Avoid out of bounds access of arrays\": \"<detail_content>\", \"Use ANSI SQL syntax for arrays\": \"<detail_content>\", \"Use ANSI SQL syntax for identifiers and strings\": \"<detail_content>\", \"Quote identifiers that start with numbers\": \"<detail_content>\", \"Use the standard string concatenation operator\": \"<detail_content>\", \"Use standard types for CAST targets\": \"<detail_content>\", \"Use CAST when dividing integers\": \"<detail_content>\", \"Use WITH for complex expressions or queries\": \"<detail_content>\", \"Use UNNEST to expand arrays and maps\": \"<detail_content>\", \"Use ANSI SQL syntax for date and time INTERVAL expressions\": \"<detail_content>\", \"Caution with datediff\": \"<detail_content>\", \"Overwriting data on insert\": \"<detail_content>\"}}, {\"title\": \"Legal notices\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18, \\\"subpages\\\", 1]\", \"content\": {\"License\": \"<detail_content>\", \"Code\": \"<detail_content>\", \"Governance\": \"<detail_content>\", \"Trademarks\": \"<detail_content>\"}}]}, {\"title\": \"Client\", \"description\": \"Documentation section: client\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19]\", \"subpages\": [{\"title\": \"Command line interface\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 0]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Installation\": \"<detail_content>\", \"Running the CLI\": \"<detail_content>\", \"TLS/HTTPS\": \"<detail_content>\", \"Authentication\": {\"Username and password authentication\": \"<detail_content>\", \"External authentication - SSO\": \"<detail_content>\", \"Certificate authentication\": \"<detail_content>\", \"JWT authentication\": \"<detail_content>\", \"Kerberos authentication\": {\"Additional Kerberos debugging information\": \"<detail_content>\"}}, \"Pagination\": \"<detail_content>\", \"History\": {\"Auto suggestion\": \"<detail_content>\"}, \"Configuration file\": \"<detail_content>\", \"Batch mode\": {\"Examples\": \"<detail_content>\"}, \"Spooling protocol\": \"<detail_content>\", \"Output formats\": \"<detail_content>\", \"Troubleshooting\": \"<detail_content>\"}}, {\"title\": \"Client protocol\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 1]\", \"content\": {\"Spooling protocol\": {\"Configuration\": \"<detail_content>\"}, \"Direct protocol\": {\"Configuration\": \"<detail_content>\"}, \"Development and reference information\": \"<detail_content>\"}}, {\"title\": \"JDBC driver\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 2]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Installation\": \"<detail_content>\", \"Registering and configuring the driver\": \"<detail_content>\", \"Connecting\": \"<detail_content>\", \"Connection parameters\": \"<detail_content>\", \"Parameter reference\": \"<detail_content>\", \"Spooling protocol\": \"<detail_content>\"}}]}, {\"title\": \"Connector\", \"description\": \"Documentation section: connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20]\", \"subpages\": [{\"title\": \"BigQuery connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 0]\", \"content\": {\"BigQuery Storage API\": \"<detail_content>\", \"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple GCP projects\": \"<detail_content>\", \"Billing and data projects\": \"<detail_content>\", \"Arrow serialization support\": \"<detail_content>\", \"Reading from views\": \"<detail_content>\", \"Configuration properties\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Type mapping\": {\"BigQuery type to Trino type mapping\": \"<detail_content>\", \"Trino type to BigQuery type mapping\": \"<detail_content>\"}, \"System tables\": \"<detail_content>\", \"Special columns\": \"<detail_content>\", \"SQL support\": {\"Wildcard table\": \"<detail_content>\", \"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Pushdown\": \"<detail_content>\"}, \"FAQ\": {\"What is the Pricing for the Storage API?\": \"<detail_content>\"}}}, {\"title\": \"Black Hole connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 1]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Cassandra connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 2]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Cassandra clusters\": \"<detail_content>\"}, \"Configuration properties\": \"<detail_content>\", \"Querying Cassandra tables\": \"<detail_content>\", \"Type mapping\": {\"Cassandra type to Trino type mapping\": \"<detail_content>\", \"Trino type to Cassandra type mapping\": \"<detail_content>\"}, \"Partition key types\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}, \"DROP TABLE\": \"<detail_content>\", \"SQL delete limitation\": \"<detail_content>\"}}}, {\"title\": \"ClickHouse connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 3]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Connection security\": \"<detail_content>\", \"Multiple ClickHouse servers\": \"<detail_content>\"}, \"Querying ClickHouse\": \"<detail_content>\", \"Table properties\": \"<detail_content>\", \"Type mapping\": {\"ClickHouse type to Trino type mapping\": \"<detail_content>\", \"Trino type to ClickHouse type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"Delta Lake connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 4]\", \"content\": {\"Requirements\": \"<detail_content>\", \"General configuration\": \"<detail_content>\", \"File system access configuration\": {\"Delta Lake general configuration properties\": \"<detail_content>\", \"Catalog session properties\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Type mapping\": {\"Delta Lake to Trino type mapping\": \"<detail_content>\", \"Trino to Delta Lake type mapping\": \"<detail_content>\"}, \"Delta Lake table features\": \"<detail_content>\", \"Security\": {\"Authorization checks\": \"<detail_content>\"}, \"SQL support\": {\"Time travel queries\": \"<detail_content>\", \"Procedures\": {\"Register table\": \"<detail_content>\", \"Unregister table\": \"<detail_content>\", \"Flush metadata cache\": \"<detail_content>\", \"`VACUUM`\": \"<detail_content>\"}, \"Data management\": \"<detail_content>\", \"Schema and table management\": {\"Schema evolution\": \"<detail_content>\", \"Replace tables\": \"<detail_content>\", \"ALTER TABLE EXECUTE\": \"<detail_content>\", \"ALTER TABLE RENAME TO\": \"<detail_content>\", \"Table properties\": \"<detail_content>\", \"Shallow cloned tables\": \"<detail_content>\", \"Metadata tables\": {\"`$history` table\": \"<detail_content>\", \"`$partitions` table\": \"<detail_content>\", \"`$properties` table\": \"<detail_content>\"}, \"Metadata columns\": \"<detail_content>\"}, \"Table functions\": {\"table_changes\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": {\"Fine-tuning\": \"<detail_content>\", \"Disable and drop extended statistics\": \"<detail_content>\"}, \"Memory usage\": {\"Memory monitoring\": \"<detail_content>\"}, \"Table redirection\": \"<detail_content>\", \"Performance tuning configuration properties\": \"<detail_content>\", \"File system cache\": \"<detail_content>\"}}}, {\"title\": \"Druid connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 5]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Type mapping\": {\"Druid type to Trino type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}}}, {\"title\": \"DuckDB connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 6]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple DuckDB servers\": \"<detail_content>\"}, \"Type mapping\": {\"DuckDB type to Trino type mapping\": \"<detail_content>\", \"Trino type to DuckDB type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}}}, {\"title\": \"Elasticsearch connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 7]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Authentication\": \"<detail_content>\", \"Connection security with TLS\": \"<detail_content>\"}, \"Type mapping\": {\"Elasticsearch type to Trino type mapping\": \"<detail_content>\", \"Array types\": \"<detail_content>\", \"Date types\": \"<detail_content>\", \"Raw JSON transform\": \"<detail_content>\"}, \"Special columns\": \"<detail_content>\", \"Full text queries\": \"<detail_content>\", \"SQL support\": {\"Wildcard table\": \"<detail_content>\", \"Table functions\": {\"`raw_query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Parallel data access\": \"<detail_content>\", \"Predicate push down\": \"<detail_content>\"}}}, {\"title\": \"Exasol connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 8]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Type mapping\": {\"Exasol to Trino type mapping\": \"<detail_content>\", \"Mapping numeric types\": \"<detail_content>\", \"Mapping character types\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}}}, {\"title\": \"Faker connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 9]\", \"content\": {\"Configuration\": {\"Character types\": \"<detail_content>\", \"Non-character types\": \"<detail_content>\", \"Unsupported types\": \"<detail_content>\", \"Number of generated rows\": \"<detail_content>\", \"Null values\": \"<detail_content>\"}, \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\", \"Usage\": {\"Using existing data statistics\": \"<detail_content>\"}}}, {\"title\": \"Google Sheets connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 10]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Configuration properties\": \"<detail_content>\", \"Credentials\": \"<detail_content>\", \"Metadata sheet\": \"<detail_content>\", \"Querying sheets\": \"<detail_content>\", \"Writing to sheets\": \"<detail_content>\", \"API usage limits\": \"<detail_content>\", \"Type mapping\": {\"Google Sheets type to Trino type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Table functions\": {\"`sheet(id, range) -> table`\": \"<detail_content>\"}}}}, {\"title\": \"Hive connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 11]\", \"content\": {\"Requirements\": \"<detail_content>\", \"General configuration\": {\"Multiple Hive clusters\": \"<detail_content>\", \"Hive general configuration properties\": \"<detail_content>\", \"File system access configuration\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Security\": \"<detail_content>\", \"Authorization\": {\"SQL standard based authorization\": \"<detail_content>\"}, \"SQL support\": {\"Basic usage examples\": \"<detail_content>\", \"Procedures\": \"<detail_content>\", \"Data management\": \"<detail_content>\", \"Schema and table management\": {\"Schema evolution\": \"<detail_content>\", \"Avro schema evolution\": {\"Limitations\": \"<detail_content>\"}, \"ALTER TABLE EXECUTE\": \"<detail_content>\", \"Table properties\": \"<detail_content>\", \"Metadata tables\": {\"`$properties` table\": \"<detail_content>\", \"`$partitions` table\": \"<detail_content>\"}, \"Column properties\": \"<detail_content>\", \"Metadata columns\": \"<detail_content>\"}, \"View management\": {\"Materialized views\": \"<detail_content>\", \"Hive views\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": {\"Updating table and partition statistics\": \"<detail_content>\"}, \"Dynamic filtering\": {\"Delaying execution for dynamic filters\": \"<detail_content>\"}, \"Table redirection\": \"<detail_content>\", \"File system cache\": \"<detail_content>\", \"Performance tuning configuration properties\": \"<detail_content>\"}, \"Hive 3-related limitations\": \"<detail_content>\"}}, {\"title\": \"Hudi connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 12]\", \"content\": {\"Requirements\": \"<detail_content>\", \"General configuration\": \"<detail_content>\", \"File system access configuration\": \"<detail_content>\", \"SQL support\": {\"Basic usage examples\": \"<detail_content>\", \"Schema and table management\": {\"Metadata tables\": {\"`$timeline` table\": \"<detail_content>\"}}}}}, {\"title\": \"Iceberg connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 13]\", \"content\": {\"Requirements\": \"<detail_content>\", \"General configuration\": {\"Fault-tolerant execution support\": \"<detail_content>\"}, \"File system access configuration\": \"<detail_content>\", \"Type mapping\": {\"Iceberg to Trino type mapping\": \"<detail_content>\", \"Trino to Iceberg type mapping\": \"<detail_content>\"}, \"Security\": {\"Kerberos authentication\": \"<detail_content>\", \"Authorization\": \"<detail_content>\"}, \"SQL support\": {\"Basic usage examples\": \"<detail_content>\", \"Procedures\": {\"Register table\": \"<detail_content>\", \"Unregister table\": \"<detail_content>\", \"Migrate table\": \"<detail_content>\", \"Add files\": \"<detail_content>\"}, \"Functions\": {\"bucket\": \"<detail_content>\"}, \"Data management\": {\"Deletion by partition\": \"<detail_content>\", \"Row level deletion\": \"<detail_content>\"}, \"Schema and table management\": {\"Schema evolution\": \"<detail_content>\", \"ALTER TABLE EXECUTE\": {\"optimize\": \"<detail_content>\", \"optimize_manifests\": \"<detail_content>\", \"expire_snapshots\": \"<detail_content>\", \"remove_orphan_files\": \"<detail_content>\", \"drop_extended_stats\": \"<detail_content>\"}, \"ALTER TABLE SET PROPERTIES\": {\"Table properties\": \"<detail_content>\"}, \"Metadata tables\": {\"`$properties` table\": \"<detail_content>\", \"`$history` table\": \"<detail_content>\", \"`$metadata_log_entries` table\": \"<detail_content>\", \"`$snapshots` table\": \"<detail_content>\", \"`$manifests` and `$all_manifests` tables\": \"<detail_content>\", \"`$partitions` table\": \"<detail_content>\", \"`$files` table\": \"<detail_content>\", \"`$entries` and `$all_entries` tables\": \"<detail_content>\", \"`$refs` table\": \"<detail_content>\"}, \"Metadata columns\": \"<detail_content>\", \"System tables\": {\"`iceberg_tables` table\": \"<detail_content>\"}, \"DROP TABLE\": \"<detail_content>\", \"COMMENT\": \"<detail_content>\", \"Partitioned tables\": \"<detail_content>\", \"Sorted tables\": \"<detail_content>\", \"Using snapshots\": \"<detail_content>\", \"Replace tables\": {\"Time travel queries\": \"<detail_content>\", \"Rolling back to a previous snapshot\": \"<detail_content>\"}, \"`NOT NULL` column constraint\": \"<detail_content>\"}, \"Materialized views\": \"<detail_content>\", \"Table functions\": {\"table_changes\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": {\"Updating table statistics\": \"<detail_content>\"}, \"Table redirection\": \"<detail_content>\", \"File system cache\": \"<detail_content>\", \"Iceberg metadata caching\": \"<detail_content>\"}}}, {\"title\": \"Ignite connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 14]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Ignite servers\": \"<detail_content>\"}, \"Table properties\": {\"`primary_key`\": \"<detail_content>\"}, \"Type mapping\": \"<detail_content>\", \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"JMX connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 15]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Querying JMX\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Kafka connector tutorial\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 16]\", \"content\": {\"Introduction\": \"<detail_content>\", \"Installation\": {\"Step 1: Install Apache Kafka\": \"<detail_content>\", \"Step 2: Load data\": \"<detail_content>\", \"Step 3: Make the Kafka topics known to Trino\": \"<detail_content>\", \"Step 4: Basic data querying\": \"<detail_content>\", \"Step 5: Add a topic description file\": \"<detail_content>\", \"Step 6: Map all the values from the topic message onto columns\": \"<detail_content>\", \"Step 7: Use live data\": {\"Setup a live Twitter feed\": \"<detail_content>\", \"Create a tweets table on Trino\": \"<detail_content>\", \"Feed live data\": \"<detail_content>\"}, \"Epilogue: Time stamps\": \"<detail_content>\"}}}, {\"title\": \"Kafka connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 17]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Kafka clusters\": \"<detail_content>\", \"Log levels\": \"<detail_content>\"}, \"Configuration properties\": {\"`kafka.default-schema`\": \"<detail_content>\", \"`kafka.nodes`\": \"<detail_content>\", \"`kafka.buffer-size`\": \"<detail_content>\", \"`kafka.timestamp-upper-bound-force-push-down-enabled`\": \"<detail_content>\", \"`kafka.hide-internal-columns`\": \"<detail_content>\", \"`kafka.security-protocol`\": \"<detail_content>\", \"`kafka.ssl.keystore.location`\": \"<detail_content>\", \"`kafka.ssl.keystore.password`\": \"<detail_content>\", \"`kafka.ssl.keystore.type`\": \"<detail_content>\", \"`kafka.ssl.truststore.location`\": \"<detail_content>\", \"`kafka.ssl.truststore.password`\": \"<detail_content>\", \"`kafka.ssl.truststore.type`\": \"<detail_content>\", \"`kafka.ssl.key.password`\": \"<detail_content>\", \"`kafka.ssl.endpoint-identification-algorithm`\": \"<detail_content>\"}, \"Internal columns\": \"<detail_content>\", \"Table schema and schema registry usage\": {\"File table description supplier\": {\"`kafka.table-names`\": \"<detail_content>\", \"`kafka.table-description-dir`\": \"<detail_content>\", \"Table definition files\": \"<detail_content>\", \"Key and message in Kafka\": \"<detail_content>\"}, \"Confluent table description supplier\": {\"Confluent subject to table name mapping\": \"<detail_content>\", \"Protobuf-specific type handling in Confluent table description supplier\": {\"oneof\": \"<detail_content>\"}}}, \"Kafka inserts\": \"<detail_content>\", \"Type mapping\": {\"Row encoding\": {\"Raw encoder\": \"<detail_content>\", \"CSV encoder\": \"<detail_content>\", \"JSON encoder\": \"<detail_content>\", \"Avro encoder\": \"<detail_content>\", \"Protobuf encoder\": \"<detail_content>\"}, \"Row decoding\": {\"Raw decoder\": \"<detail_content>\", \"CSV decoder\": \"<detail_content>\", \"JSON decoder\": {\"Default field decoder\": \"<detail_content>\", \"Date and time decoders\": \"<detail_content>\"}, \"Avro decoder\": {\"Avro schema evolution\": \"<detail_content>\"}, \"Protobuf decoder\": {\"any\": \"<detail_content>\", \"Protobuf schema evolution\": \"<detail_content>\", \"Protobuf limitations\": \"<detail_content>\"}}}, \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Lakehouse connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 18]\", \"content\": {\"General configuration\": \"<detail_content>\", \"Configuration properties\": \"<detail_content>\", \"File system access configuration\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"Loki connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 19]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Type mapping\": {\"Loki to Trino type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Table functions\": \"<detail_content>\", \"`query_range(varchar, timestamp, timestamp) -> table`\": \"<detail_content>\"}, \"Examples\": \"<detail_content>\"}}, {\"title\": \"MariaDB connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 20]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Fault-tolerant execution support\": \"<detail_content>\"}, \"Querying MariaDB\": \"<detail_content>\", \"Type mapping\": {\"MariaDB type to Trino type mapping\": \"<detail_content>\", \"Trino type mapping to MariaDB type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": \"<detail_content>\", \"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"Memory connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 21]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": {\"TRUNCATE and DROP TABLE\": \"<detail_content>\"}, \"Dynamic filtering\": {\"Delayed execution for dynamic filters\": \"<detail_content>\"}, \"Limitations\": \"<detail_content>\"}}, {\"title\": \"MongoDB connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 22]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple MongoDB clusters\": \"<detail_content>\"}, \"Configuration properties\": {\"`mongodb.connection-url`\": \"<detail_content>\", \"`mongodb.schema-collection`\": \"<detail_content>\", \"`mongodb.case-insensitive-name-matching`\": \"<detail_content>\", \"`mongodb.min-connections-per-host`\": \"<detail_content>\", \"`mongodb.connections-per-host`\": \"<detail_content>\", \"`mongodb.max-wait-time`\": \"<detail_content>\", \"`mongodb.max-connection-idle-time`\": \"<detail_content>\", \"`mongodb.connection-timeout`\": \"<detail_content>\", \"`mongodb.socket-timeout`\": \"<detail_content>\", \"`mongodb.tls.enabled`\": \"<detail_content>\", \"`mongodb.tls.keystore-path`\": \"<detail_content>\", \"`mongodb.tls.truststore-path`\": \"<detail_content>\", \"`mongodb.tls.keystore-password`\": \"<detail_content>\", \"`mongodb.tls.truststore-password`\": \"<detail_content>\", \"`mongodb.read-preference`\": \"<detail_content>\", \"`mongodb.write-concern`\": \"<detail_content>\", \"`mongodb.required-replica-set`\": \"<detail_content>\", \"`mongodb.cursor-batch-size`\": \"<detail_content>\", \"`mongodb.allow-local-scheduling`\": \"<detail_content>\", \"`mongodb.dynamic-filtering.wait-timeout`\": \"<detail_content>\"}, \"Table definition\": \"<detail_content>\", \"ObjectId\": {\"ObjectId timestamp functions\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Type mapping\": {\"MongoDB to Trino type mapping\": \"<detail_content>\", \"Trino to MongoDB type mapping\": \"<detail_content>\"}, \"SQL support\": {\"ALTER TABLE\": \"<detail_content>\", \"Table functions\": {\"`query(database, collection, filter) -> table`\": \"<detail_content>\"}}}}, {\"title\": \"MySQL connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 23]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Connection security\": \"<detail_content>\", \"Multiple MySQL servers\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Table properties\": \"<detail_content>\", \"Type mapping\": {\"MySQL to Trino type mapping\": \"<detail_content>\", \"Trino to MySQL type mapping\": \"<detail_content>\", \"Timestamp type handling\": \"<detail_content>\"}, \"Querying MySQL\": \"<detail_content>\", \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": \"<detail_content>\", \"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"OpenSearch connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 24]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Authentication\": \"<detail_content>\", \"Connection security with TLS\": \"<detail_content>\"}, \"Type mapping\": {\"OpenSearch type to Trino type mapping\": \"<detail_content>\", \"Array types\": \"<detail_content>\", \"Date types\": \"<detail_content>\", \"Raw JSON transform\": \"<detail_content>\"}, \"Special columns\": \"<detail_content>\", \"SQL support\": {\"Wildcard table\": \"<detail_content>\", \"Table functions\": {\"`raw_query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Parallel data access\": \"<detail_content>\", \"Predicate push down\": \"<detail_content>\"}}}, {\"title\": \"Oracle connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 25]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Oracle servers\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Querying Oracle\": {\"Examples\": \"<detail_content>\"}, \"Type mapping\": {\"Oracle to Trino type mapping\": \"<detail_content>\", \"Trino to Oracle type mapping\": \"<detail_content>\", \"Mapping numeric types\": \"<detail_content>\", \"Mapping datetime types\": \"<detail_content>\", \"Mapping character types\": \"<detail_content>\", \"Number to decimal configuration properties\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Synonyms\": \"<detail_content>\", \"Pushdown\": {\"Predicate pushdown support\": \"<detail_content>\"}}}}, {\"title\": \"Pinot connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 26]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Configuration properties\": {\"General configuration properties\": \"<detail_content>\", \"gRPC configuration properties\": \"<detail_content>\"}, \"Querying Pinot tables\": \"<detail_content>\", \"Dynamic tables\": \"<detail_content>\", \"Type mapping\": {\"Pinot type to Trino type mapping\": {\"Date Type\": \"<detail_content>\", \"Null Handling\": \"<detail_content>\"}}, \"SQL support\": \"<detail_content>\", \"Pushdown\": \"<detail_content>\"}}, {\"title\": \"PostgreSQL connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 27]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Access to system tables\": \"<detail_content>\", \"Connection security\": \"<detail_content>\", \"Multiple PostgreSQL databases or servers\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Type mapping\": {\"PostgreSQL type to Trino type mapping\": \"<detail_content>\", \"Trino type to PostgreSQL type mapping\": \"<detail_content>\", \"Array type handling\": \"<detail_content>\"}, \"Querying PostgreSQL\": \"<detail_content>\", \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Table statistics\": \"<detail_content>\", \"Pushdown\": \"<detail_content>\", \"Predicate pushdown support\": \"<detail_content>\"}}}, {\"title\": \"Prometheus connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 28]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Configuration properties\": \"<detail_content>\", \"Not exhausting your Trino available heap\": \"<detail_content>\", \"Bearer token authentication\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Redis connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 29]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Redis servers\": \"<detail_content>\"}, \"Configuration properties\": {\"`redis.table-names`\": \"<detail_content>\", \"`redis.default-schema`\": \"<detail_content>\", \"`redis.nodes`\": \"<detail_content>\", \"`redis.scan-count`\": \"<detail_content>\", \"`redis.max-keys-per-fetch`\": \"<detail_content>\", \"`redis.key-prefix-schema-table`\": \"<detail_content>\", \"`redis.key-delimiter`\": \"<detail_content>\", \"`redis.table-description-dir`\": \"<detail_content>\", \"`redis.table-description-cache-ttl`\": \"<detail_content>\", \"`redis.hide-internal-columns`\": \"<detail_content>\", \"`redis.database-index`\": \"<detail_content>\", \"`redis.user`\": \"<detail_content>\", \"`redis.password`\": \"<detail_content>\"}, \"Internal columns\": \"<detail_content>\", \"Table definition files\": \"<detail_content>\", \"Type mapping\": {\"Row decoding\": \"<detail_content>\"}, \"SQL support\": \"<detail_content>\", \"Performance\": {\"Pushdown\": {\"Predicate pushdown support\": \"<detail_content>\"}}}}, {\"title\": \"Redshift connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 30]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Connection security\": \"<detail_content>\", \"Multiple Redshift databases or clusters\": \"<detail_content>\"}, \"Fault-tolerant execution support\": \"<detail_content>\", \"Querying Redshift\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Parallel read via S3\": \"<detail_content>\"}}}, {\"title\": \"Removed\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 31]\", \"content\": {\"404 - Connector removed\": \"<detail_content>\"}}, {\"title\": \"SingleStore connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 32]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Connection security\": \"<detail_content>\", \"Multiple SingleStore servers\": \"<detail_content>\"}, \"Querying SingleStore\": \"<detail_content>\", \"Type mapping\": {\"Singlestore to Trino type mapping\": \"<detail_content>\", \"Trino to Singlestore type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\"}, \"Performance\": {\"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"Snowflake connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 33]\", \"content\": {\"Configuration\": {\"Multiple Snowflake databases or accounts\": \"<detail_content>\"}, \"Type mapping\": {\"Snowflake type to Trino type mapping\": \"<detail_content>\", \"Trino type to Snowflake type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}}, \"Performance\": {\"Pushdown\": \"<detail_content>\"}}}, {\"title\": \"SQL Server connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 34]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Connection security\": \"<detail_content>\", \"Multiple SQL Server databases or servers\": \"<detail_content>\", \"Specific configuration properties\": \"<detail_content>\", \"Fault-tolerant execution support\": \"<detail_content>\"}, \"Querying SQL Server\": \"<detail_content>\", \"Type mapping\": {\"SQL Server type to Trino type mapping\": \"<detail_content>\", \"Trino type to SQL Server type mapping\": \"<detail_content>\", \"Numeric type mapping\": \"<detail_content>\", \"Character type mapping\": \"<detail_content>\"}, \"SQL support\": {\"Procedures\": \"<detail_content>\", \"Table functions\": {\"`query(varchar) -> table`\": \"<detail_content>\"}, \"`procedure(varchar) -> table`\": \"<detail_content>\"}, \"Performance\": {\"Table statistics\": \"<detail_content>\", \"Pushdown\": {\"Predicate pushdown support\": \"<detail_content>\"}, \"Bulk insert\": \"<detail_content>\"}, \"Data compression\": \"<detail_content>\"}}, {\"title\": \"System connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 35]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Using the System connector\": \"<detail_content>\", \"System connector tables\": {\"`metadata.catalogs`\": \"<detail_content>\", \"`metadata.schema_properties`\": \"<detail_content>\", \"`metadata.table_properties`\": \"<detail_content>\", \"`metadata.materialized_views`\": \"<detail_content>\", \"`metadata.materialized_view_properties`\": \"<detail_content>\", \"`metadata.table_comments`\": \"<detail_content>\", \"`runtime.nodes`\": \"<detail_content>\", \"`runtime.optimizer_rule_stats`\": \"<detail_content>\", \"`runtime.queries`\": \"<detail_content>\", \"`runtime.tasks`\": \"<detail_content>\", \"`runtime.transactions`\": \"<detail_content>\"}, \"System connector procedures\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Thrift connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 36]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"Multiple Thrift systems\": \"<detail_content>\"}, \"Configuration properties\": {\"`trino.thrift.client.addresses`\": \"<detail_content>\", \"`trino-thrift.max-response-size`\": \"<detail_content>\", \"`trino-thrift.metadata-refresh-threads`\": \"<detail_content>\"}, \"TrinoThriftService implementation\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"TPC-DS connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 37]\", \"content\": {\"Configuration\": \"<detail_content>\", \"TPC-DS schemas\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"TPC-H connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 38]\", \"content\": {\"Configuration\": \"<detail_content>\", \"TPC-H schemas\": \"<detail_content>\", \"Type mapping\": \"<detail_content>\", \"SQL support\": \"<detail_content>\"}}, {\"title\": \"Vertica connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 39]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Type mapping\": {\"Vertica to Trino type mapping\": \"<detail_content>\", \"Trino to Vertica type mapping\": \"<detail_content>\"}, \"SQL support\": \"<detail_content>\", \"Table functions\": {\"`query(VARCHAR) -> table`\": \"<detail_content>\"}, \"Performance\": {\"Pushdown\": \"<detail_content>\", \"Table statistics\": \"<detail_content>\"}}}]}, {\"title\": \"Develop\", \"description\": \"Documentation section: develop\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21]\", \"subpages\": [{\"title\": \"Certificate authenticator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 0]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"Trino client REST API\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 1]\", \"content\": {\"HTTP methods\": \"<detail_content>\", \"Overview of query processing\": \"<detail_content>\", \"Important `QueryResults` attributes\": \"<detail_content>\", \"`QueryResults` diagnostic attributes\": \"<detail_content>\", \"Client request headers\": \"<detail_content>\", \"Client response headers\": \"<detail_content>\", \"`ProtocolHeaders`\": \"<detail_content>\"}}, {\"title\": \"Connectors\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 2]\", \"content\": {\"ConnectorFactory\": {\"Configuration\": \"<detail_content>\"}, \"ConnectorMetadata\": {\"Limit and top-N pushdown\": \"<detail_content>\", \"Predicate pushdown\": \"<detail_content>\"}, \"ConnectorSplitManager\": \"<detail_content>\", \"ConnectorRecordSetProvider\": {\"Type mapping\": \"<detail_content>\"}, \"ConnectorPageSourceProvider\": \"<detail_content>\", \"ConnectorPageSinkProvider\": \"<detail_content>\"}}, {\"title\": \"Event listener\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 3]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Multiple event listeners\": \"<detail_content>\"}}, {\"title\": \"Example HTTP connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 4]\", \"content\": {\"Installation\": \"<detail_content>\", \"Code\": \"<detail_content>\", \"Plugin implementation\": \"<detail_content>\", \"ConnectorFactory implementation\": {\"Connector: ExampleConnector\": \"<detail_content>\", \"Metadata: ExampleMetadata\": \"<detail_content>\", \"Split manager: ExampleSplitManager\": \"<detail_content>\", \"Record set provider: ExampleRecordSetProvider\": \"<detail_content>\"}}}, {\"title\": \"Example JDBC connector\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 5]\", \"content\": {\"Code\": \"<detail_content>\", \"Plugin implementation\": \"<detail_content>\", \"JdbcClient implementation\": {\"toColumnMapping\": \"<detail_content>\", \"toWriteMapping\": \"<detail_content>\"}}}, {\"title\": \"Functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 6]\", \"content\": {\"Plugin implementation\": \"<detail_content>\", \"Scalar function implementation\": \"<detail_content>\", \"Parametric scalar functions\": \"<detail_content>\", \"Another scalar function example\": \"<detail_content>\", \"Aggregation function implementation\": \"<detail_content>\", \"Deprecated function\": \"<detail_content>\"}}, {\"title\": \"Group provider\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 7]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"Header authenticator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 8]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"Insert\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 9]\", \"content\": {\"Supporting `INSERT` and `CREATE TABLE AS`\": \"<detail_content>\"}}, {\"title\": \"Password authenticator\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 10]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"SPI overview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 11]\", \"content\": {\"Code\": \"<detail_content>\", \"Plugin metadata\": \"<detail_content>\", \"Plugin\": \"<detail_content>\", \"Building plugins via Maven\": \"<detail_content>\", \"Deploying a custom plugin\": \"<detail_content>\", \"Compatibility\": \"<detail_content>\"}}, {\"title\": \"Supporting `MERGE`\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 12]\", \"content\": {\"Standard SQL `MERGE`\": \"<detail_content>\", \"`RowChangeParadigm`\": \"<detail_content>\", \"Overview of `MERGE` processing\": \"<detail_content>\", \"`MERGE` redistribution\": {\"Connector support for `MERGE`\": \"<detail_content>\"}, \"`RowChangeProcessor` implementation for `MERGE`\": \"<detail_content>\", \"Detecting duplicate matching target rows\": \"<detail_content>\", \"`ConnectorMergeTableHandle` API\": \"<detail_content>\", \"`ConnectorPageSinkProvider` API\": \"<detail_content>\", \"`ConnectorMergeSink` API\": \"<detail_content>\", \"`ConnectorMetadata` `MERGE` API\": \"<detail_content>\"}}, {\"title\": \"System access control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 13]\", \"content\": {\"Implementation\": \"<detail_content>\", \"Configuration\": \"<detail_content>\"}}, {\"title\": \"Table functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 14]\", \"content\": {\"Table function declaration\": {\"The constructor\": \"<detail_content>\", \"Argument types\": {\"Scalar arguments\": \"<detail_content>\", \"Descriptor arguments\": \"<detail_content>\", \"Table arguments\": {\"Set or row semantics\": \"<detail_content>\", \"Prune or keep when empty\": \"<detail_content>\", \"Pass-through columns\": \"<detail_content>\"}}, \"The `analyze()` method\": \"<detail_content>\"}, \"Table function execution\": \"<detail_content>\", \"Access control\": \"<detail_content>\"}}, {\"title\": \"Test writing guidelines\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 15]\", \"content\": {\"Conventions and recommendations\": \"<detail_content>\", \"Guidelines\": {\"Focus on high value tests\": \"<detail_content>\", \"Avoid combinatorial tests\": \"<detail_content>\", \"Avoid product tests\": \"<detail_content>\", \"Avoid creating testing abstractions\": \"<detail_content>\", \"Avoid data providers and parametric tests\": \"<detail_content>\", \"Avoid writing stateful test classes\": \"<detail_content>\", \"Do not try to manage memory\": \"<detail_content>\", \"Use simple resource initialization\": \"<detail_content>\", \"Keep test setup and teardown simple\": \"<detail_content>\", \"Ensure testability of new plugin and connector features\": \"<detail_content>\", \"Keep focus on plugin and connector tests\": \"<detail_content>\", \"Avoid flaky tests\": \"<detail_content>\", \"Avoid disabling tests\": \"<detail_content>\", \"Avoid using `Assumptions.abort()`\": \"<detail_content>\", \"Avoid test inheritance\": \"<detail_content>\"}, \"Avoid helper assertions\": \"<detail_content>\", \"Examples\": {\"Concurrency for tests\": \"<detail_content>\", \"Avoid manual lifecycle management\": \"<detail_content>\"}, \"Avoid fake abstractions\": \"<detail_content>\", \"Avoid custom parallelization\": \"<detail_content>\", \"Avoid parameterized tests\": \"<detail_content>\"}}, {\"title\": \"Types\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 16]\", \"content\": {\"Native container type\": \"<detail_content>\", \"Native encoding\": \"<detail_content>\", \"Type signature\": \"<detail_content>\"}}]}, {\"title\": \"Functions\", \"description\": \"Documentation section: functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22]\", \"subpages\": [{\"title\": \"Aggregate functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 0]\", \"content\": {\"Ordering during aggregation\": \"<detail_content>\", \"Filtering during aggregation\": \"<detail_content>\", \"General aggregate functions\": \"<detail_content>\", \"Bitwise aggregate functions\": \"<detail_content>\", \"Map aggregate functions\": \"<detail_content>\", \"Approximate aggregate functions\": \"<detail_content>\", \"Statistical aggregate functions\": \"<detail_content>\", \"Lambda aggregate functions\": \"<detail_content>\"}}, {\"title\": \"AI functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 1]\", \"content\": {\"Configuration\": {\"Providers\": {\"Anthropic \": \"<detail_content>\", \"OpenAI\": \"<detail_content>\", \"Ollama\": \"<detail_content>\"}, \"Model configuration\": \"<detail_content>\"}, \"Functions\": \"<detail_content>\"}}, {\"title\": \"Array functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 2]\", \"content\": {\"Subscript operator: \\\\[\\\\]\": \"<detail_content>\", \"Concatenation operator: ||\": \"<detail_content>\", \"Array functions\": \"<detail_content>\"}}, {\"title\": \"Binary functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 3]\", \"content\": {\"Binary operators\": \"<detail_content>\", \"Binary functions\": \"<detail_content>\", \"Base64 encoding functions\": \"<detail_content>\", \"Hex encoding functions\": \"<detail_content>\", \"Integer encoding functions\": \"<detail_content>\", \"Floating-point encoding functions\": \"<detail_content>\", \"Hashing functions\": \"<detail_content>\", \"HMAC functions\": \"<detail_content>\"}}, {\"title\": \"Bitwise\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 4]\", \"content\": {\"Bitwise functions\": \"<detail_content>\"}}, {\"title\": \"Color\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 5]\", \"content\": {\"Color functions\": \"<detail_content>\"}}, {\"title\": \"Comparison functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 6]\", \"content\": {\"Comparison operators\": \"<detail_content>\", \"Range operator: BETWEEN\": \"<detail_content>\", \"IS NULL and IS NOT NULL\": \"<detail_content>\", \"IS DISTINCT FROM and IS NOT DISTINCT FROM\": \"<detail_content>\", \"GREATEST and LEAST\": \"<detail_content>\", \"Quantified comparison predicates: ALL, ANY and SOME\": \"<detail_content>\", \"Pattern comparison: LIKE\": \"<detail_content>\", \"Row comparison: IN\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"Conditional expressions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 7]\", \"content\": {\"CASE\": \"<detail_content>\", \"IF\": \"<detail_content>\", \"COALESCE\": \"<detail_content>\", \"NULLIF\": \"<detail_content>\", \"TRY\": {\"Examples\": \"<detail_content>\"}}}, {\"title\": \"Conversion functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 8]\", \"content\": {\"Conversion functions\": \"<detail_content>\", \"Formatting\": \"<detail_content>\", \"Data size\": \"<detail_content>\", \"Miscellaneous\": \"<detail_content>\"}}, {\"title\": \"Date and time functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 9]\", \"content\": {\"Date and time operators\": \"<detail_content>\", \"Time zone conversion\": \"<detail_content>\", \"Date and time functions\": \"<detail_content>\", \"Truncation function\": \"<detail_content>\", \"Interval functions\": \"<detail_content>\", \"Duration function\": \"<detail_content>\", \"MySQL date functions\": \"<detail_content>\", \"Java date functions\": \"<detail_content>\", \"Extraction function\": \"<detail_content>\", \"Convenience extraction functions\": \"<detail_content>\"}}, {\"title\": \"Decimal functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 10]\", \"content\": {\"Decimal literals\": \"<detail_content>\", \"Binary arithmetic decimal operators\": \"<detail_content>\", \"Comparison operators\": \"<detail_content>\", \"Unary decimal operators\": \"<detail_content>\"}}, {\"title\": \"Geospatial functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 11]\", \"content\": {\"Constructors\": \"<detail_content>\", \"Relationship tests\": \"<detail_content>\", \"Operations\": \"<detail_content>\", \"Accessors\": \"<detail_content>\", \"Aggregations\": \"<detail_content>\", \"Bing tiles\": \"<detail_content>\", \"Encoded polylines\": \"<detail_content>\"}}, {\"title\": \"HyperLogLog functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 12]\", \"content\": {\"Data structures\": \"<detail_content>\", \"Serialization\": \"<detail_content>\", \"Functions\": \"<detail_content>\"}}, {\"title\": \"Ipaddress\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 13]\", \"content\": {\"IP Address Functions\": \"<detail_content>\"}}, {\"title\": \"JSON functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 14]\", \"content\": {\"JSON path language\": {\"JSON path syntax and semantics\": {\"literals\": \"<detail_content>\", \"variables\": \"<detail_content>\", \"arithmetic binary expressions\": \"<detail_content>\", \"arithmetic unary expressions\": \"<detail_content>\", \"member accessor\": \"<detail_content>\", \"wildcard member accessor\": \"<detail_content>\", \"descendant member accessor\": \"<detail_content>\", \"array accessor\": \"<detail_content>\", \"wildcard array accessor\": \"<detail_content>\", \"filter\": {\"Comparison rules\": \"<detail_content>\", \"Examples of filter\": \"<detail_content>\"}, \"double()\": \"<detail_content>\", \"ceiling(), floor(), and abs()\": \"<detail_content>\", \"keyvalue()\": \"<detail_content>\", \"type()\": \"<detail_content>\", \"size()\": \"<detail_content>\"}, \"Limitations\": \"<detail_content>\", \"JSON path modes\": {\"Examples of the lax mode behavior\": \"<detail_content>\"}}, \"json_exists\": {\"Examples\": \"<detail_content>\"}, \"json_query\": {\"Examples\": \"<detail_content>\"}, \"json_value\": {\"Examples\": \"<detail_content>\"}, \"json_table\": {\"Examples\": \"<detail_content>\"}, \"json_array\": {\"Argument types\": \"<detail_content>\", \"Null handling\": \"<detail_content>\", \"Returned type\": \"<detail_content>\"}, \"json_object\": {\"Argument passing conventions\": \"<detail_content>\", \"Argument types\": \"<detail_content>\", \"Null handling\": \"<detail_content>\", \"Key uniqueness\": \"<detail_content>\", \"Returned type\": \"<detail_content>\"}, \"Cast to JSON\": \"<detail_content>\", \"Cast from JSON\": \"<detail_content>\", \"Other JSON functions\": \"<detail_content>\"}}, {\"title\": \"Lambda expressions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 15]\", \"content\": {\"Limitations\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"List of functions by topic\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 16]\", \"content\": {\"Aggregate\": \"<detail_content>\", \"Array\": \"<detail_content>\", \"Binary\": \"<detail_content>\", \"Bitwise\": \"<detail_content>\", \"Color\": \"<detail_content>\", \"Comparison\": \"<detail_content>\", \"Conditional\": \"<detail_content>\", \"Conversion\": \"<detail_content>\", \"Date and time\": \"<detail_content>\", \"Geospatial\": \"<detail_content>\", \"HyperLogLog\": \"<detail_content>\", \"JSON\": \"<detail_content>\", \"Lambda\": \"<detail_content>\", \"Machine learning\": \"<detail_content>\", \"Map\": \"<detail_content>\", \"Math\": \"<detail_content>\", \"Quantile digest\": \"<detail_content>\", \"Regular expression\": \"<detail_content>\", \"Row pattern recognition expressions\": \"<detail_content>\", \"Session\": \"<detail_content>\", \"Set Digest\": \"<detail_content>\", \"String\": \"<detail_content>\", \"System\": \"<detail_content>\", \"Table\": \"<detail_content>\", \"T-Digest\": \"<detail_content>\", \"Teradata\": \"<detail_content>\", \"URL\": \"<detail_content>\", \"UUID\": \"<detail_content>\", \"Window\": \"<detail_content>\"}}, {\"title\": \"List of functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 17]\", \"content\": {\"\\\\#\": \"<detail_content>\", \"A\": \"<detail_content>\", \"B\": \"<detail_content>\", \"C\": \"<detail_content>\", \"D\": \"<detail_content>\", \"E\": \"<detail_content>\", \"F\": \"<detail_content>\", \"G\": \"<detail_content>\", \"H\": \"<detail_content>\", \"I\": \"<detail_content>\", \"J\": \"<detail_content>\", \"K\": \"<detail_content>\", \"L\": \"<detail_content>\", \"M\": \"<detail_content>\", \"N\": \"<detail_content>\", \"O\": \"<detail_content>\", \"P\": \"<detail_content>\", \"Q\": \"<detail_content>\", \"R\": \"<detail_content>\", \"S\": \"<detail_content>\", \"T\": \"<detail_content>\", \"U\": \"<detail_content>\", \"V\": \"<detail_content>\", \"W\": \"<detail_content>\", \"X\": \"<detail_content>\", \"Y\": \"<detail_content>\", \"Z\": \"<detail_content>\"}}, {\"title\": \"Logical operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 18]\", \"content\": {\"Logical operators\": \"<detail_content>\", \"Effect of NULL on logical operators\": \"<detail_content>\"}}, {\"title\": \"Map functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 19]\", \"content\": {\"Subscript operator: \\\\[\\\\]\": \"<detail_content>\", \"Map functions\": \"<detail_content>\"}}, {\"title\": \"Mathematical functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 20]\", \"content\": {\"Mathematical operators\": \"<detail_content>\", \"Mathematical functions\": \"<detail_content>\", \"Random functions\": \"<detail_content>\", \"Trigonometric functions\": \"<detail_content>\", \"Geometric functions\": \"<detail_content>\", \"Floating point functions\": \"<detail_content>\", \"Base conversion functions\": \"<detail_content>\", \"Statistical functions\": \"<detail_content>\", \"Cumulative distribution functions\": \"<detail_content>\"}}, {\"title\": \"Machine learning functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 21]\", \"content\": {\"Feature vector\": \"<detail_content>\", \"Classification\": \"<detail_content>\", \"Regression\": \"<detail_content>\", \"Machine learning functions\": \"<detail_content>\"}}, {\"title\": \"Quantile digest functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 22]\", \"content\": {\"Data structures\": \"<detail_content>\", \"Functions\": \"<detail_content>\"}}, {\"title\": \"Regexp\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 23]\", \"content\": {\"Regular expression functions\": \"<detail_content>\"}}, {\"title\": \"Session\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 24]\", \"content\": {\"Session information\": \"<detail_content>\"}}, {\"title\": \"Set Digest functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 25]\", \"content\": {\"Data structures\": \"<detail_content>\", \"Serialization\": \"<detail_content>\", \"Functions\": \"<detail_content>\"}}, {\"title\": \"String functions and operators\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 26]\", \"content\": {\"String operators\": \"<detail_content>\", \"String functions\": \"<detail_content>\", \"Unicode functions\": \"<detail_content>\"}}, {\"title\": \"System\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 27]\", \"content\": {\"System information\": \"<detail_content>\"}}, {\"title\": \"Table functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 28]\", \"content\": {\"Built-in table functions\": {\"`exclude_columns` table function\": \"<detail_content>\", \"`sequence` table function\": \"<detail_content>\"}, \"Table function invocation\": {\"Function resolution\": \"<detail_content>\", \"Arguments\": \"<detail_content>\", \"Argument passing conventions\": \"<detail_content>\"}}}, {\"title\": \"T-Digest functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 29]\", \"content\": {\"Data structures\": \"<detail_content>\", \"Functions\": \"<detail_content>\"}}, {\"title\": \"Teradata functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 30]\", \"content\": {\"String functions\": \"<detail_content>\", \"Date functions\": \"<detail_content>\"}}, {\"title\": \"URL functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 31]\", \"content\": {\"Extraction functions\": \"<detail_content>\", \"Encoding functions\": \"<detail_content>\"}}, {\"title\": \"Uuid\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 32]\", \"content\": {\"UUID functions\": \"<detail_content>\"}}, {\"title\": \"Window functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 33]\", \"content\": {\"Aggregate functions\": \"<detail_content>\", \"Ranking functions\": \"<detail_content>\", \"Value functions\": \"<detail_content>\"}}]}, {\"title\": \"Installation\", \"description\": \"Documentation section: installation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23]\", \"subpages\": [{\"title\": \"Trino in a Docker container\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 0]\", \"content\": {\"Running the container\": \"<detail_content>\", \"Executing queries\": \"<detail_content>\", \"Configuring Trino\": \"<detail_content>\", \"Cleaning up\": \"<detail_content>\"}}, {\"title\": \"Deploying Trino\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 1]\", \"content\": {\"Requirements\": {\"Linux operating system\": \"<detail_content>\", \"Java runtime environment\": \"<detail_content>\"}, \"Installing Trino\": \"<detail_content>\", \"Configuring Trino\": {\"Node properties\": \"<detail_content>\", \"JVM config\": {\"Temporary directory\": \"<detail_content>\"}, \"Config properties\": \"<detail_content>\", \"Catalog properties\": \"<detail_content>\"}, \"Running Trino\": \"<detail_content>\"}}, {\"title\": \"Trino on Kubernetes with Helm\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 2]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Running Trino using Helm\": \"<detail_content>\", \"Executing queries\": \"<detail_content>\", \"Configuration\": {\"Creating your own YAML configuration\": \"<detail_content>\", \"Adding catalogs\": \"<detail_content>\"}, \"Running a local Kubernetes cluster with kind\": \"<detail_content>\", \"Cleaning up\": \"<detail_content>\"}}, {\"title\": \"Plugins \", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 3]\", \"content\": {\"Download\": \"<detail_content>\", \"Installation\": \"<detail_content>\", \"Removal\": \"<detail_content>\", \"Development\": \"<detail_content>\", \"List of plugins\": \"<detail_content>\"}}, {\"title\": \"Improve query processing resilience\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 4]\", \"content\": {\"Architecture\": \"<detail_content>\", \"Best practices and considerations\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Next steps\": \"<detail_content>\"}}]}, {\"title\": \"Language\", \"description\": \"Documentation section: language\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24]\", \"subpages\": [{\"title\": \"Comments\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 0]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"Keywords and identifiers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 1]\", \"content\": {\"Reserved keywords\": \"<detail_content>\", \"Identifiers\": \"<detail_content>\"}}, {\"title\": \"SQL statement support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 2]\", \"content\": {\"Globally available statements\": {\"Catalog management\": \"<detail_content>\"}, \"Read operations\": \"<detail_content>\", \"Write operations\": {\"Data management\": \"<detail_content>\", \"Schema and table management\": \"<detail_content>\", \"View management\": \"<detail_content>\", \"Materialized view management\": \"<detail_content>\", \"User-defined function management\": \"<detail_content>\"}, \"Security operations\": \"<detail_content>\", \"Transactions\": \"<detail_content>\"}}, {\"title\": \"Data types\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 3]\", \"content\": {\"Trino type support and mapping\": \"<detail_content>\", \"Boolean\": {\"`BOOLEAN`\": \"<detail_content>\"}, \"Integer\": {\"`TINYINT`\": \"<detail_content>\", \"`SMALLINT`\": \"<detail_content>\", \"`INTEGER` or `INT`\": \"<detail_content>\", \"`BIGINT`\": \"<detail_content>\"}, \"Floating-point\": {\"`REAL`\": \"<detail_content>\", \"`DOUBLE`\": \"<detail_content>\"}, \"Exact numeric\": {\"`DECIMAL`\": \"<detail_content>\"}, \"String\": {\"`VARCHAR`\": \"<detail_content>\", \"`CHAR`\": \"<detail_content>\", \"`VARBINARY`\": \"<detail_content>\", \"`JSON`\": \"<detail_content>\"}, \"Date and time\": {\"`DATE`\": \"<detail_content>\", \"`TIME`\": \"<detail_content>\", \"`TIME(P)`\": \"<detail_content>\", \"`TIME WITH TIME ZONE`\": \"<detail_content>\", \"`TIMESTAMP`\": \"<detail_content>\", \"`TIMESTAMP(P)`\": \"<detail_content>\", \"`TIMESTAMP WITH TIME ZONE`\": \"<detail_content>\", \"`TIMESTAMP(P) WITH TIME ZONE`\": \"<detail_content>\", \"`INTERVAL YEAR TO MONTH`\": \"<detail_content>\", \"`INTERVAL DAY TO SECOND`\": \"<detail_content>\"}, \"Structural\": {\"`ARRAY`\": \"<detail_content>\", \"`MAP`\": \"<detail_content>\", \"`ROW`\": \"<detail_content>\"}, \"Network address\": {\"`IPADDRESS`\": \"<detail_content>\"}, \"UUID\": {\"`UUID`\": \"<detail_content>\"}, \"HyperLogLog\": {\"`HyperLogLog`\": \"<detail_content>\", \"`P4HyperLogLog`\": \"<detail_content>\"}, \"SetDigest\": {\"`SetDigest`\": \"<detail_content>\"}, \"Quantile digest\": {\"`QDigest`\": \"<detail_content>\"}, \"T-Digest\": {\"`TDigest`\": \"<detail_content>\"}}}]}, {\"title\": \"Object Storage\", \"description\": \"Documentation section: object-storage\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25]\", \"subpages\": [{\"title\": \"Object storage file formats\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 0]\", \"content\": {\"ORC format configuration properties\": \"<detail_content>\", \"Parquet format configuration properties\": \"<detail_content>\"}}, {\"title\": \"Alluxio file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 1]\", \"content\": {\"Configuration\": \"<detail_content>\", \"Alluxio client configuration\": \"<detail_content>\"}}, {\"title\": \"Azure Storage file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 2]\", \"content\": {\"General configuration\": \"<detail_content>\", \"User-assigned managed identity authentication\": \"<detail_content>\", \"Access key authentication\": \"<detail_content>\", \"OAuth 2.0 authentication\": \"<detail_content>\", \"Access multiple storage accounts\": \"<detail_content>\", \"Migration from legacy Azure Storage file system\": \"<detail_content>\"}}, {\"title\": \"File system cache\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 3]\", \"content\": {\"Distributed caching\": \"<detail_content>\", \"Benefits\": \"<detail_content>\", \"Configuration\": \"<detail_content>\", \"Monitoring\": \"<detail_content>\", \"Recommendations\": \"<detail_content>\"}}, {\"title\": \"Google Cloud Storage file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 4]\", \"content\": {\"General configuration\": \"<detail_content>\", \"Authentication\": \"<detail_content>\", \"Migration from legacy Google Cloud Storage file system\": \"<detail_content>\"}}, {\"title\": \"HDFS file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 5]\", \"content\": {\"General configuration\": \"<detail_content>\", \"Security\": {\"HDFS impersonation\": \"<detail_content>\", \"HDFS Kerberos authentication\": {\"Keytab files\": \"<detail_content>\"}}, \"Security configuration examples\": {\"Default `NONE` authentication without impersonation\": \"<detail_content>\", \"`NONE` authentication with impersonation\": \"<detail_content>\", \"`KERBEROS` authentication without impersonation\": \"<detail_content>\", \"`KERBEROS` authentication with impersonation\": \"<detail_content>\"}}}, {\"title\": \"Local file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 6]\", \"content\": {\"General configuration\": \"<detail_content>\"}}, {\"title\": \"S3 file system support\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 7]\", \"content\": {\"General configuration\": \"<detail_content>\", \"Authentication\": \"<detail_content>\", \"Security mapping\": \"<detail_content>\", \"Migration from legacy S3 file system\": \"<detail_content>\"}}, {\"title\": \"Metastores\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 8]\", \"content\": {\"General metastore configuration properties\": \"<detail_content>\", \"Thrift metastore configuration properties\": {\"Iceberg-specific Hive catalog configuration properties\": \"<detail_content>\", \"Thrift metastore authentication\": {\"Default `NONE` authentication without impersonation\": \"<detail_content>\", \"`KERBEROS` authentication with impersonation\": \"<detail_content>\"}}, \"AWS Glue catalog configuration properties\": {\"Iceberg-specific Glue catalog configuration properties\": \"<detail_content>\"}, \"Iceberg-specific metastores\": {\"REST catalog\": \"<detail_content>\", \"JDBC catalog\": \"<detail_content>\", \"Nessie catalog\": \"<detail_content>\", \"Snowflake catalog\": \"<detail_content>\"}, \"Access tables with Athena partition projection metadata\": \"<detail_content>\", \"Configure metastore for Avro\": \"<detail_content>\"}}]}, {\"title\": \"Optimizer\", \"description\": \"Documentation section: optimizer\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26]\", \"subpages\": [{\"title\": \"Adaptive plan optimizations\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 0]\", \"content\": {\"Adaptive reordering of partitioned joins\": \"<detail_content>\"}}, {\"title\": \"Cost-based optimizations\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 1]\", \"content\": {\"Join enumeration\": \"<detail_content>\", \"Join distribution selection\": {\"Capping replicated table size\": \"<detail_content>\"}, \"Syntactic join order\": \"<detail_content>\", \"Connector implementations\": \"<detail_content>\"}}, {\"title\": \"Cost In Explain\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 2]\", \"content\": {\"Cost in EXPLAIN\": \"<detail_content>\"}}, {\"title\": \"Pushdown\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 3]\", \"content\": {\"Predicate pushdown\": \"<detail_content>\", \"Projection pushdown\": \"<detail_content>\", \"Dereference pushdown\": \"<detail_content>\", \"Aggregation pushdown\": {\"Limitations\": \"<detail_content>\"}, \"Join pushdown\": \"<detail_content>\", \"Limit pushdown\": \"<detail_content>\", \"Top-N pushdown\": \"<detail_content>\"}}, {\"title\": \"Table statistics\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 4]\", \"content\": {\"Available statistics\": \"<detail_content>\"}}]}, {\"title\": \"Overview\", \"description\": \"Documentation section: overview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27]\", \"subpages\": [{\"title\": \"Trino concepts\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27, \\\"subpages\\\", 0]\", \"content\": {\"Overview\": \"<detail_content>\", \"Architecture\": {\"Cluster\": \"<detail_content>\", \"Node\": \"<detail_content>\", \"Coordinator\": \"<detail_content>\", \"Worker\": \"<detail_content>\"}, \"Client\": \"<detail_content>\", \"Plugin\": \"<detail_content>\", \"Data source\": {\"Connector\": \"<detail_content>\", \"Catalog\": \"<detail_content>\", \"Schema\": \"<detail_content>\", \"Table\": \"<detail_content>\"}, \"Query execution model\": {\"Statement\": \"<detail_content>\", \"Query\": \"<detail_content>\", \"Stage\": \"<detail_content>\", \"Task\": \"<detail_content>\", \"Split\": \"<detail_content>\", \"Driver\": \"<detail_content>\", \"Operator\": \"<detail_content>\", \"Exchange\": \"<detail_content>\"}}}, {\"title\": \"Use cases\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27, \\\"subpages\\\", 1]\", \"content\": {\"What Trino is not\": \"<detail_content>\", \"What Trino is\": \"<detail_content>\"}}]}, {\"title\": \"Release\", \"description\": \"Documentation section: release\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28]\", \"subpages\": [{\"title\": \"Release 0.100\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 0]\", \"content\": {\"System connector\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.101\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 1]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.102\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 2]\", \"content\": {\"Unicode support\": \"<detail_content>\", \"Regular expression functions\": \"<detail_content>\", \"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.103\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 3]\", \"content\": {\"Cluster resource management\": \"<detail_content>\", \"Task parallelism\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.104\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 4]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.105\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 5]\", \"content\": {\"General\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.106\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 6]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.107\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 7]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.108\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 8]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\"}}, {\"title\": \"Release 0.109\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 9]\", \"content\": {\"General\": \"<detail_content>\", \"Remove \\\"Big Query\\\" support\": \"<detail_content>\"}}, {\"title\": \"Release 0.110\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 10]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.111\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 11]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.112\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 12]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.113\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 13]\", \"content\": {\"Cluster resource management\": \"<detail_content>\", \"Session properties\": \"<detail_content>\", \"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.114\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 14]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.115\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 15]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.116\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 16]\", \"content\": {\"Cast between JSON and VARCHAR\": \"<detail_content>\", \"Cluster memory manager improvements\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.117\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 17]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.118\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 18]\", \"content\": {\"General\": \"<detail_content>\", \"Authorization\": \"<detail_content>\"}}, {\"title\": \"Release 0.119\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 19]\", \"content\": {\"General\": \"<detail_content>\", \"SPI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL and PostgreSQL\": \"<detail_content>\"}}, {\"title\": \"Release 0.120\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 20]\", \"content\": {\"Release 0.120\": \"<detail_content>\"}}, {\"title\": \"Release 0.121\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 21]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.122\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 22]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.123\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 23]\", \"content\": {\"General\": \"<detail_content>\", \"Table properties\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.124\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 24]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Verifier\": \"<detail_content>\"}}, {\"title\": \"Release 0.125\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 25]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.126\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 26]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.127\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 27]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.128\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 28]\", \"content\": {\"Graceful shutdown\": \"<detail_content>\", \"General\": \"<detail_content>\", \"MySQL\": \"<detail_content>\"}}, {\"title\": \"Release 0.129\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 29]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Network topology aware scheduling\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.130\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 30]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.131\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 31]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.132\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 32]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.133\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 33]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.134\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 34]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.135\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 35]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.136\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 36]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.137\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 37]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.138\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 38]\", \"content\": {\"General\": \"<detail_content>\", \"New Hive Parquet reader\": \"<detail_content>\"}}, {\"title\": \"Release 0.139\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 39]\", \"content\": {\"Dynamic split concurrency\": \"<detail_content>\", \"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.140\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 40]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.141\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 41]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.142\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 42]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.143\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 43]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.1\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 44]\", \"content\": {\"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.2\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 45]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.3\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 46]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.4\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 47]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.5\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 48]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.6\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 49]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.144.7\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 50]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.144\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 51]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.145\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 52]\", \"content\": {\"General\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.146\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 53]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Black Hole\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\"}}, {\"title\": \"Release 0.147\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 54]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Kafka\": \"<detail_content>\", \"Redis\": \"<detail_content>\", \"MySQL and PostgreSQL\": \"<detail_content>\"}}, {\"title\": \"Release 0.148\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 55]\", \"content\": {\"General\": \"<detail_content>\", \"Interval fixes\": \"<detail_content>\", \"Functions and language features\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Kafka\": \"<detail_content>\", \"JMX\": \"<detail_content>\", \"MySQL and PostgreSQL\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 0.149\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 56]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.150\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 57]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.151\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 58]\", \"content\": {\"General\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.152.1\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 59]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.152.2\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 60]\", \"content\": {\"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.152.3\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 61]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.152\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 62]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"SPI\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"Local file\": \"<detail_content>\"}}, {\"title\": \"Release 0.153\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 63]\", \"content\": {\"General\": \"<detail_content>\", \"Functions and language features\": \"<detail_content>\", \"Pluggable resource groups\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"JMX\": \"<detail_content>\", \"MySQL\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"Blackhole\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.154\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 64]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.155\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 65]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.156\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 66]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Redis\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.157.1\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 67]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.157\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 68]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.158\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 69]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\"}}, {\"title\": \"Release 0.159\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 70]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.160\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 71]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.161\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 72]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"JMX connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.162\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 73]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.163\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 74]\", \"content\": {\"General\": \"<detail_content>\", \"Accumulo\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.164\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 75]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.165\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 76]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL and PostgreSQL\": \"<detail_content>\"}}, {\"title\": \"Release 0.166\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 77]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.167\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 78]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.168\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 79]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.169\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 80]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\"}}, {\"title\": \"Release 0.170\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 81]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Verifier\": \"<detail_content>\"}}, {\"title\": \"Release 0.171\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 82]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.172\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 83]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.173\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 84]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.174\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 85]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.175\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 86]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\"}}, {\"title\": \"Release 0.176\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 87]\", \"content\": {\"General\": \"<detail_content>\", \"MySQL\": \"<detail_content>\", \"Accumulo\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\"}}, {\"title\": \"Release 0.177\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 88]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\"}}, {\"title\": \"Release 0.178\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 89]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.179\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 90]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.180\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 91]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.181\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 92]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"Accumulo\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.182\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 93]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.183\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 94]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"TPC-H\": \"<detail_content>\", \"TPC-DS\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.184\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 95]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"TPC-DS\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.185\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 96]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.186\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 97]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.187\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 98]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.188\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 99]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Resource group\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.189\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 100]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Resource group\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL, PostgreSQL, Redshift, and SQL Server shanges\": \"<detail_content>\", \"Kafka\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.190\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 101]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Accumulo\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.191\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 102]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"MySQL, PostgreSQL, Redshift, and SQL Server\": \"<detail_content>\"}}, {\"title\": \"Release 0.192\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 103]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\", \"JMX\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.193\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 104]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Blackhole\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MongoDB\": \"<detail_content>\"}}, {\"title\": \"Release 0.194\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 105]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\"}}, {\"title\": \"Release 0.195\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 106]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI and JDBC\": \"<detail_content>\", \"MySQL\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL, Redis, Kafka, and MongoDB\": \"<detail_content>\"}}, {\"title\": \"Release 0.196\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 107]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.197\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 108]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.198\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 109]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"JMX\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.199\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 110]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.200\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 111]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"MySQL\": \"<detail_content>\"}}, {\"title\": \"Release 0.201\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 112]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.202\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 113]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.203\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 114]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"Local file connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.204\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 115]\", \"content\": {\"General\": \"<detail_content>\", \"Event listener\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Resource group\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.205\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 116]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.206\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 117]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.207\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 118]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.208\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 119]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\"}}, {\"title\": \"Release 0.209\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 120]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.210\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 121]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.211\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 122]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"Resource group\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.212\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 123]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"Verifier\": \"<detail_content>\"}}, {\"title\": \"Release 0.213\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 124]\", \"content\": {\"General\": \"<detail_content>\", \"Geospatial\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"Verifier\": \"<detail_content>\"}}, {\"title\": \"Release 0.214\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 125]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Verifier\": \"<detail_content>\"}}, {\"title\": \"Release 0.215\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 126]\", \"content\": {\"General\": \"<detail_content>\", \"Geospatial\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Redis\": \"<detail_content>\"}}, {\"title\": \"Release 0.54\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 127]\", \"content\": {\"Release 0.54\": \"<detail_content>\"}}, {\"title\": \"Release 0.55\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 128]\", \"content\": {\"RC binary 2-4x gain in CPU efficiency\": \"<detail_content>\", \"Hash distributed aggregations\": \"<detail_content>\", \"Simple distinct aggregations\": \"<detail_content>\", \"Range predicate pushdown\": \"<detail_content>\", \"json_array_get function\": \"<detail_content>\", \"Non-reserved keywords\": \"<detail_content>\", \"CLI source option\": \"<detail_content>\", \"SHOW SCHEMAS FROM\": \"<detail_content>\", \"Hive bucketed table fixes\": \"<detail_content>\"}}, {\"title\": \"Release 0.56\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 129]\", \"content\": {\"Table creation\": \"<detail_content>\", \"Cross joins\": \"<detail_content>\"}}, {\"title\": \"Release 0.57\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 130]\", \"content\": {\"Distinct aggregations\": \"<detail_content>\", \"Hadoop 2.x\": \"<detail_content>\", \"Amazon S3\": \"<detail_content>\", \"Miscellaneous\": \"<detail_content>\"}}, {\"title\": \"Release 0.58\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 131]\", \"content\": {\"Release 0.58\": \"<detail_content>\"}}, {\"title\": \"Release 0.59\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 132]\", \"content\": {\"Release 0.59\": \"<detail_content>\"}}, {\"title\": \"Release 0.60\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 133]\", \"content\": {\"JDBC improvements\": \"<detail_content>\", \"USE CATALOG and USE SCHEMA\": \"<detail_content>\", \"TPC-H connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\", \"Optimizations\": {\"DISTINCT LIMIT\": \"<detail_content>\", \"Range predicates\": \"<detail_content>\", \"Compound filters\": \"<detail_content>\", \"Window functions\": \"<detail_content>\"}, \"Bug fixes\": \"<detail_content>\"}}, {\"title\": \"Release 0.61\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 134]\", \"content\": {\"Add support for table value constructors\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Amazon S3 support\": \"<detail_content>\", \"Miscellaneous\": \"<detail_content>\"}}, {\"title\": \"Release 0.62\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 135]\", \"content\": {\"Release 0.62\": \"<detail_content>\"}}, {\"title\": \"Release 0.63\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 136]\", \"content\": {\"Release 0.63\": \"<detail_content>\"}}, {\"title\": \"Release 0.64\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 137]\", \"content\": {\"Release 0.64\": \"<detail_content>\"}}, {\"title\": \"Release 0.65\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 138]\", \"content\": {\"Release 0.65\": \"<detail_content>\"}}, {\"title\": \"Release 0.66\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 139]\", \"content\": {\"Type system\": \"<detail_content>\", \"Date/time types\": {\"Time zones\": \"<detail_content>\", \"Localization\": \"<detail_content>\"}, \"Optimizations\": \"<detail_content>\", \"SPI\": \"<detail_content>\", \"General bug fixes\": \"<detail_content>\", \"Hive bug fixes\": \"<detail_content>\", \"Cassandra bug fixes\": \"<detail_content>\"}}, {\"title\": \"Release 0.67\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 140]\", \"content\": {\"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.68\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 141]\", \"content\": {\"Release 0.68\": \"<detail_content>\"}}, {\"title\": \"Release 0.69\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 142]\", \"content\": {\"Prevent scheduling work on coordinator\": \"<detail_content>\", \"Datasource configuration\": \"<detail_content>\", \"Raptor connector\": \"<detail_content>\", \"Machine learning functions\": \"<detail_content>\", \"Variable length binary type\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.70\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 143]\", \"content\": {\"Views\": \"<detail_content>\", \"DUAL table\": \"<detail_content>\", \"Presto Verifier\": \"<detail_content>\", \"Connector improvements\": \"<detail_content>\", \"Machine learning functions\": \"<detail_content>\", \"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.71\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 144]\", \"content\": {\"Release 0.71\": \"<detail_content>\"}}, {\"title\": \"Release 0.72\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 145]\", \"content\": {\"Release 0.72\": \"<detail_content>\"}}, {\"title\": \"Release 0.73\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 146]\", \"content\": {\"Cassandra plugin\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.74\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 147]\", \"content\": {\"Bytecode compiler\": \"<detail_content>\", \"Hive storage format\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.75\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 148]\", \"content\": {\"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\", \"JSON function\": \"<detail_content>\", \"Scheduler\": \"<detail_content>\", \"Row number optimizations\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.76\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 149]\", \"content\": {\"Kafka connector\": \"<detail_content>\", \"MySQL and PostgreSQL connectors\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.77\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 150]\", \"content\": {\"Parametric types\": \"<detail_content>\", \"Streaming index joins\": \"<detail_content>\", \"Distributed joins\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Kafka\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.78\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 151]\", \"content\": {\"ARRAY and MAP types in Hive connector\": \"<detail_content>\", \"Session properties\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.79\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 152]\", \"content\": {\"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.80\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 153]\", \"content\": {\"New Hive ORC reader\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Cassandra\": \"<detail_content>\", \"\\\"Big Query\\\" support\": \"<detail_content>\", \"Metadata-only query optimization\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.81\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 154]\", \"content\": {\"Hive\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.82\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 155]\", \"content\": {\"Release 0.82\": \"<detail_content>\"}}, {\"title\": \"Release 0.83\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 156]\", \"content\": {\"Raptor\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.84\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 157]\", \"content\": {\"Release 0.84\": \"<detail_content>\"}}, {\"title\": \"Release 0.85\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 158]\", \"content\": {\"Release 0.85\": \"<detail_content>\"}}, {\"title\": \"Release 0.86\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 159]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.87\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 160]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.88\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 161]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.89\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 162]\", \"content\": {\"DATE type\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.90\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 163]\", \"content\": {\"General\": \"<detail_content>\", \"Functions and language features\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 0.91\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 164]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.92\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 165]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.93\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 166]\", \"content\": {\"ORC memory usage\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.94\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 167]\", \"content\": {\"ORC memory usage\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.95\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 168]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.96\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 169]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.97\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 170]\", \"content\": {\"General\": \"<detail_content>\", \"Hive\": \"<detail_content>\"}}, {\"title\": \"Release 0.98\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 171]\", \"content\": {\"Array, map, and row types\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"SPI\": \"<detail_content>\", \"General\": \"<detail_content>\"}}, {\"title\": \"Release 0.99\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 172]\", \"content\": {\"General\": \"<detail_content>\"}}, {\"title\": \"Release 300 (22 Jan 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 173]\", \"content\": {\"General\": \"<detail_content>\", \"JMX MBean naming\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"System connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Raptor Legacy connector\": \"<detail_content>\", \"Verifier\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 301 (31 Jan 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 174]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 302 (6 Feb 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 175]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 303 (13 Feb 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 176]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Mongo connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 304 (27 Feb 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 177]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\"}}, {\"title\": \"Release 305 (7 Mar 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 178]\", \"content\": {\"General\": \"<detail_content>\", \"Resource groups\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\"}}, {\"title\": \"Release 306 (16 Mar 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 179]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 307 (3 Apr 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 180]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 308 (11 Apr 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 181]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\"}}, {\"title\": \"Release 309 (25 Apr 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 182]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 310 (3 May 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 183]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Blackhole connector\": \"<detail_content>\"}}, {\"title\": \"Release 311 (14 May 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 184]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Black Hole connector\": \"<detail_content>\", \"System connector\": \"<detail_content>\"}}, {\"title\": \"Release 312 (29 May 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 185]\", \"content\": {\"General\": \"<detail_content>\", \"Server\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 313 (31 May 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 186]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\"}}, {\"title\": \"Release 314 (7 Jun 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 187]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 315 (14 Jun 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 188]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 316 (8 Jul 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 189]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"TPC-H connector\": \"<detail_content>\", \"TPC-DS connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 317 (1 Aug 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 190]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 318 (26 Aug 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 191]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 319 (22 Sep 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 192]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\"}}, {\"title\": \"Release 320 (10 Oct 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 193]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 321 (15 Oct 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 194]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"JMX connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 322 (16 Oct 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 195]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 323 (23 Oct 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 196]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 324 (1 Nov 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 197]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"Elasticsearch\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 325 (14 Nov 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 198]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 326 (27 Nov 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 199]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 327 (20 Dec 2019)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 200]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 328 (10 Jan 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 201]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 329 (23 Jan 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 202]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 330 (18 Feb 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 203]\", \"content\": {\"General\": \"<detail_content>\", \"Server\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 331 (16 Mar 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 204]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 332 (08 Apr 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 205]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 333 (04 May 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 206]\", \"content\": {\"General\": \"<detail_content>\", \"Server\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\"}}, {\"title\": \"Release 334 (29 May 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 207]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 335 (14 Jun 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 208]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 336 (16 Jun 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 209]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\"}}, {\"title\": \"Release 337 (25 Jun 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 210]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\"}}, {\"title\": \"Release 338 (07 Jul 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 211]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\"}}, {\"title\": \"Release 339 (21 Jul 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 212]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 340 (8 Aug 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 213]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 341 (8 Sep 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 214]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"JMX connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kinesis connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Local File connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Raptor connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 342 (24 Sep 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 215]\", \"content\": {\"General\": \"<detail_content>\", \"Atop connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 343 (25 Sep 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 216]\", \"content\": {\"BigQuery connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 344 (9 Oct 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 217]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 345 (23 Oct 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 218]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\"}}, {\"title\": \"Release 346 (10 Nov 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 219]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 347 (25 Nov 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 220]\", \"content\": {\"General\": \"<detail_content>\", \"Server\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 348 (14 Dec 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 221]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 349\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 222]\", \"content\": {\"Release 349 (28 Dec 2020)\": \"<detail_content>\"}}, {\"title\": \"Release 350 (28 Dec 2020)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 223]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 351 (3 Jan 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 224]\", \"content\": {\"General\": \"<detail_content>\", \"JMX MBean naming\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Local file connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 352 (9 Feb 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 225]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kinesis connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 353 (5 Mar 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 226]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 354 (19 Mar 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 227]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 355 (8 Apr 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 228]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 356 (30 Apr 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 229]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 357 (21 May 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 230]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Kinesis connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Other connectors\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 358 (1 Jun 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 231]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC Driver\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 359 (1 Jul 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 232]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 360 (30 Jul 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 233]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 361 (27 Aug 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 234]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 362 (20 Sep 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 235]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"TPC-H connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 363 (6 Oct 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 236]\", \"content\": {\"General\": \"<detail_content>\", \"Python client\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 364 (1 Nov 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 237]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 365 (3 Dec 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 238]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 366 (14 Dec 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 239]\", \"content\": {\"General\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MemSQL connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 367 (22 Dec 2021)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 240]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 368 (11 Jan 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 241]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 369 (24 Jan 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 242]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 370 (3 Feb 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 243]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"RPM package\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 371 (16 Feb 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 244]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 372 (2 Mar 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 245]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Base-JDBC connector library\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 373 (9 Mar 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 246]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 374 (17 Mar 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 247]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\"}}, {\"title\": \"Release 375 (28 Mar 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 248]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 376 (7 Apr 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 249]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 377 (13 Apr 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 250]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 378 (21 Apr 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 251]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 379 (28 Apr 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 252]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 380 (6 May 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 253]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 381 (16 May 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 254]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 382 (25 May 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 255]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 383 (1 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 256]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Raptor connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 384 (3 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 257]\", \"content\": {\"General\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 385 (8 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 258]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"TPC-H connector\": \"<detail_content>\"}}, {\"title\": \"Release 386 (15 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 259]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 387 (22 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 260]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 388 (29 Jun 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 261]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\"}}, {\"title\": \"Release 389 (7 Jul 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 262]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 390 (13 Jul 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 263]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\"}}, {\"title\": \"Release 391 (22 Jul 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 264]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 392 (3 Aug 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 265]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 393 (17 Aug 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 266]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Raptor connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 394 (29 Aug 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 267]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 395 (7 Sep 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 268]\", \"content\": {\"General\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 396 (15 Sep 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 269]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 397 (21 Sep 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 270]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 398 (28 Sep 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 271]\", \"content\": {\"General\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 399 (6 Oct 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 272]\", \"content\": {\"General\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 400 (13 Oct 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 273]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 401 (26 Oct 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 274]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 402 (2 Nov 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 275]\", \"content\": {\"General\": \"<detail_content>\", \"Blackhole connector\": \"<detail_content>\", \"Clickhouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore (MemSQL) connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 403 (15 Nov 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 276]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 404\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 277]\", \"content\": {\"Release 404 (???)\": \"<detail_content>\"}}, {\"title\": \"Release 405 (28 Dec 2022)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 278]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 406 (25 Jan 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 279]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 407 (16 Feb 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 280]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 408 (23 Feb 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 281]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Thrift connector\": \"<detail_content>\"}}, {\"title\": \"Release 409 (3 Mar 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 282]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 410 (8 Mar 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 283]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\"}}, {\"title\": \"Release 411 (29 Mar 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 284]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 412 (5 Apr 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 285]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 413 (12 Apr 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 286]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 414 (19 Apr 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 287]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 415 (28 Apr 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 288]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 416 (3 May 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 289]\", \"content\": {\"General\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\"}}, {\"title\": \"Release 417 (10 May 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 290]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\"}}, {\"title\": \"Release 418 (17 May 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 291]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kinesis connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\"}}, {\"title\": \"Release 419 (5 Jun 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 292]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 420 (22 Jun 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 293]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 421 (6 Jul 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 294]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 422 (13 Jul 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 295]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 423 (10 Aug 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 296]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Blackhole connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kafka connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 424 (17 Aug 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 297]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 425 (24 Aug 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 298]\", \"content\": {\"General\": \"<detail_content>\", \"BlackHole connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\"}}, {\"title\": \"Release 426 (5 Sep 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 299]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 427 (26 Sep 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 300]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 428 (4 Oct 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 301]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\"}}, {\"title\": \"Release 429 (11 Oct 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 302]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 430 (20 Oct 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 303]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 431 (27 Oct 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 304]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 432 (2 Nov 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 305]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 433 (10 Nov 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 306]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 434 (29 Nov 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 307]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 435 (13 Dec 2023)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 308]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 436 (11 Jan 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 309]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"ElasticSearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 437 (24 Jan 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 310]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\"}}, {\"title\": \"Release 438 (1 Feb 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 311]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 439 (15 Feb 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 312]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 440 (8 Mar 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 313]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 441 (13 Mar 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 314]\", \"content\": {\"General\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\"}}, {\"title\": \"Release 442 (14 Mar 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 315]\", \"content\": {\"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"OpenSearch connector\": \"<detail_content>\"}}, {\"title\": \"Release 443 (21 Mar 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 316]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 444 (3 Apr 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 317]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQLServer connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 445 (17 Apr 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 318]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redis connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\"}}, {\"title\": \"Release 446 (1 May 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 319]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 447 (8 May 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 320]\", \"content\": {\"General\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 448 (15 May 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 321]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\"}}, {\"title\": \"Release 449 (31 May 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 322]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\"}}, {\"title\": \"Release 450 (19 Jun 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 323]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Pinot connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\"}}, {\"title\": \"Release 451 (27 Jun 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 324]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 452 (11 Jul 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 325]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Black Hole connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 453 (25 Jul 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 326]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Exasol connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 454 (15 Aug 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 327]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 455 (29 Aug 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 328]\", \"content\": {\"General\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"OpenSearch connector\": \"<detail_content>\", \"PostgreSQL\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 456\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 329]\", \"content\": {\"Release 456 (6 Sep 2024)\": \"<detail_content>\"}}, {\"title\": \"Release 457 (6 Sep 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 330]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Blackhole connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"Prometheus connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 458 (17 Sep 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 331]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Exasol connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 459 (25 Sep 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 332]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Local file connector\": \"<detail_content>\", \"OpenSearch connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 460 (3 Oct 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 333]\", \"content\": {\"General\": \"<detail_content>\", \"Atop connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Raptor connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\"}}, {\"title\": \"Release 461 (10 Oct 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 334]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 462 (16 Oct 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 335]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\"}}, {\"title\": \"Release 463 (23 Oct 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 336]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\"}}, {\"title\": \"Release 464 (30 Oct 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 337]\", \"content\": {\"General\": \"<detail_content>\", \"Accumulo connector\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\"}}, {\"title\": \"Release 465 (20 Nov 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 338]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector \": \"<detail_content>\", \"Cassandra connector\": \"<detail_content>\", \"Clickhouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"Exasol connector\": \"<detail_content>\", \"Faker connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Vertica connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 466 (27 Nov 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 339]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 467 (6 Dec 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 340]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Delta Lake\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 468 (17 Dec 2024)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 341]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 469 (27 Jan 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 342]\", \"content\": {\"General\": \"<detail_content>\", \"Web UI\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Elasticsearch connector\": \"<detail_content>\", \"Faker connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Vertica connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 470 (5 Feb 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 343]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Faker connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"JMX connector\": \"<detail_content>\", \"Kinesis connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\"}}, {\"title\": \"Release 471 (19 Feb 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 344]\", \"content\": {\"General\": \"<detail_content>\", \"Server RPM\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"MongoDB connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 472 (5 Mar 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 345]\", \"content\": {\"General\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Faker connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Loki connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 473 (19 Mar 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 346]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Kudu connector\": \"<detail_content>\", \"Phoenix connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 474 (21 Mar 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 347]\", \"content\": {\"General\": \"<detail_content>\", \"Docker image\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\"}}, {\"title\": \"Release 475 (23 Apr 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 348]\", \"content\": {\"General\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"JDBC driver\": \"<detail_content>\", \"CLI\": \"<detail_content>\", \"Clickhouse connector\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}, {\"title\": \"Release 476 (5 Jun 2025)\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 349]\", \"content\": {\"General\": \"<detail_content>\", \"BigQuery connector\": \"<detail_content>\", \"ClickHouse connector\": \"<detail_content>\", \"Delta Lake connector\": \"<detail_content>\", \"Druid connector\": \"<detail_content>\", \"DuckDB connector\": \"<detail_content>\", \"Exasol connector\": \"<detail_content>\", \"Google Sheets connector\": \"<detail_content>\", \"Hive connector\": \"<detail_content>\", \"Hudi connector\": \"<detail_content>\", \"Iceberg connector\": \"<detail_content>\", \"Ignite connector\": \"<detail_content>\", \"Kafka event Listener\": \"<detail_content>\", \"MariaDB connector\": \"<detail_content>\", \"Memory connector\": \"<detail_content>\", \"MySQL connector\": \"<detail_content>\", \"Oracle connector\": \"<detail_content>\", \"PostgreSQL connector\": \"<detail_content>\", \"Redshift connector\": \"<detail_content>\", \"SingleStore connector\": \"<detail_content>\", \"Snowflake connector\": \"<detail_content>\", \"SQL Server connector\": \"<detail_content>\", \"Vertica connector\": \"<detail_content>\", \"SPI\": \"<detail_content>\"}}]}, {\"title\": \"Security\", \"description\": \"Documentation section: security\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29]\", \"subpages\": [{\"title\": \"Authentication types\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 0]\", \"content\": {\"Multiple authentication types\": \"<detail_content>\", \"Multiple password authenticators\": \"<detail_content>\", \"Multiple header authenticators\": \"<detail_content>\"}}, {\"title\": \"System access control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 1]\", \"content\": {\"Multiple access control systems\": \"<detail_content>\", \"Available access control systems\": \"<detail_content>\", \"Read only system access control\": \"<detail_content>\"}}, {\"title\": \"Certificate authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 2]\", \"content\": {\"Using certificate authentication\": \"<detail_content>\", \"Certificate authentication configuration\": \"<detail_content>\", \"Use certificate authentication with clients\": \"<detail_content>\"}}, {\"title\": \"File-based access control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 3]\", \"content\": {\"System-level access control files\": {\"Configuration\": \"<detail_content>\", \"Refresh\": \"<detail_content>\", \"Catalog, schema, and table access\": {\"Visibility\": \"<detail_content>\", \"Catalog rules\": \"<detail_content>\", \"Schema rules\": \"<detail_content>\", \"Table rules\": \"<detail_content>\", \"Column constraint\": \"<detail_content>\", \"Filter and mask environment\": \"<detail_content>\", \"Function rules\": \"<detail_content>\", \"Procedure rules\": \"<detail_content>\", \"Table procedure rules\": \"<detail_content>\", \"Verify configuration\": \"<detail_content>\"}, \"Session property rules\": \"<detail_content>\", \"Query rules\": \"<detail_content>\", \"Impersonation rules\": \"<detail_content>\", \"Principal rules\": \"<detail_content>\", \"System information rules\": \"<detail_content>\", \"Authorization rules\": \"<detail_content>\"}, \"Catalog-level access control files\": {\"Configure a catalog rules file\": {\"Schema rules\": \"<detail_content>\", \"Table rules\": {\"Column constraints\": \"<detail_content>\", \"Filter environment and mask environment\": \"<detail_content>\"}, \"Function rules\": \"<detail_content>\", \"Session property rules\": \"<detail_content>\"}, \"Example\": \"<detail_content>\"}}}, {\"title\": \"File group provider\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 4]\", \"content\": {\"Group file configuration\": \"<detail_content>\", \"Group files\": {\"File format\": \"<detail_content>\"}}}, {\"title\": \"JKS files\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 5]\", \"content\": {\"Inspect and validate keystore\": \"<detail_content>\", \"Extra: add PEM to keystore\": \"<detail_content>\", \"Extra: Java truststores\": \"<detail_content>\"}}, {\"title\": \"PEM files\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 6]\", \"content\": {\"Inspect PEM file\": \"<detail_content>\", \"Validate PEM key section\": \"<detail_content>\", \"Validate PEM certificate section\": \"<detail_content>\"}}, {\"title\": \"Secure internal communication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 7]\", \"content\": {\"Configure shared secret\": {\"Verify configuration\": \"<detail_content>\"}, \"Configure internal TLS\": {\"Performance with SSL/TLS enabled\": \"<detail_content>\", \"Advanced performance tuning\": \"<detail_content>\"}}}, {\"title\": \"JWT authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 8]\", \"content\": {\"Using JWT authentication\": \"<detail_content>\", \"JWT authentication configuration\": \"<detail_content>\", \"Using JWTs with clients\": \"<detail_content>\", \"Resources\": \"<detail_content>\"}}, {\"title\": \"Kerberos authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 9]\", \"content\": {\"Environment configuration\": {\"Kerberos services\": \"<detail_content>\", \"MIT Kerberos configuration\": \"<detail_content>\", \"Kerberos principals and keytab files\": \"<detail_content>\", \"Configuration for TLS\": \"<detail_content>\"}, \"System access control plugin\": \"<detail_content>\", \"Trino coordinator node configuration\": {\"config.properties\": \"<detail_content>\", \"access-control.properties\": \"<detail_content>\"}, \"User mapping\": \"<detail_content>\", \"Troubleshooting\": {\"Kerberos verification\": \"<detail_content>\", \"Java keystore file verification\": \"<detail_content>\", \"Additional Kerberos debugging information\": \"<detail_content>\", \"Additional resources\": \"<detail_content>\"}}}, {\"title\": \"LDAP authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 10]\", \"content\": {\"Trino server configuration\": {\"Trino coordinator node configuration\": {\"Server config properties\": \"<detail_content>\", \"Password authenticator configuration\": {\"Active Directory\": \"<detail_content>\", \"OpenLDAP\": \"<detail_content>\"}, \"Authorization based on LDAP group membership\": \"<detail_content>\", \"Authorization using Trino LDAP service user\": {\"LDAP group authorization examples\": \"<detail_content>\"}}}, \"Trino CLI\": {\"Environment configuration\": {\"TLS configuration\": \"<detail_content>\"}, \"Trino CLI execution\": \"<detail_content>\"}, \"Troubleshooting\": {\"Java keystore file verification\": \"<detail_content>\", \"Debug Trino to LDAP server issues\": \"<detail_content>\", \"TLS debugging for Trino CLI\": {\"Common TLS/SSL errors\": {\"java.security.cert.CertificateException: No subject alternative names present\": \"<detail_content>\"}, \"Authentication or TLS errors with JDK upgrade\": \"<detail_content>\"}}}}, {\"title\": \"OAuth 2.0 authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 11]\", \"content\": {\"OpenID Connect Discovery\": \"<detail_content>\", \"Trino server configuration\": {\"Refresh tokens\": \"<detail_content>\"}, \"Troubleshooting\": \"<detail_content>\"}}, {\"title\": \"Open Policy Agent access control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 12]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Trino configuration\": {\"Logging\": \"<detail_content>\", \"Permission management\": \"<detail_content>\"}, \"OPA configuration\": {\"Example requests to OPA\": \"<detail_content>\"}, \"Row filtering\": \"<detail_content>\", \"Column masking\": {\"Batch column masking\": \"<detail_content>\"}, \"Batch mode\": \"<detail_content>\"}}, {\"title\": \"Security overview\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 13]\", \"content\": {\"Aspects of configuring security\": \"<detail_content>\", \"Suggested configuration workflow\": \"<detail_content>\", \"Securing client access to the cluster\": {\"Encryption\": \"<detail_content>\", \"Authentication\": {\"User name management\": \"<detail_content>\"}, \"Authorization and access control\": \"<detail_content>\"}, \"Securing inside the cluster\": \"<detail_content>\", \"Securing cluster access to data sources\": \"<detail_content>\"}}, {\"title\": \"Password file authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 14]\", \"content\": {\"Password authenticator configuration\": \"<detail_content>\", \"Password files\": {\"File format\": \"<detail_content>\", \"Creating a password file\": \"<detail_content>\", \"Verify configuration\": \"<detail_content>\"}}}, {\"title\": \"Ranger access control\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 15]\", \"content\": {\"Requirements\": \"<detail_content>\", \"Configuration\": {\"ranger-trino-security.xml\": \"<detail_content>\", \"ranger-trino-audit.xml\": \"<detail_content>\", \"ranger-policymgr-ssl.xml\": \"<detail_content>\"}, \"Required policies\": \"<detail_content>\"}}, {\"title\": \"Salesforce authentication\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 16]\", \"content\": {\"Salesforce authenticator configuration\": \"<detail_content>\", \"Salesforce concepts\": {\"Security token\": \"<detail_content>\", \"Salesforce.com organization IDs\": \"<detail_content>\"}}}, {\"title\": \"Secrets\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 17]\", \"content\": {\"Secrets\": \"<detail_content>\"}}, {\"title\": \"TLS and HTTPS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 18]\", \"content\": {\"Supported standards\": \"<detail_content>\", \"Approaches\": \"<detail_content>\", \"Use a load balancer to terminate TLS/HTTPS\": \"<detail_content>\", \"Secure Trino directly\": {\"Add a TLS certificate\": \"<detail_content>\", \"Keys and certificates\": \"<detail_content>\", \"Inspect received certificates\": \"<detail_content>\", \"Invalid certificates\": \"<detail_content>\", \"Place the certificate file\": \"<detail_content>\", \"Configure the coordinator\": \"<detail_content>\", \"Verify configuration\": \"<detail_content>\"}, \"Limitations of self-signed certificates\": \"<detail_content>\"}}, {\"title\": \"User mapping\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 19]\", \"content\": {\"Pattern mapping rule\": \"<detail_content>\", \"File mapping rules\": \"<detail_content>\"}}]}, {\"title\": \"Sql\", \"description\": \"Documentation section: sql\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30]\", \"subpages\": [{\"title\": \"ALTER MATERIALIZED VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 0]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": {\"SET PROPERTIES\": \"<detail_content>\"}, \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"ALTER SCHEMA\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 1]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See Also\": \"<detail_content>\"}}, {\"title\": \"ALTER TABLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 2]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": {\"SET PROPERTIES\": \"<detail_content>\", \"EXECUTE\": \"<detail_content>\"}, \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"ALTER VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 3]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"ANALYZE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 4]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"CALL\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 5]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"COMMENT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 6]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"COMMIT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 7]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE CATALOG\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 8]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE FUNCTION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 9]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE MATERIALIZED VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 10]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE ROLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 11]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE SCHEMA\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 12]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE TABLE AS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 13]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE TABLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 14]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CREATE VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 15]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Security\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DEALLOCATE PREPARE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 16]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DELETE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 17]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\"}}, {\"title\": \"DENY\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 18]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DESCRIBE INPUT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 19]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DESCRIBE OUTPUT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 20]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DESCRIBE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 21]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"DROP CATALOG\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 22]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP FUNCTION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 23]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP MATERIALIZED VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 24]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP ROLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 25]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP SCHEMA\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 26]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP TABLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 27]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DROP VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 28]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"EXECUTE IMMEDIATE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 29]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"EXECUTE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 30]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"EXPLAIN ANALYZE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 31]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"EXPLAIN\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 32]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": {\"EXPLAIN (TYPE LOGICAL)\": \"<detail_content>\", \"EXPLAIN (TYPE LOGICAL, FORMAT JSON)\": \"<detail_content>\", \"EXPLAIN (TYPE DISTRIBUTED)\": \"<detail_content>\", \"EXPLAIN (TYPE DISTRIBUTED, FORMAT JSON)\": \"<detail_content>\", \"EXPLAIN (TYPE VALIDATE)\": \"<detail_content>\", \"EXPLAIN (TYPE IO)\": \"<detail_content>\"}, \"See also\": \"<detail_content>\"}}, {\"title\": \"GRANT role\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 33]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"GRANT privilege\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 34]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"INSERT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 35]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"MATCH_RECOGNIZE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 36]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Partitioning and ordering\": \"<detail_content>\", \"Row pattern measures\": \"<detail_content>\", \"Rows per match\": \"<detail_content>\", \"After match skip\": \"<detail_content>\", \"Row pattern syntax\": {\"concatenation\": \"<detail_content>\", \"alternation\": \"<detail_content>\", \"permutation\": \"<detail_content>\", \"grouping\": \"<detail_content>\", \"partition start anchor\": \"<detail_content>\", \"partition end anchor\": \"<detail_content>\", \"empty pattern\": \"<detail_content>\", \"exclusion syntax\": \"<detail_content>\", \"quantifiers\": \"<detail_content>\"}, \"Row pattern union variables\": \"<detail_content>\", \"Row pattern variable definitions\": \"<detail_content>\", \"Row pattern recognition expressions\": {\"pattern variable references\": \"<detail_content>\", \"classifier function\": \"<detail_content>\", \"match_number function\": \"<detail_content>\", \"logical navigation functions\": \"<detail_content>\", \"physical navigation functions\": \"<detail_content>\", \"nesting of navigation functions\": \"<detail_content>\", \"Aggregate functions\": {\"Aggregation arguments\": \"<detail_content>\", \"Nesting of aggregate functions\": \"<detail_content>\", \"Usage of the `classifier` and `match_number` functions\": \"<detail_content>\", \"Row pattern count aggregation\": \"<detail_content>\"}, \"`RUNNING` and `FINAL` semantics\": \"<detail_content>\"}, \"Evaluating expressions in empty matches and unmatched rows\": \"<detail_content>\"}}, {\"title\": \"MERGE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 37]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\"}}, {\"title\": \"Row pattern recognition in window structures\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 38]\", \"content\": {\"Window with row pattern recognition\": \"<detail_content>\", \"Description of the pattern recognition clauses\": \"<detail_content>\", \"Processing input with row pattern recognition\": \"<detail_content>\", \"Empty matches and unmatched rows\": \"<detail_content>\"}}, {\"title\": \"PREPARE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 39]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"REFRESH MATERIALIZED VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 40]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"RESET SESSION AUTHORIZATION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 41]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"RESET SESSION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 42]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"REVOKE role\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 43]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"REVOKE privilege\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 44]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"ROLLBACK\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 45]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SELECT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 46]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"WITH SESSION clause\": \"<detail_content>\", \"WITH FUNCTION clause\": \"<detail_content>\", \"WITH clause\": \"<detail_content>\", \"WITH RECURSIVE clause\": \"<detail_content>\", \"SELECT clause\": {\"Select expressions\": \"<detail_content>\"}, \"GROUP BY clause\": {\"Complex grouping operations\": \"<detail_content>\", \"GROUPING SETS\": \"<detail_content>\", \"CUBE\": \"<detail_content>\", \"ROLLUP\": \"<detail_content>\", \"Combining multiple grouping expressions\": \"<detail_content>\", \"GROUPING operation\": \"<detail_content>\"}, \"HAVING clause\": \"<detail_content>\", \"WINDOW clause\": \"<detail_content>\", \"Set operations\": {\"UNION clause\": \"<detail_content>\", \"INTERSECT clause\": \"<detail_content>\", \"EXCEPT clause\": \"<detail_content>\"}, \"ORDER BY clause\": \"<detail_content>\", \"OFFSET clause\": \"<detail_content>\", \"LIMIT or FETCH FIRST clause\": \"<detail_content>\", \"TABLESAMPLE\": \"<detail_content>\", \"UNNEST\": \"<detail_content>\", \"JSON_TABLE\": \"<detail_content>\", \"Joins\": {\"CROSS JOIN\": \"<detail_content>\", \"LATERAL\": \"<detail_content>\", \"Qualifying column names\": \"<detail_content>\"}, \"Subqueries\": {\"EXISTS\": \"<detail_content>\", \"IN\": \"<detail_content>\", \"Scalar subquery\": \"<detail_content>\"}}}, {\"title\": \"SET PATH\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 47]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SET ROLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 48]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SET SESSION AUTHORIZATION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 49]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SET SESSION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 50]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Session properties\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SET TIME ZONE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 51]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW CATALOGS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 52]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW COLUMNS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 53]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW CREATE FUNCTION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 54]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW CREATE MATERIALIZED VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 55]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW CREATE SCHEMA\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 56]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW CREATE TABLE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 57]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW CREATE VIEW\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 58]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW FUNCTIONS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 59]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW GRANTS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 60]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW ROLE GRANTS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 61]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW ROLES\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 62]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW SCHEMAS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 63]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW SESSION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 64]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SHOW STATS\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 65]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\"}}, {\"title\": \"SHOW TABLES\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 66]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"START TRANSACTION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 67]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"TRUNCATE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 68]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"UPDATE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 69]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Limitations\": \"<detail_content>\"}}, {\"title\": \"USE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 70]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}}, {\"title\": \"VALUES\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 71]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}]}, {\"title\": \"Udf\", \"description\": \"Documentation section: udf\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31]\", \"subpages\": [{\"title\": \"FUNCTION\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 0]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"Introduction to UDFs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 1]\", \"content\": {\"UDF declaration\": \"<detail_content>\", \"Inline user-defined functions\": \"<detail_content>\", \"Catalog user-defined functions\": \"<detail_content>\", \"SQL environment configuration for UDFs\": \"<detail_content>\", \"Recommendations\": \"<detail_content>\"}}, {\"title\": \"Python user-defined functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 2]\", \"content\": {\"Python UDF declaration\": \"<detail_content>\", \"Python language details\": \"<detail_content>\", \"Type mapping\": {\"Time and timestamp\": \"<detail_content>\", \"Timestamp with time zone\": \"<detail_content>\"}}}, {\"title\": \"SQL user-defined functions\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 3]\", \"content\": {\"SQL UDF declaration\": \"<detail_content>\", \"Labels\": \"<detail_content>\", \"Limitations\": \"<detail_content>\"}}, {\"title\": \"Python\", \"description\": \"Documentation section: python\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"Example Python UDFs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"Inline and catalog Python UDFs\": \"<detail_content>\", \"XOR\": \"<detail_content>\", \"reverse_words\": \"<detail_content>\"}}]}, {\"title\": \"Sql\", \"description\": \"Documentation section: sql\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"BEGIN\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"CASE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"DECLARE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"Example SQL UDFs\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 3]\", \"content\": {\"Inline and catalog UDFs\": \"<detail_content>\", \"Declaration examples\": \"<detail_content>\", \"Conditional flows\": \"<detail_content>\", \"Fibonacci example\": \"<detail_content>\", \"Labels and loops\": \"<detail_content>\", \"SQL UDFs and built-in functions\": \"<detail_content>\", \"Optional parameter example\": \"<detail_content>\", \"Date string parsing example\": \"<detail_content>\", \"Human-readable days\": \"<detail_content>\", \"Truncating long strings\": \"<detail_content>\", \"Formatting bytes\": \"<detail_content>\", \"Charts\": \"<detail_content>\", \"Top-N\": \"<detail_content>\"}}, {\"title\": \"IF\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 4]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"ITERATE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 5]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"LEAVE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 6]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"LOOP\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 7]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"REPEAT\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 8]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"RETURN\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 9]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"SET\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 10]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"WHILE\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 11]\", \"content\": {\"Synopsis\": \"<detail_content>\", \"Description\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}]}]}]}]}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"trino\", \"description\": \"Documentation for trino\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs\"}, \"subpages\": [{\"title\": \"Trino documentation\", \"description\": null, \"content\": {\"Writing and contributing\": \"We welcome any contributions to the documentation. Contributions must [follow\\nthe same process as code contributions](https://trino.io/development/) and\\ncan be part of your code contributions or separate documentation improvements.\\n\\nThe documentation follows the Google developer documentation style guide for any\\nnew documentation:\\n\\n['[Google developer documentation style guide](https://developers.google.com/style)', '[Highlights](https://developers.google.com/style/highlights)', '[Word list](https://developers.google.com/style/word-list)', '[Style and tone](https://developers.google.com/style/tone)', '[Writing for a global audience](https://developers.google.com/style/translation)', '[Cross-references](https://developers.google.com/style/cross-references)', '[Present tense](https://developers.google.com/style/tense)']\\n\\nThe Google guidelines include more material than listed here, and are used as a\\nguide that enable easy decision-making about proposed doc changes. Changes to\\nexisting documentation to follow these guidelines are underway.\\n\\nAs a specific style note, because different readers may perceive the phrases \\\"a\\nSQL\\\" or \\\"an SQL\\\" to be incorrect depending on how they pronounce SQL, aim to\\navoid use of \\\"a/an SQL\\\" in Trino documentation. Try to reword, re-order, or\\nadjust writing so that it is not necessary. If there is absolutely no way around\\nit, default to using \\\"a SQL.\\\"\\n\\nOther useful resources:\\n\\n['[Style check](#style-check)', '[Google Technical Writing Courses](https://developers.google.com/tech-writing)', '[Myst guide](https://mystmd.org/guide)']\", \"Tools\": \"Documentation source files can be found in [Myst Markdown](https://mystmd.org/)\\n(`.md`) format in `src/main/sphinx` and sub-folders. Refer to the [Myst\\nguide](https://mystmd.org/guide) and the existing documentation for more\\ninformation about how to write and format the documentation source.\\n\\nThe engine used to create the documentation in HTML format is the Python-based\\n[Sphinx](https://www.sphinx-doc.org).\\n\\nThe [fast doc build option](#fast-doc-build-option) requires *only* a local\\ninstallation of [Docker Desktop on\\nMac](https://docs.docker.com/docker-for-mac/install/) or [Docker Engine on\\nLinux](https://docs.docker.com/engine/install/). No other tools are required.\\n\\nThe default formal build of the docs is performed with Apache Maven, which requires an\\ninstallation of a Java Development Kit.\", \"Fast doc build option\": \"For fast local build times when writing documentation, you can run the Sphinx\\nbuild directly. The build runs inside a Docker container and thus does not\\nrequire having anything installed locally other than Docker. You can run the\\nSphinx build on a fresh clone of the project, with no prerequisite commands. For\\nexample:\\n\\n```\\ndocs/build\\n```\\n\\nSphinx attempts to perform an incremental build, but this does not work\\nin all cases, such as after editing the CSS. You can force a full rebuild\\nby removing the ``target/html`` directory:\\n\\n```\\nrm -rf docs/target/html\\n```\", \"Default build\": \"The default build uses Apache Maven and Java as does the rest of the\\nTrino build. You only need to have built the current Trino version from the root.\\nThat is, before building the docs the first time, run the following command:\\n\\n```\\n./mvnw clean install -DskipTests\\n```\\n\\nSubsequently, you can build the doc site using the Maven wrapper script:\\n\\n```\\n./mvnw -pl docs clean install\\n```\\n\\nIf you have Maven installed and available on the path, you can use the `mvn` command\\ndirectly.\\n\\nThis also performs other checks, and is the authoritative way to build the\\ndocs. However, using Maven is also somewhat slower than using Sphinx directly.\", \"Viewing documentation\": \"However you build the docs, the generated HTML files can be found in the folder\\n`docs/target/html/`.\\n\\nYou can open the file `docs/target/html/index.html` in a web browser on\\nmacOS with\\n\\n```\\nopen docs/target/html/index.html\\n```\\n\\nor on Linux with\\n\\n```\\nxdg-open docs/target/html/index.html\\n```\\n\\nOr you can directly call your browser of choice with the same filename. For example, on Ubuntu\\nwith Chromium:\\n\\n```\\nchromium-browser docs/target/html/index.html\\n```\\n\\nAlternatively, you can start a web server with that folder as root, such as with\\nthe following Python command. You can then open\\n[http://localhost:4000](http://localhost:4000) in a web browser.\\n\\n```\\ncd docs/target/html/\\npython3 -m http.server 4000\\n```\\n\\nIn order to see any changes from the source files in the HTML output, simply\\nre-run the ``build`` command and refresh the browser.\", \"Versioning\": \"The version displayed in the resulting HTML is read by default from the top level Maven\\n`pom.xml` file `version` field.\\n\\nTo deploy a specific documentation set (such as a SNAPSHOT version) as the release\\nversion you must override the pom version with the `TRINO_VERSION`\\nenvironment variable.\\n\\n```\\nTRINO_VERSION=355 docs/build\\n```\\n\\nIf you work on the docs for more than one invocation, you can export the\\nvariable and use it with Sphinx.\\n\\n```\\nexport TRINO_VERSION=354\\ndocs/build\\n```\\n\\nThis is especially useful when deploying doc patches for a release where the\\nMaven pom has already moved to the next SNAPSHOT version.\", \"Style check\": \"The project contains a configured setup for [Vale](https://vale.sh) and the\\nGoogle developer documentation style. Vale is a command-line tool to check for\\neditorial style issues of a document or a set of documents.\\n\\nInstall vale with brew on macOS or follow the instructions on the website.\\n\\n```\\nbrew install vale\\n```\\n\\nThe `docs` folder contains the necessary configuration to use vale for any\\ndocument in the repository:\\n\\n['`.vale` directory with Google style setup', '`.vale/Vocab/Base/accept.txt` file for additional approved words and spelling', '`.vale.ini` configuration file configured for rst and md files']\\n\\nWith this setup you can validate an individual file from the root by specifying\\nthe path:\\n\\n```\\nvale src/main/sphinx/overview/use-cases.md\\n```\\n\\nYou can also use directory paths and all files within.\\n\\nTreat all output from vale as another help towards better docs. Fixing any\\nissues is not required, but can help with learning more about the [Google style\\nguide](https://developers.google.com/style) that we try to follow.\", \"Contribution requirements\": \"To contribute corrections or new explanations to the Trino documentation requires\\nonly a willingness to help and submission of your [Contributor License\\nAgreement](https://github.com/trinodb/cla) (CLA).\", \"Workflow\": \"The procedure to add a documentation contribution is the same as for [a code\\ncontribution](https://trino.io/development/process.html).\\n\\n[\\\"In the Trino project's [GitHub Issues\\\\nlist](https://github.com/trinodb/trino/issues), identify documentation issues\\\\nby filtering on the [``docs``\\\\nlabel](https://github.com/trinodb/trino/issues?q=is%3Aissue+is%3Aopen+label%3Adocs).\\\", \\\"If you want to help Trino documentation, but don't know where to start, look\\\\nin the Issues list for both the [``docs`` and ``good first issue``\\\\nlabels](https://github.com/trinodb/trino/issues?q=is%3Aissue+is%3Aopen+label%3Adocs+label%3A%22good+first+issue%22).\\\", 'If the doc fix you have in mind does not yet have an issue, add one (which\\\\nrequires a signed CLA). Add the ``docs`` label to your new issue.', 'You can discuss proposed doc changes in the #docs channel of the [Trino\\\\nSlack](https://trino.io/slack.html).', 'For a larger contribution, create a GitHub pull request as described\\\\nin [GitHub\\\\ndocumentation](https://docs.github.com/en/github/getting-started-with-github).\\\\nIn brief, this means:', ['[Create a fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) of the\\\\n[trinodb/trino](https://github.com/trinodb/trino) repository.', 'Create a working branch in your fork.', 'Make your edits in your working branch and push them to your fork.', 'In a browser, open your fork in GitHub, which offers to submit a pull\\\\nrequest for you.']]\", \"Videos\": [\"See [**Contributing to the Trino\\ndocumentation**](https://www.youtube.com/watch?v=yseFM3ZI2ro) for a\\nfive-minute video introduction. Note that this video uses the old RST source\\nformat.\", \"You might select a GitHub doc issue to work on that requires you to verify\\nhow Trino handles a situation, such as [adding\\ndocumentation](https://github.com/trinodb/trino/issues/7660) for SQL\\nfunctions.\", \"In this case, the five-minute video [Learning Trino SQL with\\nDocker](https://www.youtube.com/watch?v=y58sb9bW2mA) gives you a starting\\npoint for setting up a test system on your laptop.\"], \"Docker container\": \"The build of the docs uses a Docker container that includes Sphinx and the\\nrequired libraries. The container is referenced in the `SPHINX_IMAGE` variable\\nin the `build` script.\\n\\nThe specific details for the container are available in `Dockerfile`, and\\n`requirements.in`. The file `requirements.txt` must be updated after any changes\\nto `requirements.in`.\\n\\nThe container must be published to the GitHub container registry at ghcr.io with\\nthe necessary access credentials and the following command, after modification\\nof the version tag `xxx` to the new desired value as used in the `build` script:\\n\\n```\\ndocker buildx build docs --platform=linux/arm64,linux/amd64 --tag ghcr.io/trinodb/build/sphinx:xxx --provenance=false --push\\n```\\n\\nNote that the version must be updated and the command automatically also\\npublishes the container with support for arm64 and amd64 processors. This is\\nnecessary so the build performs well on both hardware platforms.\\n\\nAfter the container is published, you can update the `build` script and merge\\nthe related pull request.\\n\\nExample PRs:\\n\\n['https://github.com/trinodb/trino/pull/17778', 'https://github.com/trinodb/trino/pull/13225']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"Release xyz (dd MMM 2025)\", \"description\": null, \"content\": {\"General\": \"\", \"Security\": \"\", \"Web UI\": \"\", \"JDBC driver\": \"\", \"Docker image\": \"\", \"CLI\": \"\", \"BigQuery connector\": \"\", \"Blackhole connector\": \"\", \"Cassandra connector\": \"\", \"ClickHouse connector\": \"\", \"Delta Lake connector\": \"\", \"Druid connector\": \"\", \"DuckDB connector\": \"\", \"Elasticsearch connector\": \"\", \"Exasol connector\": \"\", \"Faker connector\": \"\", \"Google Sheets connector\": \"\", \"Hive connector\": \"\", \"Hudi connector\": \"\", \"Iceberg connector\": \"\", \"Ignite connector\": \"\", \"JMX connector\": \"\", \"Kafka connector\": \"\", \"Loki connector\": \"\", \"MariaDB connector\": \"\", \"Memory connector\": \"\", \"MongoDB connector\": \"\", \"MySQL connector\": \"\", \"OpenSearch connector\": \"\", \"Oracle connector\": \"\", \"Pinot connector\": \"\", \"PostgreSQL connector\": \"\", \"Prometheus connector\": \"\", \"Redis connector\": \"\", \"Redshift connector\": \"\", \"SingleStore connector\": \"\", \"Snowflake connector\": \"\", \"SQL Server connector\": \"\", \"TPC-H connector\": \"\", \"TPC-DS connector\": \"\", \"Vertica connector\": \"\", \"SPI\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1]\"}, {\"title\": \"Src\", \"description\": \"Documentation section: src\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src\"}, \"subpages\": [{\"title\": \"Main\", \"description\": \"Documentation section: main\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main\"}, \"subpages\": [{\"title\": \"Sphinx\", \"description\": \"Documentation section: sphinx\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx\"}, \"subpages\": [{\"title\": \"Administration\", \"description\": null, \"content\": {\"Event listeners\": \"Event listeners are plugins that allow streaming of query events, such as query\\nstarted or query finished, to an external system. \\n\\nUsing an event listener you can process and store the query events in a separate\\nsystem for long periods of time. Some of these external systems can be queried\\nwith Trino for further analysis or reporting.\\n\\nThe following event listeners are available:\\n\\n```\\n:titlesonly: true\\n\\nadmin/event-listeners-http\\nadmin/event-listeners-kafka\\nadmin/event-listeners-mysql\\nadmin/event-listeners-openlineage\\n```\\n\\nUnrelated to event listeners, the coordinator stores information about recent\\nqueries in memory for usage by the [](/admin/web-interface) - see also\\n`query.max-history` and `query.min-expire-age` in\\n[](/admin/properties-query-management).\", \"Properties reference\": \"Many aspects for running Trino are [configured with properties](config-properties).\\nThe following pages provide an overview and details for specific topics.\\n\\n```\\n:maxdepth: 1\\n:hidden:\\nadmin/properties\\n```\\n\\n['[Properties reference overview](admin/properties)', '[](admin/properties-general)', '[](admin/properties-client-protocol)', '[](admin/properties-http-server)', '[](admin/properties-resource-management)', '[](admin/properties-query-management)', '[](admin/properties-catalog)', '[](admin/properties-sql-environment)', '[](admin/properties-spilling)', '[](admin/properties-exchange)', '[](admin/properties-task)', '[](admin/properties-write-partitioning)', '[](admin/properties-writer-scaling)', '[](admin/properties-node-scheduler)', '[](admin/properties-optimizer)', '[](admin/properties-logging)', '[](admin/properties-web-interface)', '[](admin/properties-regexp-function)', '[](admin/properties-http-client)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}, {\"title\": \"Appendix\", \"description\": null, \"content\": {\"Appendix\": \"```\\n:maxdepth: 1\\n\\nappendix/from-hive\\nappendix/legal-notices\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\"}, {\"title\": \"Clients\", \"description\": null, \"content\": {\"Client drivers\": \"Client drivers, also called client libraries, provide a mechanism for other\\napplications to connect to Trino. The application are called client application\\nand include your own custom applications or scripts. The Trino project maintains the\\nfollowing client drivers:\\n\\n['[Trino JDBC driver](/client/jdbc)', '[trino-go-client](https://github.com/trinodb/trino-go-client)', '[trino-js-client](https://github.com/trinodb/trino-js-client)', '[trino-python-client](https://github.com/trinodb/trino-python-client)', '[trino-csharp-client](https://github.com/trinodb/trino-csharp-client)']\\n\\nOther communities and vendors provide [other client\\ndrivers](https://trino.io/ecosystem/client-driver#other-client-drivers).\", \"Client applications\": \"Client applications provide a user interface and other user-facing features to\\nrun queries with Trino. You can inspect the results, perform analytics with\\nfurther queries, and create visualizations. Client applications typically use a\\nclient driver.\\n\\nThe Trino project maintains the [Trino command line interface](/client/cli) and\\nthe [Trino Grafana Data Source Plugin](https://github.com/trinodb/grafana-trino)\\nas a client application.\\n\\nOther communities and vendors provide [numerous other client\\napplications](https://trino.io/ecosystem/client-application#other-client-applications)\", \"Client protocol\": \"All client drivers and client applications communicate with the Trino\\ncoordinator using the [client protocol](/client/client-protocol).\\n\\nConfigure support for the [spooling protocol](protocol-spooling) on the cluster\\nto improve throughput for client interactions with higher data transfer demands.\\n\\n```\\n:maxdepth: 1\\n\\nclient/client-protocol\\nclient/cli\\nclient/jdbc\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\"}, {\"title\": \"Connector\", \"description\": null, \"content\": {\"Connectors\": \"This section describes the connectors available in Trino to access data from\\ndifferent [data sources](trino-concept-data-source) by configuring\\n[catalogs](trino-concept-catalog) with the connector-specific properties in\\n[catalog properties files](catalog-properties).\\n\\n```\\n:maxdepth: 1\\n\\nBigQuery <connector/bigquery>\\nBlack Hole <connector/blackhole>\\nCassandra <connector/cassandra>\\nClickHouse <connector/clickhouse>\\nDelta Lake <connector/delta-lake>\\nDruid <connector/druid>\\nDuckDB <connector/duckdb>\\nElasticsearch <connector/elasticsearch>\\nExasol <connector/exasol>\\nFaker <connector/faker>\\nGoogle Sheets <connector/googlesheets>\\nHive <connector/hive>\\nHudi <connector/hudi>\\nIceberg <connector/iceberg>\\nIgnite <connector/ignite>\\nJMX <connector/jmx>\\nKafka <connector/kafka>\\nLakehouse <connector/lakehouse>\\nLoki <connector/loki>\\nMariaDB <connector/mariadb>\\nMemory <connector/memory>\\nMongoDB <connector/mongodb>\\nMySQL <connector/mysql>\\nOpenSearch <connector/opensearch>\\nOracle <connector/oracle>\\nPinot <connector/pinot>\\nPostgreSQL <connector/postgresql>\\nPrometheus <connector/prometheus>\\nRedis <connector/redis>\\nRedshift <connector/redshift>\\nSingleStore <connector/singlestore>\\nSnowflake <connector/snowflake>\\nSQL Server <connector/sqlserver>\\nSystem <connector/system>\\nThrift <connector/thrift>\\nTPC-DS <connector/tpcds>\\nTPC-H <connector/tpch>\\nVertica <connector/vertica>\\n```\\n\\n```\\n:hidden:\\n\\nconnector/removed\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\"}, {\"title\": \"Develop\", \"description\": null, \"content\": {\"Developer guide\": \"This guide is intended for Trino contributors and plugin developers.\\n\\nImportant information on processes, code style, reviews, and other details are\\navailable on the [development section of the Trino\\nwebsite](https://trino.io/development/) and in the [development documentation in\\nthe Trino source\\ncode](https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md).\\n\\n```\\n:maxdepth: 1\\n\\ndevelop/spi-overview\\ndevelop/tests\\ndevelop/connectors\\ndevelop/example-http\\ndevelop/example-jdbc\\ndevelop/insert\\ndevelop/supporting-merge\\ndevelop/types\\ndevelop/functions\\ndevelop/table-functions\\ndevelop/system-access-control\\ndevelop/password-authenticator\\ndevelop/certificate-authenticator\\ndevelop/header-authenticator\\ndevelop/group-provider\\ndevelop/event-listener\\ndevelop/client-protocol\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\"}, {\"title\": \"Functions and operators\", \"description\": null, \"content\": {\"Functions by name\": \"If you are looking for a specific function or operator by name use\\n[](/sql/show-functions), or refer to the following resources:\\n\\n:::{toctree}\\n:maxdepth: 1\\n\\nfunctions/list\\nfunctions/list-by-topic\\n:::\", \"Functions per topic\": \"```\\n:maxdepth: 1\\n\\nAggregate <functions/aggregate>\\nAI <functions/ai>\\nArray <functions/array>\\nBinary <functions/binary>\\nBitwise <functions/bitwise>\\nColor <functions/color>\\nComparison <functions/comparison>\\nConditional <functions/conditional>\\nConversion <functions/conversion>\\nDate and time <functions/datetime>\\nDecimal <functions/decimal>\\nGeospatial <functions/geospatial>\\nHyperLogLog <functions/hyperloglog>\\nIP Address <functions/ipaddress>\\nJSON <functions/json>\\nLambda <functions/lambda>\\nLogical <functions/logical>\\nMachine learning <functions/ml>\\nMap <functions/map>\\nMath <functions/math>\\nQuantile digest <functions/qdigest>\\nRegular expression <functions/regexp>\\nSession <functions/session>\\nSet Digest <functions/setdigest>\\nString <functions/string>\\nSystem <functions/system>\\nTable <functions/table>\\nTeradata <functions/teradata>\\nT-Digest <functions/tdigest>\\nURL <functions/url>\\nUUID <functions/uuid>\\nWindow <functions/window>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\"}, {\"title\": \"Glossary\", \"description\": null, \"content\": {\"Glossary\": \"The glossary contains a list of key Trino terms and definitions.\\n\\n(glosscatalog)=\\nCatalog\\n\\n: Catalogs define and name a configuration for connecting to a data source,\\nallowing users to query the connected data. Each catalog's configuration\\nspecifies a {ref}`connector <glossConnector>` to define which data source\\nthe catalog connects to. For more information about catalogs, see\\n{ref}`trino-concept-catalog`.\\n\\n(glosscert)=\\nCertificate\\n\\n: A public key [certificate](https://wikipedia.org/wiki/Public_key_certificate) issued by a {ref}`CA\\n<glossCA>`, sometimes abbreviated as cert, that verifies the ownership of a\\nserver's private keys. Certificate format is specified in the [X.509](https://wikipedia.org/wiki/X.509) standard.\\n\\n(glossca)=\\nCertificate Authority (CA)\\n\\n: A trusted organization that signs and issues certificates. Its signatures\\ncan be used to verify the validity of {ref}`certificates <glossCert>`.\\n\\nCluster\\n\\n: A Trino cluster provides the resources to run queries against numerous data\\nsources. Clusters define the number of nodes, the configuration for the JVM\\nruntime, configured data sources, and others aspects. For more information,\\nsee {ref}`trino-concept-cluster`.\\n\\n(glossconnector)=\\nConnector\\n\\n: Translates data from a data source into Trino schemas, tables, columns,\\nrows, and data types. A {doc}`connector </connector>` is specific to a data\\nsource, and is used in {ref}`catalog <glossCatalog>` configurations to\\ndefine what data source the catalog connects to. A connector is one of many\\ntypes of {ref}`plugins <glossPlugin>`\\n\\n(glosscontainer)=\\nContainer\\n\\n: A lightweight virtual package of software that contains libraries, binaries,\\ncode, configuration files, and other dependencies needed to deploy an\\napplication. A running container does not include an operating system,\\ninstead using the operating system of the host machine. To learn more, \\nread about [containers](https://kubernetes.io/docs/concepts/containers/)\\nin the Kubernetes documentation.\\n\\n(glossdatasource)=\\nData source\\n\\n: A system from which data is retrieved - for example, PostgreSQL or Iceberg\\non S3 data. In Trino, users query data sources with {ref}`catalogs\\n<glossCatalog>` that connect to each source. See\\n{ref}`trino-concept-data-source` for more information.\\n\\n(glossdatavirtualization)=\\nData virtualization\\n\\n: [Data virtualization](https://wikipedia.org/wiki/Data_virtualization) is a\\nmethod of abstracting an interaction with multiple {ref}`heterogeneous data\\nsources <glossDataSource>`, without needing to know the distributed nature\\nof the data, its format, or any other technical details involved in\\npresenting the data.\\n\\n(glossgzip)=\\ngzip\\n\\n: [gzip](https://wikipedia.org/wiki/Gzip) is a compression format and\\nsoftware that compresses and decompresses files. This format is used several\\nways in Trino, including deployment and compressing files in {ref}`object\\nstorage <glossObjectStorage>`. The most common extension for gzip-compressed\\nfiles is `.gz`.\\n\\n(glosshdfs)=\\nHDFS\\n\\n: [Hadoop Distributed Filesystem (HDFS)](https://wikipedia.org/wiki/Apache_Hadoop#HDFS) is a scalable {ref}`open\\nsource <glossOpenSource>` filesystem that was one of the earliest\\ndistributed big data systems created to store large amounts of data for the\\n[Hadoop ecosystem](https://wikipedia.org/wiki/Apache_Hadoop).\\n\\n(glossjks)=\\nJava KeyStore (JKS)\\n\\n: The system of public key cryptography supported as one part of the Java\\nsecurity APIs. The legacy JKS system recognizes keys and {ref}`certificates\\n<glossCert>` stored in *keystore* files, typically with the `.jks`\\nextension, and by default relies on a system-level list of {ref}`CAs\\n<glossCA>` in *truststore* files installed as part of the current Java\\ninstallation.\\n\\nKey\\n\\n: A cryptographic key specified as a pair of public and private strings\\ngenerally used in the context of {ref}`TLS <glossTLS>` to secure public\\nnetwork traffic.\\n\\n(glosslb)=\\nLoad Balancer (LB)\\n\\n: Software or a hardware device that sits on a network edge and accepts\\nnetwork connections on behalf of servers behind that wall, distributing\\ntraffic across network and server infrastructure to balance the load on\\nnetworked services.\\n\\n(glossobjectstorage)=\\nObject storage\\n\\n: [Object storage](https://en.wikipedia.org/wiki/Object_storage) is a file\\nstorage mechanism. Examples of compatible object stores include the\\nfollowing:\\n\\n['[Amazon S3](https://aws.amazon.com/s3)', '[Google Cloud Storage](https://cloud.google.com/storage)', '[Azure Blob Storage](https://azure.microsoft.com/en-us/products/storage/blobs)', '[MinIO](https://min.io/) and other S3-compatible stores', '{ref}`HDFS <glossHDFS>`']\\n\\n(glossopensource)=\\nOpen-source\\n\\n: Typically refers to [open-source software](https://wikipedia.org/wiki/Open-source_software). which is software that\\nhas the source code made available for others to see, use, and contribute\\nto. Allowed usage varies depending on the license that the software is\\nlicensed under. Trino is licensed under the [Apache license](https://wikipedia.org/wiki/Apache_License), and is therefore maintained\\nby a community of contributors from all across the globe.\\n\\n(glosspem)=\\nPEM file format\\n\\n: A format for storing and sending cryptographic keys and certificates. PEM\\nformat can contain both a key and its certificate, plus the chain of\\ncertificates from authorities back to the root {ref}`CA <glossCA>`, or back\\nto a CA vendor's intermediate CA.\\n\\n(glosspkcs12)=\\nPKCS #12\\n\\n: A binary archive used to store keys and certificates or certificate chains\\nthat validate a key. [PKCS #12](https://wikipedia.org/wiki/PKCS_12) files\\nhave `.p12` or `.pfx` extensions. This format is a less popular\\nalternative to {ref}`PEM <glossPEM>`.\\n\\n(glossplugin)=\\nPlugin\\n\\n: A bundle of code implementing the Trino [Service Provider Interface\\n(SPI)](/develop/spi-overview). that is used to add new functionality.\\nMore information is available in [](/installation/plugins).\\n\\nPresto and PrestoSQL\\n\\n: The old name for Trino. To learn more about the name change to Trino, read\\n[the history](<https://wikipedia.org/wiki/Trino_(SQL_query_engine)#History>).\\n\\nQuery federation\\n\\n: A type of {ref}`data virtualization <glossDataVirtualization>` that provides a\\ncommon access point and data model across two or more heterogeneous data\\nsources. A popular data model used by many query federation engines is\\ntranslating different data sources to {ref}`SQL <glossSQL>` tables.\\n\\n(glossssl)=\\nSecure Sockets Layer (SSL)\\n\\n: Now superseded by {ref}`TLS <glossTLS>`, but still recognized as the term\\nfor what TLS does.\\n\\n(glosssql)=\\nStructured Query Language (SQL)\\n\\n: The standard language used with relational databases. For more information,\\nsee {doc}`SQL </language>`.\\n\\n(glosstarball)=\\nTarball\\n\\n: A common abbreviation for [TAR file](<https://wikipedia.org/wiki/Tar_(computing)>), which is a common software\\ndistribution mechanism. This file format is a collection of multiple files\\ndistributed as a single file, commonly compressed using {ref}`gzip\\n<glossGzip>` compression.\\n\\n(glosstls)=\\nTransport Layer Security (TLS)\\n\\n: [TLS](https://wikipedia.org/wiki/Transport_Layer_Security) is a security\\nprotocol designed to provide secure communications over a network. It is the\\nsuccessor to {ref}`SSL <glossSSL>`, and used in many applications like\\nHTTPS, email, and Trino. These security topics use the term TLS to refer to\\nboth TLS and SSL.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\"}, {\"title\": \"Index\", \"description\": null, \"content\": {\"Trino documentation\": \"```\\n:titlesonly: true\\n\\noverview\\ninstallation\\nclient\\nsecurity\\nadmin\\noptimizer\\nconnector\\nobject-storage\\nfunctions\\nudf\\nlanguage\\nsql\\ndevelop\\nglossary\\nappendix\\n```\\n\\n```\\n:maxdepth: 1\\n:titlesonly: true\\n\\nrelease\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\"}, {\"title\": \"Installation\", \"description\": null, \"content\": {\"Installation\": \"A Trino server can be installed and deployed on a number of different\\nplatforms. Typically you run a cluster of machines with one coordinator and many\\nworkers. You can find instructions for deploying such a cluster, and related\\ninformation, in the following sections:\\n\\n```\\n:maxdepth: 1\\n\\ninstallation/deployment\\ninstallation/containers\\ninstallation/kubernetes\\ninstallation/plugins\\ninstallation/query-resiliency\\n```\\n\\nOnce you have a completed the deployment, or if you have access to a running\\ncluster already, you can proceed to configure your {doc}`client application\\n</client>`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\"}, {\"title\": \"Language\", \"description\": null, \"content\": {\"SQL language\": \"Trino is an ANSI SQL compliant query engine. This standard compliance allows\\nTrino users to integrate their favorite data tools, including BI and ETL tools\\nwith any underlying data source.\\n\\nTrino validates and translates the received SQL statements into the necessary\\noperations on the connected data source.\\n\\nThis section provides a reference to the supported SQL data types and other\\ngeneral characteristics of the SQL support of Trino.\\n\\nRefer to the following sections for further details:\\n\\n['[SQL statement and syntax reference](/sql)', '[SQL functions and operators](/functions)']\\n\\n```\\n:maxdepth: 2\\n\\nlanguage/sql-support\\nlanguage/types\\n```\\n\\n```\\n:maxdepth: 1\\n\\nlanguage/reserved\\nlanguage/comments\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\"}, {\"title\": \"Object storage\", \"description\": null, \"content\": {\"Object storage connectors\": \"Trino accesses files directly on object storage and remote file system storage.\\nThe following connectors use this direct approach to read and write data files.\\n\\n['[](/connector/delta-lake)', '[](/connector/hive)', '[](/connector/hudi)', '[](/connector/iceberg)']\\n\\nThe connectors all support a variety of protocols and formats used on these\\nobject storage systems, and have separate requirements for metadata\\navailability.\\n\\n(file-system-configuration)=\", \"Configuration\": \"By default, no file system support is activated for your catalog. You must\\nselect and configure one of the following properties to determine the support\\nfor different file systems in the catalog. Each catalog can only use one file\\nsystem support.\\n\\n:::{list-table} File system support properties\\n:widths: 35, 65\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.native-azure.enabled`', 'Activate the [native implementation for Azure Storage\\\\nsupport](/object-storage/file-system-azure). Defaults to `false`.'], ['`fs.native-gcs.enabled`', 'Activate the [native implementation for Google Cloud Storage\\\\nsupport](/object-storage/file-system-gcs). Defaults to `false`.'], ['`fs.native-s3.enabled`', 'Activate the [native implementation for S3 storage\\\\nsupport](/object-storage/file-system-s3). Defaults to `false`.'], ['`fs.hadoop.enabled`', 'Activate [support for HDFS](/object-storage/file-system-hdfs) and [legacy\\\\nsupport for other file systems](file-system-legacy) using the HDFS\\\\nlibraries. Defaults to `false`.\\\\n:::']]\\n\\n(file-system-native)=\", \"Native file system support\": \"Trino includes optimized implementations to access the following systems, and\\ncompatible replacements:\\n\\n['[](/object-storage/file-system-azure)', '[](/object-storage/file-system-gcs)', '[](/object-storage/file-system-s3)', '[](/object-storage/file-system-local)', '[](/object-storage/file-system-alluxio)']\\n\\nThe native support is available in all four connectors, and must be activated\\nfor use.\\n\\n(file-system-legacy)=\", \"Legacy file system support\": \"The default behavior uses legacy libraries that originate from the Hadoop\\necosystem. It should only be used for accessing the Hadoop Distributed File\\nSystem (HDFS):\\n\\n['[](/object-storage/file-system-hdfs)']\\n\\nAll four connectors can use the deprecated `hive.*` properties for access to\\nother object storage system as *legacy* support. These properties will be\\nremoved in a future release. Additional documentation is available with the Hive\\nconnector and relevant migration guides pages:\\n\\n['[](/connector/hive)', '[Azure Storage migration from hive.azure.* properties](fs-legacy-azure-migration)', '[Google Cloud Storage migration from hive.gcs.* properties](fs-legacy-gcs-migration)', '[S3 migration from hive.s3.* properties](fs-legacy-s3-migration) ']\\n\\n(object-storage-other)=\", \"Other object storage support\": \"Trino also provides the following additional support and features for object\\nstorage:\\n\\n['[](/object-storage/file-system-cache)', '[](/object-storage/file-system-alluxio)', '[](/object-storage/metastores)', '[](/object-storage/file-formats)']\\n\\n```\\n:maxdepth: 1\\n:hidden:\\n\\n/object-storage/file-system-azure\\n/object-storage/file-system-gcs\\n/object-storage/file-system-s3\\n/object-storage/file-system-local\\n/object-storage/file-system-hdfs\\n/object-storage/file-system-cache\\n/object-storage/file-system-alluxio\\n/object-storage/metastores\\n/object-storage/file-formats\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\"}, {\"title\": \"Optimizer\", \"description\": null, \"content\": {\"Query optimizer\": \"```\\n:maxdepth: 1\\n\\noptimizer/statistics\\noptimizer/cost-in-explain\\noptimizer/cost-based-optimizations\\noptimizer/pushdown\\noptimizer/adaptive-plan-optimizations\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 11]\"}, {\"title\": \"Overview\", \"description\": null, \"content\": {\"Overview\": \"Trino is a distributed SQL query engine designed to query large data sets\\ndistributed over one or more heterogeneous data sources.\\n\\n```\\n:maxdepth: 1\\n\\noverview/use-cases\\noverview/concepts\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 12]\"}, {\"title\": \"Release notes\", \"description\": null, \"content\": {\"2025\": \"```\\n:maxdepth: 1\\n\\nrelease/release-476\\nrelease/release-475\\nrelease/release-474\\nrelease/release-473\\nrelease/release-472\\nrelease/release-471\\nrelease/release-470\\nrelease/release-469\\n```\\n\\n(releases-2024)=\", \"2024\": \"```\\n:maxdepth: 1\\n\\nrelease/release-468\\nrelease/release-467\\nrelease/release-466\\nrelease/release-465\\nrelease/release-464\\nrelease/release-463\\nrelease/release-462\\nrelease/release-461\\nrelease/release-460\\nrelease/release-459\\nrelease/release-458\\nrelease/release-457\\nrelease/release-456\\nrelease/release-455\\nrelease/release-454\\nrelease/release-453\\nrelease/release-452\\nrelease/release-451\\nrelease/release-450\\nrelease/release-449\\nrelease/release-448\\nrelease/release-447\\nrelease/release-446\\nrelease/release-445\\nrelease/release-444\\nrelease/release-443\\nrelease/release-442\\nrelease/release-441\\nrelease/release-440\\nrelease/release-439\\nrelease/release-438\\nrelease/release-437\\nrelease/release-436\\n```\\n\\n(releases-2023)=\", \"2023\": \"```\\n:maxdepth: 1\\n\\nrelease/release-435\\nrelease/release-434\\nrelease/release-433\\nrelease/release-432\\nrelease/release-431\\nrelease/release-430\\nrelease/release-429\\nrelease/release-428\\nrelease/release-427\\nrelease/release-426\\nrelease/release-425\\nrelease/release-424\\nrelease/release-423\\nrelease/release-422\\nrelease/release-421\\nrelease/release-420\\nrelease/release-419\\nrelease/release-418\\nrelease/release-417\\nrelease/release-416\\nrelease/release-415\\nrelease/release-414\\nrelease/release-413\\nrelease/release-412\\nrelease/release-411\\nrelease/release-410\\nrelease/release-409\\nrelease/release-408\\nrelease/release-407\\nrelease/release-406\\n```\\n\\n(releases-2022)=\", \"2022\": \"```\\n:maxdepth: 1\\n\\nrelease/release-405\\nrelease/release-404\\nrelease/release-403\\nrelease/release-402\\nrelease/release-401\\nrelease/release-400\\nrelease/release-399\\nrelease/release-398\\nrelease/release-397\\nrelease/release-396\\nrelease/release-395\\nrelease/release-394\\nrelease/release-393\\nrelease/release-392\\nrelease/release-391\\nrelease/release-390\\nrelease/release-389\\nrelease/release-388\\nrelease/release-387\\nrelease/release-386\\nrelease/release-385\\nrelease/release-384\\nrelease/release-383\\nrelease/release-382\\nrelease/release-381\\nrelease/release-380\\nrelease/release-379\\nrelease/release-378\\nrelease/release-377\\nrelease/release-376\\nrelease/release-375\\nrelease/release-374\\nrelease/release-373\\nrelease/release-372\\nrelease/release-371\\nrelease/release-370\\nrelease/release-369\\nrelease/release-368\\n```\\n\\n(releases-2021)=\", \"2021\": \"```\\n:maxdepth: 1\\n\\nrelease/release-367\\nrelease/release-366\\nrelease/release-365\\nrelease/release-364\\nrelease/release-363\\nrelease/release-362\\nrelease/release-361\\nrelease/release-360\\nrelease/release-359\\nrelease/release-358\\nrelease/release-357\\nrelease/release-356\\nrelease/release-355\\nrelease/release-354\\nrelease/release-353\\nrelease/release-352\\nrelease/release-351\\n```\\n\\n(releases-2020)=\", \"2020\": \"```\\n:maxdepth: 1\\n\\nrelease/release-350\\nrelease/release-349\\nrelease/release-348\\nrelease/release-347\\nrelease/release-346\\nrelease/release-345\\nrelease/release-344\\nrelease/release-343\\nrelease/release-342\\nrelease/release-341\\nrelease/release-340\\nrelease/release-339\\nrelease/release-338\\nrelease/release-337\\nrelease/release-336\\nrelease/release-335\\nrelease/release-334\\nrelease/release-333\\nrelease/release-332\\nrelease/release-331\\nrelease/release-330\\nrelease/release-329\\nrelease/release-328\\n```\\n\\n(releases-2019)=\", \"2019\": \"```\\n:maxdepth: 1\\n\\nrelease/release-327\\nrelease/release-326\\nrelease/release-325\\nrelease/release-324\\nrelease/release-323\\nrelease/release-322\\nrelease/release-321\\nrelease/release-320\\nrelease/release-319\\nrelease/release-318\\nrelease/release-317\\nrelease/release-316\\nrelease/release-315\\nrelease/release-314\\nrelease/release-313\\nrelease/release-312\\nrelease/release-311\\nrelease/release-310\\nrelease/release-309\\nrelease/release-308\\nrelease/release-307\\nrelease/release-306\\nrelease/release-305\\nrelease/release-304\\nrelease/release-303\\nrelease/release-302\\nrelease/release-301\\nrelease/release-300\\n```\", \"Before 2019\": \"```\\n:maxdepth: 1\\n\\nrelease/release-0.215\\nrelease/release-0.214\\nrelease/release-0.213\\nrelease/release-0.212\\nrelease/release-0.211\\nrelease/release-0.210\\nrelease/release-0.209\\nrelease/release-0.208\\nrelease/release-0.207\\nrelease/release-0.206\\nrelease/release-0.205\\nrelease/release-0.204\\nrelease/release-0.203\\nrelease/release-0.202\\nrelease/release-0.201\\nrelease/release-0.200\\nrelease/release-0.199\\nrelease/release-0.198\\nrelease/release-0.197\\nrelease/release-0.196\\nrelease/release-0.195\\nrelease/release-0.194\\nrelease/release-0.193\\nrelease/release-0.192\\nrelease/release-0.191\\nrelease/release-0.190\\nrelease/release-0.189\\nrelease/release-0.188\\nrelease/release-0.187\\nrelease/release-0.186\\nrelease/release-0.185\\nrelease/release-0.184\\nrelease/release-0.183\\nrelease/release-0.182\\nrelease/release-0.181\\nrelease/release-0.180\\nrelease/release-0.179\\nrelease/release-0.178\\nrelease/release-0.177\\nrelease/release-0.176\\nrelease/release-0.175\\nrelease/release-0.174\\nrelease/release-0.173\\nrelease/release-0.172\\nrelease/release-0.171\\nrelease/release-0.170\\nrelease/release-0.169\\nrelease/release-0.168\\nrelease/release-0.167\\nrelease/release-0.166\\nrelease/release-0.165\\nrelease/release-0.164\\nrelease/release-0.163\\nrelease/release-0.162\\nrelease/release-0.161\\nrelease/release-0.160\\nrelease/release-0.159\\nrelease/release-0.158\\nrelease/release-0.157.1\\nrelease/release-0.157\\nrelease/release-0.156\\nrelease/release-0.155\\nrelease/release-0.154\\nrelease/release-0.153\\nrelease/release-0.152.3\\nrelease/release-0.152.2\\nrelease/release-0.152.1\\nrelease/release-0.152\\nrelease/release-0.151\\nrelease/release-0.150\\nrelease/release-0.149\\nrelease/release-0.148\\nrelease/release-0.147\\nrelease/release-0.146\\nrelease/release-0.145\\nrelease/release-0.144.7\\nrelease/release-0.144.6\\nrelease/release-0.144.5\\nrelease/release-0.144.4\\nrelease/release-0.144.3\\nrelease/release-0.144.2\\nrelease/release-0.144.1\\nrelease/release-0.144\\nrelease/release-0.143\\nrelease/release-0.142\\nrelease/release-0.141\\nrelease/release-0.140\\nrelease/release-0.139\\nrelease/release-0.138\\nrelease/release-0.137\\nrelease/release-0.136\\nrelease/release-0.135\\nrelease/release-0.134\\nrelease/release-0.133\\nrelease/release-0.132\\nrelease/release-0.131\\nrelease/release-0.130\\nrelease/release-0.129\\nrelease/release-0.128\\nrelease/release-0.127\\nrelease/release-0.126\\nrelease/release-0.125\\nrelease/release-0.124\\nrelease/release-0.123\\nrelease/release-0.122\\nrelease/release-0.121\\nrelease/release-0.120\\nrelease/release-0.119\\nrelease/release-0.118\\nrelease/release-0.117\\nrelease/release-0.116\\nrelease/release-0.115\\nrelease/release-0.114\\nrelease/release-0.113\\nrelease/release-0.112\\nrelease/release-0.111\\nrelease/release-0.110\\nrelease/release-0.109\\nrelease/release-0.108\\nrelease/release-0.107\\nrelease/release-0.106\\nrelease/release-0.105\\nrelease/release-0.104\\nrelease/release-0.103\\nrelease/release-0.102\\nrelease/release-0.101\\nrelease/release-0.100\\nrelease/release-0.99\\nrelease/release-0.98\\nrelease/release-0.97\\nrelease/release-0.96\\nrelease/release-0.95\\nrelease/release-0.94\\nrelease/release-0.93\\nrelease/release-0.92\\nrelease/release-0.91\\nrelease/release-0.90\\nrelease/release-0.89\\nrelease/release-0.88\\nrelease/release-0.87\\nrelease/release-0.86\\nrelease/release-0.85\\nrelease/release-0.84\\nrelease/release-0.83\\nrelease/release-0.82\\nrelease/release-0.81\\nrelease/release-0.80\\nrelease/release-0.79\\nrelease/release-0.78\\nrelease/release-0.77\\nrelease/release-0.76\\nrelease/release-0.75\\nrelease/release-0.74\\nrelease/release-0.73\\nrelease/release-0.72\\nrelease/release-0.71\\nrelease/release-0.70\\nrelease/release-0.69\\nrelease/release-0.68\\nrelease/release-0.67\\nrelease/release-0.66\\nrelease/release-0.65\\nrelease/release-0.64\\nrelease/release-0.63\\nrelease/release-0.62\\nrelease/release-0.61\\nrelease/release-0.60\\nrelease/release-0.59\\nrelease/release-0.58\\nrelease/release-0.57\\nrelease/release-0.56\\nrelease/release-0.55\\nrelease/release-0.54\\n```\", \"Breaking changes\": \"Starting with Trino 432, release notes include a \\u26a0\\ufe0f symbol to highlight any\\nchanges as potentially breaking changes. The following changes are considered\\nand may require adjustments:\\n\\n['Removal or renaming of configuration properties that may prevent startup or\\\\nrequire configuration changes', 'Changes to default values for configuration properties that may significantly\\\\nchange the behavior of a system', 'Updates to the requirements for external systems or software used with Trino,\\\\nsuch as removal of support for an old version of a data source in a connector', 'Non-backwards compatible changes to the SPI which may require plugins to be\\\\nupdated', 'Otherwise significant changes that requires specific attention from teams\\\\nmanaging a Trino deployment']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 13]\"}, {\"title\": \"Security\", \"description\": null, \"content\": {\"Introduction\": \"```\\n:maxdepth: 1\\n\\nsecurity/overview\\n```\", \"Cluster access security\": \"```\\n:maxdepth: 1\\n\\nsecurity/tls\\nsecurity/inspect-pem\\nsecurity/inspect-jks\\n```\\n\\n(security-authentication)=\", \"Authentication\": \"```\\n:maxdepth: 1\\n\\nsecurity/authentication-types\\nsecurity/password-file\\nsecurity/ldap\\nsecurity/salesforce\\nsecurity/oauth2\\nsecurity/kerberos\\nsecurity/certificate\\nsecurity/jwt\\n```\", \"User name management\": \"```\\n:maxdepth: 1\\n\\nsecurity/user-mapping\\nsecurity/group-file\\n```\\n\\n(security-access-control)=\", \"Access control\": \"```\\n:maxdepth: 1\\n\\nsecurity/built-in-system-access-control\\nsecurity/file-system-access-control\\nsecurity/opa-access-control\\nsecurity/ranger-access-control\\n```\", \"Security inside the cluster\": \"```\\n:maxdepth: 1\\n\\nsecurity/internal-communication\\nsecurity/secrets\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 14]\"}, {\"title\": \"Sql\", \"description\": null, \"content\": {\"SQL statement syntax\": \"This section describes the syntax for SQL statements that can be executed in\\nTrino.\\n\\nRefer to the following sections for further details:\\n\\n['[SQL data types and other general aspects](/language)', '[SQL functions and operators](/functions)']\\n\\n```\\n:maxdepth: 1\\n\\nsql/alter-materialized-view\\nsql/alter-schema\\nsql/alter-table\\nsql/alter-view\\nsql/analyze\\nsql/call\\nsql/comment\\nsql/commit\\nsql/create-catalog\\nsql/create-function\\nsql/create-materialized-view\\nsql/create-role\\nsql/create-schema\\nsql/create-table\\nsql/create-table-as\\nsql/create-view\\nsql/deallocate-prepare\\nsql/delete\\nsql/deny\\nsql/describe\\nsql/describe-input\\nsql/describe-output\\nsql/drop-catalog\\nsql/drop-function\\nsql/drop-materialized-view\\nsql/drop-role\\nsql/drop-schema\\nsql/drop-table\\nsql/drop-view\\nsql/execute\\nsql/execute-immediate\\nsql/explain\\nsql/explain-analyze\\nsql/grant\\nsql/grant-roles\\nsql/insert\\nsql/match-recognize\\nsql/merge\\nsql/prepare\\nsql/refresh-materialized-view\\nsql/reset-session\\nsql/reset-session-authorization\\nsql/revoke\\nsql/revoke-roles\\nsql/rollback\\nsql/select\\nsql/set-path\\nsql/set-role\\nsql/set-session\\nsql/set-session-authorization\\nsql/set-time-zone\\nsql/show-catalogs\\nsql/show-columns\\nsql/show-create-function\\nsql/show-create-materialized-view\\nsql/show-create-schema\\nsql/show-create-table\\nsql/show-create-view\\nsql/show-functions\\nsql/show-grants\\nsql/show-role-grants\\nsql/show-roles\\nsql/show-schemas\\nsql/show-session\\nsql/show-stats\\nsql/show-tables\\nsql/start-transaction\\nsql/truncate\\nsql/update\\nsql/use\\nsql/values\\n```\\n\\n```\\n:hidden:\\n\\nsql/pattern-recognition-in-window\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 15]\"}, {\"title\": \"Udf\", \"description\": null, \"content\": {\"User-defined functions\": \"A user-defined function (UDF) is a custom function authored by a user of Trino\\nin a client application. UDFs are scalar functions that return a single output\\nvalue, similar to [built-in functions](/functions).\\n\\nMore details are available in the following sections:\\n\\n```\\n:titlesonly: true\\n:maxdepth: 1\\n\\nudf/introduction\\nudf/function\\nudf/sql\\nudf/python\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 16]\"}, {\"title\": \"Admin\", \"description\": \"Documentation section: admin\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/admin\"}, \"subpages\": [{\"title\": \"Dist Sort\", \"description\": null, \"content\": {\"Distributed sort\": \"Distributed sort allows to sort data, which exceeds `query.max-memory-per-node`.\\nDistributed sort is enabled via the `distributed_sort` session property, or\\n`distributed-sort` configuration property set in\\n`etc/config.properties` of the coordinator. Distributed sort is enabled by\\ndefault.\\n\\nWhen distributed sort is enabled, the sort operator executes in parallel on multiple\\nnodes in the cluster. Partially sorted data from each Trino worker node is then streamed\\nto a single worker node for a final merge. This technique allows to utilize memory of multiple\\nTrino worker nodes for sorting. The primary purpose of distributed sort is to allow for sorting\\nof data sets which don't normally fit into single node memory. Performance improvement\\ncan be expected, but it won't scale linearly with the number of nodes, since the\\ndata needs to be merged by a single node.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 0]\"}, {\"title\": \"Dynamic filtering\", \"description\": null, \"content\": {\"Analysis and confirmation\": \"Dynamic filtering depends on a number of factors:\\n\\n['Planner support for dynamic filtering for a given join operation in Trino.\\\\nCurrently inner and right joins with `=`, `<`, `<=`, `>`, `>=` or\\\\n`IS NOT DISTINCT FROM` join conditions, and\\\\nsemi-joins with `IN` conditions are supported.', 'Connector support for utilizing dynamic filters pushed into the table scan at runtime.\\\\nFor example, the Hive connector can push dynamic filters into ORC and Parquet readers\\\\nto perform stripe or row-group pruning.', 'Connector support for utilizing dynamic filters at the splits enumeration stage.', 'Size of right (build) side of the join.']\\n\\nYou can take a closer look at the {doc}`EXPLAIN plan </sql/explain>` of the query\\nto analyze if the planner is adding dynamic filters to a specific query's plan.\\nFor example, the explain plan for the above query can be obtained by running\\nthe following statement:\\n\\n```\\nEXPLAIN\\nSELECT count(*)\\nFROM store_sales\\nJOIN date_dim ON store_sales.ss_sold_date_sk = date_dim.d_date_sk\\nWHERE d_following_holiday='Y' AND d_year = 2000;\\n```\\n\\nThe explain plan for this query shows `dynamicFilterAssignments` in the\\n`InnerJoin` node with dynamic filter `df_370` collected from build symbol `d_date_sk`.\\nYou can also see the `dynamicFilter` predicate as part of the Hive `ScanFilterProject`\\noperator where `df_370` is associated with probe symbol `ss_sold_date_sk`.\\nThis shows you that the planner is successful in pushing dynamic filters\\ndown to the connector in the query plan.\\n\\n```\\n...\\n\\nFragment 1 [SOURCE]\\n Output layout: [count_3]\\n Output partitioning: SINGLE []\\n Aggregate(PARTIAL)\\n \\u2502 Layout: [count_3:bigint]\\n \\u2502 count_3 := count(*)\\n \\u2514\\u2500 InnerJoin[(\\\"\\\"ss_sold_date_sk\\\"\\\" = \\\"\\\"d_date_sk\\\"\\\")][$hashvalue, $hashvalue_4]\\n \\u2502 Layout: []\\n \\u2502 Estimates: {rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}\\n \\u2502 Distribution: REPLICATED\\n \\u2502 dynamicFilterAssignments = {d_date_sk -> #df_370}\\n \\u251c\\u2500 ScanFilterProject[table = hive:default:store_sales, grouped = false, filterPredicate = true, dynamicFilters = {\\\"\\\"ss_sold_date_sk\\\"\\\" = #df_370}]\\n \\u2502 Layout: [ss_sold_date_sk:bigint, $hashvalue:bigint]\\n \\u2502 Estimates: {rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}/{rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}/{rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}\\n \\u2502 $hashvalue := combine_hash(bigint '0', COALESCE(\\\"\\\"$operator$hash_code\\\"\\\"(\\\"\\\"ss_sold_date_sk\\\"\\\"), 0))\\n \\u2502 ss_sold_date_sk := ss_sold_date_sk:bigint:REGULAR\\n \\u2514\\u2500 LocalExchange[HASH][$hashvalue_4] (\\\"\\\"d_date_sk\\\"\\\")\\n \\u2502 Layout: [d_date_sk:bigint, $hashvalue_4:bigint]\\n \\u2502 Estimates: {rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}\\n \\u2514\\u2500 RemoteSource[2]\\n Layout: [d_date_sk:bigint, $hashvalue_5:bigint]\\n\\nFragment 2 [SOURCE]\\n Output layout: [d_date_sk, $hashvalue_6]\\n Output partitioning: BROADCAST []\\n ScanFilterProject[table = hive:default:date_dim, grouped = false, filterPredicate = ((\\\"\\\"d_following_holiday\\\"\\\" = CAST('Y' AS char(1))) AND (\\\"\\\"d_year\\\"\\\" = 2000))]\\n Layout: [d_date_sk:bigint, $hashvalue_6:bigint]\\n Estimates: {rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}/{rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}/{rows: 0 (0B), cpu: 0, memory: 0B, network: 0B}\\n $hashvalue_6 := combine_hash(bigint '0', COALESCE(\\\"\\\"$operator$hash_code\\\"\\\"(\\\"\\\"d_date_sk\\\"\\\"), 0))\\n d_following_holiday := d_following_holiday:char(1):REGULAR\\n d_date_sk := d_date_sk:bigint:REGULAR\\n d_year := d_year:int:REGULAR\\n```\\n\\nDuring execution of a query with dynamic filters, Trino populates statistics\\nabout dynamic filters in the QueryInfo JSON available through the\\n{doc}`/admin/web-interface`.\\nIn the `queryStats` section, statistics about dynamic filters collected\\nby the coordinator can be found in the `dynamicFiltersStats` structure.\\n\\n```\\n\\\"dynamicFiltersStats\\\" : {\\n \\\"dynamicFilterDomainStats\\\" : [ {\\n \\\"dynamicFilterId\\\" : \\\"df_370\\\",\\n \\\"simplifiedDomain\\\" : \\\"[ SortedRangeSet[type=bigint, ranges=3, {[2451546], ..., [2451905]}] ]\\\",\\n \\\"collectionDuration\\\" : \\\"2.34s\\\"\\n } ],\\n \\\"lazyDynamicFilters\\\" : 1,\\n \\\"replicatedDynamicFilters\\\" : 1,\\n \\\"totalDynamicFilters\\\" : 1,\\n \\\"dynamicFiltersCompleted\\\" : 1\\n}\\n```\\n\\nPush down of dynamic filters into a table scan on the worker nodes can be\\nverified by looking at the operator statistics for that table scan.\\n`dynamicFilterSplitsProcessed` records the number of splits\\nprocessed after a dynamic filter is pushed down to the table scan.\\n\\n```\\n\\\"operatorType\\\" : \\\"ScanFilterAndProjectOperator\\\",\\n\\\"totalDrivers\\\" : 1,\\n\\\"addInputCalls\\\" : 762,\\n\\\"addInputWall\\\" : \\\"0.00ns\\\",\\n\\\"addInputCpu\\\" : \\\"0.00ns\\\",\\n\\\"physicalInputDataSize\\\" : \\\"0B\\\",\\n\\\"physicalInputPositions\\\" : 28800991,\\n\\\"inputPositions\\\" : 28800991,\\n\\\"dynamicFilterSplitsProcessed\\\" : 1,\\n```\\n\\nDynamic filters are reported as a part of the\\n{doc}`EXPLAIN ANALYZE plan </sql/explain-analyze>` in the statistics for\\n`ScanFilterProject` nodes.\\n\\n```\\n...\\n\\n \\u2514\\u2500 InnerJoin[(\\\"ss_sold_date_sk\\\" = \\\"d_date_sk\\\")][$hashvalue, $hashvalue_4]\\n \\u2502 Layout: []\\n \\u2502 Estimates: {rows: 11859 (0B), cpu: 8.84M, memory: 3.19kB, network: 3.19kB}\\n \\u2502 CPU: 78.00ms (30.00%), Scheduled: 295.00ms (47.05%), Output: 296 rows (0B)\\n \\u2502 Left (probe) Input avg.: 120527.00 rows, Input std.dev.: 0.00%\\n \\u2502 Right (build) Input avg.: 0.19 rows, Input std.dev.: 208.17%\\n \\u2502 Distribution: REPLICATED\\n \\u2502 dynamicFilterAssignments = {d_date_sk -> #df_370}\\n \\u251c\\u2500 ScanFilterProject[table = hive:default:store_sales, grouped = false, filterPredicate = true, dynamicFilters = {\\\"ss_sold_date_sk\\\" = #df_370}]\\n \\u2502 Layout: [ss_sold_date_sk:bigint, $hashvalue:bigint]\\n \\u2502 Estimates: {rows: 120527 (2.03MB), cpu: 1017.64k, memory: 0B, network: 0B}/{rows: 120527 (2.03MB), cpu: 1.99M, memory: 0B, network: 0B}/{rows: 120527 (2.03MB), cpu: 4.02M, memory: 0B, network: 0B}\\n \\u2502 CPU: 49.00ms (18.85%), Scheduled: 123.00ms (19.62%), Output: 120527 rows (2.07MB)\\n \\u2502 Input avg.: 120527.00 rows, Input std.dev.: 0.00%\\n \\u2502 $hashvalue := combine_hash(bigint '0', COALESCE(\\\"$operator$hash_code\\\"(\\\"ss_sold_date_sk\\\"), 0))\\n \\u2502 ss_sold_date_sk := ss_sold_date_sk:bigint:REGULAR\\n \\u2502 Input: 120527 rows (1.03MB), Filtered: 0.00%\\n \\u2502 Dynamic filters:\\n \\u2502 - df_370, [ SortedRangeSet[type=bigint, ranges=3, {[2451546], ..., [2451905]}] ], collection time=2.34s\\n |\\n...\\n```\", \"Dynamic filter collection thresholds\": \"In order for dynamic filtering to work, the smaller dimension table\\nneeds to be chosen as a join\\u2019s build side. The cost-based optimizer can automatically\\ndo this using table statistics provided by connectors. Therefore, it is recommended\\nto keep {doc}`table statistics </optimizer/statistics>` up to date and rely on the\\nCBO to correctly choose the smaller table on the build side of join.\\n\\nCollection of values of the join key columns from the build side for\\ndynamic filtering may incur additional CPU overhead during query execution.\\nTherefore, to limit the overhead of collecting dynamic filters\\nto the cases where the join operator is likely to be selective,\\nTrino defines thresholds on the size of dynamic filters collected from build side tasks.\\nCollection of dynamic filters for joins with large build sides can be enabled\\nusing the `enable-large-dynamic-filters` configuration property or the\\n`enable_large_dynamic_filters` session property.\\n\\nWhen large dynamic filters are enabled, limits on the size of dynamic filters can\\nbe configured using the configuration properties\\n`dynamic-filtering.large.max-distinct-values-per-driver`,\\n`dynamic-filtering.large.max-size-per-driver` ,\\n`dynamic-filtering.large.range-row-limit-per-driver`,\\n`dynamic-filtering.large-partitioned.max-distinct-values-per-driver`,\\n`dynamic-filtering.large-partitioned.max-size-per-driver` and\\n`dynamic-filtering.large-partitioned.range-row-limit-per-driver`.\\n\\nSimilarly, limits for dynamic filters when `enable-large-dynamic-filters`\\nis not enabled can be configured using configuration properties like\\n`dynamic-filtering.small.max-distinct-values-per-driver`,\\n`dynamic-filtering.small.max-size-per-driver` ,\\n`dynamic-filtering.small.range-row-limit-per-driver`,\\n`dynamic-filtering.small-partitioned.max-distinct-values-per-driver`,\\n`dynamic-filtering.small-partitioned.max-size-per-driver` and\\n`dynamic-filtering.small-partitioned.range-row-limit-per-driver`.\\n\\nThe `dynamic-filtering.large.*` and `dynamic-filtering.small.*` limits are applied\\nwhen dynamic filters are collected before build side is partitioned on join\\nkeys (when broadcast join is chosen or when fault-tolerant execution is enabled). The\\n`dynamic-filtering.large-partitioned.*` and `dynamic-filtering.small-partitioned.*`\\nlimits are applied when dynamic filters are collected after build side is partitioned\\non join keys (when partitioned join is chosen and fault-tolerant execution is disabled).\\n\\nThe properties based on `max-distinct-values-per-driver` and `max-size-per-driver`\\ndefine thresholds for the size up to which dynamic filters are collected in a\\ndistinct values data structure. When the build side exceeds these thresholds,\\nTrino switches to collecting min and max values per column to reduce overhead.\\nThis min-max filter has much lower granularity than the distinct values filter.\\nHowever, it may still be beneficial in filtering some data from the probe side,\\nespecially when a range of values is selected from the build side of the join.\\nThe limits for min-max filters collection are defined by the properties\\nbased on `range-row-limit-per-driver`.\", \"Dimension tables layout\": \"Dynamic filtering works best for dimension tables where\\ntable keys are correlated with columns.\\n\\nFor example, a date dimension key column should be correlated with a date column,\\nso the table keys monotonically increase with date values.\\nAn address dimension key can be composed of other columns such as\\n`COUNTRY-STATE-ZIP-ADDRESS_ID` with an example value of `US-NY-10001-1234`.\\nThis usage allows dynamic filtering to succeed even with a large number\\nof selected rows from the dimension table.\", \"Limitations\": [\"Min-max dynamic filter collection is not supported for `DOUBLE`, `REAL` and unorderable data types.\", \"Dynamic filtering is not supported for `DOUBLE` and `REAL` data types when using `IS NOT DISTINCT FROM` predicate.\", \"Dynamic filtering is supported when the join key contains a cast from the build key type to the\\nprobe key type. Dynamic filtering is also supported in limited scenarios when there is an implicit\\ncast from the probe key type to the build key type. For example, dynamic filtering is supported when\\nthe build side key is of `DOUBLE` type and the probe side key is of `REAL` or `INTEGER` type.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 1]\"}, {\"title\": \"HTTP event listener\", \"description\": null, \"content\": {\"Rationale\": \"This event listener is a simple first step into better understanding the usage\\nof a datalake using query events provided by Trino. These can provide CPU and memory\\nusage metrics, what data is being accessed with resolution down to specific columns,\\nand metadata about the query processing.\\n\\nRunning the capture system separate from Trino reduces the performance impact and\\navoids downtime for non-client-facing changes.\\n\\n(http-event-listener-requirements)=\", \"Requirements\": \"You need to perform the following steps:\\n\\n['Provide an HTTP/S service that accepts POST events with a JSON body.', 'Configure `http-event-listener.connect-ingest-uri` in the event listener properties file\\\\nwith the URI of the service.', 'Detail the events to send in the {ref}`http-event-listener-configuration` section.']\\n\\n(http-event-listener-configuration)=\", \"Configuration\": {\"Configuration properties\": \":::{list-table}\\n:widths: 40, 40, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['http-event-listener.log-created', 'Enable the plugin to log `QueryCreatedEvent` events', '`false`'], ['http-event-listener.log-completed', 'Enable the plugin to log `QueryCompletedEvent` events', '`false`'], ['http-event-listener.connect-ingest-uri', 'The URI that the plugin will POST events to', 'None. See the [requirements](http-event-listener-requirements) section.'], ['http-event-listener.connect-http-headers', 'List of custom HTTP headers to be sent along with the events. See\\\\n[](http-event-listener-custom-headers) for more details', 'Empty'], ['http-event-listener.connect-http-method', 'Specifies the HTTP method to use for the request. Supported values\\\\nare POST and PUT.', '`POST`'], ['http-event-listener.connect-retry-count', 'The number of retries on server error. A server is considered to be\\\\nin an error state when the response code is 500 or higher', '`0`'], ['http-event-listener.connect-retry-delay', 'Duration for which to delay between attempts to send a request', '`1s`'], ['http-event-listener.connect-backoff-base', 'The base used for exponential backoff when retrying on server error.\\\\nThe formula used to calculate the delay is\\\\n`attemptDelay = retryDelay * backoffBase^{attemptCount}`.\\\\nAttempt count starts from 0. Leave this empty or set to 1 to disable\\\\nexponential backoff and keep constant delays', '`2`'], ['http-event-listener.connect-max-delay', 'The upper bound of a delay between 2 retries. This should be\\\\nused with exponential backoff.', '`1m`'], ['http-event-listener.*', 'Pass configuration onto the HTTP client']]\\n\\n:::\\n\\n(http-event-listener-custom-headers)=\", \"Custom HTTP headers\": \"Providing custom HTTP headers is a useful mechanism for sending metadata along with\\nevent messages.\\n\\nProviding headers follows the pattern of `key:value` pairs separated by commas:\\n\\n```\\nhttp-event-listener.connect-http-headers=\\\"Header-Name-1:header value 1,Header-Value-2:header value 2,...\\\"\\n```\\n\\nIf you need to use a comma(`,`) or colon(`:`) in a header name or value,\\nescape it using a backslash (`\\\\`).\\n\\nKeep in mind that these are static, so they can not carry information\\ntaken from the event itself.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 2]\"}, {\"title\": \"Kafka event listener\", \"description\": null, \"content\": {\"Rationale\": \"This event listener is a first step to store the query history of your Trino\\ncluster. The query events can provide CPU and memory usage metrics, what data is\\nbeing accessed with resolution down to specific columns, and metadata about the\\nquery processing.\\n\\nRunning the capture system separate from Trino reduces the performance impact\\nand avoids downtime for non-client-facing changes.\\n\\n(kafka-event-listener-requirements)=\", \"Requirements\": \"You need to perform the following steps:\\n\\n['Provide a Kafka service that is network-accessible to Trino.', 'Configure `kafka-event-listener.broker-endpoints` in the event listener\\\\nproperties file with the URI of the service', 'Configure what events to send as detailed\\\\nin [](kafka-event-listener-configuration)']\\n\\n(kafka-event-listener-configuration)=\", \"Configuration\": \"To configure the Kafka event listener, create an event listener properties\\nfile in `etc` named `kafka-event-listener.properties` with the following\\ncontents as an example of a minimal required configuration:\\n\\n```\\nevent-listener.name=kafka\\nkafka-event-listener.broker-endpoints=kafka.example.com:9093\\nkafka-event-listener.created-event.topic=query_create\\nkafka-event-listener.completed-event.topic=query_complete\\nkafka-event-listener.client-id=trino-example\\n```\\n\\nAdd `etc/kafka-event-listener.properties` to `event-listener.config-files`\\nin [](config-properties):\\n\\n```\\nevent-listener.config-files=etc/kafka-event-listener.properties,...\\n```\\n\\nIn some cases, such as when using specialized authentication methods, it is\\nnecessary to specify additional Kafka client properties in order to access\\nyour Kafka cluster. To do so, add the `kafka-event-listener.config.resources`\\nproperty to reference your Kafka config files. Note that configs can be\\noverwritten if defined explicitly in `kafka-event-listener.properties`:\\n\\n```\\nevent-listener.name=kafka\\nkafka-event-listener.broker-endpoints=kafka.example.com:9093\\nkafka-event-listener.created-event.topic=query_create\\nkafka-event-listener.completed-event.topic=query_complete\\nkafka-event-listener.client-id=trino-example\\nkafka-event-listener.config.resources=/etc/kafka-configuration.properties\\n```\\n\\nThe contents of `/etc/kafka-configuration.properties` can for example be:\\n\\n```\\nsasl.mechanism=SCRAM-SHA-512\\nsecurity.protocol=SASL_SSL\\nsasl.jaas.config=org.apache.kafka.common.security.scram.ScramLoginModule required \\\\\\n username=\\\"kafkaclient1\\\" \\\\\\n password=\\\"kafkaclient1-secret\\\";\\n```\\n\\nUse the following properties for further configuration.\\n\\n:::{list-table} Kafka event listener configuration properties\\n:widths: 40, 40, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`kafka-event-listener.broker-endpoints`', 'Comma-separated list of Kafka broker endpoints with URL and port, for\\\\nexample `kafka-1.example.com:9093,kafka-2.example.com:9093`.'], ['`kafka-event-listener.anonymization.enabled`', '[Boolean](prop-type-boolean) switch to enable anonymization of the event\\\\ndata in Trino before it is sent to Kafka.', '`false`'], ['`kafka-event-listener.client-id`', '[String identifier](prop-type-string) for the Trino cluster to allow\\\\ndistinction in Kafka, if multiple Trino clusters send events to the same\\\\nKafka system.'], ['`kafka-event-listener.max-request-size`', '[Size value](prop-type-data-size) that specifies the maximum request size the Kafka producer can send; \\\\nmessages exceeding this size will fail.', '`5MB`'], ['`kafka-event-listener.batch-size`', '[Size value](prop-type-data-size) that specifies the size to batch before sending records to Kafka.', '`16KB`'], ['`kafka-event-listener.publish-created-event`', '[Boolean](prop-type-boolean) switch to control publishing of query creation\\\\nevents.', '`true`'], ['`kafka-event-listener.created-event.topic`', 'Name of the Kafka topic for the query creation event data.'], ['`kafka-event-listener.publish-completed-event`', '[Boolean](prop-type-boolean) switch to control publishing of query\\\\ncompletion events.', '`true`'], ['`kafka-event-listener.completed-event.topic`', 'Name of the Kafka topic for the query completion event data.'], ['`kafka-event-listener.excluded-fields`', 'Comma-separated list of field names to exclude from the Kafka event, for\\\\nexample `payload,user`. Values are replaced with null.'], ['`kafka-event-listener.request-timeout`', 'Timeout [duration](prop-type-duration) to complete a Kafka request. Minimum\\\\nvalue of `1ms`.', '`10s`'], ['`kafka-event-listener.terminate-on-initialization-failure`', 'Kafka publisher initialization can fail due to network issues reaching the\\\\nKafka brokers. This [boolean](prop-type-boolean) switch controls whether to\\\\nthrow an exception in such cases.', '`true`'], ['`kafka-event-listener.env-var-prefix`', 'When set, Kafka events are sent with additional metadata populated from\\\\nenvironment variables. For example, if the value is `TRINO_INSIGHTS_` and an\\\\nenvironment variable on the cluster is set at\\\\n`TRINO_INSIGHTS_CLUSTER_ID=foo`, then the Kafka payload metadata contains\\\\n`CLUSTER_ID=foo`.'], ['`kafka-event-listener.config.resources`', 'A comma-separated list of Kafka client configuration files. These files\\\\nmust exist on the machines running Trino. Only specify this if absolutely\\\\nnecessary to access Kafka. Example: `/etc/kafka-configuration.properties`']]\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 3]\"}, {\"title\": \"MySQL event listener\", \"description\": null, \"content\": {\"Rationale\": \"This event listener is a first step to store the query history of your Trino\\ncluster. The query events can provide CPU and memory usage metrics, what data is\\nbeing accessed with resolution down to specific columns, and metadata about the\\nquery processing.\\n\\nRunning the capture system separate from Trino reduces the performance impact\\nand avoids downtime for non-client-facing changes.\", \"Requirements\": \"You need to perform the following steps:\\n\\n['Create a MySQL database.', 'Determine the JDBC connection URL for the database.', 'Ensure network access from the Trino coordinator to MySQL is available.\\\\nPort 3306 is the default port.']\\n\\n(mysql-event-listener-configuration)=\", \"Configuration\": {\"Configuration properties\": \":::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`mysql-event-listener.db.url`', 'JDBC connection URL to the database including credentials'], ['`mysql-event-listener.terminate-on-initialization-failure`', 'MySQL event listener initialization can fail if the database is unavailable.\\\\nThis [boolean](prop-type-boolean) switch controls whether to throw an \\\\nexception in such cases. Defaults to `true`.\\\\n:::']]\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 4]\"}, {\"title\": \"OpenLineage event listener\", \"description\": null, \"content\": {\"Rationale\": {\"Available Trino Facets\": {\"Trino Metadata\": \"Facet containing properties (if present):\\n\\n['`queryPlan`', '`transactionId` - transaction id used for query processing']\\n\\nrelated to query based on which OpenLineage Run Event was generated.\\n\\nAvailable in both `Start` and `Complete/Fail` OpenLineage events.\\n\\nIf you want to disable this facet, add `trino_metadata` to \\n`openlineage-event-listener.disabled-facets`.\", \"Trino Query Context\": \"Facet containing properties:\\n\\n['`serverVersion` - version of Trino server that was used to process the query', '`environment` - inherited from `node.environment` of [](node-properties)', '`queryType` - one of query types configured via \\\\n`openlineage-event-listener.trino.include-query-types`']\\n\\nrelated to query based on which OpenLineage Run Event was generated.\\n\\nAvailable in both `Start` and `Complete/Fail` OpenLineage events.\\n\\nIf you want to disable this facet, add `trino_query_context` to\\n`openlineage-event-listener.disabled-facets`.\", \"Trino Query Statistics\": \"Facet containing full contents of query statistics of completed. Available only\\nin OpenLineage `Complete/Fail` events.\\n\\nIf you want to disable this facet, add `trino_query_statistics` to\\n`openlineage-event-listener.disabled-facets`.\\n\\n(openlineage-event-listener-requirements)=\"}}, \"Requirements\": \"You need to perform the following steps:\\n\\n['Provide an HTTP/S service that accepts POST events with a JSON body and is\\\\ncompatible with the OpenLineage API format.', 'Configure `openlineage-event-listener.transport.url` in the event listener\\\\nproperties file with the URI of the service', 'Configure `openlineage-event-listener.trino.uri` so proper OpenLineage job \\\\nnamespace is render within produced events. Needs to be proper uri with scheme,\\\\nhost and port (otherwise plugin will fail to start).', 'Configure what events to send as detailed\\\\nin [](openlineage-event-listener-configuration)']\\n\\n(openlineage-event-listener-configuration)=\", \"Configuration\": {\"Supported Transport Types\": [\"`CONSOLE` - sends OpenLineage JSON event to Trino coordinator standard output.\", \"`HTTP` - sends OpenLineage JSON event to OpenLineage compatible HTTP endpoint.\"], \"Custom HTTP headers\": \"Providing custom HTTP headers is a useful mechanism for sending metadata along \\nwith event messages.\\n\\nProviding headers follows the pattern of `key:value` pairs separated by commas:\\n\\n```\\nopenlineage-event-listener.transport.headers=\\\"Header-Name-1:header value 1,Header-Value-2:header value 2,...\\\"\\n```\\n\\nIf you need to use a comma(`,`) or colon(`:`) in a header name or value,\\nescape it using a backslash (`\\\\`).\\n\\nKeep in mind that these are static, so they can not carry information\\ntaken from the event itself.\\n\\n(openlineage-event-listener-custom-url-params)=\", \"Custom URL Params\": \"Providing additional URL Params included in final HTTP Request.\\n\\nProviding url params follows the pattern of `key:value` pairs separated by commas:\\n\\n```\\nopenlineage-event-listener.transport.url-params=\\\"Param-Name-1:param value 1,Param-Value-2:param value 2,...\\\"\\n```\\n\\nKeep in mind that these are static, so they can not carry information\\ntaken from the event itself.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 5]\"}, {\"title\": \"Fault-tolerant execution\", \"description\": null, \"content\": {\"Configuration\": \"Fault-tolerant execution is turned off by default. To enable the feature, set the\\n`retry-policy` configuration property to either `QUERY` or `TASK`\\ndepending on the desired {ref}`retry policy <fte-retry-policy>`.\\n\\n```\\nretry-policy=QUERY\\n```\\n\\n:::{warning}\\nSetting `retry-policy` may cause queries to fail with connectors that do not\\nexplicitly support fault-tolerant execution, resulting in a \\\"This connector\\ndoes not support query retries\\\" error message.\\n\\nSupport for fault-tolerant execution of SQL statements varies on a\\nper-connector basis, with more details in the documentation for each\\nconnector. The following connectors support fault-tolerant execution:\\n\\n['{ref}`BigQuery connector <bigquery-fte-support>`', '{ref}`Delta Lake connector <delta-lake-fte-support>`', '{ref}`Hive connector <hive-fte-support>`', '{ref}`Iceberg connector <iceberg-fte-support>`', '{ref}`MariaDB connector <mariadb-fte-support>`', '{ref}`MongoDB connector <mongodb-fte-support>`', '{ref}`MySQL connector <mysql-fte-support>`', '{ref}`Oracle connector <oracle-fte-support>`', '{ref}`PostgreSQL connector <postgresql-fte-support>`', '{ref}`Redshift connector <redshift-fte-support>`', '{ref}`SQL Server connector <sqlserver-fte-support>`\\\\n:::']\\n\\nThe following configuration properties control the behavior of fault-tolerant\\nexecution on a Trino cluster:\\n\\n:::{list-table} Fault-tolerant execution configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value'], ['`retry-policy`', 'Configures what is retried in the event of failure, either `QUERY` to retry\\\\nthe whole query, or `TASK` to retry tasks individually if they fail. See\\\\n[retry policy](fte-retry-policy) for more information. Use the equivalent\\\\nsession property `retry_policy` only on clusters configured for\\\\nfault-tolerant execution and typically only to deactivate with `NONE`, since\\\\nswitching between modes on a cluster is not tested.', '`NONE`'], ['`exchange.deduplication-buffer-size`', '[Data size](prop-type-data-size) of the coordinator\\\\'s in-memory buffer used\\\\nby fault-tolerant execution to store output of query\\\\n[stages](trino-concept-stage). If this buffer is filled during query\\\\nexecution, the query fails with a \\\"Exchange manager must be configured for \\\\nthe failure recovery capabilities to be fully functional\\\" error message unless an \\\\n[exchange manager](fte-exchange-manager) is configured.', '`32MB`'], ['`fault-tolerant-execution.exchange-encryption-enabled`', 'Enable encryption of spooling data, see [Encryption](fte-encryption) for details.\\\\nSetting this property to false is not recommended if Trino processes sensitive data.', '``true``\\\\n:::']]\\n\\nFind further related properties in [](/admin/properties), specifically in\\n[](/admin/properties-resource-management) and [](/admin/properties-exchange).\\n\\n(fte-retry-policy)=\", \"Retry policy\": {\"QUERY\": \"A `QUERY` retry policy instructs Trino to automatically retry a query in the\\nevent of an error occurring on a worker node. A `QUERY` retry policy is\\nrecommended when the majority of the Trino cluster's workload consists of many\\nsmall queries.\\n\\nBy default Trino does not implement fault tolerance for queries whose result set\\nexceeds 32MB in size, such as {doc}`/sql/select` statements that return a very\\nlarge data set to the user. This limit can be increased by modifying the\\n`exchange.deduplication-buffer-size` configuration property to be greater than\\nthe default value of `32MB`, but this results in higher memory usage on the\\ncoordinator.\\n\\nTo enable fault-tolerant execution on queries with a larger result set, it is\\nstrongly recommended to configure an {ref}`exchange manager\\n<fte-exchange-manager>` that utilizes external storage for spooled data and\\ntherefore allows for storage of spilled data beyond the in-memory buffer size.\", \"TASK\": \"A `TASK` retry policy instructs Trino to retry individual query {ref}`tasks\\n<trino-concept-task>` in the event of failure. You must configure an\\n{ref}`exchange manager <fte-exchange-manager>` to use the task retry policy.\\nThis policy is recommended when executing large batch queries, as the cluster\\ncan more efficiently retry smaller tasks within the query rather than retry the\\nwhole query.\\n\\nWhen a cluster is configured with a `TASK` retry policy, some relevant\\nconfiguration properties have their default values changed to follow best\\npractices for a fault-tolerant cluster. However, this automatic change does not\\naffect clusters that have these properties manually configured. If you have\\nany of the following properties configured in the `config.properties` file on\\na cluster with a `TASK` retry policy, it is strongly recommended to set the\\n`task.low-memory-killer.policy`\\n{doc}`query management property </admin/properties-query-management>` to\\n`total-reservation-on-blocked-nodes`, or queries may need to be manually killed\\nif the cluster runs out of memory.\\n\\n:::{note}\\nA `TASK` retry policy is best suited for large batch queries, but this\\npolicy can result in higher latency for short-running queries executed in high\\nvolume. As a best practice, it is recommended to run a dedicated cluster\\nwith a `TASK` retry policy for large batch queries, separate from another\\ncluster that handles short queries.\\n:::\\n\\n(fte-encryption)=\"}, \"Encryption\": \"Trino encrypts data before spooling it to storage. This prevents access to query\\ndata by anyone besides the Trino cluster that wrote it, including administrators\\nof the storage system. A new encryption key is randomly generated for every\\nquery, and the key is discarded once a query is completed.\", \"Advanced configuration\": {\"Retry limits\": \"The following configuration properties control the thresholds at which\\nqueries/tasks are no longer retried in the event of repeated failures:\\n\\n:::{list-table} Fault tolerance retry limit configuration properties\\n:widths: 30, 50, 20, 30\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value', 'Retry policy'], ['`query-retry-attempts`', 'Maximum number of times Trino may attempt to retry a query before declaring\\\\nthe query as failed.', '`4`', 'Only `QUERY`'], ['`task-retry-attempts-per-task`', 'Maximum number of times Trino may attempt to retry a single task before\\\\ndeclaring the query as failed.', '`4`', 'Only `TASK`'], ['`retry-initial-delay`', 'Minimum [time](prop-type-duration) that a failed query or task must wait\\\\nbefore it is retried. May be overridden with the `retry_initial_delay`\\\\n[session property](session-properties-definition).', '`10s`', '`QUERY` and `TASK`'], ['`retry-max-delay`', 'Maximum [time](prop-type-duration) that a failed query or task must\\\\nwait before it is retried. Wait time is increased on each subsequent\\\\nfailure. May be overridden with the ``retry_max_delay`` [session\\\\nproperty](session-properties-definition).', '`1m`', '`QUERY` and `TASK`'], ['`retry-delay-scale-factor`', 'Factor by which retry delay is increased on each query or task failure. May\\\\nbe overridden with the `retry_delay_scale_factor` [session\\\\nproperty](session-properties-definition).', '`2.0`', '`QUERY` and `TASK`\\\\n:::']]\", \"Task sizing\": \"With a `TASK` retry policy, it is important to manage the amount of data\\nprocessed in each task. If tasks are too small, the management of task\\ncoordination can take more processing time and resources than executing the task\\nitself. If tasks are too large, then a single task may require more resources\\nthan are available on any one node and therefore prevent the query from\\ncompleting.\\n\\nTrino supports limited automatic task sizing. If issues are occurring\\nduring fault-tolerant task execution, you can configure the following\\nconfiguration properties to manually control task sizing. These configuration\\nproperties only apply to a `TASK` retry policy.\\n\\n:::{list-table} Task sizing configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value'], ['`fault-tolerant-execution-standard-split-size`', 'Standard [split](trino-concept-splits) [data size]( prop-type-data-size)\\\\nprocessed by tasks that read data from source tables. Value is interpreted\\\\nwith split weight taken into account. If the weight of splits produced by a\\\\ncatalog denotes that they are lighter or heavier than \\\"standard\\\" split, then\\\\nthe number of splits processed by a single task is adjusted accordingly.', 'May be overridden for the current session with the\\\\n`fault_tolerant_execution_standard_split_size` [session\\\\nproperty](session-properties-definition).', '`64MB`'], ['`fault-tolerant-execution-max-task-split-count`', 'Maximum number of [splits](trino-concept-splits) processed by a single task.\\\\nThis value is not split weight-adjusted and serves as protection against\\\\nsituations where catalogs report an incorrect split weight.', 'May be overridden for the current session with the\\\\n`fault_tolerant_execution_max_task_split_count` [session\\\\nproperty](session-properties-definition).', '`2048`'], ['`fault-tolerant-execution-arbitrary-distribution-compute-task-target-size-growth-period`', 'The number of tasks created for any given non-writer stage of arbitrary\\\\ndistribution before task size is increased.', '`64`'], ['`fault-tolerant-execution-arbitrary-distribution-compute-task-target-size-growth-factor`', 'Growth factor for adaptive sizing of non-writer tasks of arbitrary\\\\ndistribution for fault-tolerant execution. Lower bound is 1.0. For every\\\\ntask size increase, new task target size is old task target size multiplied\\\\nby this growth factor.', '`1.26`'], ['`fault-tolerant-execution-arbitrary-distribution-compute-task-target-size-min`', 'Initial/minimum target input [data size](prop-type-data-size) for non-writer\\\\ntasks of arbitrary distribution of fault-tolerant execution.', '`512MB`'], ['`fault-tolerant-execution-arbitrary-distribution-compute-task-target-size-max`', 'Maximum target input [data size](prop-type-data-size) for each non-writer\\\\ntask of arbitrary distribution of fault-tolerant execution.', '`50GB`'], ['`fault-tolerant-execution-arbitrary-distribution-write-task-target-size-growth-period`', 'The number of tasks created for any given writer stage of arbitrary\\\\ndistribution before task size is increased.', '`64`'], ['`fault-tolerant-execution-arbitrary-distribution-write-task-target-size-growth-factor`', 'Growth factor for adaptive sizing of writer tasks of arbitrary distribution\\\\nfor fault-tolerant execution. Lower bound is 1.0. For every task size\\\\nincrease, new task target size is old task target size multiplied by this\\\\ngrowth factor.', '`1.26`'], ['`fault-tolerant-execution-arbitrary-distribution-write-task-target-size-min`', 'Initial/minimum target input [data size](prop-type-data-size) for writer\\\\ntasks of arbitrary distribution of fault-tolerant execution.', '`4GB`'], ['`fault-tolerant-execution-arbitrary-distribution-write-task-target-size-max`', 'Maximum target input [data size](prop-type-data-size) for writer tasks of\\\\narbitrary distribution of fault-tolerant execution.', '`50GB`'], ['`fault-tolerant-execution-hash-distribution-compute-task-target-size`', 'Target input [data size](prop-type-data-size) for non-writer tasks of hash\\\\ndistribution of fault-tolerant execution.', '`512MB`'], ['`fault-tolerant-execution-hash-distribution-write-task-target-size`', 'Target input [data size](prop-type-data-size) of writer tasks of hash\\\\ndistribution of fault-tolerant execution.', '``4GB``'], ['`fault-tolerant-execution-hash-distribution-write-task-target-max-count`', 'Soft upper bound on number of writer tasks in a stage of hash distribution\\\\nof fault-tolerant execution.', '`2000`\\\\n:::']]\", \"Node allocation\": \"With a `TASK` retry policy, nodes are allocated to tasks based on available\\nmemory and estimated memory usage. If task failure occurs due to exceeding\\navailable memory on a node, the task is restarted with a request to allocate the\\nfull node for its execution.\\n\\nThe initial task memory-requirements estimation is static and configured with\\nthe `fault-tolerant-execution-task-memory` configuration property. This property only\\napplies to a `TASK` retry policy.\\n\\n:::{list-table} Node allocation configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value'], ['`fault-tolerant-execution-task-memory`', 'Initial task memory [data size](prop-type-data-size) estimation\\\\nused for bin-packing when allocating nodes for tasks. May be overridden\\\\nfor the current session with the\\\\n`fault_tolerant_execution_task_memory`\\\\n[session property](session-properties-definition).', '`5GB`\\\\n:::']]\", \"Other tuning\": \"The following additional configuration property can be used to manage\\nfault-tolerant execution:\\n\\n:::{list-table} Other fault-tolerant execution configuration properties\\n:widths: 30, 50, 20, 30\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value', 'Retry policy'], ['`fault-tolerant-execution-task-descriptor-storage-max-memory`', 'Maximum [data size](prop-type-data-size) of memory to be used to\\\\nstore task descriptors for fault-tolerant queries on coordinator. Extra\\\\nmemory is needed to be able to reschedule tasks in case of a failure.', '(JVM heap size * 0.15)', 'Only `TASK`'], ['`fault-tolerant-execution-max-partition-count`', 'Maximum number of partitions to use for distributed joins and aggregations,\\\\nsimilar in function to the ``query.max-hash-partition-count`` [query\\\\nmanagement property](/admin/properties-query-management). It is not\\\\nrecommended to increase this property value higher than the default of `50`,\\\\nwhich may result in instability and poor performance. May be overridden for\\\\nthe current session with the `fault_tolerant_execution_max_partition_count`\\\\n[session property](session-properties-definition).', '`50`', 'Only `TASK`'], ['`fault-tolerant-execution-min-partition-count`', 'Minimum number of partitions to use for distributed joins and aggregations,\\\\nsimilar in function to the `query.min-hash-partition-count` [query\\\\nmanagement property](/admin/properties-query-management). May be overridden\\\\nfor the current session with the\\\\n`fault_tolerant_execution_min_partition_count` [session\\\\nproperty](session-properties-definition).', '`4`', 'Only `TASK`'], ['`fault-tolerant-execution-min-partition-count-for-write`', 'Minimum number of partitions to use for distributed joins and aggregations\\\\nin write queries, similar in function to the\\\\n`query.min-hash-partition-count-for-write` [query management\\\\nproperty](/admin/properties-query-management). May be overridden for the\\\\ncurrent session with the\\\\n`fault_tolerant_execution_min_partition_count_for_write` [session\\\\nproperty](session-properties-definition).', '`50`', 'Only `TASK`'], ['`max-tasks-waiting-for-node-per-query`', 'Allow for up to configured number of tasks to wait for node allocation\\\\nper query, before pausing scheduling for other tasks from this query.', '`50`', 'Only `TASK`\\\\n:::']]\\n\\n(fte-exchange-manager)=\"}, \"Exchange manager\": {\"Configuration\": {\"AWS S3\": \"The following example `exchange-manager.properties` configuration specifies an\\nAWS S3 bucket as the spooling storage destination. Note that the destination\\ndoes not have to be in AWS, but can be any S3-compatible storage system. While\\nthe exchange manager is designed to support S3-compatible storage systems, only\\nAWS S3 and MinIO are tested for compatibility. For other storage systems,\\nperform your own testing and consult your vendor for more information.\\n\\n```\\nexchange-manager.name=filesystem\\nexchange.base-directories=s3://exchange-spooling-bucket\\nexchange.s3.region=us-west-1\\nexchange.s3.aws-access-key=example-access-key\\nexchange.s3.aws-secret-key=example-secret-key\\n```\\n\\nYou can configure multiple S3 buckets for the exchange manager to distribute\\nspooled data across buckets, reducing the I/O load on any one bucket. If a query\\nfails with the error message\\n\\\"software.amazon.awssdk.services.s3.model.S3Exception: Please reduce your\\nrequest rate\\\", this indicates that the workload is I/O intensive, and you should\\nspecify multiple S3 buckets in `exchange.base-directories` to balance the\\nload:\\n\\n```\\nexchange.base-directories=s3://exchange-spooling-bucket-1,s3://exchange-spooling-bucket-2\\n```\\n\\n(fte-exchange-azure-blob)=\", \"Azure Blob Storage\": \"The following example `exchange-manager.properties` configuration specifies an\\nAzure Blob Storage container as the spooling storage destination. You must use\\nAzure Blob Storage, not Azure Data Lake Storage or any other hierarchical\\nstorage option in Azure.\\n\\n```\\nexchange-manager.name=filesystem\\nexchange.base-directories=abfs://container_name@account_name.dfs.core.windows.net\\nexchange.azure.connection-string=connection-string\\n```\\n\\n(fte-exchange-gcs)=\", \"Google Cloud Storage\": \"To enable exchange spooling on GCS in Trino, change the request endpoint to the\\n`https://storage.googleapis.com` Google storage URI, and configure your AWS\\naccess/secret keys to use the GCS HMAC keys. If you deploy Trino on GCP, you\\nmust either create a service account with access to your spooling bucket or\\nconfigure the key path to your GCS credential file.\\n\\nFor more information on GCS's S3 compatibility, refer to the [Google Cloud\\ndocumentation on S3 migration](https://cloud.google.com/storage/docs/aws-simple-migration).\\n\\nThe following example `exchange-manager.properties` configuration specifies a\\nGCS bucket as the spooling storage destination.\\n\\n```\\nexchange-manager.name=filesystem\\nexchange.base-directories=gs://exchange-spooling-bucket\\nexchange.s3.region=us-west-1\\nexchange.s3.aws-access-key=example-access-key\\nexchange.s3.aws-secret-key=example-secret-key\\nexchange.s3.endpoint=https://storage.googleapis.com\\nexchange.gcs.json-key-file-path=/path/to/gcs_keyfile.json\\n```\\n\\n(fte-exchange-hdfs)=\", \"HDFS\": \"The following `exchange-manager.properties` configuration example specifies HDFS\\nas the spooling storage destination.\\n\\n```\\nexchange-manager.name=hdfs\\nexchange.base-directories=hadoop-master:9000/exchange-spooling-directory\\nhdfs.config.resources=/usr/lib/hadoop/etc/hadoop/core-site.xml\\n```\\n\\nWhen you want use Hadoop-compatible file system as the spooling storage location, \\nyou should enable `exchange.hdfs.skip-directory-scheme-validation` in `exchange-manager.properties` \\nwhen configure `exchange.base-directories` with a specific scheme instead of `hdfs` and the following steps \\nmay be necessary.\\n\\n['Configure the `AbstractFileSystem` implementation in `core-site.xml`.', 'Add the relevant client JAR files into the directory `${Trino_HOME}/plugin/exchange-hdfs` \\\\non all Trino cluster nodes.']\\n\\n(fte-exchange-local-filesystem)=\", \"Local filesystem storage\": \"The following example `exchange-manager.properties` configuration specifies a\\nlocal directory, `/tmp/trino-exchange-manager`, as the spooling storage\\ndestination.\\n\\n:::{note}\\nIt is only recommended to use a local filesystem for exchange in standalone,\\nnon-production clusters. A local directory can only be used for exchange in\\na distributed cluster if the exchange directory is shared and accessible\\nfrom all nodes.\\n:::\\n\\n```\\nexchange-manager.name=filesystem\\nexchange.base-directories=/tmp/trino-exchange-manager\\n```\"}}, \"Adaptive plan optimizations\": \"Fault-tolerant execution mode offers several adaptive plan \\noptimizations that adjust query execution plans dynamically based on \\nruntime statistics. For more information, see \\n[](/optimizer/adaptive-plan-optimizations).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 6]\"}, {\"title\": \"Graceful shutdown\", \"description\": null, \"content\": {\"Shutdown behavior\": \"Once the API is called, the worker performs the following steps:\\n\\n['Go into `SHUTTING_DOWN` state.', 'Sleep for `shutdown.grace-period`, which defaults to 2 minutes.\\\\n: - After this, the coordinator is aware of the shutdown and stops sending\\\\ntasks to the worker.', 'Block until all active tasks are complete.', 'Sleep for the grace period again in order to ensure the coordinator sees\\\\nall tasks are complete.', 'Shutdown the application.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 7]\"}, {\"title\": \"Monitoring with JMX\", \"description\": null, \"content\": {\"JVM\": [\"Heap size: `java.lang:type=Memory:HeapMemoryUsage.used`\", \"Thread count: `java.lang:type=Threading:ThreadCount`\"], \"Trino cluster and nodes\": [\"Active nodes:\\n`trino.failuredetector:name=HeartbeatFailureDetector:ActiveCount`\", \"Free memory (general pool):\\n`trino.memory:type=ClusterMemoryPool:name=general:FreeDistributedBytes`\", \"Cumulative count (since Trino started) of queries that ran out of memory and were killed:\\n`trino.memory:name=ClusterMemoryManager:QueriesKilledDueToOutOfMemory`\"], \"Trino queries\": [\"Active queries currently executing or queued: `trino.execution:name=QueryManager:RunningQueries`\", \"Queries started: `trino.execution:name=QueryManager:StartedQueries.FiveMinute.Count`\", \"Failed queries from last 5 min (all): `trino.execution:name=QueryManager:FailedQueries.FiveMinute.Count`\", \"Failed queries from last 5 min (internal): `trino.execution:name=QueryManager:InternalFailures.FiveMinute.Count`\", \"Failed queries from last 5 min (external): `trino.execution:name=QueryManager:ExternalFailures.FiveMinute.Count`\", \"Failed queries (user): `trino.execution:name=QueryManager:UserErrorFailures.FiveMinute.Count`\", \"Execution latency (P50): `trino.execution:name=QueryManager:ExecutionTime.FiveMinutes.P50`\", \"Input data rate (P90): `trino.execution:name=QueryManager:WallInputBytesRate.FiveMinutes.P90`\"], \"Trino tasks\": [\"Input data bytes: `trino.execution:name=SqlTaskManager:InputDataSize.FiveMinute.Count`\", \"Input rows: `trino.execution:name=SqlTaskManager:InputPositions.FiveMinute.Count`\"], \"Connectors\": \"Many connectors provide their own metrics. The metric names typically start with\\n`trino.plugin`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 8]\"}, {\"title\": \"Logging\", \"description\": null, \"content\": {\"Configuration\": \"Trino application logging is optional and configured in the `log.properties`\\nfile in your Trino installation `etc` configuration directory as set by the\\n[launcher](running-trino).\\n\\nUse it to add specific loggers and configure the minimum log levels. Every\\nlogger has a name, which is typically the fully qualified name of the class that\\nuses the logger. Loggers have a hierarchy based on the dots in the name, like\\nJava packages. The four log levels are `DEBUG`, `INFO`, `WARN` and `ERROR`,\\nsorted by decreasing verbosity.\\n\\nFor example, consider the following log levels file:\\n\\n```\\nio.trino=WARN\\nio.trino.plugin.iceberg=DEBUG\\nio.trino.parquet=DEBUG\\n```\\n\\nThe preceding configuration sets the changes the level for all loggers in the\\n`io.trino` namespace to `WARN` as an update from the default `INFO` to make\\nlogging less verbose. The example also increases logging verbosity for the\\nIceberg connector using the `io.trino.plugin.iceberg` namespace, and the Parquet\\nfile reader and writer support located in the `io.trino.parquet` namespace to\\n`DEBUG` for troubleshooting purposes. \\n\\nAdditional loggers can include other package namespaces from libraries and\\ndependencies embedded within Trino or part of the Java runtime, for example:\\n\\n['`io.airlift` for the [Airlift](https://github.com/airlift/airlift) application\\\\nframework used by Trino.', '`org.eclipse.jetty` for the [Eclipse Jetty](https://jetty.org/) web server\\\\nused by Trino.', '`org.postgresql` for the [PostgresSQL JDBC driver](https://github.com/pgjdbc)\\\\nused by the PostgreSQL connector.', '`javax.net.ssl` for TLS from the Java runtime.', '`java.io` for I/O operations.']\\n\\nThere are numerous additional properties available to customize logging in\\n[](config-properties), with details documented in [](/admin/properties-logging)\\nand in following example sections.\", \"Log output\": \"By default, logging output is file-based with rotated files in `var/log`:\\n\\n['`launcher.log` for logging out put from the application startup from the\\\\n[launcher](running-trino). Only used if the launcher starts Trino in the\\\\nbackground, and therefore not used in the Trino container.', '`http-request.log` for HTTP request logs, mostly from the [client\\\\nprotocol](/client/client-protocol) and the [Web UI](/admin/web-interface).', '`server.log` for the main application log of Trino, including logging from all\\\\nplugins.']\", \"JSON and TCP channel logging\": \"Trino supports logging to JSON-formatted output files with the configuration\\n`log.format=json`. Optionally you can set `node.annotations-file` as path to a\\nproperties file such as the following example:\\n\\n```\\nhost_ip=1.2.3.4\\nservice_name=trino\\nnode_name=${ENV:MY_NODE_NAME}\\npod_name=${ENV:MY_POD_NAME}\\npod_namespace=${ENV:MY_POD_NAMESPACE}\\n```\\n\\nThe annotations file supports environment variable substitution, so that the\\nabove example attaches the name of the Trino node as `pod_name` and other\\ninformation to every log line. When running Trino on Kubernetes, you have access\\nto [a lot of information to use in the\\nlog](https://kubernetes.io/docs/tasks/inject-data-application/environment-variable-expose-pod-information/).\\n\\nTCP logging allows you to log to a TCP socket instead of a file with the\\nconfiguration `log.path=tcp://<server_ip>:<server_port>`. The endpoint must be\\navailable at the URL configured with `server_ip` and `server_port` and is\\nassumed to be stable.\\n\\nYou can use an application such as [fluentbit](https://fluentbit.io/) as a\\nconsumer for these JSON-formatted logs. \\n\\nExample fluentbit configuration file `config.yaml`:\\n\\n```\\npipeline:\\n inputs:\\n - name: tcp\\n tag: trino\\n listen: 0.0.0.0\\n port: 5170\\n buffer_size: 2048\\n format: json\\n outputs:\\n - name: stdout\\n match: '*'\\n```\\n\\nStart the application with the command:\\n\\n```\\nfluent-bit -c config.yaml\\n```\\n\\nUse the following Trino properties configuration:\\n\\n```\\nlog.path=tcp://localhost:5170\\nlog.format=json\\nnode.annotation-file=etc/annotations.properties\\n```\\n\\nFile `etc/annotation.properties`:\\n\\n```\\nhost_ip=1.2.3.4\\nservice_name=trino\\npod_name=${ENV:HOSTNAME}\\n```\\n\\nAs a result, Trino logs appear as structured JSON log lines in fluentbit in the\\nuser interface, and can also be [forwarded into a configured logging\\nsystem](https://docs.fluentbit.io/manual/pipeline/outputs).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 9]\"}, {\"title\": \"Trino metrics with OpenMetrics\", \"description\": null, \"content\": {\"Examples\": {\"Simple example with Docker and Prometheus\": \"The following steps provide a simple demo setup to run\\n[Prometheus](https://prometheus.io/) and Trino locally in Docker containers.\\n\\nCreate a shared network for both servers called `platform`:\\n\\n```\\ndocker network create platform\\n```\\n\\nStart Trino in the background:\\n\\n```\\ndocker run -d \\\\\\n --name=trino \\\\\\n --network=platform \\\\\\n --network-alias=trino \\\\\\n -p 8080:8080 \\\\\\n trinodb/trino:latest\\n```\\n\\nThe preceding command starts Trino and adds it to the `platform` network with\\nthe hostname `trino`. \\n\\nCreate a `prometheus.yml` configuration file with the following content, that\\npoint Prometheus at the `trino` hostname:\\n\\n```\\nscrape_configs:\\n- job_name: trino\\n basic_auth:\\n username: trino-user\\n static_configs:\\n - targets:\\n - trino:8080\\n```\\n\\nStart Prometheus from the same directory as the configuration file:\\n\\n```\\ndocker run -d \\\\\\n --name=prometheus \\\\\\n --network=platform \\\\\\n -p 9090:9090 \\\\\\n --mount type=bind,source=$PWD/prometheus.yml,target=/etc/prometheus/prometheus.yml \\\\\\n prom/prometheus\\n```\\n\\nThe preceding command adds Prometheus to the `platform` network. It also mounts\\nthe configuration file into the container so that metrics from Trino are\\ngathered by Prometheus.\\n\\nNow everything is running.\\n\\nInstall and run the [Trino CLI](/client/cli) or any other client application and\\nsubmit a query such as `SHOW CATALOGS;` or `SELECT * FROM tpch.tiny.nation;`.\\n\\nOptionally, log into the [Trino Web UI](/admin/web-interface) at\\n[http://localhost:8080](http://localhost:8080) with a random username. Press\\nthe **Finished** button and inspect the details for the completed queries.\\n\\nAccess the Prometheus UI at [http://localhost:9090/](http://localhost:9090/),\\nselect **Status** > **Targets** and see the configured endpoint for Trino\\nmetrics.\\n\\nTo see an example graph, select **Graph**, add the metric name\\n`trino_execution_name_QueryManager_RunningQueries` in the input field and press\\n**Execute**. Press **Table** for the raw data or **Graph** for a visualization.\\n\\nAs a next step, run more queries and inspect the effect on the metrics.\\n\\nOnce you are done you can stop the containers:\\n\\n```\\ndocker stop prometheus\\ndocker stop trino\\n```\\n\\nYou can start them again for further testing:\\n\\n```\\ndocker start trino\\ndocker start prometheus\\n```\\n\\nUse the following commands to completely remove the network and containers:\\n\\n```\\ndocker rm trino\\ndocker rm prometheus\\ndocker network rm platform\\n```\"}, \"Coordinator and worker metrics with Kubernetes\": \"To get a complete picture of the metrics on your cluster, you must access the\\ncoordinator and the worker metrics. This section details tips for setting up for\\nthis scenario with the [Trino Helm chart](https://github.com/trinodb/charts) on\\nKubernetes.\\n\\nAdd an annotation to flag all cluster nodes for scraping in your values for the\\nTrino Helm chart:\\n\\n```\\ncoordinator:\\n annotations:\\n prometheus.io/trino_scrape: \\\"true\\\"\\nworker:\\n annotations:\\n prometheus.io/trino_scrape: \\\"true\\\"\\n```\\n\\nConfigure metrics retrieval from the workers in your Prometheus configuration:\\n\\n```\\n - job_name: trino-metrics-worker\\n scrape_interval: 10s\\n scrape_timeout: 10s\\n kubernetes_sd_configs:\\n - role: pod\\n relabel_configs:\\n - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_trino_scrape]\\n action: keep # scrape only pods with the trino scrape anotation\\n regex: true\\n - source_labels: [__meta_kubernetes_pod_container_name]\\n action: keep # dont try to scrape non trino container\\n regex: trino-worker\\n - action: hashmod\\n modulus: $(SHARDS)\\n source_labels:\\n - __address__\\n target_label: __tmp_hash\\n - action: keep\\n regex: $(SHARD)\\n source_labels:\\n - __tmp_hash\\n - source_labels: [__meta_kubernetes_pod_name]\\n action: replace\\n target_label: pod\\n - source_labels: [__meta_kubernetes_pod_container_name]\\n action: replace\\n target_label: container\\n metric_relabel_configs:\\n - source_labels: [__name__]\\n regex: \\\".+_FifteenMinute.+|.+_FiveMinute.+|.+IterativeOptimizer.+|.*io_airlift_http_client_type_HttpClient.+\\\"\\n action: drop # droping some highly granular metrics \\n - source_labels: [__meta_kubernetes_pod_name]\\n regex: \\\".+\\\"\\n target_label: pod\\n action: replace \\n - source_labels: [__meta_kubernetes_pod_container_name]\\n regex: \\\".+\\\"\\n target_label: container\\n action: replace \\n \\n scheme: http\\n tls_config:\\n insecure_skip_verify: true\\n basic_auth:\\n username: myuser # replace with a username that has system information permission\\n # DO NOT ADD PASSWORD\\n```\\n\\nThe worker authentication uses a user with access to the system information, yet\\ndoes not add a password and uses access via HTTP.\\n\\nConfigure metrics retrieval from the coordinator in your Prometheus\\nconfiguration:\\n\\n```\\n - job_name: trino-metrics-coordinator\\n scrape_interval: 10s\\n scrape_timeout: 10s\\n kubernetes_sd_configs:\\n - role: pod\\n relabel_configs:\\n - source_labels: [__meta_kubernetes_pod_annotation_prometheus_io_trino_scrape]\\n action: keep # scrape only pods with the trino scrape anotation\\n regex: true\\n - source_labels: [__meta_kubernetes_pod_container_name]\\n action: keep # dont try to scrape non trino container\\n regex: trino-coordinator\\n - action: hashmod\\n modulus: $(SHARDS)\\n source_labels:\\n - __address__\\n target_label: __tmp_hash\\n - action: keep\\n regex: $(SHARD)\\n source_labels:\\n - __tmp_hash\\n - source_labels: [__meta_kubernetes_pod_name]\\n action: replace\\n target_label: pod\\n - source_labels: [__meta_kubernetes_pod_container_name]\\n action: replace\\n target_label: container\\n - action: replace # overide the address to the https ingress address \\n target_label: __address__\\n replacement: {{ .Values.trinourl }} \\n metric_relabel_configs:\\n - source_labels: [__name__]\\n regex: \\\".+_FifteenMinute.+|.+_FiveMinute.+|.+IterativeOptimizer.+|.*io_airlift_http_client_type_HttpClient.+\\\"\\n action: drop # droping some highly granular metrics \\n - source_labels: [__meta_kubernetes_pod_name]\\n regex: \\\".+\\\"\\n target_label: pod\\n action: replace \\n - source_labels: [__meta_kubernetes_pod_container_name]\\n regex: \\\".+\\\"\\n target_label: container\\n action: replace \\n \\n scheme: https\\n tls_config:\\n insecure_skip_verify: true\\n basic_auth:\\n username: myuser # replace with a username that has system information permission\\n password_file: /some/password/file\\n```\\n\\nThe coordinator authentication uses a user with access to the system information\\nand requires authentication and access via HTTPS.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 10]\"}, {\"title\": \"Observability with OpenTelemetry\", \"description\": null, \"content\": {\"Configuration\": \"Use tracing with OpenTelemetry by enabling it and configuring the endpoint in\\nthe [config.properties file](config-properties):\\n\\n```\\ntracing.enabled=true\\ntracing.exporter.endpoint=http://observe.example.com:4317\\n```\\n\\nTracing is not enabled by default. The exporter endpoint must specify a URL that\\nis accessible from the coordinator and all workers of the cluster. The preceding\\nexample uses a observability platform deployment available by\\nHTTP at the host `observe.example.com`, port `4317`.\\n\\nUse the `tracing.exporter.protocol` property to configure the protocol for exporting traces. \\nDefaults to the gRPC protocol with the `grpc` value. Set the value to `http/protobuf` for \\nexporting traces using protocol buffers with HTTP transport.\", \"Example use\": \"The following steps provide a simple demo setup to run the open source\\nobservability platform [Jaeger](https://www.jaegertracing.io/) and Trino locally\\nin Docker containers.\\n\\nCreate a shared network for both servers called `platform`:\\n\\n```\\ndocker network create platform\\n```\\n\\nStart Jaeger in the background:\\n\\n```\\ndocker run -d \\\\\\n --name jaeger \\\\\\n --network=platform \\\\\\n --network-alias=jaeger \\\\\\n -e COLLECTOR_OTLP_ENABLED=true \\\\\\n -p 16686:16686 \\\\\\n -p 4317:4317 \\\\\\n jaegertracing/all-in-one:latest\\n```\\n\\nThe preceding command adds Jaeger to the `platform` network with the hostname\\n`jaeger`. It also maps the endpoint and Jaeger UI ports.\\n\\nCreate a `config.properties` file that uses the default setup from the Trino\\ncontainer, and adds the tracing configuration with the `jaeger` hostname:\\n\\n```\\nnode-scheduler.include-coordinator=true\\nhttp-server.http.port=8080\\ndiscovery.uri=http://localhost:8080\\ntracing.enabled=true\\ntracing.exporter.endpoint=http://jaeger:4317\\n```\\n\\nStart Trino in the background:\\n\\n```\\ndocker run -d \\\\\\n --name trino \\\\\\n --network=platform \\\\\\n -p 8080:8080 \\\\\\n --mount type=bind,source=$PWD/config.properties,target=/etc/trino/config.properties \\\\\\n trinodb/trino:latest\\n```\\n\\nThe preceding command adds Trino to the `platform` network. It also mounts the\\nconfiguration file into the container so that tracing is enabled.\\n\\nNow everything is running.\\n\\nInstall and run the [Trino CLI](/client/cli) or any other client application and\\nsubmit a query such as `SHOW CATALOGS;` or `SELECT * FROM tpch.tiny.nation;`.\\n\\nOptionally, log into the [Trino Web UI](/admin/web-interface) at\\n[http://localhost:8080](http://localhost:8080) with a random username. Press\\nthe **Finished** button and inspect the details for the completed queries.\\n\\nAccess the Jaeger UI at [http://localhost:16686/](http://localhost:16686/),\\nselect the service `trino`, and press **Find traces**.\\n\\nAs a next step, run more queries and inspect more traces with the Jaeger UI.\\n\\nOnce you are done you can stop the containers:\\n\\n```\\ndocker stop trino\\ndocker stop jaeger\\n```\\n\\nYou can start them again for further testing:\\n\\n```\\ndocker start jaeger\\ndocker start trino\\n```\\n\\nUse the following commands to completely remove the network and containers:\\n\\n```\\ndocker rm trino\\ndocker rm jaeger\\ndocker network rm platform\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 11]\"}, {\"title\": \"Preview Web UI\", \"description\": null, \"content\": {\"Activation\": \"The Preview Web UI is not available by default, and must be enabled in\\n[](config-properties) with the following configuration:\\n\\n```\\nweb-ui.preview.enabled=true\\n```\", \"Access\": \"Once activated, users can access the interface in the URL context `/ui/preview`\\nafter successful login to the [](/admin/web-interface). For example, the full\\nURL on a locally running Trino installation or Trino docker container without\\nTLS configuration is [http://localhost:8080/ui/preview](http://localhost:8080/ui/preview).\", \"Authentication\": {\"Password authentication\": \"Typically, a password-based authentication method such as [LDAP](/security/ldap)\\nor [password file](/security/password-file) is used to secure both the Trino\\nserver and the Web UI. When the Trino server is configured to use a password\\nauthenticator, the Web UI authentication type is automatically set to `FORM`. In\\nthis case, the Web UI displays a login form that accepts a username and\\npassword. \", \"Fixed user authentication\": \"If you require the Preview Web UI to be accessible without authentication, you\\ncan set a fixed username that will be used for all Web UI access by setting the\\nauthentication type to `FIXED` and setting the username with the `web-ui.user`\\nconfiguration property. If there is a system access control installed, this user\\nmust have permission to view ,and possibly to kill, queries.\", \"Other authentication types\": \"The following Preview Web UI authentication types are also supported:\\n\\n['`CERTIFICATE`, see details in [](/security/certificate)', '`KERBEROS`, see details in [](/security/kerberos)', '`JWT`, see details in [](/security/jwt)', '`OAUTH2`, see details in [](/security/oauth2)']\\n\\nFor these authentication types, the username is defined by\\n[](/security/user-mapping).\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 12]\"}, {\"title\": \"Catalog management properties\", \"description\": null, \"content\": {\"`catalog.management`\": [\"**Type:** [](prop-type-string)\", \"**Allowed values:** `static`, `dynamic`\", \"**Default value:** `static`\"], \"`catalog.prune.update-interval`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `5s`\", \"**Minimum value:** `1s`\"], \"`catalog.store`\": [\"**Type:** [](prop-type-string)\", \"**Allowed values:** `file`, `memory`\", \"**Default value:** `file`\"], \"`catalog.config-dir`\": [\"**Type:** [](prop-type-string)\", \"**Default value:** `etc/catalog/`\"], \"`catalog.disabled-catalogs`\": [\"**Type:** [](prop-type-string)\"], \"`catalog.read-only`\": [\"**Type:** [](prop-type-string)\", \"**Default value:** `false`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 13]\"}, {\"title\": \"Client protocol properties\", \"description\": null, \"content\": {\"Spooling protocol properties\": {\"`protocol.spooling.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\", \"**Session property:** `spooling_enabled`\"], \"`protocol.spooling.shared-secret-key`\": [\"**Type:** [](prop-type-string)\"], \"`protocol.spooling.retrieval-mode`\": [\"**Type:** [](prop-type-string)\", \"**Default value:** `STORAGE`\"], \"`protocol.spooling.encoding.json.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`protocol.spooling.encoding.json+zstd.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`protocol.spooling.encoding.json+lz4.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`protocol.spooling.encoding.compression.threshold`\": [\"**Type:** [](prop-type-data-size)\", \"**Default value:** `8KB`\", \"**Minimum value:** `1KB`\", \"**Maximum value:** `4MB`\"], \"`protocol.spooling.initial-segment-size`\": [\"**Type:** [](prop-type-data-size)\", \"**Default value:** `8MB`\", \"**Minimum value:** `1KB`\", \"**Maximum value:** `128MB`\", \"**Session property:** `spooling_initial_segment_size`\"], \"`protocol.spooling.max-segment-size`\": [\"**Type:** [](prop-type-data-size)\", \"**Default value:** `16MB`\", \"**Minimum value:** `1KB`\", \"**Maximum value:** `128MB`\", \"**Session property:** `spooling_max_segment_size`\"], \"`protocol.spooling.inlining.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\", \"**Session property:** `spooling_inlining_enabled`\"], \"`protocol.spooling.inlining.max-rows`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `1000`\", \"**Minimum value:** `1`\", \"**Maximum value:** `1000000`\", \"**Session property:** `spooling_inlining_max_rows`\"], \"`protocol.spooling.inlining.max-size`\": [\"**Type:** [](prop-type-data-size)\", \"**Default value:** `128kB`\", \"**Minimum value:** `1KB`\", \"**Maximum value:** `1MB`\", \"**Session property:** `spooling_inlining_max_size`\"]}, \"Spooling file system properties\": {\"`fs.azure.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`fs.s3.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`fs.gcs.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`fs.location`\": [\"**Type:** [](prop-type-string)\"], \"`fs.segment.ttl`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `12h`\"], \"`fs.segment.direct.ttl`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `1h`\"], \"`fs.segment.encryption`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`fs.segment.explicit-ack`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`fs.segment.pruning.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`fs.segment.pruning.interval`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `5m`\"], \"`fs.segment.pruning.batch-size`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `250`\"]}, \"Shared protocol properties\": {\"`protocol.v1.prepared-statement-compression.length-threshold`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `2048`\"], \"`protocol.v1.prepared-statement-compression.min-gain`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `512`\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 14]\"}, {\"title\": \"Exchange properties\", \"description\": null, \"content\": {\"`exchange.client-threads`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default value:** `25`\"], \"`exchange.concurrent-request-multiplier`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default value:** `3`\"], \"`exchange.compression-codec`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `NONE`, `LZ4`, `ZSTD`\", \"**Default value:** `NONE`\"], \"`exchange.data-integrity-verification`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `NONE`, `ABORT`, `RETRY`\", \"**Default value:** `ABORT`\"], \"`exchange.max-buffer-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `32MB`\"], \"`exchange.max-response-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Minimum value:** `1MB`\", \"**Default value:** `16MB`\"], \"`sink.max-buffer-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `32MB`\"], \"`sink.max-broadcast-buffer-size`\": [\"**Type** `data size`\", \"**Default value:** `200MB`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 15]\"}, {\"title\": \"General properties\", \"description\": null, \"content\": {\"`join-distribution-type`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `AUTOMATIC`, `PARTITIONED`, `BROADCAST`\", \"**Default value:** `AUTOMATIC`\", \"**Session property:** `join_distribution_type`\"], \"`redistribute-writes`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `redistribute_writes`\"], \"File compression and decompression\": \"Trino uses the [aircompressor](https://github.com/airlift/aircompressor) library\\nto compress and decompress ORC, Parquet, and other files using the LZ4, zstd,\\nSnappy, and other algorithms. The library takes advantage of using embedded,\\nhigher performing, native implementations for these algorithms by default. \\n\\nIf necessary, this behavior can be deactivated to fall back on JVM-based\\nimplementations with the following configuration in the [](jvm-config):\\n\\n```\\n-Dio.airlift.compress.v3.disable-native=true\\n```\\n\\nThe library relies on the [temporary directory used by the JVM](tmp-directory),\\nincluding the execution of code in the directory, to load the embedded shared\\nlibraries. If this directory is mounted with `noexec`, and therefore not\\nsuitable, you can configure usage of a separate directory with an absolute path\\nset with the following configuration in the [](jvm-config):\\n\\n```\\n-Daircompressor.tmpdir=/mnt/example\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 16]\"}, {\"title\": \"HTTP client properties\", \"description\": null, \"content\": {\"General properties\": {\"`http-client.connect-timeout`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `5s`\", \"**Minimum value:** `0ms`\"], \"`max-content-length`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `16MB`\"], \"`http-client.request-timeout`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `5m`\", \"**Minimum value:** `0ms`\"]}, \"TLS and security properties\": {\"`http-client.https.excluded-cipher`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.https.included-cipher`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.https.hostname-verification`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`http-client.key-store-password`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.key-store-path`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.secure-random-algorithm`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.trust-store-password`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.trust-store-path`\": [\"**Type:** [](prop-type-string)\"]}, \"Proxy properties\": {\"`http-client.http-proxy`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.http-proxy.user`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.http-proxy.password`\": [\"**Type:** [](prop-type-string)\"], \"`http-client.http-proxy.secure`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`http-client.socks-proxy`\": [\"**Type:** [](prop-type-string)\"]}, \"Request logging\": {\"`http-client.log.compression.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`http-client.log.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`http-client.log.flush-interval`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `10s`\"], \"`http-client.log.max-history`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `15`\"], \"`http-client.log.max-size`\": [\"**Type:** [](prop-type-data-size)\", \"**Default value:** `1GB`\"], \"`http-client.log.path`\": [\"**Type:** [](prop-type-string)\", \"**Default value:** `var/log/`\"], \"`http-client.log.queue-size`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `10000`\", \"**Minimum value:** `1`\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 17]\"}, {\"title\": \"HTTP server properties\", \"description\": null, \"content\": {\"General\": {\"`http-server.process-forwarded`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"]}, \"HTTP and HTTPS\": {\"`http-server.http.port`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `8080`\"], \"`http-server.https.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`http-server.https.port`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `8443`\"], \"`http-server.https.included-cipher` and `http-server.https.excluded-cipher`\": \"Optional configuration for ciphers to use TLS, find details in\\n[](tls-version-and-ciphers).\", \"`http-server.https.keystore.path`\": [\"**Type:** [](prop-type-string)\"], \"`http-server.https.keystore.key`\": [\"**Type:** [](prop-type-string)\"], \"`http-server.https.truststore.path`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`http-server.https.truststore.key`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"], \"`http-server.https.keymanager.password`\": [\"**Type:** [](prop-type-string)\"], \"`http-server.https.secure-random-algorithm`\": [\"**Type:** [](prop-type-string)\"], \"`http-server.https.ssl-session-timeout`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `4h`\"], \"`http-server.https.ssl-session-cache-size`\": [\"**Type:** [](prop-type-integer)\", \"**Default value:** `10000`\"], \"`http-server.https.ssl-context.refresh-time`\": [\"**Type:** [](prop-type-duration)\", \"**Default value:** `1m`\"]}, \"Authentication\": {\"`http-server.authentication.type`\": [\"**Type:** [](prop-type-string)\"], \"`http-server.authentication.allow-insecure-over-http`\": [\"**Type:** [](prop-type-boolean)\"], \"`http-server.authentication.certificate.*`\": \"Configuration properties for [](/security/certificate).\", \"`http-server.authentication.jwt.*`\": \"Configuration properties for [](/security/jwt).\", \"`http-server.authentication.krb5.*`\": \"Configuration properties for [](/security/kerberos).\", \"`http-server.authentication.oauth2.*`\": \"Configuration properties for [](/security/oauth2).\", \"`http-server.authentication.password.*`\": \"Configuration properties for the `PASSWORD` authentication types\\n[](/security/ldap), [](/security/password-file), and [](/security/salesforce).\"}, \"Logging\": {\"`http-server.log.*`\": \"Configuration properties for [](/admin/properties-logging).\\n\\n(props-internal-communication)\"}, \"Internal communication\": {\"`internal-communication.shared-secret`\": [\"**Type:** [](prop-type-string)\"], \"`internal-communication.http2.enabled`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `true`\"], \"`internal-communication.https.required`\": [\"**Type:** [](prop-type-boolean)\", \"**Default value:** `false`\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 18]\"}, {\"title\": \"Logging properties\", \"description\": null, \"content\": {\"`log.annotation-file`\": [\"**Type:** {ref}`prop-type-string`\"], \"`log.format`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `TEXT`\"], \"`log.console-format`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `TEXT`\"], \"`log.path`\": [\"**Type:** {ref}`prop-type-string`\"], \"`log.max-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `100MB`\"], \"`log.max-total-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `1GB`\"], \"`log.compression`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `GZIP`\"], \"`http-server.log.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\"], \"`http-server.log.compression.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\"], \"`http-server.log.path`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `var/log/http-request.log`\"], \"`http-server.log.max-history`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `15`\"], \"`http-server.log.max-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `unlimited`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 19]\"}, {\"title\": \"Node scheduler properties\", \"description\": null, \"content\": {\"`node-scheduler.include-coordinator`\": {\"Splits\": \"\"}, \"`node-scheduler.max-splits-per-node`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `256`\"], \"`node-scheduler.min-pending-splits-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `16`\"], \"`node-scheduler.max-adjusted-pending-splits-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `2000`\"], \"`node-scheduler.max-unacknowledged-splits-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `2000`\"], \"`node-scheduler.min-candidates`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default value:** `10`\"], \"`node-scheduler.policy`\": {\"Network topology\": \"\"}, \"`node-scheduler.network-topology.segments`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `machine`\"], \"`node-scheduler.network-topology.type`\": {\"File based network topology\": \"\"}, \"`node-scheduler.network-topology.file`\": [\"**Type:** {ref}`prop-type-string`\"], \"`node-scheduler.network-topology.refresh-period`\": {\"Subnet based network topology\": \"\"}, \"`node-scheduler.network-topology.subnet.ip-address-protocol`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `IPv4`, `IPv6`\", \"**Default value:** `IPv4`\"], \"`node-scheduler.network-topology.subnet.cidr-prefix-lengths`\": \"A comma-separated list of {ref}`prop-type-integer` values defining CIDR prefix\\nlengths for subnet masks. The prefix lengths must be in increasing order. The\\nmaximum prefix length values for IPv4 and IPv6 protocols are 32 and 128\\nrespectively. To use this option, `node-scheduler.network-topology.type` must\\nbe set to `subnet`.\\n\\nFor example, the value `24,25,27` for this property with IPv4 protocol means\\nthat masks applied on the IP address to compute location segments are\\n`255.255.255.0`, `255.255.255.128` and `255.255.255.224`. So the segments\\ncreated for an address `192.168.0.172` are `[192.168.0.0, 192.168.0.128,\\n192.168.0.160, 192.168.0.172]`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 20]\"}, {\"title\": \"Optimizer properties\", \"description\": null, \"content\": {\"`optimizer.dictionary-aggregation`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\", \"**Session property:** `dictionary_aggregation`\"], \"`optimizer.optimize-metadata-queries`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\", \"**Session property:** `optimize_metadata_queries`\"], \"`optimizer.distinct-aggregations-strategy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `AUTOMATIC`, `MARK_DISTINCT`, `SINGLE_STEP`, `PRE_AGGREGATE`, `SPLIT_TO_SUBQUERIES`\", \"**Default value:** `AUTOMATIC`\", \"**Session property:** `distinct_aggregations_strategy`\"], \"`optimizer.push-aggregation-through-outer-join`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `push_aggregation_through_outer_join`\"], \"`optimizer.push-table-write-through-union`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `push_table_write_through_union`\"], \"`optimizer.push-filter-into-values-max-row-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `100`\", \"**Minimum value:** `0`\", \"**Session property:** `push_filter_into_values_max_row_count`\"], \"`optimizer.join-reordering-strategy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `AUTOMATIC`, `ELIMINATE_CROSS_JOINS`, `NONE`\", \"**Default value:** `AUTOMATIC`\", \"**Session property:** `join_reordering_strategy`\"], \"`optimizer.max-reordered-joins`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `8`\", \"**Session property:** `max_reordered_joins`\"], \"`optimizer.optimize-duplicate-insensitive-joins`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `optimize_duplicate_insensitive_joins`\"], \"`optimizer.use-exact-partitioning`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\", \"**Session property:** `use_exact_partitioning` \"], \"`optimizer.use-table-scan-node-partitioning`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `use_table_scan_node_partitioning`\"], \"`optimizer.table-scan-node-partitioning-min-bucket-to-task-ratio`\": [\"**Type:** {ref}`prop-type-double`\", \"**Default value:** `0.5`\", \"**Session property:** `table_scan_node_partitioning_min_bucket_to_task_ratio`\"], \"`optimizer.colocated-joins-enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `colocated_join`\"], \"`optimizer.filter-conjunction-independence-factor`\": [\"**Type:** {ref}`prop-type-double`\", \"**Default value:** `0.75`\", \"**Min allowed value:** `0`\", \"**Max allowed value:** `1`\", \"**Session property:** `filter_conjunction_independence_factor`\"], \"`optimizer.join-multi-clause-independence-factor`\": [\"**Type:** {ref}`prop-type-double`\", \"**Default value:** `0.25`\", \"**Min allowed value:** `0`\", \"**Max allowed value:** `1`\", \"**Session property:** `join_multi_clause_independence_factor` \"], \"`optimizer.non-estimatable-predicate-approximation.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `non_estimatable_predicate_approximation_enabled`\"], \"`optimizer.join-partitioned-build-min-row-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `1000000`\", \"**Min allowed value:** `0`\", \"**Session property:** `join_partitioned_build_min_row_count`\"], \"`optimizer.min-input-size-per-task`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `5GB`\", \"**Min allowed value:** `0MB`\", \"**Session property:** `min_input_size_per_task`\"], \"`optimizer.min-input-rows-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `10000000`\", \"**Min allowed value:** `0`\", \"**Session property:** `min_input_rows_per_task`\"], \"`optimizer.use-cost-based-partitioning`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `use_cost_based_partitioning`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 21]\"}, {\"title\": \"Query management properties\", \"description\": null, \"content\": {\"`query.client.timeout`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `5m`\"], \"`query.execution-policy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `phased`\", \"**Session property:** `execution_policy`\"], \"`query.determine-partition-count-for-write-enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\", \"**Session property:** `determine_partition_count_for_write_enabled`\"], \"`query.max-hash-partition-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `100`\", \"**Session property:** `max_hash_partition_count`\"], \"`query.min-hash-partition-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `4`\", \"**Session property:** `min_hash_partition_count`\"], \"`query.min-hash-partition-count-for-write`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `50`\", \"**Session property:** `min_hash_partition_count_for_write`\"], \"`query.max-writer-task-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `100`\", \"**Session property:** `max_writer_task_count`\"], \"`query.low-memory-killer.policy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `total-reservation-on-blocked-nodes`\"], \"`task.low-memory-killer.policy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `total-reservation-on-blocked-nodes`\"], \"`query.max-execution-time`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `100d`\", \"**Session property:** `query_max_execution_time`\"], \"`query.max-length`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `1,000,000`\", \"**Maximum value:** `1,000,000,000`\"], \"`query.max-planning-time`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `10m`\", \"**Session property:** `query_max_planning_time`\"], \"`query.max-run-time`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `100d`\", \"**Session property:** `query_max_run_time`\"], \"`query.max-scan-physical-bytes`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Session property:** `query_max_scan_physical_bytes`\"], \"`query.max-write-physical-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Session property:** `query_max_write_physical_size`\"], \"`query.max-stage-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `150`\", \"**Minimum value:** `1`\"], \"`query.max-history`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `100`\"], \"`query.min-expire-age`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `15m`\"], \"`query.remote-task.enable-adaptive-request-size`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `remote_task_adaptive_update_request_size_enabled`\"], \"`query.remote-task.guaranteed-splits-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `3`\", \"**Session property:** `remote_task_guaranteed_splits_per_request`\"], \"`query.remote-task.max-error-duration`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `1m`\"], \"`query.remote-task.max-request-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `8MB`\", \"**Session property:** `remote_task_max_request_size`\"], \"`query.remote-task.request-size-headroom`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `2MB`\", \"**Session property:** `remote_task_request_size_headroom`\"], \"`query.info-url-template`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `(URL of the query info page on the coordinator)`\"], \"`retry-policy`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** `NONE`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 22]\"}, {\"title\": \"Regular expression function properties\", \"description\": null, \"content\": {\"`regex-library`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `JONI`, `RE2J`\", \"**Default value:** `JONI`\"], \"`re2j.dfa-states-limit`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `2`\", \"**Default value:** `2147483647`\"], \"`re2j.dfa-retries`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `0`\", \"**Default value:** `5`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 23]\"}, {\"title\": \"Resource management properties\", \"description\": null, \"content\": {\"`query.max-cpu-time`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `1_000_000_000d`\"], \"`query.max-memory-per-node`\": [\"**Type:** {ref}`prop-type-heap-size`\", \"**Default value:** (30% of maximum heap size on the node)\"], \"`query.max-memory`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `20GB`\"], \"`query.max-total-memory`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** (`query.max-memory` * 2)\"], \"`memory.heap-headroom-per-node`\": [\"**Type:** {ref}`prop-type-heap-size`\", \"**Default value:** (30% of maximum heap size on the node)\"], \"`exchange.deduplication-buffer-size`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `32MB`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 24]\"}, {\"title\": \"Spilling properties\", \"description\": null, \"content\": {\"`spill-enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\", \"**Session property:** `spill_enabled`\"], \"`spiller-spill-path`\": [\"**Type:** {ref}`prop-type-string`\", \"**No default value.** Must be set when spilling is enabled\"], \"`spiller-max-used-space-threshold`\": [\"**Type:** {ref}`prop-type-double`\", \"**Default value:** `0.9`\"], \"`spiller-threads`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** The number of spill directories multiplied by 2, with a minimum\\nvalue of 4.\"], \"`max-spill-per-node`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `100GB`\"], \"`query-max-spill-per-node`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `100GB`\"], \"`aggregation-operator-unspill-memory-limit`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `4MB`\"], \"`spill-compression-codec`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `NONE`, `LZ4`, `ZSTD`\", \"**Default value:** `NONE`\"], \"`spill-encryption-enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 25]\"}, {\"title\": \"SQL environment properties\", \"description\": null, \"content\": {\"`sql.forced-session-time-zone`\": [\"**Type:** [](prop-type-string)\"], \"`sql.default-catalog`\": [\"**Type:** [](prop-type-string)\"], \"`sql.default-schema`\": [\"**Type:** [](prop-type-string)\"], \"`sql.default-function-catalog`\": [\"**Type:** [](prop-type-string)\"], \"`sql.default-function-schema`\": [\"**Type:** [](prop-type-string)\"], \"`sql.path`\": [\"**Type:** [](prop-type-string)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 26]\"}, {\"title\": \"Task properties\", \"description\": null, \"content\": {\"`task.concurrency`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Restrictions:** Must be a power of two\", \"**Default value:** The number of physical CPUs of the node, with a minimum\\nvalue of 2 and a maximum of 32. Defaults to 8 in\\n[](/admin/fault-tolerant-execution) mode.\", \"**Session property:** `task_concurrency`\"], \"`task.http-response-threads`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default value:** `100`\"], \"`task.http-timeout-threads`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default value:** `3`\"], \"`task.info-update-interval`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Minimum value:** `1ms`\", \"**Maximum value:** `10s`\", \"**Default value:** `3s`\"], \"`task.max-drivers-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default Value:** `2147483647`\"], \"`task.max-partial-aggregation-memory`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `16MB`\"], \"`task.max-worker-threads`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** (Node CPUs * 2)\"], \"`task.min-drivers`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** (`task.max-worker-threads` * 2)\"], \"`task.min-drivers-per-task`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Minimum value:** `1`\", \"**Default Value:** `3`\"], \"`task.scale-writers.enabled`\": [\"**Description:** see details at {ref}`prop-task-scale-writers`\"], \"`task.min-writer-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Default value:** `1`\", \"**Session property:** `task_min_writer_count`\"], \"`task.max-writer-count`\": [\"**Type:** {ref}`prop-type-integer`\", \"**Restrictions:** Must be a power of two\", \"**Default value:** The number of physical CPUs of the node, with a minimum value of 2 and a maximum of 64\", \"**Session property:** `task_max_writer_count`\"], \"`task.interrupt-stuck-split-tasks-enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\"], \"`task.interrupt-stuck-split-tasks-warning-threshold`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Minimum value:** `1m`\", \"**Default value:** `10m`\"], \"`task.interrupt-stuck-split-tasks-timeout`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Minimum value:** `3m`\", \"**Default value:** `10m`\"], \"`task.interrupt-stuck-split-tasks-detection-interval`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Minimum value:** `1m`\", \"**Default value:** `2m`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 27]\"}, {\"title\": \"Web UI properties\", \"description\": null, \"content\": {\"`web-ui.authentication.type`\": [\"**Type:** {ref}`prop-type-string`\", \"**Allowed values:** `FORM`, `FIXED`, `CERTIFICATE`, `KERBEROS`, `JWT`, `OAUTH2`\", \"**Default value:** `FORM`\"], \"`web-ui.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\"], \"`web-ui.preview.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `false`\"], \"`web-ui.shared-secret`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** randomly generated unless set\"], \"`web-ui.session-timeout`\": [\"**Type:** {ref}`prop-type-duration`\", \"**Default value:** `1d`\"], \"`web-ui.user`\": [\"**Type:** {ref}`prop-type-string`\", \"**Default value:** None\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 28]\"}, {\"title\": \"Write partitioning properties\", \"description\": null, \"content\": {\"`use-preferred-write-partitioning`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `use_preferred_write_partitioning`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 29]\"}, {\"title\": \"Writer scaling properties\", \"description\": null, \"content\": {\"`scale-writers`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `scale_writers`\"], \"`task.scale-writers.enabled`\": [\"**Type:** {ref}`prop-type-boolean`\", \"**Default value:** `true`\", \"**Session property:** `task_scale_writers_enabled`\"], \"`writer-scaling-min-data-processed`\": [\"**Type:** {ref}`prop-type-data-size`\", \"**Default value:** `120MB`\", \"**Session property:** `writer_scaling_min_data_processed`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 30]\"}, {\"title\": \"Properties reference\", \"description\": null, \"content\": {\"Property value types\": {\"`boolean`\": \"The properties of type `boolean` support two values, `true` or `false`.\\n\\n(prop-type-data-size)=\", \"`data size`\": \"The properties of type `data size` support values that describe an amount of\\ndata, measured in byte-based units. These units are incremented in multiples of\\n1024, so one megabyte is 1024 kilobytes, one kilobyte is 1024 bytes, and so on.\\nFor example, the value `6GB` describes six gigabytes, which is\\n(6 * 1024 * 1024 * 1024) = 6442450944 bytes.\\n\\nThe `data size` type supports the following units:\\n\\n['`B`: Bytes', '`kB`: Kilobytes', '`MB`: Megabytes', '`GB`: Gigabytes', '`TB`: Terabytes', '`PB`: Petabytes']\\n\\n(prop-type-double)=\", \"`double`\": \"The properties of type `double` support numerical values including decimals,\\nsuch as `1.6`. `double` type values can be negative, if supported by the\\nspecific property.\\n\\n(prop-type-duration)=\", \"`duration`\": \"The properties of type `duration` support values describing an\\namount of time, using the syntax of a non-negative number followed by a time\\nunit. For example, the value `7m` describes seven minutes.\\n\\nThe `duration` type supports the following units:\\n\\n['`ns`: Nanoseconds', '`us`: Microseconds', '`ms`: Milliseconds', '`s`: Seconds', '`m`: Minutes', '`h`: Hours', '`d`: Days']\\n\\nA duration of `0` is treated as zero regardless of the unit that follows.\\nFor example, `0s` and `0m` both mean the same thing.\\n\\nProperties of type `duration` also support decimal values, such as `2.25d`.\\nThese are handled as a fractional value of the specified unit. For example, the\\nvalue `1.5m` equals one and a half minutes, or 90 seconds.\\n\\n(prop-type-heap-size)=\", \"`heap size`\": \"Properties of type `heap size` support values that specify an amount of heap memory.\\nThese values can be provided in the same format as the `data size` property, or as `double`\\nvalues followed by a `%` suffix. The `%` suffix indicates a percentage of the maximum heap \\nmemory available on the node. The minimum allowed value is `1B`, and the maximum is `100%`, \\nwhich corresponds to the maximum heap memory available on the node.\\n\\n(prop-type-integer)=\", \"`integer`\": \"The properties of type `integer` support whole numeric values, such as `5`\\nand `1000`. Negative values are supported as well, for example `-7`.\\n`integer` type values must be whole numbers, decimal values such as `2.5`\\nare not supported.\\n\\nSome `integer` type properties enforce their own minimum and maximum values.\\n\\n(prop-type-string)=\", \"`string`\": \"The properties of type `string` support a set of values that consist of a\\nsequence of characters. Allowed values are defined on a property-by-property\\nbasis, refer to the specific property for its supported and default values.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 31]\"}, {\"title\": \"Resource groups\", \"description\": null, \"content\": {\"File resource group manager\": \"The file resource group manager reads a JSON configuration file, specified with\\n`resource-groups.config-file`:\\n\\n```\\nresource-groups.configuration-manager=file\\nresource-groups.config-file=etc/resource-groups.json\\n```\\n\\nThe path to the JSON file can be an absolute path, or a path relative to the Trino\\ndata directory. The JSON file only needs to be present on the coordinator.\\n\\n(db-resource-group-manager)=\", \"Database resource group manager\": \"The database resource group manager loads the configuration from a relational database. The\\nsupported databases are MySQL, PostgreSQL, and Oracle.\\n\\n```\\nresource-groups.configuration-manager=db\\nresource-groups.config-db-url=jdbc:mysql://localhost:3306/resource_groups\\nresource-groups.config-db-user=username\\nresource-groups.config-db-password=password\\n```\\n\\nThe resource group configuration must be populated through tables\\n`resource_groups_global_properties`, `resource_groups`, and\\n`selectors`. If any of the tables do not exist when Trino starts, they\\nwill be created automatically.\\n\\nThe rules in the `selectors` table are processed in descending order of the\\nvalues in the `priority` field.\\n\\nThe `resource_groups` table also contains an `environment` field which is\\nmatched with the value contained in the `node.environment` property in\\n{ref}`node-properties`. This allows the resource group configuration for different\\nTrino clusters to be stored in the same database if required.\\n\\nThe configuration is reloaded from the database every second, and the changes\\nare reflected automatically for incoming queries.\\n\\n:::{list-table} Database resource group manager properties\\n:widths: 40, 50, 10\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value'], ['`resource-groups.config-db-url`', 'Database URL to load configuration from.', '`none`'], ['`resource-groups.config-db-user`', 'Database user to connect with.', '`none`'], ['`resource-groups.config-db-password`', 'Password for database user to connect with.', '`none`'], ['`resource-groups.max-refresh-interval`', 'The maximum time period for which the cluster will continue to accept\\\\nqueries after refresh failures, causing configuration to become stale.', '`1h`'], ['`resource-groups.refresh-interval`', 'How often the cluster reloads from the database', '`1s`'], ['`resource-groups.exact-match-selector-enabled`', 'Setting this flag enables usage of an additional\\\\n`exact_match_source_selectors` table to configure resource group selection\\\\nrules defined exact name based matches for source, environment and query\\\\ntype. By default, the rules are only loaded from the `selectors` table, with\\\\na regex-based filter for `source`, among other filters.', '`false`\\\\n:::']]\", \"Resource group properties\": {\"Scheduling weight example\": \"Schedule weighting is a method of assigning a priority to a resource. Sub-groups\\nwith a higher scheduling weight are given higher priority. For example, to\\nensure timely execution of scheduled pipelines queries, weight them higher than\\nadhoc queries.\\n\\nIn the following example, pipeline queries are weighted with a value of `350`,\\nwhich is higher than the adhoc queries that have a scheduling weight of `150`.\\nThis means that approximately 70% (350 out of 500 queries) of your queries come\\nfrom the pipeline sub-group, and 30% (150 out of 500 queries) come from the adhoc\\nsub-group in a given timeframe. Alternatively, if you set each sub-group value to\\n`1`, the weight of the queries for the pipeline and adhoc sub-groups are split\\nevenly and each receive 50% of the queries in a given timeframe.\\n\\n```\\n:language: text\\n```\"}, \"Selector rules\": \"The selector rules for pattern matching use Java's regular expression\\ncapabilities. Java implements regular expressions through the `java.util.regex`\\npackage. For more information, see the [Java\\ndocumentation](https://docs.oracle.com/en/java/javase/24/docs/api/java.base/java/util/regex/Pattern.html).\\n\\n['`user` (optional): Java regex to match against username.', '`originalUser` (optional): Java regex to match against the _original_ username,\\\\ni.e. before any changes to the session user. For example, if user \\\"foo\\\" runs\\\\n`SET SESSION AUTHORIZATION \\\\'bar\\\\'`, `originalUser` is \\\"foo\\\", while `user` is \\\"bar\\\".', '`authenticatedUser` (optional): Java regex to match against the _authenticated_ username,\\\\nwhich will always refer to the user that authenticated with the system, regardless of any\\\\nchanges made to the session user.', '`userGroup` (optional): Java regex to match against every user group the user belongs to.', '`source` (optional): Java regex to match against source string.', '`queryType` (optional): string to match against the type of the query submitted:', ['`SELECT`: [SELECT](/sql/select) queries.', '`EXPLAIN`: [EXPLAIN](/sql/explain) queries, but not [EXPLAIN\\\\nANALYZE](/sql/explain-analyze) queries.', '`DESCRIBE`: [DESCRIBE](/sql/describe), [DESCRIBE\\\\nINPUT](/sql/describe-input), [DESCRIBE OUTPUT](/sql/describe-output), and\\\\n`SHOW` queries such as [SHOW CATALOGS](/sql/show-catalogs), [SHOW\\\\nSCHEMAS](/sql/show-schemas), and [SHOW TABLES](/sql/show-tables).', '`INSERT`: [INSERT](/sql/insert), [CREATE TABLE AS](/sql/create-table-as),\\\\nand [REFRESH MATERIALIZED VIEW](/sql/refresh-materialized-view) queries.', '`UPDATE`: [UPDATE](/sql/update) queries.', '`MERGE`: [MERGE](/sql/merge) queries.', '`DELETE`: [DELETE](/sql/delete) queries.', '`ANALYZE`: [ANALYZE](/sql/analyze) queries.', '`DATA_DEFINITION`: Queries that affect the data definition. These include\\\\n`CREATE`, `ALTER`, and `DROP` statements for schemas, tables, views, and\\\\nmaterialized views, as well as statements that manage prepared statements,\\\\nprivileges, sessions, and transactions.', '`ALTER_TABLE_EXECUTE`: Queries that execute table procedures with [ALTER\\\\nTABLE EXECUTE](alter-table-execute).'], '`clientTags` (optional): list of tags. To match, every tag in this list must be in the list of\\\\nclient-provided tags associated with the query.', '`group` (required): the group these queries will run in.']\\n\\nAll rules within a single selector are combined using a logical `AND`. Therefore\\nall rules must match for a selector to be applied.\\n\\nSelectors are processed sequentially and the first one that matches will be used.\", \"Global properties\": [\"`cpuQuotaPeriod` (optional): the period in which cpu quotas are enforced.\", \"`physicalDataScanQuotaPeriod` (optional): the period in which physical data scan quotas are enforced.\"], \"Providing selector properties\": \"The source name can be set as follows:\\n\\n['CLI: use the `--source` option.', 'JDBC driver when used in client apps: add the `source` property to the\\\\nconnection configuration and set the value when using a Java application that\\\\nuses the JDBC Driver.', 'JDBC driver used with Java programs: add a property with the key `source`\\\\nand the value on the `Connection` instance as shown in {ref}`the example\\\\n<jdbc-java-connection>`.']\\n\\nClient tags can be set as follows:\\n\\n['CLI: use the `--client-tags` option.', 'JDBC driver when used in client apps: add the `clientTags` property to the\\\\nconnection configuration and set the value when using a Java application that\\\\nuses the JDBC Driver.', 'JDBC driver used with Java programs: add a property with the key\\\\n`clientTags` and the value on the `Connection` instance as shown in\\\\n{ref}`the example <jdbc-parameter-reference>`.']\", \"Example\": {\"File resource group manager\": \"```\\n:language: json\\n```\", \"Database resource group manager\": \"This example is for a MySQL database.\\n\\n```\\n-- global properties\\nINSERT INTO resource_groups_global_properties (name, value) VALUES ('cpu_quota_period', '1h');\\n\\n-- Every row in resource_groups table indicates a resource group.\\n-- The enviroment name is 'test_environment', make sure it matches `node.environment` in your cluster.\\n-- The parent-child relationship is indicated by the ID in 'parent' column.\\n\\n-- create a root group 'global' with NULL parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_physical_data_scan_limit, hard_concurrency_limit, max_queued, scheduling_policy, jmx_export, environment) VALUES ('global', '80%', '50TB', 100, 1000, 'weighted', true, 'test_environment');\\n\\n-- get ID of 'global' group\\nSELECT resource_group_id FROM resource_groups WHERE name = 'global'; -- 1\\n-- create two new groups with 'global' as parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_weight, environment, parent) VALUES ('data_definition', '10%', 5, 100, 1, 'test_environment', 1);\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_weight, environment, parent) VALUES ('adhoc', '10%', 50, 1, 10, 'test_environment', 1);\\n\\n-- get ID of 'adhoc' group\\nSELECT resource_group_id FROM resource_groups WHERE name = 'adhoc'; -- 3\\n-- create 'other' group with 'adhoc' as parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_weight, scheduling_policy, environment, parent) VALUES ('other', '10%', 2, 1, 10, 'weighted_fair', 'test_environment', 3);\\n\\n-- get ID of 'other' group\\nSELECT resource_group_id FROM resource_groups WHERE name = 'other'; -- 4\\n-- create '${USER}' group with 'other' as parent.\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_physical_data_scan_limit, hard_concurrency_limit, max_queued, environment, parent) VALUES ('${USER}', '10%', '10GB', 1, 100, 'test_environment', 4);\\n\\n-- create 'bi-${toolname}' group with 'adhoc' as parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_weight, scheduling_policy, environment, parent) VALUES ('bi-${toolname}', '10%', 10, 100, 10, 'weighted_fair', 'test_environment', 3);\\n\\n-- get ID of 'bi-${toolname}' group\\nSELECT resource_group_id FROM resource_groups WHERE name = 'bi-${toolname}'; -- 6\\n-- create '${USER}' group with 'bi-${toolname}' as parent. This indicates\\n-- nested group 'global.adhoc.bi-${toolname}.${USER}', and will have a\\n-- different ID than 'global.adhoc.other.${USER}' created above.\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, environment, parent) VALUES ('${USER}', '10%', 3, 10, 'test_environment', 6);\\n\\n-- create 'pipeline' group with 'global' as parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_weight, jmx_export, environment, parent) VALUES ('pipeline', '80%', 45, 100, 1, true, 'test_environment', 1);\\n\\n-- get ID of 'pipeline' group\\nSELECT resource_group_id FROM resource_groups WHERE name = 'pipeline'; -- 8\\n-- create 'pipeline_${USER}' group with 'pipeline' as parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, environment, parent) VALUES ('pipeline_${USER}', '50%', 5, 100, 'test_environment', 8);\\n\\n-- create a root group 'admin' with NULL parent\\nINSERT INTO resource_groups (name, soft_memory_limit, hard_concurrency_limit, max_queued, scheduling_policy, environment, jmx_export) VALUES ('admin', '100%', 50, 100, 'query_priority', 'test_environment', true);\\n\\n\\n-- Selectors\\n\\n-- use ID of 'admin' resource group for selector\\nINSERT INTO selectors (resource_group_id, user_regex, priority) VALUES ((SELECT resource_group_id FROM resource_groups WHERE name = 'admin'), 'bob', 6);\\n\\n-- use ID of 'admin' resource group for selector\\nINSERT INTO selectors (resource_group_id, user_group_regex, priority) VALUES ((SELECT resource_group_id FROM resource_groups WHERE name = 'admin'), 'admin', 5);\\n\\n-- use ID of 'global.data_definition' resource group for selector\\nINSERT INTO selectors (resource_group_id, source_regex, query_type, priority) VALUES ((SELECT resource_group_id FROM resource_groups WHERE name = 'data_definition'), '.*pipeline.*', 'DATA_DEFINITION', 4);\\n\\n-- use ID of 'global.pipeline.pipeline_${USER}' resource group for selector\\nINSERT INTO selectors (resource_group_id, source_regex, priority) VALUES ((SELECT resource_group_id FROM resource_groups WHERE name = 'pipeline_${USER}'), '.*pipeline.*', 3);\\n\\n-- get ID of 'global.adhoc.bi-${toolname}.${USER}' resource group by disambiguating group name using parent ID\\nSELECT A.resource_group_id self_id, B.resource_group_id parent_id, concat(B.name, '.', A.name) name_with_parent\\nFROM resource_groups A JOIN resource_groups B ON A.parent = B.resource_group_id\\nWHERE A.name = '${USER}' AND B.name = 'bi-${toolname}';\\n-- 7 | 6 | bi-${toolname}.${USER}\\nINSERT INTO selectors (resource_group_id, source_regex, client_tags, priority) VALUES (7, 'jdbc#(?<toolname>.*)', '[\\\"hipri\\\"]', 2);\\n\\n-- get ID of 'global.adhoc.other.${USER}' resource group for by disambiguating group name using parent ID\\nSELECT A.resource_group_id self_id, B.resource_group_id parent_id, concat(B.name, '.', A.name) name_with_parent\\nFROM resource_groups A JOIN resource_groups B ON A.parent = B.resource_group_id\\nWHERE A.name = '${USER}' AND B.name = 'other';\\n-- | 5 | 4 | other.${USER} |\\nINSERT INTO selectors (resource_group_id, priority) VALUES (5, 1);\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 32]\"}, {\"title\": \"Session property managers\", \"description\": null, \"content\": {\"Match rules\": [\"`user` (optional): regex to match against username.\", \"`source` (optional): regex to match against source string.\", \"`queryType` (optional): string to match against the type of the query submitted:\\n: - `DATA_DEFINITION`: Queries that alter/create/drop the metadata of schemas/tables/views, and that manage\\nprepared statements, privileges, sessions, and transactions.\", [\"`DELETE`: `DELETE` queries.\", \"`DESCRIBE`: `DESCRIBE`, `DESCRIBE INPUT`, `DESCRIBE OUTPUT`, and `SHOW` queries.\", \"`EXPLAIN`: `EXPLAIN` queries.\", \"`INSERT`: `INSERT` and `CREATE TABLE AS` queries.\", \"`SELECT`: `SELECT` queries.\"], \"`clientTags` (optional): list of tags. To match, every tag in this list must be in the list of\\nclient-provided tags associated with the query.\", \"`group` (optional): regex to match against the fully qualified name of the resource group the query is\\nrouted to.\", \"`sessionProperties`: map with string keys and values. Each entry is a system or catalog property name and\\ncorresponding value. Values must be specified as strings, no matter the actual data type.\"], \"Example\": \"Consider the following set of requirements:\\n\\n['All queries running under the `global` resource group must have an execution time limit of 8 hours.', 'All interactive queries are routed to sub-groups under the `global.interactive` group, and have an execution time\\\\nlimit of 1 hour (tighter than the constraint on `global`).', \\\"All ETL queries (tagged with 'etl') are routed to sub-groups under the `global.pipeline` group, and must be\\\\nconfigured with certain properties to control writer behavior and a hive catalog property.\\\"]\\n\\nThese requirements can be expressed with the following rules:\\n\\n```\\n[\\n {\\n \\\"group\\\": \\\"global.*\\\",\\n \\\"sessionProperties\\\": {\\n \\\"query_max_execution_time\\\": \\\"8h\\\"\\n }\\n },\\n {\\n \\\"group\\\": \\\"global.interactive.*\\\",\\n \\\"sessionProperties\\\": {\\n \\\"query_max_execution_time\\\": \\\"1h\\\"\\n }\\n },\\n {\\n \\\"group\\\": \\\"global.pipeline.*\\\",\\n \\\"clientTags\\\": [\\\"etl\\\"],\\n \\\"sessionProperties\\\": {\\n \\\"scale_writers\\\": \\\"true\\\",\\n \\\"hive.insert_existing_partitions_behavior\\\": \\\"overwrite\\\"\\n }\\n }\\n]\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 33]\"}, {\"title\": \"Spill to disk\", \"description\": null, \"content\": {\"Overview\": \"In the case of memory intensive operations, Trino allows offloading\\nintermediate operation results to disk. The goal of this mechanism is to\\nenable execution of queries that require amounts of memory exceeding per query\\nor per node limits.\\n\\nThe mechanism is similar to OS level page swapping. However, it is\\nimplemented on the application level to address specific needs of Trino.\\n\\nProperties related to spilling are described in {doc}`properties-spilling`.\\n\\n:::{warning} \\nThe spill to disk feature and implementation are a legacy functionality of\\nTrino. Consider using [](/admin/fault-tolerant-execution) with the `task` retry\\npolicy and a configured [](fte-exchange-manager).\\n:::\", \"Memory management and spill\": \"By default, Trino kills queries, if the memory requested by the query execution\\nexceeds session properties `query_max_memory` or\\n`query_max_memory_per_node`. This mechanism ensures fairness in allocation\\nof memory to queries, and prevents deadlock caused by memory allocation.\\nIt is efficient when there is a lot of small queries in the cluster, but\\nleads to killing large queries that don't stay within the limits.\\n\\nTo overcome this inefficiency, the concept of revocable memory was introduced. A\\nquery can request memory that does not count toward the limits, but this memory\\ncan be revoked by the memory manager at any time. When memory is revoked, the\\nquery runner spills intermediate data from memory to disk and continues to\\nprocess it later.\\n\\nIn practice, when the cluster is idle, and all memory is available, a memory\\nintensive query may use all the memory in the cluster. On the other hand,\\nwhen the cluster does not have much free memory, the same query may be forced to\\nuse disk as storage for intermediate data. A query, that is forced to spill to\\ndisk, may have a longer execution time by orders of magnitude than a query that\\nruns completely in memory.\\n\\nPlease note that enabling spill-to-disk does not guarantee execution of all\\nmemory intensive queries. It is still possible that the query runner fails\\nto divide intermediate data into chunks small enough so that every chunk fits into\\nmemory, leading to `Out of memory` errors while loading the data from disk.\", \"Spill disk space\": \"Spilling intermediate results to disk, and retrieving them back, is expensive\\nin terms of IO operations. Thus, queries that use spill likely become\\nthrottled by disk. To increase query performance, it is recommended to\\nprovide multiple paths on separate local devices for spill (property\\n`spiller-spill-path` in {doc}`properties-spilling`).\\n\\nThe system drive should not be used for spilling, especially not to the drive where the JVM\\nis running and writing logs. Doing so may lead to cluster instability. Additionally,\\nit is recommended to monitor the disk saturation of the configured spill paths.\\n\\nTrino treats spill paths as independent disks (see [JBOD](https://wikipedia.org/wiki/Non-RAID_drive_architectures#JBOD)), so\\nthere is no need to use RAID for spill.\", \"Spill compression\": \"When spill compression is enabled with the [`spill-compression-codec`\\nproperty](/admin/properties-spilling), spilled pages are compressed, before\\nbeing written to disk. Enabling this feature can reduce disk IO at the cost of\\nextra CPU load to compress and decompress spilled pages.\", \"Spill encryption\": \"When spill encryption is enabled (`spill-encryption-enabled` property in\\n{doc}`properties-spilling`), spill contents are encrypted with a randomly generated\\n(per spill file) secret key. Enabling this increases CPU load and reduces throughput\\nof spilling to disk, but can protect spilled data from being recovered from spill files.\\nConsider reducing the value of `memory-revoking-threshold` when spill\\nencryption is enabled, to account for the increase in latency of spilling.\", \"Supported operations\": {\"Joins\": \"During the join operation, one of the tables being joined is stored in memory.\\nThis table is called the build table. The rows from the other table stream\\nthrough and are passed onto the next operation, if they match rows in the build\\ntable. The most memory-intensive part of the join is this build table.\\n\\nWhen the task concurrency is greater than one, the build table is partitioned.\\nThe number of partitions is equal to the value of the `task.concurrency`\\nconfiguration parameter (see {doc}`properties-task`).\\n\\nWhen the build table is partitioned, the spill-to-disk mechanism can decrease\\nthe peak memory usage needed by the join operation. When a query approaches the\\nmemory limit, a subset of the partitions of the build table gets spilled to disk,\\nalong with rows from the other table that fall into those same partitions. The\\nnumber of partitions, that get spilled, influences the amount of disk space needed.\\n\\nAfterward, the spilled partitions are read back one-by-one to finish the join\\noperation.\\n\\nWith this mechanism, the peak memory used by the join operator can be decreased\\nto the size of the largest build table partition. Assuming no data skew, this\\nis `1 / task.concurrency` times the size of the whole build table.\", \"Aggregations\": \"Aggregation functions perform an operation on a group of values and return one\\nvalue. If the number of groups you're aggregating over is large, a significant\\namount of memory may be needed. When spill-to-disk is enabled, if there is not\\nenough memory, intermediate cumulated aggregation results are written to disk.\\nThey are loaded back and merged with a lower memory footprint.\", \"Order by\": \"If your trying to sort a larger amount of data, a significant amount of memory\\nmay be needed. When spill to disk for `order by` is enabled, if there is not enough\\nmemory, intermediate sorted results are written to disk. They are loaded back and\\nmerged with a lower memory footprint.\", \"Window functions\": \"Window functions perform an operator over a window of rows, and return one value\\nfor each row. If this window of rows is large, a significant amount of memory may\\nbe needed. When spill to disk for window functions is enabled, if there is not enough\\nmemory, intermediate results are written to disk. They are loaded back and merged\\nwhen memory is available. There is a current limitation that spill does not work\\nin all cases, such as when a single window is very large.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 34]\"}, {\"title\": \"Tuning Trino\", \"description\": null, \"content\": {\"Config properties\": \"See {doc}`/admin/properties`.\", \"JVM settings\": \"The following can be helpful for diagnosing garbage collection (GC) issues:\\n\\n```\\n-Xlog:gc*,safepoint::time,level,tags,tid\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 35]\"}, {\"title\": \"Web UI\", \"description\": null, \"content\": {\"Authentication\": {\"Password authentication\": \"Typically, a password-based authentication method\\nsuch as {doc}`LDAP </security/ldap>` or {doc}`password file </security/password-file>`\\nis used to secure both the Trino server and the Web UI. When the Trino server\\nis configured to use a password authenticator, the Web UI authentication type\\nis automatically set to `FORM`. In this case, the Web UI displays a login form\\nthat accepts a username and password.\", \"Fixed user authentication\": \"If you require the Web UI to be accessible without authentication, you can set a fixed\\nusername that will be used for all Web UI access by setting the authentication type to\\n`FIXED` and setting the username with the `web-ui.user` configuration property.\\nIf there is a system access control installed, this user must have permission to view\\n(and possibly to kill) queries.\", \"Other authentication types\": \"The following Web UI authentication types are also supported:\\n\\n['`CERTIFICATE`, see details in {doc}`/security/certificate`', '`KERBEROS`, see details in {doc}`/security/kerberos`', '`JWT`, see details in {doc}`/security/jwt`', '`OAUTH2`, see details in {doc}`/security/oauth2`']\\n\\nFor these authentication types, the username is defined by {doc}`/security/user-mapping`.\\n\\n(web-ui-overview)=\"}, \"User interface overview\": \"The main page has a list of queries along with information like unique query ID, query text,\\nquery state, percentage completed, username and source from which this query originated.\\nThe currently running queries are at the top of the page, followed by the most recently\\ncompleted or failed queries.\\n\\nThe possible query states are as follows:\\n\\n['`QUEUED` -- Query has been accepted and is awaiting execution.', '`PLANNING` -- Query is being planned.', '`STARTING` -- Query execution is being started.', '`RUNNING` -- Query has at least one running task.', '`BLOCKED` -- Query is blocked and is waiting for resources (buffer space, memory, splits, etc.).', '`FINISHING` -- Query is finishing (e.g. commit for autocommit queries).', '`FINISHED` -- Query has finished executing and all output has been consumed.', '`FAILED` -- Query execution failed.']\\n\\nThe `BLOCKED` state is normal, but if it is persistent, it should be investigated.\\nIt has many potential causes: insufficient memory or splits, disk or network I/O bottlenecks, data skew\\n(all the data goes to a few workers), a lack of parallelism (only a few workers available), or computationally\\nexpensive stages of the query following a given stage. Additionally, a query can be in\\nthe `BLOCKED` state if a client is not processing the data fast enough (common with \\\"SELECT \\\\*\\\" queries).\\n\\nFor more detailed information about a query, simply click the query ID link.\\nThe query detail page has a summary section, graphical representation of various stages of the\\nquery and a list of tasks. Each task ID can be clicked to get more information about that task.\\n\\nThe summary section has a button to kill the currently running query. There are two visualizations\\navailable in the summary section: task execution and timeline. The full JSON document containing\\ninformation and statistics about the query is available by clicking the *JSON* link. These visualizations\\nand other statistics can be used to analyze where time is being spent for a query.\", \"Configuring query history\": \"The following configuration properties affect {doc}`how query history\\nis collected </admin/properties-query-management>` for display in the Web UI:\\n\\n['`query.min-expire-age`', '`query.max-history`']\\n\\nUnrelated to the storage of queries and query history in memory, you can use an\\n[event listener](admin-event-listeners) to publish query events, such as\\nquery started or query finished, to an external system.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17, \\\"subpages\\\", 36]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 17]\"}, {\"title\": \"Appendix\", \"description\": \"Documentation section: appendix\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/appendix\"}, \"subpages\": [{\"title\": \"Migrating from Hive\", \"description\": null, \"content\": {\"Use subscript for accessing a dynamic index of an array instead of an udf\": \"The subscript operator in SQL supports full expressions, unlike Hive (which only supports constants). Therefore you can write queries like:\\n\\n```\\nSELECT my_array[CARDINALITY(my_array)] as last_element\\nFROM ...\\n```\", \"Avoid out of bounds access of arrays\": \"Accessing out of bounds elements of an array will result in an exception. You can avoid this with an `if` as follows:\\n\\n```\\nSELECT IF(CARDINALITY(my_array) >= 3, my_array[3], NULL)\\nFROM ...\\n```\", \"Use ANSI SQL syntax for arrays\": \"Arrays are indexed starting from 1, not from 0:\\n\\n```\\nSELECT my_array[1] AS first_element\\nFROM ...\\n```\\n\\nConstruct arrays with ANSI syntax:\\n\\n```\\nSELECT ARRAY[1, 2, 3] AS my_array\\n```\", \"Use ANSI SQL syntax for identifiers and strings\": \"Strings are delimited with single quotes and identifiers are quoted with double quotes, not backquotes:\\n\\n```\\nSELECT name AS \\\"User Name\\\"\\nFROM \\\"7day_active\\\"\\nWHERE name = 'foo'\\n```\", \"Quote identifiers that start with numbers\": \"Identifiers that start with numbers are not legal in ANSI SQL and must be quoted using double quotes:\\n\\n```\\nSELECT *\\nFROM \\\"7day_active\\\"\\n```\", \"Use the standard string concatenation operator\": \"Use the ANSI SQL string concatenation operator:\\n\\n```\\nSELECT a || b || c\\nFROM ...\\n```\", \"Use standard types for CAST targets\": \"The following standard types are supported for `CAST` targets:\\n\\n```\\nSELECT\\n CAST(x AS varchar)\\n, CAST(x AS bigint)\\n, CAST(x AS double)\\n, CAST(x AS boolean)\\nFROM ...\\n```\\n\\nIn particular, use `VARCHAR` instead of `STRING`.\", \"Use CAST when dividing integers\": \"Trino follows the standard behavior of performing integer division when dividing two integers. For example, dividing `7` by `2` will result in `3`, not `3.5`.\\nTo perform floating point division on two integers, cast one of them to a double:\\n\\n```\\nSELECT CAST(5 AS DOUBLE) / 2\\n```\", \"Use WITH for complex expressions or queries\": \"When you want to re-use a complex output expression as a filter, use either an inline subquery or factor it out using the `WITH` clause:\\n\\n```\\nWITH a AS (\\n SELECT substr(name, 1, 3) x\\n FROM ...\\n)\\nSELECT *\\nFROM a\\nWHERE x = 'foo'\\n```\", \"Use UNNEST to expand arrays and maps\": \"Trino supports {ref}`unnest` for expanding arrays and maps.\\nUse `UNNEST` instead of `LATERAL VIEW explode()`.\\n\\nHive query:\\n\\n```\\nSELECT student, score\\nFROM tests\\nLATERAL VIEW explode(scores) t AS score;\\n```\\n\\nTrino query:\\n\\n```\\nSELECT student, score\\nFROM tests\\nCROSS JOIN UNNEST(scores) AS t (score);\\n```\", \"Use ANSI SQL syntax for date and time INTERVAL expressions\": \"Trino supports the ANSI SQL style `INTERVAL` expressions that differs from the implementation used in Hive.\\n\\n['The `INTERVAL` keyword is required and is not optional.', 'Date and time units must be singular. For example `day` and not `days`.', 'Values must be quoted.']\\n\\nHive query:\\n\\n```\\nSELECT cast('2000-08-19' as date) + 14 days;\\n```\\n\\nEquivalent Trino query:\\n\\n```\\nSELECT cast('2000-08-19' as date) + INTERVAL '14' day;\\n```\", \"Caution with datediff\": \"The Hive `datediff` function returns the difference between the two dates in\\ndays and is declared as:\\n\\n```\\ndatediff(string enddate, string startdate) -> integer\\n```\\n\\nThe equivalent Trino function {ref}`date_diff<datetime-interval-functions>`\\nuses a reverse order for the two date parameters and requires a unit. This has\\nto be taken into account when migrating:\\n\\nHive query:\\n\\n```\\ndatediff(enddate, startdate)\\n```\\n\\nTrino query:\\n\\n```\\ndate_diff('day', startdate, enddate)\\n```\", \"Overwriting data on insert\": \"By default, `INSERT` queries are not allowed to overwrite existing data. You\\ncan use the catalog session property `insert_existing_partitions_behavior` to\\nallow overwrites. Prepend the name of the catalog using the Hive connector, for\\nexample `hdfs`, and set the property in the session before you run the insert\\nquery:\\n\\n```\\nSET SESSION hdfs.insert_existing_partitions_behavior = 'OVERWRITE';\\nINSERT INTO hdfs.schema.table ...\\n```\\n\\nThe resulting behavior is equivalent to using [INSERT OVERWRITE](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DML) in Hive.\\n\\nInsert overwrite operation is not supported by Trino when the table is stored on\\nencrypted HDFS, when the table is unpartitioned or table is transactional.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18, \\\"subpages\\\", 0]\"}, {\"title\": \"Legal notices\", \"description\": null, \"content\": {\"License\": \"Trino is open source software licensed under the\\n[Apache License 2.0](https://github.com/trinodb/trino/blob/master/LICENSE).\", \"Code\": \"Source code is available at [https://github.com/trinodb](https://github.com/trinodb).\", \"Governance\": \"The project is run by volunteer contributions and supported by the [Trino\\nSoftware Foundation](https://trino.io/foundation.html).\", \"Trademarks\": \"Product names, other names, logos and other material used on this site are\\nregistered trademarks of various entities including, but not limited to, the\\nfollowing trademark owners and names:\\n\\n[American National Standards Institute](https://www.ansi.org/)\\n\\n['ANSI, and other names']\\n\\n[Apache Software Foundation](https://apache.org/)\\n\\n['Apache Hadoop, Apache Hive, Apache Iceberg, Apache Kafka, and other names']\\n\\n[Amazon](https://trademarks.amazon.com/)\\n\\n['AWS, S3, Glue, EMR, and other names']\\n\\n[Docker Inc.](https://www.docker.com/)\\n\\n['Docker']\\n\\n[Google](https://www.google.com/permissions/trademark/trademark-list/)\\n\\n['GCP, YouTube and other names']\\n\\n[Linux Mark Institute](http://www.linuxmark.org/)\\n\\n['Linux']\\n\\n[Microsoft](https://www.microsoft.com/en-us/legal/intellectualproperty/Trademarks/EN-US.aspx)\\n\\n['Azure, AKS, and others']\\n\\n[Oracle](https://www.oracle.com/)\\n\\n['Java, JVM, OpenJDK, and other names']\\n\\n[The Linux Foundation](https://www.linuxfoundation.org/trademark-list/)\\n\\n['Kubernetes, Presto, and other names']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 18]\"}, {\"title\": \"Client\", \"description\": \"Documentation section: client\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/client\"}, \"subpages\": [{\"title\": \"Command line interface\", \"description\": null, \"content\": {\"Requirements\": \"The Trino CLI has the following requirements:\\n\\n['Java version 11 or higher available on the path. Java 22 or higher is\\\\nrecommended for improved decompression performance.', 'Network access over HTTP/HTTPS to the coordinator of the Trino cluster.', 'Network access to the configured object storage, if the\\\\n[](cli-spooling-protocol) is enabled.']\\n\\nThe CLI version should be identical to the version of the Trino cluster, or\\nnewer. Older versions typically work, but only a subset is regularly tested.\\nVersions before 350 are not supported.\\n\\n(cli-installation)=\", \"Installation\": \"Download {maven_download}`cli`, rename it to `trino`, make it executable with\\n`chmod +x`, and run it to show the version of the CLI:\\n\\n```\\n./trino --version\\n```\\n\\nRun the CLI with `--help` or `-h` to see all available options.\\n\\nWindows users, and users unable to execute the preceding steps, can use the\\nequivalent `java` command with the `-jar` option to run the CLI, and show\\nthe version:\\n\\n```\\njava -jar trino-cli-*-executable.jar --version\\n```\\n\\nThe syntax can be used for the examples in the following sections. In addition,\\nusing the `java` command allows you to add configuration options for the Java\\nruntime with the `-D` syntax. You can use this for debugging and\\ntroubleshooting, such as when {ref}`specifying additional Kerberos debug options\\n<cli-kerberos-debug>`.\", \"Running the CLI\": \"The minimal command to start the CLI in interactive mode specifies the URL of\\nthe coordinator in the Trino cluster:\\n\\n```\\n./trino http://trino.example.com:8080\\n```\\n\\nIf successful, you will get a prompt to execute commands. Use the `help`\\ncommand to see a list of supported commands. Use the `clear` command to clear\\nthe terminal. To stop and exit the CLI, run `exit` or `quit`.:\\n\\n```\\ntrino> help\\n\\nSupported commands:\\nQUIT\\nEXIT\\nCLEAR\\nEXPLAIN [ ( option [, ...] ) ] <query>\\n options: FORMAT { TEXT | GRAPHVIZ | JSON }\\n TYPE { LOGICAL | DISTRIBUTED | VALIDATE | IO }\\nDESCRIBE <table>\\nSHOW COLUMNS FROM <table>\\nSHOW FUNCTIONS\\nSHOW CATALOGS [LIKE <pattern>]\\nSHOW SCHEMAS [FROM <catalog>] [LIKE <pattern>]\\nSHOW TABLES [FROM <schema>] [LIKE <pattern>]\\nUSE [<catalog>.]<schema>\\n```\\n\\nYou can now run SQL statements. After processing, the CLI will show results and\\nstatistics.\\n\\n```\\ntrino> SELECT count(*) FROM tpch.tiny.nation;\\n\\n_col0\\n-------\\n 25\\n(1 row)\\n\\nQuery 20220324_213359_00007_w6hbk, FINISHED, 1 node\\nSplits: 13 total, 13 done (100.00%)\\n2.92 [25 rows, 0B] [8 rows/s, 0B/s]\\n```\\n\\nAs part of starting the CLI, you can set the default catalog and schema. This\\nallows you to query tables directly without specifying catalog and schema.\\n\\n```\\n./trino http://trino.example.com:8080/tpch/tiny\\n\\ntrino:tiny> SHOW TABLES;\\n\\n Table\\n----------\\ncustomer\\nlineitem\\nnation\\norders\\npart\\npartsupp\\nregion\\nsupplier\\n(8 rows)\\n```\\n\\nYou can also set the default catalog and schema with the {doc}`/sql/use`\\nstatement.\\n\\n```\\ntrino> USE tpch.tiny;\\nUSE\\ntrino:tiny>\\n```\\n\\nMany other options are available to further configure the CLI in interactive\\nmode:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Option', 'Description'], ['`--catalog`', 'Sets the default catalog. Optionally also use `--schema` to set the default\\\\nschema. You can change the default catalog and default schema with[](/sql/use).'], ['`--client-info`', 'Adds arbitrary text as extra information about the client.'], ['`--client-request-timeout`', 'Sets the duration for query processing, after which, the client request is\\\\nterminated. Defaults to `2m`.'], ['`--client-tags`', 'Adds extra tags information about the client and the CLI user. Separate\\\\nmultiple tags with commas. The tags can be used as input for\\\\n[](/admin/resource-groups).'], ['`--debug`', 'Enables display of debug information during CLI usage for\\\\n[](cli-troubleshooting). Displays more information about query\\\\nprocessing statistics.'], ['`--decimal-data-size`', 'Show data size and rate in base 10 (KB, MB, etc.) rather than the default \\\\nbase 2 (KiB, MiB, etc.).'], ['`--disable-auto-suggestion`', 'Disables autocomplete suggestions.'], ['`--disable-compression`', 'Disables compression of query results.'], ['`--editing-mode`', 'Sets key bindings in the CLI to be compatible with VI or\\\\nEMACS editors. Defaults to `EMACS`.'], ['`--extra-credential`', 'Extra credentials (property can be used multiple times; format is key=value)'], ['`--http-proxy`', 'Configures the URL of the HTTP proxy to connect to Trino.'], ['`--history-file`', 'Path to the [history file](cli-history). Defaults to `~/.trino_history`.'], ['`--network-logging`', 'Configures the level of detail provided for network logging of the CLI.\\\\nDefaults to `NONE`, other options are `BASIC`, `HEADERS`, or `BODY`.'], ['`--output-format-interactive=<format>`', 'Specify the [format](cli-output-format) to use for printing query results.\\\\nDefaults to `ALIGNED`.'], ['`--pager=<pager>`', 'Path to the pager program used to display the query results. Set to an empty\\\\nvalue to completely disable pagination. Defaults to `less` with a carefully\\\\nselected set of options.'], ['`--no-progress`', 'Do not show query processing progress.'], ['`--path`', 'Set the default [SQL path](/sql/set-path) for the session. Useful for\\\\nsetting a catalog and schema location for [](udf-catalog).'], ['`--password`', 'Prompts for a password. Use if your Trino server requires password\\\\nauthentication. You can set the `TRINO_PASSWORD` environment variable with\\\\nthe password value to avoid the prompt. For more information, see\\\\n[](cli-username-password-auth).'], ['`--schema`', 'Sets the default schema. Must be combined with `--catalog`. You can change\\\\nthe default catalog and default schema with [](/sql/use).'], ['`--server`', 'The HTTP/HTTPS address and port of the Trino coordinator. The port must be\\\\nset to the port the Trino coordinator is listening for connections on. Port\\\\n80 for HTTP and Port 443 for HTTPS can be omitted. Trino server location\\\\ndefaults to `http://localhost:8080`. Can only be set if URL is not\\\\nspecified.'], ['`--session`', 'Sets one or more [session properties](session-properties-definition).\\\\nProperty can be used multiple times with the format\\\\n`session_property_name=value`.'], ['`--socks-proxy`', 'Configures the URL of the SOCKS proxy to connect to Trino.'], ['`--source`', 'Specifies the name of the application or source connecting to Trino.\\\\nDefaults to `trino-cli`. The value can be used as input for\\\\n[](/admin/resource-groups).'], ['`--timezone`', 'Sets the time zone for the session using the [time zone name](\\\\n<https://wikipedia.org/wiki/List_of_tz_database_time_zones>). Defaults to\\\\nthe timezone set on your workstation.'], ['`--user`', 'Sets the username for [](cli-username-password-auth). Defaults to your\\\\noperating system username. You can override the default username, if your\\\\ncluster uses a different username or authentication mechanism. \\\\n:::']]\\n\\nMost of the options can also be set as parameters in the URL. This means\\na JDBC URL can be used in the CLI after removing the `jdbc:` prefix.\\nHowever, the same parameter may not be specified using both methods.\\nSee {doc}`the JDBC driver parameter reference </client/jdbc>`\\nto find out URL parameter names. For example:\\n\\n```\\n./trino 'https://trino.example.com?SSL=true&SSLVerification=FULL&clientInfo=extra'\\n```\\n\\n(cli-tls)=\", \"TLS/HTTPS\": \"Trino is typically available with an HTTPS URL. This means that all network\\ntraffic between the CLI and Trino uses TLS. {doc}`TLS configuration\\n</security/tls>` is common, since it is a requirement for {ref}`any\\nauthentication <cli-authentication>`.\\n\\nUse the HTTPS URL to connect to the server:\\n\\n```\\n./trino https://trino.example.com\\n```\\n\\nThe recommended TLS implementation is to use a globally trusted certificate. In\\nthis case, no other options are necessary, since the JVM running the CLI\\nrecognizes these certificates.\\n\\nUse the options from the following table to further configure TLS and\\ncertificate usage:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Option', 'Description'], ['`--insecure`', 'Skip certificate validation when connecting with TLS/HTTPS (should only be\\\\nused for debugging).'], ['`--keystore-path`', 'The location of the Java Keystore file that contains the certificate of the\\\\nserver to connect with TLS.'], ['`--keystore-password`', 'The password for the keystore. This must match the password you specified\\\\nwhen creating the keystore.'], ['`--keystore-type`', 'Determined by the keystore file format. The default keystore type is JKS.\\\\nThis advanced option is only necessary if you use a custom Java Cryptography\\\\nArchitecture (JCA) provider implementation.'], ['`--use-system-keystore`', 'Use a client certificate obtained from the system keystore of the operating\\\\nsystem. Windows and macOS are supported. For other operating systems, the\\\\ndefault Java keystore is used. The keystore type can be overridden using\\\\n`--keystore-type`.'], ['`--truststore-password`', 'The password for the truststore. This must match the password you specified\\\\nwhen creating the truststore.'], ['`--truststore-path`', 'The location of the Java truststore file that will be used to secure TLS.'], ['`--truststore-type`', 'Determined by the truststore file format. The default keystore type is JKS.\\\\nThis advanced option is only necessary if you use a custom Java Cryptography\\\\nArchitecture (JCA) provider implementation.'], ['`--use-system-truststore`', 'Verify the server certificate using the system truststore of the operating\\\\nsystem. Windows and macOS are supported. For other operating systems, the\\\\ndefault Java truststore is used. The truststore type can be overridden using\\\\n`--truststore-type`.\\\\n:::']]\\n\\n(cli-authentication)=\", \"Authentication\": {\"Username and password authentication\": \"Username and password authentication is typically configured in a cluster using\\nthe `PASSWORD` {doc}`authentication type </security/authentication-types>`,\\nfor example with {doc}`/security/ldap` or {doc}`/security/password-file`.\\n\\nThe following code example connects to the server, establishes your username,\\nand prompts the CLI for your password:\\n\\n```\\n./trino https://trino.example.com --user=exampleusername --password\\n```\\n\\nAlternatively, set the password as the value of the `TRINO_PASSWORD`\\nenvironment variable. Typically use single quotes to avoid problems with\\nspecial characters such as `$`:\\n\\n```\\nexport TRINO_PASSWORD='LongSecurePassword123!@#'\\n```\\n\\nIf the `TRINO_PASSWORD` environment variable is set, you are not prompted\\nto provide a password to connect with the CLI.\\n\\n```\\n./trino https://trino.example.com --user=exampleusername --password\\n```\\n\\n(cli-external-sso-auth)=\", \"External authentication - SSO\": \"Use the `--external-authentication` option for browser-based SSO\\nauthentication, as detailed in {doc}`/security/oauth2`. With this configuration,\\nthe CLI displays a URL that you must open in a web browser for authentication.\\n\\nThe detailed behavior is as follows:\\n\\n['Start the CLI with the `--external-authentication` option and execute a\\\\nquery.', 'The CLI starts and connects to Trino.', 'A message appears in the CLI directing you to open a browser with a specified\\\\nURL when the first query is submitted.', 'Open the URL in a browser and follow through the authentication process.', 'The CLI automatically receives a token.', 'When successfully authenticated in the browser, the CLI proceeds to execute\\\\nthe query.', 'Further queries in the CLI session do not require additional logins while the\\\\nauthentication token remains valid. Token expiration depends on the external\\\\nauthentication type configuration.', 'Expired tokens force you to log in again.']\\n\\n(cli-certificate-auth)=\", \"Certificate authentication\": \"Use the following CLI arguments to connect to a cluster that uses\\n{doc}`certificate authentication </security/certificate>`.\\n\\n:::{list-table} CLI options for certificate authentication\\n:widths: 35 65\\n:header-rows: 1\\n\\n[['Option', 'Description'], ['`--keystore-path=<path>`', 'Absolute or relative path to a [PEM](/security/inspect-pem) or\\\\n[JKS](/security/inspect-jks) file, which must contain a certificate\\\\nthat is trusted by the Trino cluster you are connecting to.'], ['`--keystore-password=<password>`', 'Only required if the keystore has a password.\\\\n:::']]\\n\\nThe truststore related options are independent of client certificate\\nauthentication with the CLI; instead, they control the client's trust of the\\nserver's certificate.\\n\\n(cli-jwt-auth)=\", \"JWT authentication\": \"To access a Trino cluster configured to use {doc}`/security/jwt`, use the\\n`--access-token=<token>` option to pass a JWT to the server.\\n\\n(cli-kerberos-auth)=\", \"Kerberos authentication\": {\"Additional Kerberos debugging information\": \"You can enable additional Kerberos debugging information for the Trino CLI\\nprocess by passing `-Dsun.security.krb5.debug=true`,\\n`-Dtrino.client.debugKerberos=true`, and\\n`-Djava.security.debug=gssloginconfig,configfile,configparser,logincontext`\\nas a JVM argument when {ref}`starting the CLI process <cli-installation>`:\\n\\n```\\njava \\\\\\n -Dsun.security.krb5.debug=true \\\\\\n -Djava.security.debug=gssloginconfig,configfile,configparser,logincontext \\\\\\n -Dtrino.client.debugKerberos=true \\\\\\n -jar trino-cli-*-executable.jar \\\\\\n --server https://trino.example.com \\\\\\n --krb5-config-path /etc/krb5.conf \\\\\\n --krb5-principal someuser@EXAMPLE.COM \\\\\\n --krb5-keytab-path /home/someuser/someuser.keytab \\\\\\n --krb5-remote-service-name trino\\n```\\n\\nFor help with interpreting Kerberos debugging messages, see {ref}`additional\\nresources <kerberos-debug>`.\"}}, \"Pagination\": \"By default, the results of queries are paginated using the `less` program\\nwhich is configured with a carefully selected set of options. This behavior\\ncan be overridden by setting the `--pager` option or\\nthe `TRINO_PAGER` environment variable to the name of a different program\\nsuch as `more` or [pspg](https://github.com/okbob/pspg),\\nor it can be set to an empty value to completely disable pagination.\\n\\n(cli-history)=\", \"History\": {\"Auto suggestion\": \"The CLI generates autocomplete suggestions based on command history.\\n\\nPress {kbd}`\\u2192` to accept the suggestion and replace the current command line\\nbuffer. Press {kbd}`Ctrl+\\u2192` ({kbd}`Option+\\u2192` on Mac) to accept only the next\\nkeyword. Continue typing to reject the suggestion.\"}, \"Configuration file\": \"The CLI can read default values for all options from a file. It uses the first\\nfile found from the ordered list of locations:\\n\\n['File path set as value of the `TRINO_CONFIG` environment variable.', '`.trino_config` in the current users home directory.', '`$XDG_CONFIG_HOME/trino/config`.']\\n\\nFor example, you could create separate configuration files with different\\nauthentication options, like `kerberos-cli.properties` and `ldap-cli.properties`.\\nAssuming they're located in the current directory, you can set the\\n`TRINO_CONFIG` environment variable for a single invocation of the CLI by\\nadding it before the `trino` command:\\n\\n```\\nTRINO_CONFIG=kerberos-cli.properties trino https://first-cluster.example.com:8443\\nTRINO_CONFIG=ldap-cli.properties trino https://second-cluster.example.com:8443\\n```\\n\\nIn the preceding example, the default configuration files are not used.\\n\\nYou can use all supported options without the `--` prefix in the configuration\\nproperties file. Options that normally don't take an argument are boolean, so\\nset them to either `true` or `false`. For example:\\n\\n```\\noutput-format-interactive=AUTO\\ntimezone=Europe/Warsaw\\nuser=trino-client\\nnetwork-logging=BASIC\\nkrb5-disable-remote-service-hostname-canonicalization=true\\n```\", \"Batch mode\": {\"Examples\": \"Consider the following command run as shown, or with the\\n`--output-format=CSV` option, which is the default for non-interactive usage:\\n\\n```\\ntrino --execute 'SELECT nationkey, name, regionkey FROM tpch.sf1.nation LIMIT 3'\\n```\\n\\nThe output is as follows:\\n\\n```\\n\\\"0\\\",\\\"ALGERIA\\\",\\\"0\\\"\\n\\\"1\\\",\\\"ARGENTINA\\\",\\\"1\\\"\\n\\\"2\\\",\\\"BRAZIL\\\",\\\"1\\\"\\n```\\n\\nThe output with the `--output-format=JSON` option:\\n\\n```\\n{\\\"nationkey\\\":0,\\\"name\\\":\\\"ALGERIA\\\",\\\"regionkey\\\":0}\\n{\\\"nationkey\\\":1,\\\"name\\\":\\\"ARGENTINA\\\",\\\"regionkey\\\":1}\\n{\\\"nationkey\\\":2,\\\"name\\\":\\\"BRAZIL\\\",\\\"regionkey\\\":1}\\n```\\n\\nThe output with the `--output-format=ALIGNED` option, which is the default\\nfor interactive usage:\\n\\n```\\nnationkey | name | regionkey\\n----------+-----------+----------\\n 0 | ALGERIA | 0\\n 1 | ARGENTINA | 1\\n 2 | BRAZIL | 1\\n```\\n\\nThe output with the `--output-format=VERTICAL` option:\\n\\n```\\n-[ RECORD 1 ]--------\\nnationkey | 0\\nname | ALGERIA\\nregionkey | 0\\n-[ RECORD 2 ]--------\\nnationkey | 1\\nname | ARGENTINA\\nregionkey | 1\\n-[ RECORD 3 ]--------\\nnationkey | 2\\nname | BRAZIL\\nregionkey | 1\\n```\\n\\nThe preceding command with `--output-format=NULL` produces no output.\\nHowever, if you have an error in the query, such as incorrectly using\\n`region` instead of `regionkey`, the command has an exit status of 1\\nand displays an error message (which is unaffected by the output format):\\n\\n```\\nQuery 20200707_170726_00030_2iup9 failed: line 1:25: Column 'region' cannot be resolved\\nSELECT nationkey, name, region FROM tpch.sf1.nation LIMIT 3\\n```\\n\\n(cli-spooling-protocol)=\"}, \"Spooling protocol\": \"The Trino CLI automatically uses the spooling protocol to improve throughput\\nfor client interactions with higher data transfer demands, if the\\n[](protocol-spooling) is configured on the cluster.\\n\\nOptionally use the `--encoding` option to configure a different desired\\nencoding, compared to the default on the cluster. The available values are\\n`json+zstd` (recommended) for JSON with Zstandard compression, and `json+lz4`\\nfor JSON with LZ4 compression, and `json` for uncompressed JSON. \\n\\nThe CLI process must have network access to the spooling object storage.\\n\\n(cli-output-format)=\", \"Output formats\": \"The Trino CLI provides the options `--output-format`\\nand `--output-format-interactive` to control how the output is displayed.\\nThe available options shown in the following table must be entered\\nin uppercase. The default value is `ALIGNED` in interactive mode,\\nand `CSV` in non-interactive mode.\\n\\n:::{list-table} Output format options\\n:widths: 25, 75\\n:header-rows: 1\\n\\n[['Option', 'Description'], ['`CSV`', 'Comma-separated values, each value quoted. No header row.'], ['`CSV_HEADER`', 'Comma-separated values, quoted with header row.'], ['`CSV_UNQUOTED`', 'Comma-separated values without quotes.'], ['`CSV_HEADER_UNQUOTED`', 'Comma-separated values with header row but no quotes.'], ['`TSV`', 'Tab-separated values.'], ['`TSV_HEADER`', 'Tab-separated values with header row.'], ['`JSON`', 'Output rows emitted as JSON objects with name-value pairs.'], ['`ALIGNED`', 'Output emitted as an ASCII character table with values.'], ['`VERTICAL`', 'Output emitted as record-oriented top-down lines, one per value.'], ['`AUTO`', 'Same as `ALIGNED` if output would fit the current terminal width,\\\\nand `VERTICAL` otherwise.'], ['`MARKDOWN`', 'Output emitted as a Markdown table.'], ['`NULL`', \\\"Suppresses normal query results. This can be useful during development to\\\\ntest a query's shell return code or to see whether it results in error\\\\nmessages. \\\\n:::\\\"]]\\n\\n(cli-troubleshooting)=\", \"Troubleshooting\": \"If something goes wrong, you see an error message:\\n\\n```\\n$ trino\\ntrino> select count(*) from tpch.tiny.nations;\\nQuery 20200804_201646_00003_f5f6c failed: line 1:22: Table 'tpch.tiny.nations' does not exist\\nselect count(*) from tpch.tiny.nations\\n```\\n\\nTo view debug information, including the stack trace for failures, use the\\n`--debug` option:\\n\\n```\\n$ trino --debug\\ntrino> select count(*) from tpch.tiny.nations;\\nQuery 20200804_201629_00002_f5f6c failed: line 1:22: Table 'tpch.tiny.nations' does not exist\\nio.trino.spi.TrinoException: line 1:22: Table 'tpch.tiny.nations' does not exist\\nat io.trino.sql.analyzer.SemanticExceptions.semanticException(SemanticExceptions.java:48)\\nat io.trino.sql.analyzer.SemanticExceptions.semanticException(SemanticExceptions.java:43)\\n...\\nat java.base/java.lang.Thread.run(Thread.java:834)\\nselect count(*) from tpch.tiny.nations\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 0]\"}, {\"title\": \"Client protocol\", \"description\": null, \"content\": {\"Spooling protocol\": {\"Configuration\": \"The following steps are necessary to configure support for the spooling protocol\\non a Trino cluster:\\n\\n['Configure the spooling protocol usage in [](config-properties) using the\\\\n[](prop-protocol-spooling).', 'Choose a suitable object storage that is accessible to your Trino cluster and\\\\nyour clients.', 'Create a location in your object storage that is not shared with any object\\\\nstorage catalog or spooling for any other Trino clusters.', 'Configure the object storage in `etc/spooling-manager.properties` using the\\\\n[](prop-spooling-file-system).']\\n\\nMinimal configuration in [](config-properties):\\n\\n```\\nprotocol.spooling.enabled=true\\nprotocol.spooling.shared-secret-key=jxTKysfCBuMZtFqUf8UJDQ1w9ez8rynEJsJqgJf66u0=\\n```\\n\\nRefer to [](prop-protocol-spooling) for further optional configuration.\\n\\nSuitable object storage systems for spooling are S3 and compatible systems,\\nAzure Storage, and Google Cloud Storage. The object storage system must provide\\ngood connectivity for all cluster nodes as well as any clients. \\n\\nActivate the desired system with\\n`fs.s3.enabled`, `fs.azure.enabled`, or `fs.gcs.enabled` in\\n`etc/spooling-manager.properties` and configure further details using relevant\\nproperties from [](prop-spooling-file-system),\\n[](/object-storage/file-system-s3), [](/object-storage/file-system-azure), and\\n[](/object-storage/file-system-gcs).\\n\\nThe `spooling-manager.name` property must be set to `filesystem`.\\n\\nFollowing is a minimalistic example for using the S3-compatible MinIO object\\nstorage:\\n\\n```\\nspooling-manager.name=filesystem\\nfs.s3.enabled=true\\nfs.location=s3://spooling\\ns3.endpoint=http://minio:9080/\\ns3.region=fake-value\\ns3.aws-access-key=minio-access-key\\ns3.aws-secret-key=minio-secret-key\\ns3.path-style-access=true\\n```\\n\\nRefer to [](prop-spooling-file-system) for further configuration properties.\\n\\nThe system assumes the object storage to be unbounded in terms of data and data\\ntransfer volume. Spooled segments on object storage are automatically removed by\\nthe clients after reads as well as the coordinator in specific intervals. Sizing\\nand transfer demands vary with the query workload on your cluster.\\n\\nSegments on object storage are encrypted, compressed, and can only be used by\\nthe specific client who initiated the query.\\n\\nThe following client drivers and client applications support the spooling protocol.\\n\\n['[Trino JDBC driver](jdbc-spooling-protocol), version 466 and newer', '[Trino command line interface](cli-spooling-protocol), version 466 and newer', '[Trino Python client](https://github.com/trinodb/trino-python-client), version\\\\n0.332.0 and newer', '[Trino Go client](https://github.com/trinodb/trino-go-client), version \\\\n0.328.0 and newer']\\n\\nRefer to the documentation for your specific client drivers and client\\napplications for up to date information.\\n\\n(protocol-direct)=\"}, \"Direct protocol\": {\"Configuration\": \"Use of the direct protocol requires no configuration.\\nFind optional configuration properties in [](prop-protocol-shared).\"}, \"Development and reference information\": \"Further technical details about the client protocol, including information\\nuseful for developing a client driver, are available in the [Trino client REST\\nAPI developer reference](/develop/client-protocol).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 1]\"}, {\"title\": \"JDBC driver\", \"description\": null, \"content\": {\"Requirements\": \"The Trino JDBC driver has the following requirements:\\n\\n['Java version 11 or higher. Java 22 or higher is recommended for improved\\\\ndecompression performance.', 'All users that connect to Trino with the JDBC driver must be granted access to\\\\nquery tables in the `system.jdbc` schema.', 'Network access over HTTP/HTTPS to the coordinator of the Trino cluster.', 'Network access to the configured object storage, if the\\\\n[](jdbc-spooling-protocol) is enabled.']\\n\\nThe JDBC driver version should be identical to the version of the Trino cluster,\\nor newer. Older versions typically work, but only a subset is regularly tested.\\nVersions before 350 are not supported.\\n\\n(jdbc-installation)=\", \"Installation\": \"Download {maven_download}`jdbc` and add it to the classpath of your Java application.\\n\\nThe driver is also available from Maven Central:\\n\\n```\\n<dependency>\\n <groupId>io.trino</groupId>\\n <artifactId>trino-jdbc</artifactId>\\n <version>|trino_version|</version>\\n</dependency>\\n```\\n\\nWe recommend using the latest version of the JDBC driver. A list of all\\navailable versions can be found in the [Maven Central Repository](https://repo1.maven.org/maven2/io/trino/trino-jdbc/). Navigate to the\\ndirectory for the desired version, and select the `trino-jdbc-xxx.jar` file\\nto download, where `xxx` is the version number.\\n\\nOnce downloaded, you must add the JAR file to a directory in the classpath\\nof users on systems where they will access Trino.\\n\\nAfter you have downloaded the JDBC driver and added it to your\\nclasspath, you'll typically need to restart your application in order to\\nrecognize the new driver. Then, depending on your application, you\\nmay need to manually register and configure the driver.\", \"Registering and configuring the driver\": \"Drivers are commonly loaded automatically by applications once they are added to\\nits classpath. If your application does not, such as is the case for some\\nGUI-based SQL editors, read this section. The steps to register the JDBC driver\\nin a UI or on the command line depend upon the specific application you are\\nusing. Please check your application's documentation.\\n\\nOnce registered, you must also configure the connection information as described\\nin the following section.\", \"Connecting\": \"When your driver is loaded, registered and configured, you are ready to connect\\nto Trino from your application. The following JDBC URL formats are supported:\\n\\n```\\njdbc:trino://host:port\\njdbc:trino://host:port/catalog\\njdbc:trino://host:port/catalog/schema\\n```\\n\\nThe value for `port` is optional if Trino is available at the default HTTP port\\n`80` or with `SSL=true` and the default HTTPS port `443`.\\n\\nThe following is an example of a JDBC URL used to create a connection:\\n\\n```\\njdbc:trino://example.net:8080/hive/sales\\n```\\n\\nThis example JDBC URL locates a Trino instance running on port `8080` on\\n`example.net`, with the catalog `hive` and the schema `sales` defined.\\n\\n:::{note}\\nTypically, the JDBC driver classname is configured automatically by your\\nclient. If it is not, use `io.trino.jdbc.TrinoDriver` wherever a driver\\nclassname is required.\\n:::\\n\\n(jdbc-java-connection)=\", \"Connection parameters\": \"The driver supports various parameters that may be set as URL parameters,\\nor as properties passed to `DriverManager`. Both of the following\\nexamples are equivalent:\\n\\n```\\n// properties\\nString url = \\\"jdbc:trino://example.net:8080/hive/sales\\\";\\nProperties properties = new Properties();\\nproperties.setProperty(\\\"user\\\", \\\"test\\\");\\nproperties.setProperty(\\\"password\\\", \\\"secret\\\");\\nproperties.setProperty(\\\"SSL\\\", \\\"true\\\");\\nConnection connection = DriverManager.getConnection(url, properties);\\n\\n// URL parameters\\nString url = \\\"jdbc:trino://example.net:8443/hive/sales?user=test&password=secret&SSL=true\\\";\\nConnection connection = DriverManager.getConnection(url);\\n```\\n\\nThese methods may be mixed; some parameters may be specified in the URL,\\nwhile others are specified using properties. However, the same parameter\\nmay not be specified using both methods.\\n\\n(jdbc-parameter-reference)=\", \"Parameter reference\": \":::{list-table}\\n:widths: 35, 65\\n:header-rows: 1\\n\\n[['Name', 'Description'], ['`user`', 'Username to use for authentication and authorization.'], ['`password`', 'Password to use for LDAP authentication.'], ['`sessionUser`', 'Session username override, used for impersonation.'], ['`socksProxy`', 'SOCKS proxy host and port. Example: `localhost:1080`'], ['`httpProxy`', 'HTTP proxy host and port. Example: `localhost:8888`'], ['`clientInfo`', 'Extra information about the client.'], ['`clientTags`', 'Client tags for selecting resource groups. Example: `abc,xyz`'], ['`path`', 'Set the default [SQL path](/sql/set-path) for the session. Useful for\\\\nsetting a catalog and schema location for [](udf-catalog).'], ['`traceToken`', 'Trace token for correlating requests across systems.'], ['`source`', 'Source name for the Trino query. This parameter should be used in preference\\\\nto `ApplicationName`. Thus, it takes precedence over `ApplicationName`\\\\nand/or `applicationNamePrefix`.'], ['`applicationNamePrefix`', 'Prefix to append to any specified `ApplicationName` client info property,\\\\nwhich is used to set the source name for the Trino query if the `source`\\\\nparameter has not been set. If neither this property nor `ApplicationName`\\\\nor `source` are set, the source name for the query is `trino-jdbc`.'], ['`accessToken`', '[JWT](/security/jwt) access token for token based authentication.'], ['`SSL`', 'Set `true` to specify using TLS/HTTPS for connections.'], ['`SSLVerification`', 'The method of TLS verification. There are three modes: `FULL`\\\\n(default), `CA` and `NONE`. For `FULL`, the normal TLS verification\\\\nis performed. For `CA`, only the CA is verified but hostname mismatch\\\\nis allowed. For `NONE`, there is no verification.'], ['`SSLKeyStorePath`', 'Use only when connecting to a Trino cluster that has [certificate\\\\nauthentication](/security/certificate) enabled. Specifies the path to a\\\\n[PEM](/security/inspect-pem) or [JKS](/security/inspect-jks) file, which must\\\\ncontain a certificate that is trusted by the Trino cluster you connect to.'], ['`SSLKeyStorePassword`', 'The password for the KeyStore, if any.'], ['`SSLKeyStoreType`', 'The type of the KeyStore. The default type is provided by the Java\\\\n`keystore.type` security property or `jks` if none exists.'], ['`SSLUseSystemKeyStore`', 'Set `true` to automatically use the system KeyStore based on the operating\\\\nsystem. The supported OSes are Windows and macOS. For Windows, the\\\\n`Windows-MY` KeyStore is selected. For macOS, the `KeychainStore`\\\\nKeyStore is selected. For other OSes, the default Java KeyStore is loaded.\\\\nThe KeyStore specification can be overridden using `SSLKeyStoreType`.'], ['`SSLTrustStorePath`', 'The location of the Java TrustStore file to use to validate HTTPS server\\\\ncertificates.'], ['`SSLTrustStorePassword`', 'The password for the TrustStore.'], ['`SSLTrustStoreType`', 'The type of the TrustStore. The default type is provided by the Java\\\\n`keystore.type` security property or `jks` if none exists.'], ['`SSLUseSystemTrustStore`', 'Set `true` to automatically use the system TrustStore based on the operating\\\\nsystem. The supported OSes are Windows and macOS. For Windows, the\\\\n`Windows-ROOT` TrustStore is selected. For macOS, the `KeychainStore`\\\\nTrustStore is selected. For other OSes, the default Java TrustStore is\\\\nloaded. The TrustStore specification can be overridden using\\\\n`SSLTrustStoreType`.'], ['`hostnameInCertificate`', 'Expected hostname in the certificate presented by the Trino server. Only\\\\napplicable with full SSL verification enabled.'], ['`KerberosRemoteServiceName`', 'Trino coordinator Kerberos service name. This parameter is required for\\\\nKerberos authentication.'], ['`KerberosPrincipal`', 'The principal to use when authenticating to the Trino coordinator.'], ['`KerberosUseCanonicalHostname`', 'Use the canonical hostname of the Trino coordinator for the Kerberos service\\\\nprincipal by first resolving the hostname to an IP address and then doing a\\\\nreverse DNS lookup for that IP address. This is enabled by default.'], ['`KerberosServicePrincipalPattern`', 'Trino coordinator Kerberos service principal pattern. The default is\\\\n`${SERVICE}@${HOST}`. `${SERVICE}` is replaced with the value of\\\\n`KerberosRemoteServiceName` and `${HOST}` is replaced with the hostname of\\\\nthe coordinator (after canonicalization if enabled).'], ['`KerberosConfigPath`', 'Kerberos configuration file.'], ['`KerberosKeytabPath`', 'Kerberos keytab file.'], ['`KerberosCredentialCachePath`', 'Kerberos credential cache.'], ['`KerberosDelegation`', 'Set to `true` to use the token from an existing Kerberos context. This\\\\nallows client to use Kerberos authentication without passing the Keytab or\\\\ncredential cache. Defaults to `false`.'], ['`extraCredentials`', 'Extra credentials for connecting to external services, specified as a list\\\\nof key-value pairs. For example, `foo:bar;abc:xyz` creates the credential\\\\nnamed `abc` with value `xyz` and the credential named `foo` with value\\\\n`bar`.'], ['`roles`', 'Authorization roles to use for catalogs, specified as a list of key-value\\\\npairs for the catalog and role. For example, `catalog1:roleA;catalog2:roleB`\\\\nsets `roleA` for `catalog1` and `roleB` for `catalog2`.'], ['`sessionProperties`', 'Session properties to set for the system and for catalogs, specified as a\\\\nlist of key-value pairs. For example, `abc:xyz;example.foo:bar` sets the\\\\nsystem property `abc` to the value `xyz` and the `foo` property for catalog\\\\n`example` to the value `bar`.'], ['`externalAuthentication`', 'Set to true if you want to use external authentication via\\\\n[](/security/oauth2). Use a local web browser to authenticate with an\\\\nidentity provider (IdP) that has been configured for the Trino coordinator.'], ['`externalAuthenticationTokenCache`', 'Allows the sharing of external authentication tokens between different\\\\nconnections for the same authenticated user until the cache is invalidated,\\\\nsuch as when a client is restarted or when the classloader reloads the JDBC\\\\ndriver. This is disabled by default, with a value of `NONE`. To enable, set\\\\nthe value to `MEMORY`. If the JDBC driver is used in a shared mode by\\\\ndifferent users, the first registered token is stored and authenticates all\\\\nusers.'], ['`disableCompression`', 'Whether compression should be enabled.'], ['`assumeLiteralUnderscoreInMetadataCallsForNonConformingClients`', 'When enabled, the name patterns passed to `DatabaseMetaData` methods are\\\\ntreated as underscores. You can use this as a workaround for applications\\\\nthat do not escape schema or table names when passing them to\\\\n`DatabaseMetaData` methods as schema or table name patterns.'], ['`timezone`', 'Sets the time zone for the session using the [time zone\\\\npassed](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/ZoneId.html#of(java.lang.String)).\\\\nDefaults to the timezone of the JVM running the JDBC driver.'], ['`explicitPrepare`', 'Defaults to `true`. When set to `false`, prepared statements are executed\\\\ncalling a single `EXECUTE IMMEDIATE` query instead of the standard\\\\n`PREPARE <statement>` followed by `EXECUTE <statement>`. This reduces\\\\nnetwork overhead and uses smaller HTTP headers and requires Trino 431 or\\\\ngreater.'], ['`encoding`', 'Set the encoding when using the [spooling protocol](jdbc-spooling-protocol).\\\\nValid values are JSON with Zstandard compression, `json+zstd` (recommended),\\\\nJSON with LZ4 compression `json+lz4`, and uncompressed JSON `json`. By\\\\ndefault, the default encoding configured on the cluster is used.'], ['`validateConnection`', 'Defaults to `false`. If set to `true`, connectivity and credentials are validated \\\\nwhen the connection is created, and when `java.sql.Connection.isValid(int)` is called.\\\\n:::']]\\n\\n(jdbc-spooling-protocol)=\", \"Spooling protocol\": \"The Trino JDBC driver automatically uses of the spooling protocol to improve\\nthroughput for client interactions with higher data transfer demands, if the\\n[](protocol-spooling) is configured on the cluster.\\n\\nOptionally use the `encoding` parameter to configure a different desired\\nencoding, compared to the default on the cluster.\\n\\nThe JVM process using the JDBC driver must have network access to the spooling\\nobject storage.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 19]\"}, {\"title\": \"Connector\", \"description\": \"Documentation section: connector\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/connector\"}, \"subpages\": [{\"title\": \"BigQuery connector\", \"description\": null, \"content\": {\"BigQuery Storage API\": \"The Storage API streams data in parallel directly from BigQuery via gRPC without\\nusing Google Cloud Storage as an intermediary.\\nIt has a number of advantages over using the previous export-based read flow\\nthat should generally lead to better read performance:\\n\\n**Direct Streaming**\\n\\n: It does not leave any temporary files in Google Cloud Storage. Rows are read\\ndirectly from BigQuery servers using an Avro wire format.\\n\\n**Column Filtering**\\n\\n: The new API allows column filtering to only read the data you are interested in.\\n[Backed by a columnar datastore](https://cloud.google.com/blog/products/bigquery/inside-capacitor-bigquerys-next-generation-columnar-storage-format),\\nit can efficiently stream data without reading all columns.\\n\\n**Dynamic Sharding**\\n\\n: The API rebalances records between readers until they all complete. This means\\nthat all Map phases will finish nearly concurrently. See this blog article on\\n[how dynamic sharding is similarly used in Google Cloud Dataflow](https://cloud.google.com/blog/products/gcp/no-shard-left-behind-dynamic-work-rebalancing-in-google-cloud-dataflow).\\n\\n(bigquery-requirements)=\", \"Requirements\": \"To connect to BigQuery, you need:\\n\\n['To enable the [BigQuery Storage Read API](https://cloud.google.com/bigquery/docs/reference/storage/#enabling_the_api).', 'Network access from your Trino coordinator and workers to the\\\\nGoogle Cloud API service endpoint. This endpoint uses HTTPS, or port 443.', 'To configure BigQuery so that the Trino coordinator and workers have [permissions\\\\nin BigQuery](https://cloud.google.com/bigquery/docs/reference/storage#permissions).', 'To set up authentication. Your authentication options differ depending on whether\\\\nyou are using Dataproc/Google Compute Engine (GCE) or not.', \\\"**On Dataproc/GCE** the authentication is done from the machine's role.\\\", '**Outside Dataproc/GCE** you have 3 options:', ['Use a service account JSON key and `GOOGLE_APPLICATION_CREDENTIALS` as\\\\ndescribed in the Google Cloud authentication [getting started guide](https://cloud.google.com/docs/authentication/getting-started).', 'Set `bigquery.credentials-key` in the catalog properties file. It should\\\\ncontain the contents of the JSON file, encoded using base64.', 'Set `bigquery.credentials-file` in the catalog properties file. It should\\\\npoint to the location of the JSON file.']]\", \"Configuration\": {\"Multiple GCP projects\": \"The BigQuery connector can only access a single GCP project. If you have\\ndata in multiple GCP projects, you must create several catalogs, each\\npointing to a different GCP project. For example, if you have two GCP projects,\\none for the sales and one for analytics, you can create two properties files in\\n`etc/catalog` named `sales.properties` and `analytics.properties`, both\\nhaving `connector.name=bigquery` but with different `project-id`. This will\\ncreate the two catalogs, `sales` and `analytics` respectively.\\n\\n(bigquery-project-id-resolution)=\", \"Billing and data projects\": \"The BigQuery connector determines the [project\\nID](https://cloud.google.com/resource-manager/docs/creating-managing-projects)\\nto use based on the configuration settings. This behavior provides users with\\nflexibility in selecting both the project to query and the project to bill for\\nBigQuery operations. The following table explains how project IDs are resolved\\nin different scenarios:\\n\\n:::{list-table} Billing and data project ID resolution\\n:widths: 30, 33, 33\\n:header-rows: 1\\n\\n[['Configured properties', 'Billing project', 'Data project'], ['Only `bigquery.credentials-key`', 'The project ID from the credentials key is used for billing.', 'The project ID from the credentials key is used for querying data.'], ['`bigquery.credentials-key` and `bigquery.project-id`', 'The project ID from the credentials key is used for billing.', '`bigquery.project-id` is used for querying data.'], ['`bigquery.credentials-key` and `bigquery.parent-project-id`', '`bigquery.parent-project-id` is used for billing.', 'The project ID from the credentials key is used for querying data.'], ['`bigquery.credentials-key` and `bigquery.parent-project-id`\\\\nand `bigquery.project-id`', '`bigquery.parent-project-id` is used for billing.', '`bigquery.project-id` is used for querying data.\\\\n:::']]\\n\\n(bigquery-arrow-serialization-support)=\", \"Arrow serialization support\": \"This is a feature which introduces support for using Apache Arrow\\nas the serialization format when reading from BigQuery. Add the following\\nrequired, additional JVM argument to the [](jvm-config):\\n\\n```\\n--add-opens=java.base/java.nio=ALL-UNNAMED\\n--sun-misc-unsafe-memory-access=allow\\n```\\n\\n(bigquery-reading-from-views)=\", \"Reading from views\": \"The connector has a preliminary support for reading from [BigQuery views](https://cloud.google.com/bigquery/docs/views-intro). Please note there are\\na few caveats:\\n\\n['Reading from views is disabled by default. In order to enable it, set the\\\\n`bigquery.views-enabled` configuration property to `true`.', 'BigQuery views are not materialized by default, which means that the\\\\nconnector needs to materialize them before it can read them. This process\\\\naffects the read performance.', 'The materialization process can also incur additional costs to your BigQuery bill.', 'By default, the materialized views are created in the same project and\\\\ndataset. Those can be configured by the optional `bigquery.view-materialization-project`\\\\nand `bigquery.view-materialization-dataset` properties, respectively. The\\\\nservice account must have write permission to the project and the dataset in\\\\norder to materialize the view.']\", \"Configuration properties\": \":::{list-table} BigQuery configuration properties\\n:widths: 30, 55, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`bigquery.project-id`', 'The project ID of the Google Cloud account used to store the data,\\\\nsee also [](bigquery-project-id-resolution)', 'Taken from the service account or from `bigquery.parent-project-id`, if set'], ['`bigquery.parent-project-id`', 'The project ID Google Cloud Project to bill for the export,\\\\nsee also [](bigquery-project-id-resolution)', 'Taken from the service account'], ['`bigquery.views-enabled`', 'Enables the connector to read from views and not only tables. Read\\\\n[this section](bigquery-reading-from-views) before enabling this feature.', '`false`'], ['`bigquery.view-expire-duration`', 'Expire duration for the materialized view.', '`24h`'], ['`bigquery.view-materialization-project`', 'The project where the materialized view is going to be created.', \\\"The view's project\\\"], ['`bigquery.view-materialization-dataset`', 'The dataset where the materialized view is going to be created.', \\\"The view's project\\\"], ['`bigquery.skip-view-materialization`', 'Use REST API to access views instead of Storage API. BigQuery `BIGNUMERIC`\\\\nand `TIMESTAMP` types are unsupported.', '`false`'], ['`bigquery.view-materialization-with-filter`', 'Use filter conditions when materializing views.', '`false`'], ['`bigquery.views-cache-ttl`', 'Duration for which the materialization of a view will be cached and reused.\\\\nSet to `0ms` to disable the cache.', '`15m`'], ['`bigquery.metadata.cache-ttl`', 'Duration for which metadata retrieved from BigQuery is cached and reused.\\\\nSet to `0ms` to disable the cache.', '`0ms`'], ['`bigquery.max-read-rows-retries`', 'The number of retries in case of retryable server issues.', '`3`'], ['`bigquery.credentials-key`', 'The base64 encoded credentials key.', 'None. See the [requirements](bigquery-requirements) section'], ['`bigquery.credentials-file`', 'The path to the JSON credentials file.', 'None. See the [requirements](bigquery-requirements) section'], ['`bigquery.case-insensitive-name-matching`', 'Match dataset and table names case-insensitively.', '`false`'], ['`bigquery.case-insensitive-name-matching.cache-ttl`', '[Duration](prop-type-duration) for which case insensitive schema and table\\\\nnames are cached. Set to `0ms` to disable the cache.', '`0ms`'], ['`bigquery.query-results-cache.enabled`', 'Enable [query results cache](https://cloud.google.com/bigquery/docs/cached-results).', '`false`'], ['`bigquery.arrow-serialization.enabled`', 'Enable using Apache Arrow serialization when reading data from BigQuery.\\\\nRead this [section](bigquery-arrow-serialization-support) before using this feature.', '`true`'], ['`bigquery.max-parallelism`', 'The max number of partitions to split the data into. Reduce this number if\\\\nthe default parallelism (number of workers x 3) is too high.'], ['`bigquery.channel-pool.initial-size`', 'The initial size of the connection pool, also known as a channel pool,\\\\nused for gRPC communication.', '`1`'], ['`bigquery.channel-pool.min-size`', 'The minimum number of connections in the connection pool, also known as a\\\\nchannel pool, used for gRPC communication.', '`1`'], ['`bigquery.channel-pool.max-size`', 'The maximum number of connections in the connection pool, also known as a\\\\nchannel pool, used for gRPC communication.', '`1`'], ['`bigquery.channel-pool.min-rpc-per-channel`', 'Threshold to start scaling down the channel pool.\\\\nWhen the average of outstanding RPCs in a single minute drop below this\\\\nthreshold, channels are removed from the pool.', '`0`'], ['`bigquery.channel-pool.max-rpc-per-channel`', 'Threshold to start scaling up the channel pool.\\\\nWhen the average of outstanding RPCs in a single minute surpass this\\\\nthreshold, channels are added to the pool.', '`2147483647`'], ['`bigquery.rpc-retries`', 'The maximum number of retry attempts to perform for the RPC calls.\\\\nIf this value is set to `0`, the value from \\\\n`bigquery.rpc-timeout` is used. \\\\nRetry is deactivated when both `bigquery.rpc-retries` and\\\\n`bigquery.rpc-timeout` are `0`.\\\\nIf this value is positive, and the number of attempts exceeds\\\\n`bigquery.rpc-retries` limit, retries stop even if\\\\nthe total retry time is still lower than `bigquery.rpc-timeout`.', '`0`'], ['`bigquery.rpc-timeout`', 'Timeout [duration](prop-type-duration) on when the retries for the\\\\nRPC call should be given up completely. The higher the timeout, the\\\\nmore retries can be attempted. If this value is `0s`, then\\\\n`bigquery.rpc-retries` is used to determine retries.\\\\nRetry is deactivated when `bigquery.rpc-retries` and \\\\n`bigquery.rpc-timeout` are both `0`. \\\\nIf this value is positive, and the retry duration has reached the timeout\\\\nvalue, retries stop even if the number of attempts is lower than \\\\nthe `bigquery.rpc-retries` value.', '`0s`'], ['`bigquery.rpc-retry-delay`', 'The delay [duration](prop-type-duration) before the first retry attempt\\\\nfor RPC calls.', '`0s`'], ['`bigquery.rpc-retry-delay-multiplier`', 'Controls the change in delay before the next retry.\\\\nThe retry delay of the previous call is multiplied by the\\\\n`bigquery.rpc-retry-delay-multiplier` to calculate the retry delay\\\\nfor the next RPC call.', '`1.0`'], ['`bigquery.rpc-proxy.enabled`', 'Use a proxy for communication with BigQuery.', '`false`'], ['`bigquery.rpc-proxy.uri`', 'Proxy URI to use if connecting through a proxy.'], ['`bigquery.rpc-proxy.username`', 'Proxy username to use if connecting through a proxy.'], ['`bigquery.rpc-proxy.password`', 'Proxy password to use if connecting through a proxy.'], ['`bigquery.rpc-proxy.keystore-path`', 'Keystore containing client certificates to present to proxy if connecting\\\\nthrough a proxy. Only required if proxy uses mutual TLS.'], ['`bigquery.rpc-proxy.keystore-password`', 'Password of the keystore specified by `bigquery.rpc-proxy.keystore-path`.'], ['`bigquery.rpc-proxy.truststore-path`', 'Truststore containing certificates of the proxy server if connecting\\\\nthrough a proxy.'], ['`bigquery.rpc-proxy.truststore-password`', 'Password of the truststore specified by `bigquery.rpc-proxy.truststore-path`.']]\\n\\n:::\\n\\n(bigquery-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\\n\\n(bigquery-type-mapping)=\"}, \"Type mapping\": {\"BigQuery type to Trino type mapping\": \"The connector maps BigQuery types to the corresponding Trino types according\\nto the following table:\\n\\n:::{list-table} BigQuery type to Trino type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['BigQuery type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INT64`', '`BIGINT`', '`INT`, `SMALLINT`, `INTEGER`, `BIGINT`, `TINYINT`, and `BYTEINT` are aliases\\\\nfor `INT64` in BigQuery.'], ['`FLOAT64`', '`DOUBLE`'], ['`NUMERIC`', '`DECIMAL(P,S)`', 'The default precision and scale of `NUMERIC` is `(38, 9)`.'], ['`BIGNUMERIC`', '`DECIMAL(P,S)`', 'Precision > 38 is not supported. The default precision and scale of\\\\n`BIGNUMERIC` is `(77, 38)`.'], ['`DATE`', '`DATE`'], ['`DATETIME`', '`TIMESTAMP(6)`'], ['`STRING`', '`VARCHAR`'], ['`BYTES`', '`VARBINARY`'], ['`TIME`', '`TIME(6)`'], ['`TIMESTAMP`', '`TIMESTAMP(6) WITH TIME ZONE`', 'Time zone is UTC'], ['`GEOGRAPHY`', '`VARCHAR`', 'In [Well-known text\\\\n(WKT)](https://wikipedia.org/wiki/Well-known_text_representation_of_geometry)\\\\nformat'], ['`JSON`', '`JSON`'], ['`ARRAY`', '`ARRAY`'], ['`RECORD`', '`ROW`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type to BigQuery type mapping\": \"The connector maps Trino types to the corresponding BigQuery types according\\nto the following table:\\n\\n:::{list-table} Trino type to BigQuery type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['Trino type', 'BigQuery type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`VARBINARY`', '`BYTES`'], ['`DATE`', '`DATE`'], ['`DOUBLE`', '`FLOAT`'], ['`BIGINT`', '`INT64`', '`INT`, `SMALLINT`, `INTEGER`, `BIGINT`, `TINYINT`, and\\\\n`BYTEINT` are aliases for `INT64` in BigQuery.'], ['`DECIMAL(P,S)`', '`NUMERIC`', 'The default precision and scale of `NUMERIC` is `(38, 9)`.'], ['`VARCHAR`', '`STRING`'], ['`TIMESTAMP(6)`', '`DATETIME`']]\\n\\n:::\\n\\nNo other types are supported.\"}, \"System tables\": \"For each Trino table which maps to BigQuery view there exists a system table\\nwhich exposes BigQuery view definition. Given a BigQuery view `example_view`\\nyou can send query `SELECT * example_view$view_definition` to see the SQL\\nwhich defines view in BigQuery.\\n\\n(bigquery-special-columns)=\", \"Special columns\": \"In addition to the defined columns, the BigQuery connector exposes\\npartition information in a number of hidden columns:\\n\\n['`$partition_date`: Equivalent to `_PARTITIONDATE` pseudo-column in BigQuery', '`$partition_time`: Equivalent to `_PARTITIONTIME` pseudo-column in BigQuery']\\n\\nYou can use these columns in your SQL statements like any other column. They\\ncan be selected directly, or used in conditional statements. For example, you\\ncan inspect the partition date and time for each record:\\n\\n```\\nSELECT *, \\\"$partition_date\\\", \\\"$partition_time\\\"\\nFROM example.web.page_views;\\n```\\n\\nRetrieve all records stored in the partition `_PARTITIONDATE = '2022-04-07'`:\\n\\n```\\nSELECT *\\nFROM example.web.page_views\\nWHERE \\\"$partition_date\\\" = date '2022-04-07';\\n```\\n\\n:::{note}\\nTwo special partitions `__NULL__` and `__UNPARTITIONED__` are not supported.\\n:::\\n\\n(bigquery-sql-support)=\", \"SQL support\": {\"Wildcard table\": \"The connector provides support to query multiple tables using a concise\\n[wildcard table](https://cloud.google.com/bigquery/docs/querying-wildcard-tables)\\nnotation.\\n\\n```\\nSELECT *\\nFROM example.web.\\\"page_views_*\\\";\\n```\", \"Procedures\": \"```\\n```\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying BigQuery directly. It\\nrequires syntax native to BigQuery, because the full query is pushed down and\\nprocessed by BigQuery. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nFor example, query the `example` catalog and group and concatenate all\\nemployee IDs by manager ID:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n manager_id, STRING_AGG(employee_id)\\n FROM\\n company.employees\\n GROUP BY\\n manager_id'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['[](limit-pushdown) for access to tables and other objects when using the REST\\\\nAPI to reduce CPU consumption in BigQuery and performance overall. Pushdown is\\\\nnot supported by the Storage API, used for the more common Trino-managed\\\\ntables, and therefore not used for access with it.']\"}, \"FAQ\": {\"What is the Pricing for the Storage API?\": \"See the [BigQuery pricing documentation](https://cloud.google.com/bigquery/pricing#storage-api).\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 0]\"}, {\"title\": \"Black Hole connector\", \"description\": null, \"content\": {\"Configuration\": \"Create `etc/catalog/example.properties` to mount the `blackhole` connector\\nas the `example` catalog, with the following contents:\\n\\n```\\nconnector.name=blackhole\\n```\", \"Examples\": \"Create a table using the blackhole connector:\\n\\n```\\nCREATE TABLE example.test.nation AS\\nSELECT * from tpch.tiny.nation;\\n```\\n\\nInsert data into a table in the blackhole connector:\\n\\n```\\nINSERT INTO example.test.nation\\nSELECT * FROM tpch.tiny.nation;\\n```\\n\\nSelect from the blackhole connector:\\n\\n```\\nSELECT count(*) FROM example.test.nation;\\n```\\n\\nThe above query always returns zero.\\n\\nCreate a table with a constant number of rows (500 * 1000 * 2000):\\n\\n```\\nCREATE TABLE example.test.nation (\\n nationkey BIGINT,\\n name VARCHAR\\n)\\nWITH (\\n split_count = 500,\\n pages_per_split = 1000,\\n rows_per_page = 2000\\n);\\n```\\n\\nNow query it:\\n\\n```\\nSELECT count(*) FROM example.test.nation;\\n```\\n\\nThe above query returns 1,000,000,000.\\n\\nLength of variable length columns can be controlled using the `field_length`\\ntable property (default value is equal to 16):\\n\\n```\\nCREATE TABLE example.test.nation (\\n nationkey BIGINT,\\n name VARCHAR\\n)\\nWITH (\\n split_count = 500,\\n pages_per_split = 1000,\\n rows_per_page = 2000,\\n field_length = 100\\n);\\n```\\n\\nThe consuming and producing rate can be slowed down\\nusing the `page_processing_delay` table property.\\nSetting this property to `5s` leads to a 5 second\\ndelay before consuming or producing a new page:\\n\\n```\\nCREATE TABLE example.test.delay (\\n dummy BIGINT\\n)\\nWITH (\\n split_count = 1,\\n pages_per_split = 1,\\n rows_per_page = 1,\\n page_processing_delay = '5s'\\n);\\n```\\n\\n(blackhole-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>`,\\n{ref}`read operation <sql-read-operations>`, and supports the following\\nadditional features:\\n\\n['{doc}`/sql/insert`', '{doc}`/sql/update`', '{doc}`/sql/delete`', '{doc}`/sql/merge`', '{doc}`/sql/create-table`', '{doc}`/sql/create-table-as`', '{doc}`/sql/show-create-table`', '{doc}`/sql/drop-table`', '{doc}`/sql/alter-table`', '{doc}`/sql/comment`', '{doc}`/sql/create-schema`', '{doc}`/sql/drop-schema`', '{doc}`/sql/create-view`', '{doc}`/sql/show-create-view`', '{doc}`/sql/drop-view`']\\n\\n:::{note}\\nThe connector discards all written data. While read operations are supported,\\nthey return rows with all NULL values, with the number of rows controlled\\nvia table properties.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 1]\"}, {\"title\": \"Cassandra connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Cassandra, you need:\\n\\n['Cassandra version 3.0 or higher.', 'Network access from the Trino coordinator and workers to Cassandra.\\\\nPort 9042 is the default port.']\", \"Configuration\": {\"Multiple Cassandra clusters\": \"You can have as many catalogs as you need, so if you have additional\\nCassandra clusters, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For\\nexample, if you name the property file `sales.properties`, Trino\\ncreates a catalog named `sales` using the configured connector.\"}, \"Configuration properties\": \"The following configuration properties are available:\\n\\n| Property name | Description |\\n| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `cassandra.contact-points` | Comma-separated list of hosts in a Cassandra cluster. The Cassandra driver uses these contact points to discover cluster topology. At least one Cassandra host is required. |\\n| `cassandra.native-protocol-port` | The Cassandra server port running the native client protocol, defaults to `9042`. |\\n| `cassandra.consistency-level` | Consistency levels in Cassandra refer to the level of consistency to be used for both read and write operations. More information about consistency levels can be found in the [Cassandra consistency] documentation. This property defaults to a consistency level of `ONE`. Possible values include `ALL`, `EACH_QUORUM`, `QUORUM`, `LOCAL_QUORUM`, `ONE`, `TWO`, `THREE`, `LOCAL_ONE`, `ANY`, `SERIAL`, `LOCAL_SERIAL`. |\\n| `cassandra.allow-drop-table` | Enables {doc}`/sql/drop-table` operations. Defaults to `false`. |\\n| `cassandra.security` | Configure authentication to Cassandra. Defaults to `NONE`. Set to `PASSWORD` for basic authentication, and configure `cassandra.username` and `cassandra.password`. |\\n| `cassandra.username` | Username used for authentication to the Cassandra cluster. Requires `cassandra.security=PASSWORD`. This is a global setting used for all connections, regardless of the user connected to Trino. |\\n| `cassandra.password` | Password used for authentication to the Cassandra cluster. Requires `cassandra.security=PASSWORD`. This is a global setting used for all connections, regardless of the user connected to Trino. |\\n| `cassandra.protocol-version` | It is possible to override the protocol version for older Cassandra clusters. By default, the value corresponds to the default protocol version used in the underlying Cassandra java driver. Possible values include `V3`, `V4`, `V5`, `V6`. |\\n\\n:::{note}\\nIf authorization is enabled, `cassandra.username` must have enough permissions to perform `SELECT` queries on\\nthe `system.size_estimates` table.\\n:::\\n\\nThe following advanced configuration properties are available:\\n\\n| Property name | Description |\\n| ---------------------------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\\n| `cassandra.fetch-size` | Number of rows fetched at a time in a Cassandra query. |\\n| `cassandra.partition-size-for-batch-select` | Number of partitions batched together into a single select for a single partition key column table. |\\n| `cassandra.split-size` | Number of keys per split when querying Cassandra. |\\n| `cassandra.splits-per-node` | Number of splits per node. By default, the values from the `system.size_estimates` table are used. Only override when connecting to Cassandra versions \\\\< 2.1.5, which lacks the `system.size_estimates` table. |\\n| `cassandra.batch-size` | Maximum number of statements to execute in one batch. |\\n| `cassandra.client.read-timeout` | Maximum time the Cassandra driver waits for an answer to a query from one Cassandra node. Note that the underlying Cassandra driver may retry a query against more than one node in the event of a read timeout. Increasing this may help with queries that use an index. |\\n| `cassandra.client.connect-timeout` | Maximum time the Cassandra driver waits to establish a connection to a Cassandra node. Increasing this may help with heavily loaded Cassandra clusters. |\\n| `cassandra.client.so-linger` | Number of seconds to linger on close if unsent data is queued. If set to zero, the socket will be closed immediately. When this option is non-zero, a socket lingers that many seconds for an acknowledgement that all data was written to a peer. This option can be used to avoid consuming sockets on a Cassandra server by immediately closing connections when they are no longer needed. |\\n| `cassandra.retry-policy` | Policy used to retry failed requests to Cassandra. This property defaults to `DEFAULT`. Using `BACKOFF` may help when queries fail with *\\\"not enough replicas\\\"*. The other possible values are `DOWNGRADING_CONSISTENCY` and `FALLTHROUGH`. |\\n| `cassandra.load-policy.use-dc-aware` | Set to `true` if the load balancing policy requires a local datacenter, defaults to `true`. |\\n| `cassandra.load-policy.dc-aware.local-dc` | The name of the datacenter considered \\\"local\\\". |\\n| `cassandra.load-policy.dc-aware.used-hosts-per-remote-dc` | Uses the provided number of host per remote datacenter as failover for the local hosts for `DefaultLoadBalancingPolicy`. |\\n| `cassandra.load-policy.dc-aware.allow-remote-dc-for-local` | Set to `true` to allow to use hosts of remote datacenter for local consistency level. |\\n| `cassandra.no-host-available-retry-timeout` | Retry timeout for `AllNodesFailedException`, defaults to `1m`. |\\n| `cassandra.speculative-execution.limit` | The number of speculative executions. This is disabled by default. |\\n| `cassandra.speculative-execution.delay` | The delay between each speculative execution, defaults to `500ms`. |\\n| `cassandra.tls.enabled` | Whether TLS security is enabled, defaults to `false`. |\\n| `cassandra.tls.keystore-path` | Path to the {doc}`PEM </security/inspect-pem>` or {doc}`JKS </security/inspect-jks>` key store file. |\\n| `cassandra.tls.truststore-path` | Path to the {doc}`PEM </security/inspect-pem>` or {doc}`JKS </security/inspect-jks>` trust store file. |\\n| `cassandra.tls.keystore-password` | Password for the key store. |\\n| `cassandra.tls.truststore-password` | Password for the trust store. |\", \"Querying Cassandra tables\": \"The `users` table is an example Cassandra table from the Cassandra\\n[Getting Started] guide. It can be created along with the `example_keyspace`\\nkeyspace using Cassandra's cqlsh (CQL interactive terminal):\\n\\n```\\ncqlsh> CREATE KEYSPACE example_keyspace\\n ... WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };\\ncqlsh> USE example_keyspace;\\ncqlsh:example_keyspace> CREATE TABLE users (\\n ... user_id int PRIMARY KEY,\\n ... fname text,\\n ... lname text\\n ... );\\n```\\n\\nThis table can be described in Trino:\\n\\n```\\nDESCRIBE example.example_keyspace.users;\\n```\\n\\n```\\n Column | Type | Extra | Comment\\n---------+---------+-------+---------\\n user_id | bigint | |\\n fname | varchar | |\\n lname | varchar | |\\n(3 rows)\\n```\\n\\nThis table can then be queried in Trino:\\n\\n```\\nSELECT * FROM example.example_keyspace.users;\\n```\\n\\n(cassandra-type-mapping)=\", \"Type mapping\": {\"Cassandra type to Trino type mapping\": \"The connector maps Cassandra types to the corresponding Trino types according to\\nthe following table:\\n\\n:::{list-table} Cassandra type to Trino type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Cassandra type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INT`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL`', '`DOUBLE`'], ['`ASCII`', '`VARCHAR`', 'US-ASCII character string'], ['`TEXT`', '`VARCHAR`', 'UTF-8 encoded string'], ['`VARCHAR`', '`VARCHAR`', 'UTF-8 encoded string'], ['`VARINT`', '`VARCHAR`', 'Arbitrary-precision integer'], ['`BLOB`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIME`', '`TIME(9)`'], ['`TIMESTAMP`', '`TIMESTAMP(3) WITH TIME ZONE`'], ['`LIST<?>`', '`VARCHAR`'], ['`MAP<?, ?>`', '`VARCHAR`'], ['`SET<?>`', '`VARCHAR`'], ['`TUPLE`', '`ROW` with anonymous fields'], ['`UDT`', '`ROW` with field names'], ['`INET`', '`IPADDRESS`'], ['`UUID`', '`UUID`'], ['`TIMEUUID`', '`UUID`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type to Cassandra type mapping\": \"The connector maps Trino types to the corresponding Cassandra types according to\\nthe following table:\\n\\n:::{list-table} Trino type to Cassandra type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Trino type', 'Cassandra type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INT`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`FLOAT`'], ['`DOUBLE`', '`DOUBLE`'], ['`VARCHAR`', '`TEXT`'], ['`DATE`', '`DATE`'], ['`TIMESTAMP(3) WITH TIME ZONE`', '`TIMESTAMP`'], ['`IPADDRESS`', '`INET`'], ['`UUID`', '`UUID`']]\\n\\n:::\\n\\nNo other types are supported.\"}, \"Partition key types\": \"Partition keys can only be of the following types:\\n\\n['ASCII', 'TEXT', 'VARCHAR', 'BIGINT', 'BOOLEAN', 'DOUBLE', 'INET', 'INT', 'FLOAT', 'DECIMAL', 'TIMESTAMP', 'UUID', 'TIMEUUID']\", \"Limitations\": [\"Queries without filters containing the partition key result in fetching all partitions.\\nThis causes a full scan of the entire data set, and is therefore much slower compared to a similar\\nquery with a partition key as a filter.\", \"`IN` list filters are only allowed on index (that is, partition key or clustering key) columns.\", \"Range (`<` or `>` and `BETWEEN`) filters can be applied only to the partition keys.\"], \"SQL support\": {\"Procedures\": \"```\\n```\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying Cassandra directly. It\\nrequires syntax native to Cassandra, because the full query is pushed down and\\nprocessed by Cassandra. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nAs a simple example, to select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\"}, \"DROP TABLE\": \"By default, `DROP TABLE` operations are disabled on Cassandra catalogs. To\\nenable `DROP TABLE`, set the `cassandra.allow-drop-table` catalog\\nconfiguration property to `true`:\\n\\n```\\ncassandra.allow-drop-table=true\\n```\\n\\n(sql-delete-limitation)=\", \"SQL delete limitation\": \"`DELETE` is only supported if the `WHERE` clause matches entire partitions.\\n\\n[cassandra consistency]: https://docs.datastax.com/en/cassandra-oss/2.2/cassandra/dml/dmlConfigConsistency.html\\n[getting started]: https://cassandra.apache.org/doc/latest/cassandra/getting_started/index.html\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 2]\"}, {\"title\": \"ClickHouse connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to a ClickHouse server, you need:\\n\\n['ClickHouse (version 24.3 or higher) or Altinity (version 22.3 or higher).', 'Network access from the Trino coordinator and workers to the ClickHouse\\\\nserver. Port 8123 is the default port.']\", \"Configuration\": {\"Connection security\": \"If you have TLS configured with a globally-trusted certificate installed on your\\ndata source, you can enable TLS between your cluster and the data\\nsource by appending a parameter to the JDBC connection string set in the\\n`connection-url` catalog configuration property.\\n\\nFor example, with version 2.6.4 of the ClickHouse JDBC driver, enable TLS by\\nappending the `ssl=true` parameter to the `connection-url` configuration\\nproperty:\\n\\n```\\nconnection-url=jdbc:clickhouse://host1:8443/?ssl=true\\n```\\n\\nFor more information on TLS configuration options, see the [Clickhouse JDBC\\ndriver documentation](https://clickhouse.com/docs/en/interfaces/jdbc/)\\n\\n```\\n```\", \"Multiple ClickHouse servers\": \"If you have multiple ClickHouse servers you need to configure one\\ncatalog for each server. To add another catalog:\\n\\n['Add another properties file to `etc/catalog`', 'Save it with a different name that ends in `.properties`']\\n\\nFor example, if you name the property file `sales.properties`, Trino uses the\\nconfigured connector to create a catalog named `sales`.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\"}, \"Querying ClickHouse\": \"The ClickHouse connector provides a schema for every ClickHouse *database*.\\nRun `SHOW SCHEMAS` to see the available ClickHouse databases:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a ClickHouse database named `web`, run `SHOW TABLES` to view the\\ntables in this database:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nRun `DESCRIBE` or `SHOW COLUMNS` to list the columns in the `clicks` table\\nin the `web` databases:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nRun `SELECT` to access the `clicks` table in the `web` database:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\n:::{note}\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n:::\", \"Table properties\": \"Table property usage example:\\n\\n```\\nCREATE TABLE default.trino_ck (\\n id int NOT NULL,\\n birthday DATE NOT NULL,\\n name VARCHAR,\\n age BIGINT,\\n logdate DATE NOT NULL\\n)\\nWITH (\\n engine = 'MergeTree',\\n order_by = ARRAY['id', 'birthday'],\\n partition_by = ARRAY['toYYYYMM(logdate)'],\\n primary_key = ARRAY['id'],\\n sample_by = 'id'\\n);\\n```\\n\\nThe following are supported ClickHouse table properties from [https://clickhouse.tech/docs/en/engines/table-engines/mergetree-family/mergetree/](https://clickhouse.tech/docs/en/engines/table-engines/mergetree-family/mergetree/)\\n\\n| Property name | Default value | Description |\\n| -------------- | ------------- |----------------------------------------------------------------------------------------------------------------------------------------|\\n| `engine` | `Log` | Name and parameters of the engine. |\\n| `order_by` | (none) | Array of columns or expressions to concatenate to create the sorting key. `tuple()` is used by default if `order_by is` not specified. |\\n| `partition_by` | (none) | Array of columns or expressions to use as nested partition keys. Optional. |\\n| `primary_key` | (none) | Array of columns or expressions to concatenate to create the primary key. Optional. |\\n| `sample_by` | (none) | An expression to use for [sampling](https://clickhouse.tech/docs/en/sql-reference/statements/select/sample/). Optional. |\\n\\nCurrently the connector only supports `Log` and `MergeTree` table engines\\nin create table statement. `ReplicatedMergeTree` engine is not yet supported.\\n\\n(clickhouse-type-mapping)=\", \"Type mapping\": {\"ClickHouse type to Trino type mapping\": \"The connector maps ClickHouse types to the corresponding Trino types according\\nto the following table:\\n\\n:::{list-table} ClickHouse type to Trino type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['ClickHouse type', 'Trino type', 'Notes'], ['`Bool`', '`BOOLEAN`'], ['`Int8`', '`TINYINT`', '`TINYINT` and `INT1` are aliases of `Int8`'], ['`Int16`', '`SMALLINT`', '`SMALLINT` and `INT2` are aliases of `Int16`'], ['`Int32`', '`INTEGER`', '`INT`, `INT4`, and `INTEGER` are aliases of `Int32`'], ['`Int64`', '`BIGINT`', '`BIGINT` is an alias of `Int64`'], ['`UInt8`', '`SMALLINT`'], ['`UInt16`', '`INTEGER`'], ['`UInt32`', '`BIGINT`'], ['`UInt64`', '`DECIMAL(20,0)`'], ['`Float32`', '`REAL`', '`FLOAT` is an alias of `Float32`'], ['`Float64`', '`DOUBLE`', '`DOUBLE` is an alias of `Float64`'], ['`Decimal`', '`DECIMAL`'], ['`FixedString`', '`VARBINARY`', 'Enabling `clickhouse.map-string-as-varchar` config property changes the\\\\nmapping to `VARCHAR`'], ['`String`', '`VARBINARY`', 'Enabling `clickhouse.map-string-as-varchar` config property changes the\\\\nmapping to `VARCHAR`'], ['`Date`', '`DATE`'], ['`DateTime[(timezone)]`', '`TIMESTAMP(0) [WITH TIME ZONE]`'], ['`IPv4`', '`IPADDRESS`'], ['`IPv6`', '`IPADDRESS`'], ['`Enum8`', '`VARCHAR`'], ['`Enum16`', '`VARCHAR`'], ['`UUID`', '`UUID`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type to ClickHouse type mapping\": \"The connector maps Trino types to the corresponding ClickHouse types according\\nto the following table:\\n\\n:::{list-table} Trino type to ClickHouse type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Trino type', 'ClickHouse type', 'Notes'], ['`BOOLEAN`', '`Bool`'], ['`TINYINT`', '`Int8`', '`TINYINT` and `INT1` are aliases of `Int8`'], ['`SMALLINT`', '`Int16`', '`SMALLINT` and `INT2` are aliases of `Int16`'], ['`INTEGER`', '`Int32`', '`INT`, `INT4`, and `INTEGER` are aliases of `Int32`'], ['`BIGINT`', '`Int64`', '`BIGINT` is an alias of `Int64`'], ['`REAL`', '`Float32`', '`FLOAT` is an alias of `Float32`'], ['`DOUBLE`', '`Float64`', '`DOUBLE` is an alias of `Float64`'], ['`DECIMAL(p,s)`', '`Decimal(p,s)`'], ['`VARCHAR`', '`String`'], ['`CHAR`', '`String`'], ['`VARBINARY`', '`String`', 'Enabling `clickhouse.map-string-as-varchar` config property changes the\\\\nmapping to `VARCHAR`'], ['`DATE`', '`Date`'], ['`TIMESTAMP(0)`', '`DateTime`'], ['`UUID`', '`UUID`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n```\\n```\\n\\n(clickhouse-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(clickhouse-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to ClickHouse, because the full query is pushed down and\\nprocessed in ClickHouse. This can be useful for accessing native features which\\nare not available in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`limit-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`']\\n\\n```\\n```\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`1000`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 3]\"}, {\"title\": \"Delta Lake connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Databricks Delta Lake, you need:\\n\\n['Tables written by Databricks Runtime 7.3 LTS, 9.1 LTS, 10.4 LTS, 11.3 LTS,\\\\n12.2 LTS, 13.3 LTS, 14.3 LTS, 15.4 LTS and 16.4 LTS are supported.', 'Deployments using AWS, HDFS, Azure Storage, and Google Cloud Storage (GCS) are\\\\nfully supported.', 'Network access from the coordinator and workers to the Delta Lake storage.', 'Access to the Hive metastore service (HMS) of Delta Lake or a separate HMS,\\\\nor a Glue metastore.', 'Network access to the HMS from the coordinator and workers. Port 9083 is the\\\\ndefault port for the Thrift protocol used by the HMS.', 'Data files stored in the [Parquet file format](parquet-format-configuration)\\\\non a [supported file system](delta-lake-file-system-configuration).']\", \"General configuration\": \"To configure the Delta Lake connector, create a catalog properties file\\n`etc/catalog/example.properties` that references the `delta_lake` connector.\\n\\nYou must configure a [metastore for metadata](/object-storage/metastores).\\n\\nYou must select and configure one of the [supported file\\nsystems](delta-lake-file-system-configuration).\\n\\n```\\nconnector.name=delta_lake\\nhive.metastore.uri=thrift://example.net:9083\\nfs.x.enabled=true\\n```\\n\\nReplace the `fs.x.enabled` configuration property with the desired file system.\\n\\nIf you are using {ref}`AWS Glue <hive-glue-metastore>` as your metastore, you\\nmust instead set `hive.metastore` to `glue`:\\n\\n```\\nconnector.name=delta_lake\\nhive.metastore=glue\\n```\\n\\nEach metastore type has specific configuration properties along with\\n{ref}`general metastore configuration properties <general-metastore-properties>`.\\n\\nThe connector recognizes Delta Lake tables created in the metastore by the Databricks\\nruntime. If non-Delta Lake tables are present in the metastore as well, they are not\\nvisible to the connector.\\n\\n(delta-lake-file-system-configuration)=\", \"File system access configuration\": {\"Delta Lake general configuration properties\": \"The following configuration properties are all using reasonable, tested default\\nvalues. Typical usage does not require you to configure them.\\n\\n:::{list-table} Delta Lake configuration properties\\n:widths: 30, 55, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`delta.metadata.cache-ttl`', 'Caching duration for Delta Lake tables metadata.', '`30m`'], ['`delta.metadata.cache-max-retained-size`', 'Maximum retained size of Delta table metadata stored in cache. Must be\\\\nspecified in [](prop-type-data-size) values such as `64MB`. Default is\\\\ncalculated to 5% of the maximum memory allocated to the JVM.'], ['`delta.metadata.live-files.cache-size`', 'Amount of memory allocated for caching information about files. Must be\\\\nspecified in [](prop-type-data-size) values such as `64MB`. Default is\\\\ncalculated to 10% of the maximum memory allocated to the JVM.'], ['`delta.metadata.live-files.cache-ttl`', 'Caching duration for active files that correspond to the Delta Lake tables.', '`30m`'], ['`delta.compression-codec`', 'The compression codec to be used when writing new data files. Possible\\\\nvalues are:', ['`NONE`', '`SNAPPY`', '`ZSTD`', '`GZIP`'], 'The equivalent catalog session property is `compression_codec`.', '`ZSTD`'], ['`delta.max-partitions-per-writer`', 'Maximum number of partitions per writer.', '`100`'], ['`delta.hide-non-delta-lake-tables`', 'Hide information about tables that are not managed by Delta Lake. Hiding\\\\nonly applies to tables with the metadata managed in a Glue catalog, and does\\\\nnot apply to usage with a Hive metastore service.', '`false`'], ['`delta.enable-non-concurrent-writes`', 'Enable [write support](delta-lake-data-management) for all supported file\\\\nsystems. Specifically, take note of the warning about concurrency and\\\\ncheckpoints.', '`false`'], ['`delta.default-checkpoint-writing-interval`', 'Default integer count to write transaction log checkpoint entries. If the\\\\nvalue is set to N, then checkpoints are written after every Nth statement\\\\nperforming table writes. The value can be overridden for a specific table\\\\nwith the `checkpoint_interval` table property.', '`10`'], ['`delta.hive-catalog-name`', 'Name of the catalog to which `SELECT` queries are redirected when a\\\\nHive table is detected.'], ['`delta.checkpoint-row-statistics-writing.enabled`', 'Enable writing row statistics to checkpoint files.', '`true`'], ['`delta.checkpoint-filtering.enabled`', 'Enable pruning of data file entries as well as data file statistics columns\\\\nwhich are irrelevant for the query when reading Delta Lake checkpoint files.\\\\nReading only the relevant active file data from the checkpoint, directly\\\\nfrom the storage, instead of relying on the active files caching, likely\\\\nresults in decreased memory pressure on the coordinator. The equivalent\\\\ncatalog session property is `checkpoint_filtering_enabled`.', '`true`'], ['`delta.dynamic-filtering.wait-timeout`', 'Duration to wait for completion of [dynamic\\\\nfiltering](/admin/dynamic-filtering) during split generation. The equivalent\\\\ncatalog session property is `dynamic_filtering_wait_timeout`.'], ['`delta.table-statistics-enabled`', 'Enables [Table statistics](delta-lake-table-statistics) for performance\\\\nimprovements. The equivalent catalog session property is\\\\n`statistics_enabled`.', '`true`'], ['`delta.extended-statistics.enabled`', 'Enable statistics collection with [](/sql/analyze) and use of extended\\\\nstatistics. The equivalent catalog session property is\\\\n`extended_statistics_enabled`.', '`true`'], ['`delta.extended-statistics.collect-on-write`', 'Enable collection of extended statistics for write operations. The\\\\nequivalent catalog session property is\\\\n`extended_statistics_collect_on_write`.', '`true`'], ['`delta.per-transaction-metastore-cache-maximum-size`', 'Maximum number of metastore data objects per transaction in the Hive\\\\nmetastore cache.', '`1000`'], ['`delta.metastore.store-table-metadata`', 'Store table comments and colum definitions in the metastore. The write\\\\npermission is required to update the metastore.', '`false`'], ['`delta.metastore.store-table-metadata-threads`', 'Number of threads used for storing table metadata in metastore.', '`5`'], ['`delta.delete-schema-locations-fallback`', \\\"Whether schema locations are deleted when Trino can't determine whether they\\\\ncontain external files.\\\", '`false`'], ['`delta.parquet.time-zone`', 'Time zone for Parquet read and write.', 'JVM default'], ['`delta.target-max-file-size`', 'Target maximum size of written files; the actual size could be larger. The\\\\nequivalent catalog session property is `target_max_file_size`.', '`1GB`'], ['`delta.unique-table-location`', 'Use randomized, unique table locations.', '`true`'], ['`delta.register-table-procedure.enabled`', 'Enable to allow users to call the [`register_table` procedure](delta-lake-register-table).', '`false`'], ['`delta.vacuum.min-retention`', 'Minimum retention threshold for the files taken into account for removal by\\\\nthe [VACUUM](delta-lake-vacuum) procedure. The equivalent catalog session\\\\nproperty is `vacuum_min_retention`.', '`7 DAYS`'], ['`delta.deletion-vectors-enabled`', 'Set to `true` for enabling deletion vectors by default when creating new tables.', '`false`'], ['`delta.metadata.parallelism`', 'Number of threads used for retrieving metadata. Currently, only table loading \\\\nis parallelized.', '`8`'], ['`delta.checkpoint-processing.parallelism`', \\\"Number of threads used for retrieving checkpoint files of each table. Currently, only \\\\nretrievals of V2 Checkpoint's sidecar files are parallelized.\\\", '`4`\\\\n:::']]\", \"Catalog session properties\": \"The following table describes {ref}`catalog session properties\\n<session-properties-definition>` supported by the Delta Lake connector:\\n\\n:::{list-table} Catalog session properties\\n:widths: 40, 60, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`parquet_max_read_block_size`', 'The maximum block size used when reading Parquet files.', '`16MB`'], ['`parquet_writer_block_size`', 'The maximum block size created by the Parquet writer.', '`128MB`'], ['`parquet_writer_page_size`', 'The maximum page size created by the Parquet writer.', '`1MB`'], ['`parquet_writer_page_value_count`', 'The maximum value count of pages created by the Parquet writer.', '`60000`'], ['`parquet_writer_batch_size`', 'Maximum number of rows processed by the Parquet writer in a batch.', '`10000`'], ['`projection_pushdown_enabled`', 'Read only projected fields from row columns while performing `SELECT`\\\\nqueries.', '`true`\\\\n:::']]\\n\\n(delta-lake-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\\n\\n(delta-lake-type-mapping)=\"}, \"Type mapping\": {\"Delta Lake to Trino type mapping\": \"The connector maps Delta Lake types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} Delta Lake to Trino type mapping\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Delta Lake type', 'Trino type'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INTEGER`', '`INTEGER`'], ['`BYTE`', '`TINYINT`'], ['`SHORT`', '`SMALLINT`'], ['`LONG`', '`BIGINT`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`STRING`', '`VARCHAR`'], ['`BINARY`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIMESTAMPNTZ` (`TIMESTAMP_NTZ`)', '`TIMESTAMP(6)`'], ['`TIMESTAMP`', '`TIMESTAMP(3) WITH TIME ZONE`'], ['`ARRAY`', '`ARRAY`'], ['`MAP`', '`MAP`'], ['`STRUCT(...)`', '`ROW(...)`\\\\n:::']]\\n\\nNo other types are supported.\", \"Trino to Delta Lake type mapping\": \"The connector maps Trino types to the corresponding Delta Lake types following\\nthis table:\\n\\n:::{list-table} Trino to Delta Lake type mapping\\n:widths: 60, 40\\n:header-rows: 1\\n\\n[['Trino type', 'Delta Lake type'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INTEGER`', '`INTEGER`'], ['`TINYINT`', '`BYTE`'], ['`SMALLINT`', '`SHORT`'], ['`BIGINT`', '`LONG`'], ['`REAL`', '`FLOAT`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`VARCHAR`', '`STRING`'], ['`VARBINARY`', '`BINARY`'], ['`DATE`', '`DATE`'], ['`TIMESTAMP`', '`TIMESTAMPNTZ` (`TIMESTAMP_NTZ`)'], ['`TIMESTAMP(3) WITH TIME ZONE`', '`TIMESTAMP`'], ['`ARRAY`', '`ARRAY`'], ['`MAP`', '`MAP`'], ['`ROW(...)`', '`STRUCT(...)`\\\\n:::']]\\n\\nNo other types are supported.\"}, \"Delta Lake table features\": \"The connector supports the following [Delta Lake table\\nfeatures](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#table-features):\\n\\n:::{list-table} Table features\\n:widths: 70, 30\\n:header-rows: 1\\n\\n[['Feature', 'Description'], ['Append-only tables', 'Writers only'], ['Column invariants', 'Writers only'], ['CHECK constraints', 'Writers only'], ['Change data feed', 'Writers only'], ['Column mapping', 'Readers and writers'], ['Deletion vectors', 'Readers and writers'], ['Iceberg compatibility V1 & V2', 'Readers only'], ['Invariants', 'Writers only'], ['Timestamp without time zone', 'Readers and writers'], ['Type widening', 'Readers only'], ['Vacuum protocol check', 'Readers and writers'], ['V2 checkpoint', 'Readers only\\\\n:::']]\\n\\nNo other features are supported.\", \"Security\": {\"Authorization checks\": \"Enable authorization checks for the connector by setting the `delta.security`\\nproperty in the catalog properties file. This property must be one of the\\nsecurity values in the following table:\\n\\n:::{list-table} Delta Lake security values\\n:widths: 30, 60\\n:header-rows: 1\\n\\n[['Property value', 'Description'], ['`ALLOW_ALL` (default value)', 'No authorization checks are enforced.'], ['`SYSTEM`', 'The connector relies on system-level access control.'], ['`READ_ONLY`', 'Operations that read data or metadata, such as [](/sql/select) are\\\\npermitted. No operations that write data or metadata, such as\\\\n[](/sql/create-table), [](/sql/insert), or [](/sql/delete) are allowed.'], ['`FILE`', 'Authorization checks are enforced using a catalog-level access control\\\\nconfiguration file whose path is specified in the `security.config-file`\\\\ncatalog configuration property. See [](catalog-file-based-access-control)\\\\nfor information on the authorization configuration file.\\\\n:::']]\\n\\n(delta-lake-sql-support)=\"}, \"SQL support\": {\"Time travel queries\": \"The connector offers the ability to query historical data. This allows to\\nquery the table as it was when a previous snapshot of the table was taken, even\\nif the data has since been modified or deleted.\\n\\nThe historical data of the table can be retrieved by specifying the version\\nnumber corresponding to the version of the table to be retrieved:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR VERSION AS OF 3\\n```\\n\\nA different approach of retrieving historical data is to specify a point in time\\nin the past, such as a day or week ago. The latest snapshot of the table taken\\nbefore or at the specified timestamp in the query is internally used for\\nproviding the previous state of the table:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 09:59:29.803 America/Los_Angeles';\\n```\\n\\nThe connector allows to create a new snapshot through Delta Lake's [replace table](delta-lake-create-or-replace).\\n\\n```\\nCREATE OR REPLACE TABLE example.testdb.customer_orders AS\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 09:59:29.803 America/Los_Angeles';\\n```\\n\\nYou can use a date to specify a point a time in the past for using a snapshot of a table in a query.\\nAssuming that the session time zone is `America/Los_Angeles` the following queries are equivalent:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF DATE '2022-03-23';\\n```\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 00:00:00';\\n```\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 00:00:00.000 America/Los_Angeles';\\n```\\n\\nUse the `$history` metadata table to determine the snapshot ID of the\\ntable like in the following query:\\n\\n```\\nSELECT version, operation\\nFROM example.testdb.\\\"customer_orders$history\\\"\\nORDER BY version DESC\\n```\", \"Procedures\": {\"Register table\": \"The connector can register existing Delta Lake tables into the metastore if\\n`delta.register-table-procedure.enabled` is set to `true` for the catalog.\\n\\nThe `system.register_table` procedure allows the caller to register an\\nexisting Delta Lake table in the metastore, using its existing transaction logs\\nand data files:\\n\\n```\\nCALL example.system.register_table(schema_name => 'testdb', table_name => 'customer_orders', table_location => 's3://my-bucket/a/path')\\n```\\n\\nTo prevent unauthorized users from accessing data, this procedure is disabled by\\ndefault. The procedure is enabled only when\\n`delta.register-table-procedure.enabled` is set to `true`.\\n\\n(delta-lake-unregister-table)=\", \"Unregister table\": \"The connector can remove existing Delta Lake tables from the metastore. Once\\nunregistered, you can no longer query the table from Trino.\\n\\nThe procedure `system.unregister_table` allows the caller to unregister an\\nexisting Delta Lake table from the metastores without deleting the data:\\n\\n```\\nCALL example.system.unregister_table(schema_name => 'testdb', table_name => 'customer_orders')\\n```\\n\\n(delta-lake-flush-metadata-cache)=\", \"Flush metadata cache\": [\"`system.flush_metadata_cache()`\", \"Flushes all metadata caches.\", \"`system.flush_metadata_cache(schema_name => ..., table_name => ...)`\", \"Flushes metadata cache entries of a specific table.\\nProcedure requires passing named parameters.\"], \"`VACUUM`\": \"The `VACUUM` procedure removes all old files that are not in the transaction\\nlog, as well as files that are not needed to read table snapshots newer than the\\ncurrent time minus the retention period defined by the `retention period`\\nparameter.\\n\\nUsers with `INSERT` and `DELETE` permissions on a table can run `VACUUM`\\nas follows:\\n\\n```\\nCALL example.system.vacuum('exampleschemaname', 'exampletablename', '7d');\\n```\\n\\nAll parameters are required and must be presented in the following order:\\n\\n['Schema name', 'Table name', 'Retention period']\\n\\nThe `delta.vacuum.min-retention` configuration property provides a safety\\nmeasure to ensure that files are retained as expected. The minimum value for\\nthis property is `0s`. There is a minimum retention session property as well,\\n`vacuum_min_retention`.\\n\\n(delta-lake-data-management)=\"}, \"Data management\": \"You can use the connector to {doc}`/sql/insert`, {doc}`/sql/delete`,\\n{doc}`/sql/update`, and {doc}`/sql/merge` data in Delta Lake tables.\\n\\nWrite operations are supported for tables stored on the following systems:\\n\\n['Azure ADLS Gen2, Google Cloud Storage', 'Writes to the Azure ADLS Gen2 and Google Cloud Storage are\\\\nenabled by default. Trino detects write collisions on these storage systems\\\\nwhen writing from multiple Trino clusters, or from other query engines.', 'S3 and S3-compatible storage', 'Writes to Amazon S3 and S3-compatible storage must be enabled\\\\nwith the `delta.enable-non-concurrent-writes` property. Writes to S3 can\\\\nsafely be made from multiple Trino clusters; however, write collisions are not\\\\ndetected when writing concurrently from other Delta Lake engines. You must\\\\nmake sure that no concurrent data modifications are run to avoid data\\\\ncorruption.']\\n\\n(delta-lake-schema-table-management)=\", \"Schema and table management\": {\"Schema evolution\": \"The Delta Lake connector supports schema evolution, with safe column add, drop,\\nand rename operations for non nested structures.\\n\\n(delta-lake-alter-table)=\\nThe connector supports the following [](/sql/alter-table) statements.\\n\\n(delta-lake-create-or-replace)=\", \"Replace tables\": \"The connector supports replacing an existing table as an atomic operation.\\nAtomic table replacement creates a new snapshot with the new table definition as\\npart of the [table history](#delta-lake-history-table).\\n\\nTo replace a table, use [`CREATE OR REPLACE TABLE`](/sql/create-table) or\\n[`CREATE OR REPLACE TABLE AS`](/sql/create-table-as).\\n\\nIn this example, a table `example_table` is replaced by a completely new\\ndefinition and data from the source table:\\n\\n```\\nCREATE OR REPLACE TABLE example_table\\nWITH (partitioned_by = ARRAY['a'])\\nAS SELECT * FROM another_table;\\n```\\n\\n(delta-lake-alter-table-execute)=\", \"ALTER TABLE EXECUTE\": \"The connector supports the following commands for use with {ref}`ALTER TABLE\\nEXECUTE <alter-table-execute>`.\\n\\n```\\n```\\n\\nUse a `WHERE` clause with [metadata columns](delta-lake-special-columns) to filter\\nwhich files are optimized.\\n\\n```\\nALTER TABLE test_table EXECUTE optimize\\nWHERE \\\"$file_modified_time\\\" > date_trunc('day', CURRENT_TIMESTAMP);\\n```\\n\\n```\\nALTER TABLE test_table EXECUTE optimize\\nWHERE \\\"$path\\\" <> 'skipping-file-path'\\n```\\n\\n```\\n-- optimze files smaller than 1MB\\nALTER TABLE test_table EXECUTE optimize\\nWHERE \\\"$file_size\\\" <= 1024 * 1024\\n```\\n\\n(delta-lake-alter-table-rename-to)=\", \"ALTER TABLE RENAME TO\": \"The connector only supports the `ALTER TABLE RENAME TO` statement when met with\\none of the following conditions:\\n\\n['The table type is external.', 'The table is backed by a metastore that does not perform object storage\\\\noperations, for example, AWS Glue.']\", \"Table properties\": \"The following table properties are available for use:\\n\\n:::{list-table} Delta Lake table properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`location`', 'File system location URI for the table.'], ['`partitioned_by`', 'Set partition columns.'], ['`checkpoint_interval`', 'Set the checkpoint interval in number of table writes.'], ['`change_data_feed_enabled`', 'Enables storing change data feed entries.'], ['`column_mapping_mode`', 'Column mapping mode. Possible values are:', ['`ID`', '`NAME`', '`NONE`'], 'Defaults to `NONE`.'], ['`deletion_vectors_enabled`', 'Enables deletion vectors.\\\\n:::']]\\n\\nThe following example uses all available table properties:\\n\\n```\\nCREATE TABLE example.default.example_partitioned_table\\nWITH (\\n location = 's3://my-bucket/a/path',\\n partitioned_by = ARRAY['regionkey'],\\n checkpoint_interval = 5,\\n change_data_feed_enabled = false,\\n column_mapping_mode = 'name',\\n deletion_vectors_enabled = false\\n)\\nAS SELECT name, comment, regionkey FROM tpch.tiny.nation;\\n```\\n\\n(delta-lake-shallow-clone)=\", \"Shallow cloned tables\": \"The connector supports read and write operations on shallow cloned tables. Trino\\ndoes not support creating shallow clone tables. More information about shallow\\ncloning is available in the [Delta Lake\\ndocumentation](https://docs.delta.io/latest/delta-utility.html#shallow-clone-a-delta-table).\\n\\nShallow cloned tables let you test queries or experiment with changes to a table\\nwithout duplicating data.\", \"Metadata tables\": {\"`$history` table\": \"The `$history` table provides a log of the metadata changes performed on\\nthe Delta Lake table.\\n\\nYou can retrieve the changelog of the Delta Lake table `test_table`\\nby using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$history\\\"\\n```\\n\\n```\\n version | timestamp | user_id | user_name | operation | operation_parameters | cluster_id | read_version | isolation_level | is_blind_append | operation_metrics \\n---------+---------------------------------------+---------+-----------+--------------+---------------------------------------+---------------------------------+--------------+-------------------+-----------------+-------------------\\n 2 | 2023-01-19 07:40:54.684 Europe/Vienna | trino | trino | WRITE | {queryId=20230119_064054_00008_4vq5t} | trino-406-trino-coordinator | 2 | WriteSerializable | true | {}\\n 1 | 2023-01-19 07:40:41.373 Europe/Vienna | trino | trino | ADD COLUMNS | {queryId=20230119_064041_00007_4vq5t} | trino-406-trino-coordinator | 0 | WriteSerializable | true | {}\\n 0 | 2023-01-19 07:40:10.497 Europe/Vienna | trino | trino | CREATE TABLE | {queryId=20230119_064010_00005_4vq5t} | trino-406-trino-coordinator | 0 | WriteSerializable | true | {}\\n```\\n\\nThe output of the query has the following history columns:\\n\\n:::{list-table} History columns\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`version`', '`BIGINT`', 'The version of the table corresponding to the operation'], ['`timestamp`', '`TIMESTAMP(3) WITH TIME ZONE`', 'The time when the table version became active\\\\nFor tables with in-Commit timestamps enabled, this field returns value of \\\\n[inCommitTimestamp](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#in-commit-timestamps),\\\\nOtherwise returns value of `timestamp` field that in the \\\\n[commitInfo](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#commit-provenance-information)'], ['`user_id`', '`VARCHAR`', 'The identifier for the user which performed the operation'], ['`user_name`', '`VARCHAR`', 'The username for the user which performed the operation'], ['`operation`', '`VARCHAR`', 'The name of the operation performed on the table'], ['`operation_parameters`', '`map(VARCHAR, VARCHAR)`', 'Parameters of the operation'], ['`cluster_id`', '`VARCHAR`', 'The ID of the cluster which ran the operation'], ['`read_version`', '`BIGINT`', 'The version of the table which was read in order to perform the operation'], ['`isolation_level`', '`VARCHAR`', 'The level of isolation used to perform the operation'], ['`is_blind_append`', '`BOOLEAN`', 'Whether or not the operation appended data'], ['`operation_metrics`', '`map(VARCHAR, VARCHAR)`', 'Metrics of the operation\\\\n:::']]\\n\\n(delta-lake-partitions-table)=\", \"`$partitions` table\": \"The `$partitions` table provides a detailed overview of the partitions of the\\nDelta Lake table.\\n\\nYou can retrieve the information about the partitions of the Delta Lake table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$partitions\\\"\\n```\\n\\n```\\n partition | file_count | total_size | data |\\n-------------------------------+------------+------------+----------------------------------------------+\\n{_bigint=1, _date=2021-01-12} | 2 | 884 | {_decimal={min=1.0, max=2.0, null_count=0}} |\\n{_bigint=1, _date=2021-01-13} | 1 | 442 | {_decimal={min=1.0, max=1.0, null_count=0}} |\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Partitions columns\\n:widths: 20, 30, 50\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`partition`', '`ROW(...)`', 'A row that contains the mapping of the partition column names to the\\\\npartition column values.'], ['`file_count`', '`BIGINT`', 'The number of files mapped in the partition.'], ['`total_size`', '`BIGINT`', 'The size of all the files in the partition.'], ['`data`', '`ROW(... ROW (min ..., max ... , null_count BIGINT))`', 'Partition range and null counts.\\\\n:::']]\", \"`$properties` table\": \"The `$properties` table provides access to Delta Lake table configuration,\\ntable features and table properties. The table rows are key/value pairs.\\n\\nYou can retrieve the properties of the Delta\\ntable `test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$properties\\\"\\n```\\n\\n```\\n key | value |\\n----------------------------+-----------------+\\ndelta.minReaderVersion | 1 |\\ndelta.minWriterVersion | 4 |\\ndelta.columnMapping.mode | name |\\ndelta.feature.columnMapping | supported |\\n```\\n\\n(delta-lake-special-columns)=\"}, \"Metadata columns\": \"In addition to the defined columns, the Delta Lake connector automatically\\nexposes metadata in a number of hidden columns in each table. You can use these\\ncolumns in your SQL statements like any other column, e.g., they can be selected\\ndirectly or used in conditional statements.\\n\\n['`$path`\\\\n: Full file system path name of the file for this row.', '`$file_modified_time`\\\\n: Date and time of the last modification of the file for this row.', '`$file_size`\\\\n: Size of the file for this row.']\"}, \"Table functions\": {\"table_changes\": \"Allows reading Change Data Feed (CDF) entries to expose row-level changes\\nbetween two versions of a Delta Lake table. When the `change_data_feed_enabled`\\ntable property is set to `true` on a specific Delta Lake table,\\nthe connector records change events for all data changes on the table.\\nThis is how these changes can be read:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n system.table_changes(\\n schema_name => 'test_schema',\\n table_name => 'tableName',\\n since_version => 0\\n )\\n );\\n```\\n\\n`schema_name` - type `VARCHAR`, required, name of the schema for which the function is called\\n\\n`table_name` - type `VARCHAR`, required, name of the table for which the function is called\\n\\n`since_version` - type `BIGINT`, optional, version from which changes are shown, exclusive\\n\\nIn addition to returning the columns present in the table, the function\\nreturns the following values for each change event:\\n\\n['`_change_type`\\\\n: Gives the type of change that occurred. Possible values are `insert`,\\\\n`delete`, `update_preimage` and `update_postimage`.', '`_commit_version`\\\\n: Shows the table version for which the change occurred.', '`_commit_timestamp`\\\\n: Represents the timestamp for the commit in which the specified change happened.']\\n\\nThis is how it would be normally used:\\n\\nCreate table:\\n\\n```\\nCREATE TABLE test_schema.pages (page_url VARCHAR, domain VARCHAR, views INTEGER)\\n WITH (change_data_feed_enabled = true);\\n```\\n\\nInsert data:\\n\\n```\\nINSERT INTO test_schema.pages\\n VALUES\\n ('url1', 'domain1', 1),\\n ('url2', 'domain2', 2),\\n ('url3', 'domain1', 3);\\nINSERT INTO test_schema.pages\\n VALUES\\n ('url4', 'domain1', 400),\\n ('url5', 'domain2', 500),\\n ('url6', 'domain3', 2);\\n```\\n\\nUpdate data:\\n\\n```\\nUPDATE test_schema.pages\\n SET domain = 'domain4'\\n WHERE views = 2;\\n```\\n\\nSelect changes:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n system.table_changes(\\n schema_name => 'test_schema',\\n table_name => 'pages',\\n since_version => 1\\n )\\n )\\nORDER BY _commit_version ASC;\\n```\\n\\nThe preceding sequence of SQL statements returns the following result:\\n\\n```\\npage_url | domain | views | _change_type | _commit_version | _commit_timestamp\\nurl4 | domain1 | 400 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl5 | domain2 | 500 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl6 | domain3 | 2 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl2 | domain2 | 2 | update_preimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl2 | domain4 | 2 | update_postimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl6 | domain3 | 2 | update_preimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl6 | domain4 | 2 | update_postimage | 3 | 2023-03-10T22:23:24.000+0000\\n```\\n\\nThe output shows what changes happen in which version.\\nFor example in version 3 two rows were modified, first one changed from\\n`('url2', 'domain2', 2)` into `('url2', 'domain4', 2)` and the second from\\n`('url6', 'domain2', 2)` into `('url6', 'domain4', 2)`.\\n\\nIf `since_version` is not provided the function produces change events\\nstarting from when the table was created.\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n system.table_changes(\\n schema_name => 'test_schema',\\n table_name => 'pages'\\n )\\n )\\nORDER BY _commit_version ASC;\\n```\\n\\nThe preceding SQL statement returns the following result:\\n\\n```\\npage_url | domain | views | _change_type | _commit_version | _commit_timestamp\\nurl1 | domain1 | 1 | insert | 1 | 2023-03-10T20:21:22.000+0000\\nurl2 | domain2 | 2 | insert | 1 | 2023-03-10T20:21:22.000+0000\\nurl3 | domain1 | 3 | insert | 1 | 2023-03-10T20:21:22.000+0000\\nurl4 | domain1 | 400 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl5 | domain2 | 500 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl6 | domain3 | 2 | insert | 2 | 2023-03-10T21:22:23.000+0000\\nurl2 | domain2 | 2 | update_preimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl2 | domain4 | 2 | update_postimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl6 | domain3 | 2 | update_preimage | 3 | 2023-03-10T22:23:24.000+0000\\nurl6 | domain4 | 2 | update_postimage | 3 | 2023-03-10T22:23:24.000+0000\\n```\\n\\nYou can see changes that occurred at version 1 as three inserts. They are\\nnot visible in the previous statement when `since_version` value was set to 1.\"}}, \"Performance\": {\"Table statistics\": {\"Fine-tuning\": \"The `files_modified_after` property is useful if you want to run the\\n`ANALYZE` statement on a table that was previously analyzed. You can use it to\\nlimit the amount of data used to generate the table statistics:\\n\\n```\\nANALYZE example_table WITH(files_modified_after = TIMESTAMP '2021-08-23\\n16:43:01.321 Z')\\n```\\n\\nAs a result, only files newer than the specified time stamp are used in the\\nanalysis.\\n\\nYou can also specify a set or subset of columns to analyze using the `columns`\\nproperty:\\n\\n```\\nANALYZE example_table WITH(columns = ARRAY['nationkey', 'regionkey'])\\n```\\n\\nTo run `ANALYZE` with `columns` more than once, the next `ANALYZE` must\\nrun on the same set or a subset of the original columns used.\\n\\nTo broaden the set of `columns`, drop the statistics and reanalyze the table.\", \"Disable and drop extended statistics\": \"You can disable extended statistics with the catalog configuration property\\n`delta.extended-statistics.enabled` set to `false`. Alternatively, you can\\ndisable it for a session, with the {doc}`catalog session property\\n</sql/set-session>` `extended_statistics_enabled` set to `false`.\\n\\nIf a table is changed with many delete and update operation, calling `ANALYZE`\\ndoes not result in accurate statistics. To correct the statistics, you have to\\ndrop the extended statistics and analyze the table again.\\n\\nUse the `system.drop_extended_stats` procedure in the catalog to drop the\\nextended statistics for a specified table in a specified schema:\\n\\n```\\nCALL example.system.drop_extended_stats('example_schema', 'example_table')\\n```\"}, \"Memory usage\": {\"Memory monitoring\": \"When using the Delta Lake connector, you must monitor memory usage on the\\ncoordinator. Specifically, monitor JVM heap utilization using standard tools as\\npart of routine operation of the cluster.\\n\\nA good proxy for memory usage is the cache utilization of Delta Lake caches. It\\nis exposed by the connector with the\\n`plugin.deltalake.transactionlog:name=<catalog-name>,type=transactionlogaccess`\\nJMX bean.\\n\\nYou can access it with any standard monitoring software with JMX support, or use\\nthe {doc}`/connector/jmx` with the following query:\\n\\n```\\nSELECT * FROM jmx.current.\\\"*.plugin.deltalake.transactionlog:name=<catalog-name>,type=transactionlogaccess\\\"\\n```\\n\\nFollowing is an example result:\\n\\n```\\ndatafilemetadatacachestats.hitrate | 0.97\\ndatafilemetadatacachestats.missrate | 0.03\\ndatafilemetadatacachestats.requestcount | 3232\\nmetadatacachestats.hitrate | 0.98\\nmetadatacachestats.missrate | 0.02\\nmetadatacachestats.requestcount | 6783\\nnode | trino-master\\nobject_name | io.trino.plugin.deltalake.transactionlog:type=TransactionLogAccess,name=delta\\n```\\n\\nIn a healthy system, both `datafilemetadatacachestats.hitrate` and\\n`metadatacachestats.hitrate` are close to `1.0`.\\n\\n(delta-lake-table-redirection)=\"}, \"Table redirection\": \"```\\n```\\n\\nThe connector supports redirection from Delta Lake tables to Hive tables\\nwith the `delta.hive-catalog-name` catalog configuration property.\", \"Performance tuning configuration properties\": \"The following table describes performance tuning catalog properties specific to\\nthe Delta Lake connector.\\n\\n:::{warning}\\nPerformance tuning configuration properties are considered expert-level\\nfeatures. Altering these properties from their default values is likely to\\ncause instability and performance degradation. It is strongly suggested that\\nyou use them only to address non-trivial performance issues, and that you\\nkeep a backup of the original values if you change them.\\n:::\\n\\n:::{list-table} Delta Lake performance tuning configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`delta.domain-compaction-threshold`', 'Minimum size of query predicates above which Trino compacts the predicates.\\\\nPushing a large list of predicates down to the data source can compromise\\\\nperformance. For optimization in that situation, Trino can compact the large\\\\npredicates. If necessary, adjust the threshold to ensure a balance between\\\\nperformance and predicate pushdown.', '`1000`'], ['`delta.max-outstanding-splits`', 'The target number of buffered splits for each table scan in a query, before\\\\nthe scheduler tries to pause.', '`1000`'], ['`delta.max-splits-per-second`', 'Sets the maximum number of splits used per second to access underlying\\\\nstorage. Reduce this number if your limit is routinely exceeded, based on\\\\nyour filesystem limits. This is set to the absolute maximum value, which\\\\nresults in Trino maximizing the parallelization of data access by default.\\\\nAttempting to set it higher results in Trino not being able to start.', '`Integer.MAX_VALUE`'], ['`delta.max-split-size`', 'Sets the largest [](prop-type-data-size) for a single read section\\\\nassigned to a worker after `max-initial-splits` have been processed. You can\\\\nalso use the corresponding catalog session property\\\\n`<catalog-name>.max_split_size`.', '`128MB`'], ['`delta.minimum-assigned-split-weight`', 'A decimal value in the range (0, 1] used as a minimum for weights assigned\\\\nto each split. A low value might improve performance on tables with small\\\\nfiles. A higher value might improve performance for queries with highly\\\\nskewed aggregations or joins.', '`0.05`'], ['`delta.projection-pushdown-enabled`', 'Read only projected fields from row columns while performing `SELECT` queries', '`true`'], ['`delta.query-partition-filter-required`', 'Set to `true` to force a query to use a partition filter. You can use the\\\\n`query_partition_filter_required` catalog session property for temporary,\\\\ncatalog specific use.', '`false`\\\\n:::']]\", \"File system cache\": \"The connector supports configuring and using [file system\\ncaching](/object-storage/file-system-cache).\\n\\nThe following table describes file system cache properties specific to \\nthe Delta Lake connector.\\n\\n:::{list-table} Delta Lake file system cache configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`delta.fs.cache.disable-transaction-log-caching`', 'Set to `true` to disable caching of the `_delta_log` directory of \\\\nDelta Tables. This is useful in those cases when Delta Tables are \\\\ndestroyed and recreated, and the files inside the transaction log \\\\ndirectory get overwritten and cannot be safely cached. Effective \\\\nonly when `fs.cache.enabled=true`.', '`false`\\\\n:::']]\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 4]\"}, {\"title\": \"Druid connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Druid, you need:\\n\\n['Druid version 0.18.0 or higher.', 'Network access from the Trino coordinator and workers to your Druid broker.\\\\nPort 8082 is the default port.']\", \"Configuration\": \"Create a catalog properties file that specifies the Druid connector by setting\\nthe `connector.name` to `druid` and configuring the `connection-url` with\\nthe JDBC string to connect to Druid.\\n\\nFor example, to access a database as `example`, create the file\\n`etc/catalog/example.properties`. Replace `BROKER:8082` with the correct\\nhost and port of your Druid broker.\\n\\n```\\nconnector.name=druid\\nconnection-url=jdbc:avatica:remote:url=http://BROKER:8082/druid/v2/sql/avatica/\\n```\\n\\nYou can add authentication details to connect to a Druid deployment that is\\nsecured by basic authentication by updating the URL and adding credentials:\\n\\n```\\nconnection-url=jdbc:avatica:remote:url=http://BROKER:port/druid/v2/sql/avatica/;authentication=BASIC\\nconnection-user=root\\nconnection-password=secret\\n```\\n\\nNow you can access your Druid database in Trino with the `example` catalog\\nname from the properties file.\\n\\nThe `connection-user` and `connection-password` are typically required and\\ndetermine the user credentials for the connection, often a service user. You can\\nuse {doc}`secrets </security/secrets>` to avoid actual values in the catalog\\nproperties files.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(druid-type-mapping)=\", \"Type mapping\": {\"Druid type to Trino type mapping\": \"The connector maps Druid types to the corresponding Trino types according to the\\nfollowing table:\\n\\n:::{list-table} Druid type to Trino type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['Druid type', 'Trino type', 'Notes'], ['`STRING`', '`VARCHAR`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`LONG`', '`BIGINT`', 'Except for the special `_time` column, which is mapped to `TIMESTAMP`.'], ['`TIMESTAMP`', '`TIMESTAMP`', 'Only applicable to the special `_time` column.\\\\n:::']]\\n\\nNo other data types are supported.\\n\\nDruid does not have a real `NULL` value for any data type. By\\ndefault, Druid treats `NULL` as the default value for a data type. For\\nexample, `LONG` would be `0`, `DOUBLE` would be `0.0`, `STRING` would\\nbe an empty string `''`, and so forth.\\n\\n```\\n```\\n\\n(druid-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(druid-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to Druid, because the full query is pushed down and\\nprocessed in Druid. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nAs an example, query the `example` catalog and use `STRING_TO_MV` and\\n`MV_LENGTH` from [Druid SQL's multi-value string functions](https://druid.apache.org/docs/latest/querying/sql-multivalue-string-functions.html)\\nto split and then count the number of comma-separated values in a column:\\n\\n```\\nSELECT\\n num_reports\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n MV_LENGTH(\\n STRING_TO_MV(direct_reports, \\\",\\\")\\n ) AS num_reports\\n FROM company.managers'\\n )\\n );\\n```\\n\\n```\\n```\"}}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 5]\"}, {\"title\": \"DuckDB connector\", \"description\": null, \"content\": {\"Requirements\": [\"All cluster nodes must include `libstdc++` as required by the [DuckDB JDBC\\ndriver](https://duckdb.org/docs/clients/java.html).\", \"The path to the persistent DuckDB database must be identical and available on\\nall cluster nodes and point to the same storage location.\"], \"Configuration\": {\"Multiple DuckDB servers\": \"The DuckDB connector can only access a single database within\\na DuckDB instance. Thus, if you have multiple DuckDB servers,\\nor want to connect to multiple DuckDB servers, you must configure\\nmultiple instances of the DuckDB connector.\\n\\n(duckdb-type-mapping)=\"}, \"Type mapping\": {\"DuckDB type to Trino type mapping\": \"The connector maps DuckDB types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} DuckDB type to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['DuckDB type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL`', '`DECIMAL`', 'Default precision and scale are (18,3).'], ['`VARCHAR`', '`VARCHAR`'], ['`DATE`', '`DATE`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type to DuckDB type mapping\": \"The connector maps Trino types to the corresponding DuckDB types following\\nthis table:\\n\\n:::{list-table} Trino type to DuckDB type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'DuckDB type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL`', '`DECIMAL`'], ['`CHAR`', '`VARCHAR`'], ['`VARCHAR`', '`VARCHAR`'], ['`DATE`', '`DATE`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n```\\n```\\n\\n(duckdb-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to DuckDB, because the full query is pushed down and\\nprocessed in DuckDB. This can be useful for accessing native features which\\nare not available in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\nFind details about the SQL support of DuckDB that you can use in the query in\\nthe [DuckDB SQL Command\\nReference](https://duckdb.org/docs/sql/query_syntax/select) and\\nother statements and functions.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\n```\\n```\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 6]\"}, {\"title\": \"Elasticsearch connector\", \"description\": null, \"content\": {\"Requirements\": [\"Elasticsearch 7.x or 8.x\", \"Network access from the Trino coordinator and workers to the Elasticsearch nodes.\"], \"Configuration\": {\"Authentication\": \"The connection to Elasticsearch can use AWS or password authentication.\\n\\nTo enable AWS authentication and authorization using IAM policies, the\\n`elasticsearch.security` option must be set to `AWS`. Additionally, the\\nfollowing options must be configured:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`elasticsearch.aws.region`', 'AWS region of the Elasticsearch endpoint. This option is required.'], ['`elasticsearch.aws.access-key`', 'AWS access key to use to connect to the Elasticsearch domain. If not set, the\\\\ndefault AWS credentials provider chain is used.'], ['`elasticsearch.aws.secret-key`', 'AWS secret key to use to connect to the Elasticsearch domain. If not set, the\\\\ndefault AWS credentials provider chain is used.'], ['`elasticsearch.aws.iam-role`', 'Optional ARN of an IAM role to assume to connect to Elasticsearch. Note that\\\\nthe configured IAM user must be able to assume this role.'], ['`elasticsearch.aws.external-id`', 'Optional external ID to pass while assuming an AWS IAM role.\\\\n:::']]\\n\\nTo enable password authentication, the `elasticsearch.security` option must be set\\nto `PASSWORD`. Additionally the following options must be configured:\\n\\n:::{list-table}\\n:widths: 45, 55\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`elasticsearch.auth.user`', 'Username to use to connect to Elasticsearch.'], ['`elasticsearch.auth.password`', 'Password to use to connect to Elasticsearch.\\\\n:::']]\", \"Connection security with TLS\": \"The connector provides additional security options to connect to Elasticsearch\\nclusters with TLS enabled.\\n\\nIf your cluster has globally-trusted certificates, you should only need to\\nenable TLS. If you require custom configuration for certificates, the connector\\nsupports key stores and trust stores in P12 (PKCS) or Java Key Store (JKS) format.\\n\\nThe available configuration values are listed in the following table:\\n\\n:::{list-table} TLS Security Properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`elasticsearch.tls.enabled`', 'Enables TLS security.'], ['`elasticsearch.tls.keystore-path`', 'The path to the P12 (PKCS) or [JKS](/security/inspect-jks)\\\\nkey store.'], ['`elasticsearch.tls.truststore-path`', 'The path to P12 (PKCS) or [JKS](/security/inspect-jks)\\\\ntrust store.'], ['`elasticsearch.tls.keystore-password`', 'The key password for the key store specified by\\\\n`elasticsearch.tls.keystore-path`.'], ['`elasticsearch.tls.truststore-password`', 'The key password for the trust store specified by\\\\n`elasticsearch.tls.truststore-path`.'], ['`elasticsearch.tls.verify-hostnames`', 'Flag to determine if the hostnames in the certificates must be verified. Defaults\\\\nto `true`.\\\\n:::']]\\n\\n(elasticsearch-type-mapping)=\"}, \"Type mapping\": {\"Elasticsearch type to Trino type mapping\": \"The connector maps Elasticsearch types to the corresponding Trino types\\naccording to the following table:\\n\\n:::{list-table} Elasticsearch type to Trino type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['Elasticsearch type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`DOUBLE`', '`DOUBLE`'], ['`FLOAT`', '`REAL`'], ['`BYTE`', '`TINYINT`'], ['`SHORT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`LONG`', '`BIGINT`'], ['`KEYWORD`', '`VARCHAR`'], ['`TEXT`', '`VARCHAR`'], ['`DATE`', '`TIMESTAMP`', 'For more information, see [](elasticsearch-date-types).'], ['`IPADDRESS`', '`IP`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n(elasticsearch-array-types)=\", \"Array types\": \"Fields in Elasticsearch can contain [zero or more\\nvalues](https://www.elastic.co/guide/en/elasticsearch/reference/current/array.html),\\nbut there is no dedicated array type. To indicate a field contains an array, it\\ncan be annotated in a Trino-specific structure in the\\n[\\\\_meta](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html)\\nsection of the index mapping.\\n\\nFor example, you can have an Elasticsearch index that contains documents with the following structure:\\n\\n```\\n{\\n \\\"array_string_field\\\": [\\\"trino\\\",\\\"the\\\",\\\"lean\\\",\\\"machine-ohs\\\"],\\n \\\"long_field\\\": 314159265359,\\n \\\"id_field\\\": \\\"564e6982-88ee-4498-aa98-df9e3f6b6109\\\",\\n \\\"timestamp_field\\\": \\\"1987-09-17T06:22:48.000Z\\\",\\n \\\"object_field\\\": {\\n \\\"array_int_field\\\": [86,75,309],\\n \\\"int_field\\\": 2\\n }\\n}\\n```\\n\\nThe array fields of this structure can be defined by using the following command to add the field\\nproperty definition to the `_meta.trino` property of the target index mapping with Elasticsearch available at `search.example.com:9200`:\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"_meta\\\": {\\n \\\"trino\\\":{\\n \\\"array_string_field\\\":{\\n \\\"isArray\\\":true\\n },\\n \\\"object_field\\\":{\\n \\\"array_int_field\\\":{\\n \\\"isArray\\\":true\\n }\\n },\\n }\\n }\\n}'\\n```\\n\\n:::{note}\\nIt is not allowed to use `asRawJson` and `isArray` flags simultaneously for the same column.\\n:::\\n\\n(elasticsearch-date-types)=\", \"Date types\": \"The Elasticsearch connector supports only the default `date` type. All other\\n[date] formats including [built-in date formats] and [custom date formats] are\\nnot supported. Dates with the [format] property are ignored.\", \"Raw JSON transform\": \"Documents in Elasticsearch can include more complex structures that are not\\nrepresented in the mapping. For example, a single `keyword` field can have\\nwidely different content including a single `keyword` value, an array, or a\\nmultidimensional `keyword` array with any level of nesting.\\n\\nThe following command configures `array_string_field` mapping with Elasticsearch\\navailable at `search.example.com:9200`:\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"properties\\\": {\\n \\\"array_string_field\\\":{\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n}'\\n```\\n\\nAll the following documents are legal for Elasticsearch with\\n`array_string_field` mapping:\\n\\n```\\n[\\n {\\n \\\"array_string_field\\\": \\\"trino\\\"\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",\\\"is\\\",\\\"the\\\",\\\"best\\\"]\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",[\\\"is\\\",\\\"the\\\",\\\"best\\\"]]\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",[\\\"is\\\",[\\\"the\\\",\\\"best\\\"]]]\\n }\\n]\\n```\\n\\nSee the [Elasticsearch array\\ndocumentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/array.html)\\nfor more details.\\n\\nFurther, Elasticsearch supports types, such as\\n[dense_vector](https://www.elastic.co/guide/en/elasticsearch/reference/current/dense-vector.html),\\nthat are not supported in Trino. These and other types can cause parsing\\nexceptions for users that use of these types in Elasticsearch. To manage all of\\nthese scenarios, you can transform fields to raw JSON by annotating it in a\\nTrino-specific structure in the\\n[\\\\_meta](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-meta-field.html)\\nsection of the index mapping. This indicates to Trino that the field, and all\\nnested fields beneath, need to be cast to a `VARCHAR` field that contains the\\nraw JSON content. These fields can be defined by using the following command to\\nadd the field property definition to the `_meta.trino` property of the target\\nindex mapping.\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"_meta\\\": {\\n \\\"trino\\\":{\\n \\\"array_string_field\\\":{\\n \\\"asRawJson\\\":true\\n }\\n }\\n }\\n}'\\n```\\n\\nThis preceding configuration causes Trino to return the `array_string_field`\\nfield as a `VARCHAR` containing raw JSON. You can parse these fields with the\\n[built-in JSON functions](/functions/json).\\n\\n:::{note}\\nIt is not allowed to use `asRawJson` and `isArray` flags simultaneously for the same column.\\n:::\"}, \"Special columns\": \"The following hidden columns are available:\\n\\n:::{list-table}\\n:widths: 25, 75\\n:header-rows: 1\\n\\n[['Column', 'Description'], ['`_id`', 'The Elasticsearch document ID.'], ['`_score`', 'The document score returned by the Elasticsearch query.'], ['`_source`', 'The source of the original document.\\\\n:::']]\\n\\n(elasticsearch-full-text-queries)=\", \"Full text queries\": \"Trino SQL queries can be combined with Elasticsearch queries by providing the [full text query]\\nas part of the table name, separated by a colon. For example:\\n\\n```\\nSELECT * FROM \\\"tweets: +trino SQL^2\\\"\\n```\\n\\n(elasticsearch-sql-support)=\", \"SQL support\": {\"Wildcard table\": \"The connector provides support to query multiple tables using a concise\\n[wildcard table](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multiple-indices.html)\\nnotation.\\n\\n```\\nSELECT *\\nFROM example.web.\\\"page_views_*\\\";\\n```\", \"Table functions\": {\"`raw_query(varchar) -> table`\": \"The `raw_query` function allows you to query the underlying database directly.\\nThis function requires [Elastic Query\\nDSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html)\\nsyntax. The full DSL query is pushed down and processed in Elasticsearch. This\\ncan be useful for accessing native features which are not available in Trino or\\nfor improving query performance in situations where running a query natively may\\nbe faster.\\n\\n```\\n```\\n\\nThe `raw_query` function requires three parameters:\\n\\n['`schema`: The schema in the catalog that the query is to be executed on.', '`index`: The index in Elasticsearch to be searched.', '`query`: The query to execute, written in [Elastic Query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html).']\\n\\nOnce executed, the query returns a single row containing the resulting JSON\\npayload returned by Elasticsearch.\\n\\nFor example, query the `example` catalog and use the `raw_query` table function\\nto search for documents in the `orders` index where the country name is\\n`ALGERIA` as defined as a JSON-formatted query matcher and passed to the\\n`raw_query` table function in the `query` parameter:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.raw_query(\\n schema => 'sales',\\n index => 'orders',\\n query => '{\\n \\\"query\\\": {\\n \\\"match\\\": {\\n \\\"name\\\": \\\"ALGERIA\\\"\\n }\\n }\\n }'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Parallel data access\": \"The connector requests data from multiple nodes of the Elasticsearch cluster for\\nquery processing in parallel.\", \"Predicate push down\": \"The connector supports [predicate push down](predicate-pushdown) for the\\nfollowing data types:\\n\\n:::{list-table}\\n:widths: 50, 50\\n:header-rows: 1\\n\\n[['Elasticsearch', 'Trino'], ['`boolean`', '`BOOLEAN`'], ['`double`', '`DOUBLE`'], ['`float`', '`REAL`'], ['`byte`', '`TINYINT`'], ['`short`', '`SMALLINT`'], ['`integer`', '`INTEGER`'], ['`long`', '`BIGINT`'], ['`keyword`', '`VARCHAR`'], ['`date`', '`TIMESTAMP`\\\\n:::']]\\n\\nNo other data types are supported for predicate push down.\\n\\n[built-in date formats]: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#built-in-date-formats\\n[custom date formats]: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#custom-date-formats\\n[date]: https://www.elastic.co/guide/en/elasticsearch/reference/current/date.html\\n[format]: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-date-format.html#mapping-date-format\\n[full text query]: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 7]\"}, {\"title\": \"Exasol connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Exasol, you need:\\n\\n['Exasol database version 7.1 or higher.', 'Network access from the Trino coordinator and workers to Exasol.\\\\nPort 8563 is the default port.']\", \"Configuration\": \"To configure the Exasol connector as the ``example`` catalog, create a file\\nnamed ``example.properties`` in ``etc/catalog``. Include the following\\nconnection properties in the file:\\n\\n```\\nconnector.name=exasol\\nconnection-url=jdbc:exa:exasol.example.com:8563\\nconnection-user=user\\nconnection-password=secret\\n```\\n\\nThe ``connection-url`` defines the connection information and parameters to pass\\nto the JDBC driver. See the\\n[Exasol JDBC driver documentation](https://docs.exasol.com/db/latest/connect_exasol/drivers/jdbc.htm#ExasolURL)\\nfor more information.\\n\\nThe ``connection-user`` and ``connection-password`` are typically required and\\ndetermine the user credentials for the connection, often a service user. You can\\nuse {doc}`secrets </security/secrets>` to avoid using actual values in catalog\\nproperties files.\\n\\n:::{note}\\nIf your Exasol database uses a self-signed TLS certificate you must\\nspecify the certificate's fingerprint in the JDBC URL using parameter\\n``fingerprint``, e.g.: ``jdbc:exa:exasol.example.com:8563;fingerprint=ABC123``.\\n:::\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(exasol-type-mapping)=\", \"Type mapping\": {\"Exasol to Trino type mapping\": \"Trino supports selecting Exasol database types. This table shows the Exasol to\\nTrino data type mapping:\\n\\n```\\n.. list-table:: Exasol to Trino type mapping\\n :widths: 25, 25, 50\\n :header-rows: 1\\n\\n * - Exasol database type\\n - Trino type\\n - Notes\\n * - ``BOOLEAN``\\n - ``BOOLEAN``\\n -\\n * - ``DOUBLE PRECISION``\\n - ``REAL``\\n -\\n * - ``DECIMAL(p, s)``\\n - ``DECIMAL(p, s)``\\n - See :ref:`exasol-number-mapping`\\n * - ``CHAR(n)``\\n - ``CHAR(n)``\\n -\\n * - ``VARCHAR(n)``\\n - ``VARCHAR(n)``\\n -\\n * - ``DATE``\\n - ``DATE``\\n -\\n```\\n\\nNo other types are supported.\\n\\n(exasol-number-mapping)=\", \"Mapping numeric types\": \"An Exasol `DECIMAL(p, s)` maps to Trino's `DECIMAL(p, s)` and vice versa\\nexcept in these conditions:\\n\\n['No precision is specified for the column (example: `DECIMAL` or\\\\n`DECIMAL(*)`).', 'Scale (`s`) is greater than precision.', 'Precision (`p`) is greater than 36.', 'Scale is negative.']\\n\\n(exasol-character-mapping)=\", \"Mapping character types\": \"Trino's `VARCHAR(n)` maps to `VARCHAR(n)` and vice versa if `n` is no greater\\nthan 2000000. Exasol does not support longer values.\\nIf no length is specified, the connector uses 2000000.\\n\\nTrino's `CHAR(n)` maps to `CHAR(n)` and vice versa if `n` is no greater than 2000.\\nExasol does not support longer values.\\n\\n```\\n```\\n\\n(exasol-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(exasol-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to Exasol, because the full query is pushed down and\\nprocessed in Exasol. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table::\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\nAs a practical example, you can use the\\n[WINDOW clause from Exasol](https://docs.exasol.com/db/latest/sql_references/functions/analyticfunctions.htm#AnalyticFunctions):\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n id, department, hire_date, starting_salary,\\n AVG(starting_salary) OVER w2 AVG,\\n MIN(starting_salary) OVER w2 MIN_STARTING_SALARY,\\n MAX(starting_salary) OVER (w1 ORDER BY hire_date)\\n FROM employee_table\\n WINDOW w1 as (PARTITION BY department), w2 as (w1 ORDER BY hire_date)\\n ORDER BY department, hire_date'\\n )\\n );\\n```\\n\\n```\\n```\"}}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 8]\"}, {\"title\": \"Faker connector\", \"description\": null, \"content\": {\"Configuration\": {\"Character types\": \"Faker supports the following character types:\\n\\n['`CHAR`', '`VARCHAR`', '`VARBINARY`']\\n\\nColumns of those types use a generator producing the [Lorem\\nipsum](https://en.wikipedia.org/wiki/Lorem_ipsum) placeholder text. Unbounded\\ncolumns return a random sentence with 3 to 40 words.\\n\\nTo have more control over the format of the generated data, use the `generator`\\ncolumn property. Some examples of valid generator expressions:\\n\\n[\\\"`#{regexify '(a|b){2,3}'}`\\\", \\\"`#{regexify '\\\\\\\\\\\\\\\\.\\\\\\\\\\\\\\\\*\\\\\\\\\\\\\\\\?\\\\\\\\\\\\\\\\+'}`\\\", \\\"`#{bothify '????','false'}`\\\", '`#{Name.first_name} #{Name.first_name} #{Name.last_name}`', \\\"`#{number.number_between '1','10'}`\\\"]\\n\\nSee the Datafaker's documentation for more information about\\n[the expression](https://www.datafaker.net/documentation/expressions/) syntax\\nand [available providers](https://www.datafaker.net/documentation/providers/).\\n\\n:::{function} random_string(expression_string) -> string\\n\\nCreate a random output `string` with the provided input `expression_string`. The\\nexpression must use the [syntax from\\nDatafaker](https://www.datafaker.net/documentation/expressions/).\\n\\nUse the `random_string` function from the `default` schema of the `generator`\\ncatalog to test a generator expression:\\n\\n```\\nSELECT generator.default.random_string('#{Name.first_name}');\\n```\\n\\n:::\", \"Non-character types\": \"Faker supports the following non-character types:\\n\\n['`BIGINT`', '`INTEGER` or `INT`', '`SMALLINT`', '`TINYINT`', '`BOOLEAN`', '`DATE`', '`DECIMAL`', '`REAL`', '`DOUBLE`', '`INTERVAL DAY TO SECOND`', '`INTERVAL YEAR TO MONTH`', '`TIMESTAMP` and `TIMESTAMP(P)`', '`TIMESTAMP WITH TIME ZONE` and `TIMESTAMP(P) WITH TIME ZONE`', '`TIME` and `TIME(P)`', '`TIME WITH TIME ZONE` and `TIME(P) WITH TIME ZONE`', '`ROW`', '`IPADDRESS`', '`UUID`']\\n\\nYou can not use generator expressions for non-character-based columns. To limit\\ntheir data range, set the `min` and `max` column properties - see\\n[](faker-usage).\", \"Unsupported types\": \"Faker does not support the following data types:\\n\\n['Structural types `ARRAY` and `MAP`', '`JSON`', 'Geometry', 'HyperLogLog and all digest types']\\n\\nTo generate data using these complex types, data from column of primitive types\\ncan be combined, like in the following example:\\n\\n```\\nCREATE TABLE faker.default.prices (\\n currency VARCHAR NOT NULL WITH (generator = '#{Currency.code}'),\\n price DECIMAL(8,2) NOT NULL WITH (min = '0')\\n);\\n\\nSELECT JSON_OBJECT(KEY currency VALUE price) AS complex\\nFROM faker.default.prices\\nLIMIT 3;\\n```\\n\\nRunning the queries returns data similar to the following result:\\n\\n```\\n complex\\n-------------------\\n {\\\"TTD\\\":924657.82}\\n {\\\"MRO\\\":968292.49}\\n {\\\"LTL\\\":357773.63}\\n(3 rows)\\n```\", \"Number of generated rows\": \"By default, the connector generates 1000 rows for every table. To control how\\nmany rows are generated for a table, use the `LIMIT` clause in the query. A\\ndefault limit can be set using the `default_limit` table, or schema property or\\nin the connector configuration file, using the `faker.default-limit` property.\\nUse a limit value higher than the configured default to return more rows.\", \"Null values\": \"For columns without a `NOT NULL` constraint, `null` values are generated using\\nthe default probability of 50%. It can be modified using the `null_probability`\\nproperty set for a column, table, or schema. The default value of 0.5 can be\\nalso modified in the catalog configuration file, by using the\\n`faker.null-probability` property.\\n\\n(faker-type-mapping)=\"}, \"Type mapping\": \"The Faker connector generates data itself, so no mapping is required.\\n\\n(faker-sql-support)=\", \"SQL support\": \"The connector provides [globally available](sql-globally-available) and [read\\noperation](sql-read-operations) statements to generate data.\\n\\nTo define the schema for generating data, it supports the following features:\\n\\n['[](/sql/create-table)', '[](/sql/create-table-as), see also [](faker-statistics)', '[](/sql/drop-table)', '[](/sql/create-schema)', '[](/sql/drop-schema)', '[](sql-view-management)']\\n\\n(faker-usage)=\", \"Usage\": {\"Using existing data statistics\": \"The Faker connector automatically sets the `default_limit` table property, and\\nthe `min`, `max`, and `null_probability` column properties, based on statistics\\ncollected by scanning existing data read by Trino from the data source. The\\nconnector uses these statistics to be able to generate data that is more similar\\nto the original data set, without using any of that data:\\n\\n```\\nCREATE TABLE generator.default.customer AS\\nSELECT *\\nFROM production.public.customer\\nWHERE created_at > CURRENT_DATE - INTERVAL '1' YEAR;\\n```\\n\\nInstead of using range, or other predicates, tables can be sampled,\\nsee [](tablesample).\\n\\nWhen the `SELECT` statement doesn't contain a `WHERE` clause, a shorter notation\\ncan be used:\\n\\n```\\nCREATE TABLE generator.default.customer AS TABLE production.public.customer;\\n```\\n\\nThe Faker connector detects sequence columns, which are integer column with the\\nnumber of distinct values almost equal to the number of rows in the table. For\\nsuch columns, Faker sets the `step` column property to 1.\\n\\nSequence detection can be turned off using the `sequence_detection_enabled`\\ntable, or schema property or in the connector configuration file, using the\\n`faker.sequence-detection-enabled` property.\\n\\nThe Faker connector detects dictionary columns, which are columns of\\nnon-character types with the number of distinct values lower or equal to 1000.\\nFor such columns, Faker generates a list of random values to choose from, and\\nsaves it in the `allowed_values` column property.\\n\\nDictionary detection can be turned off using the `dictionary_detection_enabled`\\ntable, or schema property or in the connector configuration file, using\\nthe `faker.dictionary-detection-enabled` property.\\n\\nFor example, copy the `orders` table from the TPC-H connector with\\nstatistics, using the following query:\\n\\n```\\nCREATE TABLE generator.default.orders AS TABLE tpch.tiny.orders;\\n```\\n\\nInspect the schema of the table created by the Faker connector:\\n\\n```\\nSHOW CREATE TABLE generator.default.orders;\\n```\\n\\nThe table schema should contain additional column and table properties.\\n\\n```\\nCREATE TABLE generator.default.orders (\\n orderkey bigint WITH (max = '60000', min = '1', null_probability = 0E0, step = '1'),\\n custkey bigint WITH (allowed_values = ARRAY['153','662','1453','63','784', ..., '1493','657'], null_probability = 0E0),\\n orderstatus varchar(1),\\n totalprice double WITH (max = '466001.28', min = '874.89', null_probability = 0E0),\\n orderdate date WITH (max = '1998-08-02', min = '1992-01-01', null_probability = 0E0),\\n orderpriority varchar(15),\\n clerk varchar(15),\\n shippriority integer WITH (allowed_values = ARRAY['0'], null_probability = 0E0),\\n comment varchar(79)\\n)\\nWITH (\\n default_limit = 15000\\n)\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 9]\"}, {\"title\": \"Google Sheets connector\", \"description\": null, \"content\": {\"Configuration\": \"Create `etc/catalog/example.properties` to mount the Google Sheets connector\\nas the `example` catalog, with the following contents:\\n\\n```\\nconnector.name=gsheets\\ngsheets.credentials-path=/path/to/google-sheets-credentials.json\\ngsheets.metadata-sheet-id=exampleId\\n```\", \"Configuration properties\": \"The following configuration properties are available:\\n\\n| Property name | Description |\\n|--------------------------------|-----------------------------------------------------------------------------------|\\n| `gsheets.credentials-path` | Path to the Google API JSON key file |\\n| `gsheets.credentials-key` | The base64 encoded credentials key |\\n| `gsheets.delegated-user-email` | User email to impersonate the service account with domain-wide delegation enabled |\\n| `gsheets.metadata-sheet-id` | Sheet ID of the spreadsheet, that contains the table mapping |\\n| `gsheets.max-data-cache-size` | Maximum number of spreadsheets to cache, defaults to `1000` |\\n| `gsheets.data-cache-ttl` | How long to cache spreadsheet data or metadata, defaults to `5m` |\\n| `gsheets.connection-timeout` | Timeout when connection to Google Sheets API, defaults to `20s` |\\n| `gsheets.read-timeout` | Timeout when reading from Google Sheets API, defaults to `20s` |\\n| `gsheets.write-timeout` | Timeout when writing to Google Sheets API, defaults to `20s` |\", \"Credentials\": \"The connector requires credentials in order to access the Google Sheets API.\\n\\n['Open the [Google Sheets API](https://console.developers.google.com/apis/library/sheets.googleapis.com)\\\\npage and click the *Enable* button. This takes you to the API manager page.', 'Select a project using the drop-down menu at the top of the page.\\\\nCreate a new project, if you do not already have one.', 'Choose *Credentials* in the left panel.', 'Click *Manage service accounts*, then create a service account for the connector.\\\\nOn the *Create key* step, create and download a key in JSON format.']\\n\\nThe key file needs to be available on the Trino coordinator and workers.\\nSet the `gsheets.credentials-path` configuration property to point to this file.\\nThe exact name of the file does not matter -- it can be named anything.\\n\\nAlternatively, set the `gsheets.credentials-key` configuration property.\\nIt should contain the contents of the JSON file, encoded using base64.\\n\\nOptionally, set the `gsheets.delegated-user-email` property to impersonate a user.\\nThis allows you to share Google Sheets with this email instead of the service account.\", \"Metadata sheet\": \"The metadata sheet is used to map table names to sheet IDs.\\nCreate a new metadata sheet. The first row must be a header row\\ncontaining the following columns in this order:\\n\\n['Table Name', 'Sheet ID', 'Owner (optional)', 'Notes (optional)']\\n\\nSee this [example sheet](https://docs.google.com/spreadsheets/d/1Es4HhWALUQjoa-bQh4a8B5HROz7dpGMfq_HbfoaW5LM)\\nas a reference.\\n\\nThe metadata sheet must be shared with the service account user,\\nthe one for which the key credentials file was created. Click the *Share*\\nbutton to share the sheet with the email address of the service account.\\n\\nSet the `gsheets.metadata-sheet-id` configuration property to the ID of this sheet.\", \"Querying sheets\": \"The service account user must have access to the sheet in order for Trino\\nto query it. Click the *Share* button to share the sheet with the email\\naddress of the service account.\\n\\nThe sheet needs to be mapped to a Trino table name. Specify a table name\\n(column A) and the sheet ID (column B) in the metadata sheet. To refer\\nto a specific range in the sheet, add the range after the sheet ID, separated\\nwith `#`. If a range is not provided, the connector loads only 10,000 rows by default from\\nthe first tab in the sheet.\\n\\nThe first row of the provided sheet range is used as the header and will determine the column\\nnames of the Trino table.\\nFor more details on sheet range syntax see the [google sheets docs](https://developers.google.com/sheets/api/guides/concepts).\", \"Writing to sheets\": \"The same way sheets can be queried, they can also be written by appending data to existing sheets.\\nIn this case the service account user must also have **Editor** permissions on the sheet.\\n\\nAfter data is written to a table, the table contents are removed from the cache\\ndescribed in [API usage limits](gsheets-api-usage). If the table is accessed\\nimmediately after the write, querying the Google Sheets API may not reflect the\\nchange yet. In that case the old version of the table is read and cached for the\\nconfigured amount of time, and it might take some time for the written changes\\nto propagate properly.\\n\\nKeep in mind that the Google Sheets API has [usage limits](https://developers.google.com/sheets/api/limits), that limit the speed of inserting data.\\nIf you run into timeouts you can increase timeout times to avoid `503: The service is currently unavailable` errors.\\n\\n(gsheets-api-usage)=\", \"API usage limits\": \"The Google Sheets API has [usage limits](https://developers.google.com/sheets/api/limits),\\nthat may impact the usage of this connector. Increasing the cache duration and/or size\\nmay prevent the limit from being reached. Running queries on the `information_schema.columns`\\ntable without a schema and table name filter may lead to hitting the limit, as this requires\\nfetching the sheet data for every table, unless it is already cached.\", \"Type mapping\": {\"Google Sheets type to Trino type mapping\": \"The connector maps Google Sheets types to the corresponding Trino types\\nfollowing this table:\\n\\n:::{list-table} Google Sheets type to Trino type mapping\\n:widths: 30, 20\\n:header-rows: 1\\n\\n[['Google Sheets type', 'Trino type'], ['`TEXT`', '`VARCHAR`\\\\n:::']]\\n\\nNo other types are supported.\\n\\n(google-sheets-sql-support)=\"}, \"SQL support\": {\"Table functions\": {\"`sheet(id, range) -> table`\": \"The `sheet` function allows you to query a Google Sheet directly without\\nspecifying it as a named table in the metadata sheet.\\n\\nFor example, for a catalog named 'example':\\n\\n```\\nSELECT *\\nFROM\\n TABLE(example.system.sheet(\\n id => 'googleSheetIdHere'));\\n```\\n\\nA sheet range or named range can be provided as an optional `range` argument.\\nThe default sheet range is `$1:$10000` if one is not provided:\\n\\n```\\nSELECT *\\nFROM\\n TABLE(example.system.sheet(\\n id => 'googleSheetIdHere',\\n range => 'TabName!A1:B4'));\\n```\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 10]\"}, {\"title\": \"Hive connector\", \"description\": null, \"content\": {\"Requirements\": \"The Hive connector requires a\\n{ref}`Hive metastore service <hive-thrift-metastore>` (HMS), or a compatible\\nimplementation of the Hive metastore, such as\\n{ref}`AWS Glue <hive-glue-metastore>`.\\n\\nYou must select and configure a [supported\\nfile system](hive-file-system-configuration) in your catalog configuration file.\\n\\nThe coordinator and all workers must have network access to the Hive metastore\\nand the storage system. Hive metastore access with the Thrift protocol defaults\\nto using port 9083.\\n\\nData files must be in a supported file format. File formats can be\\nconfigured using the [`format` table property](hive-table-properties)\\nand other specific properties:\\n\\n['{ref}`ORC <orc-format-configuration>`', '{ref}`Parquet <parquet-format-configuration>`', 'Avro']\\n\\nIn the case of serializable formats, only specific\\n[SerDes](https://www.wikipedia.org/wiki/SerDes) are allowed:\\n\\n['RCText - RCFile using `ColumnarSerDe`', 'RCBinary - RCFile using `LazyBinaryColumnarSerDe`', 'SequenceFile', 'CSV - using `org.apache.hadoop.hive.serde2.OpenCSVSerde`', 'JSON - using `org.apache.hive.hcatalog.data.JsonSerDe`', 'OPENX_JSON - OpenX JSON SerDe from `org.openx.data.jsonserde.JsonSerDe`. Find\\\\nmore [details about the Trino implementation in the source repository](https://github.com/trinodb/trino/tree/master/lib/trino-hive-formats/src/main/java/io/trino/hive/formats/line/openxjson/README.md).', 'TextFile', 'ESRI - using `com.esri.hadoop.hive.serde.EsriJsonSerDe`']\\n\\n(hive-configuration)=\", \"General configuration\": {\"Multiple Hive clusters\": \"You can have as many catalogs as you need, so if you have additional\\nHive clusters, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For\\nexample, if you name the property file `sales.properties`, Trino\\ncreates a catalog named `sales` using the configured connector.\\n\\n(hive-configuration-properties)=\", \"Hive general configuration properties\": \"The following table lists general configuration properties for the Hive\\nconnector. There are additional sets of configuration properties throughout the\\nHive connector documentation.\\n\\n:::{list-table} Hive general configuration properties\\n:widths: 35, 50, 15\\n:header-rows: 1\\n\\n[['Property Name', 'Description', 'Default'], ['`hive.recursive-directories`', 'Enable reading data from subdirectories of table or partition locations. If\\\\ndisabled, subdirectories are ignored. This is equivalent to the\\\\n`hive.mapred.supports.subdirectories` property in Hive.', '`false`'], ['`hive.ignore-absent-partitions`', 'Ignore partitions when the file system location does not exist rather than\\\\nfailing the query. This skips data that may be expected to be part of the\\\\ntable.', '`false`'], ['`hive.storage-format`', 'The default file format used when creating new tables.', '`ORC`'], ['`hive.orc.use-column-names`', 'Access ORC columns by name. By default, columns in ORC files are accessed by\\\\ntheir ordinal position in the Hive table definition. The equivalent catalog\\\\nsession property is `orc_use_column_names`. See also,\\\\n[](orc-format-configuration)', '`false`'], ['`hive.parquet.use-column-names`', 'Access Parquet columns by name by default. Set this property to `false` to\\\\naccess columns by their ordinal position in the Hive table definition. The\\\\nequivalent catalog session property is `parquet_use_column_names`. See also,\\\\n[](parquet-format-configuration)', '`true`'], ['`hive.parquet.time-zone`', 'Time zone for Parquet read and write.', 'JVM default'], ['`hive.compression-codec`', 'The compression codec to use when writing files. Possible values are `NONE`,\\\\n`SNAPPY`, `LZ4`, `ZSTD`, or `GZIP`.', '`GZIP`'], ['`hive.force-local-scheduling`', 'Force splits to be scheduled on the same node as the Hadoop DataNode process\\\\nserving the split data. This is useful for installations where Trino is\\\\ncollocated with every DataNode.', '`false`'], ['`hive.respect-table-format`', 'Should new partitions be written using the existing table format or the\\\\ndefault Trino format?', '`true`'], ['`hive.immutable-partitions`', 'Can new data be inserted into existing partitions? If `true` then setting\\\\n`hive.insert-existing-partitions-behavior` to `APPEND` is not allowed. This\\\\nalso affects the `insert_existing_partitions_behavior` session property in\\\\nthe same way.', '`false`'], ['`hive.insert-existing-partitions-behavior`', 'What happens when data is inserted into an existing partition? Possible\\\\nvalues are', ['`APPEND` - appends data to existing partitions', '`OVERWRITE` - overwrites existing partitions', '`ERROR` - modifying existing partitions is not allowed'], 'The equivalent catalog session property is `insert_existing_partitions_behavior`.', '`APPEND`'], ['`hive.target-max-file-size`', 'Best effort maximum size of new files.', '`1GB`'], ['`hive.create-empty-bucket-files`', 'Should empty files be created for buckets that have no data?', '`false`'], ['`hive.validate-bucketing`', 'Enables validation that data is in the correct bucket when reading bucketed\\\\ntables.', '`true`'], ['`hive.partition-statistics-sample-size`', 'Specifies the number of partitions to analyze when computing table\\\\nstatistics.', '100'], ['`hive.max-partitions-per-writers`', 'Maximum number of partitions per writer.', '100'], ['`hive.max-partitions-for-eager-load`', 'The maximum number of partitions for a single table scan to load eagerly on\\\\nthe coordinator. Certain optimizations are not possible without eager\\\\nloading.', '100,000'], ['`hive.max-partitions-per-scan`', 'Maximum number of partitions for a single table scan.', '1,000,000'], ['`hive.non-managed-table-writes-enabled`', 'Enable writes to non-managed (external) Hive tables.', '`false`'], ['`hive.non-managed-table-creates-enabled`', 'Enable creating non-managed (external) Hive tables.', '`true`'], ['`hive.collect-column-statistics-on-write`', 'Enables automatic column level statistics collection on write. See\\\\n[](hive-table-statistics) for details.', '`true`'], ['`hive.file-status-cache-tables`', 'Cache directory listing for specific tables. Examples:', ['`fruit.apple,fruit.orange` to cache listings only for tables\\\\n`apple` and `orange` in schema `fruit`', '`fruit.*,vegetable.*` to cache listings for all tables\\\\nin schemas `fruit` and `vegetable`', '`*` to cache listings for all tables in all schemas']], ['`hive.file-status-cache.excluded-tables`', 'Whereas `hive.file-status-cache-tables` is an inclusion list, this is an exclusion list for the cache. ', ['`fruit.apple,fruit.orange` to *NOT* cache listings only for tables\\\\n`apple` and `orange` in schema `fruit`', '`fruit.*,vegetable.*` to *NOT* cache listings for all tables\\\\nin schemas `fruit` and `vegetable`']], ['`hive.file-status-cache.max-retained-size`', 'Maximum retained size of cached file status entries.', '`1GB`'], ['`hive.file-status-cache-expire-time`', 'How long a cached directory listing is considered valid.', '`1m`'], ['`hive.per-transaction-file-status-cache.max-retained-size`', 'Maximum retained size of all entries in per transaction file status cache.\\\\nRetained size limit is shared across all running queries.', '`100MB`'], ['`hive.rcfile.time-zone`', 'Adjusts binary encoded timestamp values to a specific time zone. For Hive\\\\n3.1+, this must be set to UTC.', 'JVM default'], ['`hive.timestamp-precision`', 'Specifies the precision to use for Hive columns of type `TIMESTAMP`.\\\\nPossible values are `MILLISECONDS`, `MICROSECONDS` and `NANOSECONDS`.\\\\nValues with higher precision than configured are rounded. The equivalent\\\\n[catalog session property](/sql/set-session) is `timestamp_precision` for\\\\nsession specific use.', '`MILLISECONDS`'], ['`hive.temporary-staging-directory-enabled`', 'Controls whether the temporary staging directory configured at\\\\n`hive.temporary-staging-directory-path` is used for write operations.\\\\nTemporary staging directory is never used for writes to non-sorted tables on\\\\nS3, encrypted HDFS or external location. Writes to sorted tables will\\\\nutilize this path for staging temporary files during sorting operation. When\\\\ndisabled, the target storage will be used for staging while writing sorted\\\\ntables which can be inefficient when writing to object stores like S3.', '`true`'], ['`hive.temporary-staging-directory-path`', 'Controls the location of temporary staging directory that is used for write\\\\noperations. The `${USER}` placeholder can be used to use a different\\\\nlocation for each user.', '`/tmp/presto-${USER}`'], ['`hive.hive-views.enabled`', 'Enable translation for [Hive views](hive-views).', '`false`'], ['`hive.hive-views.legacy-translation`', 'Use the legacy algorithm to translate [Hive views](hive-views). You\\\\ncan use the `hive_views_legacy_translation` catalog session property for\\\\ntemporary, catalog specific use.', '`false`'], ['`hive.parallel-partitioned-bucketed-writes`', 'Improve parallelism of partitioned and bucketed table writes. When disabled,\\\\nthe number of writing threads is limited to number of buckets.', '`true`'], ['`hive.query-partition-filter-required`', 'Set to `true` to force a query to use a partition filter. You can use the\\\\n`query_partition_filter_required` catalog session property for temporary,\\\\ncatalog specific use.', '`false`'], ['`hive.query-partition-filter-required-schemas`', 'Allow specifying the list of schemas for which Trino will enforce that\\\\nqueries use a filter on partition keys for source tables. The list can be\\\\nspecified using the `hive.query-partition-filter-required-schemas`,\\\\nor the `query_partition_filter_required_schemas` session property. The list\\\\nis taken into consideration only if the `hive.query-partition-filter-required`\\\\nconfiguration property or the `query_partition_filter_required` session\\\\nproperty is set to `true`.', '`[]`'], ['`hive.table-statistics-enabled`', 'Enables [](/optimizer/statistics). The equivalent [catalog session\\\\nproperty](/sql/set-session) is `statistics_enabled` for session specific\\\\nuse. Set to `false` to disable statistics. Disabling statistics means that\\\\n[](/optimizer/cost-based-optimizations) can not make smart decisions about\\\\nthe query plan.', '`true`'], ['`hive.auto-purge`', 'Set the default value for the auto_purge table property for managed tables.\\\\nSee the [](hive-table-properties) for more information on auto_purge.', '`false`'], ['`hive.partition-projection-enabled`', 'Enables Athena partition projection support', '`true`'], ['`hive.s3-glacier-filter`', 'Filter S3 objects based on their storage class and restored status if applicable. Possible\\\\nvalues are', ['`READ_ALL` - read files from all S3 storage classes', '`READ_NON_GLACIER` - read files from non S3 Glacier storage classes', '`READ_NON_GLACIER_AND_RESTORED` - read files from non S3 Glacier storage classes and \\\\nrestored objects from Glacier storage class'], '`READ_ALL`'], ['`hive.max-partition-drops-per-query`', 'Maximum number of partitions to drop in a single query.', '100,000'], ['`hive.metastore.partition-batch-size.max`', 'Maximum number of partitions processed in a single batch.', '100'], ['`hive.single-statement-writes`', 'Enables auto-commit for all writes. This can be used to disallow\\\\nmulti-statement write transactions.', '`false`'], ['`hive.metadata.parallelism`', 'Number of threads used for retrieving metadata. Currently, only table loading\\\\nis parallelized.', '`8`\\\\n:::']]\\n\\n(hive-file-system-configuration)=\", \"File system access configuration\": \"The connector supports accessing the following file systems:\\n\\n['[](/object-storage/file-system-azure)', '[](/object-storage/file-system-gcs)', '[](/object-storage/file-system-s3)', '[](/object-storage/file-system-hdfs)']\\n\\nYou must enable and configure the specific file system access. [Legacy\\nsupport](file-system-legacy) is not recommended and will be removed.\\n\\n(hive-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy\\non non-transactional tables.\\n\\nRead operations are supported with any retry policy on transactional tables.\\nWrite operations and `CREATE TABLE ... AS` operations are not supported with\\nany retry policy on transactional tables.\\n\\n(hive-security)=\"}, \"Security\": \"The connector supports different means of authentication for the used [file\\nsystem](hive-file-system-configuration) and [metastore](hive-configuration).\\n\\nIn addition, the following security-related features are supported.\\n\\n(hive-authorization)=\", \"Authorization\": {\"SQL standard based authorization\": \"When `sql-standard` security is enabled, Trino enforces the same SQL\\nstandard-based authorization as Hive does.\\n\\nSince Trino's `ROLE` syntax support matches the SQL standard, and\\nHive does not exactly follow the SQL standard, there are the following\\nlimitations and differences:\\n\\n['`CREATE ROLE role WITH ADMIN` is not supported.', 'The `admin` role must be enabled to execute `CREATE ROLE`, `DROP ROLE` or `CREATE SCHEMA`.', '`GRANT role TO user GRANTED BY someone` is not supported.', '`REVOKE role FROM user GRANTED BY someone` is not supported.', \\\"By default, all a user's roles, except `admin`, are enabled in a new user session.\\\", 'One particular role can be selected by executing `SET ROLE role`.', \\\"`SET ROLE ALL` enables all of a user's roles except `admin`.\\\", 'The `admin` role must be enabled explicitly by executing `SET ROLE admin`.', '`GRANT privilege ON SCHEMA schema` is not supported. Schema ownership can be\\\\nchanged with `ALTER SCHEMA schema SET AUTHORIZATION user`']\\n\\n(hive-sql-support)=\"}, \"SQL support\": {\"Basic usage examples\": \"The examples shown here work on Google Cloud Storage by replacing `s3://` with\\n`gs://`.\\n\\nCreate a new Hive table named `page_views` in the `web` schema\\nthat is stored using the ORC file format, partitioned by date and\\ncountry, and bucketed by user into `50` buckets. Note that Hive\\nrequires the partition columns to be the last columns in the table:\\n\\n```\\nCREATE TABLE example.web.page_views (\\n view_time TIMESTAMP,\\n user_id BIGINT,\\n page_url VARCHAR,\\n ds DATE,\\n country VARCHAR\\n)\\nWITH (\\n format = 'ORC',\\n partitioned_by = ARRAY['ds', 'country'],\\n bucketed_by = ARRAY['user_id'],\\n bucket_count = 50\\n)\\n```\\n\\nCreate a new Hive schema named `web` that stores tables in an\\nS3 bucket named `my-bucket`:\\n\\n```\\nCREATE SCHEMA example.web\\nWITH (location = 's3://my-bucket/')\\n```\\n\\nDrop a schema:\\n\\n```\\nDROP SCHEMA example.web\\n```\\n\\nDrop a partition from the `page_views` table:\\n\\n```\\nDELETE FROM example.web.page_views\\nWHERE ds = DATE '2016-08-09'\\n AND country = 'US'\\n```\\n\\nQuery the `page_views` table:\\n\\n```\\nSELECT * FROM example.web.page_views\\n```\\n\\nList the partitions of the `page_views` table:\\n\\n```\\nSELECT * FROM example.web.\\\"page_views$partitions\\\"\\n```\\n\\nCreate an external Hive table named `request_logs` that points at\\nexisting data in S3:\\n\\n```\\nCREATE TABLE example.web.request_logs (\\n request_time TIMESTAMP,\\n url VARCHAR,\\n ip VARCHAR,\\n user_agent VARCHAR\\n)\\nWITH (\\n format = 'TEXTFILE',\\n external_location = 's3://my-bucket/data/logs/'\\n)\\n```\\n\\nCollect statistics for the `request_logs` table:\\n\\n```\\nANALYZE example.web.request_logs;\\n```\\n\\nDrop the external table `request_logs`. This only drops the metadata\\nfor the table. The referenced data directory is not deleted:\\n\\n```\\nDROP TABLE example.web.request_logs\\n```\\n\\n['{doc}`/sql/create-table-as` can be used to create transactional tables in ORC format like this:', \\\"```\\\\nCREATE TABLE <name>\\\\nWITH (\\\\n format='ORC',\\\\n transactional=true\\\\n)\\\\nAS <query>\\\\n```\\\"]\\n\\nAdd an empty partition to the `page_views` table:\\n\\n```\\nCALL system.create_empty_partition(\\n schema_name => 'web',\\n table_name => 'page_views',\\n partition_columns => ARRAY['ds', 'country'],\\n partition_values => ARRAY['2016-08-09', 'US']);\\n```\\n\\nDrop stats for a partition of the `page_views` table:\\n\\n```\\nCALL system.drop_stats(\\n schema_name => 'web',\\n table_name => 'page_views',\\n partition_values => ARRAY[ARRAY['2016-08-09', 'US']]);\\n```\\n\\n(hive-procedures)=\", \"Procedures\": \"Use the {doc}`/sql/call` statement to perform data manipulation or\\nadministrative tasks. Procedures must include a qualified catalog name, if your\\nHive catalog is called `web`:\\n\\n```\\nCALL web.system.example_procedure()\\n```\\n\\nThe following procedures are available:\\n\\n['`system.create_empty_partition(schema_name, table_name, partition_columns, partition_values)`', 'Create an empty partition in the specified table.', '`system.sync_partition_metadata(schema_name, table_name, mode, case_sensitive)`', 'Check and update partitions list in metastore. There are three modes available:', ['`ADD` : add any partitions that exist on the file system, but not in the metastore.', '`DROP`: drop any partitions that exist in the metastore, but not on the file system.', '`FULL`: perform both `ADD` and `DROP`.'], \\\"The `case_sensitive` argument is optional. The default value is `true` for compatibility\\\\nwith Hive's `MSCK REPAIR TABLE` behavior, which expects the partition column names in\\\\nfile system paths to use lowercase (e.g. `col_x=SomeValue`). Partitions on the file system\\\\nnot conforming to this convention are ignored, unless the argument is set to `false`.\\\", '`system.drop_stats(schema_name, table_name, partition_values)`', 'Drops statistics for a subset of partitions or the entire table. The partitions are specified as an\\\\narray whose elements are arrays of partition values (similar to the `partition_values` argument in\\\\n`create_empty_partition`). If `partition_values` argument is omitted, stats are dropped for the\\\\nentire table.']\\n\\n(register-partition)=\\n\\n['`system.register_partition(schema_name, table_name, partition_columns, partition_values, location)`', 'Registers existing location as a new partition in the metastore for the specified table.', 'When the `location` argument is omitted, the partition location is\\\\nconstructed using `partition_columns` and `partition_values`.', 'Due to security reasons, the procedure is enabled only when `hive.allow-register-partition-procedure`\\\\nis set to `true`.']\\n\\n(unregister-partition)=\\n\\n['`system.unregister_partition(schema_name, table_name, partition_columns, partition_values)`', 'Unregisters given, existing partition in the metastore for the specified table.\\\\nThe partition data is not deleted.']\\n\\n(hive-flush-metadata-cache)=\\n\\n['`system.flush_metadata_cache()`', 'Flush all Hive metadata caches.', '`system.flush_metadata_cache(schema_name => ..., table_name => ...)`', 'Flush Hive metadata caches entries connected with selected table.\\\\nProcedure requires named parameters to be passed', '`system.flush_metadata_cache(schema_name => ..., table_name => ..., partition_columns => ARRAY[...], partition_values => ARRAY[...])`', 'Flush Hive metadata cache entries connected with selected partition.\\\\nProcedure requires named parameters to be passed.']\\n\\n(hive-data-management)=\", \"Data management\": \"The {ref}`sql-data-management` functionality includes support for `INSERT`,\\n`UPDATE`, `DELETE`, and `MERGE` statements, with the exact support\\ndepending on the storage system, file format, and metastore.\\n\\nWhen connecting to a Hive metastore version 3.x, the Hive connector supports\\nreading from and writing to insert-only and ACID tables, with full support for\\npartitioning and bucketing.\\n\\n{doc}`/sql/delete` applied to non-transactional tables is only supported if the\\ntable is partitioned and the `WHERE` clause matches entire partitions.\\nTransactional Hive tables with ORC format support \\\"row-by-row\\\" deletion, in\\nwhich the `WHERE` clause may match arbitrary sets of rows.\\n\\n{doc}`/sql/update` is only supported for transactional Hive tables with format\\nORC. `UPDATE` of partition or bucket columns is not supported.\\n\\n{doc}`/sql/merge` is only supported for ACID tables.\\n\\nACID tables created with [Hive Streaming Ingest](https://cwiki.apache.org/confluence/display/Hive/Streaming+Data+Ingest)\\nare not supported.\\n\\n(hive-schema-and-table-management)=\", \"Schema and table management\": {\"Schema evolution\": \"Hive table partitions can differ from the current table schema. This occurs when\\nthe data types of columns of a table are changed from the data types of columns\\nof preexisting partitions. The Hive connector supports this schema evolution by\\nallowing the same conversions as Hive. The following table lists possible data\\ntype conversions.\\n\\n:::{list-table} Hive schema evolution type conversion\\n:widths: 25, 75\\n:header-rows: 1\\n\\n[['Data type', 'Converted to'], ['`BOOLEAN`', '`VARCHAR`'], ['`VARCHAR`', '`BOOLEAN`, `TINYINT`, `SMALLINT`, `INTEGER`, `BIGINT`, `REAL`, `DOUBLE`, `TIMESTAMP`, `DATE`, `CHAR` as well as\\\\nnarrowing conversions for `VARCHAR`'], ['`CHAR`', '`VARCHAR`, narrowing conversions for `CHAR`'], ['`TINYINT`', '`VARCHAR`, `SMALLINT`, `INTEGER`, `BIGINT`, `DOUBLE`, `DECIMAL`'], ['`SMALLINT`', '`VARCHAR`, `INTEGER`, `BIGINT`, `DOUBLE`, `DECIMAL`'], ['`INTEGER`', '`VARCHAR`, `BIGINT`, `DOUBLE`, `DECIMAL`'], ['`BIGINT`', '`VARCHAR`, `DOUBLE`, `DECIMAL`'], ['`REAL`', '`DOUBLE`, `DECIMAL`'], ['`DOUBLE`', '`FLOAT`, `DECIMAL`'], ['`DECIMAL`', '`DOUBLE`, `REAL`, `VARCHAR`, `TINYINT`, `SMALLINT`, `INTEGER`, `BIGINT`, as\\\\nwell as narrowing and widening conversions for `DECIMAL`'], ['`DATE`', '`VARCHAR`'], ['`TIMESTAMP`', '`VARCHAR`, `DATE`'], ['`VARBINARY`', '`VARCHAR`\\\\n:::']]\\n\\nAny conversion failure results in null, which is the same behavior\\nas Hive. For example, converting the string `'foo'` to a number,\\nor converting the string `'1234'` to a `TINYINT` (which has a\\nmaximum value of `127`).\\n\\n(hive-avro-schema)=\", \"Avro schema evolution\": {\"Limitations\": \"The following operations are not supported when `avro_schema_url` is set:\\n\\n['`CREATE TABLE AS` is not supported.', 'Bucketing(`bucketed_by`) columns are not supported in `CREATE TABLE`.', '`ALTER TABLE` commands modifying columns are not supported.']\\n\\n(hive-alter-table-execute)=\"}, \"ALTER TABLE EXECUTE\": \"The connector supports the following commands for use with {ref}`ALTER TABLE\\nEXECUTE <alter-table-execute>`.\\n\\n```\\n```\\n\\nThe `optimize` command is disabled by default, and can be enabled for a\\ncatalog with the `<catalog-name>.non_transactional_optimize_enabled`\\nsession property:\\n\\n```\\nSET SESSION <catalog_name>.non_transactional_optimize_enabled=true\\n```\\n\\n:::{warning}\\nBecause Hive tables are non-transactional, take note of the following possible\\noutcomes:\\n\\n['If queries are run against tables that are currently being optimized,\\\\nduplicate rows may be read.', 'In rare cases where exceptions occur during the `optimize` operation,\\\\na manual cleanup of the table directory is needed. In this situation, refer\\\\nto the Trino logs and query failure messages to see which files must be\\\\ndeleted.\\\\n:::']\\n\\n(hive-table-properties)=\", \"Table properties\": \"Table properties supply or set metadata for the underlying tables. This\\nis key for {doc}`/sql/create-table-as` statements. Table properties are passed\\nto the connector using a {doc}`WITH </sql/create-table-as>` clause:\\n\\n```\\nCREATE TABLE tablename\\nWITH (format='CSV',\\n csv_escape = '\\\"')\\n```\\n\\n:::{list-table} Hive connector table properties\\n:widths: 20, 60, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`auto_purge`', 'Indicates to the configured metastore to perform a purge when a table or\\\\npartition is deleted instead of a soft deletion using the trash.'], ['`avro_schema_url`', 'The URI pointing to [](hive-avro-schema) for the table.'], ['`bucket_count`', 'The number of buckets to group data into. Only valid if used with\\\\n`bucketed_by`.', '0'], ['`bucketed_by`', 'The bucketing column for the storage table. Only valid if used with\\\\n`bucket_count`.', '`[]`'], ['`bucketing_version`', 'Specifies which Hive bucketing version to use. Valid values are `1` or `2`.'], ['`csv_escape`', 'The CSV escape character. Requires CSV format.'], ['`csv_quote`', 'The CSV quote character. Requires CSV format.'], ['`csv_separator`', \\\"The CSV separator character. Requires CSV format. You can use other\\\\nseparators such as `|` or use Unicode to configure invisible separators such\\\\ntabs with `U&'\\\\\\\\0009'`.\\\", '`,`'], ['`external_location`', 'The URI for an external Hive table on S3, Azure Blob Storage, etc. See the\\\\n[](hive-examples) for more information.'], ['`format`', 'The table file format. Valid values include `ORC`, `PARQUET`, `AVRO`,\\\\n`RCBINARY`, `RCTEXT`, `SEQUENCEFILE`, `JSON`, `OPENX_JSON`, `TEXTFILE`,\\\\n`CSV`, and `REGEX`. The catalog property `hive.storage-format` sets the\\\\ndefault value and can change it to a different default.'], ['`null_format`', 'The serialization format for `NULL` value. Requires TextFile, RCText, or\\\\nSequenceFile format.'], ['`orc_bloom_filter_columns`', 'Comma separated list of columns to use for ORC bloom filter. It improves the\\\\nperformance of queries using equality predicates, such as `=`, `IN` and\\\\nsmall range predicates, when reading ORC files. Requires ORC format.', '`[]`'], ['`orc_bloom_filter_fpp`', 'The ORC bloom filters false positive probability. Requires ORC format.', '0.05'], ['`partitioned_by`', 'The partitioning column for the storage table. The columns listed in the\\\\n`partitioned_by` clause must be the last columns as defined in the DDL.', '`[]`'], ['`parquet_bloom_filter_columns`', 'Comma separated list of columns to use for Parquet bloom filter. It improves\\\\nthe performance of queries using equality predicates, such as `=`, `IN` and\\\\nsmall range predicates, when reading Parquet files. Requires Parquet format.', '`[]`'], ['`skip_footer_line_count`', 'The number of footer lines to ignore when parsing the file for data.\\\\nRequires TextFile or CSV format tables.'], ['`skip_header_line_count`', 'The number of header lines to ignore when parsing the file for data.\\\\nRequires TextFile or CSV format tables.'], ['`sorted_by`', 'The column to sort by to determine bucketing for row. Only valid if\\\\n`bucketed_by` and `bucket_count` are specified as well.', '`[]`'], ['`textfile_field_separator`', \\\"Allows the use of custom field separators, such as '|', for TextFile\\\\nformatted tables.\\\"], ['`textfile_field_separator_escape`', 'Allows the use of a custom escape character for TextFile formatted tables.'], ['`transactional`', 'Set this property to `true` to create an ORC ACID transactional table.\\\\nRequires ORC format. This property may be shown as true for insert-only\\\\ntables created using older versions of Hive.'], ['`partition_projection_enabled`', 'Enables partition projection for selected table. Mapped from AWS Athena\\\\ntable property\\\\n[projection.enabled](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-setting-up.html).'], ['`partition_projection_ignore`', 'Ignore any partition projection properties stored in the metastore for the\\\\nselected table. This is a Trino-only property which allows you to work\\\\naround compatibility issues on a specific table, and if enabled, Trino\\\\nignores all other configuration options related to partition projection.'], ['`partition_projection_location_template`', 'Projected partition location template, such as `s3a://test/name=${name}/`.\\\\nMapped from the AWS Athena table property\\\\n[storage.location.template](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-setting-up.html#partition-projection-specifying-custom-s3-storage-locations)', '`${table_location}/${partition_name}`'], ['`extra_properties`', 'Additional properties added to a Hive table. The properties are not used by\\\\nTrino, and are available in the `$properties` metadata table. The properties\\\\nare not included in the output of `SHOW CREATE TABLE` statements.']]\\n\\n:::\\n\\n(hive-special-tables)=\", \"Metadata tables\": {\"`$properties` table\": \"The properties table name is composed with the table name and `$properties` appended.\\nIt exposes the parameters of the table in the metastore.\\n\\nYou can inspect the property names and values with a simple query:\\n\\n```\\nSELECT * FROM example.web.\\\"page_views$properties\\\";\\n```\\n\\n```\\n stats_generated_via_stats_task | auto.purge | trino_query_id | trino_version | transactional\\n---------------------------------------------+------------+-----------------------------+---------------+---------------\\n workaround for potential lack of HIVE-12730 | false | 20230705_152456_00001_nfugi | 434 | false\\n```\", \"`$partitions` table\": \"The `$partitions` table provides a list of all partition values\\nof a partitioned table.\\n\\nThe following example query returns all partition values from the\\n`page_views` table in the `web` schema of the `example` catalog:\\n\\n```\\nSELECT * FROM example.web.\\\"page_views$partitions\\\";\\n```\\n\\n```\\n day | country\\n------------+---------\\n 2023-07-01 | POL\\n 2023-07-02 | POL\\n 2023-07-03 | POL\\n 2023-03-01 | USA\\n 2023-03-02 | USA\\n```\\n\\n(hive-column-properties)=\"}, \"Column properties\": \":::{list-table} Hive connector column properties\\n:widths: 20, 60, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`partition_projection_type`', 'Defines the type of partition projection to use on this column. May be used\\\\nonly on partition columns. Available types: `ENUM`, `INTEGER`, `DATE`,\\\\n`INJECTED`. Mapped from the AWS Athena table property\\\\n[projection.${columnName}.type](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).'], ['`partition_projection_values`', 'Used with `partition_projection_type` set to `ENUM`. Contains a static list\\\\nof values used to generate partitions. Mapped from the AWS Athena table\\\\nproperty\\\\n[projection.${columnName}.values](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).'], ['`partition_projection_range`', \\\"Used with `partition_projection_type` set to `INTEGER` or `DATE` to define a\\\\nrange. It is a two-element array, describing the minimum and maximum range\\\\nvalues used to generate partitions. Generation starts from the minimum, then\\\\nincrements by the defined `partition_projection_interval` to the maximum.\\\\nFor example, the format is `['1', '4']` for a `partition_projection_type` of\\\\n`INTEGER` and `['2001-01-01', '2001-01-07']` or `['NOW-3DAYS', 'NOW']` for a\\\\n`partition_projection_type` of `DATE`. Mapped from the AWS Athena table\\\\nproperty\\\\n[projection.${columnName}.range](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).\\\"], ['`partition_projection_interval`', 'Used with `partition_projection_type` set to `INTEGER` or `DATE`. It\\\\nrepresents the interval used to generate partitions within the given range\\\\n`partition_projection_range`. Mapped from the AWS Athena table property\\\\n[projection.${columnName}.interval](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).'], ['`partition_projection_digits`', 'Used with `partition_projection_type` set to `INTEGER`. The number of digits\\\\nto be used with integer column projection. Mapped from the AWS Athena table\\\\nproperty\\\\n[projection.${columnName}.digits](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).'], ['`partition_projection_format`', 'Used with `partition_projection_type` set to `DATE`. The date column\\\\nprojection format, defined as a string such as `yyyy MM` or `MM-dd-yy\\\\nHH:mm:ss` for use with the [Java DateTimeFormatter\\\\nclass](https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html).\\\\nMapped from the AWS Athena table property\\\\n[projection.${columnName}.format](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).'], ['`partition_projection_interval_unit`', 'Used with `partition_projection_type=DATA`. The date column projection range\\\\ninterval unit given in `partition_projection_interval`. Mapped from the AWS\\\\nAthena table property\\\\n[projection.${columnName}.interval.unit](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html).']]\\n\\n:::\\n\\n(hive-special-columns)=\", \"Metadata columns\": \"In addition to the defined columns, the Hive connector automatically exposes\\nmetadata in a number of hidden columns in each table:\\n\\n['`$bucket`: Bucket number for this row', '`$path`: Full file system path name of the file for this row', '`$file_modified_time`: Date and time of the last modification of the file for this row', '`$file_size`: Size of the file for this row', '`$partition`: Partition name for this row']\\n\\nYou can use these columns in your SQL statements like any other column. They\\ncan be selected directly, or used in conditional statements. For example, you\\ncan inspect the file size, location and partition for each record:\\n\\n```\\nSELECT *, \\\"$path\\\", \\\"$file_size\\\", \\\"$partition\\\"\\nFROM example.web.page_views;\\n```\\n\\nRetrieve all records that belong to files stored in the partition\\n`ds=2016-08-09/country=US`:\\n\\n```\\nSELECT *, \\\"$path\\\", \\\"$file_size\\\"\\nFROM example.web.page_views\\nWHERE \\\"$partition\\\" = 'ds=2016-08-09/country=US'\\n```\\n\\n(hive-sql-view-management)=\"}, \"View management\": {\"Materialized views\": \"The Hive connector supports reading from Hive materialized views.\\nIn Trino, these views are presented as regular, read-only tables.\\n\\n(hive-views)=\", \"Hive views\": \"Hive views are defined in HiveQL and stored in the Hive Metastore Service. They\\nare analyzed to allow read access to the data.\\n\\nThe Hive connector includes support for reading Hive views with three different\\nmodes.\\n\\n['Disabled', 'Legacy', 'Experimental']\\n\\nIf using Hive views from Trino is required, you must compare results in Hive and\\nTrino for each view definition to ensure identical results. Use the experimental\\nmode whenever possible. Avoid using the legacy mode. Leave Hive views support\\ndisabled, if you are not accessing any Hive views from Trino.\\n\\nYou can configure the behavior in your catalog properties file.\\n\\nBy default, Hive views are executed with the `RUN AS DEFINER` security mode.\\nSet the `hive.hive-views.run-as-invoker` catalog configuration property to\\n`true` to use `RUN AS INVOKER` semantics.\\n\\n**Disabled**\\n\\nThe default behavior is to ignore Hive views. This means that your business\\nlogic and data encoded in the views is not available in Trino.\\n\\n**Legacy**\\n\\nA very simple implementation to execute Hive views, and therefore allow read\\naccess to the data in Trino, can be enabled with\\n`hive.hive-views.enabled=true` and\\n`hive.hive-views.legacy-translation=true`.\\n\\nFor temporary usage of the legacy behavior for a specific catalog, you can set\\nthe `hive_views_legacy_translation` {doc}`catalog session property\\n</sql/set-session>` to `true`.\\n\\nThis legacy behavior interprets any HiveQL query that defines a view as if it\\nis written in SQL. It does not do any translation, but instead relies on the\\nfact that HiveQL is very similar to SQL.\\n\\nThis works for very simple Hive views, but can lead to problems for more complex\\nqueries. For example, if a HiveQL function has an identical signature but\\ndifferent behaviors to the SQL version, the returned results may differ. In more\\nextreme cases the queries might fail, or not even be able to be parsed and\\nexecuted.\\n\\n**Experimental**\\n\\nThe new behavior is better engineered and has the potential to become a lot\\nmore powerful than the legacy implementation. It can analyze, process, and\\nrewrite Hive views and contained expressions and statements.\\n\\nIt supports the following Hive view functionality:\\n\\n['`UNION [DISTINCT]` and `UNION ALL` against Hive views', 'Nested `GROUP BY` clauses', '`current_user()`', '`LATERAL VIEW OUTER EXPLODE`', '`LATERAL VIEW [OUTER] EXPLODE` on array of struct', '`LATERAL VIEW json_tuple`']\\n\\nYou can enable the experimental behavior with\\n`hive.hive-views.enabled=true`. Remove the\\n`hive.hive-views.legacy-translation` property or set it to `false` to make\\nsure legacy is not enabled.\\n\\nKeep in mind that numerous features are not yet implemented when experimenting\\nwith this feature. The following is an incomplete list of **missing**\\nfunctionality:\\n\\n['HiveQL `current_date`, `current_timestamp`, and others', 'Hive function calls including `translate()`, window functions, and others', 'Common table expressions and simple case expressions', 'Honor timestamp precision setting', 'Support all Hive data types and correct mapping to Trino types', 'Ability to process custom UDFs']\"}}, \"Performance\": {\"Table statistics\": {\"Updating table and partition statistics\": \"If your queries are complex and include joining large data sets,\\nrunning {doc}`/sql/analyze` on tables/partitions may improve query performance\\nby collecting statistical information about the data.\\n\\nWhen analyzing a partitioned table, the partitions to analyze can be specified\\nvia the optional `partitions` property, which is an array containing\\nthe values of the partition keys in the order they are declared in the table schema:\\n\\n```\\nANALYZE table_name WITH (\\n partitions = ARRAY[\\n ARRAY['p1_value1', 'p1_value2'],\\n ARRAY['p2_value1', 'p2_value2']])\\n```\\n\\nThis query will collect statistics for two partitions with keys\\n`p1_value1, p1_value2` and `p2_value1, p2_value2`.\\n\\nOn wide tables, collecting statistics for all columns can be expensive and can have a\\ndetrimental effect on query planning. It is also typically unnecessary - statistics are\\nonly useful on specific columns, like join keys, predicates, grouping keys. One can\\nspecify a subset of columns to be analyzed via the optional `columns` property:\\n\\n```\\nANALYZE table_name WITH (\\n partitions = ARRAY[ARRAY['p2_value1', 'p2_value2']],\\n columns = ARRAY['col_1', 'col_2'])\\n```\\n\\nThis query collects statistics for columns `col_1` and `col_2` for the partition\\nwith keys `p2_value1, p2_value2`.\\n\\nNote that if statistics were previously collected for all columns, they must be dropped\\nbefore re-analyzing just a subset:\\n\\n```\\nCALL system.drop_stats('schema_name', 'table_name')\\n```\\n\\nYou can also drop statistics for selected partitions only:\\n\\n```\\nCALL system.drop_stats(\\n schema_name => 'schema',\\n table_name => 'table',\\n partition_values => ARRAY[ARRAY['p2_value1', 'p2_value2']])\\n```\\n\\n(hive-dynamic-filtering)=\"}, \"Dynamic filtering\": {\"Delaying execution for dynamic filters\": \"It can often be beneficial to wait for the collection of dynamic filters before starting\\na table scan. This extra wait time can potentially result in significant overall savings\\nin query and CPU time, if dynamic filtering is able to reduce the amount of scanned data.\\n\\nFor the Hive connector, a table scan can be delayed for a configured amount of\\ntime until the collection of dynamic filters by using the configuration property\\n`hive.dynamic-filtering.wait-timeout` in the catalog file or the catalog\\nsession property `<hive-catalog>.dynamic_filtering_wait_timeout`.\\n\\n(hive-table-redirection)=\"}, \"Table redirection\": \"```\\n```\\n\\nThe connector supports redirection from Hive tables to Iceberg, Delta Lake, and\\nHudi tables with the following catalog configuration properties:\\n\\n['`hive.iceberg-catalog-name`: Name of the catalog, configured with the\\\\n[](/connector/iceberg), to use for reading Iceberg tables.', '`hive.delta-lake-catalog-name`: Name of the catalog, configured with the\\\\n[](/connector/delta-lake), to use for reading Delta Lake tables.', '`hive.hudi-catalog-name`: Name of the catalog, configured with the\\\\n[](/connector/hudi), to use for reading Hudi tables.']\", \"File system cache\": \"The connector supports configuring and using [file system\\ncaching](/object-storage/file-system-cache).\\n\\n(hive-performance-tuning-configuration)=\", \"Performance tuning configuration properties\": \"The following table describes performance tuning properties for the Hive\\nconnector.\\n\\n:::{warning}\\nPerformance tuning configuration properties are considered expert-level\\nfeatures. Altering these properties from their default values is likely to\\ncause instability and performance degradation.\\n:::\\n\\n:::{list-table}\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default value'], ['`hive.max-outstanding-splits`', 'The target number of buffered splits for each table scan in a query, before\\\\nthe scheduler tries to pause.', '`1000`'], ['`hive.max-outstanding-splits-size`', 'The maximum size allowed for buffered splits for each table scan in a query,\\\\nbefore the query fails.', '`256 MB`'], ['`hive.max-splits-per-second`', 'The maximum number of splits generated per second per table scan. This can\\\\nbe used to reduce the load on the storage system. By default, there is no\\\\nlimit, which results in Trino maximizing the parallelization of data access.'], ['`hive.max-initial-splits`', 'For each table scan, the coordinator first assigns file sections of up to\\\\n`max-initial-split-size`. After `max-initial-splits` have been assigned,\\\\n`max-split-size` is used for the remaining splits.', '`200`'], ['`hive.max-initial-split-size`', 'The size of a single file section assigned to a worker until\\\\n`max-initial-splits` have been assigned. Smaller splits results in more\\\\nparallelism, which gives a boost to smaller queries.', '`32 MB`'], ['`hive.max-split-size`', 'The largest size of a single file section assigned to a worker. Smaller\\\\nsplits result in more parallelism and thus can decrease latency, but\\\\nalso have more overhead and increase load on the system.', '`64 MB`\\\\n:::']]\"}, \"Hive 3-related limitations\": [\"For security reasons, the `sys` system catalog is not accessible.\", \"Hive's `timestamp with local zone` data type is mapped to\\n`timestamp with time zone` with UTC timezone. It only supports reading\\nvalues - writing to tables with columns of this type is not supported.\", \"Due to Hive issues [HIVE-21002](https://issues.apache.org/jira/browse/HIVE-21002)\\nand [HIVE-22167](https://issues.apache.org/jira/browse/HIVE-22167), Trino does\\nnot correctly read `TIMESTAMP` values from Parquet, RCBinary, or Avro\\nfile formats created by Hive 3.1 or later. When reading from these file formats,\\nTrino returns different results than Hive.\", \"Trino does not support gathering table statistics for Hive transactional tables.\\nYou must use Hive to gather table statistics with\\n[ANALYZE statement](https://cwiki.apache.org/confluence/display/hive/statsdev#StatsDev-ExistingTables%E2%80%93ANALYZE)\\nafter table creation.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 11]\"}, {\"title\": \"Hudi connector\", \"description\": null, \"content\": {\"Requirements\": \"To use the Hudi connector, you need:\\n\\n['Hudi version 0.12.3 or higher.', 'Network access from the Trino coordinator and workers to the Hudi storage.', 'Access to a Hive metastore service (HMS).', 'Network access from the Trino coordinator to the HMS.', 'Data files stored in the [Parquet file format](parquet-format-configuration)\\\\non a [supported file system](hudi-file-system-configuration).']\", \"General configuration\": \"To configure the Hudi connector, create a catalog properties file\\n`etc/catalog/example.properties` that references the `hudi` connector.\\n\\nYou must configure a [metastore for table metadata](/object-storage/metastores).\\n\\nYou must select and configure one of the [supported file\\nsystems](hudi-file-system-configuration).\\n\\n```\\nconnector.name=hudi\\nhive.metastore.uri=thrift://example.net:9083\\nfs.x.enabled=true\\n```\\n\\nReplace the `fs.x.enabled` configuration property with the desired file system.\\n\\nThere are {ref}`HMS configuration properties <general-metastore-properties>`\\navailable for use with the Hudi connector. The connector recognizes Hudi tables\\nsynced to the metastore by the [Hudi sync tool](https://hudi.apache.org/docs/syncing_metastore).\\n\\nAdditionally, following configuration properties can be set depending on the use-case:\\n\\n:::{list-table} Hudi configuration properties\\n:widths: 30, 55, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`hudi.columns-to-hide`', 'List of column names that are hidden from the query output. It can be used\\\\nto hide Hudi meta fields. By default, no fields are hidden.'], ['`hudi.parquet.use-column-names`', 'Access Parquet columns using names from the file. If disabled, then columns\\\\nare accessed using the index. Only applicable to Parquet file format.', '`true`'], ['`hudi.split-generator-parallelism`', 'Number of threads to generate splits from partitions.', '`4`'], ['`hudi.split-loader-parallelism`', 'Number of threads to run background split loader. A single background split\\\\nloader is needed per query.', '`4`'], ['`hudi.size-based-split-weights-enabled`', 'Unlike uniform splitting, size-based splitting ensures that each batch of\\\\nsplits has enough data to process. By default, it is enabled to improve\\\\nperformance.', '`true`'], ['`hudi.standard-split-weight-size`', 'The split size corresponding to the standard weight (1.0) when size-based\\\\nsplit weights are enabled.', '`128MB`'], ['`hudi.minimum-assigned-split-weight`', 'Minimum weight that a split can be assigned when size-based split weights\\\\nare enabled.', '`0.05`'], ['`hudi.max-splits-per-second`', 'Rate at which splits are queued for processing. The queue is throttled if\\\\nthis rate limit is breached.', '`Integer.MAX_VALUE`'], ['`hudi.max-outstanding-splits`', 'Maximum outstanding splits in a batch enqueued for processing.', '`1000`'], ['`hudi.per-transaction-metastore-cache-maximum-size`', 'Maximum number of metastore data objects per transaction in the Hive\\\\nmetastore cache.', '`2000`'], ['`hudi.query-partition-filter-required`', \\\"Set to `true` to force a query to use a partition column in the filter condition.\\\\nThe equivalent catalog session property is `query_partition_filter_required`.\\\\nEnabling this property causes query failures if the partition column used\\\\nin the filter condition doesn't effectively reduce the number of data files read.\\\\nExample: Complex filter expressions such as `id = 1 OR part_key = '100'`\\\\nor `CAST(part_key AS INTEGER) % 2 = 0` are not recognized as partition filters,\\\\nand queries using such expressions fail if the property is set to `true`.\\\", '`false`'], ['`hudi.ignore-absent-partitions`', 'Ignore partitions when the file system location does not exist rather than\\\\nfailing the query. This skips data that may be expected to be part of the\\\\ntable.', '`false`']]\\n\\n:::\\n\\n(hudi-file-system-configuration)=\", \"File system access configuration\": \"The connector supports accessing the following file systems:\\n\\n['[](/object-storage/file-system-azure)', '[](/object-storage/file-system-gcs)', '[](/object-storage/file-system-s3)', '[](/object-storage/file-system-hdfs)']\\n\\nYou must enable and configure the specific file system access. [Legacy\\nsupport](file-system-legacy) is not recommended and will be removed.\", \"SQL support\": {\"Basic usage examples\": \"In the following example queries, `stock_ticks_cow` is the Hudi copy-on-write\\ntable referred to in the Hudi [quickstart guide](https://hudi.apache.org/docs/docker_demo/).\\n\\n```\\nUSE example.example_schema;\\n\\nSELECT symbol, max(ts)\\nFROM stock_ticks_cow\\nGROUP BY symbol\\nHAVING symbol = 'GOOG';\\n```\\n\\n```\\n symbol | _col1 |\\n-----------+----------------------+\\n GOOG | 2018-08-31 10:59:00 |\\n(1 rows)\\n```\\n\\n```\\nSELECT dt, symbol\\nFROM stock_ticks_cow\\nWHERE symbol = 'GOOG';\\n```\\n\\n```\\n dt | symbol |\\n------------+--------+\\n 2018-08-31 | GOOG |\\n(1 rows)\\n```\\n\\n```\\nSELECT dt, count(*)\\nFROM stock_ticks_cow\\nGROUP BY dt;\\n```\\n\\n```\\n dt | _col1 |\\n------------+--------+\\n 2018-08-31 | 99 |\\n(1 rows)\\n```\", \"Schema and table management\": {\"Metadata tables\": {\"`$timeline` table\": \"The `$timeline` table provides a detailed view of meta-data instants\\nin the Hudi table. Instants are specific points in time.\\n\\nYou can retrieve the information about the timeline of the Hudi table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$timeline\\\"\\n```\\n\\n```\\n timestamp | action | state\\n--------------------+---------+-----------\\n8667764846443717831 | commit | COMPLETED\\n7860805980949777961 | commit | COMPLETED\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Timeline columns\\n:widths: 20, 30, 50\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`timestamp`', '`VARCHAR`', 'Instant time is typically a timestamp when the actions performed.'], ['`action`', '`VARCHAR`', '[Type of action](https://hudi.apache.org/docs/concepts/#timeline) performed\\\\non the table.'], ['`state`', '`VARCHAR`', 'Current state of the instant.\\\\n:::']]\"}}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 12]\"}, {\"title\": \"Iceberg connector\", \"description\": null, \"content\": {\"Requirements\": \"To use Iceberg, you need:\\n\\n['Network access from the Trino coordinator and workers to the distributed\\\\nobject storage.', 'Access to a {ref}`Hive metastore service (HMS) <hive-thrift-metastore>`, an\\\\n{ref}`AWS Glue catalog <iceberg-glue-catalog>`, a {ref}`JDBC catalog\\\\n<iceberg-jdbc-catalog>`, a {ref}`REST catalog <iceberg-rest-catalog>`,\\\\na {ref}`Nessie server <iceberg-nessie-catalog>`, or a\\\\n{ref}`Snowflake catalog <iceberg-snowflake-catalog>`.', 'Data files stored in the file formats\\\\n[Parquet](parquet-format-configuration)(default),\\\\n[ORC](orc-format-configuration), or Avro on a [supported file\\\\nsystem](iceberg-file-system-configuration).']\", \"General configuration\": {\"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\\n\\n(iceberg-file-system-configuration)=\"}, \"File system access configuration\": \"The connector supports accessing the following file systems:\\n\\n['[](/object-storage/file-system-azure)', '[](/object-storage/file-system-gcs)', '[](/object-storage/file-system-s3)', '[](/object-storage/file-system-hdfs)']\\n\\nYou must enable and configure the specific file system access. [Legacy\\nsupport](file-system-legacy) is not recommended and will be removed.\", \"Type mapping\": {\"Iceberg to Trino type mapping\": \"The connector maps Iceberg types to the corresponding Trino types according to\\nthe following table:\\n\\n:::{list-table} Iceberg to Trino type mapping\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Iceberg type', 'Trino type'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INT`', '`INTEGER`'], ['`LONG`', '`BIGINT`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`DATE`', '`DATE`'], ['`TIME`', '`TIME(6)`'], ['`TIMESTAMP`', '`TIMESTAMP(6)`'], ['`TIMESTAMPTZ`', '`TIMESTAMP(6) WITH TIME ZONE`'], ['`STRING`', '`VARCHAR`'], ['`UUID`', '`UUID`'], ['`BINARY`', '`VARBINARY`'], ['`FIXED (L)`', '`VARBINARY`'], ['`STRUCT(...)`', '`ROW(...)`'], ['`LIST(e)`', '`ARRAY(e)`'], ['`MAP(k,v)`', '`MAP(k,v)`\\\\n:::']]\\n\\nNo other types are supported.\", \"Trino to Iceberg type mapping\": \"The connector maps Trino types to the corresponding Iceberg types according to\\nthe following table:\\n\\n:::{list-table} Trino to Iceberg type mapping\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Trino type', 'Iceberg type'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INTEGER`', '`INT`'], ['`BIGINT`', '`LONG`'], ['`REAL`', '`FLOAT`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`DATE`', '`DATE`'], ['`TIME(6)`', '`TIME`'], ['`TIMESTAMP(6)`', '`TIMESTAMP`'], ['`TIMESTAMP(6) WITH TIME ZONE`', '`TIMESTAMPTZ`'], ['`VARCHAR`', '`STRING`'], ['`UUID`', '`UUID`'], ['`VARBINARY`', '`BINARY`'], ['`ROW(...)`', '`STRUCT(...)`'], ['`ARRAY(e)`', '`LIST(e)`'], ['`MAP(k,v)`', '`MAP(k,v)`\\\\n:::']]\\n\\nNo other types are supported.\"}, \"Security\": {\"Kerberos authentication\": \"The Iceberg connector supports Kerberos authentication for the Hive metastore\\nand HDFS and is configured using the same parameters as the Hive connector. Find\\nmore information in the [](/object-storage/file-system-hdfs) section.\\n\\n(iceberg-authorization)=\", \"Authorization\": \"The Iceberg connector allows you to choose one of several means of providing\\nauthorization at the catalog level.\\n\\nYou can enable authorization checks for the connector by setting the\\n`iceberg.security` property in the catalog properties file. This property must\\nbe one of the following values:\\n\\n:::{list-table} Iceberg security values\\n:widths: 30, 60\\n:header-rows: 1\\n\\n[['Property value', 'Description'], ['`ALLOW_ALL`', 'No authorization checks are enforced.'], ['`SYSTEM`', 'The connector relies on system-level access control.'], ['`READ_ONLY`', 'Operations that read data or metadata, such as [](/sql/select) are\\\\npermitted. No operations that write data or metadata, such as\\\\n[](/sql/create-table), [](/sql/insert), or [](/sql/delete) are allowed.'], ['`FILE`', 'Authorization checks are enforced using a catalog-level access control\\\\nconfiguration file whose path is specified in the `security.config-file`\\\\ncatalog configuration property. See [](catalog-file-based-access-control)\\\\nfor information on the authorization configuration file.\\\\n:::']]\\n\\n(iceberg-sql-support)=\"}, \"SQL support\": {\"Basic usage examples\": \"The connector supports creating schemas. You can create a schema with or without\\na specified location.\\n\\nYou can create a schema with the {doc}`/sql/create-schema` statement and the\\n`location` schema property. The tables in this schema, which have no explicit\\n`location` set in {doc}`/sql/create-table` statement, are located in a\\nsubdirectory under the directory corresponding to the schema location.\\n\\nCreate a schema on S3:\\n\\n```\\nCREATE SCHEMA example.example_s3_schema\\nWITH (location = 's3://my-bucket/a/path/');\\n```\\n\\nCreate a schema on an S3-compatible object storage such as MinIO:\\n\\n```\\nCREATE SCHEMA example.example_s3a_schema\\nWITH (location = 's3a://my-bucket/a/path/');\\n```\\n\\nCreate a schema on HDFS:\\n\\n```\\nCREATE SCHEMA example.example_hdfs_schema\\nWITH (location='hdfs://hadoop-master:9000/user/hive/warehouse/a/path/');\\n```\\n\\nOptionally, on HDFS, the location can be omitted:\\n\\n```\\nCREATE SCHEMA example.example_hdfs_schema;\\n```\\n\\nThe Iceberg connector supports creating tables using the {doc}`CREATE TABLE\\n</sql/create-table>` syntax. Optionally, specify the {ref}`table properties\\n<iceberg-table-properties>` supported by this connector:\\n\\n```\\nCREATE TABLE example_table (\\n c1 INTEGER,\\n c2 DATE,\\n c3 DOUBLE\\n)\\nWITH (\\n format = 'PARQUET',\\n partitioning = ARRAY['c1', 'c2'],\\n sorted_by = ARRAY['c3'],\\n location = 's3://my-bucket/a/path/'\\n);\\n```\\n\\nWhen the `location` table property is omitted, the content of the table is\\nstored in a subdirectory under the directory corresponding to the schema\\nlocation.\\n\\nThe Iceberg connector supports creating tables using the {doc}`CREATE TABLE AS\\n</sql/create-table-as>` with {doc}`SELECT </sql/select>` syntax:\\n\\n```\\nCREATE TABLE tiny_nation\\nWITH (\\n format = 'PARQUET'\\n)\\nAS\\n SELECT *\\n FROM nation\\n WHERE nationkey < 10;\\n```\\n\\nAnother flavor of creating tables with {doc}`CREATE TABLE AS\\n</sql/create-table-as>` is with {doc}`VALUES </sql/values>` syntax:\\n\\n```\\nCREATE TABLE yearly_clicks (\\n year,\\n clicks\\n)\\nWITH (\\n partitioning = ARRAY['year']\\n)\\nAS VALUES\\n (2021, 10000),\\n (2022, 20000);\\n```\", \"Procedures\": {\"Register table\": \"The connector can register existing Iceberg tables into the metastore if\\n`iceberg.register-table-procedure.enabled` is set to `true` for the catalog.\\n\\nThe procedure `system.register_table` allows the caller to register an\\nexisting Iceberg table in the metastore, using its existing metadata and data\\nfiles:\\n\\n```\\nCALL example.system.register_table(\\n schema_name => 'testdb', \\n table_name => 'customer_orders', \\n table_location => 'hdfs://hadoop-master:9000/user/hive/warehouse/customer_orders-581fad8517934af6be1857a903559d44');\\n```\\n\\nIn addition, you can provide a file name to register a table with specific\\nmetadata. This may be used to register the table with some specific table state,\\nor may be necessary if the connector cannot automatically figure out the\\nmetadata version to use:\\n\\n```\\nCALL example.system.register_table(\\n schema_name => 'testdb', \\n table_name => 'customer_orders', \\n table_location => 'hdfs://hadoop-master:9000/user/hive/warehouse/customer_orders-581fad8517934af6be1857a903559d44', \\n metadata_file_name => '00003-409702ba-4735-4645-8f14-09537cc0b2c8.metadata.json');\\n```\\n\\nTo prevent unauthorized users from accessing data, this procedure is disabled by\\ndefault. The procedure is enabled only when\\n`iceberg.register-table-procedure.enabled` is set to `true`.\\n\\n(iceberg-unregister-table)=\", \"Unregister table\": \"The connector can remove existing Iceberg tables from the metastore. Once\\nunregistered, you can no longer query the table from Trino.\\n\\nThe procedure `system.unregister_table` allows the caller to unregister an\\nexisting Iceberg table from the metastores without deleting the data:\\n\\n```\\nCALL example.system.unregister_table(\\n schema_name => 'testdb', \\n table_name => 'customer_orders');\\n```\", \"Migrate table\": \"The connector can read from or write to Hive tables that have been migrated to\\nIceberg.\\n\\nUse the procedure `system.migrate` to move a table from the Hive format to the\\nIceberg format, loaded with the source\\u2019s data files. Table schema, partitioning,\\nproperties, and location are copied from the source table. A bucketed Hive table\\nwill be migrated as a non-bucketed Iceberg table. The data files in the Hive table\\nmust use the Parquet, ORC, or Avro file format.\\n\\nThe procedure must be called for a specific catalog `example` with the\\nrelevant schema and table names supplied with the required parameters\\n`schema_name` and `table_name`:\\n\\n```\\nCALL example.system.migrate(\\n schema_name => 'testdb',\\n table_name => 'customer_orders');\\n```\\n\\nMigrate fails if any table partition uses an unsupported file format.\\n\\nIn addition, you can provide a `recursive_directory` argument to migrate a\\nHive table that contains subdirectories:\\n\\n```\\nCALL example.system.migrate(\\n schema_name => 'testdb',\\n table_name => 'customer_orders',\\n recursive_directory => 'true');\\n```\\n\\nThe default value is `fail`, which causes the migrate procedure to throw an\\nexception if subdirectories are found. Set the value to `true` to migrate\\nnested directories, or `false` to ignore them.\\n\\n(iceberg-add-files)=\", \"Add files\": \"The connector can add files from tables or locations to an existing Iceberg\\ntable if `iceberg.add-files-procedure.enabled` is set to `true` for the catalog.\\n\\nUse the procedure `add_files_from_table` to add existing files from a Hive table\\nin the current catalog, or `add_files` to add existing files from a specified\\nlocation, to an existing Iceberg table.\\n\\nThe data files must be the Parquet, ORC, or Avro file format.\\n\\nThe procedure adds the files to the target table, specified after `ALTER TABLE`,\\nand loads them from the source table specified with the required parameters\\n`schema_name` and `table_name`. The source table must be accessible in the same\\ncatalog as the target table and use the Hive format. The target table must use\\nthe Iceberg format. The catalog must use the Iceberg connector.\\n\\nThe following examples copy data from the Hive table `hive_customer_orders` in\\nthe `legacy` schema of the `example` catalog into the Iceberg table\\n`iceberg_customer_orders` in the `lakehouse` schema of the `example` catalog:\\n\\n```\\nALTER TABLE example.lakehouse.iceberg_customer_orders \\nEXECUTE add_files_from_table(\\n schema_name => 'legacy',\\n table_name => 'customer_orders');\\n```\\n\\nAlternatively, you can set the current catalog and schema with a `USE`\\nstatement, and omit catalog and schema information:\\n\\n```\\nUSE example.lakehouse;\\nALTER TABLE iceberg_customer_orders \\nEXECUTE add_files_from_table(\\n schema_name => 'legacy',\\n table_name => 'customer_orders');\\n```\\n\\nUse a `partition_filter` argument to add files from specified partitions. The\\nfollowing example adds files from a partition where the `region` is `ASIA` and\\n`country` is `JAPAN`:\\n\\n```\\nALTER TABLE example.lakehouse.iceberg_customer_orders \\nEXECUTE add_files_from_table(\\n schema_name => 'legacy',\\n table_name => 'customer_orders',\\n partition_filter => map(ARRAY['region', 'country'], ARRAY['ASIA', 'JAPAN']));\\n```\\n\\nIn addition, you can provide a `recursive_directory` argument to migrate a\\nHive table that contains subdirectories:\\n\\n```\\nALTER TABLE example.lakehouse.iceberg_customer_orders \\nEXECUTE add_files_from_table(\\n schema_name => 'legacy',\\n table_name => 'customer_orders',\\n recursive_directory => 'true');\\n```\\n\\nThe default value of `recursive_directory` is `fail`, which causes the procedure\\nto throw an exception if subdirectories are found. Set the value to `true` to\\nadd files from nested directories, or `false` to ignore them.\\n\\nThe `add_files` procedure supports adding files, and therefore the contained\\ndata, to a target table, specified after `ALTER TABLE`. It loads the files from\\na object storage path specified with the required `location` parameter. The\\nfiles must use the specified `format`, with `ORC` and `PARQUET` as valid values.\\nThe target Iceberg table must use the same format as the added files. The\\nprocedure does not validate file schemas for compatibility with the target\\nIceberg table. The `location` property is supported for partitioned tables.\\n\\nThe following examples copy `ORC`-format files from the location\\n`s3://my-bucket/a/path` into the Iceberg table `iceberg_customer_orders` in the\\n`lakehouse` schema of the `example` catalog:\\n\\n```\\nALTER TABLE example.lakehouse.iceberg_customer_orders \\nEXECUTE add_files(\\n location => 's3://my-bucket/a/path',\\n format => 'ORC');\\n```\\n\\n(iceberg-functions)=\"}, \"Functions\": {\"bucket\": \"This function exposes the [Iceberg bucket transform](https://iceberg.apache.org/spec/#bucket-transform-details)\\nso that users can determine what bucket a particular value falls into. The\\nfunction takes two arguments: the partition value and the number of buckets.\\n\\nThe supported types for the 1st argument to this function are:\\n\\n['`TINYINT`', '`SMALLINT`', '`INTEGER`', '`BIGINT`', '`VARCHAR`', '`VARBINARY`', '`DATE`', '`TIMESTAMP`', '`TIMESTAMP WITH TIME ZONE`']\\n\\nFor example, if we wanted to see what bucket number a particular string would\\nbe assigned, we can execute:\\n\\n```\\nSELECT system.bucket('trino', 16);\\n```\\n\\nThis function can be used in a `WHERE` clause to only operate on a particular\\nbucket:\\n\\n```\\nSELECT count(*)\\nFROM customer\\nWHERE system.bucket(custkey, 16) = 2;\\n```\\n\\n(iceberg-data-management)=\"}, \"Data management\": {\"Deletion by partition\": \"For partitioned tables, the Iceberg connector supports the deletion of entire\\npartitions if the `WHERE` clause specifies filters only on the\\nidentity-transformed partitioning columns, that can match entire partitions.\\nGiven the table definition from {ref}`Partitioned Tables <iceberg-tables>`\\nsection, the following SQL statement deletes all partitions for which\\n`country` is `US`:\\n\\n```\\nDELETE FROM example.testdb.customer_orders\\nWHERE country = 'US';\\n```\\n\\nA partition delete is performed if the `WHERE` clause meets these conditions.\", \"Row level deletion\": \"Tables using v2 of the Iceberg specification support deletion of individual rows\\nby writing position delete files.\\n\\n(iceberg-schema-table-management)=\"}, \"Schema and table management\": {\"Schema evolution\": \"Iceberg supports schema evolution, with safe column add, drop, and\\nrename operations, including in nested structures.\\n\\nIceberg supports updating column types only for widening operations:\\n\\n['`INTEGER` to `BIGINT`', '`REAL` to `DOUBLE`', '`DECIMAL(p,s)` to `DECIMAL(p2,s)` when `p2` > `p` (scale cannot change)']\\n\\nPartitioning can also be changed and the connector can still query data\\ncreated before the partitioning change.\\n\\n(iceberg-alter-table-execute)=\", \"ALTER TABLE EXECUTE\": {\"optimize\": \"The `optimize` command is used for rewriting the content of the specified\\ntable so that it is merged into fewer but larger files. If the table is\\npartitioned, the data compaction acts separately on each partition selected for\\noptimization. This operation improves read performance.\\n\\nAll files with a size below the optional `file_size_threshold` parameter\\n(default value for the threshold is `100MB`) are merged in case any of the\\nfollowing conditions are met per partition:\\n\\n['more than one data file to merge is present', 'at least one data file, with delete files attached, is present']\\n\\n```\\nALTER TABLE test_table EXECUTE optimize\\n```\\n\\nThe following statement merges files in a table that are\\nunder 128 megabytes in size:\\n\\n```\\nALTER TABLE test_table EXECUTE optimize(file_size_threshold => '128MB')\\n```\\n\\nYou can use a `WHERE` clause with the columns used to partition the table\\nto filter which partitions are optimized:\\n\\n```\\nALTER TABLE test_partitioned_table EXECUTE optimize\\nWHERE partition_key = 1\\n```\\n\\nYou can use a more complex `WHERE` clause to narrow down the scope of the\\n`optimize` procedure. The following example casts the timestamp values to\\ndates, and uses a comparison to only optimize partitions with data from the year\\n2022 or newer:\\n\\n```\\nALTER TABLE test_table EXECUTE optimize\\nWHERE CAST(timestamp_tz AS DATE) > DATE '2021-12-31'\\n```\\n\\nUse a `WHERE` clause with [metadata columns](iceberg-metadata-columns) to filter\\nwhich files are optimized.\\n\\n```\\nALTER TABLE test_table EXECUTE optimize\\nWHERE \\\"$file_modified_time\\\" > date_trunc('day', CURRENT_TIMESTAMP);\\n```\\n\\n(iceberg-optimize-manifests)=\", \"optimize_manifests\": \"Rewrites manifest files to cluster them by partitioning columns.\\nThis can be used to optimize scan planning when there are many small manifest files\\nor when there are partition filters in read queries but the manifest files are\\nnot grouped by partitions.\\nThe iceberg table property `commit.manifest.target-size-bytes` controls\\nthe maximum size of manifest files produced by this procedure.\\n\\n`optimize_manifests` can be run as follows:\\n\\n```\\nALTER TABLE test_table EXECUTE optimize_manifests;\\n```\\n\\n(iceberg-expire-snapshots)=\", \"expire_snapshots\": \"The `expire_snapshots` command removes all snapshots and all related metadata\\nand data files. Regularly expiring snapshots is recommended to delete data files\\nthat are no longer needed, and to keep the size of table metadata small. The\\nprocedure affects all snapshots that are older than the time period configured\\nwith the `retention_threshold` parameter.\\n\\n`expire_snapshots` can be run as follows:\\n\\n```\\nALTER TABLE test_table EXECUTE expire_snapshots(retention_threshold => '7d');\\n```\\n\\nThe value for `retention_threshold` must be higher than or equal to\\n`iceberg.expire-snapshots.min-retention` in the catalog, otherwise the\\nprocedure fails with a similar message: `Retention specified (1.00d) is shorter\\nthan the minimum retention configured in the system (7.00d)`. The default value\\nfor this property is `7d`.\\n\\n(iceberg-remove-orphan-files)=\", \"remove_orphan_files\": \"The `remove_orphan_files` command removes all files from a table's data\\ndirectory that are not linked from metadata files and that are older than the\\nvalue of `retention_threshold` parameter. Deleting orphan files from time to\\ntime is recommended to keep size of a table's data directory under control.\\n\\n`remove_orphan_files` can be run as follows:\\n\\n```\\nALTER TABLE test_table EXECUTE remove_orphan_files(retention_threshold => '7d');\\n```\\n\\nThe value for `retention_threshold` must be higher than or equal to\\n`iceberg.remove-orphan-files.min-retention` in the catalog otherwise the\\nprocedure fails with a similar message: `Retention specified (1.00d) is shorter\\nthan the minimum retention configured in the system (7.00d)`. The default value\\nfor this property is `7d`.\\n\\n(drop-extended-stats)=\", \"drop_extended_stats\": \"The `drop_extended_stats` command removes all extended statistics information\\nfrom the table.\\n\\n`drop_extended_stats` can be run as follows:\\n\\n```\\nALTER TABLE test_table EXECUTE drop_extended_stats;\\n```\\n\\n(iceberg-alter-table-set-properties)=\"}, \"ALTER TABLE SET PROPERTIES\": {\"Table properties\": \"Table properties supply or set metadata for the underlying tables. This is key\\nfor {doc}`/sql/create-table-as` statements. Table properties are passed to the\\nconnector using a {doc}`WITH </sql/create-table-as>` clause.\\n\\n:::{list-table} Iceberg table properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`format`', 'Optionally specifies the format of table data files; either `PARQUET`,\\\\n`ORC`, or `AVRO`. Defaults to the value of the `iceberg.file-format` \\\\ncatalog configuration property, which defaults to `PARQUET`.'], ['`compression_codec`', 'Optionally specifies the compression-codec used for writing the table; \\\\neither `NONE`, `ZSTD`, `SNAPPY`, `LZ4`, or `GZIP`. Defaults to the value \\\\nof the `iceberg.compression-codec` catalog configuration property, which \\\\ndefaults to `ZSTD`.'], ['`partitioning`', \\\"Optionally specifies table partitioning. If a table is partitioned by\\\\ncolumns `c1` and `c2`, the partitioning property is `partitioning =\\\\nARRAY['c1', 'c2']`.\\\"], ['`sorted_by`', \\\"The sort order to be applied during writes to the content of\\\\neach file written to the table. If the table files are sorted by columns\\\\n`c1` and `c2`, the sort order property is `sorted_by = ARRAY['c1', 'c2']`.\\\\nThe sort order applies to the contents written within each output file\\\\nindependently and not the entire dataset.\\\"], ['`location`', 'Optionally specifies the file system location URI for the table.'], ['`format_version`', 'Optionally specifies the format version of the Iceberg specification to use\\\\nfor new tables; either `1` or `2`. Defaults to `2`. Version `2` is required\\\\nfor row level deletes.'], ['`max_commit_retry`', 'Number of times to retry a commit before failing. Defaults to the value of \\\\nthe `iceberg.max-commit-retry` catalog configuration property, which \\\\ndefaults to `4`.'], ['`orc_bloom_filter_columns`', 'Comma-separated list of columns to use for ORC bloom filter. It improves the\\\\nperformance of queries using Equality and IN predicates when reading ORC\\\\nfiles. Requires ORC format. Defaults to `[]`.'], ['`orc_bloom_filter_fpp`', 'The ORC bloom filters false positive probability. Requires ORC format.\\\\nDefaults to `0.05`.'], ['`parquet_bloom_filter_columns`', 'Comma-separated list of columns to use for Parquet bloom filter. It improves\\\\nthe performance of queries using Equality and IN predicates when reading\\\\nParquet files. Requires Parquet format. Defaults to `[]`.'], ['`object_store_layout_enabled`', \\\"Whether Iceberg's [object store file layout](https://iceberg.apache.org/docs/latest/aws/#object-store-file-layout) is enabled. \\\\nDefaults to `false`. \\\"], ['`data_location`', \\\"Optionally specifies the file system location URI for the table's data files\\\"], ['`extra_properties`', 'Additional properties added to an Iceberg table. The properties are not used by Trino,\\\\nand are available in the `$properties` metadata table.\\\\nThe properties are not included in the output of `SHOW CREATE TABLE` statements.\\\\n:::']]\\n\\nThe table definition below specifies to use Parquet files, partitioning by columns\\n`c1` and `c2`, and a file system location of\\n`/var/example_tables/test_table`:\\n\\n```\\nCREATE TABLE test_table (\\n c1 INTEGER,\\n c2 DATE,\\n c3 DOUBLE)\\nWITH (\\n format = 'PARQUET',\\n partitioning = ARRAY['c1', 'c2'],\\n location = '/var/example_tables/test_table');\\n```\\n\\nThe table definition below specifies to use ORC files with compression_codec\\nSNAPPY, bloom filter index by columns `c1` and `c2`, fpp is 0.05, and a file\\nsystem location of `/var/example_tables/test_table`:\\n\\n```\\nCREATE TABLE test_table (\\n c1 INTEGER,\\n c2 DATE,\\n c3 DOUBLE)\\nWITH (\\n format = 'ORC',\\n compression_codec = 'SNAPPY',\\n location = '/var/example_tables/test_table',\\n orc_bloom_filter_columns = ARRAY['c1', 'c2'],\\n orc_bloom_filter_fpp = 0.05);\\n```\\n\\nThe table definition below specifies to use Avro files, partitioning\\nby `child1` field in `parent` column:\\n\\n```\\nCREATE TABLE test_table (\\n data INTEGER,\\n parent ROW(child1 DOUBLE, child2 INTEGER))\\nWITH (\\n format = 'AVRO',\\n partitioning = ARRAY['\\\"parent.child1\\\"']);\\n```\\n\\n(iceberg-metadata-tables)=\"}, \"Metadata tables\": {\"`$properties` table\": \"The `$properties` table provides access to general information about Iceberg\\ntable configuration and any additional metadata key/value pairs that the table\\nis tagged with.\\n\\nYou can retrieve the properties of the current snapshot of the Iceberg table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$properties\\\";\\n```\\n\\n```\\n key | value |\\n-----------------------+----------+\\nwrite.format.default | PARQUET |\\n```\\n\\n(iceberg-history-table)=\", \"`$history` table\": \"The `$history` table provides a log of the metadata changes performed on the\\nIceberg table.\\n\\nYou can retrieve the changelog of the Iceberg table `test_table` by using the\\nfollowing query:\\n\\n```\\nSELECT * FROM \\\"test_table$history\\\";\\n```\\n\\n```\\n made_current_at | snapshot_id | parent_id | is_current_ancestor\\n----------------------------------+----------------------+----------------------+--------------------\\n2022-01-10 08:11:20 Europe/Vienna | 8667764846443717831 | <null> | true\\n2022-01-10 08:11:34 Europe/Vienna | 7860805980949777961 | 8667764846443717831 | true\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} History columns\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`made_current_at`', '`TIMESTAMP(3) WITH TIME ZONE`', 'The time when the snapshot became active.'], ['`snapshot_id`', '`BIGINT`', 'The identifier of the snapshot.'], ['`parent_id`', '`BIGINT`', 'The identifier of the parent snapshot.'], ['`is_current_ancestor`', '`BOOLEAN`', 'Whether or not this snapshot is an ancestor of the current snapshot.\\\\n:::']]\", \"`$metadata_log_entries` table\": \"The `$metadata_log_entries` table provides a view of metadata log entries\\nof the Iceberg table.\\n\\nYou can retrieve the information about the metadata log entries of the Iceberg\\ntable `test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$metadata_log_entries\\\";\\n```\\n\\n```\\n timestamp | file | latest_snapshot_id | latest_schema_id | latest_sequence_number\\n---------------------------------------+----------------------------------------------------------------------------------------------------------------------------+---------------------+------------------+------------------------\\n 2024-01-16 15:55:31.172 Europe/Vienna | hdfs://hadoop-master:9000/user/hive/warehouse/test_table/metadata/00000-39174715-be2a-48fa-9949-35413b8b736e.metadata.json | 1221802298419195590 | 0 | 1\\n 2024-01-16 17:19:56.118 Europe/Vienna | hdfs://hadoop-master:9000/user/hive/warehouse/test_table/metadata/00001-e40178c9-271f-4a96-ad29-eed5e7aef9b0.metadata.json | 7124386610209126943 | 0 | 2\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Metadata log entries columns\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`timestamp`', '`TIMESTAMP(3) WITH TIME ZONE`', 'The time when the metadata was created.'], ['`file`', '`VARCHAR`', 'The location of the metadata file.'], ['`latest_snapshot_id`', '`BIGINT`', 'The identifier of the latest snapshot when the metadata was updated.'], ['`latest_schema_id`', '`INTEGER`', 'The identifier of the latest schema when the metadata was updated.'], ['`latest_sequence_number`', '`BIGINT`', 'The data sequence number of the metadata file.\\\\n:::']]\", \"`$snapshots` table\": \"The `$snapshots` table provides a detailed view of snapshots of the Iceberg\\ntable. A snapshot consists of one or more file manifests, and the complete table\\ncontents are represented by the union of all the data files in those manifests.\\n\\nYou can retrieve the information about the snapshots of the Iceberg table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$snapshots\\\";\\n```\\n\\n```\\n committed_at | snapshot_id | parent_id | operation | manifest_list | summary\\n----------------------------------+----------------------+----------------------+--------------------+------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\n2022-01-10 08:11:20 Europe/Vienna | 8667764846443717831 | <null> | append | hdfs://hadoop-master:9000/user/hive/warehouse/test_table/metadata/snap-8667764846443717831-1-100cf97e-6d56-446e-8961-afdaded63bc4.avro | {changed-partition-count=0, total-equality-deletes=0, total-position-deletes=0, total-delete-files=0, total-files-size=0, total-records=0, total-data-files=0}\\n2022-01-10 08:11:34 Europe/Vienna | 7860805980949777961 | 8667764846443717831 | append | hdfs://hadoop-master:9000/user/hive/warehouse/test_table/metadata/snap-7860805980949777961-1-faa19903-1455-4bb8-855a-61a1bbafbaa7.avro | {changed-partition-count=1, added-data-files=1, total-equality-deletes=0, added-records=1, total-position-deletes=0, added-files-size=442, total-delete-files=0, total-files-size=442, total-records=1, total-data-files=1}\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Snapshots columns\\n:widths: 20, 30, 50\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`committed_at`', '`TIMESTAMP(3) WITH TIME ZONE`', 'The time when the snapshot became active.'], ['`snapshot_id`', '`BIGINT`', 'The identifier for the snapshot.'], ['`parent_id`', '`BIGINT`', 'The identifier for the parent snapshot.'], ['`operation`', '`VARCHAR`', 'The type of operation performed on the Iceberg table. The supported\\\\noperation types in Iceberg are:', ['`append` when new data is appended.', '`replace` when files are removed and replaced without changing the\\\\ndata in the table.', '`overwrite` when new data is added to overwrite existing data.', '`delete` when data is deleted from the table and no new data is added.']], ['`manifest_list`', '`VARCHAR`', 'The list of Avro manifest files containing the detailed information about\\\\nthe snapshot changes.'], ['`summary`', '`map(VARCHAR, VARCHAR)`', 'A summary of the changes made from the previous snapshot to the current\\\\nsnapshot.\\\\n:::']]\", \"`$manifests` and `$all_manifests` tables\": \"The `$manifests` and `$all_manifests` tables provide a detailed overview of the\\nmanifests corresponding to the snapshots performed in the log of the Iceberg\\ntable. The `$manifests` table contains data for the current snapshot. The\\n`$all_manifests` table contains data for all snapshots.\\n\\nYou can retrieve the information about the manifests of the Iceberg table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$manifests\\\";\\n```\\n\\n```\\n path | length | partition_spec_id | added_snapshot_id | added_data_files_count | added_rows_count | existing_data_files_count | existing_rows_count | deleted_data_files_count | deleted_rows_count | partition_summaries\\n----------------------------------------------------------------------------------------------------------------+-----------------+----------------------+-----------------------+-------------------------+------------------+-----------------------------+---------------------+-----------------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------\\n hdfs://hadoop-master:9000/user/hive/warehouse/test_table/metadata/faa19903-1455-4bb8-855a-61a1bbafbaa7-m0.avro | 6277 | 0 | 7860805980949777961 | 1 | 100 | 0 | 0 | 0 | 0 | {{contains_null=false, contains_nan= false, lower_bound=1, upper_bound=1},{contains_null=false, contains_nan= false, lower_bound=2021-01-12, upper_bound=2021-01-12}}\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Manifests columns\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`path`', '`VARCHAR`', 'The manifest file location.'], ['`length`', '`BIGINT`', 'The manifest file length.'], ['`partition_spec_id`', '`INTEGER`', 'The identifier for the partition specification used to write the manifest\\\\nfile.'], ['`added_snapshot_id`', '`BIGINT`', 'The identifier of the snapshot during which this manifest entry has been\\\\nadded.'], ['`added_data_files_count`', '`INTEGER`', 'The number of data files with status `ADDED` in the manifest file.'], ['`added_rows_count`', '`BIGINT`', 'The total number of rows in all data files with status `ADDED` in the\\\\nmanifest file.'], ['`existing_data_files_count`', '`INTEGER`', 'The number of data files with status `EXISTING` in the manifest file.'], ['`existing_rows_count`', '`BIGINT`', 'The total number of rows in all data files with status `EXISTING` in the\\\\nmanifest file.'], ['`deleted_data_files_count`', '`INTEGER`', 'The number of data files with status `DELETED` in the manifest file.'], ['`deleted_rows_count`', '`BIGINT`', 'The total number of rows in all data files with status `DELETED` in the\\\\nmanifest file.'], ['`partition_summaries`', '`ARRAY(row(contains_null BOOLEAN, contains_nan BOOLEAN, lower_bound VARCHAR, upper_bound VARCHAR))`', 'Partition range metadata.\\\\n:::']]\", \"`$partitions` table\": \"The `$partitions` table provides a detailed overview of the partitions of the\\nIceberg table.\\n\\nYou can retrieve the information about the partitions of the Iceberg table\\n`test_table` by using the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$partitions\\\";\\n```\\n\\n```\\n partition | record_count | file_count | total_size | data\\n-----------------------+---------------+---------------+---------------+------------------------------------------------------\\n{c1=1, c2=2021-01-12} | 2 | 2 | 884 | {c3={min=1.0, max=2.0, null_count=0, nan_count=NULL}}\\n{c1=1, c2=2021-01-13} | 1 | 1 | 442 | {c3={min=1.0, max=1.0, null_count=0, nan_count=NULL}}\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Partitions columns\\n:widths: 20, 30, 50\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`partition`', '`ROW(...)`', 'A row that contains the mapping of the partition column names to the\\\\npartition column values.'], ['`record_count`', '`BIGINT`', 'The number of records in the partition.'], ['`file_count`', '`BIGINT`', 'The number of files mapped in the partition.'], ['`total_size`', '`BIGINT`', 'The size of all the files in the partition.'], ['`data`', '`ROW(... ROW (min ..., max ... , null_count BIGINT, nan_count BIGINT))`', 'Partition range metadata.\\\\n:::']]\", \"`$files` table\": \"The `$files` table provides a detailed overview of the data files in current\\nsnapshot of the Iceberg table.\\n\\nTo retrieve the information about the data files of the Iceberg table\\n`test_table`, use the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$files\\\";\\n```\\n\\n```\\n content | file_path | record_count | file_format | file_size_in_bytes | column_sizes | value_counts | null_value_counts | nan_value_counts | lower_bounds | upper_bounds | key_metadata | split_offsets | equality_ids\\n----------+-------------------------------------------------------------------------------------------------------------------------------+-----------------+---------------+----------------------+----------------------+-------------------+--------------------+-------------------+-----------------------------+-----------------------------+----------------+----------------+---------------\\n 0 | hdfs://hadoop-master:9000/user/hive/warehouse/test_table/data/c1=3/c2=2021-01-14/af9872b2-40f3-428f-9c87-186d2750d84e.parquet | 1 | PARQUET | 442 | {1=40, 2=40, 3=44} | {1=1, 2=1, 3=1} | {1=0, 2=0, 3=0} | <null> | {1=3, 2=2021-01-14, 3=1.3} | {1=3, 2=2021-01-14, 3=1.3} | <null> | <null> | <null>\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Files columns\\n:widths: 25, 30, 45\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`content`', '`INTEGER`', 'Type of content stored in the file. The supported content types in Iceberg\\\\nare:', ['`DATA(0)`', '`POSITION_DELETES(1)`', '`EQUALITY_DELETES(2)`']], ['`file_path`', '`VARCHAR`', 'The data file location.'], ['`file_format`', '`VARCHAR`', 'The format of the data file.'], ['`spec_id`', '`INTEGER`', 'Spec ID used to track the file containing a row.'], ['`partition`', '`ROW(...)`', 'A row that contains the mapping of the partition column names to the\\\\npartition column values.'], ['`record_count`', '`BIGINT`', 'The number of entries contained in the data file.'], ['`file_size_in_bytes`', '`BIGINT`', 'The data file size'], ['`column_sizes`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding size in the\\\\nfile.'], ['`value_counts`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding count of entries\\\\nin the file.'], ['`null_value_counts`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding count of `NULL`\\\\nvalues in the file.'], ['`nan_value_counts`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding count of \\\\nnon-numerical values in the file.'], ['`lower_bounds`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding lower bound in\\\\nthe file.'], ['`upper_bounds`', '`map(INTEGER, BIGINT)`', 'Mapping between the Iceberg column ID and its corresponding upper bound in\\\\nthe file.'], ['`key_metadata`', '`VARBINARY`', 'Metadata about the encryption key used to encrypt this file, if applicable.'], ['`split_offsets`', '`array(BIGINT)`', 'List of recommended split locations.'], ['`equality_ids`', '`array(INTEGER)`', 'The set of field IDs used for equality comparison in equality delete files.'], ['`sort_order_id`', '`INTEGER`', 'ID representing sort order for this file.'], ['`readable_metrics`', '`JSON`', 'File metrics in human-readable form.\\\\n:::']]\", \"`$entries` and `$all_entries` tables\": \"The `$entries` and `$all_entries` tables provide the table's manifest entries\\nfor both data and delete files. The `$entries` table contains data for the\\ncurrent snapshot. The `$all_entries` table contains data for all snapshots.\\n\\nTo retrieve the information about the entries of the Iceberg table\\n`test_table`, use the following query:\\n\\n```\\nSELECT * FROM \\\"test_table$entries\\\";\\n```\\n\\nAbbreviated sample output:\\n\\n```\\n status | snapshot_id | sequence_number | file_sequence_number | data_file | readable_metrics |\\n--------+----------------+-----------------+----------------------+-------------------------------------+------------------------------------------------+\\n 2 | 57897183625154 | 0 | 0 | {\\\"content\\\":0,...,\\\"sort_order_id\\\":0} | {\\\"c1\\\":{\\\"column_size\\\":103,...,\\\"upper_bound\\\":3}} |\\n```\\n\\nThe metadata tables include the following columns:\\n\\n:::{list-table} Files columns\\n:widths: 25, 30, 45\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`status`', '`INTEGER`', 'Numeric status indication to track additions and deletions. Deletes are\\\\ninformational only and not used in scans:', ['`EXISTING(0)`', '`ADDED(1)`', '`DELETED(2)`']], ['`snapshot_id`', '`BIGINT`', 'The snapshot ID of the reference.'], ['`sequence_number`', '`BIGINT`', 'Data sequence number of the file. Inherited when null and status is 1.'], ['`file_sequence_number`', '`BIGINT`', 'File sequence number indicating when the file was added. Inherited when null\\\\nand status is 1.'], ['`data_file`', '`ROW`', 'Metadata including file path, file format, file size and other information.'], ['`readable_metrics`', '`JSON`', 'JSON-formatted file metrics such as column size, value count, and others.\\\\n:::']]\", \"`$refs` table\": \"The `$refs` table provides information about Iceberg references including\\nbranches and tags.\\n\\nYou can retrieve the references of the Iceberg table `test_table` by using the\\nfollowing query:\\n\\n```\\nSELECT * FROM \\\"test_table$refs\\\";\\n```\\n\\n```\\nname | type | snapshot_id | max_reference_age_in_ms | min_snapshots_to_keep | max_snapshot_age_in_ms |\\n----------------+--------+-------------+-------------------------+-----------------------+------------------------+\\nexample_tag | TAG | 10000000000 | 10000 | null | null |\\nexample_branch | BRANCH | 20000000000 | 20000 | 2 | 30000 |\\n```\\n\\nThe output of the query has the following columns:\\n\\n:::{list-table} Refs columns\\n:widths: 20, 30, 50\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`name`', '`VARCHAR`', 'Name of the reference.'], ['`type`', '`VARCHAR`', 'Type of the reference, either `BRANCH` or `TAG`.'], ['`snapshot_id`', '`BIGINT`', 'The snapshot ID of the reference.'], ['`max_reference_age_in_ms`', '`BIGINT`', 'The maximum age of the reference before it could be expired.'], ['`min_snapshots_to_keep`', '`INTEGER`', 'For branch only, the minimum number of snapshots to keep in a branch.'], ['`max_snapshot_age_in_ms`', '`BIGINT`', 'For branch only, the max snapshot age allowed in a branch. Older snapshots\\\\nin the branch will be expired.\\\\n:::']]\\n\\n(iceberg-metadata-columns)=\"}, \"Metadata columns\": \"In addition to the defined columns, the Iceberg connector automatically exposes\\npath metadata as a hidden column in each table:\\n\\n['`$partition`: Partition path for this row', '`$path`: Full file system path name of the file for this row', '`$file_modified_time`: Timestamp of the last modification of the file for\\\\nthis row']\\n\\nYou can use these columns in your SQL statements like any other column. This can\\nbe selected directly, or used in conditional statements. For example, you can\\ninspect the file path for each record:\\n\\n```\\nSELECT *, \\\"$partition\\\", \\\"$path\\\", \\\"$file_modified_time\\\"\\nFROM example.web.page_views;\\n```\\n\\nRetrieve all records that belong to a specific file using `\\\"$path\\\"` filter:\\n\\n```\\nSELECT *\\nFROM example.web.page_views\\nWHERE \\\"$path\\\" = '/usr/iceberg/table/web.page_views/data/file_01.parquet'\\n```\\n\\nRetrieve all records that belong to a specific file using\\n`\\\"$file_modified_time\\\"` filter:\\n\\n```\\nSELECT *\\nFROM example.web.page_views\\nWHERE \\\"$file_modified_time\\\" = CAST('2022-07-01 01:02:03.456 UTC' AS TIMESTAMP WITH TIME ZONE)\\n```\\n\\n(iceberg-system-tables)=\", \"System tables\": {\"`iceberg_tables` table\": \"The `iceberg_tables` table allows listing only Iceberg tables from a given catalog.\\nThe `SHOW TABLES` statement, `information_schema.tables`, and `jdbc.tables` will all\\nreturn all tables that exist in the underlying metastore, even if the table cannot\\nbe handled in any way by the iceberg connector. This can happen if other connectors\\nlike Hive or Delta Lake, use the same metastore, catalog, and schema to store its tables.\\n\\nThe table includes following columns:\\n\\n:::{list-table} iceberg_tables columns\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Name', 'Type', 'Description'], ['`table_schema`', '`VARCHAR`', 'The name of the schema the table is in.'], ['`table_name`', '`VARCHAR`', 'The name of the table.\\\\n:::']]\\n\\nThe following query lists Iceberg tables from all schemas in the `example` catalog.\\n\\n```\\nSELECT * FROM example.system.iceberg_tables;\\n```\\n\\n```\\n table_schema | table_name |\\n--------------+-------------+\\n tpcds | store_sales |\\n tpch | nation |\\n tpch | region |\\n tpch | orders | \\n```\"}, \"DROP TABLE\": \"The Iceberg connector supports dropping a table by using the\\n{doc}`/sql/drop-table` syntax. When the command succeeds, both the data of the\\nIceberg table and also the information related to the table in the metastore\\nservice are removed. Dropping tables that have their data/metadata stored in a\\ndifferent location than the table's corresponding base directory on the object\\nstore is not supported.\\n\\n(iceberg-comment)=\", \"COMMENT\": \"The Iceberg connector supports setting comments on the following objects:\\n\\n['tables', 'views', 'table columns', 'materialized view columns']\\n\\nThe `COMMENT` option is supported on both the table and the table columns for\\nthe {doc}`/sql/create-table` operation.\\n\\nThe `COMMENT` option is supported for adding table columns through the\\n{doc}`/sql/alter-table` operations.\\n\\nThe connector supports the command {doc}`COMMENT </sql/comment>` for setting\\ncomments on existing entities.\\n\\n(iceberg-tables)=\", \"Partitioned tables\": \"Iceberg supports partitioning by specifying transforms over the table columns. A\\npartition is created for each unique tuple value produced by the transforms.\\nIdentity transforms are simply the column name. Other transforms are:\\n\\n:::{list-table} Iceberg column transforms\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Transform', 'Description'], ['`year(ts)`', 'A partition is created for each year. The partition value is the integer\\\\ndifference in years between `ts` and January 1 1970.'], ['`month(ts)`', 'A partition is created for each month of each year. The partition value is\\\\nthe integer difference in months between `ts` and January 1 1970.'], ['`day(ts)`', 'A partition is created for each day of each year. The partition value is the\\\\ninteger difference in days between `ts` and January 1 1970.'], ['`hour(ts)`', 'A partition is created hour of each day. The partition value is a timestamp\\\\nwith the minutes and seconds set to zero.'], ['`bucket(x, nbuckets)`', 'The data is hashed into the specified number of buckets. The partition value\\\\nis an integer hash of `x`, with a value between 0 and `nbuckets - 1`\\\\ninclusive.'], ['`truncate(s, nchars)`', 'The partition value is the first `nchars` characters of `s`.\\\\n:::']]\\n\\nIn this example, the table is partitioned by the month of `order_date`, a hash\\nof `account_number` (with 10 buckets), and `country`:\\n\\n```\\nCREATE TABLE example.testdb.customer_orders (\\n order_id BIGINT,\\n order_date DATE,\\n account_number BIGINT,\\n customer VARCHAR,\\n country VARCHAR)\\nWITH (partitioning = ARRAY['month(order_date)', 'bucket(account_number, 10)', 'country']);\\n```\\n\\n(iceberg-sorted-files)=\", \"Sorted tables\": \"The connector supports sorted files as a performance improvement. Data is sorted\\nduring writes within each file based on the specified array of one or more\\ncolumns.\\n\\nSorting is particularly beneficial when the sorted columns show a high\\ncardinality and are used as a filter for selective reads.\\n\\nThe sort order is configured with the `sorted_by` table property. Specify an\\narray of one or more columns to use for sorting when creating the table. The\\nfollowing example configures the `order_date` column of the `orders` table\\nin the `customers` schema in the `example` catalog:\\n\\n```\\nCREATE TABLE example.customers.orders (\\n order_id BIGINT,\\n order_date DATE,\\n account_number BIGINT,\\n customer VARCHAR,\\n country VARCHAR)\\nWITH (sorted_by = ARRAY['order_date']);\\n```\\n\\nYou can explicitly configure sort directions or null ordering in the following way:\\n\\n```\\nCREATE TABLE example.customers.orders (\\n order_id BIGINT,\\n order_date DATE,\\n account_number BIGINT,\\n customer VARCHAR,\\n country VARCHAR)\\nWITH (sorted_by = ARRAY['order_date DESC NULLS FIRST', 'order_id ASC NULLS LAST']);\\n```\\n\\nSorting can be combined with partitioning on the same column. For example:\\n\\n```\\nCREATE TABLE example.customers.orders (\\n order_id BIGINT,\\n order_date DATE,\\n account_number BIGINT,\\n customer VARCHAR,\\n country VARCHAR)\\nWITH (\\n partitioning = ARRAY['month(order_date)'],\\n sorted_by = ARRAY['order_date']\\n);\\n```\\n\\nYou can disable sorted writing with the session property\\n`sorted_writing_enabled` set to `false`.\", \"Using snapshots\": \"Iceberg supports a snapshot model of data, where table snapshots are\\nidentified by a snapshot ID.\\n\\nThe connector provides a system table exposing snapshot information for every\\nIceberg table. Snapshots are identified by `BIGINT` snapshot IDs. For example,\\nyou can find the snapshot IDs for the `customer_orders` table by running the\\nfollowing query:\\n\\n```\\nSELECT snapshot_id\\nFROM example.testdb.\\\"customer_orders$snapshots\\\"\\nORDER BY committed_at DESC;\\n```\\n\\n(iceberg-create-or-replace)=\", \"Replace tables\": {\"Time travel queries\": \"The connector offers the ability to query historical data. This allows you to\\nquery the table as it was when a previous snapshot of the table was taken, even\\nif the data has since been modified or deleted.\\n\\nThe historical data of the table can be retrieved by specifying the snapshot\\nidentifier corresponding to the version of the table to be retrieved:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR VERSION AS OF 8954597067493422955;\\n```\\n\\nA different approach of retrieving historical data is to specify a point in time\\nin the past, such as a day or week ago. The latest snapshot of the table taken\\nbefore or at the specified timestamp in the query is internally used for\\nproviding the previous state of the table:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 09:59:29.803 Europe/Vienna';\\n```\\n\\nThe connector allows to create a new snapshot through Iceberg's [replace table](iceberg-create-or-replace).\\n\\n```\\nCREATE OR REPLACE TABLE example.testdb.customer_orders AS\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 09:59:29.803 Europe/Vienna';\\n```\\n\\nYou can use a date to specify a point a time in the past for using a snapshot of a table in a query.\\nAssuming that the session time zone is `Europe/Vienna` the following queries are equivalent:\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF DATE '2022-03-23';\\n```\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 00:00:00';\\n```\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR TIMESTAMP AS OF TIMESTAMP '2022-03-23 00:00:00.000 Europe/Vienna';\\n```\\n\\nIceberg supports named references of snapshots via branches and tags.\\nTime travel can be performed to branches and tags in the table.\\n\\n```\\nSELECT *\\nFROM example.testdb.customer_orders FOR VERSION AS OF 'historical-tag';\\n\\nSELECT *\\nFROM example.testdb.customer_orders FOR VERSION AS OF 'test-branch';\\n```\", \"Rolling back to a previous snapshot\": \"Use the `$snapshots` metadata table to determine the latest snapshot ID of the\\ntable like in the following query:\\n\\n```\\nSELECT snapshot_id\\nFROM example.testdb.\\\"customer_orders$snapshots\\\"\\nORDER BY committed_at DESC LIMIT 1;\\n```\\n\\nThe table procedure `rollback_to_snapshot` allows the caller to roll back the\\nstate of the table to a previous snapshot id:\\n\\n```\\nALTER TABLE testdb.customer_orders EXECUTE rollback_to_snapshot(8954597067493422955);\\n```\"}, \"`NOT NULL` column constraint\": \"The Iceberg connector supports setting `NOT NULL` constraints on the table\\ncolumns.\\n\\nThe `NOT NULL` constraint can be set on the columns, while creating tables by\\nusing the {doc}`CREATE TABLE </sql/create-table>` syntax:\\n\\n```\\nCREATE TABLE example_table (\\n year INTEGER NOT NULL,\\n name VARCHAR NOT NULL,\\n age INTEGER,\\n address VARCHAR\\n);\\n```\\n\\nWhen trying to insert/update data in the table, the query fails if trying to set\\n`NULL` value on a column having the `NOT NULL` constraint.\\n\\n(iceberg-materialized-views)=\"}, \"Materialized views\": \"The Iceberg connector supports {ref}`sql-materialized-view-management`. In the\\nunderlying system, each materialized view consists of a view definition and an\\nIceberg storage table. The storage table name is stored as a materialized view\\nproperty. The data is stored in that storage table.\\n\\nYou can use the {ref}`iceberg-table-properties` to control the created storage\\ntable and therefore the layout and performance. For example, you can use the\\nfollowing clause with {doc}`/sql/create-materialized-view` to use the ORC format\\nfor the data files and partition the storage per day using the column\\n`event_date`:\\n\\n```\\nWITH ( format = 'ORC', partitioning = ARRAY['event_date'] )\\n```\\n\\nBy default, the storage table is created in the same schema as the materialized\\nview definition. The `storage_schema` materialized view property can be\\nused to specify the schema where the storage table is created.\\n\\nCreating a materialized view does not automatically populate it with data. You\\nmust run {doc}`/sql/refresh-materialized-view` to populate data in the\\nmaterialized view.\\n\\nUpdating the data in the materialized view can be achieved using the `REFRESH\\nMATERIALIZED VIEW` command. This operation may perform either an incremental or\\na full refresh, depending on the complexity of the materialized view definition\\nand the snapshot history of the source tables. For a full refresh, the operation\\ndeletes the data from the storage table, and inserts the data that is the result\\nof executing the materialized view query into the existing table. For\\nincremental refresh, the existing data is not deleted from the storage table and\\nonly the delta records are processed from the source tables and appended into\\nthe storage table as needed. In both cases, data is replaced or appended\\natomically, so users can continue to query the materialized view while it is\\nbeing refreshed. Refreshing a materialized view also stores the snapshot-ids of\\nall Iceberg tables that are part of the materialized view's query in the\\nmaterialized view metadata. When the materialized view is queried, the\\nsnapshot-ids are used to check if the data in the storage table is up to date.\\n\\nMaterialized views that use non-Iceberg tables in the query show the [default\\nbehavior around grace periods](mv-grace-period). If all tables are Iceberg\\ntables, the connector can determine if the data has not changed and continue to\\nuse the data from the storage tables, even after the grace period expired.\\n\\nDropping a materialized view with {doc}`/sql/drop-materialized-view` removes\\nthe definition and the storage table.\", \"Table functions\": {\"table_changes\": \"Allows reading row-level changes between two versions of an Iceberg table.\\nThe following query shows an example of displaying the changes of the `t1`\\ntable in the `default` schema in the current catalog.\\nAll changes between the start and end snapshots are returned.\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n system.table_changes(\\n schema_name => 'default',\\n table_name => 't1',\\n start_snapshot_id => 6541165659943306573,\\n end_snapshot_id => 6745790645714043599\\n )\\n );\\n```\\n\\nThe function takes the following required parameters:\\n\\n['`schema_name`\\\\n: Name of the schema for which the function is called.', '`table_name`\\\\n: Name of the table for which the function is called.', '`start_snapshot_id`\\\\n: The identifier of the exclusive starting snapshot.', '`end_snapshot_id`\\\\n: The identifier of the inclusive end snapshot.']\\n\\nUse the `$snapshots` metadata table to determine the snapshot IDs of the\\ntable.\\n\\nThe function returns the columns present in the table, and the following values\\nfor each change:\\n\\n['`_change_type`\\\\n: The type of change that occurred. Possible values are `insert` and `delete`.', '`_change_version_id`\\\\n: The identifier of the snapshot in which the change occurred.', '`_change_timestamp`\\\\n: Timestamp when the snapshot became active.', '`_change_ordinal`\\\\n: Order number of the change, useful for sorting the results.']\\n\\n**Example:**\\n\\nCreate a table:\\n\\n```\\nCREATE TABLE test_schema.pages (page_url VARCHAR, domain VARCHAR, views INTEGER);\\n```\\n\\nInsert some data:\\n\\n```\\nINSERT INTO test_schema.pages\\n VALUES\\n ('url1', 'domain1', 1),\\n ('url2', 'domain2', 2),\\n ('url3', 'domain1', 3);\\nINSERT INTO test_schema.pages\\n VALUES\\n ('url4', 'domain1', 400),\\n ('url5', 'domain2', 500),\\n ('url6', 'domain3', 2);\\n```\\n\\nRetrieve the snapshot identifiers of the changes performed on the table:\\n\\n```\\nSELECT\\n snapshot_id,\\n parent_id,\\n operation\\nFROM test_schema.\\\"pages$snapshots\\\";\\n```\\n\\n```\\n snapshot_id | parent_id | operation\\n---------------------+---------------------+-----------\\n 2009020668682716382 | NULL | append\\n 2135434251890923160 | 2009020668682716382 | append\\n 3108755571950643966 | 2135434251890923160 | append\\n(3 rows)\\n\\n```\\n\\nSelect the changes performed in the previously-mentioned `INSERT` statements:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n system.table_changes(\\n schema_name => 'test_schema',\\n table_name => 'pages',\\n start_snapshot_id => 2009020668682716382,\\n end_snapshot_id => 3108755571950643966\\n )\\n )\\nORDER BY _change_ordinal ASC;\\n```\\n\\n```\\n page_url | domain | views | _change_type | _change_version_id | _change_timestamp | _change_ordinal\\n----------+---------+-------+--------------+---------------------+-----------------------------+-----------------\\n url1 | domain1 | 1 | insert | 2135434251890923160 | 2024-04-04 21:24:26.105 UTC | 0\\n url2 | domain2 | 2 | insert | 2135434251890923160 | 2024-04-04 21:24:26.105 UTC | 0\\n url3 | domain1 | 3 | insert | 2135434251890923160 | 2024-04-04 21:24:26.105 UTC | 0\\n url4 | domain1 | 400 | insert | 3108755571950643966 | 2024-04-04 21:24:28.318 UTC | 1\\n url5 | domain2 | 500 | insert | 3108755571950643966 | 2024-04-04 21:24:28.318 UTC | 1\\n url6 | domain3 | 2 | insert | 3108755571950643966 | 2024-04-04 21:24:28.318 UTC | 1\\n(6 rows)\\n```\"}}, \"Performance\": {\"Table statistics\": {\"Updating table statistics\": \"If your queries are complex and include joining large data sets, running\\n{doc}`/sql/analyze` on tables may improve query performance by collecting\\nstatistical information about the data:\\n\\n```\\nANALYZE table_name;\\n```\\n\\nThis query collects statistics for all columns.\\n\\nOn wide tables, collecting statistics for all columns can be expensive. It is\\nalso typically unnecessary - statistics are only useful on specific columns,\\nlike join keys, predicates, or grouping keys. You can specify a subset of\\ncolumns to analyzed with the optional `columns` property:\\n\\n```\\nANALYZE table_name WITH (columns = ARRAY['col_1', 'col_2']);\\n```\\n\\nThis query collects statistics for columns `col_1` and `col_2`.\\n\\nNote that if statistics were previously collected for all columns, they must be\\ndropped using the {ref}`drop_extended_stats <drop-extended-stats>` command\\nbefore re-analyzing.\\n\\n(iceberg-table-redirection)=\"}, \"Table redirection\": \"```\\n```\\n\\nThe connector supports redirection from Iceberg tables to Hive tables with the\\n`iceberg.hive-catalog-name` catalog configuration property.\", \"File system cache\": \"The connector supports configuring and using [file system\\ncaching](/object-storage/file-system-cache).\", \"Iceberg metadata caching\": \"The Iceberg connector supports caching metadata in coordinator memory. This\\nmetadata caching is enabled by default and can be disabled by setting the\\n`iceberg.metadata-cache.enabled` configuration property to `false`.\\nWhen `fs.cache.enabled` is set to `true`, metadata is cached on local disks\\nusing the [file system caching\\nimplementation](/object-storage/file-system-cache). If `fs.cache.enabled` is\\nenabled, metadata caching in coordinator memory is deactivated.\\n\\nAdditionally, you can use the following catalog configuration properties:\\n\\n:::{list-table} Memory metadata caching configuration properties :widths: 25, 75\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.memory-cache.ttl`', 'The maximum [duration](prop-type-duration) to keep files in the cache prior\\\\nto eviction. The minimum value of `0s` means that caching is effectively\\\\nturned off. Defaults to `1h`.'], ['`fs.memory-cache.max-size`', 'The maximum total [data size](prop-type-data-size) of the cache. When\\\\nraising this value, keep in mind that the coordinator memory is used.\\\\nDefaults to `200MB`.'], ['`fs.memory-cache.max-content-length`', 'The maximum file size that can be cached. Defaults to `15MB`.\\\\n:::']]\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 13]\"}, {\"title\": \"Ignite connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to an Ignite server, you need:\\n\\n['Ignite version 2.9.0 or latter', 'Network access from the Trino coordinator and workers to the Ignite\\\\nserver. Port 10800 is the default port.', 'Specify `--add-opens=java.base/java.nio=ALL-UNNAMED` in the `jvm.config` when starting the Trino server.']\", \"Configuration\": {\"Multiple Ignite servers\": \"If you have multiple Ignite servers you need to configure one\\ncatalog for each server. To add another catalog:\\n\\n['Add another properties file to `etc/catalog`', 'Save it with a different name that ends in `.properties`']\\n\\nFor example, if you name the property file `sales.properties`, Trino uses the\\nconfigured connector to create a catalog named `sales`.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\"}, \"Table properties\": {\"`primary_key`\": \"This is a list of columns to be used as the table's primary key. If not specified, a `VARCHAR` primary key column named `DUMMY_ID` is generated,\\nthe value is derived from the value generated by the `UUID` function in Ignite.\\n\\n(ignite-type-mapping)=\"}, \"Type mapping\": \"The following are supported Ignite SQL data types from [https://ignite.apache.org/docs/latest/sql-reference/data-types](https://ignite.apache.org/docs/latest/sql-reference/data-types)\\n\\n:::{list-table}\\n:widths: 25, 25, 50\\n:header-rows: 1\\n\\n[['Ignite SQL data type name', 'Map to Trino type', 'Possible values'], ['`BOOLEAN`', '`BOOLEAN`', '`TRUE` and `FALSE`'], ['`BIGINT`', '`BIGINT`', '`-9223372036854775808`, `9223372036854775807`, etc.'], ['`DECIMAL`', '`DECIMAL`', 'Data type with fixed precision and scale'], ['`DOUBLE`', '`DOUBLE`', '`3.14`, `-10.24`, etc.'], ['`INT`', '`INT`', '`-2147483648`, `2147483647`, etc.'], ['`REAL`', '`REAL`', '`3.14`, `-10.24`, etc.'], ['`SMALLINT`', '`SMALLINT`', '`-32768`, `32767`, etc.'], ['`TINYINT`', '`TINYINT`', '`-128`, `127`, etc.'], ['`CHAR`', '`CHAR`', '`hello`, `Trino`, etc.'], ['`VARCHAR`', '`VARCHAR`', '`hello`, `Trino`, etc.'], ['`DATE`', '`DATE`', '`1972-01-01`, `2021-07-15`, etc.'], ['`BINARY`', '`VARBINARY`', 'Represents a byte array.\\\\n:::']]\\n\\n(ignite-sql-support)=\", \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(ignite-pushdown)=\", \"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`join-pushdown`', '{ref}`limit-pushdown`', '{ref}`topn-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`']\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`1000`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 14]\"}, {\"title\": \"JMX connector\", \"description\": null, \"content\": {\"Configuration\": \"To configure the JMX connector, create a catalog properties file\\n`etc/catalog/example.properties` with the following contents:\\n\\n```\\nconnector.name=jmx\\n```\\n\\nTo enable periodical dumps, define the following properties:\\n\\n```\\nconnector.name=jmx\\njmx.dump-tables=java.lang:type=Runtime,trino.execution.scheduler:name=NodeScheduler\\njmx.dump-period=10s\\njmx.max-entries=86400\\n```\\n\\n`dump-tables` is a comma separated list of Managed Beans (MBean). It specifies\\nwhich MBeans are sampled and stored in memory every `dump-period`. You can\\nconfigure the maximum number of history entries with `max-entries` and it\\ndefaults to `86400`. The time between dumps can be configured using\\n`dump-period` and it defaults to `10s`.\\n\\nCommas in MBean names must be escaped using double backslashes (`\\\\\\\\`) in the\\nfollowing manner:\\n\\n```\\nconnector.name=jmx\\njmx.dump-tables=trino.memory:name=general\\\\\\\\,type=memorypool,trino.memory:name=reserved\\\\\\\\,type=memorypool\\n```\\n\\nDouble backslashes are required because a single backslash (`\\\\`) is used to\\nsplit the value across multiple lines in the following manner:\\n\\n```\\nconnector.name=jmx\\njmx.dump-tables=trino.memory:name=general\\\\\\\\,type=memorypool,\\\\\\n trino.memory:name=reserved\\\\\\\\,type=memorypool\\n```\", \"Querying JMX\": \"The JMX connector provides two schemas.\\n\\nThe first one is `current` that contains every MBean from every node in the Trino\\ncluster. You can see all the available MBeans by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.current;\\n```\\n\\nMBean names map to non-standard table names, and must be quoted with\\ndouble quotes when referencing them in a query. For example, the\\nfollowing query shows the JVM version of every node:\\n\\n```\\nSELECT node, vmname, vmversion\\nFROM example.current.\\\"java.lang:type=runtime\\\";\\n```\\n\\n```\\n node | vmname | vmversion\\n--------------------------------------+-----------------------------------+-----------\\n ddc4df17-0b8e-4843-bb14-1b8af1a7451a | Java HotSpot(TM) 64-Bit Server VM | 24.60-b09\\n(1 row)\\n```\\n\\nThe following query shows the open and maximum file descriptor counts\\nfor each node:\\n\\n```\\nSELECT openfiledescriptorcount, maxfiledescriptorcount\\nFROM example.current.\\\"java.lang:type=operatingsystem\\\";\\n```\\n\\n```\\n openfiledescriptorcount | maxfiledescriptorcount\\n-------------------------+------------------------\\n 329 | 10240\\n(1 row)\\n```\\n\\nThe wildcard character `*` may be used with table names in the `current` schema.\\nThis allows matching several MBean objects within a single query. The following query\\nreturns information from the different Trino memory pools on each node:\\n\\n```\\nSELECT freebytes, node, object_name\\nFROM example.current.\\\"trino.memory:*type=memorypool*\\\";\\n```\\n\\n```\\n freebytes | node | object_name\\n------------+---------+----------------------------------------------------------\\n 214748364 | example | trino.memory:type=MemoryPool,name=reserved\\n 1073741825 | example | trino.memory:type=MemoryPool,name=general\\n 858993459 | example | trino.memory:type=MemoryPool,name=system\\n(3 rows)\\n```\\n\\nThe `history` schema contains the list of tables configured in the connector properties file.\\nThe tables have the same columns as those in the current schema, but with an additional\\ntimestamp column that stores the time at which the snapshot was taken:\\n\\n```\\nSELECT \\\"timestamp\\\", \\\"uptime\\\" FROM example.history.\\\"java.lang:type=runtime\\\";\\n```\\n\\n```\\n timestamp | uptime\\n-------------------------+--------\\n 2016-01-28 10:18:50.000 | 11420\\n 2016-01-28 10:19:00.000 | 21422\\n 2016-01-28 10:19:10.000 | 31412\\n(3 rows)\\n```\\n\\n(jmx-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access JMX information\\non your Trino nodes.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 15]\"}, {\"title\": \"Kafka connector tutorial\", \"description\": null, \"content\": {\"Introduction\": \"The {doc}`kafka` for Trino allows access to live topic data from\\nApache Kafka using Trino. This tutorial shows how to set up topics, and\\nhow to create the topic description files that back Trino tables.\", \"Installation\": {\"Step 1: Install Apache Kafka\": \"Download and extract [Apache Kafka](https://kafka.apache.org/).\\n\\n:::{note}\\nThis tutorial was tested with Apache Kafka 0.8.1.\\nIt should work with any 0.8.x version of Apache Kafka.\\n:::\\n\\nStart ZooKeeper and the Kafka server:\\n\\n```\\n$ bin/zookeeper-server-start.sh config/zookeeper.properties\\n[2013-04-22 15:01:37,495] INFO Reading configuration from: config/zookeeper.properties (org.apache.zookeeper.server.quorum.QuorumPeerConfig)\\n...\\n```\\n\\n```\\n$ bin/kafka-server-start.sh config/server.properties\\n[2013-04-22 15:01:47,028] INFO Verifying properties (kafka.utils.VerifiableProperties)\\n[2013-04-22 15:01:47,051] INFO Property socket.send.buffer.bytes is overridden to 1048576 (kafka.utils.VerifiableProperties)\\n...\\n```\\n\\nThis starts Zookeeper on port `2181` and Kafka on port `9092`.\", \"Step 2: Load data\": \"Download the tpch-kafka loader from Maven Central:\\n\\n```\\n$ curl -o kafka-tpch https://repo1.maven.org/maven2/de/softwareforge/kafka_tpch_0811/1.0/kafka_tpch_0811-1.0.sh\\n$ chmod 755 kafka-tpch\\n```\\n\\nNow run the `kafka-tpch` program to preload a number of topics with tpch data:\\n\\n```\\n$ ./kafka-tpch load --brokers localhost:9092 --prefix tpch. --tpch-type tiny\\n2014-07-28T17:17:07.594-0700 INFO main io.airlift.log.Logging Logging to stderr\\n2014-07-28T17:17:07.623-0700 INFO main de.softwareforge.kafka.LoadCommand Processing tables: [customer, orders, lineitem, part, partsupp, supplier, nation, region]\\n2014-07-28T17:17:07.981-0700 INFO pool-1-thread-1 de.softwareforge.kafka.LoadCommand Loading table 'customer' into topic 'tpch.customer'...\\n2014-07-28T17:17:07.981-0700 INFO pool-1-thread-2 de.softwareforge.kafka.LoadCommand Loading table 'orders' into topic 'tpch.orders'...\\n2014-07-28T17:17:07.981-0700 INFO pool-1-thread-3 de.softwareforge.kafka.LoadCommand Loading table 'lineitem' into topic 'tpch.lineitem'...\\n2014-07-28T17:17:07.982-0700 INFO pool-1-thread-4 de.softwareforge.kafka.LoadCommand Loading table 'part' into topic 'tpch.part'...\\n2014-07-28T17:17:07.982-0700 INFO pool-1-thread-5 de.softwareforge.kafka.LoadCommand Loading table 'partsupp' into topic 'tpch.partsupp'...\\n2014-07-28T17:17:07.982-0700 INFO pool-1-thread-6 de.softwareforge.kafka.LoadCommand Loading table 'supplier' into topic 'tpch.supplier'...\\n2014-07-28T17:17:07.982-0700 INFO pool-1-thread-7 de.softwareforge.kafka.LoadCommand Loading table 'nation' into topic 'tpch.nation'...\\n2014-07-28T17:17:07.982-0700 INFO pool-1-thread-8 de.softwareforge.kafka.LoadCommand Loading table 'region' into topic 'tpch.region'...\\n2014-07-28T17:17:10.612-0700 ERROR pool-1-thread-8 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.region\\n2014-07-28T17:17:10.781-0700 INFO pool-1-thread-8 de.softwareforge.kafka.LoadCommand Generated 5 rows for table 'region'.\\n2014-07-28T17:17:10.797-0700 ERROR pool-1-thread-3 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.lineitem\\n2014-07-28T17:17:10.932-0700 ERROR pool-1-thread-1 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.customer\\n2014-07-28T17:17:11.068-0700 ERROR pool-1-thread-2 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.orders\\n2014-07-28T17:17:11.200-0700 ERROR pool-1-thread-6 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.supplier\\n2014-07-28T17:17:11.319-0700 INFO pool-1-thread-6 de.softwareforge.kafka.LoadCommand Generated 100 rows for table 'supplier'.\\n2014-07-28T17:17:11.333-0700 ERROR pool-1-thread-4 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.part\\n2014-07-28T17:17:11.466-0700 ERROR pool-1-thread-5 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.partsupp\\n2014-07-28T17:17:11.597-0700 ERROR pool-1-thread-7 kafka.producer.async.DefaultEventHandler Failed to collate messages by topic, partition due to: Failed to fetch topic metadata for topic: tpch.nation\\n2014-07-28T17:17:11.706-0700 INFO pool-1-thread-7 de.softwareforge.kafka.LoadCommand Generated 25 rows for table 'nation'.\\n2014-07-28T17:17:12.180-0700 INFO pool-1-thread-1 de.softwareforge.kafka.LoadCommand Generated 1500 rows for table 'customer'.\\n2014-07-28T17:17:12.251-0700 INFO pool-1-thread-4 de.softwareforge.kafka.LoadCommand Generated 2000 rows for table 'part'.\\n2014-07-28T17:17:12.905-0700 INFO pool-1-thread-2 de.softwareforge.kafka.LoadCommand Generated 15000 rows for table 'orders'.\\n2014-07-28T17:17:12.919-0700 INFO pool-1-thread-5 de.softwareforge.kafka.LoadCommand Generated 8000 rows for table 'partsupp'.\\n2014-07-28T17:17:13.877-0700 INFO pool-1-thread-3 de.softwareforge.kafka.LoadCommand Generated 60175 rows for table 'lineitem'.\\n```\\n\\nKafka now has a number of topics that are preloaded with data to query.\", \"Step 3: Make the Kafka topics known to Trino\": \"In your Trino installation, add a catalog properties file\\n`etc/catalog/kafka.properties` for the Kafka connector.\\nThis file lists the Kafka nodes and topics:\\n\\n```\\nconnector.name=kafka\\nkafka.nodes=localhost:9092\\nkafka.table-names=tpch.customer,tpch.orders,tpch.lineitem,tpch.part,tpch.partsupp,tpch.supplier,tpch.nation,tpch.region\\nkafka.hide-internal-columns=false\\n```\\n\\nNow start Trino:\\n\\n```\\n$ bin/launcher start\\n```\\n\\nBecause the Kafka tables all have the `tpch.` prefix in the configuration,\\nthe tables are in the `tpch` schema. The connector is mounted into the\\n`kafka` catalog, because the properties file is named `kafka.properties`.\\n\\nStart the {doc}`Trino CLI </client/cli>`:\\n\\n```\\n$ ./trino --catalog kafka --schema tpch\\n```\\n\\nList the tables to verify that things are working:\\n\\n```\\ntrino:tpch> SHOW TABLES;\\n Table\\n----------\\n customer\\n lineitem\\n nation\\n orders\\n part\\n partsupp\\n region\\n supplier\\n(8 rows)\\n```\", \"Step 4: Basic data querying\": \"Kafka data is unstructured, and it has no metadata to describe the format of\\nthe messages. Without further configuration, the Kafka connector can access\\nthe data, and map it in raw form. However there are no actual columns besides the\\nbuilt-in ones:\\n\\n```\\ntrino:tpch> DESCRIBE customer;\\n Column | Type | Extra | Comment\\n-------------------+------------+-------+---------------------------------------------\\n _partition_id | bigint | | Partition Id\\n _partition_offset | bigint | | Offset for the message within the partition\\n _key | varchar | | Key text\\n _key_corrupt | boolean | | Key data is corrupt\\n _key_length | bigint | | Total number of key bytes\\n _message | varchar | | Message text\\n _message_corrupt | boolean | | Message data is corrupt\\n _message_length | bigint | | Total number of message bytes\\n _timestamp | timestamp | | Message timestamp\\n(11 rows)\\n\\ntrino:tpch> SELECT count(*) FROM customer;\\n _col0\\n-------\\n 1500\\n\\ntrino:tpch> SELECT _message FROM customer LIMIT 5;\\n _message\\n--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\\n {\\\"rowNumber\\\":1,\\\"customerKey\\\":1,\\\"name\\\":\\\"Customer#000000001\\\",\\\"address\\\":\\\"IVhzIApeRb ot,c,E\\\",\\\"nationKey\\\":15,\\\"phone\\\":\\\"25-989-741-2988\\\",\\\"accountBalance\\\":711.56,\\\"marketSegment\\\":\\\"BUILDING\\\",\\\"comment\\\":\\\"to the even, regular platelets. regular, ironic epitaphs nag e\\\"}\\n {\\\"rowNumber\\\":3,\\\"customerKey\\\":3,\\\"name\\\":\\\"Customer#000000003\\\",\\\"address\\\":\\\"MG9kdTD2WBHm\\\",\\\"nationKey\\\":1,\\\"phone\\\":\\\"11-719-748-3364\\\",\\\"accountBalance\\\":7498.12,\\\"marketSegment\\\":\\\"AUTOMOBILE\\\",\\\"comment\\\":\\\" deposits eat slyly ironic, even instructions. express foxes detect slyly. blithel\\n {\\\"rowNumber\\\":5,\\\"customerKey\\\":5,\\\"name\\\":\\\"Customer#000000005\\\",\\\"address\\\":\\\"KvpyuHCplrB84WgAiGV6sYpZq7Tj\\\",\\\"nationKey\\\":3,\\\"phone\\\":\\\"13-750-942-6364\\\",\\\"accountBalance\\\":794.47,\\\"marketSegment\\\":\\\"HOUSEHOLD\\\",\\\"comment\\\":\\\"n accounts will have to unwind. foxes cajole accor\\\"}\\n {\\\"rowNumber\\\":7,\\\"customerKey\\\":7,\\\"name\\\":\\\"Customer#000000007\\\",\\\"address\\\":\\\"TcGe5gaZNgVePxU5kRrvXBfkasDTea\\\",\\\"nationKey\\\":18,\\\"phone\\\":\\\"28-190-982-9759\\\",\\\"accountBalance\\\":9561.95,\\\"marketSegment\\\":\\\"AUTOMOBILE\\\",\\\"comment\\\":\\\"ainst the ironic, express theodolites. express, even pinto bean\\n {\\\"rowNumber\\\":9,\\\"customerKey\\\":9,\\\"name\\\":\\\"Customer#000000009\\\",\\\"address\\\":\\\"xKiAFTjUsCuxfeleNqefumTrjS\\\",\\\"nationKey\\\":8,\\\"phone\\\":\\\"18-338-906-3675\\\",\\\"accountBalance\\\":8324.07,\\\"marketSegment\\\":\\\"FURNITURE\\\",\\\"comment\\\":\\\"r theodolites according to the requests wake thinly excuses: pending\\n(5 rows)\\n\\ntrino:tpch> SELECT sum(cast(json_extract_scalar(_message, '$.accountBalance') AS DOUBLE)) FROM customer LIMIT 10;\\n _col0\\n------------\\n 6681865.59\\n(1 row)\\n```\\n\\nThe data from Kafka can be queried using Trino, but it is not yet in\\nactual table shape. The raw data is available through the `_message` and\\n`_key` columns, but it is not decoded into columns. As the sample data is\\nin JSON format, the {doc}`/functions/json` built into Trino can be used\\nto slice the data.\", \"Step 5: Add a topic description file\": \"The Kafka connector supports topic description files to turn raw data into\\ntable format. These files are located in the `etc/kafka` folder in the\\nTrino installation and must end with `.json`. It is recommended that\\nthe file name matches the table name, but this is not necessary.\\n\\nAdd the following file as `etc/kafka/tpch.customer.json` and restart Trino:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"customer\\\",\\n \\\"schemaName\\\": \\\"tpch\\\",\\n \\\"topicName\\\": \\\"tpch.customer\\\",\\n \\\"key\\\": {\\n \\\"dataFormat\\\": \\\"raw\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"kafka_key\\\",\\n \\\"dataFormat\\\": \\\"LONG\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"hidden\\\": \\\"false\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nThe customer table now has an additional column: `kafka_key`.\\n\\n```\\ntrino:tpch> DESCRIBE customer;\\n Column | Type | Extra | Comment\\n-------------------+------------+-------+---------------------------------------------\\n kafka_key | bigint | |\\n _partition_id | bigint | | Partition Id\\n _partition_offset | bigint | | Offset for the message within the partition\\n _key | varchar | | Key text\\n _key_corrupt | boolean | | Key data is corrupt\\n _key_length | bigint | | Total number of key bytes\\n _message | varchar | | Message text\\n _message_corrupt | boolean | | Message data is corrupt\\n _message_length | bigint | | Total number of message bytes\\n _timestamp | timestamp | | Message timestamp\\n(12 rows)\\n\\ntrino:tpch> SELECT kafka_key FROM customer ORDER BY kafka_key LIMIT 10;\\n kafka_key\\n-----------\\n 0\\n 1\\n 2\\n 3\\n 4\\n 5\\n 6\\n 7\\n 8\\n 9\\n(10 rows)\\n```\\n\\nThe topic definition file maps the internal Kafka key, which is a raw long\\nin eight bytes, onto a Trino `BIGINT` column.\", \"Step 6: Map all the values from the topic message onto columns\": \"Update the `etc/kafka/tpch.customer.json` file to add fields for the\\nmessage, and restart Trino. As the fields in the message are JSON, it uses\\nthe `JSON` data format. This is an example, where different data formats\\nare used for the key and the message.\\n\\n```\\n{\\n \\\"tableName\\\": \\\"customer\\\",\\n \\\"schemaName\\\": \\\"tpch\\\",\\n \\\"topicName\\\": \\\"tpch.customer\\\",\\n \\\"key\\\": {\\n \\\"dataFormat\\\": \\\"raw\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"kafka_key\\\",\\n \\\"dataFormat\\\": \\\"LONG\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"hidden\\\": \\\"false\\\"\\n }\\n ]\\n },\\n \\\"message\\\": {\\n \\\"dataFormat\\\": \\\"json\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"row_number\\\",\\n \\\"mapping\\\": \\\"rowNumber\\\",\\n \\\"type\\\": \\\"BIGINT\\\"\\n },\\n {\\n \\\"name\\\": \\\"customer_key\\\",\\n \\\"mapping\\\": \\\"customerKey\\\",\\n \\\"type\\\": \\\"BIGINT\\\"\\n },\\n {\\n \\\"name\\\": \\\"name\\\",\\n \\\"mapping\\\": \\\"name\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"address\\\",\\n \\\"mapping\\\": \\\"address\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"nation_key\\\",\\n \\\"mapping\\\": \\\"nationKey\\\",\\n \\\"type\\\": \\\"BIGINT\\\"\\n },\\n {\\n \\\"name\\\": \\\"phone\\\",\\n \\\"mapping\\\": \\\"phone\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"account_balance\\\",\\n \\\"mapping\\\": \\\"accountBalance\\\",\\n \\\"type\\\": \\\"DOUBLE\\\"\\n },\\n {\\n \\\"name\\\": \\\"market_segment\\\",\\n \\\"mapping\\\": \\\"marketSegment\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"comment\\\",\\n \\\"mapping\\\": \\\"comment\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nNow for all the fields in the JSON of the message, columns are defined and\\nthe sum query from earlier can operate on the `account_balance` column directly:\\n\\n```\\ntrino:tpch> DESCRIBE customer;\\n Column | Type | Extra | Comment\\n-------------------+------------+-------+---------------------------------------------\\n kafka_key | bigint | |\\n row_number | bigint | |\\n customer_key | bigint | |\\n name | varchar | |\\n address | varchar | |\\n nation_key | bigint | |\\n phone | varchar | |\\n account_balance | double | |\\n market_segment | varchar | |\\n comment | varchar | |\\n _partition_id | bigint | | Partition Id\\n _partition_offset | bigint | | Offset for the message within the partition\\n _key | varchar | | Key text\\n _key_corrupt | boolean | | Key data is corrupt\\n _key_length | bigint | | Total number of key bytes\\n _message | varchar | | Message text\\n _message_corrupt | boolean | | Message data is corrupt\\n _message_length | bigint | | Total number of message bytes\\n _timestamp | timestamp | | Message timestamp\\n(21 rows)\\n\\ntrino:tpch> SELECT * FROM customer LIMIT 5;\\n kafka_key | row_number | customer_key | name | address | nation_key | phone | account_balance | market_segment | comment\\n-----------+------------+--------------+--------------------+---------------------------------------+------------+-----------------+-----------------+----------------+---------------------------------------------------------------------------------------------------------\\n 1 | 2 | 2 | Customer#000000002 | XSTf4,NCwDVaWNe6tEgvwfmRchLXak | 13 | 23-768-687-3665 | 121.65 | AUTOMOBILE | l accounts. blithely ironic theodolites integrate boldly: caref\\n 3 | 4 | 4 | Customer#000000004 | XxVSJsLAGtn | 4 | 14-128-190-5944 | 2866.83 | MACHINERY | requests. final, regular ideas sleep final accou\\n 5 | 6 | 6 | Customer#000000006 | sKZz0CsnMD7mp4Xd0YrBvx,LREYKUWAh yVn | 20 | 30-114-968-4951 | 7638.57 | AUTOMOBILE | tions. even deposits boost according to the slyly bold packages. final accounts cajole requests. furious\\n 7 | 8 | 8 | Customer#000000008 | I0B10bB0AymmC, 0PrRYBCP1yGJ8xcBPmWhl5 | 17 | 27-147-574-9335 | 6819.74 | BUILDING | among the slyly regular theodolites kindle blithely courts. carefully even theodolites haggle slyly alon\\n 9 | 10 | 10 | Customer#000000010 | 6LrEaV6KR6PLVcgl2ArL Q3rqzLzcT1 v2 | 5 | 15-741-346-9870 | 2753.54 | HOUSEHOLD | es regular deposits haggle. fur\\n(5 rows)\\n\\ntrino:tpch> SELECT sum(account_balance) FROM customer LIMIT 10;\\n _col0\\n------------\\n 6681865.59\\n(1 row)\\n```\\n\\nNow all the fields from the `customer` topic messages are available as\\nTrino table columns.\", \"Step 7: Use live data\": {\"Setup a live Twitter feed\": [\"Download the twistr tool\"], \"Create a tweets table on Trino\": \"Add the tweets table to the `etc/catalog/kafka.properties` file:\\n\\n```\\nconnector.name=kafka\\nkafka.nodes=localhost:9092\\nkafka.table-names=tpch.customer,tpch.orders,tpch.lineitem,tpch.part,tpch.partsupp,tpch.supplier,tpch.nation,tpch.region,tweets\\nkafka.hide-internal-columns=false\\n```\\n\\nAdd a topic definition file for the Twitter feed as `etc/kafka/tweets.json`:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"tweets\\\",\\n \\\"topicName\\\": \\\"twitter_feed\\\",\\n \\\"dataFormat\\\": \\\"json\\\",\\n \\\"key\\\": {\\n \\\"dataFormat\\\": \\\"raw\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"kafka_key\\\",\\n \\\"dataFormat\\\": \\\"LONG\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"hidden\\\": \\\"false\\\"\\n }\\n ]\\n },\\n \\\"message\\\": {\\n \\\"dataFormat\\\":\\\"json\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"text\\\",\\n \\\"mapping\\\": \\\"text\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"user_name\\\",\\n \\\"mapping\\\": \\\"user/screen_name\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"lang\\\",\\n \\\"mapping\\\": \\\"lang\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"created_at\\\",\\n \\\"mapping\\\": \\\"created_at\\\",\\n \\\"type\\\": \\\"TIMESTAMP\\\",\\n \\\"dataFormat\\\": \\\"rfc2822\\\"\\n },\\n {\\n \\\"name\\\": \\\"favorite_count\\\",\\n \\\"mapping\\\": \\\"favorite_count\\\",\\n \\\"type\\\": \\\"BIGINT\\\"\\n },\\n {\\n \\\"name\\\": \\\"retweet_count\\\",\\n \\\"mapping\\\": \\\"retweet_count\\\",\\n \\\"type\\\": \\\"BIGINT\\\"\\n },\\n {\\n \\\"name\\\": \\\"favorited\\\",\\n \\\"mapping\\\": \\\"favorited\\\",\\n \\\"type\\\": \\\"BOOLEAN\\\"\\n },\\n {\\n \\\"name\\\": \\\"id\\\",\\n \\\"mapping\\\": \\\"id_str\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"in_reply_to_screen_name\\\",\\n \\\"mapping\\\": \\\"in_reply_to_screen_name\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n },\\n {\\n \\\"name\\\": \\\"place_name\\\",\\n \\\"mapping\\\": \\\"place/full_name\\\",\\n \\\"type\\\": \\\"VARCHAR\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nAs this table does not have an explicit schema name, it is placed\\ninto the `default` schema.\", \"Feed live data\": \"Start the twistr tool:\\n\\n```\\n$ java -Dness.config.location=file:$(pwd) -Dness.config=twistr -jar ./twistr\\n```\\n\\n`twistr` connects to the Twitter API and feeds the \\\"sample tweet\\\" feed\\ninto a Kafka topic called `twitter_feed`.\\n\\nNow run queries against live data:\\n\\n```\\n$ ./trino --catalog kafka --schema default\\n\\ntrino:default> SELECT count(*) FROM tweets;\\n _col0\\n-------\\n 4467\\n(1 row)\\n\\ntrino:default> SELECT count(*) FROM tweets;\\n _col0\\n-------\\n 4517\\n(1 row)\\n\\ntrino:default> SELECT count(*) FROM tweets;\\n _col0\\n-------\\n 4572\\n(1 row)\\n\\ntrino:default> SELECT kafka_key, user_name, lang, created_at FROM tweets LIMIT 10;\\n kafka_key | user_name | lang | created_at\\n--------------------+-----------------+------+-------------------------\\n 494227746231685121 | burncaniff | en | 2014-07-29 14:07:31.000\\n 494227746214535169 | gu8tn | ja | 2014-07-29 14:07:31.000\\n 494227746219126785 | pequitamedicen | es | 2014-07-29 14:07:31.000\\n 494227746201931777 | josnyS | ht | 2014-07-29 14:07:31.000\\n 494227746219110401 | Cafe510 | en | 2014-07-29 14:07:31.000\\n 494227746210332673 | Da_JuanAnd_Only | en | 2014-07-29 14:07:31.000\\n 494227746193956865 | Smile_Kidrauhl6 | pt | 2014-07-29 14:07:31.000\\n 494227750426017793 | CashforeverCD | en | 2014-07-29 14:07:32.000\\n 494227750396653569 | FilmArsivimiz | tr | 2014-07-29 14:07:32.000\\n 494227750388256769 | jmolas | es | 2014-07-29 14:07:32.000\\n(10 rows)\\n```\\n\\nThere is now a live feed into Kafka, which can be queried using Trino.\"}, \"Epilogue: Time stamps\": \"The tweets feed, that was set up in the last step, contains a timestamp in\\nRFC 2822 format as `created_at` attribute in each tweet.\\n\\n```\\ntrino:default> SELECT DISTINCT json_extract_scalar(_message, '$.created_at')) AS raw_date\\n -> FROM tweets LIMIT 5;\\n raw_date\\n--------------------------------\\n Tue Jul 29 21:07:31 +0000 2014\\n Tue Jul 29 21:07:32 +0000 2014\\n Tue Jul 29 21:07:33 +0000 2014\\n Tue Jul 29 21:07:34 +0000 2014\\n Tue Jul 29 21:07:35 +0000 2014\\n(5 rows)\\n```\\n\\nThe topic definition file for the tweets table contains a mapping onto a\\ntimestamp using the `rfc2822` converter:\\n\\n```\\n...\\n{\\n \\\"name\\\": \\\"created_at\\\",\\n \\\"mapping\\\": \\\"created_at\\\",\\n \\\"type\\\": \\\"TIMESTAMP\\\",\\n \\\"dataFormat\\\": \\\"rfc2822\\\"\\n},\\n...\\n```\\n\\nThis allows the raw data to be mapped onto a Trino TIMESTAMP column:\\n\\n```\\ntrino:default> SELECT created_at, raw_date FROM (\\n -> SELECT created_at, json_extract_scalar(_message, '$.created_at') AS raw_date\\n -> FROM tweets)\\n -> GROUP BY 1, 2 LIMIT 5;\\n created_at | raw_date\\n-------------------------+--------------------------------\\n 2014-07-29 14:07:20.000 | Tue Jul 29 21:07:20 +0000 2014\\n 2014-07-29 14:07:21.000 | Tue Jul 29 21:07:21 +0000 2014\\n 2014-07-29 14:07:22.000 | Tue Jul 29 21:07:22 +0000 2014\\n 2014-07-29 14:07:23.000 | Tue Jul 29 21:07:23 +0000 2014\\n 2014-07-29 14:07:24.000 | Tue Jul 29 21:07:24 +0000 2014\\n(5 rows)\\n```\\n\\nThe Kafka connector contains converters for ISO 8601, RFC 2822 text\\nformats and for number-based timestamps using seconds or milliseconds\\nsince the epoch. There is also a generic, text-based formatter, which uses\\nJoda-Time format strings to parse text columns.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 16]\"}, {\"title\": \"Kafka connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Kafka, you need:\\n\\n['Kafka broker version 3.3 or higher (with KRaft enabled).', 'Network access from the Trino coordinator and workers to the Kafka nodes.\\\\nPort 9092 is the default port.']\\n\\nWhen using Protobuf decoder with the {ref}`Confluent table description\\nsupplier<confluent-table-description-supplier>`, the following additional steps\\nmust be taken:\\n\\n['Copy the `kafka-protobuf-provider` and `kafka-protobuf-types` JAR files\\\\nfrom [Confluent](https://packages.confluent.io/maven/io/confluent/) for\\\\nConfluent version 7.9.0 to the Kafka connector plugin directory (`<install\\\\ndirectory>/plugin/kafka`) on all nodes in the cluster.\\\\nThe plugin directory depends on the {doc}`/installation` method.', 'By copying those JARs and using them, you agree to the terms of the [Confluent\\\\nCommunity License Agreement](https://github.com/confluentinc/schema-registry/blob/master/LICENSE-ConfluentCommunity)\\\\nunder which Confluent makes them available.']\\n\\nThese steps are not required if you are not using Protobuf and Confluent table\\ndescription supplier.\", \"Configuration\": {\"Multiple Kafka clusters\": \"You can have as many catalogs as you need, so if you have additional\\nKafka clusters, simply add another properties file to `etc/catalog`\\nwith a different name (making sure it ends in `.properties`). For\\nexample, if you name the property file `sales.properties`, Trino\\ncreates a catalog named `sales` using the configured connector.\", \"Log levels\": \"Kafka consumer logging can be verbose and pollute Trino logs. To lower the\\n[log level](logging-configuration), simply add the following to `etc/log.properties`:\\n\\n```\\norg.apache.kafka=WARN\\n```\"}, \"Configuration properties\": {\"`kafka.default-schema`\": \"Defines the schema which contains all tables that were defined without\\na qualifying schema name.\\n\\nThis property is optional; the default is `default`.\", \"`kafka.nodes`\": \"A comma separated list of `hostname:port` pairs for the Kafka data nodes.\\n\\nThis property is required; there is no default and at least one node must be defined.\\n\\n:::{note}\\nTrino must still be able to connect to all nodes of the cluster\\neven if only a subset is specified here, as segment files may be\\nlocated only on a specific node.\\n:::\", \"`kafka.buffer-size`\": \"Size of the internal data buffer for reading data from Kafka. The data\\nbuffer must be able to hold at least one message and ideally can hold many\\nmessages. There is one data buffer allocated per worker and data node.\\n\\nThis property is optional; the default is `64kb`.\", \"`kafka.timestamp-upper-bound-force-push-down-enabled`\": \"The upper bound predicate on `_timestamp` column\\nis pushed down only for topics using `LogAppendTime` mode.\\n\\nFor topics using `CreateTime` mode, upper bound pushdown must be explicitly\\nenabled via `kafka.timestamp-upper-bound-force-push-down-enabled` config property\\nor `timestamp_upper_bound_force_push_down_enabled` session property.\\n\\nThis property is optional; the default is `false`.\", \"`kafka.hide-internal-columns`\": \"In addition to the data columns defined in a table description file, the\\nconnector maintains a number of additional columns for each table. If\\nthese columns are hidden, they can still be used in queries but do not\\nshow up in `DESCRIBE <table-name>` or `SELECT *`.\\n\\nThis property is optional; the default is `true`.\", \"`kafka.security-protocol`\": \"Protocol used to communicate with brokers.\\nValid values are: `PLAINTEXT`, `SSL`.\\n\\nThis property is optional; default is `PLAINTEXT`.\", \"`kafka.ssl.keystore.location`\": \"Location of the keystore file used for connection to Kafka cluster.\\n\\nThis property is optional.\", \"`kafka.ssl.keystore.password`\": \"Password for the keystore file used for connection to Kafka cluster.\\n\\nThis property is optional, but required when `kafka.ssl.keystore.location` is given.\", \"`kafka.ssl.keystore.type`\": \"File format of the keystore file.\\nValid values are: `JKS`, `PKCS12`.\\n\\nThis property is optional; default is `JKS`.\", \"`kafka.ssl.truststore.location`\": \"Location of the truststore file used for connection to Kafka cluster.\\n\\nThis property is optional.\", \"`kafka.ssl.truststore.password`\": \"Password for the truststore file used for connection to Kafka cluster.\\n\\nThis property is optional, but required when `kafka.ssl.truststore.location` is given.\", \"`kafka.ssl.truststore.type`\": \"File format of the truststore file.\\nValid values are: JKS, PKCS12.\\n\\nThis property is optional; default is `JKS`.\", \"`kafka.ssl.key.password`\": \"Password for the private key in the keystore file used for connection to Kafka cluster.\\n\\nThis property is optional. This is required for clients only if two-way authentication is configured, i.e. `ssl.client.auth=required`.\", \"`kafka.ssl.endpoint-identification-algorithm`\": \"The endpoint identification algorithm used by clients to validate server host name for connection to Kafka cluster.\\nKafka uses `https` as default. Use `disabled` to disable server host name validation.\\n\\nThis property is optional; default is `https`.\"}, \"Internal columns\": \"The internal column prefix is configurable by `kafka.internal-column-prefix`\\nconfiguration property and defaults to `_`. A different prefix affects the\\ninternal column names in the following sections. For example, a value of\\n`internal_` changes the partition ID column name from `_partition_id`\\nto `internal_partition_id`.\\n\\nFor each defined table, the connector maintains the following columns:\\n\\n| Column name | Type | Description |\\n| ------------------- | ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `_partition_id` | BIGINT | ID of the Kafka partition which contains this row. |\\n| `_partition_offset` | BIGINT | Offset within the Kafka partition for this row. |\\n| `_segment_start` | BIGINT | Lowest offset in the segment (inclusive) which contains this row. This offset is partition specific. |\\n| `_segment_end` | BIGINT | Highest offset in the segment (exclusive) which contains this row. The offset is partition specific. This is the same value as `_segment_start` of the next segment (if it exists). |\\n| `_segment_count` | BIGINT | Running count for the current row within the segment. For an uncompacted topic, `_segment_start + _segment_count` is equal to `_partition_offset`. |\\n| `_message_corrupt` | BOOLEAN | True if the decoder could not decode the message for this row. When true, data columns mapped from the message should be treated as invalid. |\\n| `_message` | VARCHAR | Message bytes as a UTF-8 encoded string. This is only useful for a text topic. |\\n| `_message_length` | BIGINT | Number of bytes in the message. |\\n| `_headers` | map(VARCHAR, array(VARBINARY)) | Headers of the message where values with the same key are grouped as array. |\\n| `_key_corrupt` | BOOLEAN | True if the key decoder could not decode the key for this row. When true, data columns mapped from the key should be treated as invalid. |\\n| `_key` | VARCHAR | Key bytes as a UTF-8 encoded string. This is only useful for textual keys. |\\n| `_key_length` | BIGINT | Number of bytes in the key. |\\n| `_timestamp` | TIMESTAMP | Message timestamp. |\\n\\nFor tables without a table definition file, the `_key_corrupt` and\\n`_message_corrupt` columns will always be `false`.\\n\\n(kafka-table-schema-registry)=\", \"Table schema and schema registry usage\": {\"File table description supplier\": {\"`kafka.table-names`\": \"Comma-separated list of all tables provided by this catalog. A table name can be\\nunqualified (simple name), and is placed into the default schema (see\\nbelow), or it can be qualified with a schema name\\n(`<schema-name>.<table-name>`).\\n\\nFor each table defined here, a table description file (see below) may exist. If\\nno table description file exists, the table name is used as the topic name on\\nKafka, and no data columns are mapped into the table. The table still contains\\nall internal columns (see below).\\n\\nThis property is required; there is no default and at least one table must be\\ndefined.\", \"`kafka.table-description-dir`\": \"References a folder within Trino deployment that holds one or more JSON files\\n(must end with `.json`) which contain table description files.\\n\\nThis property is optional; the default is `etc/kafka`.\\n\\n(table-definition-files)=\", \"Table definition files\": \"Kafka maintains topics only as byte messages and leaves it to producers\\nand consumers to define how a message should be interpreted. For Trino,\\nthis data must be mapped into columns to allow queries against the data.\\n\\n:::{note}\\nFor textual topics that contain JSON data, it is entirely possible to not\\nuse any table definition files, but instead use the Trino\\n{doc}`/functions/json` to parse the `_message` column which contains\\nthe bytes mapped into a UTF-8 string. This is cumbersome and makes it\\ndifficult to write SQL queries. This only works when reading data.\\n:::\\n\\nA table definition file consists of a JSON definition for a table. The\\nname of the file can be arbitrary but must end in `.json`. Place the\\nfile in the directory configured with the `kafka.table-description-dir`\\nproperty. The table definition file must be accessible from all Trino nodes.\\n\\n```\\n{\\n \\\"tableName\\\": ...,\\n \\\"schemaName\\\": ...,\\n \\\"topicName\\\": ...,\\n \\\"key\\\": {\\n \\\"dataFormat\\\": ...,\\n \\\"fields\\\": [\\n ...\\n ]\\n },\\n \\\"message\\\": {\\n \\\"dataFormat\\\": ...,\\n \\\"fields\\\": [\\n ...\\n ]\\n }\\n}\\n```\\n\\n| Field | Required | Type | Description |\\n| ------------ | -------- | ----------- | ------------------------------------------------------------------------- |\\n| `tableName` | required | string | Trino table name defined by this file. |\\n| `schemaName` | optional | string | Schema containing the table. If omitted, the default schema name is used. |\\n| `topicName` | required | string | Kafka topic that is mapped. |\\n| `key` | optional | JSON object | Field definitions for data columns mapped to the message key. |\\n| `message` | optional | JSON object | Field definitions for data columns mapped to the message itself. |\", \"Key and message in Kafka\": \"Starting with Kafka 0.8, each message in a topic can have an optional key.\\nA table definition file contains sections for both key and message to map\\nthe data onto table columns.\\n\\nEach of the `key` and `message` fields in the table definition is a\\nJSON object that must contain two fields:\\n\\n| Field | Required | Type | Description |\\n| ------------ | -------- | ---------- | ------------------------------------------------------------------------------------------- |\\n| `dataFormat` | required | string | Selects the decoder for this group of fields. |\\n| `fields` | required | JSON array | A list of field definitions. Each field definition creates a new column in the Trino table. |\\n\\nEach field definition is a JSON object:\\n\\n```\\n{\\n \\\"name\\\": ...,\\n \\\"type\\\": ...,\\n \\\"dataFormat\\\": ...,\\n \\\"mapping\\\": ...,\\n \\\"formatHint\\\": ...,\\n \\\"hidden\\\": ...,\\n \\\"comment\\\": ...\\n}\\n```\\n\\n| Field | Required | Type | Description |\\n| ------------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |\\n| `name` | required | string | Name of the column in the Trino table. |\\n| `type` | required | string | Trino type of the column. |\\n| `dataFormat` | optional | string | Selects the column decoder for this field. Defaults to the default decoder for this row data format and column type. |\\n| `dataSchema` | optional | string | The path or URL where the Avro schema resides. Used only for Avro decoder. |\\n| `mapping` | optional | string | Mapping information for the column. This is decoder specific, see below. |\\n| `formatHint` | optional | string | Sets a column-specific format hint to the column decoder. |\\n| `hidden` | optional | boolean | Hides the column from `DESCRIBE <table name>` and `SELECT *`. Defaults to `false`. |\\n| `comment` | optional | string | Adds a column comment, which is shown with `DESCRIBE <table name>`. |\\n\\nThere is no limit on field descriptions for either key or message.\\n\\n(confluent-table-description-supplier)=\"}, \"Confluent table description supplier\": {\"Confluent subject to table name mapping\": \"The [subject naming strategy](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#sr-schemas-subject-name-strategy)\\ndetermines how a subject is resolved from the table name.\\n\\nThe default strategy is the `TopicNameStrategy`, where the key subject is\\ndefined as `<topic-name>-key` and the value subject is defined as\\n`<topic-name>-value`. If other strategies are used there is no way to\\ndetermine the subject name beforehand, so it must be specified manually in the\\ntable name.\\n\\nTo manually specify the key and value subjects, append to the topic name,\\nfor example: `<topic name>&key-subject=<key subject>&value-subject=<value\\nsubject>`. Both the `key-subject` and `value-subject` parameters are\\noptional. If neither is specified, then the default `TopicNameStrategy` is\\nused to resolve the subject name via the topic name. Note that a \\ncase-insensitive match must be done, as identifiers cannot contain upper case\\ncharacters.\", \"Protobuf-specific type handling in Confluent table description supplier\": {\"oneof\": \"Protobuf schemas containing `oneof` fields are mapped to a `JSON` field in\\nTrino.\\n\\nFor example, given the following Protobuf schema:\\n\\n```\\nsyntax = \\\"proto3\\\";\\n\\nmessage schema {\\n oneof test_oneof_column {\\n string string_column = 1;\\n uint32 integer_column = 2;\\n uint64 long_column = 3;\\n double double_column = 4;\\n float float_column = 5;\\n bool boolean_column = 6;\\n }\\n}\\n```\\n\\nThe corresponding Trino row is a `JSON` field `test_oneof_column`\\ncontaining a JSON object with a single key. The value of the key matches\\nthe name of the `oneof` type that is present.\\n\\nIn the above example, if the Protobuf message has the\\n`test_oneof_column` containing `string_column` set to a value `Trino`\\nthen the corresponding Trino row includes a column named\\n`test_oneof_column` with the value `JSON '{\\\"string_column\\\": \\\"Trino\\\"}'`.\\n\\n(kafka-sql-inserts)=\"}}}, \"Kafka inserts\": \"The Kafka connector supports the use of {doc}`/sql/insert` statements to write\\ndata to a Kafka topic. Table column data is mapped to Kafka messages as defined\\nin the [table definition file](#table-definition-files). There are\\nfive supported data formats for key and message encoding:\\n\\n['[raw format](raw-encoder)', '[CSV format](csv-encoder)', '[JSON format](json-encoder)', '[Avro format](avro-encoder)', '[Protobuf format](kafka-protobuf-encoding)']\\n\\nThese data formats each have an encoder that maps column values into bytes to be\\nsent to a Kafka topic.\\n\\nTrino supports at-least-once delivery for Kafka producers. This means that\\nmessages are guaranteed to be sent to Kafka topics at least once. If a producer\\nacknowledgement times out, or if the producer receives an error, it might retry\\nsending the message. This could result in a duplicate message being sent to the\\nKafka topic.\\n\\nThe Kafka connector does not allow the user to define which partition will be\\nused as the target for a message. If a message includes a key, the producer will\\nuse a hash algorithm to choose the target partition for the message. The same\\nkey will always be assigned the same partition.\\n\\n(kafka-type-mapping)=\", \"Type mapping\": {\"Row encoding\": {\"Raw encoder\": \"The raw encoder formats the table columns as raw bytes using the mapping\\ninformation specified in the\\n[table definition file](#table-definition-files).\\n\\nThe following field attributes are supported:\\n\\n['`dataFormat` - Specifies the width of the column data type.', '`type` - Trino data type.', '`mapping` - start and optional end position of bytes to convert\\\\n(specified as `start` or `start:end`).']\\n\\nThe `dataFormat` attribute selects the number of bytes converted.\\nIf absent, `BYTE` is assumed. All values are signed.\\n\\nSupported values:\\n\\n['`BYTE` - one byte', '`SHORT` - two bytes (big-endian)', '`INT` - four bytes (big-endian)', '`LONG` - eight bytes (big-endian)', '`FLOAT` - four bytes (IEEE 754 format, big-endian)', '`DOUBLE` - eight bytes (IEEE 754 format, big-endian)']\\n\\nThe `type` attribute defines the Trino data type.\\n\\nDifferent values of `dataFormat` are supported, depending on the Trino data\\ntype:\\n\\n| Trino data type | `dataFormat` values |\\n| ------------------------ | ------------------------------ |\\n| `BIGINT` | `BYTE`, `SHORT`, `INT`, `LONG` |\\n| `INTEGER` | `BYTE`, `SHORT`, `INT` |\\n| `SMALLINT` | `BYTE`, `SHORT` |\\n| `TINYINT` | `BYTE` |\\n| `REAL` | `FLOAT` |\\n| `DOUBLE` | `FLOAT`, `DOUBLE` |\\n| `BOOLEAN` | `BYTE`, `SHORT`, `INT`, `LONG` |\\n| `VARCHAR` / `VARCHAR(x)` | `BYTE` |\\n\\nNo other types are supported.\\n\\nThe `mapping` attribute specifies the range of bytes in a key or\\nmessage used for encoding.\\n\\n:::{note}\\nBoth a start and end position must be defined for `VARCHAR` types.\\nOtherwise, there is no way to know how many bytes the message contains. The\\nraw format mapping information is static and cannot be dynamically changed\\nto fit the variable width of some Trino data types.\\n:::\\n\\nIf only a start position is given:\\n\\n['For fixed width types, the appropriate number of bytes are used for the\\\\nspecified `dataFormat` (see above).']\\n\\nIf both a start and end position are given, then:\\n\\n['For fixed width types, the size must be equal to number of bytes used by\\\\nspecified `dataFormat`.', 'All bytes between start (inclusive) and end (exclusive) are used.']\\n\\n:::{note}\\nAll mappings must include a start position for encoding to work.\\n:::\\n\\nThe encoding for numeric data types (`BIGINT`, `INTEGER`, `SMALLINT`,\\n`TINYINT`, `REAL`, `DOUBLE`) is straightforward. All numeric types use\\nbig-endian. Floating point types use IEEE 754 format.\\n\\nExample raw field definition in a [table definition file](#table-definition-files)\\nfor a Kafka message:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"example_table_name\\\",\\n \\\"schemaName\\\": \\\"example_schema_name\\\",\\n \\\"topicName\\\": \\\"example_topic_name\\\",\\n \\\"key\\\": { \\\"...\\\" },\\n \\\"message\\\": {\\n \\\"dataFormat\\\": \\\"raw\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"field1\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"dataFormat\\\": \\\"LONG\\\",\\n \\\"mapping\\\": \\\"0\\\"\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\": \\\"INTEGER\\\",\\n \\\"dataFormat\\\": \\\"INT\\\",\\n \\\"mapping\\\": \\\"8\\\"\\n },\\n {\\n \\\"name\\\": \\\"field3\\\",\\n \\\"type\\\": \\\"SMALLINT\\\",\\n \\\"dataFormat\\\": \\\"LONG\\\",\\n \\\"mapping\\\": \\\"12\\\"\\n },\\n {\\n \\\"name\\\": \\\"field4\\\",\\n \\\"type\\\": \\\"VARCHAR(6)\\\",\\n \\\"dataFormat\\\": \\\"BYTE\\\",\\n \\\"mapping\\\": \\\"20:26\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nColumns should be defined in the same order they are mapped. There can be no\\ngaps or overlaps between column mappings. The width of the column as defined by\\nthe column mapping must be equivalent to the width of the `dataFormat` for all\\ntypes except for variable width types.\\n\\nExample insert query for the above table definition:\\n\\n```\\nINSERT INTO example_raw_table (field1, field2, field3, field4)\\n VALUES (123456789, 123456, 1234, 'abcdef');\\n```\\n\\n:::{note}\\nThe raw encoder requires the field size to be known ahead of time, including\\nfor variable width data types like `VARCHAR`. It also disallows inserting\\nvalues that do not match the width defined in the table definition\\nfile. This is done to ensure correctness, as otherwise longer values are\\ntruncated, and shorter values are read back incorrectly due to an undefined\\npadding character.\\n:::\\n\\n(csv-encoder)=\", \"CSV encoder\": \"The CSV encoder formats the values for each row as a line of\\ncomma-separated-values (CSV) using UTF-8 encoding. The CSV line is formatted\\nwith a comma `,` as the column delimiter.\\n\\nThe `type` and `mapping` attributes must be defined for each field:\\n\\n['`type` - Trino data type', '`mapping` - The integer index of the column in the CSV line (the first\\\\ncolumn is 0, the second is 1, and so on)']\\n\\n`dataFormat` and `formatHint` are not supported and must be omitted.\\n\\nThe following Trino data types are supported by the CSV encoder:\\n\\n['`BIGINT`', '`INTEGER`', '`SMALLINT`', '`TINYINT`', '`DOUBLE`', '`REAL`', '`BOOLEAN`', '`VARCHAR` / `VARCHAR(x)`']\\n\\nNo other types are supported.\\n\\nColumn values are converted to strings before they are formatted as a CSV line.\\n\\nThe following is an example CSV field definition in a [table definition file](#table-definition-files) for a Kafka message:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"example_table_name\\\",\\n \\\"schemaName\\\": \\\"example_schema_name\\\",\\n \\\"topicName\\\": \\\"example_topic_name\\\",\\n \\\"key\\\": { \\\"...\\\" },\\n \\\"message\\\": {\\n \\\"dataFormat\\\": \\\"csv\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"field1\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"mapping\\\": \\\"0\\\"\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\": \\\"VARCHAR\\\",\\n \\\"mapping\\\": \\\"1\\\"\\n },\\n {\\n \\\"name\\\": \\\"field3\\\",\\n \\\"type\\\": \\\"BOOLEAN\\\",\\n \\\"mapping\\\": \\\"2\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nExample insert query for the above table definition:\\n\\n```\\nINSERT INTO example_csv_table (field1, field2, field3)\\n VALUES (123456789, 'example text', TRUE);\\n```\\n\\n(json-encoder)=\", \"JSON encoder\": \"The JSON encoder maps table columns to JSON fields defined in the\\n[table definition file](#table-definition-files) according to\\n{rfc}`4627`.\\n\\nFor fields, the following attributes are supported:\\n\\n['`type` - Trino data type of column.', '`mapping` - A slash-separated list of field names to select a field from the\\\\nJSON object.', '`dataFormat` - Name of formatter. Required for temporal types.', '`formatHint` - Pattern to format temporal data. Only use with\\\\n`custom-date-time` formatter.']\\n\\nThe following Trino data types are supported by the JSON encoder:\\n\\n['`BIGINT`', '`INTEGER`', '`SMALLINT`', '`TINYINT`', '`DOUBLE`', '`REAL`', '`BOOLEAN`', '`VARCHAR`', '`DATE`', '`TIME`', '`TIME WITH TIME ZONE`', '`TIMESTAMP`', '`TIMESTAMP WITH TIME ZONE`']\\n\\nNo other types are supported.\\n\\nThe following `dataFormats` are available for temporal data:\\n\\n['`iso8601`', '`rfc2822`', '`custom-date-time` - Formats temporal data according to\\\\n[Joda Time](https://www.joda.org/joda-time/key_format.html)\\\\npattern given by `formatHint` field.', '`milliseconds-since-epoch`', '`seconds-since-epoch`']\\n\\nAll temporal data in Kafka supports milliseconds precision.\\n\\nThe following table defines which temporal data types are supported by\\n`dataFormats`:\\n\\n| Trino data type | Decoding rules |\\n| -------------------------- | ------------------------------------------------------------------------------------------- |\\n| `DATE` | `custom-date-time`, `iso8601` |\\n| `TIME` | `custom-date-time`, `iso8601`, `milliseconds-since-epoch`, `seconds-since-epoch` |\\n| `TIME WITH TIME ZONE` | `custom-date-time`, `iso8601` |\\n| `TIMESTAMP` | `custom-date-time`, `iso8601`, `rfc2822`, `milliseconds-since-epoch`, `seconds-since-epoch` |\\n| `TIMESTAMP WITH TIME ZONE` | `custom-date-time`, `iso8601`, `rfc2822`, `milliseconds-since-epoch`, `seconds-since-epoch` |\\n\\nThe following is an example JSON field definition in a [table definition file](#table-definition-files) for a Kafka message:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"example_table_name\\\",\\n \\\"schemaName\\\": \\\"example_schema_name\\\",\\n \\\"topicName\\\": \\\"example_topic_name\\\",\\n \\\"key\\\": { \\\"...\\\" },\\n \\\"message\\\": {\\n \\\"dataFormat\\\": \\\"json\\\",\\n \\\"fields\\\": [\\n {\\n \\\"name\\\": \\\"field1\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"mapping\\\": \\\"field1\\\"\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\": \\\"VARCHAR\\\",\\n \\\"mapping\\\": \\\"field2\\\"\\n },\\n {\\n \\\"name\\\": \\\"field3\\\",\\n \\\"type\\\": \\\"TIMESTAMP\\\",\\n \\\"dataFormat\\\": \\\"custom-date-time\\\",\\n \\\"formatHint\\\": \\\"yyyy-dd-MM HH:mm:ss.SSS\\\",\\n \\\"mapping\\\": \\\"field3\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nThe following shows an example insert query for the preceding table definition:\\n\\n```\\nINSERT INTO example_json_table (field1, field2, field3)\\n VALUES (123456789, 'example text', TIMESTAMP '2020-07-15 01:02:03.456');\\n```\\n\\n(avro-encoder)=\", \"Avro encoder\": \"The Avro encoder serializes rows to Avro records as defined by the\\n[Avro schema](https://avro.apache.org/docs/current/).\\nTrino does not support schemaless Avro encoding.\\n\\n:::{note}\\nThe Avro schema is encoded with the table column values in each Kafka message.\\n:::\\n\\nThe `dataSchema` must be defined in the table definition file to use the Avro\\nencoder. It points to the location of the Avro schema file for the key or message.\\n\\nAvro schema files can be retrieved via HTTP or HTTPS from remote server with the\\nsyntax:\\n\\n`\\\"dataSchema\\\": \\\"http://example.org/schema/avro_data.avsc\\\"`\\n\\nLocal files need to be available on all Trino nodes and use an absolute path in\\nthe syntax, for example:\\n\\n`\\\"dataSchema\\\": \\\"/usr/local/schema/avro_data.avsc\\\"`\\n\\nThe following field attributes are supported:\\n\\n['`name` - Name of the column in the Trino table.', '`type` - Trino data type of column.', '`mapping` - A slash-separated list of field names to select a field from the\\\\nAvro schema. If the field specified in `mapping` does not exist\\\\nin the original Avro schema, then a write operation fails.']\\n\\nThe following table lists supported Trino data types, which can be used in `type`\\nfor the equivalent Avro field type.\\n\\n| Trino data type | Avro data type |\\n| ------------------------ | ----------------- |\\n| `BIGINT` | `INT`, `LONG` |\\n| `REAL` | `FLOAT` |\\n| `DOUBLE` | `FLOAT`, `DOUBLE` |\\n| `BOOLEAN` | `BOOLEAN` |\\n| `VARCHAR` / `VARCHAR(x)` | `STRING` |\\n\\nNo other types are supported.\\n\\nThe following example shows an Avro field definition in a [table definition\\nfile](#table-definition-files) for a Kafka message:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"example_table_name\\\",\\n \\\"schemaName\\\": \\\"example_schema_name\\\",\\n \\\"topicName\\\": \\\"example_topic_name\\\",\\n \\\"key\\\": { \\\"...\\\" },\\n \\\"message\\\":\\n {\\n \\\"dataFormat\\\": \\\"avro\\\",\\n \\\"dataSchema\\\": \\\"/avro_message_schema.avsc\\\",\\n \\\"fields\\\":\\n [\\n {\\n \\\"name\\\": \\\"field1\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"mapping\\\": \\\"field1\\\"\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\": \\\"VARCHAR\\\",\\n \\\"mapping\\\": \\\"field2\\\"\\n },\\n {\\n \\\"name\\\": \\\"field3\\\",\\n \\\"type\\\": \\\"BOOLEAN\\\",\\n \\\"mapping\\\": \\\"field3\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nIn the following example, an Avro schema definition for the preceding table\\ndefinition is shown:\\n\\n```\\n{\\n \\\"type\\\" : \\\"record\\\",\\n \\\"name\\\" : \\\"example_avro_message\\\",\\n \\\"namespace\\\" : \\\"io.trino.plugin.kafka\\\",\\n \\\"fields\\\" :\\n [\\n {\\n \\\"name\\\":\\\"field1\\\",\\n \\\"type\\\":[\\\"null\\\", \\\"long\\\"],\\n \\\"default\\\": null\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\":[\\\"null\\\", \\\"string\\\"],\\n \\\"default\\\": null\\n },\\n {\\n \\\"name\\\":\\\"field3\\\",\\n \\\"type\\\":[\\\"null\\\", \\\"boolean\\\"],\\n \\\"default\\\": null\\n }\\n ],\\n \\\"doc:\\\" : \\\"A basic avro schema\\\"\\n}\\n```\\n\\nThe following is an example insert query for the preceding table definition:\\n\\n['INSERT INTO example_avro_table (field1, field2, field3)', \\\": VALUES (123456789, 'example text', FALSE);\\\"]\\n\\n(kafka-protobuf-encoding)=\", \"Protobuf encoder\": \"The Protobuf encoder serializes rows to Protobuf DynamicMessages as defined by\\nthe [Protobuf schema](https://developers.google.com/protocol-buffers/docs/overview).\\n\\n:::{note}\\nThe Protobuf schema is encoded with the table column values in each Kafka message.\\n:::\\n\\nThe `dataSchema` must be defined in the table definition file to use the\\nProtobuf encoder. It points to the location of the `proto` file for the key\\nor message.\\n\\nProtobuf schema files can be retrieved via HTTP or HTTPS from a remote server\\nwith the syntax:\\n\\n`\\\"dataSchema\\\": \\\"http://example.org/schema/schema.proto\\\"`\\n\\nLocal files need to be available on all Trino nodes and use an absolute path in\\nthe syntax, for example:\\n\\n`\\\"dataSchema\\\": \\\"/usr/local/schema/schema.proto\\\"`\\n\\nThe following field attributes are supported:\\n\\n['`name` - Name of the column in the Trino table.', '`type` - Trino type of column.', '`mapping` - slash-separated list of field names to select a field from the\\\\nProtobuf schema. If the field specified in `mapping` does not exist in the\\\\noriginal Protobuf schema, then a write operation fails.']\\n\\nThe following table lists supported Trino data types, which can be used in `type`\\nfor the equivalent Protobuf field type.\\n\\n| Trino data type | Protobuf data type |\\n| ------------------------ | -------------------------------------------------- |\\n| `BOOLEAN` | `bool` |\\n| `INTEGER` | `int32`, `uint32`, `sint32`, `fixed32`, `sfixed32` |\\n| `BIGINT` | `int64`, `uint64`, `sint64`, `fixed64`, `sfixed64` |\\n| `DOUBLE` | `double` |\\n| `REAL` | `float` |\\n| `VARCHAR` / `VARCHAR(x)` | `string` |\\n| `VARBINARY` | `bytes` |\\n| `ROW` | `Message` |\\n| `ARRAY` | Protobuf type with `repeated` field |\\n| `MAP` | `Map` |\\n| `TIMESTAMP` | `Timestamp`, predefined in `timestamp.proto` |\\n\\nThe following example shows a Protobuf field definition in a [table definition\\nfile](#table-definition-files) for a Kafka message:\\n\\n```\\n{\\n \\\"tableName\\\": \\\"example_table_name\\\",\\n \\\"schemaName\\\": \\\"example_schema_name\\\",\\n \\\"topicName\\\": \\\"example_topic_name\\\",\\n \\\"key\\\": { \\\"...\\\" },\\n \\\"message\\\":\\n {\\n \\\"dataFormat\\\": \\\"protobuf\\\",\\n \\\"dataSchema\\\": \\\"/message_schema.proto\\\",\\n \\\"fields\\\":\\n [\\n {\\n \\\"name\\\": \\\"field1\\\",\\n \\\"type\\\": \\\"BIGINT\\\",\\n \\\"mapping\\\": \\\"field1\\\"\\n },\\n {\\n \\\"name\\\": \\\"field2\\\",\\n \\\"type\\\": \\\"VARCHAR\\\",\\n \\\"mapping\\\": \\\"field2\\\"\\n },\\n {\\n \\\"name\\\": \\\"field3\\\",\\n \\\"type\\\": \\\"BOOLEAN\\\",\\n \\\"mapping\\\": \\\"field3\\\"\\n }\\n ]\\n }\\n}\\n```\\n\\nIn the following example, a Protobuf schema definition for the preceding table\\ndefinition is shown:\\n\\n```\\nsyntax = \\\"proto3\\\";\\n\\nmessage schema {\\n uint64 field1 = 1 ;\\n string field2 = 2;\\n bool field3 = 3;\\n}\\n```\\n\\nThe following is an example insert query for the preceding table definition:\\n\\n```\\nINSERT INTO example_protobuf_table (field1, field2, field3)\\n VALUES (123456789, 'example text', FALSE);\\n```\\n\\n(kafka-row-decoding)=\"}, \"Row decoding\": {\"Raw decoder\": \"The raw decoder supports reading of raw byte-based values from Kafka message\\nor key, and converting it into Trino columns.\\n\\nFor fields, the following attributes are supported:\\n\\n['`dataFormat` - Selects the width of the data type converted.', '`type` - Trino data type. See table later min this document for list of\\\\nsupported data types.', '`mapping` - `<start>[:<end>]` - Start and end position of bytes to convert (optional).']\\n\\nThe `dataFormat` attribute selects the number of bytes converted.\\nIf absent, `BYTE` is assumed. All values are signed.\\n\\nSupported values are:\\n\\n['`BYTE` - one byte', '`SHORT` - two bytes (big-endian)', '`INT` - four bytes (big-endian)', '`LONG` - eight bytes (big-endian)', '`FLOAT` - four bytes (IEEE 754 format)', '`DOUBLE` - eight bytes (IEEE 754 format)']\\n\\nThe `type` attribute defines the Trino data type on which the value is mapped.\\n\\nDepending on the Trino type assigned to a column, different values of dataFormat can be used:\\n\\n| Trino data type | Allowed `dataFormat` values |\\n| ------------------------ | ------------------------------ |\\n| `BIGINT` | `BYTE`, `SHORT`, `INT`, `LONG` |\\n| `INTEGER` | `BYTE`, `SHORT`, `INT` |\\n| `SMALLINT` | `BYTE`, `SHORT` |\\n| `TINYINT` | `BYTE` |\\n| `DOUBLE` | `DOUBLE`, `FLOAT` |\\n| `BOOLEAN` | `BYTE`, `SHORT`, `INT`, `LONG` |\\n| `VARCHAR` / `VARCHAR(x)` | `BYTE` |\\n\\nNo other types are supported.\\n\\nThe `mapping` attribute specifies the range of the bytes in a key or\\nmessage used for decoding. It can be one or two numbers separated by a colon (`<start>[:<end>]`).\\n\\nIf only a start position is given:\\n\\n['For fixed width types, the column will use the appropriate number of bytes for the specified `dataFormat` (see above).', 'When `VARCHAR` value is decoded, all bytes from start position till the end of the message will be used.']\\n\\nIf start and end position are given:\\n\\n['For fixed width types, the size must be equal to number of bytes used by specified `dataFormat`.', 'For `VARCHAR` all bytes between start (inclusive) and end (exclusive) are used.']\\n\\nIf no `mapping` attribute is specified, it is equivalent to setting start position to 0 and leaving end position undefined.\\n\\nThe decoding scheme of numeric data types (`BIGINT`, `INTEGER`, `SMALLINT`, `TINYINT`, `DOUBLE`) is straightforward.\\nA sequence of bytes is read from input message and decoded according to either:\\n\\n['big-endian encoding (for integer types)', 'IEEE 754 format for (for `DOUBLE`).']\\n\\nLength of decoded byte sequence is implied by the `dataFormat`.\\n\\nFor `VARCHAR` data type a sequence of bytes is interpreted according to UTF-8\\nencoding.\", \"CSV decoder\": \"The CSV decoder converts the bytes representing a message or key into a\\nstring using UTF-8 encoding and then interprets the result as a CSV\\n(comma-separated value) line.\\n\\nFor fields, the `type` and `mapping` attributes must be defined:\\n\\n['`type` - Trino data type. See the following table for a list of supported data types.', '`mapping` - The index of the field in the CSV record.']\\n\\nThe `dataFormat` and `formatHint` attributes are not supported and must be omitted.\\n\\nTable below lists supported Trino types, which can be used in `type` and decoding scheme:\\n\\n:::{list-table}\\n:header-rows: 1\\n\\n[['Trino data type', 'Decoding rules'], ['`BIGINT`, `INTEGER`, `SMALLINT`, `TINYINT`', 'Decoded using Java `Long.parseLong()`'], ['`DOUBLE`', 'Decoded using Java `Double.parseDouble()`'], ['`BOOLEAN`', '\\\"true\\\" character sequence maps to `true`; Other character sequences map to `false`'], ['`VARCHAR`, `VARCHAR(x)`', 'Used as is\\\\n:::']]\\n\\nNo other types are supported.\", \"JSON decoder\": {\"Default field decoder\": \"This is the standard field decoder, supporting all the Trino physical data\\ntypes. A field value is transformed under JSON conversion rules into\\nboolean, long, double or string values. For non-date/time based columns,\\nthis decoder should be used.\", \"Date and time decoders\": \"To convert values from JSON objects into Trino `DATE`, `TIME`, `TIME WITH TIME ZONE`,\\n`TIMESTAMP` or `TIMESTAMP WITH TIME ZONE` columns, special decoders must be selected using the\\n`dataFormat` attribute of a field definition.\\n\\n['`iso8601` - Text based, parses a text field as an ISO 8601 timestamp.', '`rfc2822` - Text based, parses a text field as an {rfc}`2822` timestamp.', '`custom-date-time` - Text based, parses a text field according to Joda format pattern\\\\n: specified via `formatHint` attribute. Format pattern should conform\\\\nto <https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html>.', '`milliseconds-since-epoch` - Number-based; interprets a text or number as number of milliseconds since the epoch.', '`seconds-since-epoch` - Number-based; interprets a text or number as number of milliseconds since the epoch.']\\n\\nFor `TIMESTAMP WITH TIME ZONE` and `TIME WITH TIME ZONE` data types, if timezone information is present in decoded value, it will\\nbe used as Trino value. Otherwise result time zone will be set to `UTC`.\"}, \"Avro decoder\": {\"Avro schema evolution\": \"The Avro decoder supports schema evolution feature with backward compatibility. With backward compatibility,\\na newer schema can be used to read Avro data created with an older schema. Any change in the Avro schema must also be\\nreflected in Trino's topic definition file. Newly added/renamed fields *must* have a default value in the Avro schema file.\\n\\nThe schema evolution behavior is as follows:\\n\\n['Column added in new schema:\\\\nData created with an older schema produces a *default* value when the table is using the new schema.', 'Column removed in new schema:\\\\nData created with an older schema no longer outputs the data from the column that was removed.', 'Column is renamed in the new schema:\\\\nThis is equivalent to removing the column and adding a new one, and data created with an older schema\\\\nproduces a *default* value when table is using the new schema.', 'Changing type of column in the new schema:\\\\nIf the type coercion is supported by Avro, then the conversion happens. An\\\\nerror is thrown for incompatible types.']\\n\\n(kafka-protobuf-decoding)=\"}, \"Protobuf decoder\": {\"any\": \"Message types with an [Any](https://protobuf.dev/programming-guides/proto3/#any)\\nfield contain an arbitrary serialized message as bytes and a type URL to resolve\\nthat message's type with a scheme of `file://`, `http://`, or `https://`.\\nThe connector reads the contents of the URL to create the type descriptor\\nfor the `Any` message and convert the message to JSON. This behavior is enabled\\nby setting `kafka.protobuf-any-support-enabled` to `true`.\\n\\nThe descriptors for each distinct URL are cached for performance reasons and\\nany modifications made to the type returned by the URL requires a restart of\\nTrino.\\n\\nFor example, given the following Protobuf schema which defines `MyMessage`\\nwith three columns:\\n\\n```\\nsyntax = \\\"proto3\\\";\\n\\nmessage MyMessage {\\n string stringColumn = 1;\\n uint32 integerColumn = 2;\\n uint64 longColumn = 3;\\n}\\n```\\n\\nAnd a separate schema which uses an `Any` type which is a packed message\\nof the above type and a valid URL:\\n\\n```\\nsyntax = \\\"proto3\\\";\\n\\nimport \\\"google/protobuf/any.proto\\\";\\n\\nmessage schema {\\n google.protobuf.Any any_message = 1;\\n}\\n```\\n\\nThe corresponding Trino column is named `any_message` of type `JSON`\\ncontaining a JSON-serialized representation of the Protobuf message:\\n\\n```\\n{\\n \\\"@type\\\":\\\"file:///path/to/schemas/MyMessage\\\",\\n \\\"longColumn\\\":\\\"493857959588286460\\\",\\n \\\"numberColumn\\\":\\\"ONE\\\",\\n \\\"stringColumn\\\":\\\"Trino\\\"\\n}\\n```\", \"Protobuf schema evolution\": \"The Protobuf decoder supports the schema evolution feature with backward\\ncompatibility. With backward compatibility, a newer schema can be used to read\\nProtobuf data created with an older schema. Any change in the Protobuf schema\\n*must* also be reflected in the topic definition file.\\n\\nThe schema evolution behavior is as follows:\\n\\n['Column added in new schema:\\\\nData created with an older schema produces a *default* value when the table is using the new schema.', 'Column removed in new schema:\\\\nData created with an older schema no longer outputs the data from the column that was removed.', 'Column is renamed in the new schema:\\\\nThis is equivalent to removing the column and adding a new one, and data created with an older schema\\\\nproduces a *default* value when table is using the new schema.', 'Changing type of column in the new schema:\\\\nIf the type coercion is supported by Protobuf, then the conversion happens. An error is thrown for incompatible types.']\", \"Protobuf limitations\": [\"Protobuf Timestamp has a nanosecond precision but Trino supports\\ndecoding/encoding at microsecond precision.\"]}}}, \"SQL support\": \"The connector provides read and write access to data and metadata in Trino\\ntables populated by Kafka topics. See {ref}`kafka-row-decoding` for more\\ninformation.\\n\\nIn addition to the {ref}`globally available <sql-globally-available>`\\nand {ref}`read operation <sql-read-operations>` statements, the connector\\nsupports the following features:\\n\\n['{doc}`/sql/insert`, encoded to a specified data format. See also\\\\n{ref}`kafka-sql-inserts`.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 17]\"}, {\"title\": \"Lakehouse connector\", \"description\": null, \"content\": {\"General configuration\": \"To configure the Lakehouse connector, create a catalog properties file\\n`etc/catalog/example.properties` with the following content, replacing the\\nproperties as appropriate:\\n\\n```\\nconnector.name=lakehouse\\n```\\n\\nYou must configure a [AWS Glue or a Hive metastore](/object-storage/metastores).\\nThe `hive.metastore` property will also configure the Iceberg catalog.\\nDo not specify `iceberg.catalog.type`.\\n\\nYou must select and configure one of the\\n[supported file systems](lakehouse-file-system-configuration).\", \"Configuration properties\": \"The following configuration properties are available:\\n\\n:::{list-table}\\n:widths: 30, 58, 12\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`lakehouse.table-type`', 'The default table type for newly created tables when the `format`\\\\ntable property is not specified. Possible values:', ['`HIVE`', '`ICEBERG`', '`DELTA`'], '`ICEBERG`\\\\n:::']]\\n\\n(lakehouse-file-system-configuration)=\", \"File system access configuration\": \"The connector supports accessing the following file systems:\\n\\n['[](/object-storage/file-system-azure)', '[](/object-storage/file-system-gcs)', '[](/object-storage/file-system-s3)', '[](/object-storage/file-system-hdfs)']\\n\\nYou must enable and configure the specific file system access. \", \"Examples\": \"Create an Iceberg table:\\n\\n```\\nCREATE TABLE iceberg_table (\\n c1 INTEGER,\\n c2 DATE,\\n c3 DOUBLE\\n)\\nWITH (\\n type = 'ICEBERG'\\n format = 'PARQUET',\\n partitioning = ARRAY['c1', 'c2'],\\n sorted_by = ARRAY['c3']\\n);\\n```\\n\\nCreate a Hive table:\\n\\n```\\nCREATE TABLE hive_page_views (\\n view_time TIMESTAMP,\\n user_id BIGINT,\\n page_url VARCHAR,\\n ds DATE,\\n country VARCHAR\\n)\\nWITH (\\n type = 'HIVE',\\n format = 'ORC',\\n partitioned_by = ARRAY['ds', 'country'],\\n bucketed_by = ARRAY['user_id'],\\n bucket_count = 50\\n)\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 18]\"}, {\"title\": \"Loki connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Loki, you need:\\n\\n['Loki 3.2.0 or higher.', 'Network access from the Trino coordinator and workers to Loki. Port 3100 is\\\\nthe default port.']\", \"Configuration\": \"The connector can query log data in Loki. Create a catalog properties file that\\nspecifies the Loki connector by setting the `connector.name` to `loki`.\\n\\nFor example, to access a database as the `example` catalog, create the file\\n`etc/catalog/example.properties`.\\n\\n```\\nconnector.name=loki\\nloki.uri=http://loki.example.com:3100\\n```\\n\\nThe following table contains a list of all available configuration properties.\\n\\n:::{list-table} Loki configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`loki.uri`', 'The URI endpoint for the Loki server that Trino cluster nodes use to access\\\\nthe Loki APIs.'], ['`loki.query-timeout`', '[Duration](prop-type-duration) that Trino waits for a result from Loki\\\\nbefore the specific query request times out. Defaults to `10s`. A minimum of\\\\n`1s` is required.\\\\n:::']]\\n\\n(loki-type-mapping)=\", \"Type mapping\": {\"Loki to Trino type mapping\": \"Each log line in Loki is split up by the connector into three columns:\\n\\n['`timestamp`', '`values`', '`labels`']\\n\\nThese are separately mapped to Trino types:\\n\\n:::{list-table} Loki log entry to Trino type mapping\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Loki type', 'Trino type'], ['`timestamp`', '`TIMESTAMP WITH TIME ZONE`'], ['`values` for [log queries](https://grafana.com/docs/loki/latest/query/log_queries/)', '`VARCHAR`'], ['`values` for [metrics queries](https://grafana.com/docs/loki/latest/query/metric_queries/)', '`DOUBLE`'], ['`labels`', '`MAP` with label names and values as `VARCHAR` key value pairs\\\\n:::']]\\n\\nNo other types are supported.\\n\\n(loki-sql-support)=\"}, \"SQL support\": {\"Table functions\": \"The connector provides the following [table function](/functions/table) to\\naccess Loki.\\n\\n(loki-query-range)=\", \"`query_range(varchar, timestamp, timestamp) -> table`\": \"The `query_range` function allows you to query the log data in Loki with the\\nfollowing parameters:\\n\\n['The first parameter is a `varchar` string that uses valid\\\\n[LogQL](https://grafana.com/docs/loki/latest/query/) query.', 'The second parameter is a `timestamp` formatted data and time representing the\\\\nstart date and time of the log data range to query.', 'The third parameter is a `timestamp` formatted data and time representing the\\\\nend date and time of the log data range to query.']\\n\\nThe table function is available in the `system` schema of the catalog using the\\nLoki connector, and returns a table with the columns `timestamp`, `value`, and\\n`labels` described in the [](loki-type-mapping) section.\\n\\nThe following query invokes the `query_range` table function in the `example`\\ncatalog. It uses the LogQL query string `{origin=\\\"CA\\\"}` to retrieve all log data\\nwith the value `CA` for the `origin` label on the log entries. The timestamp\\nparameters set a range of all log entries from the first of January 2025. \\n\\n```\\nSELECT timestamp, value \\nFROM\\n TABLE(\\n example.system.query_range(\\n '{origin=\\\"CA\\\"}',\\n TIMESTAMP '2025-01-01 00:00:00',\\n TIMESTAMP '2025-01-02 00:00:00'\\n )\\n )\\n;\\n```\\n\\nThe query only returns the timestamp and value for each log entry, and omits the\\nlabel data in the `labels` column. The value is a `varchar` string since the\\nLoqQL query is a log query.\"}, \"Examples\": \"The following examples showcase combinations of\\n[LogQL](https://grafana.com/docs/loki/latest/query/) queries passed through the\\ntable function with SQL accessing the data in the returned table. \\n\\nThe following query uses a metrics query and therefore returns a `count` column\\nwith double values, limiting the result data to the latest 100 values.\\n\\n```\\nSELECT value AS count\\nFROM\\n TABLE(\\n example.system.query_range(\\n 'count_over_time({test=\\\"metrics_query\\\"}[5m])',\\n TIMESTAMP '2025-01-01 00:00:00',\\n TIMESTAMP '2025-01-02 00:00:00'\\n )\\n )\\nORDER BY timestamp DESC\\nLIMIT 100;\\n```\\n\\nThe following query accesses the value of the label named `province` and returns\\nit as separate column.\\n\\n```\\nSELECT \\n timestamp, \\n value, \\n labels['province'] AS province\\nFROM\\n TABLE(\\n example.system.query_range(\\n '{origin=\\\"CA\\\"}',\\n TIMESTAMP '2025-01-01 00:00:00',\\n TIMESTAMP '2025-01-02 00:00:00'\\n )\\n )\\n;\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 19]\"}, {\"title\": \"MariaDB connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to MariaDB, you need:\\n\\n['MariaDB version 10.10 or higher.', 'Network access from the Trino coordinator and workers to MariaDB. Port\\\\n3306 is the default port.']\", \"Configuration\": {\"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\"}, \"Querying MariaDB\": \"The MariaDB connector provides a schema for every MariaDB *database*.\\nYou can see the available MariaDB databases by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a MariaDB database named `web`, you can view the tables\\nin this database by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web`\\ndatabase using either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can access the `clicks` table in the `web` database:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n\\n% mariadb-type-mapping:\", \"Type mapping\": {\"MariaDB type to Trino type mapping\": \"The connector maps MariaDB types to the corresponding Trino types according\\nto the following table:\\n\\n:::{list-table} MariaDB type to Trino type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['MariaDB type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`TINYINT`', '`BOOL` and `BOOLEAN` are aliases of `TINYINT(1)`'], ['`TINYINT`', '`TINYINT`'], ['`TINYINT UNSIGNED`', '`SMALLINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`SMALLINT UNSIGNED`', '`INTEGER`'], ['`INT`', '`INTEGER`'], ['`INT UNSIGNED`', '`BIGINT`'], ['`BIGINT`', '`BIGINT`'], ['`BIGINT UNSIGNED`', '`DECIMAL(20, 0)`'], ['`FLOAT`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`CHAR(n)`', '`CHAR(n)`'], ['`TINYTEXT`', '`VARCHAR(255)`'], ['`TEXT`', '`VARCHAR(65535)`'], ['`MEDIUMTEXT`', '`VARCHAR(16777215)`'], ['`LONGTEXT`', '`VARCHAR`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`TINYBLOB`', '`VARBINARY`'], ['`BLOB`', '`VARBINARY`'], ['`MEDIUMBLOB`', '`VARBINARY`'], ['`LONGBLOB`', '`VARBINARY`'], ['`VARBINARY(n)`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`TIMESTAMP(n)`', '`TIMESTAMP(n)`', 'MariaDB stores the current timestamp by default. Enable\\\\n[explicit_defaults_for_timestamp](https://mariadb.com/docs/reference/mdb/system-variables/explicit_defaults_for_timestamp/)\\\\nto avoid implicit default values and use `NULL` as the default value.'], ['`DATETIME(n)`', '`TIMESTAMP(n)`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type mapping to MariaDB type mapping\": \"The connector maps Trino types to the corresponding MariaDB types according\\nto the following table:\\n\\n:::{list-table} Trino type mapping to MariaDB type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Trino type', 'MariaDB type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INT`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`FLOAT`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p,s)`', '`DECIMAL(p,s)`'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(255)`', '`TINYTEXT`', 'Maps on `VARCHAR` of length 255 or less.'], ['`VARCHAR(65535)`', '`TEXT`', 'Maps on `VARCHAR` of length between 256 and 65535, inclusive.'], ['`VARCHAR(16777215)`', '`MEDIUMTEXT`', 'Maps on `VARCHAR` of length between 65536 and 16777215, inclusive.'], ['`VARCHAR`', '`LONGTEXT`', '`VARCHAR` of length greater than 16777215 and unbounded `VARCHAR` map\\\\nto `LONGTEXT`.'], ['`VARBINARY`', '`MEDIUMBLOB`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`TIMESTAMP(n)`', '`TIMESTAMP(n)`', 'MariaDB stores the current timestamp by default. Enable\\\\n`explicit_defaults_for_timestamp\\\\n<https://mariadb.com/docs/reference/mdb/system-variables/explicit_defaults_for_timestamp/>`_\\\\nto avoid implicit default values and use `NULL` as the default value.']]\\n\\n:::\\n\\nNo other types are supported.\\n\\nComplete list of [MariaDB data types](https://mariadb.com/kb/en/data-types/).\\n\\n```\\n```\\n\\n(mariadb-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(mariadb-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to MariaDB, because the full query is pushed down and\\nprocessed in MariaDB. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nAs an example, query the `example` catalog and select the age of employees by\\nusing `TIMESTAMPDIFF` and `CURDATE`:\\n\\n```\\nSELECT\\n age\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n TIMESTAMPDIFF(\\n YEAR,\\n date_of_birth,\\n CURDATE()\\n ) AS age\\n FROM\\n tiny.employees'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Table statistics\": \"The MariaDB connector can use [table and column\\nstatistics](/optimizer/statistics) for [cost based\\noptimizations](/optimizer/cost-based-optimizations) to improve query processing\\nperformance based on the actual data in the data source.\\n\\nThe statistics are collected by MariaDB and retrieved by the connector.\\n\\nTo collect statistics for a table, execute the following statement in\\nMariaDB.\\n\\n```\\nANALYZE TABLE table_name;\\n```\\n\\nRefer to [MariaDB documentation](https://mariadb.com/kb/en/analyze-table/) for\\nadditional information.\\n\\n(mariadb-pushdown)=\", \"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`join-pushdown`', '{ref}`limit-pushdown`', '{ref}`topn-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`', '{func}`stddev`', '{func}`stddev_pop`', '{func}`stddev_samp`', '{func}`variance`', '{func}`var_pop`', '{func}`var_samp`']\\n\\n```\\n```\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 20]\"}, {\"title\": \"Memory connector\", \"description\": null, \"content\": {\"Configuration\": \"To configure the Memory connector, create a catalog properties file\\n`etc/catalog/example.properties` with the following contents:\\n\\n```\\nconnector.name=memory\\nmemory.max-data-per-node=128MB\\n```\\n\\n`memory.max-data-per-node` defines memory limit for pages stored in this\\nconnector per each node (default value is 128MB).\", \"Examples\": \"Create a table using the Memory connector:\\n\\n```\\nCREATE TABLE example.default.nation AS\\nSELECT * from tpch.tiny.nation;\\n```\\n\\nInsert data into a table in the Memory connector:\\n\\n```\\nINSERT INTO example.default.nation\\nSELECT * FROM tpch.tiny.nation;\\n```\\n\\nSelect from the Memory connector:\\n\\n```\\nSELECT * FROM example.default.nation;\\n```\\n\\nDrop table:\\n\\n```\\nDROP TABLE example.default.nation;\\n```\\n\\n(memory-type-mapping)=\", \"Type mapping\": \"Trino supports all data types used within the Memory schemas so no mapping is\\nrequired.\\n\\n(memory-sql-support)=\", \"SQL support\": {\"TRUNCATE and DROP TABLE\": \"Upon execution of a `TRUNCATE` and a `DROP TABLE` operation, memory is not released\\nimmediately. It is instead released after the next write operation to the\\ncatalog.\\n\\n(memory-dynamic-filtering)=\"}, \"Dynamic filtering\": {\"Delayed execution for dynamic filters\": \"For the Memory connector, a table scan is delayed until the collection of dynamic filters.\\nThis can be disabled by using the configuration property `memory.enable-lazy-dynamic-filtering`\\nin the catalog file.\"}, \"Limitations\": [\"When one worker fails/restarts, all data that was stored in its\\nmemory is lost. To prevent silent data loss the\\nconnector throws an error on any read access to such\\ncorrupted table.\", \"When a query fails for any reason during writing to memory table,\\nthe table enters an undefined state. The table should be dropped\\nand recreated manually. Reading attempts from the table may fail,\\nor may return partial data.\", \"When the coordinator fails/restarts, all metadata about tables is\\nlost. The tables remain on the workers, but become inaccessible.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 21]\"}, {\"title\": \"MongoDB connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to MongoDB, you need:\\n\\n['MongoDB 4.2 or higher.', 'Network access from the Trino coordinator and workers to MongoDB.\\\\nPort 27017 is the default port.', 'Write access to the {ref}`schema information collection <table-definition-label>`\\\\nin MongoDB.']\", \"Configuration\": {\"Multiple MongoDB clusters\": \"You can have as many catalogs as you need, so if you have additional\\nMongoDB clusters, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`). For\\nexample, if you name the property file `sales.properties`, Trino\\nwill create a catalog named `sales` using the configured connector.\"}, \"Configuration properties\": {\"`mongodb.connection-url`\": \"A connection string containing the protocol, credential, and host info for use\\nin connecting to your MongoDB deployment.\\n\\nFor example, the connection string may use the format\\n`mongodb://<user>:<pass>@<host>:<port>/?<options>` or\\n`mongodb+srv://<user>:<pass>@<host>/?<options>`, depending on the protocol\\nused. The user/pass credentials must be for a user with write access to the\\n{ref}`schema information collection <table-definition-label>`.\\n\\nSee the [MongoDB Connection URI](https://docs.mongodb.com/drivers/java/sync/current/fundamentals/connection/#connection-uri) for more information.\\n\\nThis property is required; there is no default. A connection URL must be\\nprovided to connect to a MongoDB deployment.\", \"`mongodb.schema-collection`\": \"As MongoDB is a document database, there is no fixed schema information in the system. So a special collection in each MongoDB database should define the schema of all tables. Please refer the {ref}`table-definition-label` section for the details.\\n\\nAt startup, the connector tries to guess the data type of fields based on the {ref}`type mapping <mongodb-type-mapping>`.\\n\\nThe initial guess can be incorrect for your specific collection. In that case, you need to modify it manually. Please refer the {ref}`table-definition-label` section for the details.\\n\\nCreating new tables using `CREATE TABLE` and `CREATE TABLE AS SELECT` automatically create an entry for you.\\n\\nThis property is optional; the default is `_schema`.\", \"`mongodb.case-insensitive-name-matching`\": \"Match database and collection names case insensitively.\\n\\nThis property is optional; the default is `false`.\", \"`mongodb.min-connections-per-host`\": \"The minimum number of connections per host for this MongoClient instance. Those connections are kept in a pool when idle, and the pool ensures over time that it contains at least this minimum number.\\n\\nThis property is optional; the default is `0`.\", \"`mongodb.connections-per-host`\": \"The maximum number of connections allowed per host for this MongoClient instance. Those connections are kept in a pool when idle. Once the pool is exhausted, any operation requiring a connection blocks waiting for an available connection.\\n\\nThis property is optional; the default is `100`.\", \"`mongodb.max-wait-time`\": \"The maximum wait time in milliseconds, that a thread may wait for a connection to become available.\\nA value of `0` means that it does not wait. A negative value means to wait indefinitely for a connection to become available.\\n\\nThis property is optional; the default is `120000`.\", \"`mongodb.max-connection-idle-time`\": \"The maximum idle time of a pooled connection in milliseconds. A value of `0` indicates no limit to the idle time.\\nA pooled connection that has exceeded its idle time will be closed and replaced when necessary by a new connection.\\n\\nThis property is optional; the default is `0`.\", \"`mongodb.connection-timeout`\": \"The connection timeout in milliseconds. A value of `0` means no timeout. It is used solely when establishing a new connection.\\n\\nThis property is optional; the default is `10000`.\", \"`mongodb.socket-timeout`\": \"The socket timeout in milliseconds. It is used for I/O socket read and write operations.\\n\\nThis property is optional; the default is `0` and means no timeout.\", \"`mongodb.tls.enabled`\": \"This flag enables TLS connections to MongoDB servers.\\n\\nThis property is optional; the default is `false`.\", \"`mongodb.tls.keystore-path`\": \"The path to the {doc}`PEM </security/inspect-pem>` or\\n{doc}`JKS </security/inspect-jks>` key store.\\n\\nThis property is optional.\", \"`mongodb.tls.truststore-path`\": \"The path to {doc}`PEM </security/inspect-pem>` or\\n{doc}`JKS </security/inspect-jks>` trust store.\\n\\nThis property is optional.\", \"`mongodb.tls.keystore-password`\": \"The key password for the key store specified by `mongodb.tls.keystore-path`.\\n\\nThis property is optional.\", \"`mongodb.tls.truststore-password`\": \"The key password for the trust store specified by `mongodb.tls.truststore-path`.\\n\\nThis property is optional.\", \"`mongodb.read-preference`\": \"The read preference to use for queries, map-reduce, aggregation, and count.\\nThe available values are `PRIMARY`, `PRIMARY_PREFERRED`, `SECONDARY`, `SECONDARY_PREFERRED` and `NEAREST`.\\n\\nThis property is optional; the default is `PRIMARY`.\", \"`mongodb.write-concern`\": \"The write concern to use. The available values are\\n`ACKNOWLEDGED`, `JOURNALED`, `MAJORITY` and `UNACKNOWLEDGED`.\\n\\nThis property is optional; the default is `ACKNOWLEDGED`.\", \"`mongodb.required-replica-set`\": \"The required replica set name. With this option set, the MongoClient instance performs the following actions:\\n\\n```\\n#. Connect in replica set mode, and discover all members of the set based on the given servers\\n#. Make sure that the set name reported by all members matches the required set name.\\n#. Refuse to service any requests, if authenticated user is not part of a replica set with the required name.\\n```\\n\\nThis property is optional; no default value.\", \"`mongodb.cursor-batch-size`\": \"Limits the number of elements returned in one batch. A cursor typically fetches a batch of result objects and stores them locally.\\nIf batchSize is 0, Driver's default are used.\\nIf batchSize is positive, it represents the size of each batch of objects retrieved. It can be adjusted to optimize performance and limit data transfer.\\nIf batchSize is negative, it limits the number of objects returned, that fit within the max batch size limit (usually 4MB), and the cursor is closed. For example if batchSize is -10, then the server returns a maximum of 10 documents, and as many as can fit in 4MB, then closes the cursor.\\n\\n:::{note}\\nDo not use a batch size of `1`.\\n:::\\n\\nThis property is optional; the default is `0`.\", \"`mongodb.allow-local-scheduling`\": \"Set the value of this property to `true` if Trino and MongoDB share the same\\ncluster, and specific MongoDB splits should be processed on the same worker and\\nMongoDB node. Note that a shared deployment is not recommended, and enabling\\nthis property can lead to resource contention.\\n\\nThis property is optional, and defaults to false.\", \"`mongodb.dynamic-filtering.wait-timeout`\": \"Duration to wait for completion of dynamic filters during split generation.\\n\\nThis property is optional; the default is `5s`.\\n\\n(table-definition-label)=\"}, \"Table definition\": \"MongoDB maintains table definitions on the special collection where `mongodb.schema-collection` configuration value specifies.\\n\\n:::{note}\\nThe plugin cannot detect that a collection has been deleted. You must\\ndelete the entry by executing `db.getCollection(\\\"_schema\\\").remove( { table:\\ndeleted_table_name })` in the MongoDB Shell. You can also drop a collection in\\nTrino by running `DROP TABLE table_name`.\\n:::\\n\\nA schema collection consists of a MongoDB document for a table.\\n\\n```\\n{\\n \\\"table\\\": ...,\\n \\\"fields\\\": [\\n { \\\"name\\\" : ...,\\n \\\"type\\\" : \\\"varchar|bigint|boolean|double|date|array(bigint)|...\\\",\\n \\\"hidden\\\" : false },\\n ...\\n ]\\n }\\n}\\n```\\n\\nThe connector quotes the fields for a row type when auto-generating the schema;\\nhowever, the auto-generated schema must be corrected manually in the collection\\nto match the information in the tables.\\n\\nManually altered fields must be explicitly quoted, for example, `row(\\\"UpperCase\\\"\\nvarchar)`.\\n\\n| Field | Required | Type | Description |\\n| -------- | -------- | ------ | ------------------------------------------------------------------------------------------- |\\n| `table` | required | string | Trino table name |\\n| `fields` | required | array | A list of field definitions. Each field definition creates a new column in the Trino table. |\\n\\nEach field definition:\\n\\n```\\n{\\n \\\"name\\\": ...,\\n \\\"type\\\": ...,\\n \\\"hidden\\\": ...\\n}\\n```\\n\\n| Field | Required | Type | Description |\\n| -------- | -------- | ------- | ---------------------------------------------------------------------------------- |\\n| `name` | required | string | Name of the column in the Trino table. |\\n| `type` | required | string | Trino type of the column. |\\n| `hidden` | optional | boolean | Hides the column from `DESCRIBE <table name>` and `SELECT *`. Defaults to `false`. |\\n\\nThere is no limit on field descriptions for either key or message.\", \"ObjectId\": {\"ObjectId timestamp functions\": \"The first four bytes of each [ObjectId](https://docs.mongodb.com/manual/reference/method/ObjectId) represent\\nan embedded timestamp of its creation time. Trino provides a couple of functions to take advantage of this MongoDB feature.\\n\\n:::{function} objectid_timestamp(ObjectId) -> timestamp\\nExtracts the TIMESTAMP WITH TIME ZONE from a given ObjectId:\\n\\n```\\nSELECT objectid_timestamp(ObjectId('507f191e810c19729de860ea'));\\n-- 2012-10-17 20:46:22.000 UTC\\n```\\n\\n:::\\n\\n:::{function} timestamp_objectid(timestamp) -> ObjectId\\nCreates an ObjectId from a TIMESTAMP WITH TIME ZONE:\\n\\n```\\nSELECT timestamp_objectid(TIMESTAMP '2021-08-07 17:51:36 +00:00');\\n-- 61 0e c8 28 00 00 00 00 00 00 00 00\\n```\\n\\n:::\\n\\nIn MongoDB, you can filter all the documents created after `2021-08-07 17:51:36`\\nwith a query like this:\\n\\n```\\ndb.collection.find({\\\"_id\\\": {\\\"$gt\\\": ObjectId(\\\"610ec8280000000000000000\\\")}})\\n```\\n\\nIn Trino, the same can be achieved with this query:\\n\\n```\\nSELECT *\\nFROM collection\\nWHERE _id > timestamp_objectid(TIMESTAMP '2021-08-07 17:51:36 +00:00');\\n```\\n\\n(mongodb-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\\n\\n(mongodb-type-mapping)=\"}, \"Type mapping\": {\"MongoDB to Trino type mapping\": \"The connector maps MongoDB types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} MongoDB to Trino type mapping\\n:widths: 30, 20, 50\\n:header-rows: 1\\n\\n[['MongoDB type', 'Trino type', 'Notes'], ['`Boolean`', '`BOOLEAN`'], ['`Int32`', '`BIGINT`'], ['`Int64`', '`BIGINT`'], ['`Double`', '`DOUBLE`'], ['`Decimal128`', '`DECIMAL(p, s)`'], ['`Date`', '`TIMESTAMP(3)`'], ['`String`', '`VARCHAR`'], ['`Binary`', '`VARBINARY`'], ['`ObjectId`', '`ObjectId`'], ['`Object`', '`ROW`'], ['`Array`', '`ARRAY`', 'Map to `ROW` if the element type is not unique.'], ['`DBRef`', '`ROW`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino to MongoDB type mapping\": \"The connector maps Trino types to the corresponding MongoDB types following\\nthis table:\\n\\n:::{list-table} Trino to MongoDB type mapping\\n:widths: 30, 20\\n:header-rows: 1\\n\\n[['Trino type', 'MongoDB type'], ['`BOOLEAN`', '`Boolean`'], ['`BIGINT`', '`Int64`'], ['`DOUBLE`', '`Double`'], ['`DECIMAL(p, s)`', '`Decimal128`'], ['`TIMESTAMP(3)`', '`Date`'], ['`VARCHAR`', '`String`'], ['`VARBINARY`', '`Binary`'], ['`ObjectId`', '`ObjectId`'], ['`ROW`', '`Object`'], ['`ARRAY`', '`Array`\\\\n:::']]\\n\\nNo other types are supported.\\n\\n(mongodb-sql-support)=\"}, \"SQL support\": {\"ALTER TABLE\": \"The connector supports `ALTER TABLE RENAME TO`, `ALTER TABLE ADD COLUMN`\\nand `ALTER TABLE DROP COLUMN` operations.\\nOther uses of `ALTER TABLE` are not supported.\", \"Table functions\": {\"`query(database, collection, filter) -> table`\": \"The `query` function allows you to query the underlying MongoDB directly. It\\nrequires syntax native to MongoDB, because the full query is pushed down and\\nprocessed by MongoDB. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\nFor example, get all rows where `regionkey` field is 0:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n database => 'tpch',\\n collection => 'region',\\n filter => '{ regionkey: 0 }'\\n )\\n );\\n```\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 22]\"}, {\"title\": \"MySQL connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to MySQL, you need:\\n\\n['MySQL 5.7, 8.0 or higher.', 'Network access from the Trino coordinator and workers to MySQL.\\\\nPort 3306 is the default port.']\", \"Configuration\": {\"Connection security\": \"If you have TLS configured with a globally-trusted certificate installed on your\\ndata source, you can enable TLS between your cluster and the data\\nsource by appending a parameter to the JDBC connection string set in the\\n`connection-url` catalog configuration property.\\n\\nFor example, with version 8.0 of MySQL Connector/J, use the `sslMode`\\nparameter to secure the connection with TLS. By default the parameter is set to\\n`PREFERRED` which secures the connection if enabled by the server. You can\\nalso set this parameter to `REQUIRED` which causes the connection to fail if\\nTLS is not established.\\n\\nYou can set the `sslMode` parameter in the catalog configuration file by\\nappending it to the `connection-url` configuration property:\\n\\n```\\nconnection-url=jdbc:mysql://example.net:3306/?sslMode=REQUIRED\\n```\\n\\nFor more information on TLS configuration options, see the [MySQL JDBC security\\ndocumentation](https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-connp-props-security.html#cj-conn-prop_sslMode).\\n\\n```\\n```\", \"Multiple MySQL servers\": \"You can have as many catalogs as you need, so if you have additional\\nMySQL servers, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For\\nexample, if you name the property file `sales.properties`, Trino\\ncreates a catalog named `sales` using the configured connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(mysql-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\"}, \"Table properties\": \"Table property usage example:\\n\\n```\\nCREATE TABLE person (\\n id INT NOT NULL,\\n name VARCHAR,\\n age INT,\\n birthday DATE \\n)\\nWITH (\\n primary_key = ARRAY['id']\\n);\\n```\\n\\nThe following are supported MySQL table properties: \\n\\n:::{list-table}\\n:widths: 30, 10, 60\\n:header-rows: 1\\n\\n[['Property name', 'Required', 'Description'], ['`primary_key`', 'No', 'The primary key of the table, can choose multi columns as the table primary key.\\\\nAll key columns must be defined as `NOT NULL`.\\\\n:::']]\\n\\n(mysql-type-mapping)=\", \"Type mapping\": {\"MySQL to Trino type mapping\": \"The connector maps MySQL types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} MySQL to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['MySQL database type', 'Trino type', 'Notes'], ['`BIT`', '`BOOLEAN`'], ['`BOOLEAN`', '`TINYINT`'], ['`TINYINT`', '`TINYINT`'], ['`TINYINT UNSIGNED`', '`SMALLINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`SMALLINT UNSIGNED`', '`INTEGER`'], ['`INTEGER`', '`INTEGER`'], ['`INTEGER UNSIGNED`', '`BIGINT`'], ['`BIGINT`', '`BIGINT`'], ['`BIGINT UNSIGNED`', '`DECIMAL(20, 0)`'], ['`DOUBLE PRECISION`', '`DOUBLE`'], ['`FLOAT`', '`REAL`'], ['`REAL`', '`REAL`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`', 'See [MySQL DECIMAL type handling](mysql-decimal-handling)'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`TINYTEXT`', '`VARCHAR(255)`'], ['`TEXT`', '`VARCHAR(65535)`'], ['`MEDIUMTEXT`', '`VARCHAR(16777215)`'], ['`LONGTEXT`', '`VARCHAR`'], ['`ENUM(n)`', '`VARCHAR(n)`'], ['`BINARY`, `VARBINARY`, `TINYBLOB`, `BLOB`, `MEDIUMBLOB`, `LONGBLOB`', '`VARBINARY`'], ['`JSON`', '`JSON`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`DATETIME(n)`', '`TIMESTAMP(n)`'], ['`TIMESTAMP(n)`', '`TIMESTAMP(n) WITH TIME ZONE`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino to MySQL type mapping\": \"The connector maps Trino types to the corresponding MySQL types following\\nthis table:\\n\\n:::{list-table} Trino to MySQL type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'MySQL type', 'Notes'], ['`BOOLEAN`', '`TINYINT`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`REAL`'], ['`DOUBLE`', '`DOUBLE PRECISION`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`', '[MySQL DECIMAL type handling](mysql-decimal-handling)'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`JSON`', '`JSON`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`TIMESTAMP(n)`', '`DATETIME(n)`'], ['`TIMESTAMP(n) WITH TIME ZONE`', '`TIMESTAMP(n)`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Timestamp type handling\": \"MySQL `TIMESTAMP` types are mapped to Trino `TIMESTAMP WITH TIME ZONE`.\\nTo preserve time instants, Trino sets the session time zone\\nof the MySQL connection to match the JVM time zone.\\nAs a result, error messages similar to the following example occur when\\na timezone from the JVM does not exist on the MySQL server:\\n\\n```\\ncom.mysql.cj.exceptions.CJException: Unknown or incorrect time zone: 'UTC'\\n```\\n\\nTo avoid the errors, you must use a time zone that is known on both systems,\\nor [install the missing time zone on the MySQL server](https://dev.mysql.com/doc/refman/8.0/en/time-zone-support.html#time-zone-installation).\\n\\n(mysql-decimal-handling)=\\n\\n```\\n```\\n\\n```\\n```\"}, \"Querying MySQL\": \"The MySQL connector provides a schema for every MySQL *database*.\\nYou can see the available MySQL databases by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a MySQL database named `web`, you can view the tables\\nin this database by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web` database\\nusing either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can access the `clicks` table in the `web` database:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n\\n(mysql-sql-support)=\", \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(mysql-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to MySQL, because the full query is pushed down and\\nprocessed in MySQL. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nFor example, query the `example` catalog and group and concatenate all\\nemployee IDs by manager ID:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n manager_id, GROUP_CONCAT(employee_id)\\n FROM\\n company.employees\\n GROUP BY\\n manager_id'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Table statistics\": \"The MySQL connector can use {doc}`table and column statistics\\n</optimizer/statistics>` for {doc}`cost based optimizations\\n</optimizer/cost-based-optimizations>`, to improve query processing performance\\nbased on the actual data in the data source.\\n\\nThe statistics are collected by MySQL and retrieved by the connector.\\n\\nThe table-level statistics are based on MySQL's `INFORMATION_SCHEMA.TABLES`\\ntable. The column-level statistics are based on MySQL's index statistics\\n`INFORMATION_SCHEMA.STATISTICS` table. The connector can return column-level\\nstatistics only when the column is the first column in some index.\\n\\nMySQL database can automatically update its table and index statistics. In some\\ncases, you may want to force statistics update, for example after creating new\\nindex, or after changing data in the table. You can do that by executing the\\nfollowing statement in MySQL Database.\\n\\n```\\nANALYZE TABLE table_name;\\n```\\n\\n:::{note}\\nMySQL and Trino may use statistics information in different ways. For this\\nreason, the accuracy of table and column statistics returned by the MySQL\\nconnector might be lower than that of others connectors.\\n:::\\n\\n**Improving statistics accuracy**\\n\\nYou can improve statistics accuracy with histogram statistics (available since\\nMySQL 8.0). To create histogram statistics execute the following statement in\\nMySQL Database.\\n\\n```\\nANALYZE TABLE table_name UPDATE HISTOGRAM ON column_name1, column_name2, ...;\\n```\\n\\nRefer to MySQL documentation for information about options, limitations\\nand additional considerations.\\n\\n(mysql-pushdown)=\", \"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`join-pushdown`', '{ref}`limit-pushdown`', '{ref}`topn-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`', '{func}`stddev`', '{func}`stddev_pop`', '{func}`stddev_samp`', '{func}`variance`', '{func}`var_pop`', '{func}`var_samp`']\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 23]\"}, {\"title\": \"OpenSearch connector\", \"description\": null, \"content\": {\"Requirements\": [\"OpenSearch 1.1.0 or higher.\", \"Network access from the Trino coordinator and workers to the OpenSearch nodes.\"], \"Configuration\": {\"Authentication\": \"The connection to OpenSearch can use AWS or password authentication.\\n\\nTo enable AWS authentication and authorization using IAM policies, the\\n`opensearch.security` option must be set to `AWS`. Additionally, the\\nfollowing options must be configured:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`opensearch.aws.region`', 'AWS region of the OpenSearch endpoint. This option is required.'], ['`opensearch.aws.access-key`', 'AWS access key to use to connect to the OpenSearch domain. If not set, the\\\\ndefault AWS credentials provider chain is used.'], ['`opensearch.aws.secret-key`', 'AWS secret key to use to connect to the OpenSearch domain. If not set, the\\\\ndefault AWS credentials provider chain is used.'], ['`opensearch.aws.iam-role`', 'Optional ARN of an IAM role to assume to connect to OpenSearch. Note that\\\\nthe configured IAM user must be able to assume this role.'], ['`opensearch.aws.external-id`', 'Optional external ID to pass while assuming an AWS IAM role.'], ['`opensearch.aws.deployment-type`', 'AWS OpenSearch deployment type. Possible values are `PROVISIONED` & `SERVERLESS`. This option is required.\\\\n:::']]\\n\\nTo enable password authentication, the `opensearch.security` option must be set\\nto `PASSWORD`. Additionally the following options must be configured:\\n\\n:::{list-table}\\n:widths: 45, 55\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`opensearch.auth.user`', 'Username to use to connect to OpenSearch.'], ['`opensearch.auth.password`', 'Password to use to connect to OpenSearch.\\\\n:::']]\", \"Connection security with TLS\": \"The connector provides additional security options to connect to OpenSearch\\nclusters with TLS enabled.\\n\\nIf your cluster uses globally-trusted certificates, you only need to\\nenable TLS. If you require custom configuration for certificates, the connector\\nsupports key stores and trust stores in P12 (PKCS) or Java Key Store (JKS) format.\\n\\nThe available configuration values are listed in the following table:\\n\\n:::{list-table} TLS configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`opensearch.tls.enabled`', 'Enable TLS security. Defaults to `false`.'], ['`opensearch.tls.keystore-path`', 'The path to the P12 (PKCS) or [JKS](/security/inspect-jks)\\\\nkey store.'], ['`opensearch.tls.truststore-path`', 'The path to P12 (PKCS) or [JKS](/security/inspect-jks)\\\\ntrust store.'], ['`opensearch.tls.keystore-password`', 'The password for the key store specified by\\\\n`opensearch.tls.keystore-path`.'], ['`opensearch.tls.truststore-password`', 'The password for the trust store specified by\\\\n`opensearch.tls.truststore-path`.'], ['`opensearch.tls.verify-hostnames`', 'Flag to determine if the hostnames in the certificates must be verified.\\\\nDefaults to `true`.\\\\n:::']]\\n\\n(opensearch-type-mapping)=\"}, \"Type mapping\": {\"OpenSearch type to Trino type mapping\": \"The connector maps OpenSearch types to the corresponding Trino types\\naccording to the following table:\\n\\n:::{list-table} OpenSearch type to Trino type mapping\\n:widths: 30, 30, 50\\n:header-rows: 1\\n\\n[['OpenSearch type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`DOUBLE`', '`DOUBLE`'], ['`FLOAT`', '`REAL`'], ['`BYTE`', '`TINYINT`'], ['`SHORT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`LONG`', '`BIGINT`'], ['`KEYWORD`', '`VARCHAR`'], ['`TEXT`', '`VARCHAR`'], ['`DATE`', '`TIMESTAMP`', 'For more information, see [](opensearch-date-types).'], ['`IPADDRESS`', '`IP`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n(opensearch-array-types)=\", \"Array types\": \"Fields in OpenSearch can contain [zero or more\\nvalues](https://opensearch.org/docs/latest/field-types/supported-field-types/date/#custom-formats),\\nbut there is no dedicated array type. To indicate a field contains an array, it\\ncan be annotated in a Trino-specific structure in the\\n[\\\\_meta](https://opensearch.org/docs/latest/field-types/index/#get-a-mapping)\\nsection of the index mapping in OpenSearch.\\n\\nFor example, you can have an OpenSearch index that contains documents with the\\nfollowing structure:\\n\\n```\\n{\\n \\\"array_string_field\\\": [\\\"trino\\\",\\\"the\\\",\\\"lean\\\",\\\"machine-ohs\\\"],\\n \\\"long_field\\\": 314159265359,\\n \\\"id_field\\\": \\\"564e6982-88ee-4498-aa98-df9e3f6b6109\\\",\\n \\\"timestamp_field\\\": \\\"1987-09-17T06:22:48.000Z\\\",\\n \\\"object_field\\\": {\\n \\\"array_int_field\\\": [86,75,309],\\n \\\"int_field\\\": 2\\n }\\n}\\n```\\n\\nThe array fields of this structure can be defined by using the following command\\nto add the field property definition to the `_meta.trino` property of the target\\nindex mapping with OpenSearch available at `search.example.com:9200`:\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"_meta\\\": {\\n \\\"trino\\\":{\\n \\\"array_string_field\\\":{\\n \\\"isArray\\\":true\\n },\\n \\\"object_field\\\":{\\n \\\"array_int_field\\\":{\\n \\\"isArray\\\":true\\n }\\n },\\n }\\n }\\n}'\\n```\\n\\n:::{note}\\nIt is not allowed to use `asRawJson` and `isArray` flags simultaneously for the same column.\\n:::\\n\\n(opensearch-date-types)=\", \"Date types\": \"The OpenSearch connector supports only the default `date` type. All other\\nOpenSearch [date] formats including [built-in date formats] and [custom date\\nformats] are not supported. Dates with the [format] property are ignored.\", \"Raw JSON transform\": \"Documents in OpenSearch can include more complex structures that are not\\nrepresented in the mapping. For example, a single `keyword` field can have\\nwidely different content including a single `keyword` value, an array, or a\\nmultidimensional `keyword` array with any level of nesting.\\n\\nThe following command configures `array_string_field` mapping with OpenSearch\\navailable at `search.example.com:9200`:\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"properties\\\": {\\n \\\"array_string_field\\\":{\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n}'\\n```\\n\\nAll the following documents are legal for OpenSearch with `array_string_field`\\nmapping:\\n\\n```\\n[\\n {\\n \\\"array_string_field\\\": \\\"trino\\\"\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",\\\"is\\\",\\\"the\\\",\\\"best\\\"]\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",[\\\"is\\\",\\\"the\\\",\\\"best\\\"]]\\n },\\n {\\n \\\"array_string_field\\\": [\\\"trino\\\",[\\\"is\\\",[\\\"the\\\",\\\"best\\\"]]]\\n }\\n]\\n```\\n\\nSee the [OpenSearch array\\ndocumentation](https://opensearch.org/docs/latest/field-types/supported-field-types/index/#arrays)\\nfor more details.\\n\\nFurther, OpenSearch supports types, such as [k-NN\\nvector](https://opensearch.org/docs/latest/field-types/supported-field-types/knn-vector/),\\nthat are not supported in Trino. These and other types can cause parsing\\nexceptions for users that use of these types in OpenSearch. To manage all of\\nthese scenarios, you can transform fields to raw JSON by annotating it in a\\nTrino-specific structure in the\\n[\\\\_meta](https://opensearch.org/docs/latest/field-types/index/) section of the\\nOpenSearch index mapping. This indicates to Trino that the field, and all nested\\nfields beneath, must be cast to a `VARCHAR` field that contains the raw JSON\\ncontent. These fields can be defined by using the following command to add the\\nfield property definition to the `_meta.trino` property of the target index\\nmapping.\\n\\n```\\ncurl --request PUT \\\\\\n --url search.example.com:9200/doc/_mapping \\\\\\n --header 'content-type: application/json' \\\\\\n --data '\\n{\\n \\\"_meta\\\": {\\n \\\"trino\\\":{\\n \\\"array_string_field\\\":{\\n \\\"asRawJson\\\":true\\n }\\n }\\n }\\n}'\\n```\\n\\nThe preceding configuration causes Trino to return the `array_string_field`\\nfield as a `VARCHAR` containing raw JSON. You can parse these fields with the\\n[built-in JSON functions](/functions/json).\\n\\n:::{note}\\nIt is not allowed to use `asRawJson` and `isArray` flags simultaneously for the same column.\\n:::\"}, \"Special columns\": \"The following hidden columns are available:\\n\\n:::{list-table}\\n:widths: 25, 75\\n:header-rows: 1\\n\\n[['Column', 'Description'], ['`_id`', 'The OpenSearch document ID.'], ['`_score`', 'The document score returned by the OpenSearch query.'], ['`_source`', 'The source of the original document.\\\\n:::']]\\n\\n(opensearch-sql-support)=\", \"SQL support\": {\"Wildcard table\": \"The connector provides support to query multiple tables using a concise\\n[wildcard table](https://opensearch.org/docs/latest/api-reference/multi-search/#metadata-only-options)\\nnotation.\\n\\n```\\nSELECT *\\nFROM example.web.\\\"page_views_*\\\";\\n```\", \"Table functions\": {\"`raw_query(varchar) -> table`\": \"The `raw_query` function allows you to query the underlying database directly\\nusing the [OpenSearch Query\\nDSL](https://opensearch.org/docs/latest/query-dsl/index/) syntax. The full DSL\\nquery is pushed down and processed in OpenSearch. This can be useful for\\naccessing native features which are not available in Trino, or for improving\\nquery performance in situations where running a query natively may be faster.\\n\\n```\\n```\\n\\nThe `raw_query` function requires three parameters:\\n\\n['`schema`: The schema in the catalog that the query is to be executed on.', '`index`: The index in OpenSearch to search.', '`query`: The query to execute, written in [OpenSearch Query DSL](https://opensearch.org/docs/latest/query-dsl).']\\n\\nOnce executed, the query returns a single row containing the resulting JSON\\npayload returned by OpenSearch.\\n\\nFor example, query the `example` catalog and use the `raw_query` table function\\nto search for documents in the `orders` index where the country name is\\n`ALGERIA` as defined as a JSON-formatted query matcher and passed to the\\n`raw_query` table function in the `query` parameter:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.raw_query(\\n schema => 'sales',\\n index => 'orders',\\n query => '{\\n \\\"query\\\": {\\n \\\"match\\\": {\\n \\\"name\\\": \\\"ALGERIA\\\"\\n }\\n }\\n }'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Parallel data access\": \"The connector requests data from multiple nodes of the OpenSearch cluster for\\nquery processing in parallel.\", \"Predicate push down\": \"The connector supports [predicate push down](predicate-pushdown) for the\\nfollowing data types:\\n\\n:::{list-table}\\n:widths: 50, 50\\n:header-rows: 1\\n\\n[['OpenSearch', 'Trino'], ['`boolean`', '`BOOLEAN`'], ['`double`', '`DOUBLE`'], ['`float`', '`REAL`'], ['`byte`', '`TINYINT`'], ['`short`', '`SMALLINT`'], ['`integer`', '`INTEGER`'], ['`long`', '`BIGINT`'], ['`keyword`', '`VARCHAR`'], ['`date`', '`TIMESTAMP`\\\\n:::']]\\n\\nNo other data types are supported for predicate push down.\\n\\n[built-in date formats]: https://opensearch.org/docs/latest/field-types/supported-field-types/date/#custom-formats\\n[custom date formats]: https://opensearch.org/docs/latest/field-types/supported-field-types/date/#custom-formats\\n[date]: https://opensearch.org/docs/latest/field-types/supported-field-types/date/\\n[format]: https://opensearch.org/docs/latest/query-dsl/term/range/#format\\n[full text query]: https://opensearch.org/docs/latest/query-dsl/full-text/query-string/\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 24]\"}, {\"title\": \"Oracle connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Oracle, you need:\\n\\n['Oracle 19 or higher.', 'Network access from the Trino coordinator and workers to Oracle.\\\\nPort 1521 is the default port.']\", \"Configuration\": {\"Multiple Oracle servers\": \"If you want to connect to multiple Oracle servers, configure another instance of\\nthe Oracle connector as a separate catalog.\\n\\nTo add another Oracle catalog, create a new properties file. For example, if\\nyou name the property file `sales.properties`, Trino creates a catalog named\\n`sales`.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(oracle-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\"}, \"Querying Oracle\": {\"Examples\": \"If you have an Oracle database named `web`, run `SHOW TABLES` to see the\\ntables it contains:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nTo see a list of the columns in the `clicks` table in the `web`\\ndatabase, run either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nTo access the clicks table in the web database, run the following:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\n(oracle-type-mapping)=\"}, \"Type mapping\": {\"Oracle to Trino type mapping\": \"Trino supports selecting Oracle database types. This table shows the Oracle to\\nTrino data type mapping:\\n\\n:::{list-table} Oracle to Trino type mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Oracle database type', 'Trino type', 'Notes'], ['`NUMBER(p, s)`', '`DECIMAL(p, s)`', 'See [](oracle-number-mapping)'], ['`NUMBER(p)`', '`DECIMAL(p, 0)`', 'See [](oracle-number-mapping)'], ['`FLOAT[(p)]`', '`DOUBLE`'], ['`BINARY_FLOAT`', '`REAL`'], ['`BINARY_DOUBLE`', '`DOUBLE`'], ['`VARCHAR2(n CHAR)`', '`VARCHAR(n)`'], ['`VARCHAR2(n BYTE)`', '`VARCHAR(n)`'], ['`NVARCHAR2(n)`', '`VARCHAR(n)`'], ['`CHAR(n)`', '`CHAR(n)`'], ['`NCHAR(n)`', '`CHAR(n)`'], ['`CLOB`', '`VARCHAR`'], ['`NCLOB`', '`VARCHAR`'], ['`RAW(n)`', '`VARBINARY`'], ['`BLOB`', '`VARBINARY`'], ['`DATE`', '`TIMESTAMP(0)`', 'See [](oracle-datetime-mapping)'], ['`TIMESTAMP(p)`', '`TIMESTAMP(p)`', 'See [](oracle-datetime-mapping)'], ['`TIMESTAMP(p) WITH TIME ZONE`', '`TIMESTAMP WITH TIME ZONE`', 'See [](oracle-datetime-mapping)\\\\n:::']]\\n\\nNo other types are supported.\", \"Trino to Oracle type mapping\": \"Trino supports creating tables with the following types in an Oracle database.\\nThe table shows the mappings from Trino to Oracle data types:\\n\\n:::{note}\\nFor types not listed in the table below, Trino can't perform the `CREATE\\nTABLE <table> AS SELECT` operations. When data is inserted into existing\\ntables, `Oracle to Trino` type mapping is used.\\n:::\\n\\n:::{list-table} Trino to Oracle Type Mapping\\n:widths: 30, 25, 50\\n:header-rows: 1\\n\\n[['Trino type', 'Oracle database type', 'Notes'], ['`TINYINT`', '`NUMBER(3)`'], ['`SMALLINT`', '`NUMBER(5)`'], ['`INTEGER`', '`NUMBER(10)`'], ['`BIGINT`', '`NUMBER(19)`'], ['`DECIMAL(p, s)`', '`NUMBER(p, s)`'], ['`REAL`', '`BINARY_FLOAT`'], ['`DOUBLE`', '`BINARY_DOUBLE`'], ['`VARCHAR`', '`NCLOB`'], ['`VARCHAR(n)`', '`VARCHAR2(n CHAR)` or `NCLOB`', 'See [](oracle-character-mapping)'], ['`CHAR(n)`', '`CHAR(n CHAR)` or `NCLOB`', 'See [](oracle-character-mapping)'], ['`VARBINARY`', '`BLOB`'], ['`DATE`', '`DATE`', 'See [](oracle-datetime-mapping)'], ['`TIMESTAMP`', '`TIMESTAMP(3)`', 'See [](oracle-datetime-mapping)'], ['`TIMESTAMP WITH TIME ZONE`', '`TIMESTAMP(3) WITH TIME ZONE`', 'See [](oracle-datetime-mapping)\\\\n:::']]\\n\\nNo other types are supported.\\n\\n(oracle-number-mapping)=\", \"Mapping numeric types\": \"An Oracle `NUMBER(p, s)` maps to Trino's `DECIMAL(p, s)` except in these\\nconditions:\\n\\n['No precision is specified for the column (example: `NUMBER` or\\\\n`NUMBER(*)`), unless `oracle.number.default-scale` is set.', 'Scale (`s` ) is greater than precision.', 'Precision (`p` ) is greater than 38.', 'Scale is negative and the difference between `p` and `s` is greater than\\\\n38, unless `oracle.number.rounding-mode` is set to a different value than\\\\n`UNNECESSARY`.']\\n\\nIf `s` is negative, `NUMBER(p, s)` maps to `DECIMAL(p + s, 0)`.\\n\\nFor Oracle `NUMBER` (without precision and scale), you can change\\n`oracle.number.default-scale=s` and map the column to `DECIMAL(38, s)`.\\n\\n(oracle-datetime-mapping)=\", \"Mapping datetime types\": \"Writing a timestamp with fractional second precision (`p`) greater than 9\\nrounds the fractional seconds to nine digits.\\n\\nOracle `DATE` type stores hours, minutes, and seconds, so it is mapped\\nto Trino `TIMESTAMP(0)`.\\n\\n:::{warning}\\nDue to date and time differences in the libraries used by Trino and the\\nOracle JDBC driver, attempting to insert or select a datetime value earlier\\nthan `1582-10-15` results in an incorrect date inserted.\\n:::\\n\\n(oracle-character-mapping)=\", \"Mapping character types\": \"Trino's `VARCHAR(n)` maps to `VARCHAR2(n CHAR)` if `n` is no greater\\nthan 4000. A larger or unbounded `VARCHAR` maps to `NCLOB`.\\n\\nTrino's `CHAR(n)` maps to `CHAR(n CHAR)` if `n` is no greater than 2000.\\nA larger `CHAR` maps to `NCLOB`.\\n\\nUsing `CREATE TABLE AS` to create an `NCLOB` column from a `CHAR` value\\nremoves the trailing spaces from the initial values for the column. Inserting\\n`CHAR` values into existing `NCLOB` columns keeps the trailing spaces. For\\nexample:\\n\\n```\\nCREATE TABLE vals AS SELECT CAST('A' as CHAR(2001)) col;\\nINSERT INTO vals (col) VALUES (CAST('BB' as CHAR(2001)));\\nSELECT LENGTH(col) FROM vals;\\n```\\n\\n```\\n _col0\\n-------\\n 2001\\n 1\\n(2 rows)\\n```\\n\\nAttempting to write a `CHAR` that doesn't fit in the column's actual size\\nfails. This is also true for the equivalent `VARCHAR` types.\\n\\n```\\n```\", \"Number to decimal configuration properties\": \":::{list-table}\\n:widths: 20, 20, 50, 10\\n:header-rows: 1\\n\\n[['Configuration property name', 'Session property name', 'Description', 'Default'], ['`oracle.number.default-scale`', '`number_default_scale`', 'Default Trino `DECIMAL` scale for Oracle `NUMBER` (without precision and\\\\nscale) date type. When not set then such column is treated as not supported.', 'not set'], ['`oracle.number.rounding-mode`', '`number_rounding_mode`', 'Rounding mode for the Oracle `NUMBER` data type. This is useful when Oracle\\\\n`NUMBER` data type specifies higher scale than is supported in Trino.\\\\nPossible values are:', ['`UNNECESSARY` - Rounding mode to assert that the\\\\nrequested operation has an exact result,\\\\nhence no rounding is necessary.', '`CEILING` - Rounding mode to round towards\\\\npositive infinity.', '`FLOOR` - Rounding mode to round towards negative\\\\ninfinity.', '`HALF_DOWN` - Rounding mode to round towards\\\\n`nearest neighbor` unless both neighbors are\\\\nequidistant, in which case rounding down is used.', '`HALF_EVEN` - Rounding mode to round towards the\\\\n`nearest neighbor` unless both neighbors are equidistant,\\\\nin which case rounding towards the even neighbor is\\\\nperformed.', '`HALF_UP` - Rounding mode to round towards\\\\n`nearest neighbor` unless both neighbors are\\\\nequidistant, in which case rounding up is used', '`UP` - Rounding mode to round towards zero.', '`DOWN` - Rounding mode to round towards zero.'], '`UNNECESSARY`\\\\n:::']]\\n\\n(oracle-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(oracle-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to Oracle, because the full query is pushed down and\\nprocessed in Oracle. This can be useful for accessing native features which are\\nnot available in Trino or for improving query performance in situations where\\nrunning a query natively may be faster.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\nAs a practical example, you can use the\\n[MODEL clause from Oracle SQL](https://docs.oracle.com/cd/B19306_01/server.102/b14223/sqlmodel.htm):\\n\\n```\\nSELECT\\n SUBSTR(country, 1, 20) country,\\n SUBSTR(product, 1, 15) product,\\n year,\\n sales\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n sales_view\\n MODEL\\n RETURN UPDATED ROWS\\n MAIN\\n simple_model\\n PARTITION BY\\n country\\n MEASURES\\n sales\\n RULES\\n (sales['Bounce', 2001] = 1000,\\n sales['Bounce', 2002] = sales['Bounce', 2001] + sales['Bounce', 2000],\\n sales['Y Box', 2002] = sales['Y Box', 2001])\\n ORDER BY\\n country'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Synonyms\": \"Based on performance reasons, Trino disables support for Oracle `SYNONYM`. To\\ninclude `SYNONYM`, add the following configuration property:\\n\\n```\\noracle.synonyms.enabled=true\\n```\\n\\n(oracle-pushdown)=\", \"Pushdown\": {\"Predicate pushdown support\": \"The connector does not support pushdown of any predicates on columns that use\\nthe `CLOB`, `NCLOB`, `BLOB`, or `RAW(n)` Oracle database types, or Trino\\ndata types that {ref}`map <oracle-type-mapping>` to these Oracle database types.\\n\\nIn the following example, the predicate is not pushed down for either query\\nsince `name` is a column of type `VARCHAR`, which maps to `NCLOB` in\\nOracle:\\n\\n```\\nSHOW CREATE TABLE nation;\\n\\n-- Create Table\\n----------------------------------------\\n-- CREATE TABLE oracle.trino_test.nation (\\n-- name VARCHAR\\n-- )\\n-- (1 row)\\n\\nSELECT * FROM nation WHERE name > 'CANADA';\\nSELECT * FROM nation WHERE name = 'CANADA';\\n```\\n\\nIn the following example, the predicate is pushed down for both queries\\nsince `name` is a column of type `VARCHAR(25)`, which maps to\\n`VARCHAR2(25)` in Oracle:\\n\\n```\\nSHOW CREATE TABLE nation;\\n\\n-- Create Table\\n----------------------------------------\\n-- CREATE TABLE oracle.trino_test.nation (\\n-- name VARCHAR(25)\\n-- )\\n-- (1 row)\\n\\nSELECT * FROM nation WHERE name > 'CANADA';\\nSELECT * FROM nation WHERE name = 'CANADA';\\n```\"}}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 25]\"}, {\"title\": \"Pinot connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Pinot, you need:\\n\\n['Pinot 1.1.0 or higher.', 'Network access from the Trino coordinator and workers to the Pinot controller\\\\nnodes. Port 8098 is the default port.']\", \"Configuration\": \"To configure the Pinot connector, create a catalog properties file\\ne.g. `etc/catalog/example.properties` with at least the following contents:\\n\\n```\\nconnector.name=pinot\\npinot.controller-urls=host1:8098,host2:8098\\n```\\n\\nReplace `host1:8098,host2:8098` with a comma-separated list of Pinot controller nodes.\\nThis can be the ip or the FQDN, the url scheme (`http://`) is optional.\", \"Configuration properties\": {\"General configuration properties\": \"| Property name | Required | Description |\\n|--------------------------------------------------------|----------| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `pinot.controller-urls` | Yes | A comma separated list of controller hosts. If Pinot is deployed via [Kubernetes](https://kubernetes.io/) this needs to point to the controller service endpoint. The Pinot broker and server must be accessible via DNS as Pinot returns hostnames and not IP addresses. |\\n| `pinot.broker-url` | No | A host and port of broker. If broker URL exposed by Pinot controller API is not accessible, this property can be used to specify the broker endpoint. Enabling this property will disable broker discovery. |\\n| `pinot.connection-timeout` | No | Pinot connection timeout, default is `15s`. |\\n| `pinot.metadata-expiry` | No | Pinot metadata expiration time, default is `2m`. |\\n| `pinot.controller.authentication.type` | No | Pinot authentication method for controller requests. Allowed values are `NONE` and `PASSWORD` - defaults to `NONE` which is no authentication. |\\n| `pinot.controller.authentication.user` | No | Controller username for basic authentication method. |\\n| `pinot.controller.authentication.password` | No | Controller password for basic authentication method. |\\n| `pinot.broker.authentication.type` | No | Pinot authentication method for broker requests. Allowed values are `NONE` and `PASSWORD` - defaults to `NONE` which is no authentication. |\\n| `pinot.broker.authentication.user` | No | Broker username for basic authentication method. |\\n| `pinot.broker.authentication.password` | No | Broker password for basic authentication method. |\\n| `pinot.max-rows-per-split-for-segment-queries` | No | Fail query if Pinot server split returns more rows than configured, default to `2,147,483,647`. |\\n| `pinot.prefer-broker-queries` | No | Pinot query plan prefers to query Pinot broker, default is `true`. |\\n| `pinot.forbid-segment-queries` | No | Forbid parallel querying and force all querying to happen via the broker, default is `false`. |\\n| `pinot.segments-per-split` | No | The number of segments processed in a split. Setting this higher reduces the number of requests made to Pinot. This is useful for smaller Pinot clusters, default is `1`. |\\n| `pinot.fetch-retry-count` | No | Retry count for retriable Pinot data fetch calls, default is `2`. |\\n| `pinot.non-aggregate-limit-for-broker-queries` | No | Max limit for non aggregate queries to the Pinot broker, default is `25,000`. |\\n| `pinot.max-rows-for-broker-queries` | No | Max rows for a broker query can return, default is `50,000`. |\\n| `pinot.aggregation-pushdown.enabled` | No | Push down aggregation queries, default is `true`. |\\n| `pinot.count-distinct-pushdown.enabled` | No | Push down count distinct queries to Pinot, default is `true`. |\\n| `pinot.target-segment-page-size` | No | Max allowed page size for segment query, default is `1MB`. |\\n| `pinot.proxy.enabled` | No | Use Pinot Proxy for controller and broker requests, default is `false`. |\\n\\nIf `pinot.controller.authentication.type` is set to `PASSWORD` then both `pinot.controller.authentication.user` and\\n`pinot.controller.authentication.password` are required.\\n\\nIf `pinot.broker.authentication.type` is set to `PASSWORD` then both `pinot.broker.authentication.user` and\\n`pinot.broker.authentication.password` are required.\\n\\nIf `pinot.controller-urls` uses `https` scheme then TLS is enabled for all connections including brokers.\", \"gRPC configuration properties\": \"| Property name | Required | Description |\\n| ------------------------------------- | -------- | -------------------------------------------------------------------- |\\n| `pinot.grpc.port` | No | Pinot gRPC port, default to `8090`. |\\n| `pinot.grpc.max-inbound-message-size` | No | Max inbound message bytes when init gRPC client, default is `128MB`. |\\n| `pinot.grpc.use-plain-text` | No | Use plain text for gRPC communication, default to `true`. |\\n| `pinot.grpc.tls.keystore-type` | No | TLS keystore type for gRPC connection, default is `JKS`. |\\n| `pinot.grpc.tls.keystore-path` | No | TLS keystore file location for gRPC connection, default is empty. |\\n| `pinot.grpc.tls.keystore-password` | No | TLS keystore password, default is empty. |\\n| `pinot.grpc.tls.truststore-type` | No | TLS truststore type for gRPC connection, default is `JKS`. |\\n| `pinot.grpc.tls.truststore-path` | No | TLS truststore file location for gRPC connection, default is empty. |\\n| `pinot.grpc.tls.truststore-password` | No | TLS truststore password, default is empty. |\\n| `pinot.grpc.tls.ssl-provider` | No | SSL provider, default is `JDK`. |\\n| `pinot.grpc.proxy-uri` | No | Pinot Rest Proxy gRPC endpoint URI, default is null. |\\n\\nFor more Apache Pinot TLS configurations, please also refer to [Configuring TLS/SSL](https://docs.pinot.apache.org/operators/tutorials/configuring-tls-ssl).\\n\\nYou can use {doc}`secrets </security/secrets>` to avoid actual values in the catalog properties files.\"}, \"Querying Pinot tables\": \"The Pinot connector automatically exposes all tables in the default schema of the catalog.\\nYou can list all tables in the pinot catalog with the following query:\\n\\n```\\nSHOW TABLES FROM example.default;\\n```\\n\\nYou can list columns in the flight_status table:\\n\\n```\\nDESCRIBE example.default.flight_status;\\nSHOW COLUMNS FROM example.default.flight_status;\\n```\\n\\nQueries written with SQL are fully supported and can include filters and limits:\\n\\n```\\nSELECT foo\\nFROM pinot_table\\nWHERE bar = 3 AND baz IN ('ONE', 'TWO', 'THREE')\\nLIMIT 25000;\\n```\\n\\n(pinot-dynamic-tables)=\", \"Dynamic tables\": \"To leverage Pinot's fast aggregation, a Pinot query written in PQL can be used as the table name.\\nFilters and limits in the outer query are pushed down to Pinot.\\nLet's look at an example query:\\n\\n```\\nSELECT *\\nFROM example.default.\\\"SELECT MAX(col1), COUNT(col2) FROM pinot_table GROUP BY col3, col4\\\"\\nWHERE col3 IN ('FOO', 'BAR') AND col4 > 50\\nLIMIT 30000\\n```\\n\\nFiltering and limit processing is pushed down to Pinot.\\n\\nThe queries are routed to the broker and are more suitable to aggregate queries.\\n\\nFor `SELECT` queries without aggregates it is more performant to issue a regular SQL query.\\nProcessing is routed directly to the servers that store the data.\\n\\nThe above query is translated to the following Pinot PQL query:\\n\\n```\\nSELECT MAX(col1), COUNT(col2)\\nFROM pinot_table\\nWHERE col3 IN('FOO', 'BAR') and col4 > 50\\nTOP 30000\\n```\\n\\n(pinot-type-mapping)=\", \"Type mapping\": {\"Pinot type to Trino type mapping\": {\"Date Type\": \"For Pinot `DateTimeFields`, if the `FormatSpec` is in days,\\nthen it is converted to a Trino `DATE` type.\\nPinot allows for `LONG` fields to have a `FormatSpec` of days as well, if the \\nvalue is larger than `Integer.MAX_VALUE` then the conversion to Trino `DATE` fails. \", \"Null Handling\": \"If a Pinot TableSpec has `nullHandlingEnabled` set to true, then for numeric \\ntypes the null value is encoded as `MIN_VALUE` for that type. \\nFor Pinot `STRING` type, the value `null` is interpreted as a `NULL` value.\\n\\n(pinot-sql-support)=\"}}, \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in Pinot.\\n\\n(pinot-pushdown)=\", \"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`limit-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`approx_distinct`', '`count(*)` and `count(distinct)` variations of {func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`']\\n\\nAggregate function pushdown is enabled by default, but can be disabled with the\\ncatalog property `pinot.aggregation-pushdown.enabled` or the catalog session\\nproperty `aggregation_pushdown_enabled`.\\n\\nA `count(distint)` pushdown may cause Pinot to run a full table scan with\\nsignificant performance impact. If you encounter this problem, you can disable\\nit with the catalog property `pinot.count-distinct-pushdown.enabled` or the\\ncatalog session property `count_distinct_pushdown_enabled`.\\n\\n```\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 26]\"}, {\"title\": \"PostgreSQL connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to PostgreSQL, you need:\\n\\n['PostgreSQL 12.x or higher.', 'Network access from the Trino coordinator and workers to PostgreSQL.\\\\nPort 5432 is the default port.']\", \"Configuration\": {\"Access to system tables\": \"The PostgreSQL connector supports reading [PostgreSQL catalog\\ntables](https://www.postgresql.org/docs/current/catalogs.html), such as\\n`pg_namespace`. The functionality is turned off by default, and can be enabled\\nusing the `postgresql.include-system-tables` configuration property.\\n\\nYou can see more details in the `pg_catalog` schema in the `example` catalog,\\nfor example about the `pg_namespace` system table:\\n\\n```\\nSHOW TABLES FROM example.pg_catalog;\\nSELECT * FROM example.pg_catalog.pg_namespace;\\n```\\n\\n(postgresql-tls)=\", \"Connection security\": \"If you have TLS configured with a globally-trusted certificate installed on your\\ndata source, you can enable TLS between your cluster and the data\\nsource by appending a parameter to the JDBC connection string set in the\\n`connection-url` catalog configuration property.\\n\\nFor example, with version 42 of the PostgreSQL JDBC driver, enable TLS by\\nappending the `ssl=true` parameter to the `connection-url` configuration\\nproperty:\\n\\n```\\nconnection-url=jdbc:postgresql://example.net:5432/database?ssl=true\\n```\\n\\nFor more information on TLS configuration options, see the [PostgreSQL JDBC\\ndriver documentation](https://jdbc.postgresql.org/documentation/use/#connecting-to-the-database).\\n\\n```\\n```\", \"Multiple PostgreSQL databases or servers\": \"The PostgreSQL connector can only access a single database within\\na PostgreSQL server. Thus, if you have multiple PostgreSQL databases,\\nor want to connect to multiple PostgreSQL servers, you must configure\\nmultiple instances of the PostgreSQL connector.\\n\\nTo add another catalog, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For example,\\nif you name the property file `sales.properties`, Trino creates a\\ncatalog named `sales` using the configured connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(postgresql-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\\n\\n(postgresql-type-mapping)=\"}, \"Type mapping\": {\"PostgreSQL type to Trino type mapping\": \"The connector maps PostgreSQL types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} PostgreSQL type to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['PostgreSQL type', 'Trino type', 'Notes'], ['`BIT`', '`BOOLEAN`'], ['`BOOLEAN`', '`BOOLEAN`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`REAL`'], ['`DOUBLE`', '`DOUBLE`'], ['`NUMERIC(p, s)`', '`DECIMAL(p, s)`', '`DECIMAL(p, s)` is an alias of `NUMERIC(p, s)`. See\\\\n[](postgresql-decimal-type-handling) for more information.'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`ENUM`', '`VARCHAR`'], ['`BYTEA`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`TIMESTAMP(n)`', '`TIMESTAMP(n)`'], ['`TIMESTAMPTZ(n)`', '`TIMESTAMP(n) WITH TIME ZONE`'], ['`MONEY`', '`VARCHAR`'], ['`UUID`', '`UUID`'], ['`JSON`', '`JSON`'], ['`JSONB`', '`JSON`'], ['`VECTOR`', '`ARRAY(REAL)`'], ['`HSTORE`', '`MAP(VARCHAR, VARCHAR)`'], ['`ARRAY`', 'Disabled, `ARRAY`, or `JSON`', 'See [](postgresql-array-type-handling) for more information.'], ['`GEOMETRY`, `GEOMETRY(GEOMETRY TYPE, SRID)`', '`GEOMETRY`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino type to PostgreSQL type mapping\": \"The connector maps Trino types to the corresponding PostgreSQL types following\\nthis table:\\n\\n:::{list-table} Trino type to PostgreSQL type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'PostgreSQL type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`SMALLINT`', '`SMALLINT`'], ['`TINYINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL(p, s)`', '`NUMERIC(p, s)`', '`DECIMAL(p, s)` is an alias of `NUMERIC(p, s)`. See\\\\n[](postgresql-decimal-type-handling) for more information.'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`VARBINARY`', '`BYTEA`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`'], ['`TIMESTAMP(n)`', '`TIMESTAMP(n)`'], ['`TIMESTAMP(n) WITH TIME ZONE`', '`TIMESTAMPTZ(n)`'], ['`UUID`', '`UUID`'], ['`JSON`', '`JSONB`'], ['`ARRAY`', '`ARRAY`', 'See [](postgresql-array-type-handling) for more information.'], ['`GEOMETRY`', '`GEOMETRY`']]\\n\\n::::\\n\\nNo other types are supported.\\n\\n(postgresql-decimal-type-handling)=\\n\\n```\\n```\\n\\n(postgresql-array-type-handling)=\", \"Array type handling\": \"The PostgreSQL array implementation does not support fixed dimensions whereas Trino\\nsupport only arrays with fixed dimensions.\\nYou can configure how the PostgreSQL connector handles arrays with the `postgresql.array-mapping` configuration property in your catalog file\\nor the `array_mapping` session property.\\nThe following values are accepted for this property:\\n\\n['`DISABLED` (default): array columns are skipped.', '`AS_ARRAY`: array columns are interpreted as Trino `ARRAY` type, for array columns with fixed dimensions.', '`AS_JSON`: array columns are interpreted as Trino `JSON` type, with no constraint on dimensions.']\\n\\n```\\n```\"}, \"Querying PostgreSQL\": \"The PostgreSQL connector provides a schema for every PostgreSQL schema.\\nYou can see the available PostgreSQL schemas by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a PostgreSQL schema named `web`, you can view the tables\\nin this schema by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web` database\\nusing either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can access the `clicks` table in the `web` schema:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n\\n(postgresql-sql-support)=\", \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(postgresql-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to PostgreSQL, because the full query is pushed down and\\nprocessed in PostgreSQL. This can be useful for accessing native features which\\nare not available in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\nAs a practical example, you can leverage\\n[frame exclusion from PostgresQL](https://www.postgresql.org/docs/current/sql-expressions.html#SYNTAX-WINDOW-FUNCTIONS)\\nwhen using window functions:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *,\\n array_agg(week) OVER (\\n ORDER BY\\n week\\n ROWS\\n BETWEEN 2 PRECEDING\\n AND 2 FOLLOWING\\n EXCLUDE GROUP\\n ) AS week,\\n array_agg(week) OVER (\\n ORDER BY\\n day\\n ROWS\\n BETWEEN 2 PRECEDING\\n AND 2 FOLLOWING\\n EXCLUDE GROUP\\n ) AS all\\n FROM\\n test.time_data'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Table statistics\": \"The PostgreSQL connector can use {doc}`table and column statistics\\n</optimizer/statistics>` for {doc}`cost based optimizations\\n</optimizer/cost-based-optimizations>`, to improve query processing performance\\nbased on the actual data in the data source.\\n\\nThe statistics are collected by PostgreSQL and retrieved by the connector.\\n\\nTo collect statistics for a table, execute the following statement in\\nPostgreSQL.\\n\\n```\\nANALYZE table_schema.table_name;\\n```\\n\\nRefer to PostgreSQL documentation for additional `ANALYZE` options.\\n\\n(postgresql-pushdown)=\", \"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`join-pushdown`', '{ref}`limit-pushdown`', '{ref}`topn-pushdown`']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`', '{func}`stddev`', '{func}`stddev_pop`', '{func}`stddev_samp`', '{func}`variance`', '{func}`var_pop`', '{func}`var_samp`', '{func}`covar_pop`', '{func}`covar_samp`', '{func}`corr`', '{func}`regr_intercept`', '{func}`regr_slope`']\\n\\n```\\n```\\n\\n```\\n```\", \"Predicate pushdown support\": \"Predicates are pushed down for most types, including `UUID` and temporal\\ntypes, such as `DATE`.\\n\\nThe connector does not support pushdown of range predicates, such as `>`,\\n`<`, or `BETWEEN`, on columns with {ref}`character string types\\n<string-data-types>` like `CHAR` or `VARCHAR`. Equality predicates, such as\\n`IN` or `=`, and inequality predicates, such as `!=` on columns with\\ntextual types are pushed down. This ensures correctness of results since the\\nremote data source may sort strings differently than Trino.\\n\\nIn the following example, the predicate of the first query is not pushed down\\nsince `name` is a column of type `VARCHAR` and `>` is a range predicate.\\nThe other queries are pushed down.\\n\\n```\\n-- Not pushed down\\nSELECT * FROM nation WHERE name > 'CANADA';\\n-- Pushed down\\nSELECT * FROM nation WHERE name != 'CANADA';\\nSELECT * FROM nation WHERE name = 'CANADA';\\n```\\n\\nThere is experimental support to enable pushdown of range predicates on columns\\nwith character string types which can be enabled by setting the\\n`postgresql.experimental.enable-string-pushdown-with-collate` catalog\\nconfiguration property or the corresponding\\n`enable_string_pushdown_with_collate` session property to `true`.\\nEnabling this configuration will make the predicate of all the queries in the\\nabove example get pushed down.\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 27]\"}, {\"title\": \"Prometheus connector\", \"description\": null, \"content\": {\"Requirements\": \"To query Prometheus, you need:\\n\\n['Network access from the Trino coordinator and workers to the Prometheus\\\\nserver. The default port is 9090.', 'Prometheus version 2.15.1 or later.']\", \"Configuration\": \"Create `etc/catalog/example.properties` to mount the Prometheus connector as\\nthe `example` catalog, replacing the properties as appropriate:\\n\\n```\\nconnector.name=prometheus\\nprometheus.uri=http://localhost:9090\\nprometheus.query.chunk.size.duration=1d\\nprometheus.max.query.range.duration=21d\\nprometheus.cache.ttl=30s\\nprometheus.bearer.token.file=/path/to/bearer/token/file\\nprometheus.read-timeout=10s\\n```\", \"Configuration properties\": \"The following configuration properties are available:\\n\\n:::{list-table} Prometheus configuration properties\\n:widths: 30, 55, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`prometheus.uri`', 'Where to find Prometheus coordinator host.', '`http://localhost:9090`'], ['`prometheus.query.chunk.size.duration`', 'The duration of each query to Prometheus. \\\\nThe equivalent catalog session property is `query_chunk_size_duration`.', '`1d`'], ['`prometheus.max.query.range.duration`', 'Width of overall query to Prometheus, will be divided into\\\\n`prometheus.query.chunk.size.duration` queries. \\\\nThe equivalent catalog session property is `max_query_range_duration`.', '`21d`'], ['`prometheus.cache.ttl`', 'How long values from this config file are cached.', '`30s`'], ['`prometheus.read-timeout`', 'How much time a query to Prometheus has before timing out.', '`10s`'], ['`prometheus.auth.user`', 'Username for basic authentication.'], ['`prometheus.auth.password`', 'Password for basic authentication.'], ['`prometheus.auth.http.header.name`', 'Name of the header to use for authorization.', '`Authorization`'], ['`prometheus.bearer.token.file`', 'File holding bearer token if needed for access to Prometheus.'], ['`prometheus.read-timeout`', 'How much time a query to Prometheus has before timing out.', '`10s`'], ['`prometheus.case-insensitive-name-matching`', 'Match Prometheus metric names case insensitively.', '`false`'], ['`prometheus.http.additional-headers`', 'Additional headers to send to Prometheus endpoint. These headers\\\\nmust be comma-separated and delimited using `:`. For example,\\\\n`header1:value1,header2:value2` sends two headers `header1` and `header2`\\\\nwith the values as `value1` and `value2`. Escape comma (`,`) or colon(`:`)\\\\ncharacters in a header name or value with a backslash (`\\\\\\\\`).']]\\n\\n:::\", \"Not exhausting your Trino available heap\": \"The `prometheus.query.chunk.size.duration` and `prometheus.max.query.range.duration` are values to protect Trino from\\ntoo much data coming back from Prometheus. The `prometheus.max.query.range.duration` is the item of\\nparticular interest.\\n\\nOn a Prometheus instance that has been running for a while and depending\\non data retention settings, `21d` might be far too much. Perhaps `1h` might be a more reasonable setting.\\nIn the case of `1h` it might be then useful to set `prometheus.query.chunk.size.duration` to `10m`, dividing the\\nquery window into 6 queries each of which can be handled in a Trino split.\\n\\nPrimarily query issuers can limit the amount of data returned by Prometheus by taking\\nadvantage of `WHERE` clause limits on `TIMESTAMP`, setting an upper bound and lower bound that define\\na relatively small window. For example:\\n\\n```\\nSELECT * FROM example.default.up WHERE TIMESTAMP > (NOW() - INTERVAL '10' second);\\n```\\n\\nIf the query does not include a WHERE clause limit, these config\\nsettings are meant to protect against an unlimited query.\", \"Bearer token authentication\": \"Prometheus can be setup to require a Authorization header with every query. The value in\\n`prometheus.bearer.token.file` allows for a bearer token to be read from the configured file. This file\\nis optional and not required unless your Prometheus setup requires it. \\n`prometheus.auth.http.header.name` allows you to use a custom header name for bearer token. Default value is `Authorization`.\\n\\n(prometheus-type-mapping)=\", \"Type mapping\": \"Because Trino and Prometheus each support types that the other does not, this\\nconnector {ref}`modifies some types <type-mapping-overview>` when reading data.\\n\\nThe connector returns fixed columns that have a defined mapping to Trino types\\naccording to the following table:\\n\\n:::{list-table} Prometheus column to Trino type mapping\\n:widths: 50, 50\\n:header-rows: 1\\n\\n[['Prometheus column', 'Trino type'], ['`labels `', '`MAP(VARCHAR,VARCHAR) `'], ['`TIMESTAMP `', '`TIMESTAMP(3) WITH TIMEZONE `'], ['`value `', '`DOUBLE `\\\\n:::']]\\n\\nNo other types are supported.\\n\\nThe following example query result shows how the Prometheus `up` metric is\\nrepresented in Trino:\\n\\n```\\nSELECT * FROM example.default.up;\\n```\\n\\n```\\n labels | timestamp | value\\n--------------------------------------------------------+--------------------------------+-------\\n{instance=localhost:9090, job=prometheus, __name__=up} | 2022-09-01 06:18:54.481 +09:00 | 1.0\\n{instance=localhost:9090, job=prometheus, __name__=up} | 2022-09-01 06:19:09.446 +09:00 | 1.0\\n(2 rows)\\n```\\n\\n(prometheus-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in Prometheus.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 28]\"}, {\"title\": \"Redis connector\", \"description\": null, \"content\": {\"Requirements\": \"Requirements for using the connector in a catalog to connect to a Redis data\\nsource are:\\n\\n['Redis 5.0.14 or higher (Redis Cluster is not supported)', 'Network access, by default on port 6379, from the Trino coordinator and\\\\nworkers to Redis.']\", \"Configuration\": {\"Multiple Redis servers\": \"You can have as many catalogs as you need. If you have additional\\nRedis servers, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`.\"}, \"Configuration properties\": {\"`redis.table-names`\": \"Comma-separated list of all tables provided by this catalog. A table name\\ncan be unqualified (simple name) and is placed into the default schema\\n(see below), or qualified with a schema name (`<schema-name>.<table-name>`).\\n\\nFor each table defined, a table description file (see below) may\\nexist. If no table description file exists, the\\ntable only contains internal columns (see below).\\n\\nThis property is optional; the connector relies on the table description files\\nspecified in the `redis.table-description-dir` property.\", \"`redis.default-schema`\": \"Defines the schema which will contain all tables that were defined without\\na qualifying schema name.\\n\\nThis property is optional; the default is `default`.\", \"`redis.nodes`\": \"The `hostname:port` pair for the Redis server.\\n\\nThis property is required; there is no default.\\n\\nRedis Cluster is not supported.\", \"`redis.scan-count`\": \"The internal COUNT parameter for the Redis SCAN command when connector is using\\nSCAN to find keys for the data. This parameter can be used to tune performance\\nof the Redis connector.\\n\\nThis property is optional; the default is `100`.\", \"`redis.max-keys-per-fetch`\": \"The internal number of keys for the Redis MGET command and Pipeline HGETALL command\\nwhen connector is using these commands to find values of keys. This parameter can be\\nused to tune performance of the Redis connector.\\n\\nThis property is optional; the default is `100`.\", \"`redis.key-prefix-schema-table`\": \"If true, only keys prefixed with the `schema-name:table-name` are scanned\\nfor a table, and all other keys are filtered out. If false, all keys are\\nscanned.\\n\\nThis property is optional; the default is `false`.\", \"`redis.key-delimiter`\": \"The character used for separating `schema-name` and `table-name` when\\n`redis.key-prefix-schema-table` is `true`\\n\\nThis property is optional; the default is `:`.\", \"`redis.table-description-dir`\": \"References a folder within Trino deployment that holds one or more JSON\\nfiles, which must end with `.json` and contain table description files.\\n\\nNote that the table description files will only be used by the Trino coordinator\\nnode.\\n\\nThis property is optional; the default is `etc/redis`.\", \"`redis.table-description-cache-ttl`\": \"The Redis connector dynamically loads the table description files after waiting\\nfor the time specified by this property. Therefore, there is no need to update\\nthe `redis.table-names` property and restart the Trino service when adding,\\nupdating, or deleting a file end with `.json` to `redis.table-description-dir`\\nfolder.\\n\\nThis property is optional; the default is `5m`.\", \"`redis.hide-internal-columns`\": \"In addition to the data columns defined in a table description file, the\\nconnector maintains a number of additional columns for each table. If\\nthese columns are hidden, they can still be used in queries, but they do not\\nshow up in `DESCRIBE <table-name>` or `SELECT *`.\\n\\nThis property is optional; the default is `true`.\", \"`redis.database-index`\": \"The Redis database to query.\\n\\nThis property is optional; the default is `0`.\", \"`redis.user`\": \"The username for Redis server.\\n\\nThis property is optional; the default is `null`.\", \"`redis.password`\": \"The password for password-protected Redis server.\\n\\nThis property is optional; the default is `null`.\"}, \"Internal columns\": \"For each defined table, the connector maintains the following columns:\\n\\n| Column name | Type | Description |\\n| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\\n| `_key` | VARCHAR | Redis key. |\\n| `_value` | VARCHAR | Redis value corresponding to the key. |\\n| `_key_length` | BIGINT | Number of bytes in the key. |\\n| `_value_length` | BIGINT | Number of bytes in the value. |\\n| `_key_corrupt` | BOOLEAN | True if the decoder could not decode the key for this row. When true, data columns mapped from the key should be treated as invalid. |\\n| `_value_corrupt` | BOOLEAN | True if the decoder could not decode the message for this row. When true, data columns mapped from the value should be treated as invalid. |\\n\\nFor tables without a table definition file, the `_key_corrupt` and\\n`_value_corrupt` columns are `false`.\", \"Table definition files\": \"With the Redis connector it is possible to further reduce Redis key/value pairs into\\ngranular cells, provided the key/value string follows a particular format. This process\\ndefines new columns that can be further queried from Trino.\\n\\nA table definition file consists of a JSON definition for a table. The\\nname of the file can be arbitrary, but must end in `.json`.\\n\\n```\\n{\\n \\\"tableName\\\": ...,\\n \\\"schemaName\\\": ...,\\n \\\"key\\\": {\\n \\\"dataFormat\\\": ...,\\n \\\"fields\\\": [\\n ...\\n ]\\n },\\n \\\"value\\\": {\\n \\\"dataFormat\\\": ...,\\n \\\"fields\\\": [\\n ...\\n ]\\n }\\n}\\n```\\n\\n| Field | Required | Type | Description |\\n| ------------ | -------- | ----------- | --------------------------------------------------------------------------------- |\\n| `tableName` | required | string | Trino table name defined by this file. |\\n| `schemaName` | optional | string | Schema which will contain the table. If omitted, the default schema name is used. |\\n| `key` | optional | JSON object | Field definitions for data columns mapped to the value key. |\\n| `value` | optional | JSON object | Field definitions for data columns mapped to the value itself. |\\n\\nPlease refer to the [Kafka connector](/connector/kafka) page for the description of the `dataFormat` as well as various available decoders.\\n\\nIn addition to the above Kafka types, the Redis connector supports `hash` type for the `value` field which represent data stored in the Redis hash.\\n\\n```\\n{\\n \\\"tableName\\\": ...,\\n \\\"schemaName\\\": ...,\\n \\\"value\\\": {\\n \\\"dataFormat\\\": \\\"hash\\\",\\n \\\"fields\\\": [\\n ...\\n ]\\n }\\n}\\n```\", \"Type mapping\": {\"Row decoding\": \"A decoder is used to map data to table columns.\\n\\nThe connector contains the following decoders:\\n\\n['`raw`: Message is not interpreted; ranges of raw message bytes are mapped\\\\nto table columns.', '`csv`: Message is interpreted as comma separated message, and fields are\\\\nmapped to table columns.', '`json`: Message is parsed as JSON, and JSON fields are mapped to table\\\\ncolumns.', '`avro`: Message is parsed based on an Avro schema, and Avro fields are\\\\nmapped to table columns.']\\n\\n:::{note}\\nIf no table definition file exists for a table, the `dummy` decoder is\\nused, which does not expose any columns.\\n:::\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(redis-sql-support)=\"}, \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in Redis.\", \"Performance\": {\"Pushdown\": {\"Predicate pushdown support\": \"The connector supports pushdown of keys of `string` type only, the `zset`\\ntype is not supported. Key pushdown is not supported when multiple key fields\\nare defined in the table definition file.\\n\\nThe connector supports pushdown of equality predicates, such as `IN` or `=`.\\nInequality predicates, such as `!=`, and range predicates, such as `>`,\\n`<`, or `BETWEEN` are not pushed down.\\n\\nIn the following example, the predicate of the first query is not pushed down\\nsince `>` is a range predicate. The other queries are pushed down:\\n\\n```\\n-- Not pushed down\\nSELECT * FROM nation WHERE redis_key > 'CANADA';\\n-- Pushed down\\nSELECT * FROM nation WHERE redis_key = 'CANADA';\\nSELECT * FROM nation WHERE redis_key IN ('CANADA', 'POLAND');\\n```\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 29]\"}, {\"title\": \"Redshift connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Redshift, you need:\\n\\n['Network access from the Trino coordinator and workers to Redshift.\\\\nPort 5439 is the default port.']\", \"Configuration\": {\"Connection security\": \"If you have TLS configured with a globally-trusted certificate installed on your\\ndata source, you can enable TLS between your cluster and the data\\nsource by appending a parameter to the JDBC connection string set in the\\n`connection-url` catalog configuration property.\\n\\nFor example, on version 2.1 of the Redshift JDBC driver, TLS/SSL is enabled by\\ndefault with the `SSL` parameter. You can disable or further configure TLS\\nby appending parameters to the `connection-url` configuration property:\\n\\n```\\nconnection-url=jdbc:redshift://example.net:5439/database;SSL=TRUE;\\n```\\n\\nFor more information on TLS configuration options, see the [Redshift JDBC driver\\ndocumentation](https://docs.aws.amazon.com/redshift/latest/mgmt/jdbc20-configuration-options.html#jdbc20-ssl-option).\\n\\n```\\n```\", \"Multiple Redshift databases or clusters\": \"The Redshift connector can only access a single database within\\na Redshift cluster. Thus, if you have multiple Redshift databases,\\nor want to connect to multiple Redshift clusters, you must configure\\nmultiple instances of the Redshift connector.\\n\\nTo add another catalog, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For example,\\nif you name the property file `sales.properties`, Trino creates a\\ncatalog named `sales` using the configured connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n(redshift-fte-support)=\"}, \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\", \"Querying Redshift\": \"The Redshift connector provides a schema for every Redshift schema.\\nYou can see the available Redshift schemas by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a Redshift schema named `web`, you can view the tables\\nin this schema by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web` database\\nusing either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can access the `clicks` table in the `web` schema:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use that catalog\\nname instead of `example` in the above examples.\\n\\n(redshift-type-mapping)=\", \"Type mapping\": \"```\\n```\\n\\n(redshift-sql-support)=\", \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(redshift-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to Redshift, because the full query is pushed down and\\nprocessed in Redshift. This can be useful for accessing native features which\\nare not implemented in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\n```\\n```\\n\\nFor example, query the `example` catalog and select the top 10 nations by\\npopulation:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n TOP 10 *\\n FROM\\n tpch.nation\\n ORDER BY\\n population DESC'\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Parallel read via S3\": \"The connector supports the Redshift `UNLOAD` command to transfer data to Parquet\\nfiles on S3. This enables parallel read of the data in Trino instead of the\\ndefault, single-threaded JDBC-based connection to Redshift, used by the\\nconnector.\\n\\nConfigure the required S3 location with `redshift.unload-location` to enable the\\nparallel read. Parquet files are automatically removed with query completion.\\nThe Redshift cluster and the configured S3 bucket must use the same AWS region.\\n\\n:::{list-table} Parallel read configuration properties\\n:widths: 30, 60\\n:header-rows: 1\\n\\n[['Property value', 'Description'], ['`redshift.unload-location`', 'A writeable location in Amazon S3 in the same AWS region as the Redshift\\\\ncluster. Used for temporary storage during query processing using the\\\\n`UNLOAD` command from Redshift. To ensure cleanup even for failed automated\\\\nremoval, configure a life cycle policy to auto clean up the bucket\\\\nregularly.'], ['`redshift.unload-iam-role`', 'Optional. Fully specified ARN of the IAM Role attached to the Redshift\\\\ncluster to use for the `UNLOAD` command. The role must have read access to\\\\nthe Redshift cluster and write access to the S3 bucket. Defaults to use the\\\\ndefault IAM role attached to the Redshift cluster.']]\\n\\n:::\\n\\nUse the `unload_enabled` [catalog session property](/sql/set-session) to\\ndeactivate the parallel read during a client session for a specific query, and\\npotentially re-activate it again afterward.\\n\\nAdditionally, define further required [S3 configuration such as IAM key, role,\\nor region](/object-storage/file-system-s3), except `fs.native-s3.enabled`,\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 30]\"}, {\"title\": \"Removed\", \"description\": null, \"content\": {\"404 - Connector removed\": \"The connector you are trying to learn more about has been removed in a prior\\nTrino release. Refer to the [list of connectors](/connector) and [release\\nnotes](/release) for details.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 31]\"}, {\"title\": \"SingleStore connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to SingleStore, you need:\\n\\n['SingleStore version 7.8 or higher.', 'Network access from the Trino coordinator and workers to SingleStore. Port\\\\n3306 is the default port.']\\n\\n(singlestore-configuration)=\", \"Configuration\": {\"Connection security\": \"If you have TLS configured with a globally-trusted certificate installed on your\\ndata source, you can enable TLS between your cluster and the data\\nsource by appending a parameter to the JDBC connection string set in the\\n`connection-url` catalog configuration property.\\n\\nEnable TLS between your cluster and SingleStore by appending the `useSsl=true`\\nparameter to the `connection-url` configuration property:\\n\\n```\\nconnection-url=jdbc:singlestore://example.net:3306/?useSsl=true\\n```\\n\\nFor more information on TLS configuration options, see the [JDBC driver\\ndocumentation](https://docs.singlestore.com/db/latest/developer-resources/connect-with-application-development-tools/connect-with-java-jdbc/the-singlestore-jdbc-driver/#tls-).\", \"Multiple SingleStore servers\": \"You can have as many catalogs as you need, so if you have additional\\nSingleStore servers, simply add another properties file to `etc/catalog`\\nwith a different name (making sure it ends in `.properties`). For\\nexample, if you name the property file `sales.properties`, Trino\\nwill create a catalog named `sales` using the configured connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\"}, \"Querying SingleStore\": \"The SingleStore connector provides a schema for every SingleStore *database*.\\nYou can see the available SingleStore databases by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a SingleStore database named `web`, you can view the tables\\nin this database by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web`\\ndatabase using either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can access the `clicks` table in the `web` database:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n\\n(singlestore-type-mapping)=\", \"Type mapping\": {\"Singlestore to Trino type mapping\": \"The connector maps Singlestore types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} Singlestore to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Singlestore type', 'Trino type', 'Notes'], ['`BIT`', '`BOOLEAN`'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`TINYINT UNSIGNED`', '`SMALLINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`SMALLINT UNSIGNED`', '`INTEGER`'], ['`INTEGER`', '`INTEGER`'], ['`INTEGER UNSIGNED`', '`BIGINT`'], ['`BIGINT`', '`BIGINT`'], ['`BIGINT UNSIGNED`', '`DECIMAL(20, 0)`'], ['`DOUBLE`', '`DOUBLE`'], ['`REAL`', '`DOUBLE`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`', 'See [Singlestore DECIMAL type handling](singlestore-decimal-handling)'], ['`CHAR(n)`', '`CHAR(n)`'], ['`TINYTEXT`', '`VARCHAR(255)`'], ['`TEXT`', '`VARCHAR(65535)`'], ['`MEDIUMTEXT`', '`VARCHAR(16777215)`'], ['`LONGTEXT`', '`VARCHAR`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`LONGBLOB`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIME`', '`TIME(0)`'], ['`TIME(6)`', '`TIME(6)`'], ['`DATETIME`', '`TIMESTAMP(0)`'], ['`DATETIME(6)`', '`TIMESTAMP(6)`'], ['`JSON`', '`JSON`']]\\n\\n:::\\n\\nNo other types are supported.\", \"Trino to Singlestore type mapping\": \"The connector maps Trino types to the corresponding Singlestore types following\\nthis table:\\n\\n:::{list-table} Trino to Singlestore type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'Singlestore type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`DOUBLE`', '`DOUBLE`'], ['`REAL`', '`FLOAT`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`', 'See [Singlestore DECIMAL type handling](singlestore-decimal-handling)'], ['`CHAR(n)`', '`CHAR(n)`'], ['`VARCHAR(65535)`', '`TEXT`'], ['`VARCHAR(16777215)`', '`MEDIUMTEXT`'], ['`VARCHAR`', '`LONGTEXT`'], ['`VARCHAR(n)`', '`VARCHAR(n)`'], ['`VARBINARY`', '`LONGBLOB`'], ['`DATE`', '`DATE`'], ['`TIME(0)`', '`TIME`'], ['`TIME(6)`', '`TIME(6)`'], ['`TIMESTAMP(0)`', '`DATETIME`'], ['`TIMESTAMP(6)`', '`DATETIME(6)`'], ['`JSON`', '`JSON`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n(singlestore-decimal-handling)=\\n\\n```\\n```\\n\\n```\\n```\\n\\n(singlestore-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\"}, \"Performance\": {\"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['{ref}`join-pushdown`', '{ref}`limit-pushdown`', '{ref}`topn-pushdown`']\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 32]\"}, {\"title\": \"Snowflake connector\", \"description\": null, \"content\": {\"Configuration\": {\"Multiple Snowflake databases or accounts\": \"The Snowflake connector can only access a single database within\\na Snowflake account. Thus, if you have multiple Snowflake databases,\\nor want to connect to multiple Snowflake accounts, you must configure\\nmultiple instances of the Snowflake connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n% snowflake-type-mapping:\"}, \"Type mapping\": {\"Snowflake type to Trino type mapping\": \"The connector maps Snowflake types to the corresponding Trino types following\\nthis table:\\n\\n:::{list-table} Snowflake type to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Snowflake type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`INT`, `INTEGER`, `BIGINT`, `SMALLINT`, `TINYINT`, `BYTEINT`', '`DECIMAL(38,0)`', 'Synonymous with `NUMBER(38,0)`. See Snowflake\\\\n[data types for fixed point numbers](https://docs.snowflake.com/en/sql-reference/data-types-numeric#data-types-for-fixed-point-numbers)\\\\nfor more information.'], ['`FLOAT`, `FLOAT4`, `FLOAT8`', '`DOUBLE`', 'The names `FLOAT`, `FLOAT4`, and `FLOAT8` are for compatibility with other systems; Snowflake treats all three as\\\\n64-bit floating-point numbers. See Snowflake\\\\n[data types for floating point numbers](https://docs.snowflake.com/en/sql-reference/data-types-numeric#data-types-for-floating-point-numbers)\\\\nfor more information.'], ['`DOUBLE`, `DOUBLE PRECISION`, `REAL`', '`DOUBLE`', 'Synonymous with `FLOAT`. See Snowflake\\\\n[data types for floating point numbers](https://docs.snowflake.com/en/sql-reference/data-types-numeric#data-types-for-floating-point-numbers)\\\\nfor more information.'], ['`NUMBER`', '`DECIMAL`', 'Default precision and scale are (38,0).'], ['`DECIMAL`, `NUMERIC`', '`DECIMAL`', 'Synonymous with `NUMBER`. See Snowflake\\\\n[data types for fixed point numbers](https://docs.snowflake.com/en/sql-reference/data-types-numeric#data-types-for-fixed-point-numbers)\\\\nfor more information.'], ['`VARCHAR`', '`VARCHAR`'], ['`CHAR`, `CHARACTER`', '`VARCHAR`', 'Synonymous with `VARCHAR` except default length is `VARCHAR(1)`. See Snowflake\\\\n[String & Binary Data Types](https://docs.snowflake.com/en/sql-reference/data-types-text)\\\\nfor more information.'], ['`STRING`, `TEXT`', '`VARCHAR`', 'Synonymous with `VARCHAR`. See Snowflake\\\\n[String & Binary Data Types](https://docs.snowflake.com/en/sql-reference/data-types-text)\\\\nfor more information.'], ['`BINARY`', '`VARBINARY`'], ['`VARBINARY`', '`VARBINARY`', 'Synonymous with `BINARY`. See Snowflake\\\\n[String & Binary Data Types](https://docs.snowflake.com/en/sql-reference/data-types-text)\\\\nfor more information.'], ['`DATE`', '`DATE`'], ['`TIME`', '`TIME`'], ['`TIMESTAMP_NTZ`', '`TIMESTAMP`', 'TIMESTAMP with no time zone; time zone, if provided, is not stored. See Snowflake\\\\n[Date & Time Data Types](https://docs.snowflake.com/en/sql-reference/data-types-datetime)\\\\nfor more information.'], ['`DATETIME`', '`TIMESTAMP`', 'Alias for `TIMESTAMP_NTZ`. See Snowflake\\\\n[Date & Time Data Types](https://docs.snowflake.com/en/sql-reference/data-types-datetime)\\\\nfor more information.'], ['`TIMESTAMP`', '`TIMESTAMP`', 'Alias for one of the `TIMESTAMP` variations (`TIMESTAMP_NTZ` by default). This connector always sets `TIMESTAMP_NTZ` as the variant.'], ['`TIMESTAMP_TZ`', '`TIMESTAMP WITH TIME ZONE`', 'TIMESTAMP with time zone.\\\\n:::']]\\n\\nNo other types are supported.\", \"Trino type to Snowflake type mapping\": \"The connector maps Trino types to the corresponding Snowflake types following\\nthis table:\\n\\n:::{list-table} Trino type to Snowflake type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'Snowflake type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`NUMBER(3, 0)`'], ['`SMALLINT`', '`NUMBER(5, 0)`'], ['`INTEGER`', '`NUMBER(10, 0)`'], ['`BIGINT`', '`NUMBER(19, 0)`'], ['`REAL`', '`DOUBLE`'], ['`DOUBLE`', '`DOUBLE`'], ['`DECIMAL`', '`NUMBER`'], ['`VARCHAR`', '`VARCHAR`'], ['`CHAR`', '`VARCHAR`'], ['`VARBINARY`', '`BINARY`'], ['`VARBINARY`', '`VARBINARY`'], ['`DATE`', '`DATE`'], ['`TIME`', '`TIME`'], ['`TIMESTAMP`', '`TIMESTAMP_NTZ`'], ['`TIMESTAMP WITH TIME ZONE`', '`TIMESTAMP_TZ`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\n```\\n```\\n\\n(snowflake-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(snowflake-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to Snowflake, because the full query is pushed down and\\nprocessed in Snowflake. This can be useful for accessing native features which\\nare not available in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\nFind details about the SQL support of Snowflake that you can use in the query in\\nthe [Snowflake SQL Command\\nReference](https://docs.snowflake.com/en/sql-reference-commands), including\\n[PIVOT](https://docs.snowflake.com/en/sql-reference/constructs/pivot), [lateral\\njoins](https://docs.snowflake.com/en/sql-reference/constructs/join-lateral) and\\nother statements and functions.\\n\\n```\\n```\\n\\nAs a simple example, query the `example` catalog and select an entire table:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\\n\\nAs a practical example, you can use the Snowflake SQL support for\\n[PIVOT](https://docs.snowflake.com/en/sql-reference/constructs/pivot) to pivot\\non all distinct column values automatically with a dynamic pivot.\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => '\\n SELECT *\\n FROM quarterly_sales\\n PIVOT(SUM(amount) FOR quarter IN (ANY ORDER BY quarter))\\n ORDER BY empid;\\n '\\n )\\n );\\n```\\n\\n```\\n```\"}}, \"Performance\": {\"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['[](limit-pushdown)', '[](topn-pushdown)']\\n\\n{ref}`Aggregate pushdown <aggregation-pushdown>` for the following functions:\\n\\n['{func}`avg`', '{func}`count`', '{func}`max`', '{func}`min`', '{func}`sum`', '{func}`stddev`', '{func}`stddev_pop`', '{func}`stddev_samp`', '{func}`variance`', '{func}`var_pop`', '{func}`var_samp`', '{func}`covar_pop`', '{func}`covar_samp`', '{func}`corr`', '{func}`regr_intercept`', '{func}`regr_slope`']\\n\\n```\\n```\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 33]\"}, {\"title\": \"SQL Server connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to SQL Server, you need:\\n\\n['SQL Server 2019 or higher, or Azure SQL Database.', 'Network access from the Trino coordinator and workers to SQL Server.\\\\nPort 1433 is the default port.']\", \"Configuration\": {\"Connection security\": \"The JDBC driver, and therefore the connector, automatically use Transport Layer\\nSecurity (TLS) encryption and certificate validation. This requires a suitable\\nTLS certificate configured on your SQL Server database host.\\n\\nIf you do not have the necessary configuration established, you can disable\\nencryption in the connection string with the `encrypt` property:\\n\\n```\\nconnection-url=jdbc:sqlserver://<host>:<port>;databaseName=<databaseName>;encrypt=false\\n```\\n\\nFurther parameters like `trustServerCertificate`, `hostNameInCertificate`,\\n`trustStore`, and `trustStorePassword` are details in the [TLS section of\\nSQL Server JDBC driver documentation](https://docs.microsoft.com/sql/connect/jdbc/using-ssl-encryption).\\n\\n```\\n```\", \"Multiple SQL Server databases or servers\": \"The SQL Server connector can only access a single SQL Server database\\nwithin a single catalog. Thus, if you have multiple SQL Server databases,\\nor want to connect to multiple SQL Server instances, you must configure\\nmultiple instances of the SQL Server connector.\\n\\nTo add another catalog, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`. For example,\\nif you name the property file `sales.properties`, Trino creates a\\ncatalog named `sales` using the configured connector.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\", \"Specific configuration properties\": \"The SQL Server connector supports additional catalog properties to configure the\\nbehavior of the connector and the issues queries to the database.\\n\\n:::{list-table}\\n:widths: 45, 55\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`sqlserver.snapshot-isolation.disabled`', 'Control the automatic use of snapshot isolation for transactions issued by\\\\nTrino in SQL Server. Defaults to `false`, which means that snapshot\\\\nisolation is enabled.\\\\n:::']]\\n\\n```\\n```\\n\\n(sqlserver-fte-support)=\", \"Fault-tolerant execution support\": \"The connector supports {doc}`/admin/fault-tolerant-execution` of query\\nprocessing. Read and write operations are both supported with any retry policy.\"}, \"Querying SQL Server\": \"The SQL Server connector provides access to all schemas visible to the specified\\nuser in the configured database. For the following examples, assume the SQL\\nServer catalog is `example`.\\n\\nYou can see the available schemas by running `SHOW SCHEMAS`:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\nIf you have a schema named `web`, you can view the tables\\nin this schema by running `SHOW TABLES`:\\n\\n```\\nSHOW TABLES FROM example.web;\\n```\\n\\nYou can see a list of the columns in the `clicks` table in the `web` database\\nusing either of the following:\\n\\n```\\nDESCRIBE example.web.clicks;\\nSHOW COLUMNS FROM example.web.clicks;\\n```\\n\\nFinally, you can query the `clicks` table in the `web` schema:\\n\\n```\\nSELECT * FROM example.web.clicks;\\n```\\n\\nIf you used a different name for your catalog properties file, use\\nthat catalog name instead of `example` in the above examples.\\n\\n(sqlserver-type-mapping)=\", \"Type mapping\": {\"SQL Server type to Trino type mapping\": \"The connector maps SQL Server types to the corresponding Trino types following this table:\\n\\n:::{list-table} SQL Server type to Trino type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['SQL Server database type', 'Trino type', 'Notes'], ['`BIT`', '`BOOLEAN`'], ['`TINYINT`', '`SMALLINT`', 'SQL Server `TINYINT` is actually `unsigned TINYINT`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`DOUBLE PRECISION`', '`DOUBLE`'], ['`FLOAT[(n)]`', '`REAL` or `DOUBLE`', 'See [](sqlserver-numeric-mapping)'], ['`REAL`', '`REAL`'], ['`DECIMAL[(p[, s])]`, `NUMERIC[(p[, s])]`', '`DECIMAL(p, s)`'], ['`CHAR[(n)]`', '`CHAR(n)`', '`1 <= n <= 8000`'], ['`NCHAR[(n)]`', '`CHAR(n)`', '`1 <= n <= 4000`'], ['`VARCHAR[(n | max)]`, `NVARCHAR[(n | max)]`', '`VARCHAR(n)`', '`1 <= n <= 8000`, `max = 2147483647`'], ['`TEXT`', '`VARCHAR(2147483647)`'], ['`NTEXT`', '`VARCHAR(1073741823)`'], ['`VARBINARY[(n | max)]`', '`VARBINARY`', '`1 <= n <= 8000`, `max = 2147483647`'], ['`DATE`', '`DATE`'], ['`TIME[(n)]`', '`TIME(n)`', '`0 <= n <= 7`'], ['`DATETIME2[(n)]`', '`TIMESTAMP(n)`', '`0 <= n <= 7`'], ['`SMALLDATETIME`', '`TIMESTAMP(0)`'], ['`DATETIMEOFFSET[(n)]`', '`TIMESTAMP(n) WITH TIME ZONE`', '`0 <= n <= 7`\\\\n:::']]\", \"Trino type to SQL Server type mapping\": \"The connector maps Trino types to the corresponding SQL Server types following this table:\\n\\n:::{list-table} Trino type to SQL Server type mapping\\n:widths: 30, 30, 40\\n:header-rows: 1\\n\\n[['Trino type', 'SQL Server type', 'Notes'], ['`BOOLEAN`', '`BIT`'], ['`TINYINT`', '`TINYINT`', 'Trino only supports writing values belonging to `[0, 127]`'], ['`SMALLINT`', '`SMALLINT`'], ['`INTEGER`', '`INTEGER`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`REAL`'], ['`DOUBLE`', '`DOUBLE PRECISION`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`'], ['`CHAR(n)`', '`NCHAR(n)` or `NVARCHAR(max)`', 'See [](sqlserver-character-mapping)'], ['`VARCHAR(n)`', '`NVARCHAR(n)` or `NVARCHAR(max)`', 'See [](sqlserver-character-mapping)'], ['`VARBINARY`', '`VARBINARY(max)`'], ['`DATE`', '`DATE`'], ['`TIME(n)`', '`TIME(n)`', '`0 <= n <= 7`'], ['`TIMESTAMP(n)`', '`DATETIME2(n)`', '`0 <= n <= 7`\\\\n:::']]\\n\\nComplete list of [SQL Server data types](https://msdn.microsoft.com/library/ms187752.aspx).\\n\\n(sqlserver-numeric-mapping)=\", \"Numeric type mapping\": \"For SQL Server `FLOAT[(n)]`:\\n\\n['If `n` is not specified maps to Trino `Double`', 'If `1 <= n <= 24` maps to Trino `REAL`', 'If `24 < n <= 53` maps to Trino `DOUBLE`']\\n\\n(sqlserver-character-mapping)=\", \"Character type mapping\": \"For Trino `CHAR(n)`:\\n\\n['If `1 <= n <= 4000` maps SQL Server `NCHAR(n)`', 'If `n > 4000` maps SQL Server `NVARCHAR(max)`']\\n\\nFor Trino `VARCHAR(n)`:\\n\\n['If `1 <= n <= 4000` maps SQL Server `NVARCHAR(n)`', 'If `n > 4000` maps SQL Server `NVARCHAR(max)`']\\n\\n```\\n```\\n\\n(sqlserver-sql-support)=\"}, \"SQL support\": {\"Procedures\": \"```\\n```\\n\\n```\\n```\\n\\n(sqlserver-table-functions)=\", \"Table functions\": {\"`query(varchar) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to SQL Server, because the full query is pushed down and\\nprocessed in SQL Server. This can be useful for accessing native features which\\nare not implemented in Trino or for improving query performance in situations\\nwhere running a query natively may be faster.\\n\\n```\\n```\\n\\nFor example, query the `example` catalog and select the top 10 percent of\\nnations by population:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'SELECT\\n TOP(10) PERCENT *\\n FROM\\n tpch.nation\\n ORDER BY\\n population DESC'\\n )\\n );\\n```\\n\\n(sqlserver-procedure-function)=\"}, \"`procedure(varchar) -> table`\": \"The `procedure` function allows you to run stored procedures on the underlying\\ndatabase directly. It requires syntax native to SQL Server, because the full query\\nis pushed down and processed in SQL Server. In order to use this table function set\\n`sqlserver.stored-procedure-table-function-enabled` to `true`.\\n\\n:::{note}\\nThe `procedure` function does not support running StoredProcedures that return multiple statements,\\nuse a non-select statement, use output parameters, or use conditional statements.\\n:::\\n\\n:::{warning}\\nThis feature is experimental only. The function has security implication and syntax might change and\\nbe backward incompatible.\\n:::\\n\\nThe follow example runs the stored procedure `employee_sp` in the `example` catalog and the\\n`example_schema` schema in the underlying SQL Server database:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.procedure(\\n query => 'EXECUTE example_schema.employee_sp'\\n )\\n );\\n```\\n\\nIf the stored procedure `employee_sp` requires any input\\nappend the parameter value to the procedure statement:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.procedure(\\n query => 'EXECUTE example_schema.employee_sp 0'\\n )\\n );\\n```\\n\\n```\\n```\"}, \"Performance\": {\"Table statistics\": \"The SQL Server connector can use {doc}`table and column statistics\\n</optimizer/statistics>` for {doc}`cost based optimizations\\n</optimizer/cost-based-optimizations>`, to improve query processing performance\\nbased on the actual data in the data source.\\n\\nThe statistics are collected by SQL Server and retrieved by the connector.\\n\\nThe connector can use information stored in single-column statistics. SQL Server\\nDatabase can automatically create column statistics for certain columns. If\\ncolumn statistics are not created automatically for a certain column, you can\\ncreate them by executing the following statement in SQL Server Database.\\n\\n```\\nCREATE STATISTICS example_statistics_name ON table_schema.table_name (column_name);\\n```\\n\\nSQL Server Database routinely updates the statistics. In some cases, you may\\nwant to force statistics update (e.g. after defining new column statistics or\\nafter changing data in the table). You can do that by executing the following\\nstatement in SQL Server Database.\\n\\n```\\nUPDATE STATISTICS table_schema.table_name;\\n```\\n\\nRefer to SQL Server documentation for information about options, limitations and\\nadditional considerations.\\n\\n(sqlserver-pushdown)=\", \"Pushdown\": {\"Predicate pushdown support\": \"The connector supports pushdown of predicates on `VARCHAR` and `NVARCHAR`\\ncolumns if the underlying columns in SQL Server use a case-sensitive [collation](https://learn.microsoft.com/en-us/sql/relational-databases/collations/collation-and-unicode-support?view=sql-server-ver16).\\n\\nThe following operators are pushed down:\\n\\n['`=`', '`<>`', '`IN`', '`NOT IN`']\\n\\nTo ensure correct results, operators are not pushed down for columns using a\\ncase-insensitive collation.\\n\\n(sqlserver-bulk-insert)=\"}, \"Bulk insert\": \"You can optionally use the [bulk copy API](https://docs.microsoft.com/sql/connect/jdbc/use-bulk-copy-api-batch-insert-operation)\\nto drastically speed up write operations.\\n\\nEnable bulk copying and a lock on the destination table to meet [minimal\\nlogging requirements](https://docs.microsoft.com/sql/relational-databases/import-export/prerequisites-for-minimal-logging-in-bulk-import).\\n\\nThe following table shows the relevant catalog configuration properties and\\ntheir default values:\\n\\n:::{list-table} Bulk load properties\\n:widths: 30, 60, 10\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`sqlserver.bulk-copy-for-write.enabled`', 'Use the SQL Server bulk copy API for writes. The corresponding catalog\\\\nsession property is `bulk_copy_for_write`.', '`false`'], ['`sqlserver.bulk-copy-for-write.lock-destination-table`', 'Obtain a bulk update lock on the destination table for write operations. The\\\\ncorresponding catalog session property is\\\\n`bulk_copy_for_write_lock_destination_table`. Setting is only used when\\\\n`bulk-copy-for-write.enabled=true`.', '`false`\\\\n:::']]\\n\\nLimitations:\\n\\n['Column names with leading and trailing spaces are not supported.']\"}, \"Data compression\": \"You can specify the [data compression policy for SQL Server tables](https://docs.microsoft.com/sql/relational-databases/data-compression/data-compression)\\nwith the `data_compression` table property. Valid policies are `NONE`, `ROW` or `PAGE`.\\n\\nExample:\\n\\n```\\nCREATE TABLE example_schema.scientists (\\n recordkey VARCHAR,\\n name VARCHAR,\\n age BIGINT,\\n birthday DATE\\n)\\nWITH (\\n data_compression = 'ROW'\\n);\\n```\"}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 34]\"}, {\"title\": \"System connector\", \"description\": null, \"content\": {\"Configuration\": \"The System connector doesn't need to be configured: it is automatically\\navailable via a catalog named `system`.\", \"Using the System connector\": \"List the available system schemas:\\n\\n```\\nSHOW SCHEMAS FROM system;\\n```\\n\\nList the tables in one of the schemas:\\n\\n```\\nSHOW TABLES FROM system.runtime;\\n```\\n\\nQuery one of the tables:\\n\\n```\\nSELECT * FROM system.runtime.nodes;\\n```\\n\\nKill a running query:\\n\\n```\\nCALL system.runtime.kill_query(query_id => '20151207_215727_00146_tx3nr', message => 'Using too many resources');\\n```\", \"System connector tables\": {\"`metadata.catalogs`\": \"The catalogs table contains the list of available catalogs.\", \"`metadata.schema_properties`\": \"The schema properties table contains the list of available properties\\nthat can be set when creating a new schema.\", \"`metadata.table_properties`\": \"The table properties table contains the list of available properties\\nthat can be set when creating a new table.\\n\\n(system-metadata-materialized-views)=\", \"`metadata.materialized_views`\": \"The materialized views table contains the following information about all\\n{ref}`materialized views <sql-materialized-view-management>`:\\n\\n:::{list-table} Metadata for materialized views\\n:widths: 30, 70\\n:header-rows: 1\\n\\n[['Column', 'Description'], ['`catalog_name`', 'Name of the catalog containing the materialized view.'], ['`schema_name`', 'Name of the schema in `catalog_name` containing the materialized view.'], ['`name`', 'Name of the materialized view.'], ['`storage_catalog`', 'Name of the catalog used for the storage table backing the materialized\\\\nview.'], ['`storage_schema`', 'Name of the schema in `storage_catalog` used for the storage table backing\\\\nthe materialized view.'], ['`storage_table`', 'Name of the storage table backing the materialized view.'], ['`freshness`', 'Freshness of data in the storage table. Queries on the materialized view\\\\naccess the storage table if not `STALE`, otherwise the `definition` is used\\\\nto access the underlying data in the source tables.'], ['`last_fresh_time`', 'Date and time of the last refresh of the materialized view.'], ['`comment`', 'User supplied text about the materialized view.'], ['`definition`', 'SQL query that defines the data provided by the materialized view.\\\\n:::']]\", \"`metadata.materialized_view_properties`\": \"The materialized view properties table contains the list of available properties\\nthat can be set when creating a new materialized view.\", \"`metadata.table_comments`\": \"The table comments table contains the list of table comment.\", \"`runtime.nodes`\": \"The nodes table contains the list of visible nodes in the Trino\\ncluster along with their status.\\n\\n(optimizer-rule-stats)=\", \"`runtime.optimizer_rule_stats`\": \"The `optimizer_rule_stats` table contains the statistics for optimizer\\nrule invocations during the query planning phase. The statistics are\\naggregated over all queries since the server start-up. The table contains\\ninformation about invocation frequency, failure rates and performance for\\noptimizer rules. For example, you can look at the multiplication of columns\\n`invocations` and `average_time` to get an idea about which rules\\ngenerally impact query planning times the most.\", \"`runtime.queries`\": \"The queries table contains information about currently and recently\\nrunning queries on the Trino cluster. From this table you can find out\\nthe original query SQL text, the identity of the user who ran the query,\\nand performance information about the query, including how long the query\\nwas queued and analyzed.\", \"`runtime.tasks`\": \"The tasks table contains information about the tasks involved in a\\nTrino query, including where they were executed, and how many rows\\nand bytes each task processed.\", \"`runtime.transactions`\": \"The transactions table contains the list of currently open transactions\\nand related metadata. This includes information such as the create time,\\nidle time, initialization parameters, and accessed catalogs.\"}, \"System connector procedures\": \":::{function} runtime.kill_query(query_id, message)\\n\\nKill the query identified by `query_id`. The query failure message includes the\\nspecified `message`. `message` is optional.\\n\\n:::\\n\\n(system-type-mapping)=\", \"Type mapping\": \"Trino supports all data types used within the System schemas so no mapping\\nis required.\\n\\n(system-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access Trino system\\ndata and metadata.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 35]\"}, {\"title\": \"Thrift connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to your custom servers with the Thrift protocol, you need:\\n\\n['Network access from the Trino coordinator and workers to the Thrift servers.', 'A {ref}`trino-thrift-service` for your system.']\", \"Configuration\": {\"Multiple Thrift systems\": \"You can have as many catalogs as you need, so if you have additional\\nThrift systems to connect to, simply add another properties file to `etc/catalog`\\nwith a different name, making sure it ends in `.properties`.\"}, \"Configuration properties\": {\"`trino.thrift.client.addresses`\": \"Comma-separated list of thrift servers in the form of `host:port`. For example:\\n\\n```\\ntrino.thrift.client.addresses=192.0.2.3:7777,192.0.2.4:7779\\n```\\n\\nThis property is required; there is no default.\", \"`trino-thrift.max-response-size`\": \"Maximum size of a data response that the connector accepts. This value is sent\\nby the connector to the Thrift server when requesting data, allowing it to size\\nthe response appropriately.\\n\\nThis property is optional; the default is `16MB`.\", \"`trino-thrift.metadata-refresh-threads`\": \"Number of refresh threads for metadata cache.\\n\\nThis property is optional; the default is `1`.\\n\\n(trino-thrift-service)=\"}, \"TrinoThriftService implementation\": \"The following IDL describes the `TrinoThriftService` that must be implemented:\\n\\n```\\n:language: thrift\\n```\\n\\n(thrift-type-mapping)=\", \"Type mapping\": \"The Thrift service defines data type support and mappings to Trino data types.\\n\\n(thrift-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in your Thrift service.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 36]\"}, {\"title\": \"TPC-DS connector\", \"description\": null, \"content\": {\"Configuration\": \"To configure the TPC-DS connector, create a catalog properties file\\n`etc/catalog/example.properties` with the following contents:\\n\\n```\\nconnector.name=tpcds\\n```\", \"TPC-DS schemas\": \"The TPC-DS connector supplies several schemas:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\n```\\n Schema\\n--------------------\\n information_schema\\n sf1\\n sf10\\n sf100\\n sf1000\\n sf10000\\n sf100000\\n sf300\\n sf3000\\n sf30000\\n tiny\\n(11 rows)\\n```\\n\\nIgnore the standard schema `information_schema`, which exists in every\\ncatalog, and is not directly provided by the TPC-DS connector.\\n\\nEvery TPC-DS schema provides the same set of tables. Some tables are\\nidentical in all schemas. The *scale factor* of the tables in a particular\\nschema is determined from the schema name. For example, the schema\\n`sf1` corresponds to scale factor `1` and the schema `sf300`\\ncorresponds to scale factor `300`. Every unit in the scale factor\\ncorresponds to a gigabyte of data. For example, for scale factor `300`,\\na total of `300` gigabytes are generated. The `tiny` schema is an\\nalias for scale factor `0.01`, which is a very small data set useful for\\ntesting.\\n\\n(tpcds-type-mapping)=\", \"Type mapping\": \"Trino supports all data types used within the TPC-DS schemas so no mapping is\\nrequired.\\n\\n(tpcds-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in the TPC-DS dataset.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 37]\"}, {\"title\": \"TPC-H connector\", \"description\": null, \"content\": {\"Configuration\": \"To configure the TPC-H connector, create a catalog properties file\\n`etc/catalog/example.properties` with the following contents:\\n\\n```\\nconnector.name=tpch\\n```\\n\\nIn the TPC-H specification, each column is assigned a prefix based on its\\ncorresponding table name, such as `l_` for the `lineitem` table. By default, the\\nTPC-H connector simplifies column names by excluding these prefixes with the\\ndefault of `tpch.column-naming` to `SIMPLIFIED`. To use the long, standard\\ncolumn names, use the configuration in the catalog properties file:\\n\\n```\\ntpch.column-naming=STANDARD\\n```\", \"TPC-H schemas\": \"The TPC-H connector supplies several schemas:\\n\\n```\\nSHOW SCHEMAS FROM example;\\n```\\n\\n```\\n Schema\\n--------------------\\n information_schema\\n sf1\\n sf100\\n sf1000\\n sf10000\\n sf100000\\n sf300\\n sf3000\\n sf30000\\n tiny\\n(11 rows)\\n```\\n\\nIgnore the standard schema `information_schema`, which exists in every\\ncatalog, and is not directly provided by the TPC-H connector.\\n\\nEvery TPC-H schema provides the same set of tables. Some tables are\\nidentical in all schemas. Other tables vary based on the *scale factor*,\\nwhich is determined based on the schema name. For example, the schema\\n`sf1` corresponds to scale factor `1` and the schema `sf300`\\ncorresponds to scale factor `300`. The TPC-H connector provides an\\ninfinite number of schemas for any scale factor, not just the few common\\nones listed by `SHOW SCHEMAS`. The `tiny` schema is an alias for scale\\nfactor `0.01`, which is a very small data set useful for testing.\\n\\n(tpch-type-mapping)=\", \"Type mapping\": \"Trino supports all data types used within the TPC-H schemas so no mapping\\nis required.\\n\\n(tpch-sql-support)=\", \"SQL support\": \"The connector provides {ref}`globally available <sql-globally-available>` and\\n{ref}`read operation <sql-read-operations>` statements to access data and\\nmetadata in the TPC-H dataset.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 38]\"}, {\"title\": \"Vertica connector\", \"description\": null, \"content\": {\"Requirements\": \"To connect to Vertica, you need:\\n\\n['Vertica 11.x or higher.', 'Network access from the coordinator and workers to the Vertica server.\\\\nPort 5433 is the default port.']\", \"Configuration\": \"Create a catalog properties file in `etc/catalog` named `example.properties` to\\naccess the configured Vertica database in the `example` catalog. Replace example\\nwith your database name or some other descriptive name of the catalog. Configure\\nthe usage of the connector by specifying the name `vertica` and replace the\\nconnection properties as appropriate for your setup.\\n\\n```\\nconnector.name=vertica\\nconnection-url=jdbc:vertica://example.net:5433/test_db\\nconnection-user=root\\nconnection-password=secret\\n```\\n\\nThe `connection-user` and `connection-password` are typically required and\\ndetermine the user credentials for the connection, often a service user. You can\\nuse [secrets](/security/secrets) to avoid actual values in the catalog\\nproperties files.\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\\n\\n```\\n```\", \"Type mapping\": {\"Vertica to Trino type mapping\": \"The connector maps Vertica types to the corresponding Trino types according to\\nthe following table:\\n\\n:::{list-table} Vertica to Trino type mapping\\n:widths: 35, 25, 40\\n:header-rows: 1\\n\\n[['Vertica type', 'Trino type', 'Notes'], ['`BOOLEAN`', '`BOOLEAN`'], ['`BIGINT`', '`BIGINT`', 'Vertica treats TINYINT, SMALLINT, INTEGER, and BIGINT as synonyms for the\\\\nsame 64-bit BIGINT data type'], ['`DOUBLE PRECISION (FLOAT)`', '`DOUBLE`', 'Vertica treats FLOAT and REAL as the same 64-bit IEEE FLOAT'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`'], ['`CHAR, CHAR(n)`', '`CHAR, CHAR(n)`'], ['`VARCHAR`, `LONG VARCHAR`, `VARCHAR(n)`, `LONG VARCHAR(n)`', '`VARCHAR(n)`'], ['`VARBINARY`, `LONG VARBINARY`, `VARBINARY(n)`, `LONG VARBINARY(n)`', '`VARBINARY(n)`'], ['`DATE`', '`DATE`']]\\n\\n:::\\n\\nNo other types are supported.\\n\\nUnsupported Vertica types can be converted to `VARCHAR` with the\\n`vertica.unsupported_type_handling` session property. The default value for\\nthis property is `IGNORE`.\\n\\n```\\nSET SESSION vertica.unsupported_type_handling='CONVERT_TO_VARCHAR';\\n```\", \"Trino to Vertica type mapping\": \"The connector maps Trino types to the corresponding Vertica types according to\\nthe following table:\\n\\n:::{list-table} Trino to Vertica type mapping\\n:widths: 50, 50\\n:header-rows: 1\\n\\n[['Trino type', 'Vertica type'], ['`BOOLEAN`', '`BOOLEAN`'], ['`TINYINT`', '`BIGINT`'], ['`SMALLINT`', '`BIGINT`'], ['`INTEGER`', '`BIGINT`'], ['`BIGINT`', '`BIGINT`'], ['`REAL`', '`DOUBLE PRECISION`'], ['`DOUBLE`', '`DOUBLE PRECISION`'], ['`DECIMAL(p, s)`', '`DECIMAL(p, s)`'], ['`CHAR`', '`CHAR`'], ['`VARCHAR`', '`VARCHAR`'], ['`VARBINARY`', '`VARBINARY`'], ['`DATE`', '`DATE`\\\\n:::']]\\n\\nNo other types are supported.\\n\\n```\\n```\\n\\n(vertica-sql-support)=\"}, \"SQL support\": \"The connector provides read and write access to data and metadata in Vertica. In\\naddition to the [globally available](sql-globally-available) and [read\\noperation](sql-read-operations) statements, the connector supports the following\\nfeatures:\\n\\n['[](sql-data-management)', '[](/sql/create-table)', '[](/sql/create-table-as)', '[](/sql/drop-table)', '[](/sql/alter-table) excluding `DROP COLUMN`, see also [](vertica-alter-table)', '[](/sql/create-schema)', '[](/sql/drop-schema)', '[](vertica-table-functions)']\\n\\n(vertica-alter-table)=\\n\\n```\\n```\\n\\n(vertica-table-functions)=\", \"Table functions\": {\"`query(VARCHAR) -> table`\": \"The `query` function allows you to query the underlying database directly. It\\nrequires syntax native to the data source, because the full query is pushed down\\nand processed in the data source. This can be useful for accessing native\\nfeatures or for improving query performance in situations where running a query\\nnatively may be faster.\\n\\nThe `query` table function is available in the `system` schema of any\\ncatalog that uses the Vertica connector, such as `example`. The\\nfollowing example passes `myQuery` to the data source. `myQuery` has to be a\\nvalid query for the data source, and is required to return a table as a result:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n example.system.query(\\n query => 'myQuery'\\n )\\n );\\n```\\n\\n```\\n```\"}, \"Performance\": {\"Pushdown\": \"The connector supports pushdown for a number of operations:\\n\\n['[](join-pushdown)', '[](limit-pushdown)']\\n\\n```\\n```\", \"Table statistics\": \"The [cost-based optimizer](/optimizer/cost-based-optimizations) can use table\\nstatistics from the Vertica database to improve query performance.\\n\\nSupport for table statistics is disabled by default. You can enable it with the\\ncatalog property `statistics.enabled` set to `true`. In addition, the\\n`connection-user` configured in the catalog must have superuser permissions in\\nVertica to gather and populate statistics.\\n\\nYou can view statistics using [](/sql/show-stats).\"}}, \"metadata\": {\"myst\": {\"substitutions\": {\"default_domain_compaction_threshold\": \"`256`\"}}}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20, \\\"subpages\\\", 39]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 20]\"}, {\"title\": \"Develop\", \"description\": \"Documentation section: develop\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/develop\"}, \"subpages\": [{\"title\": \"Certificate authenticator\", \"description\": null, \"content\": {\"Implementation\": \"`CertificateAuthenticatorFactory` is responsible for creating a\\n`CertificateAuthenticator` instance. It also defines the name of this\\nauthenticator which is used by the administrator in a Trino configuration.\\n\\n`CertificateAuthenticator` contains a single method, `authenticate()`,\\nwhich authenticates the client certificate and returns a `Principal`, which is then\\nauthorized by the {doc}`system-access-control`.\\n\\nThe implementation of `CertificateAuthenticatorFactory` must be wrapped\\nas a plugin and installed on the Trino cluster.\", \"Configuration\": \"After a plugin that implements `CertificateAuthenticatorFactory` has been\\ninstalled on the coordinator, it is configured using an\\n`etc/certificate-authenticator.properties` file. All the\\nproperties other than `certificate-authenticator.name` are specific to the\\n`CertificateAuthenticatorFactory` implementation.\\n\\nThe `certificate-authenticator.name` property is used by Trino to find a\\nregistered `CertificateAuthenticatorFactory` based on the name returned by\\n`CertificateAuthenticatorFactory.getName()`. The remaining properties are\\npassed as a map to `CertificateAuthenticatorFactory.create()`.\\n\\nExample configuration file:\\n\\n```\\ncertificate-authenticator.name=custom\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\\n\\nAdditionally, the coordinator must be configured to use certificate authentication\\nand have HTTPS enabled (or HTTPS forwarding enabled).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 0]\"}, {\"title\": \"Trino client REST API\", \"description\": null, \"content\": {\"HTTP methods\": [\"A `POST` to `/v1/statement` runs the query string in the `POST` body,\\nand returns a JSON document containing the query results. If there are more\\nresults, the JSON document contains a `nextUri` URL attribute.\", \"A `GET` to the `nextUri` attribute returns the next batch of query results.\", \"A `DELETE` to `nextUri` terminates a running query.\"], \"Overview of query processing\": \"A Trino client request is initiated by an HTTP `POST` to the endpoint\\n`/v1/statement`, with a `POST` body consisting of the SQL query string. The\\ncaller may set various [](client-request-headers). The headers are only\\nrequired in the initial `POST` request, and not when following the `nextUri`\\nlinks.\\n\\nIf the client request returns an HTTP 502, 503, or 504, that means there was\\nan intermittent problem processing request and the client should try again in\\n50-100 ms. Trino does not generate those codes by itself, but those can be\\ngenerated by load balancers in front of Trino. \\n\\nAdditionally, if the request returns a 429 status code, the client should \\nretry the request using the `Retry-After` header value provided. \\n\\nAny HTTP status other than 502, 503, 504 or 200 means that query processing \\nhas failed.\\n\\nThe `/v1/statement` `POST` request returns a JSON document of type\\n`QueryResults`, as well as a collection of response headers. The `QueryResults`\\ndocument contains an `error` field of type `QueryError` if the query has failed,\\nand if that object is not present, the query succeeded. Important aspects of\\n`QueryResults` are documented in the following sections.\\n\\nIf the `data` field of the JSON document is set, it contains a list of the rows\\nof data. The `columns` field is set to a list of the names and types of the\\ncolumns returned by the query. Most of the response headers are treated like\\nbrowser cookies by the client, and echoed back as request headers in subsequent\\nclient requests, as documented below.\\n\\nIf the JSON document returned by the `POST` to `/v1/statement` does not contain\\na `nextUri` link, the query has completed, either successfully or\\nunsuccessfully, and no additional requests need to be made. If the `nextUri`\\nlink is present in the document, there are more query results to be fetched. The\\nclient should loop executing a `GET` request to the `nextUri` returned in the\\n`QueryResults` response object until `nextUri` is absent from the response.\\n\\nThe `status` field of the JSON document is for human consumption only, and\\nprovides a hint about the query state. It cannot be used to tell if the query\\nis finished.\", \"Important `QueryResults` attributes\": \"The most important attributes of the `QueryResults` JSON document returned by\\nthe REST API endpoints are listed in this table. For more details, refer to the\\nclass `io.trino.client.QueryResults` in module `trino-client` in the\\n`client` directory of the Trino source code.\\n\\n:::{list-table} QueryResults attributes\\n:widths: 25, 55\\n:header-rows: 1\\n\\n[['Attribute', 'Description'], ['`id`', 'The ID of the query.'], ['`nextUri`', 'If present, the URL to use for subsequent `GET` or `DELETE` requests. If not\\\\npresent, the query is complete or ended in error.'], ['`columns`', 'A list of the names and types of the columns returned by the query.'], ['`data`', 'The `data` attribute contains a list of the rows returned by the query\\\\nrequest. Each row is itself a list that holds values of the columns in the\\\\nrow, in the order specified by the `columns` attribute.'], ['`updateType`', 'A human-readable string representing the operation. For a `CREATE TABLE`\\\\nrequest, the `updateType` is \\\"CREATE TABLE\\\"; for `SET SESSION` it is \\\"SET\\\\nSESSION\\\"; etc.'], ['`error`', 'If query failed, the `error` attribute contains a `QueryError` object. That\\\\nobject contains a `message`, an `errorCode` and other information about the\\\\nerror. See the `io.trino.client.QueryError` class in module `trino-client`\\\\nin the `client` directory for more details.']]\\n\\n:::\", \"`QueryResults` diagnostic attributes\": \"These `QueryResults` data members may be useful in tracking down problems:\\n\\n:::{list-table} QueryResults diagnostic attributes\\n:widths: 20, 20, 40\\n:header-rows: 1\\n\\n[['Attribute', 'Type', 'Description'], ['`queryError`', '`QueryError`', 'Non-null only if the query resulted in an error.'], ['`failureInfo`', '`FailureInfo`', '`failureInfo` has detail on the reason for the failure, including a stack\\\\ntrace, and `FailureInfo.errorLocation`, providing the query line number and\\\\ncolumn number where the failure was detected.'], ['`warnings`', '`List<TrinoWarning>`', 'A usually empty list of warnings.'], ['`statementStats`', '`StatementStats`', 'A class containing statistics about the query execution. Of particular\\\\ninterest is `StatementStats.rootStage`, of type `StageStats`, providing\\\\nstatistics on the execution of each of the stages of query processing.\\\\n:::']]\\n\\n(client-request-headers)=\", \"Client request headers\": \"This table lists all supported client request headers. Many of the headers can\\nbe updated in the client as response headers, and supplied in subsequent\\nrequests, just like browser cookies.\\n\\n:::{list-table} Client request headers\\n:widths: 30, 50\\n:header-rows: 1\\n\\n[['Header name', 'Description'], ['`X-Trino-User`', 'Specifies the session user. If not supplied, the session user is\\\\nautomatically determined via [](/security/user-mapping).'], ['`X-Trino-Original-User`', \\\"Specifies the session's original user.\\\"], ['`X-Trino-Source`', 'For reporting purposes, this supplies the name of the software that\\\\nsubmitted the query.'], ['`X-Trino-Catalog`', 'The catalog context for query processing. Set by response header\\\\n`X-Trino-Set-Catalog`.'], ['`X-Trino-Schema`', 'The schema context for query processing. Set by response header\\\\n`X-Trino-Set-Schema`.'], ['`X-Trino-Time-Zone`', 'The timezone for query processing. Defaults to the timezone of the Trino\\\\ncluster, and not the timezone of the client.'], ['`X-Trino-Language`', 'The language to use when processing the query and formatting results,\\\\nformatted as a Java `Locale` string, for example `en-US` for US English. The\\\\nlanguage of the session can be set on a per-query basis using the\\\\n`X-Trino-Language` HTTP header.'], ['`X-Trino-Trace-Token`', 'Supplies a trace token to the Trino engine to help identify log lines that\\\\noriginate with this query request.'], ['`X-Trino-Session`', \\\"Supplies a comma-separated list of name=value pairs as session properties.\\\\nWhen the Trino client run a `SET SESSION name=value` query, the name=value\\\\npair is returned in the `X-Set-Trino-Session` response header, and added to\\\\nthe client's list of session properties. If the response header\\\\n`X-Trino-Clear-Session` is returned, its value is the name of a session\\\\nproperty that is removed from the client's accumulated list.\\\"], ['`X-Trino-Role`', 'Sets the \\\"role\\\" for query processing. A \\\"role\\\" represents a collection of\\\\npermissions. Set by response header `X-Trino-Set-Role`. See\\\\n[](/sql/create-role) to understand roles.'], ['`X-Trino-Prepared-Statement`', 'A comma-separated list of the name=value pairs, where the names are names of\\\\npreviously prepared SQL statements, and the values are keys that identify\\\\nthe executable form of the named prepared statements.'], ['`X-Trino-Transaction-Id`', 'The transaction ID to use for query processing. Set by response header\\\\n`X-Trino-Started-Transaction-Id` and cleared by\\\\n`X-Trino-Clear-Transaction-Id`.'], ['`X-Trino-Client-Info`', 'Contains arbitrary information about the client program submitting the\\\\nquery.'], ['`X-Trino-Client-Tags`', 'A comma-separated list of \\\"tag\\\" strings, used to identify Trino resource\\\\ngroups.'], ['`X-Trino-Resource-Estimate`', 'A comma-separated list of `resource=value` type assignments. The possible\\\\nchoices of `resource` are `EXECUTION_TIME`, `CPU_TIME`, `PEAK_MEMORY` and\\\\n`PEAK_TASK_MEMORY`. `EXECUTION_TIME` and `CPU_TIME` have values specified\\\\nas airlift `Duration` strings The format is a double precision number\\\\nfollowed by a `TimeUnit` string, for example `s` for seconds, `m` for minutes,\\\\n`h` for hours, etc. \\\"PEAK_MEMORY\\\" and \\\"PEAK_TASK_MEMORY\\\" are specified as\\\\nairlift `DataSize` strings, whose format is an integer followed by `B` for\\\\nbytes; `kB` for kilobytes; `mB` for megabytes, `gB` for gigabytes, etc.'], ['`X-Trino-Extra-Credential`', 'Provides extra credentials to the connector. The header is a name=value\\\\nstring that is saved in the session `Identity` object. The name and value\\\\nare only meaningful to the connector.\\\\n:::']]\", \"Client response headers\": \"This table lists the supported client response headers. After receiving a\\nresponse, a client must update the request headers used in\\nsubsequent requests to be consistent with the response headers received.\\n\\n:::{list-table} Client response headers\\n:widths: 30, 50\\n:header-rows: 1\\n\\n[['Header name', 'Description'], ['`X-Trino-Set-Catalog`', 'Instructs the client to set the catalog in the `X-Trino-Catalog` request\\\\nheader in subsequent client requests.'], ['`X-Trino-Set-Schema`', 'Instructs the client to set the schema in the `X-Trino-Schema` request\\\\nheader in subsequent client requests.'], ['`X-Trino-Set-Authorization-User`', 'Instructs the client to set the session authorization user in the\\\\n`X-Trino-User` request header in subsequent client requests.\\\\n`X-Trino-Original-User` should also be set.'], ['`X-Trino-Reset-Authorization-User`', 'Instructs the client to reset `X-Trino-User` request header to its original\\\\nvalue in subsequent client requests and remove `X-Trino-Original-User`\\\\nto reset the authorization user back to the original user.'], ['`X-Trino-Set-Original-Roles`', 'Instructs the client to set the roles of the original user in the\\\\n`X-Trino-Original-Roles` request header in subsequent client requests.'], ['`X-Trino-Set-Session`', 'The value of the `X-Trino-Set-Session` response header is a string of the\\\\nform *property* = *value*. It instructs the client include session property\\\\n*property* with value *value* in the `X-Trino-Session` header of subsequent\\\\nclient requests.'], ['`X-Trino-Clear-Session`', 'Instructs the client to remove the session property whose name is the value\\\\nof the `X-Trino-Clear-Session` header from the list of session properties in\\\\nthe `X-Trino-Session` header in subsequent client requests.'], ['`X-Trino-Set-Role`', 'Instructs the client to set `X-Trino-Role` request header to the catalog\\\\nrole supplied by the `X-Trino-Set-Role` header in subsequent client\\\\nrequests.'], ['`X-Trino-Added-Prepare`', 'Instructs the client to add the name=value pair to the set of prepared\\\\nstatements in the `X-Trino-Prepared-Statement` request header in subsequent\\\\nclient requests.'], ['`X-Trino-Deallocated-Prepare`', \\\"Instructs the client to remove the prepared statement whose name is the\\\\nvalue of the `X-Trino-Deallocated-Prepare` header from the client's list of\\\\nprepared statements sent in the `X-Trino-Prepared-Statement` request header\\\\nin subsequent client requests.\\\"], ['`X-Trino-Started-Transaction-Id`', 'Provides the transaction ID that the client should pass back in the\\\\n`X-Trino-Transaction-Id` request header in subsequent requests.'], ['`X-Trino-Clear-Transaction-Id`', 'Instructs the client to clear the `X-Trino-Transaction-Id` request header in\\\\nsubsequent requests.\\\\n:::']]\", \"`ProtocolHeaders`\": \"Class `io.trino.client.ProtocolHeaders` in module `trino-client` in the\\n`client` directory of Trino source enumerates all the HTTP request and\\nresponse headers allowed by the Trino client REST API.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 1]\"}, {\"title\": \"Connectors\", \"description\": null, \"content\": {\"ConnectorFactory\": {\"Configuration\": \"The `create()` method of the connector factory receives a `config` map,\\ncontaining all properties from the catalog properties file. It can be used\\nto configure the connector, but because all the values are strings, they\\nmight require additional processing if they represent other data types.\\nIt also doesn't validate if all the provided properties are known. This\\ncan lead to the connector behaving differently than expected when a\\nconnector ignores a property due to the user making a mistake in\\ntyping the name of the property.\\n\\nTo make the configuration more robust, define a Configuration class. This\\nclass describes all the available properties, their types, and additional\\nvalidation rules.\\n\\n```\\nimport io.airlift.configuration.Config;\\nimport io.airlift.configuration.ConfigDescription;\\nimport io.airlift.configuration.ConfigSecuritySensitive;\\nimport io.airlift.units.Duration;\\nimport io.airlift.units.MaxDuration;\\nimport io.airlift.units.MinDuration;\\n\\nimport javax.validation.constraints.NotNull;\\n\\npublic class ExampleConfig\\n{\\n private String secret;\\n private Duration timeout = Duration.succinctDuration(10, TimeUnit.SECONDS);\\n\\n public String getSecret()\\n {\\n return secret;\\n }\\n\\n @Config(\\\"secret\\\")\\n @ConfigDescription(\\\"Secret required to access the data source\\\")\\n @ConfigSecuritySensitive\\n public ExampleConfig setSecret(String secret)\\n {\\n this.secret = secret;\\n return this;\\n }\\n\\n @NotNull\\n @MaxDuration(\\\"10m\\\")\\n @MinDuration(\\\"1ms\\\")\\n public Duration getTimeout()\\n {\\n return timeout;\\n }\\n\\n @Config(\\\"timeout\\\")\\n public ExampleConfig setTimeout(Duration timeout)\\n {\\n this.timeout = timeout;\\n return this;\\n }\\n}\\n```\\n\\nThe preceding example defines two configuration properties and makes\\nthe connector more robust by:\\n\\n['defining all supported properties, which allows detecting spelling mistakes\\\\nin the configuration on server startup', 'defining a default timeout value, to prevent connections getting stuck\\\\nindefinitely', 'preventing invalid timeout values, like 0 ms, that would make\\\\nall requests fail', 'parsing timeout values in different units, detecting invalid values', 'preventing logging the secret value in plain text']\\n\\nThe configuration class needs to be bound in a Guice module:\\n\\n```\\nimport com.google.inject.Binder;\\nimport com.google.inject.Module;\\n\\nimport static io.airlift.configuration.ConfigBinder.configBinder;\\n\\npublic class ExampleModule\\n implements Module\\n{\\n public ExampleModule()\\n {\\n }\\n\\n @Override\\n public void configure(Binder binder)\\n {\\n configBinder(binder).bindConfig(ExampleConfig.class);\\n }\\n}\\n```\\n\\nAnd then the module needs to be initialized in the connector factory, when\\ncreating a new instance of the connector:\\n\\n```\\n@Override\\npublic Connector create(String connectorName, Map<String, String> config, ConnectorContext context)\\n{\\n requireNonNull(config, \\\"config is null\\\");\\n Bootstrap app = new Bootstrap(new ExampleModule());\\n Injector injector = app\\n .doNotInitializeLogging()\\n .setRequiredConfigurationProperties(config)\\n .initialize();\\n\\n return injector.getInstance(ExampleConnector.class);\\n}\\n```\\n\\n:::{note}\\nEnvironment variables in the catalog properties file\\n(ex. `secret=${ENV:SECRET}`) are resolved only when using\\nthe `io.airlift.bootstrap.Bootstrap` class to initialize the module.\\nSee {doc}`/security/secrets` for more information.\\n:::\\n\\nIf you end up needing to define multiple catalogs using the same connector\\njust to change one property, consider adding support for schema and/or\\ntable properties. That would allow a more fine-grained configuration.\\nIf a connector doesn't support managing the schema, query predicates for\\nselected columns could be used as a way of passing the required configuration\\nat run time.\\n\\nFor example, when building a connector to read commits from a Git repository,\\nthe repository URL could be a configuration property. But this would result\\nin a catalog being able to return data only from a single repository.\\nAlternatively, it can be a column, where every select query would require\\na predicate for it:\\n\\n```\\nSELECT *\\nFROM git.default.commits\\nWHERE url = 'https://github.com/trinodb/trino.git'\\n```\\n\\n(connector-metadata)=\"}, \"ConnectorMetadata\": {\"Limit and top-N pushdown\": \"When executing a `SELECT` query with `LIMIT` or `ORDER BY` clauses,\\nthe query plan may contain a `Sort` or `Limit` operations.\\n\\nWhen the plan contains a `Sort` and `Limit` operations, the engine\\ntries to push down the limit into the connector by calling the `applyTopN`\\nmethod of the connector metadata service. If there's no `Sort` operation, but\\nonly a `Limit`, the `applyLimit` method is called, and the connector can\\nreturn results in an arbitrary order.\\n\\nIf the connector could benefit from the information passed to these methods but\\ncan't guarantee that it'd be able to produce fewer rows than the provided\\nlimit, it should return a non-empty result containing a new handle for the\\nderived table and the `limitGuaranteed` (in `LimitApplicationResult`) or\\n`topNGuaranteed` (in `TopNApplicationResult`) flag set to false.\\n\\nIf the connector can guarantee to produce fewer rows than the provided\\nlimit, it should return a non-empty result with the \\\"limit guaranteed\\\" or\\n\\\"topN guaranteed\\\" flag set to true.\\n\\n:::{note}\\nThe `applyTopN` is the only method that receives sort items from the\\n`Sort` operation.\\n:::\\n\\nIn a query, the `ORDER BY` section can include any column with any order.\\nBut the data source for the connector might only support limited combinations.\\nPlugin authors have to decide if the connector should ignore the pushdown,\\nreturn all the data and let the engine sort it, or throw an exception\\nto inform the user that particular order isn't supported, if fetching all\\nthe data would be too expensive or time consuming. When throwing\\nan exception, use the `TrinoException` class with the `INVALID_ORDER_BY`\\nerror code and an actionable message, to let users know how to write a valid\\nquery.\\n\\n(dev-predicate-pushdown)=\", \"Predicate pushdown\": \"When executing a query with a `WHERE` clause, the query plan can\\ncontain a `ScanFilterProject` plan node/node with a predicate constraint.\\n\\nA predicate constraint is a description of the constraint imposed on the\\nresults of the stage/fragment as expressed in the `WHERE` clause. For example,\\n`WHERE x > 5 AND y = 3` translates into a constraint where the\\n`summary` field means the `x` column's domain must be greater than\\n`5` and the `y` column domain equals `3`.\\n\\nWhen the query plan contains a `ScanFilterProject` operation, Trino\\ntries to optimize the query by pushing down the predicate constraint\\ninto the connector by calling the `applyFilter` method of the\\nconnector metadata service. This method receives a table handle with\\nall optimizations applied thus far, and returns either\\n`Optional.empty()` or a response with a new table handle derived from\\nthe old one.\\n\\nThe query optimizer may call `applyFilter` for a single query multiple times,\\nas it searches for an optimal query plan. Connectors must\\nreturn `Optional.empty()` from `applyFilter` if they cannot apply the\\nconstraint for this invocation, even if they support `ScanFilterProject`\\npushdown in general. Connectors must also return `Optional.empty()` if the\\nconstraint has already been applied.\\n\\nA constraint contains the following elements:\\n\\n['A `TupleDomain` defining the mapping between columns and their domains.\\\\nA `Domain` is either a list of possible values, or a list of ranges, and\\\\nalso contains information about nullability.', 'Expression for pushing down function calls.', 'Map of assignments from variables in the expression to columns.', '(optional) Predicate which tests a map of columns and their values;\\\\nit cannot be held on to after the `applyFilter` call returns.', '(optional) Set of columns the predicate depends on; must be present\\\\nif predicate is present.']\\n\\nIf both a predicate and a summary are available, the predicate is guaranteed to\\nbe more strict in filtering of values, and can provide a significant boost to\\nquery performance if used.\\n\\nHowever it is not possible to store a predicate in the table handle and use\\nit later, as the predicate cannot be held on to after the `applyFilter`\\ncall returns. It is used for filtering of entire partitions, and is not pushed\\ndown. The summary can be pushed down instead by storing it in the table handle.\\n\\nThis overlap between the predicate and summary is due to historical reasons,\\nas simple comparison pushdown was implemented first via summary, and more\\ncomplex filters such as `LIKE` which required more expressive predicates\\nwere added later.\\n\\nIf a constraint can only be partially pushed down, for example when a connector\\nfor a database that does not support range matching is used in a query with\\n`WHERE x = 2 AND y > 5`, the `y` column constraint must be\\nreturned in the `ConstraintApplicationResult` from `applyFilter`.\\nIn this case the `y > 5` condition is applied in Trino,\\nand not pushed down.\\n\\nThe following is a simple example which only looks at `TupleDomain`:\\n\\n```\\n@Override\\npublic Optional<ConstraintApplicationResult<ConnectorTableHandle>> applyFilter(\\n ConnectorSession session,\\n ConnectorTableHandle tableHandle,\\n Constraint constraint)\\n{\\n ExampleTableHandle handle = (ExampleTableHandle) tableHandle;\\n\\n TupleDomain<ColumnHandle> oldDomain = handle.getConstraint();\\n TupleDomain<ColumnHandle> newDomain = oldDomain.intersect(constraint.getSummary());\\n if (oldDomain.equals(newDomain)) {\\n // Nothing has changed, return empty Option\\n return Optional.empty();\\n }\\n\\n handle = new ExampleTableHandle(newDomain);\\n return Optional.of(new ConstraintApplicationResult<>(handle, TupleDomain.all(), false));\\n}\\n```\\n\\nThe `TupleDomain` from the constraint is intersected with the `TupleDomain`\\nalready applied to the `TableHandle` to form `newDomain`.\\nIf filtering has not changed, an `Optional.empty()` result is returned to\\nnotify the planner that this optimization path has reached its end.\\n\\nIn this example, the connector pushes down the `TupleDomain`\\nwith all Trino data types supported with same semantics in the\\ndata source. As a result, no filters are needed in Trino,\\nand the `ConstraintApplicationResult` sets `remainingFilter` to\\n`TupleDomain.all()`.\\n\\nThis pushdown implementation is quite similar to many Trino connectors,\\nincluding `MongoMetadata`, `BigQueryMetadata`, `KafkaMetadata`.\\n\\nThe following, more complex example shows data types from Trino that are\\nnot available directly in the underlying data source, and must be mapped:\\n\\n```\\n@Override\\npublic Optional<ConstraintApplicationResult<ConnectorTableHandle>> applyFilter(\\n ConnectorSession session,\\n ConnectorTableHandle table,\\n Constraint constraint)\\n{\\n JdbcTableHandle handle = (JdbcTableHandle) table;\\n\\n TupleDomain<ColumnHandle> oldDomain = handle.getConstraint();\\n TupleDomain<ColumnHandle> newDomain = oldDomain.intersect(constraint.getSummary());\\n TupleDomain<ColumnHandle> remainingFilter;\\n if (newDomain.isNone()) {\\n newConstraintExpressions = ImmutableList.of();\\n remainingFilter = TupleDomain.all();\\n remainingExpression = Optional.of(Constant.TRUE);\\n }\\n else {\\n // We need to decide which columns to push down.\\n // Since this is a base class for many JDBC-based connectors, each\\n // having different Trino type mappings and comparison semantics\\n // it needs to be flexible.\\n\\n Map<ColumnHandle, Domain> domains = newDomain.getDomains().orElseThrow();\\n List<JdbcColumnHandle> columnHandles = domains.keySet().stream()\\n .map(JdbcColumnHandle.class::cast)\\n .collect(toImmutableList());\\n\\n // Get information about how to push down every column based on its\\n // JDBC data type\\n List<ColumnMapping> columnMappings = jdbcClient.toColumnMappings(\\n session,\\n columnHandles.stream()\\n .map(JdbcColumnHandle::getJdbcTypeHandle)\\n .collect(toImmutableList()));\\n\\n // Calculate the domains which can be safely pushed down (supported)\\n // and those which need to be filtered in Trino (unsupported)\\n Map<ColumnHandle, Domain> supported = new HashMap<>();\\n Map<ColumnHandle, Domain> unsupported = new HashMap<>();\\n for (int i = 0; i < columnHandles.size(); i++) {\\n JdbcColumnHandle column = columnHandles.get(i);\\n DomainPushdownResult pushdownResult =\\n columnMappings.get(i).getPredicatePushdownController().apply(\\n session,\\n domains.get(column));\\n supported.put(column, pushdownResult.getPushedDown());\\n unsupported.put(column, pushdownResult.getRemainingFilter());\\n }\\n\\n newDomain = TupleDomain.withColumnDomains(supported);\\n remainingFilter = TupleDomain.withColumnDomains(unsupported);\\n }\\n\\n // Return empty Optional if nothing changed in filtering\\n if (oldDomain.equals(newDomain)) {\\n return Optional.empty();\\n }\\n\\n handle = new JdbcTableHandle(\\n handle.getRelationHandle(),\\n newDomain,\\n ...);\\n\\n return Optional.of(\\n new ConstraintApplicationResult<>(\\n handle,\\n remainingFilter));\\n}\\n```\\n\\nThis example illustrates implementing a base class for many JDBC connectors\\nwhile handling the specific requirements of multiple JDBC-compliant data sources.\\nIt ensures that if a constraint gets pushed down, it works exactly the same in\\nthe underlying data source, and produces the same results as it would in Trino.\\nFor example, in databases where string comparisons are case-insensitive,\\npushdown does not work, as string comparison operations in Trino are\\ncase-sensitive.\\n\\nThe `PredicatePushdownController` interface determines if a column domain can\\nbe pushed down in JDBC-compliant data sources. In the preceding example, it is\\ncalled from a `JdbcClient` implementation specific to that database.\\nIn non-JDBC-compliant data sources, type-based push downs are implemented\\ndirectly, without going through the `PredicatePushdownController` interface.\\n\\nThe following example adds expression pushdown enabled by a session flag:\\n\\n```\\n@Override\\npublic Optional<ConstraintApplicationResult<ConnectorTableHandle>> applyFilter(\\n ConnectorSession session,\\n ConnectorTableHandle table,\\n Constraint constraint)\\n{\\n JdbcTableHandle handle = (JdbcTableHandle) table;\\n\\n TupleDomain<ColumnHandle> oldDomain = handle.getConstraint();\\n TupleDomain<ColumnHandle> newDomain = oldDomain.intersect(constraint.getSummary());\\n List<String> newConstraintExpressions;\\n TupleDomain<ColumnHandle> remainingFilter;\\n Optional<ConnectorExpression> remainingExpression;\\n if (newDomain.isNone()) {\\n newConstraintExpressions = ImmutableList.of();\\n remainingFilter = TupleDomain.all();\\n remainingExpression = Optional.of(Constant.TRUE);\\n }\\n else {\\n // We need to decide which columns to push down.\\n // Since this is a base class for many JDBC-based connectors, each\\n // having different Trino type mappings and comparison semantics\\n // it needs to be flexible.\\n\\n Map<ColumnHandle, Domain> domains = newDomain.getDomains().orElseThrow();\\n List<JdbcColumnHandle> columnHandles = domains.keySet().stream()\\n .map(JdbcColumnHandle.class::cast)\\n .collect(toImmutableList());\\n\\n // Get information about how to push down every column based on its\\n // JDBC data type\\n List<ColumnMapping> columnMappings = jdbcClient.toColumnMappings(\\n session,\\n columnHandles.stream()\\n .map(JdbcColumnHandle::getJdbcTypeHandle)\\n .collect(toImmutableList()));\\n\\n // Calculate the domains which can be safely pushed down (supported)\\n // and those which need to be filtered in Trino (unsupported)\\n Map<ColumnHandle, Domain> supported = new HashMap<>();\\n Map<ColumnHandle, Domain> unsupported = new HashMap<>();\\n for (int i = 0; i < columnHandles.size(); i++) {\\n JdbcColumnHandle column = columnHandles.get(i);\\n DomainPushdownResult pushdownResult =\\n columnMappings.get(i).getPredicatePushdownController().apply(\\n session,\\n domains.get(column));\\n supported.put(column, pushdownResult.getPushedDown());\\n unsupported.put(column, pushdownResult.getRemainingFilter());\\n }\\n\\n newDomain = TupleDomain.withColumnDomains(supported);\\n remainingFilter = TupleDomain.withColumnDomains(unsupported);\\n\\n // Do we want to handle expression pushdown?\\n if (isComplexExpressionPushdown(session)) {\\n List<String> newExpressions = new ArrayList<>();\\n List<ConnectorExpression> remainingExpressions = new ArrayList<>();\\n // Each expression can be broken down into a list of conjuncts\\n // joined with AND. We handle each conjunct separately.\\n for (ConnectorExpression expression : extractConjuncts(constraint.getExpression())) {\\n // Try to convert the conjunct into something which is\\n // understood by the underlying JDBC data source\\n Optional<String> converted = jdbcClient.convertPredicate(\\n session,\\n expression,\\n constraint.getAssignments());\\n if (converted.isPresent()) {\\n newExpressions.add(converted.get());\\n }\\n else {\\n remainingExpressions.add(expression);\\n }\\n }\\n // Calculate which parts of the expression can be pushed down\\n // and which need to be calculated in Trino engine\\n newConstraintExpressions = ImmutableSet.<String>builder()\\n .addAll(handle.getConstraintExpressions())\\n .addAll(newExpressions)\\n .build().asList();\\n remainingExpression = Optional.of(and(remainingExpressions));\\n }\\n else {\\n newConstraintExpressions = ImmutableList.of();\\n remainingExpression = Optional.empty();\\n }\\n }\\n\\n // Return empty Optional if nothing changed in filtering\\n if (oldDomain.equals(newDomain) &&\\n handle.getConstraintExpressions().equals(newConstraintExpressions)) {\\n return Optional.empty();\\n }\\n\\n handle = new JdbcTableHandle(\\n handle.getRelationHandle(),\\n newDomain,\\n newConstraintExpressions,\\n ...);\\n\\n return Optional.of(\\n remainingExpression.isPresent()\\n ? new ConstraintApplicationResult<>(\\n handle,\\n remainingFilter,\\n remainingExpression.get())\\n : new ConstraintApplicationResult<>(\\n handle,\\n remainingFilter));\\n}\\n```\\n\\n`ConnectorExpression` is split similarly to `TupleDomain`.\\nEach expression can be broken down into independent *conjuncts*. Conjuncts are\\nsmaller expressions which, if joined together using an `AND` operator, are\\nequivalent to the original expression. Every conjunct can be handled\\nindividually. Each one is converted using connector-specific rules, as defined\\nby the `JdbcClient` implementation, to be more flexible. Unconverted\\nconjuncts are returned as `remainingExpression` and are evaluated by\\nthe Trino engine.\\n\\n(connector-split-manager)=\"}, \"ConnectorSplitManager\": \"The split manager partitions the data for a table into the individual chunks\\nthat Trino distributes to workers for processing. For example, the Hive\\nconnector lists the files for each Hive partition and creates one or more\\nsplits per file. For data sources that don't have partitioned data, a good\\nstrategy here is to simply return a single split for the entire table. This is\\nthe strategy employed by the Example HTTP connector.\\n\\n(connector-record-set-provider)=\", \"ConnectorRecordSetProvider\": {\"Type mapping\": \"The built-in SQL data types use different Java types as carrier types.\\n\\n:::{list-table} SQL type to carrier type mapping\\n:widths: 45, 55\\n:header-rows: 1\\n\\n[['SQL type', 'Java type'], ['`BOOLEAN`', '`boolean`'], ['`TINYINT`', '`long`'], ['`SMALLINT`', '`long`'], ['`INTEGER`', '`long`'], ['`BIGINT`', '`long`'], ['`REAL`', '`long`'], ['`DOUBLE`', '`double`'], ['`DECIMAL`', '`long` for precision up to 19, inclusive; `Int128` for precision greater\\\\nthan 19'], ['`VARCHAR`', '`Slice`'], ['`CHAR`', '`Slice`'], ['`VARBINARY`', '`Slice`'], ['`JSON`', '`Slice`'], ['`DATE`', '`long`'], ['`TIME(P)`', '`long`'], ['`TIME WITH TIME ZONE`', '`long` for precision up to 9; `LongTimeWithTimeZone` for precision greater\\\\nthan 9'], ['`TIMESTAMP(P)`', '`long` for precision up to 6; `LongTimestamp` for precision greater than 6'], ['`TIMESTAMP(P) WITH TIME ZONE`', '`long` for precision up to 3; `LongTimestampWithTimeZone` for precision\\\\ngreater than 3'], ['`INTERVAL YEAR TO MONTH`', '`long`'], ['`INTERVAL DAY TO SECOND`', '`long`'], ['`ARRAY`', '`Block`'], ['`MAP`', '`Block`'], ['`ROW`', '`Block`'], ['`IPADDRESS`', '`Slice`'], ['`UUID`', '`Slice`'], ['`HyperLogLog`', '`Slice`'], ['`P4HyperLogLog`', '`Slice`'], ['`SetDigest`', '`Slice`'], ['`QDigest`', '`Slice`'], ['`TDigest`', '`TDigest`\\\\n:::']]\\n\\nThe `RecordCursor.getType(int field)` method returns the SQL type for a field\\nand the field value is returned by one of the following methods, matching\\nthe carrier type:\\n\\n['`getBoolean(int field)`', '`getLong(int field)`', '`getDouble(int field)`', '`getSlice(int field)`', '`getObject(int field)`']\\n\\nValues for the `real` type are encoded into `long` using the IEEE 754\\nfloating-point \\\"single format\\\" bit layout, with NaN preservation. This can be\\naccomplished using the `java.lang.Float.floatToRawIntBits` static method.\\n\\nValues for the `timestamp(p) with time zone` and `time(p) with time zone`\\ntypes of regular precision can be converted into `long` using static methods\\nfrom the `io.trino.spi.type.DateTimeEncoding` class, like `pack()` or\\n`packDateTimeWithZone()`.\\n\\nUTF-8 encoded strings can be converted to Slices using\\nthe `Slices.utf8Slice()` static method.\\n\\n:::{note}\\nThe `Slice` class is provided by the `io.airlift:slice` package.\\n:::\\n\\n`Int128` objects can be created using the `Int128.valueOf()` method.\\n\\nThe following example creates a block for an `array(varchar)` column:\\n\\n```\\nprivate Block encodeArray(List<String> names)\\n{\\n BlockBuilder builder = VARCHAR.createBlockBuilder(null, names.size());\\n blockBuilder.buildEntry(elementBuilder -> names.forEach(name -> {\\n if (name == null) {\\n elementBuilder.appendNull();\\n }\\n else {\\n VARCHAR.writeString(elementBuilder, name);\\n }\\n }));\\n return builder.build();\\n}\\n```\\n\\nThe following example creates a SqlMap object for a `map(varchar, varchar)` column:\\n\\n```\\nprivate SqlMap encodeMap(Map<String, ?> map)\\n{\\n MapType mapType = typeManager.getType(TypeSignature.mapType(\\n VARCHAR.getTypeSignature(),\\n VARCHAR.getTypeSignature()));\\n MapBlockBuilder values = mapType.createBlockBuilder(null, map != null ? map.size() : 0);\\n if (map == null) {\\n values.appendNull();\\n return values.build().getObject(0, Block.class);\\n }\\n values.buildEntry((keyBuilder, valueBuilder) -> map.foreach((key, value) -> {\\n VARCHAR.writeString(keyBuilder, key);\\n if (value == null) {\\n valueBuilder.appendNull();\\n }\\n else {\\n VARCHAR.writeString(valueBuilder, value.toString());\\n }\\n }));\\n return values.build().getObject(0, SqlMap.class);\\n}\\n```\\n\\n(connector-page-source-provider)=\"}, \"ConnectorPageSourceProvider\": \"Given a split, a table handle, and a list of columns, the page source provider\\nis responsible for delivering data to the Trino execution engine. It creates\\na `ConnectorPageSource`, which in turn creates `Page` objects that are used\\nby Trino to read the column values.\\n\\nIf not implemented, a default `RecordPageSourceProvider` is used.\\nGiven a record set provider, it returns an instance of `RecordPageSource`\\nthat builds `Page` objects from records in a record set.\\n\\nA connector should implement a page source provider instead of a record set\\nprovider when it's possible to create pages directly. The conversion of\\nindividual records from a record set provider into pages adds overheads during\\nquery execution.\\n\\n(connector-page-sink-provider)=\", \"ConnectorPageSinkProvider\": \"Given an insert table handle, the page sink provider is responsible for\\nconsuming data from the Trino execution engine.\\nIt creates a `ConnectorPageSink`, which in turn accepts `Page` objects\\nthat contains the column values.\\n\\nExample that shows how to iterate over the page to access single values:\\n\\n```\\n@Override\\npublic CompletableFuture<?> appendPage(Page page)\\n{\\n for (int channel = 0; channel < page.getChannelCount(); channel++) {\\n Block block = page.getBlock(channel);\\n for (int position = 0; position < page.getPositionCount(); position++) {\\n if (block.isNull(position)) {\\n // or handle this differently\\n continue;\\n }\\n\\n // channel should match the column number in the table\\n // use it to determine the expected column type\\n String value = VARCHAR.getSlice(block, position).toStringUtf8();\\n // TODO do something with the value\\n }\\n }\\n return NOT_BLOCKED;\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 2]\"}, {\"title\": \"Event listener\", \"description\": null, \"content\": {\"Implementation\": \"`EventListenerFactory` is responsible for creating an\\n`EventListener` instance. It also defines an `EventListener`\\nname which is used by the administrator in a Trino configuration.\\nImplementations of `EventListener` implement methods for the event types\\nthey are interested in handling.\\n\\nThe implementation of `EventListener` and `EventListenerFactory`\\nmust be wrapped as a plugin and installed on the Trino cluster.\", \"Configuration\": \"After a plugin that implements `EventListener` and\\n`EventListenerFactory` has been installed on the coordinator, it is\\nconfigured using an `etc/event-listener.properties` file. All the\\nproperties other than `event-listener.name` are specific to the\\n`EventListener` implementation.\\n\\nThe `event-listener.name` property is used by Trino to find a registered\\n`EventListenerFactory` based on the name returned by\\n`EventListenerFactory.getName()`. The remaining properties are passed\\nas a map to `EventListenerFactory.create()`.\\n\\nExample configuration file:\\n\\n```\\nevent-listener.name=custom-event-listener\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\\n\\n(multiple-listeners)=\", \"Multiple event listeners\": \"Trino supports multiple instances of the same or different event listeners.\\nInstall and configure multiple instances by setting\\n`event-listener.config-files` in {ref}`config-properties` to a comma-separated\\nlist of the event listener configuration files:\\n\\n```\\nevent-listener.config-files=etc/event-listener.properties,etc/event-listener-second.properties\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 3]\"}, {\"title\": \"Example HTTP connector\", \"description\": null, \"content\": {\"Installation\": \"The example HTTP connector plugin is optional and therefore not included in the\\ndefault [tarball](/installation/deployment) and the default [Docker\\nimage](/installation/containers).\\n\\nFollow the [plugin installation instructions](plugins-installation) and\\noptionally use the [trino-packages\\nproject](https://github.com/trinodb/trino-packages) or manually download the\\nplugin archive {maven_download}`example-http`.\", \"Code\": \"The Example HTTP connector can be found in the [trino-example-http](https://github.com/trinodb/trino/tree/master/plugin/trino-example-http)\\ndirectory within the Trino source tree.\", \"Plugin implementation\": \"The plugin implementation in the Example HTTP connector looks very\\nsimilar to other plugin implementations. Most of the implementation is\\ndevoted to handling optional configuration and the only function of\\ninterest is the following:\\n\\n```\\n@Override\\npublic Iterable<ConnectorFactory> getConnectorFactories()\\n{\\n return ImmutableList.of(new ExampleConnectorFactory());\\n}\\n```\\n\\nNote that the `ImmutableList` class is a utility class from Guava.\\n\\nAs with all connectors, this plugin overrides the `getConnectorFactories()` method\\nand returns an `ExampleConnectorFactory`.\", \"ConnectorFactory implementation\": {\"Connector: ExampleConnector\": \"This class allows Trino to obtain references to the various services\\nprovided by the connector.\", \"Metadata: ExampleMetadata\": \"This class is responsible for reporting table names, table metadata,\\ncolumn names, column metadata and other information about the schemas\\nthat are provided by this connector. `ConnectorMetadata` is also called\\nby Trino to ensure that a particular connector can understand and\\nhandle a given table name.\\n\\nThe `ExampleMetadata` implementation delegates many of these calls to\\n`ExampleClient`, a class that implements much of the core functionality\\nof the connector.\", \"Split manager: ExampleSplitManager\": \"The split manager partitions the data for a table into the individual\\nchunks that Trino will distribute to workers for processing.\\nIn the case of the Example HTTP connector, each table contains one or\\nmore URIs pointing at the actual data. One split is created per URI.\", \"Record set provider: ExampleRecordSetProvider\": \"The record set provider creates a record set which in turn creates a\\nrecord cursor that returns the actual data to Trino.\\n`ExampleRecordCursor` reads data from a URI via HTTP. Each line\\ncorresponds to a single row. Lines are split on comma into individual\\nfield values which are then returned to Trino.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 4]\"}, {\"title\": \"Example JDBC connector\", \"description\": null, \"content\": {\"Code\": \"The Example JDBC connector can be found in the [trino-example-jdbc](https://github.com/trinodb/trino/tree/master/plugin/trino-example-jdbc)\\ndirectory within the Trino source tree.\", \"Plugin implementation\": \"The plugin implementation in the Example JDBC connector extends\\nthe `JdbcPlugin` class and uses the `ExampleClientModule`.\\n\\nThe module:\\n\\n['binds the `ExampleClient` class so it can be used by the base JDBC\\\\nconnector;', 'provides a connection factory that will create new connections using a JDBC\\\\ndriver based on the JDBC URL specified in configuration properties.']\", \"JdbcClient implementation\": {\"toColumnMapping\": \"`toColumnMapping` is used when reading data from the connector.\\nGiven a `ConnectorSession`, `Connection` and a `JdbcTypeHandle`,\\nit returns a `ColumnMapping`, if there is a matching data type.\\n\\nThe column mapping includes:\\n\\n['a Trino type,', 'a write function, used to set query parameter values when preparing a\\\\nJDBC statement to execute in the data source,', 'and a read function, used to read a value from the JDBC statement result set,\\\\nand return it using an internal Trino representation (for example, a Slice).']\", \"toWriteMapping\": \"`toWriteMapping` is used when writing data to the connector. Given a\\n`ConnectorSession` and a Trino type, it returns a `WriteMapping`.\\n\\nThe mapping includes:\\n\\n['a data type name', 'a write function']\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 5]\"}, {\"title\": \"Functions\", \"description\": null, \"content\": {\"Plugin implementation\": \"The function framework is used to implement SQL functions. Trino includes a\\nnumber of built-in functions. In order to implement new functions, you can\\nwrite a plugin that returns one or more functions from `getFunctions()`:\\n\\n```\\npublic class ExampleFunctionsPlugin\\n implements Plugin\\n{\\n @Override\\n public Set<Class<?>> getFunctions()\\n {\\n return ImmutableSet.<Class<?>>builder()\\n .add(ExampleNullFunction.class)\\n .add(IsNullFunction.class)\\n .add(IsEqualOrNullFunction.class)\\n .add(ExampleStringFunction.class)\\n .add(ExampleAverageFunction.class)\\n .build();\\n }\\n}\\n```\\n\\nNote that the `ImmutableSet` class is a utility class from Guava.\\nThe `getFunctions()` method contains all of the classes for the functions\\nthat we will implement below in this tutorial.\\n\\nFor a full example in the codebase, see either the `trino-ml` module for\\nmachine learning functions or the `trino-teradata-functions` module for\\nTeradata-compatible functions, both in the `plugin` directory of the Trino\\nsource.\", \"Scalar function implementation\": \"The function framework uses annotations to indicate relevant information\\nabout functions, including name, description, return type and parameter\\ntypes. Below is a sample function which implements `is_null`:\\n\\n```\\npublic class ExampleNullFunction\\n{\\n @ScalarFunction(\\\"is_null\\\", deterministic = true)\\n @Description(\\\"Returns TRUE if the argument is NULL\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean isNull(\\n @SqlNullable @SqlType(StandardTypes.VARCHAR) Slice string)\\n {\\n return (string == null);\\n }\\n}\\n```\\n\\nThe function `is_null` takes a single `VARCHAR` argument and returns a\\n`BOOLEAN` indicating if the argument was `NULL`. Note that the argument to\\nthe function is of type `Slice`. `VARCHAR` uses `Slice`, which is essentially\\na wrapper around `byte[]`, rather than `String` for its native container type.\\n\\nThe `deterministic` argument indicates that a function has no side effects and,\\nfor subsequent calls with the same argument(s), the function returns the exact\\nsame value(s).\\n\\nIn Trino, deterministic functions don't rely on any changing state\\nand don't modify any state. The `deterministic` flag is optional and defaults\\nto `true`.\\n\\nFor example, the function {func}`shuffle` is non-deterministic, since it uses random\\nvalues. On the other hand, {func}`now` is deterministic, because subsequent calls in a\\nsingle query return the same timestamp.\\n\\nAny function with non-deterministic behavior is required to set `deterministic = false`\\nto avoid unexpected results.\\n\\n['`@SqlType`:', 'The `@SqlType` annotation is used to declare the return type and the argument\\\\ntypes. Note that the return type and arguments of the Java code must match\\\\nthe native container types of the corresponding annotations.', '`@SqlNullable`:', 'The `@SqlNullable` annotation indicates that the argument may be `NULL`. Without\\\\nthis annotation the framework assumes that all functions return `NULL` if\\\\nany of their arguments are `NULL`. When working with a `Type` that has a\\\\nprimitive native container type, such as `BigintType`, use the object wrapper for the\\\\nnative container type when using `@SqlNullable`. The method must be annotated with\\\\n`@SqlNullable` if it can return `NULL` when the arguments are non-null.']\", \"Parametric scalar functions\": \"Scalar functions that have type parameters have some additional complexity.\\nTo make our previous example work with any type we need the following:\\n\\n```\\n@ScalarFunction(name = \\\"is_null\\\")\\n@Description(\\\"Returns TRUE if the argument is NULL\\\")\\npublic final class IsNullFunction\\n{\\n @TypeParameter(\\\"T\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean isNullSlice(@SqlNullable @SqlType(\\\"T\\\") Slice value)\\n {\\n return (value == null);\\n }\\n\\n @TypeParameter(\\\"T\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean isNullLong(@SqlNullable @SqlType(\\\"T\\\") Long value)\\n {\\n return (value == null);\\n }\\n\\n @TypeParameter(\\\"T\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean isNullDouble(@SqlNullable @SqlType(\\\"T\\\") Double value)\\n {\\n return (value == null);\\n }\\n\\n // ...and so on for each native container type\\n}\\n```\\n\\n['`@TypeParameter`:', 'The `@TypeParameter` annotation is used to declare a type parameter which can\\\\nbe used in the argument types `@SqlType` annotation, or return type of the function.\\\\nIt can also be used to annotate a parameter of type `Type`. At runtime, the engine\\\\nwill bind the concrete type to this parameter. `@OperatorDependency` may be used\\\\nto declare that an additional function for operating on the given type parameter is needed.\\\\nFor example, the following function will only bind to types which have an equals function\\\\ndefined:']\\n\\n```\\n@ScalarFunction(name = \\\"is_equal_or_null\\\")\\n@Description(\\\"Returns TRUE if arguments are equal or both NULL\\\")\\npublic final class IsEqualOrNullFunction\\n{\\n @TypeParameter(\\\"T\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean isEqualOrNullSlice(\\n @OperatorDependency(\\n operator = OperatorType.EQUAL,\\n returnType = StandardTypes.BOOLEAN,\\n argumentTypes = {\\\"T\\\", \\\"T\\\"}) MethodHandle equals,\\n @SqlNullable @SqlType(\\\"T\\\") Slice value1,\\n @SqlNullable @SqlType(\\\"T\\\") Slice value2)\\n {\\n if (value1 == null && value2 == null) {\\n return true;\\n }\\n if (value1 == null || value2 == null) {\\n return false;\\n }\\n return (boolean) equals.invokeExact(value1, value2);\\n }\\n\\n // ...and so on for each native container type\\n}\\n```\", \"Another scalar function example\": \"The `lowercaser` function takes a single `VARCHAR` argument and returns a\\n`VARCHAR`, which is the argument converted to lower case:\\n\\n```\\npublic class ExampleStringFunction\\n{\\n @ScalarFunction(\\\"lowercaser\\\")\\n @Description(\\\"Converts the string to alternating case\\\")\\n @SqlType(StandardTypes.VARCHAR)\\n public static Slice lowercaser(@SqlType(StandardTypes.VARCHAR) Slice slice)\\n {\\n String argument = slice.toStringUtf8();\\n return Slices.utf8Slice(argument.toLowerCase());\\n }\\n}\\n```\\n\\nNote that for most common string functions, including converting a string to\\nlower case, the Slice library also provides implementations that work directly\\non the underlying `byte[]`, which have much better performance. This function\\nhas no `@SqlNullable` annotations, meaning that if the argument is `NULL`,\\nthe result will automatically be `NULL` (the function will not be called).\", \"Aggregation function implementation\": \"Aggregation functions use a similar framework to scalar functions, but are\\na bit more complex.\\n\\n['`AccumulatorState`:', 'All aggregation functions accumulate input rows into a state object; this\\\\nobject must implement `AccumulatorState`. For simple aggregations, just\\\\nextend `AccumulatorState` into a new interface with the getters and setters\\\\nyou want, and the framework will generate all the implementations and\\\\nserializers for you. If you need a more complex state object, you will need\\\\nto implement `AccumulatorStateFactory` and `AccumulatorStateSerializer`\\\\nand provide these via the `AccumulatorStateMetadata` annotation.']\\n\\nThe following code implements the aggregation function `avg_double` which computes the\\naverage of a `DOUBLE` column:\\n\\n```\\n@AggregationFunction(\\\"avg_double\\\")\\npublic class AverageAggregation\\n{\\n @InputFunction\\n public static void input(\\n LongAndDoubleState state,\\n @SqlType(StandardTypes.DOUBLE) double value)\\n {\\n state.setLong(state.getLong() + 1);\\n state.setDouble(state.getDouble() + value);\\n }\\n\\n @CombineFunction\\n public static void combine(\\n LongAndDoubleState state,\\n LongAndDoubleState otherState)\\n {\\n state.setLong(state.getLong() + otherState.getLong());\\n state.setDouble(state.getDouble() + otherState.getDouble());\\n }\\n\\n @OutputFunction(StandardTypes.DOUBLE)\\n public static void output(LongAndDoubleState state, BlockBuilder out)\\n {\\n long count = state.getLong();\\n if (count == 0) {\\n out.appendNull();\\n }\\n else {\\n double value = state.getDouble();\\n DOUBLE.writeDouble(out, value / count);\\n }\\n }\\n}\\n```\\n\\nThe average has two parts: the sum of the `DOUBLE` in each row of the column\\nand the `LONG` count of the number of rows seen. `LongAndDoubleState` is an interface\\nwhich extends `AccumulatorState`:\\n\\n```\\npublic interface LongAndDoubleState\\n extends AccumulatorState\\n{\\n long getLong();\\n\\n void setLong(long value);\\n\\n double getDouble();\\n\\n void setDouble(double value);\\n}\\n```\\n\\nAs stated above, for simple `AccumulatorState` objects, it is sufficient to\\njust define the interface with the getters and setters, and the framework\\nwill generate the implementation for you.\\n\\nAn in-depth look at the various annotations relevant to writing an aggregation\\nfunction follows:\\n\\n['`@InputFunction`:', 'The `@InputFunction` annotation declares the function which accepts input\\\\nrows and stores them in the `AccumulatorState`. Similar to scalar functions\\\\nyou must annotate the arguments with `@SqlType`. Note that, unlike in the above\\\\nscalar example where `Slice` is used to hold `VARCHAR`, the primitive\\\\n`double` type is used for the argument to input. In this example, the input\\\\nfunction simply keeps track of the running count of rows (via `setLong()`)\\\\nand the running sum (via `setDouble()`).', '`@CombineFunction`:', 'The `@CombineFunction` annotation declares the function used to combine two\\\\nstate objects. This function is used to merge all the partial aggregation states.\\\\nIt takes two state objects, and merges the results into the first one (in the\\\\nabove example, just by adding them together).', '`@OutputFunction`:', 'The `@OutputFunction` is the last function called when computing an\\\\naggregation. It takes the final state object (the result of merging all\\\\npartial states) and writes the result to a `BlockBuilder`.', 'Where does serialization happen, and what is `GroupedAccumulatorState`?', \\\"The `@InputFunction` is usually run on a different worker from the\\\\n`@CombineFunction`, so the state objects are serialized and transported\\\\nbetween these workers by the aggregation framework. `GroupedAccumulatorState`\\\\nis used when performing a `GROUP BY` aggregation, and an implementation\\\\nwill be automatically generated for you, if you don't specify a\\\\n`AccumulatorStateFactory`\\\"]\", \"Deprecated function\": \"The `@Deprecated` annotation has to be used on any function that should no longer be\\nused. The annotation causes Trino to generate a warning whenever SQL statements\\nuse a deprecated function. When a function is deprecated, the `@Description`\\nneeds to be replaced with a note about the deprecation and the replacement function:\\n\\n```\\npublic class ExampleDeprecatedFunction\\n{\\n @Deprecated\\n @ScalarFunction(\\\"bad_function\\\")\\n @Description(\\\"(DEPRECATED) Use good_function() instead\\\")\\n @SqlType(StandardTypes.BOOLEAN)\\n public static boolean bad_function()\\n {\\n return false;\\n }\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 6]\"}, {\"title\": \"Group provider\", \"description\": null, \"content\": {\"Implementation\": \"`GroupProviderFactory` is responsible for creating a `GroupProvider` instance.\\nIt also defines the name of the group provider as used in the configuration file.\\n\\n`GroupProvider` contains a one method, `getGroups(String user)`\\nwhich returns a `Set<String>` of group names.\\nThis set of group names becomes part of the `Identity` and `ConnectorIdentity`\\nobjects representing the user, and can then be used by {doc}`system-access-control`.\\n\\nThe implementation of `GroupProvider` and its corresponding `GroupProviderFactory`\\nmust be wrapped as a Trino plugin and installed on the cluster.\", \"Configuration\": \"After a plugin that implements `GroupProviderFactory` has been installed on the coordinator,\\nit is configured using an `etc/group-provider.properties` file.\\nAll the properties other than `group-provider.name` are specific to\\nthe `GroupProviderFactory` implementation.\\n\\nThe `group-provider.name` property is used by Trino to find a registered\\n`GroupProviderFactory` based on the name returned by `GroupProviderFactory.getName()`.\\nThe remaining properties are passed as a map to\\n`GroupProviderFactory.create(Map<String, String>)`.\\n\\nExample configuration file:\\n\\n```\\ngroup-provider.name=custom-group-provider\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\\n\\nWith that file in place, Trino will attempt user group name resolution,\\nand will be able to use the group names while evaluating access control rules.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 7]\"}, {\"title\": \"Header authenticator\", \"description\": null, \"content\": {\"Implementation\": \"`HeaderAuthenticatorFactory` is responsible for creating a\\n`HeaderAuthenticator` instance. It also defines the name of this\\nauthenticator which is used by the administrator in a Trino configuration.\\n\\n`HeaderAuthenticator` contains a single method, `createAuthenticatedPrincipal()`,\\nwhich validates the request headers wrapped by the Headers interface; has the method getHeader(String name)\\nand returns a `Principal`, which is then authorized by the {doc}`system-access-control`.\\n\\nThe implementation of `HeaderAuthenticatorFactory` must be wrapped\\nas a plugin and installed on the Trino cluster.\", \"Configuration\": \"After a plugin that implements `HeaderAuthenticatorFactory` has been\\ninstalled on the coordinator, it is configured using an\\n`etc/header-authenticator.properties` file. All the\\nproperties other than `header-authenticator.name` are specific to the\\n`HeaderAuthenticatorFactory` implementation.\\n\\nThe `header-authenticator.name` property is used by Trino to find a\\nregistered `HeaderAuthenticatorFactory` based on the name returned by\\n`HeaderAuthenticatorFactory.getName()`. The remaining properties are\\npassed as a map to `HeaderAuthenticatorFactory.create()`.\\n\\nExample configuration file:\\n\\n```\\nheader-authenticator.name=custom\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\\n\\nAdditionally, the coordinator must be configured to use header authentication\\nand have HTTPS enabled (or HTTPS forwarding enabled).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 8]\"}, {\"title\": \"Insert\", \"description\": null, \"content\": {\"Supporting `INSERT` and `CREATE TABLE AS`\": \"To support `INSERT`, a connector must implement:\\n\\n['`beginInsert()` and `finishInsert()` from the `ConnectorMetadata`\\\\ninterface;', 'a `ConnectorPageSinkProvider` that receives a table handle and returns\\\\na `ConnectorPageSink`.']\\n\\nWhen executing an `INSERT` statement, the engine calls the `beginInsert()`\\nmethod in the connector, which receives a table handle and a list of columns.\\nIt should return a `ConnectorInsertTableHandle`, that can carry any\\nconnector specific information, and it's passed to the page sink provider.\\nThe `PageSinkProvider` creates a page sink, that accepts `Page` objects.\\n\\nWhen all the pages for a specific split have been processed, Trino calls\\n`ConnectorPageSink.finish()`, which returns a `Collection<Slice>`\\nof fragments representing connector-specific information about the processed\\nrows.\\n\\nWhen all pages for all splits have been processed, Trino calls\\n`ConnectorMetadata.finishInsert()`, passing a collection containing all\\nthe fragments from all the splits. The connector does what is required\\nto finalize the operation, for example, committing the transaction.\\n\\nTo support `CREATE TABLE AS`, the `ConnectorPageSinkProvider` must also\\nreturn a page sink when receiving a `ConnectorOutputTableHandle`. This handle\\nis returned from `ConnectorMetadata.beginCreateTable()`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 9]\"}, {\"title\": \"Password authenticator\", \"description\": null, \"content\": {\"Implementation\": \"`PasswordAuthenticatorFactory` is responsible for creating a\\n`PasswordAuthenticator` instance. It also defines the name of this\\nauthenticator which is used by the administrator in a Trino configuration.\\n\\n`PasswordAuthenticator` contains a single method, `createAuthenticatedPrincipal()`,\\nthat validates the credential and returns a `Principal`, which is then\\nauthorized by the {doc}`system-access-control`.\\n\\nThe implementation of `PasswordAuthenticatorFactory` must be wrapped\\nas a plugin and installed on the Trino cluster.\", \"Configuration\": \"After a plugin that implements `PasswordAuthenticatorFactory` has been\\ninstalled on the coordinator, it is configured using an\\n`etc/password-authenticator.properties` file. All the\\nproperties other than `password-authenticator.name` are specific to the\\n`PasswordAuthenticatorFactory` implementation.\\n\\nThe `password-authenticator.name` property is used by Trino to find a\\nregistered `PasswordAuthenticatorFactory` based on the name returned by\\n`PasswordAuthenticatorFactory.getName()`. The remaining properties are\\npassed as a map to `PasswordAuthenticatorFactory.create()`.\\n\\nExample configuration file:\\n\\n```\\npassword-authenticator.name=custom-access-control\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\\n\\nAdditionally, the coordinator must be configured to use password authentication\\nand have HTTPS enabled (or HTTPS forwarding enabled).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 10]\"}, {\"title\": \"SPI overview\", \"description\": null, \"content\": {\"Code\": \"The SPI source can be found in the `core/trino-spi` directory in the Trino\\nsource tree.\", \"Plugin metadata\": \"Each plugin identifies an entry point: an implementation of the\\n`Plugin` interface. This class name is provided to Trino via\\nthe standard Java `ServiceLoader` interface: the classpath contains\\na resource file named `io.trino.spi.Plugin` in the\\n`META-INF/services` directory. The content of this file is a\\nsingle line listing the name of the plugin class:\\n\\n```\\ncom.example.plugin.ExamplePlugin\\n```\\n\\nFor a built-in plugin that is included in the Trino source code,\\nthis resource file is created whenever the `pom.xml` file of a plugin\\ncontains the following line:\\n\\n```\\n<packaging>trino-plugin</packaging>\\n```\", \"Plugin\": \"The `Plugin` interface is a good starting place for developers looking\\nto understand the Trino SPI. It contains access methods to retrieve\\nvarious classes that a Plugin can provide. For example, the `getConnectorFactories()`\\nmethod is a top-level function that Trino calls to retrieve a `ConnectorFactory` when Trino\\nis ready to create an instance of a connector to back a catalog. There are similar\\nmethods for `Type`, `ParametricType`, `Function`, `SystemAccessControl`, and\\n`EventListenerFactory` objects.\", \"Building plugins via Maven\": \"Plugins depend on the SPI from Trino:\\n\\n```\\n<dependency>\\n <groupId>io.trino</groupId>\\n <artifactId>trino-spi</artifactId>\\n <scope>provided</scope>\\n</dependency>\\n```\\n\\nThe plugin uses the Maven `provided` scope because Trino provides\\nthe classes from the SPI at runtime and thus the plugin should not\\ninclude them in the plugin assembly.\\n\\nThere are a few other dependencies that are provided by Trino,\\nincluding Slice and Jackson annotations. In particular, Jackson is\\nused for serializing connector handles and thus plugins must use the\\nannotations version provided by Trino.\\n\\nAll other dependencies are based on what the plugin needs for its\\nown implementation. Plugins are loaded in a separate class loader\\nto provide isolation and to allow plugins to use a different version\\nof a library that Trino uses internally.\\n\\nFor an example `pom.xml` file, see the example HTTP connector in the\\n`plugin/trino-example-http` directory in the Trino source tree.\", \"Deploying a custom plugin\": \"Trino plugins must use the `trino-plugin` Maven packaging type provided by the\\n[trino-maven-plugin](https://github.com/trinodb/trino-maven-plugin). Building a\\nplugin generates the required service descriptor and invokes\\n[Provisio](https://github.com/jvanzyl/provisio) to create a ZIP file in the\\n`target` directory. The file contains the plugin JAR and all its dependencies as\\nJAR files, and is suitable for [plugin installation](plugins-installation).\\n\\n(spi-compatibility)=\", \"Compatibility\": \"Successful [download](plugins-download), [installation](plugins-installation),\\nand use of a plugin depends on compatibility of the plugin with the target Trino\\ncluster. Full compatibility is only guaranteed when using the same Trino version\\nused for the plugin build and the deployment, and therefore using the same\\nversion is recommended.\\n\\nFor example, a Trino plugin compiled for Trino 470 may not work with older or\\nnewer versions of Trino such as Trino 430 or Trino 490. This is specifically\\nimportant when installing plugins from other projects, vendors, or your custom\\ndevelopment. \\n\\nTrino plugins implement the SPI, which may change with every Trino release.\\nThere are no runtime checks for SPI compatibility by default, and it is up to\\nthe plugin author to verify compatibility using runtime testing. \\n\\nIf the source code of a plugin is available, you can confirm the Trino version\\nby inspecting the `pom.xml`. A plugin must declare a dependency to the SPI, and\\ntherefore compatibility with the Trino release specified in the `version` tag:\\n\\n```\\n<dependency>\\n <groupId>io.trino</groupId>\\n <artifactId>trino-spi</artifactId>\\n <version>470</version>\\n <scope>provided</scope>\\n</dependency>\\n```\\n\\nA good practice for plugins is to use a property for the version value, which is\\nthen declared elsewhere in the `pom.xml`:\\n\\n```\\n...\\n<dep.trino.version>470</dep.trino.version>\\n...\\n<dependency>\\n <groupId>io.trino</groupId>\\n <artifactId>trino-spi</artifactId>\\n <version>${dep.trino.version}</version>\\n <scope>provided</scope>\\n</dependency>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 11]\"}, {\"title\": \"Supporting `MERGE`\", \"description\": null, \"content\": {\"Standard SQL `MERGE`\": \"Different query engines support varying definitions of SQL `MERGE`.\\nTrino supports the strict SQL specification `ISO/IEC 9075`, published\\nin 2016. As a simple example, given tables `target_table` and\\n`source_table` defined as:\\n\\n```\\nCREATE TABLE accounts (\\n customer VARCHAR,\\n purchases DECIMAL,\\n address VARCHAR);\\nINSERT INTO accounts (customer, purchases, address) VALUES ...;\\nCREATE TABLE monthly_accounts_update (\\n customer VARCHAR,\\n purchases DECIMAL,\\n address VARCHAR);\\nINSERT INTO monthly_accounts_update (customer, purchases, address) VALUES ...;\\n```\\n\\nHere is a possible `MERGE` operation, from `monthly_accounts_update` to\\n`accounts`:\\n\\n```\\nMERGE INTO accounts t USING monthly_accounts_update s\\n ON (t.customer = s.customer)\\n WHEN MATCHED AND s.address = 'Berkeley' THEN\\n DELETE\\n WHEN MATCHED AND s.customer = 'Joe Shmoe' THEN\\n UPDATE SET purchases = purchases + 100.0\\n WHEN MATCHED THEN\\n UPDATE\\n SET purchases = s.purchases + t.purchases, address = s.address\\n WHEN NOT MATCHED THEN\\n INSERT (customer, purchases, address)\\n VALUES (s.customer, s.purchases, s.address);\\n```\\n\\nSQL `MERGE` tries to match each `WHEN` clause in source order. When\\na match is found, the corresponding `DELETE`, `INSERT` or `UPDATE`\\nis executed and subsequent `WHEN` clauses are ignored.\\n\\nSQL `MERGE` supports two operations on the target table and source\\nwhen a row from the source table or query matches a row in the target table:\\n\\n['`UPDATE`, in which the columns in the target row are updated.', '`DELETE`, in which the target row is deleted.']\\n\\nIn the `NOT MATCHED` case, SQL `MERGE` supports only `INSERT`\\noperations. The values inserted are arbitrary but usually come from\\nthe unmatched row of the source table or query.\", \"`RowChangeParadigm`\": \"Different connectors have different ways of representing row updates,\\nimposed by the underlying storage systems. The Trino engine classifies\\nthese different paradigms as elements of the `RowChangeParadigm`\\nenumeration, returned by enumeration, returned by method\\n`ConnectorMetadata.getRowChangeParadigm(...)`.\\n\\nThe `RowChangeParadigm` enumeration values are:\\n\\n['`CHANGE_ONLY_UPDATED_COLUMNS`, intended for connectors that can update\\\\nindividual columns of rows identified by a `rowId`. The corresponding\\\\nmerge processor class is `ChangeOnlyUpdatedColumnsMergeProcessor`.', '`DELETE_ROW_AND_INSERT_ROW`, intended for connectors that represent a\\\\nrow change as a row deletion paired with a row insertion. The corresponding\\\\nmerge processor class is `DeleteAndInsertMergeProcessor`.']\", \"Overview of `MERGE` processing\": \"A `MERGE` statement is processed by creating a `RIGHT JOIN` between the\\ntarget table and the source, on the `MERGE` criteria. The source may be\\na table or an arbitrary query. For each row in the source table or query,\\n`MERGE` produces a `ROW` object containing:\\n\\n['the data column values from the `UPDATE` or `INSERT` cases. For the\\\\n`DELETE` cases, only the partition columns, which determine\\\\npartitioning and bucketing, are non-null.', 'a boolean column containing `true` for source rows that matched some\\\\ntarget row, and `false` otherwise.', \\\"an integer that identifies whether the merge case operation is `UPDATE`,\\\\n`DELETE` or `INSERT`, or a source row for which no case matched. If a\\\\nsource row doesn't match any merge case, all data column values except\\\\nthose that determine distribution are null, and the operation number\\\\nis -1.\\\"]\\n\\nA `SearchedCaseExpression` is constructed from `RIGHT JOIN` result\\nto represent the `WHEN` clauses of the `MERGE`. In the example preceding\\nthe `MERGE` is executed as if the `SearchedCaseExpression` were written as:\\n\\n```\\nSELECT\\n CASE\\n WHEN present AND s.address = 'Berkeley' THEN\\n -- Null values for delete; present=true; operation DELETE=2, case_number=0\\n row(null, null, null, true, 2, 0)\\n WHEN present AND s.customer = 'Joe Shmoe' THEN\\n -- Update column values; present=true; operation UPDATE=3, case_number=1\\n row(t.customer, t.purchases + 100.0, t.address, true, 3, 1)\\n WHEN present THEN\\n -- Update column values; present=true; operation UPDATE=3, case_number=2\\n row(t.customer, s.purchases + t.purchases, s.address, true, 3, 2)\\n WHEN (present IS NULL) THEN\\n -- Insert column values; present=false; operation INSERT=1, case_number=3\\n row(s.customer, s.purchases, s.address, false, 1, 3)\\n ELSE\\n -- Null values for no case matched; present=false; operation=-1,\\n -- case_number=-1\\n row(null, null, null, false, -1, -1)\\n END\\n FROM (SELECT *, true AS present FROM target_table) t\\n RIGHT JOIN source_table s ON s.customer = t.customer;\\n```\\n\\nThe Trino engine executes the `RIGHT JOIN` and `CASE` expression,\\nand ensures that no target table row matches more than one source expression\\nrow, and ultimately creates a sequence of pages to be routed to the node that\\nruns the `ConnectorMergeSink.storeMergedRows(...)` method.\\n\\nLike `DELETE` and `UPDATE`, `MERGE` target table rows are identified by\\na connector-specific `rowId` column handle. For `MERGE`, the `rowId`\\nhandle is returned by `ConnectorMetadata.getMergeRowIdColumnHandle(...)`.\", \"`MERGE` redistribution\": {\"Connector support for `MERGE`\": \"To start `MERGE` processing, the Trino engine calls:\\n\\n['`ConnectorMetadata.getMergeRowIdColumnHandle(...)` to get the\\\\n`rowId` column handle.', '`ConnectorMetadata.getRowChangeParadigm(...)` to get the paradigm\\\\nsupported by the connector for changing existing table rows.', '`ConnectorMetadata.beginMerge(...)` to get the a\\\\n`ConnectorMergeTableHandle` for the merge operation. That\\\\n`ConnectorMergeTableHandle` object contains whatever information the\\\\nconnector needs to specify the `MERGE` operation.', '`ConnectorMetadata.getInsertLayout(...)`, from which it extracts the\\\\nlist of partition or table columns that impact write redistribution.', '`ConnectorMetadata.getUpdateLayout(...)`. If that layout is non-empty,\\\\nit is used to distribute updated rows resulting from the `MERGE`\\\\noperation.']\\n\\nOn nodes that are targets of the hash, the Trino engine calls\\n`ConnectorPageSinkProvider.createMergeSink(...)` to create a\\n`ConnectorMergeSink`.\\n\\nTo write out each page of merged rows, the Trino engine calls\\n`ConnectorMergeSink.storeMergedRows(Page)`. The `storeMergedRows(Page)`\\nmethod iterates over the rows in the page, performing updates and deletes\\nin the `MATCHED` cases, and inserts in the `NOT MATCHED` cases.\\n\\nWhen using `RowChangeParadigm.DELETE_ROW_AND_INSERT_ROW`, the engine\\ntranslates `UPDATE` operations into a pair of `DELETE` and `INSERT`\\noperations before `storeMergedRows(Page)` is called.\\n\\nTo complete the `MERGE` operation, the Trino engine calls\\n`ConnectorMetadata.finishMerge(...)`, passing the table handle\\nand a collection of JSON objects encoded as `Slice` instances. These\\nobjects contain connector-specific information specifying what was changed\\nby the `MERGE` operation. Typically this JSON object contains the files\\nwritten and table and partition statistics generated by the `MERGE`\\noperation. The connector takes appropriate actions, if any.\"}, \"`RowChangeProcessor` implementation for `MERGE`\": \"In the `MERGE` implementation, each `RowChangeParadigm`\\ncorresponds to an internal Trino engine class that implements interface\\n`RowChangeProcessor`. `RowChangeProcessor` has one interesting method:\\n`Page transformPage(Page)`. The format of the output page depends\\non the `RowChangeParadigm`.\\n\\nThe connector has no access to the `RowChangeProcessor` instance -- it\\nis used inside the Trino engine to transform the merge page rows into rows\\nto be stored, based on the connector's choice of `RowChangeParadigm`.\\n\\nThe page supplied to `transformPage()` consists of:\\n\\n['The write redistribution columns if any', 'For partitioned or bucketed tables, a long hash value column.', 'The `rowId` column for the row from the target table if matched, or\\\\nnull if not matched', 'The merge case `RowBlock`', 'The integer case number block', 'The byte `is_distinct` block, with value 0 if not distinct.']\\n\\nThe merge case `RowBlock` has the following layout:\\n\\n['Blocks for each column in the table, including partition columns, in\\\\ntable column order.', 'A block containing the boolean \\\"present\\\" value which is true if the\\\\nsource row matched a target row, and false otherwise.', 'A block containing the `MERGE` case operation number, encoded as\\\\n`INSERT` = 1, `DELETE` = 2, `UPDATE` = 3 and if no `MERGE`\\\\ncase matched, -1.', 'A block containing the `MERGE` case number, the number starting with 0, for the\\\\n`WHEN` clause that matched for the row, or -1 if no clause\\\\nmatched.']\\n\\nThe page returned from `transformPage` consists of:\\n\\n['All table columns, in table column order.', 'The tinyint type merge case operation block.', 'The integer type merge case number block.', 'The rowId block remains unchanged from the provided input page.', 'A byte block containing 1 if the row is an insert derived from an\\\\nupdate operation, and 0 otherwise. This block is used to correctly\\\\ncalculate the count of rows changed for connectors that represent\\\\nupdates and deletes plus inserts.']\\n\\n`transformPage`\\nmust ensure that there are no rows whose operation number is -1 in\\nthe page it returns.\", \"Detecting duplicate matching target rows\": \"The SQL `MERGE` specification requires that in each `MERGE` case,\\na single target table row must match at most one source row, after\\napplying the `MERGE` case condition expression. The first step\\ntoward finding these error is done by labeling each row in the target\\ntable with a unique id, using an `AssignUniqueId` node above the\\ntarget table scan. The projected results from the `RIGHT JOIN`\\nhave these unique ids for matched target table rows as well as\\nthe `WHEN` clause number. A `MarkDistinct` node adds an\\n`is_distinct` column which is true if no other row has the same\\nunique id and `WHEN` clause number, and false otherwise. If\\nany row has `is_distinct` equal to false, a\\n`MERGE_TARGET_ROW_MULTIPLE_MATCHES` exception is raised and\\nthe `MERGE` operation fails.\", \"`ConnectorMergeTableHandle` API\": \"Interface `ConnectorMergeTableHandle` defines one method,\\n`getTableHandle()` to retrieve the `ConnectorTableHandle`\\noriginally passed to `ConnectorMetadata.beginMerge()`.\", \"`ConnectorPageSinkProvider` API\": \"To support SQL `MERGE`, `ConnectorPageSinkProvider` must implement\\nthe method that creates the `ConnectorMergeSink`:\\n\\n['`createMergeSink`:', '```\\\\nConnectorMergeSink createMergeSink(\\\\n ConnectorTransactionHandle transactionHandle,\\\\n ConnectorSession session,\\\\n ConnectorMergeTableHandle mergeHandle)\\\\n```']\", \"`ConnectorMergeSink` API\": \"To support `MERGE`, the connector must define an\\nimplementation of `ConnectorMergeSink`, usually layered over the\\nconnector's `ConnectorPageSink`.\\n\\nThe `ConnectorMergeSink` is created by a call to\\n`ConnectorPageSinkProvider.createMergeSink()`.\\n\\nThe only interesting methods are:\\n\\n['`storeMergedRows`:', '```\\\\nvoid storeMergedRows(Page page)\\\\n```', 'The Trino engine calls the `storeMergedRows(Page)` method of the\\\\n`ConnectorMergeSink` instance returned by\\\\n`ConnectorPageSinkProvider.createMergeSink()`, passing the page\\\\ngenerated by the `RowChangeProcessor.transformPage()` method.\\\\nThat page consists of all table columns, in table column order,\\\\nfollowed by the `TINYINT` operation column, followed by the `INTEGER`\\\\nmerge case number column, followed by the rowId column.', 'The job of `storeMergedRows()` is iterate over the rows in the page,\\\\nand process them based on the value of the operation column, `INSERT`,\\\\n`DELETE`, `UPDATE`, or ignore the row. By choosing appropriate\\\\nparadigm, the connector can request that the UPDATE operation be\\\\ntransformed into `DELETE` and `INSERT` operations.', '`finish`:', '```\\\\nCompletableFuture<Collection<Slice>> finish()\\\\n```', 'The Trino engine calls `finish()` when all the data has been processed by\\\\na specific `ConnectorMergeSink` instance. The connector returns a future\\\\ncontaining a collection of `Slice`, representing connector-specific\\\\ninformation about the rows processed. Usually this includes the row count,\\\\nand might include information like the files or partitions created or\\\\nchanged.']\", \"`ConnectorMetadata` `MERGE` API\": \"A connector implementing `MERGE` must implement these `ConnectorMetadata`\\nmethods.\\n\\n['`getRowChangeParadigm()`:', '```\\\\nRowChangeParadigm getRowChangeParadigm(\\\\n ConnectorSession session,\\\\n ConnectorTableHandle tableHandle)\\\\n```', \\\"This method is called as the engine starts processing a `MERGE` statement.\\\\nThe connector must return a `RowChangeParadigm` enumeration instance. If\\\\nthe connector doesn't support `MERGE`, then it should throw a\\\\n`NOT_SUPPORTED` exception to indicate that SQL `MERGE` isn't supported by\\\\nthe connector. Note that the default implementation already throws this\\\\nexception when the method isn't implemented.\\\", '`getMergeRowIdColumnHandle()`:', '```\\\\nColumnHandle getMergeRowIdColumnHandle(\\\\n ConnectorSession session,\\\\n ConnectorTableHandle tableHandle)\\\\n```', 'This method is called in the early stages of query planning for `MERGE`\\\\nstatements. The ColumnHandle returned provides the `rowId` used by the\\\\nconnector to identify rows to be merged, as well as any other fields of\\\\nthe row that the connector needs to complete the `MERGE` operation.', '`getInsertLayout()`:', '```\\\\nOptional<ConnectorTableLayout> getInsertLayout(\\\\n ConnectorSession session,\\\\n ConnectorTableHandle tableHandle)\\\\n```', 'This method is called during query planning to get the table layout to be\\\\nused for rows inserted by the `MERGE` operation. For some connectors,\\\\nthis layout is used for rows deleted as well.', '`getUpdateLayout()`:', '```\\\\nOptional<ConnectorTableLayout> getUpdateLayout(\\\\n ConnectorSession session,\\\\n ConnectorTableHandle tableHandle)\\\\n```', 'This method is called during query planning to get the table layout to be\\\\nused for rows deleted by the `MERGE` operation. If the optional return\\\\nvalue is present, the Trino engine uses the layout for updated rows.\\\\nOtherwise, it uses the result of `ConnectorMetadata.getInsertLayout` to\\\\ndistribute updated rows.', '`beginMerge()`:', '```\\\\nConnectorMergeTableHandle beginMerge(\\\\n ConnectorSession session,\\\\n ConnectorTableHandle tableHandle)\\\\n```', \\\"As the last step in creating the `MERGE` execution plan, the connector's\\\\n`beginMerge()` method is called, passing the `session`, and the\\\\n`tableHandle`.\\\", '`beginMerge()` performs any orchestration needed in the connector to\\\\nstart processing the `MERGE`. This orchestration varies from connector\\\\nto connector. In the case of Hive connector operating on transactional tables,\\\\nfor example, `beginMerge()` checks that the table is transactional and\\\\nstarts a Hive Metastore transaction.', '`beginMerge()` returns a `ConnectorMergeTableHandle` with any added\\\\ninformation the connector needs when the handle is passed back to\\\\n`finishMerge()` and the split generation machinery. For most\\\\nconnectors, the returned table handle contains at least a flag identifying\\\\nthe table handle as a table handle for a `MERGE` operation.', '`finishMerge()`:', '```\\\\nvoid finishMerge(\\\\n ConnectorSession session,\\\\n ConnectorMergeTableHandle tableHandle,\\\\n Collection<Slice> fragments)\\\\n```', 'During `MERGE` processing, the Trino engine accumulates the `Slice`\\\\ncollections returned by `ConnectorMergeSink.finish()`. The engine calls\\\\n`finishMerge()`, passing the table handle and that collection of\\\\n`Slice` fragments. In response, the connector takes appropriate actions\\\\nto complete the `MERGE` operation. Those actions might include\\\\ncommitting an underlying transaction, if any, or freeing any other\\\\nresources.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 12]\"}, {\"title\": \"System access control\", \"description\": null, \"content\": {\"Implementation\": \"`SystemAccessControlFactory` is responsible for creating a\\n`SystemAccessControl` instance. It also defines a `SystemAccessControl`\\nname which is used by the administrator in a Trino configuration.\\n\\n`SystemAccessControl` implementations have several responsibilities:\\n\\n['Verifying whether or not a given principal is authorized to execute queries as a specific user.', 'Determining whether or not a given user can alter values for a given system property.', 'Performing access checks across all catalogs. These access checks happen before\\\\nany connector specific checks and thus can deny permissions that would otherwise\\\\nbe allowed by `ConnectorAccessControl`.']\\n\\nThe implementation of `SystemAccessControl` and `SystemAccessControlFactory`\\nmust be wrapped as a plugin and installed on the Trino cluster.\", \"Configuration\": \"After a plugin that implements `SystemAccessControl` and\\n`SystemAccessControlFactory` has been installed on the coordinator, it is\\nconfigured using the file(s) specified by the `access-control.config-files`\\nproperty (the default is a single `etc/access-control.properties` file).\\nAll the properties other than `access-control.name` are specific to\\nthe `SystemAccessControl` implementation.\\n\\nThe `access-control.name` property is used by Trino to find a registered\\n`SystemAccessControlFactory` based on the name returned by\\n`SystemAccessControlFactory.getName()`. The remaining properties are passed\\nas a map to `SystemAccessControlFactory.create()`.\\n\\nExample configuration file:\\n\\n```\\naccess-control.name=custom-access-control\\ncustom-property1=custom-value1\\ncustom-property2=custom-value2\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 13]\"}, {\"title\": \"Table functions\", \"description\": null, \"content\": {\"Table function declaration\": {\"The constructor\": \"```\\npublic class MyFunction\\n extends AbstractConnectorTableFunction\\n{\\n public MyFunction()\\n {\\n super(\\n \\\"system\\\",\\n \\\"my_function\\\",\\n List.of(\\n ScalarArgumentSpecification.builder()\\n .name(\\\"COLUMN_COUNT\\\")\\n .type(INTEGER)\\n .defaultValue(2)\\n .build(),\\n ScalarArgumentSpecification.builder()\\n .name(\\\"ROW_COUNT\\\")\\n .type(INTEGER)\\n .build()),\\n GENERIC_TABLE);\\n }\\n}\\n```\\n\\nThe constructor takes the following arguments:\\n\\n['**schema name**']\\n\\nThe schema name helps you organize functions, and it is used for function\\nresolution. When a table function is invoked, the right implementation is\\nidentified by the catalog name, the schema name, and the function name.\\n\\nThe function can use the schema name, for example to use data from the\\nindicated schema, or ignore it.\\n\\n['**function name**', '**list of expected arguments**']\\n\\nThree different types of arguments are supported: scalar arguments, descriptor\\narguments, and table arguments. See {ref}`tf-argument-types` for details. You can\\nspecify default values for scalar and descriptor arguments. The arguments with\\nspecified default can be skipped during table function invocation.\\n\\n['**returned row type**']\\n\\nIt describes the row type produced by the table function.\\n\\nIf a table function takes table arguments, it can additionally pass the columns\\nof the input tables to output using the *pass-through mechanism*. The returned\\nrow type is supposed to describe only the columns produced by the function, as\\nopposed to the pass-through columns.\\n\\nIn the example, the returned row type is `GENERIC_TABLE`, which means that\\nthe row type is not known statically, and it is determined dynamically based on\\nthe passed arguments.\\n\\nWhen the returned row type is known statically, you can declare it using:\\n\\n```\\nnew DescribedTable(descriptor)\\n```\\n\\nIf a table function does not produce any columns, and it only outputs the\\npass-through columns, use `ONLY_PASS_THROUGH` as the returned row type.\\n\\n:::{note}\\nA table function must return at least one column. It can either be a proper\\ncolumn, i.e. produced by the function, or a pass-through column.\\n:::\\n\\n(tf-argument-types)=\", \"Argument types\": {\"Scalar arguments\": \"They can be of any supported data type. You can specify a default value.\\n\\n```\\nScalarArgumentSpecification.builder()\\n .name(\\\"COLUMN_COUNT\\\")\\n .type(INTEGER)\\n .defaultValue(2)\\n .build()\\n```\\n\\n```\\nScalarArgumentSpecification.builder()\\n .name(\\\"ROW_COUNT\\\")\\n .type(INTEGER)\\n .build()\\n```\\n\\n(tf-descriptor-arguments)=\", \"Descriptor arguments\": \"Descriptors consist of fields with names and optional data types. They are a\\nconvenient way to pass the required result row type to the function, or for\\nexample inform the function which input columns it should use. You can specify\\ndefault values for descriptor arguments. Descriptor argument can be `null`.\\n\\n```\\nDescriptorArgumentSpecification.builder()\\n .name(\\\"SCHEMA\\\")\\n .defaultValue(null)\\n .build()\\n```\\n\\n(tf-table-arguments)=\", \"Table arguments\": {\"Set or row semantics\": \"Set semantics is the default for table arguments. A table argument with set\\nsemantics is processed on a partition-by-partition basis. During function\\ninvocation, the user can specify partitioning and ordering for the argument. If\\nno partitioning is specified, the argument is processed as a single partition.\\n\\nA table argument with row semantics is processed on a row-by-row basis.\\nPartitioning or ordering is not applicable.\", \"Prune or keep when empty\": \"The *prune when empty* property indicates that if the given table argument is\\nempty, the function returns empty result. This property is used to optimize\\nqueries involving table functions. The *keep when empty* property indicates\\nthat the function should be executed even if the table argument is empty. The\\nuser can override this property when invoking the function. Using the *keep\\nwhen empty* property can negatively affect performance when the table argument\\nis not empty.\", \"Pass-through columns\": \"If a table argument has *pass-through columns*, all of its columns are passed\\non output. For a table argument without this property, only the partitioning\\ncolumns are passed on output.\"}}, \"The `analyze()` method\": \"In order to provide all the necessary information to the Trino engine, the\\nclass must implement the `analyze()` method. This method is called by the\\nengine during the analysis phase of query processing. The `analyze()` method\\nis also the place to perform custom checks on the arguments:\\n\\n```\\n@Override\\npublic TableFunctionAnalysis analyze(ConnectorSession session, ConnectorTransactionHandle transaction, Map<String, Argument> arguments)\\n{\\n long columnCount = (long) ((ScalarArgument) arguments.get(\\\"COLUMN_COUNT\\\")).getValue();\\n long rowCount = (long) ((ScalarArgument) arguments.get(\\\"ROW_COUNT\\\")).getValue();\\n\\n // custom validation of arguments\\n if (columnCount < 1 || columnCount > 3) {\\n throw new TrinoException(INVALID_FUNCTION_ARGUMENT, \\\"column_count must be in range [1, 3]\\\");\\n }\\n\\n if (rowCount < 1) {\\n throw new TrinoException(INVALID_FUNCTION_ARGUMENT, \\\"row_count must be positive\\\");\\n }\\n\\n // determine the returned row type\\n List<Descriptor.Field> fields = List.of(\\\"col_a\\\", \\\"col_b\\\", \\\"col_c\\\").subList(0, (int) columnCount).stream()\\n .map(name -> new Descriptor.Field(name, Optional.of(BIGINT)))\\n .collect(toList());\\n\\n Descriptor returnedType = new Descriptor(fields);\\n\\n return TableFunctionAnalysis.builder()\\n .returnedType(returnedType)\\n .handle(new MyHandle(columnCount, rowCount))\\n .build();\\n}\\n```\\n\\nThe `analyze()` method returns a `TableFunctionAnalysis` object, which\\ncomprises all the information required by the engine to analyze, plan, and\\nexecute the table function invocation:\\n\\n['The returned row type, specified as an optional `Descriptor`. It should be\\\\npassed if and only if the table function is declared with the\\\\n`GENERIC_TABLE` returned type.', 'Required columns from the table arguments, specified as a map of table\\\\nargument names to lists of column indexes.', 'Any information gathered during analysis that is useful during planning or\\\\nexecution, in the form of a `ConnectorTableFunctionHandle`.\\\\n`ConnectorTableFunctionHandle` is a marker interface intended to carry\\\\ninformation throughout subsequent phases of query processing in a manner that\\\\nis opaque to the engine.']\"}, \"Table function execution\": \"There are two paths of execution available for table functions.\\n\\n['Pushdown to the connector']\\n\\nThe connector that provides the table function implements the\\n`applyTableFunction()` method. This method is called during the optimization\\nphase of query processing. It returns a `ConnectorTableHandle` and a list of\\n`ColumnHandle` s representing the table function result. The table function\\ninvocation is then replaced with a `TableScanNode`.\\n\\nThis execution path is convenient for table functions whose results are easy to\\nrepresent as a `ConnectorTableHandle`, for example query pass-through. It\\nonly supports scalar and descriptor arguments.\\n\\n['Execution by operator']\\n\\nTrino has a dedicated operator for table functions. It can handle table\\nfunctions with any number of table arguments as well as scalar and descriptor\\narguments. To use this execution path, you provide an implementation of a\\nprocessor.\\n\\nIf your table function has one or more table arguments, you must implement\\n`TableFunctionDataProcessor`. It processes pages of input data.\\n\\nIf your table function is a source operator (it does not have table arguments),\\nyou must implement `TableFunctionSplitProcessor`. It processes splits. The\\nconnector that provides the function must provide a `ConnectorSplitSource`\\nfor the function. With splits, the task can be divided so that each split\\nrepresents a subtask.\", \"Access control\": \"The access control for table functions can be provided both on system and\\nconnector level. It is based on the fully qualified table function name,\\nwhich consists of the catalog name, the schema name, and the function name,\\nin the syntax of `catalog.schema.function`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 14]\"}, {\"title\": \"Test writing guidelines\", \"description\": null, \"content\": {\"Conventions and recommendations\": \"The following section details conventions and recommendations to follow when\\ncreating new tests or refactoring existing test code. The preferred approaches\\nThe existing codebase is a mixture of newer test code that adheres to these\\nguidelines and older legacy code. The legacy test code should not be used as\\nexample for new tests, rather follow the guidelines in this document.\\n\\nAlso note that the guidelines are subject to change in a process of further\\nrefinement and improvements from practical experience.\\n\\nA number of requirements apply to all new tests, and any refactoring work of\\nexisting tests:\\n\\n['All tests must use JUnit 5.', 'All tests must use statically imported AssertJ assertions, typically from\\\\n`org.assertj.core.api.Assertions`.', 'Test class names must start with `Test`, for example `TestExample`', 'Test classes should be defined as package-private and final.', 'Test method must start with `test`, for example `testExplain()`', 'Test methods should be defined as package-private.', 'Tests must be written as unit tests, including tests that abstract production\\\\ninfrastructure with TestContainers, when possible. Product or other\\\\nintegration tests should be avoided. These tests typically rely on external\\\\ninfrastructure, use a full Trino runtime, and therefore are often slower and\\\\nsuffer from reliability issues.', 'Tests must not be duplicated across unit and product tests, or different\\\\nplugins and other integrations.']\", \"Guidelines\": {\"Focus on high value tests\": \"Testing in Trino is extremely expensive, and slows down all development as they\\ntake hours of compute time in a limited environment. For large expensive tests,\\nconsider the value the test brings to Trino, and ensure the value is justified\\nby the cost. We effectively have a limited budget for testing, and CI tests\\nqueue on most days, often for many hours, which reduces the overall project\\nvelocity.\", \"Avoid combinatorial tests\": \"Prefer tests of items in isolation and test a few common combinations to verify\\nintegrations are functional. Do not implement tests for all possible\\ncombinations.\", \"Avoid product tests\": \"If you can create a unit test for a feature, use a unit test and avoid writing a\\nproduct test. Over time the aim is to remove the majority of product tests, and\\navoiding new product tests helps to prevent the migration costs from growing.\\n\\nOnly use product tests in the following cases:\\n\\n['Minimal, high level integration testing that uses a full server. For example,\\\\nthis can verify that a plugin works correctly with the plugin classloader and\\\\nclasspath.', 'When the test code needs to run in a specialized environment, such as a\\\\ncontainer with Kerberos configured. Only run the minimum set of tests\\\\nnecessary to verify this integration.']\", \"Avoid creating testing abstractions\": \"The following approaches should be avoided because the existing build tools and\\nframeworks provide sufficient capabilities:\\n\\n['Creating custom dispatch frameworks for parallelizing test execution', 'Creating test-specific assertion frameworks', 'Creating custom parameterized test frameworks']\", \"Avoid data providers and parametric tests\": \"Data providers and parametric tests add unnecessary complexity. Consider\\nfocusing on high value tests and avoiding combinatorial tests, and the\\nfollowing details:\\n\\n['Most data providers are either trivially small, or generate massive\\\\ncombinatorial, indiscriminate, data sets for testing.', 'Prefer to write explicit test cases for trivial cases like a boolean\\\\nparameter.', 'For small datasets, use a \\u201cfor-each item in an inline list\\u201d.', 'For larger datasets, consider using a type safe enum class.', 'For large test datasets, discuss your use case with Trino maintainers to work\\\\non a solution or other guidance.', 'Avoid multiple independent data providers in a test, including multiple nested\\\\nfor loops or multiple data provider parameters.']\", \"Avoid writing stateful test classes\": \"Stateful tests can lead to issues from on one test leaking into other tests,\\nespecially when test runs are parallelized. As a result debugging and\\ntroubleshooting test failures and maintenance of the tests is more difficult. If\\npossible these stateful test classes should be avoided.\", \"Do not try to manage memory\": \"JUnit and the JVM take care of test life cycle and memory management. Avoid\\nmanual steps such as nulling out fields in `@After` methods to \\u201cfree memory\\u201d. It\\nis safe to assign memory intensive objects to final fields, as the class is\\nautomatically dereferenced after the test run.\", \"Use simple resource initialization\": \"Prefer resource initialization in constructors and tear them down in `@After`\\nmethods if necessary. This approach, combined with not nulling fields, allows\\nthe fields to be final and behave like any `Closeable` class in normal Java code\\nConsider using the Guava `Closer` class to simplify cleanup.\", \"Keep test setup and teardown simple\": \"Avoid the `@Before`/`@After` each test method style of setup and teardown.\\n\\n['Prefer try-with-resources if natural', 'If necessary, use a shared initialization or cleanup method that is explicitly\\\\ncalled.', 'If you have a test that benefits from @Before/After methods, discuss the\\\\napproach with the maintainers to develop a solution and improve guidance.']\", \"Ensure testability of new plugin and connector features\": \"New plugin/connector features should be testable using one of the testing\\nplugins (e.g., memory or null). There are existing features only tested in\\nplugins in Hive, and over time we expect coverage using the testing plugins\", \"Keep focus on plugin and connector tests\": \"For plugins and specifically connector plugins, focus on the code unique to the\\nplugin. Do not add tests for core engine features. Plugins should be focused on\\nthe correctness of the SPI implementation, and compatibility with external\\nsystems.\", \"Avoid flaky tests\": \"Flaky tests are test that are not reliable. Multiple runs of the same test\\nresult in inconsistent results. Typically the tests are successful, and then\\nrarely fail. Reasons for flakiness include reliance on external, unstable\\nsystems, connections, and other hard to troubleshoot setups.\\n\\nExisting flaky tests using the legacy TestNG library can be marked with the\\n`@Flaky` annotation temporarily to improve CI reliability until a fix is\\nimplemented:\\n\\n['Ideally the fix is to make the test reliable.', 'Rewrite the test to not rely on flakey infrastructure, including the practice\\\\nto avoid HDFS.', 'If necessary, add explicit retries, but be cognizant of resource usage.']\\n\\nAfter a certain time period, if the test hasn\\u2019t been fixed, it should be\\nremoved.\\n\\nNew tests with the `@Flaky` annotation can not be introduced, since new tests\\nmust use JUnit. Rewrite the test to be stable or avoid the test altogether.\", \"Avoid disabling tests\": \"Prefer to remove a test instead of disabling it. Test code is maintained and\\nupdated as the codebase changes, and inactive tests just waste time and effort.\\n\\nDisabled tests can be removed at any time.\", \"Avoid using `Assumptions.abort()`\": \"The approach to use `Assumptions.abort()` to skip a test, especially deep in the\\ncall stack, makes it difficult to debug tests failures. The `abort()` works by\\nthrowing an exception, which can be caught by intervening code inadvertently,\\nleading to misleading stack traces and test failures.\", \"Avoid test inheritance\": \"Inheritance of tests creates unnecessary complexity. Keep tests simple and use\\ncomposition if necessary.\"}, \"Avoid helper assertions\": \"The required usage of AssertJ provides a rich set of assertions, that typically\\nmakes custom helper assertions unnecessary. Custom assertions often make tests\\nharder to follow and debug.\\n\\nIf you decide a helper assertion is needed, consider the following details:\\n\\n['Start the name with `assert`, for example `assertSomeLogicWorks`', 'Prefer private and static']\", \"Examples\": {\"Concurrency for tests\": \"Use `PER_CLASS` for instances because `QueryAssertions` is too expensive to\\ncreate per-method, and a allow parallel execution of tests with `CONCURRENT`:\\n\\n```\\n@TestInstance(PER_CLASS)\\n@Execution(CONCURRENT)\\nfinal class TestJoin\\n{\\n private final QueryAssertions assertions = new QueryAssertions();\\n\\n @AfterAll\\n void teardown()\\n {\\n assertions.close();\\n }\\n\\n @Test\\n void testXXX()\\n {\\n assertThat(assertions.query(\\n \\\"\\\"\\\"\\n ...\\n \\\"\\\"\\\"))\\n .matches(\\\"...\\\");\\n }\\n}\\n```\", \"Avoid manual lifecycle management\": \"Avoid managing the lifecycle of a Closeable like a connection with\\n`@BeforeEach`/`@AfterEach` to reduce overhead:\\n\\n```\\n@TestInstance(PER_METHOD)\\nfinal class Test\\n{\\n private Connection connection;\\n\\n @BeforeEach\\n void setup()\\n {\\n // WRONG: create this in the test method using try-with-resources\\n connection = newConnection();\\n }\\n\\n @AfterEach\\n void teardown()\\n {\\n connection.close();\\n }\\n\\n @Test\\n void test()\\n {\\n ...\\n }\\n}\\n```\\n\\nUsing a try with resources approach allows clean parallelization of tests and\\nincludes automatic memory management:\\n\\n```\\nfinal class Test\\n{\\n\\n @Test\\n void testSomething()\\n {\\n try (Connection connection = newConnection();) {\\n ...\\n }\\n }\\n\\n @Test\\n void testSomethingElse()\\n {\\n try (Connection connection = newConnection();) {\\n ...\\n }\\n }\\n}\\n```\"}, \"Avoid fake abstractions\": \"Avoid using fake abstraction for tests.\\n\\n```\\n@DataProvider(name = \\\"data\\\")\\nvoid test(boolean flag)\\n{\\n // WRONG: use separate test methods\\n assertEqual(\\n flag ? ... : ...,\\n flag ? ... : ...);\\n}\\n```\\n\\nReplace with simplified separate assertions:\\n\\n```\\nvoid test()\\n{\\n assertThat(...).isEqualTo(...); // case corresponding to flag == true\\n assertThat(...).isEqualTo(...); // case corresponding to flag == false\\n}\\n```\", \"Avoid custom parallelization\": \"Do not develop a custom parallel test execution framework:\\n\\n```\\n@Test(dataProvider = \\\"parallelTests\\\")\\nvoid testParallel(Runnable runnable)\\n{\\n try {\\n parallelTestsSemaphore.acquire();\\n }\\n catch (InterruptedException e) {\\n Thread.currentThread().interrupt();\\n throw new RuntimeException(e);\\n }\\n try {\\n runnable.run();\\n }\\n finally {\\n parallelTestsSemaphore.release();\\n }\\n}\\n\\n@DataProvider(name = \\\"parallelTests\\\", parallel = true)\\nObject[][] parallelTests()\\n{\\n return new Object[][] {\\n parallelTest(\\\"testCreateTable\\\", this::testCreateTable),\\n parallelTest(\\\"testInsert\\\", this::testInsert),\\n parallelTest(\\\"testDelete\\\", this::testDelete),\\n parallelTest(\\\"testDeleteWithSubquery\\\", this::testDeleteWithSubquery),\\n parallelTest(\\\"testUpdate\\\", this::testUpdate),\\n parallelTest(\\\"testUpdateWithSubquery\\\", this::testUpdateWithSubquery),\\n parallelTest(\\\"testMerge\\\", this::testMerge),\\n parallelTest(\\\"testAnalyzeTable\\\", this::testAnalyzeTable),\\n parallelTest(\\\"testExplainAnalyze\\\", this::testExplainAnalyze),\\n parallelTest(\\\"testRequestTimeouts\\\", this::testRequestTimeouts)\\n };\\n}\\n```\\n\\nLeave parallelization to JUnit instead, and implement separate test methods\\ninstead.\", \"Avoid parameterized tests\": \"Do not create a custom parameterized test framework:\\n\\n```\\n@Test\\nvoid testTinyint()\\n{\\n SqlDataTypeTest.create()\\n .addRoundTrip(...)\\n .addRoundTrip(...)\\n .addRoundTrip(...)\\n .execute(getQueryRunner(), trinoCreateAsSelect(\\\"test_tinyint\\\"))\\n .execute(getQueryRunner(), trinoCreateAndInsert(\\\"test_tinyint\\\"))\\n .addRoundTrip(...)\\n .execute(getQueryRunner(), clickhouseQuery(\\\"tpch.test_tinyint\\\"));\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 15]\"}, {\"title\": \"Types\", \"description\": null, \"content\": {\"Native container type\": \"All types define the `getJavaType()` method, frequently referred to as the\\n\\\"native container type\\\". This is the Java type used to hold values during execution\\nand to store them in a `Block`. For example, this is the type used in\\nthe Java code that implements functions that produce or consume this `Type`.\", \"Native encoding\": \"The interpretation of a value in its native container type form is defined by its\\n`Type`. For some types, such as `BigintType`, it matches the Java\\ninterpretation of the native container type (64bit 2's complement). However, for other\\ntypes such as `TimestampWithTimeZoneType`, which also uses `long` for its\\nnative container type, the value stored in the `long` is a 8byte binary value\\ncombining the timezone and the milliseconds since the unix epoch. In particular,\\nthis means that you cannot compare two native values and expect a meaningful\\nresult, without knowing the native encoding.\", \"Type signature\": \"The signature of a type defines its identity, and also encodes some general\\ninformation about the type, such as its type parameters (if it's parametric),\\nand its literal parameters. The literal parameters are used in types like\\n`VARCHAR(10)`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21, \\\"subpages\\\", 16]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 21]\"}, {\"title\": \"Functions\", \"description\": \"Documentation section: functions\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/functions\"}, \"subpages\": [{\"title\": \"Aggregate functions\", \"description\": null, \"content\": {\"Ordering during aggregation\": \"Some aggregate functions such as {func}`array_agg` produce different results\\ndepending on the order of input values. This ordering can be specified by writing\\nan {ref}`order-by-clause` within the aggregate function:\\n\\n```\\narray_agg(x ORDER BY y DESC)\\narray_agg(x ORDER BY x, y, z)\\n```\\n\\n(aggregate-function-filtering-during-aggregation)=\", \"Filtering during aggregation\": \"The `FILTER` keyword can be used to remove rows from aggregation processing\\nwith a condition expressed using a `WHERE` clause. This is evaluated for each\\nrow before it is used in the aggregation and is supported for all aggregate\\nfunctions.\\n\\n```\\naggregate_function(...) FILTER (WHERE <condition>)\\n```\\n\\nA common and very useful example is to use `FILTER` to remove nulls from\\nconsideration when using `array_agg`:\\n\\n```\\nSELECT array_agg(name) FILTER (WHERE name IS NOT NULL)\\nFROM region;\\n```\\n\\nAs another example, imagine you want to add a condition on the count for Iris\\nflowers, modifying the following query:\\n\\n```\\nSELECT species,\\n count(*) AS count\\nFROM iris\\nGROUP BY species;\\n```\\n\\n```\\nspecies | count\\n-----------+-------\\nsetosa | 50\\nvirginica | 50\\nversicolor | 50\\n```\\n\\nIf you just use a normal `WHERE` statement you lose information:\\n\\n```\\nSELECT species,\\n count(*) AS count\\nFROM iris\\nWHERE petal_length_cm > 4\\nGROUP BY species;\\n```\\n\\n```\\nspecies | count\\n-----------+-------\\nvirginica | 50\\nversicolor | 34\\n```\\n\\nUsing a filter you retain all information:\\n\\n```\\nSELECT species,\\n count(*) FILTER (where petal_length_cm > 4) AS count\\nFROM iris\\nGROUP BY species;\\n```\\n\\n```\\nspecies | count\\n-----------+-------\\nvirginica | 50\\nsetosa | 0\\nversicolor | 34\\n```\", \"General aggregate functions\": \":::{function} any_value(x) -> [same as input]\\nReturns an arbitrary non-null value `x`, if one exists. `x` can be any\\nvalid expression. This allows you to return values from columns that are not\\ndirectly part of the aggregation, including expressions using these columns,\\nin a query.\\n\\nFor example, the following query returns the customer name from the `name`\\ncolumn, and returns the sum of all total prices as customer spend. The\\naggregation however uses the rows grouped by the customer identifier\\n`custkey` a required, since only that column is guaranteed to be unique:\\n\\n```\\nSELECT sum(o.totalprice) as spend,\\n any_value(c.name)\\nFROM tpch.tiny.orders o\\nJOIN tpch.tiny.customer c\\nON o.custkey = c.custkey\\nGROUP BY c.custkey;\\nORDER BY spend;\\n```\\n\\n:::\\n\\n:::{function} arbitrary(x) -> [same as input]\\nReturns an arbitrary non-null value of `x`, if one exists. Identical to\\n{func}`any_value`.\\n:::\\n\\n:::{function} array_agg(x) -> array<[same as input]>\\nReturns an array created from the input `x` elements.\\n:::\\n\\n:::{function} avg(x) -> double\\nReturns the average (arithmetic mean) of all input values.\\n:::\\n\\n:::{function} avg(time interval type) -> time interval type\\n:noindex: true\\n\\nReturns the average interval length of all input values.\\n:::\\n\\n:::{function} bool_and(boolean) -> boolean\\nReturns `TRUE` if every input value is `TRUE`, otherwise `FALSE`.\\n:::\\n\\n:::{function} bool_or(boolean) -> boolean\\nReturns `TRUE` if any input value is `TRUE`, otherwise `FALSE`.\\n:::\\n\\n:::{function} checksum(x) -> varbinary\\nReturns an order-insensitive checksum of the given values.\\n:::\\n\\n:::{function} count(*) -> bigint\\nReturns the number of input rows.\\n:::\\n\\n:::{function} count(x) -> bigint\\n:noindex: true\\n\\nReturns the number of non-null input values.\\n:::\\n\\n:::{function} count_if(x) -> bigint\\nReturns the number of `TRUE` input values.\\nThis function is equivalent to `count(CASE WHEN x THEN 1 END)`.\\n:::\\n\\n:::{function} every(boolean) -> boolean\\nThis is an alias for {func}`bool_and`.\\n:::\\n\\n:::{function} geometric_mean(x) -> double\\nReturns the geometric mean of all input values.\\n:::\\n\\n:::{function} listagg(x, separator) -> varchar\\nReturns the concatenated input values, separated by the `separator` string.\\n\\nSynopsis:\\n\\n```\\nLISTAGG( expression [, separator] [ON OVERFLOW overflow_behaviour])\\n WITHIN GROUP (ORDER BY sort_item, [...]) [FILTER (WHERE condition)]\\n```\\n\\n:::{note}\\nThe `expression` value must evaluate to a string data type (`varchar`). You must\\nexplicitly cast non-string datatypes to `varchar` using `CAST(expression AS\\nVARCHAR)` before you use them with `listagg`.\\n:::\\n\\nIf `separator` is not specified, the empty string will be used as `separator`.\\n\\nIn its simplest form the function looks like:\\n\\n```\\nSELECT listagg(value, ',') WITHIN GROUP (ORDER BY value) csv_value\\nFROM (VALUES 'a', 'c', 'b') t(value);\\n```\\n\\nand results in:\\n\\n```\\ncsv_value\\n-----------\\n'a,b,c'\\n```\\n\\nThe following example casts the `v` column to `varchar`:\\n\\n```\\nSELECT listagg(CAST(v AS VARCHAR), ',') WITHIN GROUP (ORDER BY v) csv_value\\nFROM (VALUES 1, 3, 2) t(v);\\n```\\n\\nand results in\\n\\n```\\ncsv_value\\n-----------\\n'1,2,3'\\n```\\n\\nThe overflow behaviour is by default to throw an error in case that the length of the output\\nof the function exceeds `1048576` bytes:\\n\\n```\\nSELECT listagg(value, ',' ON OVERFLOW ERROR) WITHIN GROUP (ORDER BY value) csv_value\\nFROM (VALUES 'a', 'b', 'c') t(value);\\n```\\n\\nThere exists also the possibility to truncate the output `WITH COUNT` or `WITHOUT COUNT`\\nof omitted non-null values in case that the length of the output of the\\nfunction exceeds `1048576` bytes:\\n\\n```\\nSELECT listagg(value, ',' ON OVERFLOW TRUNCATE '.....' WITH COUNT) WITHIN GROUP (ORDER BY value)\\nFROM (VALUES 'a', 'b', 'c') t(value);\\n```\\n\\nIf not specified, the truncation filler string is by default `'...'`.\\n\\nThis aggregation function can be also used in a scenario involving grouping:\\n\\n```\\nSELECT id, listagg(value, ',') WITHIN GROUP (ORDER BY o) csv_value\\nFROM (VALUES\\n (100, 1, 'a'),\\n (200, 3, 'c'),\\n (200, 2, 'b')\\n) t(id, o, value)\\nGROUP BY id\\nORDER BY id;\\n```\\n\\nresults in:\\n\\n```\\n id | csv_value\\n-----+-----------\\n 100 | a\\n 200 | b,c\\n```\\n\\nThis aggregation function supports\\n[filtering during aggregation](aggregate-function-filtering-during-aggregation)\\nfor scenarios where the aggregation for the data not matching the filter\\ncondition still needs to show up in the output:\\n\\n```\\nSELECT \\n country,\\n listagg(city, ',')\\n WITHIN GROUP (ORDER BY population DESC)\\n FILTER (WHERE population >= 10_000_000) megacities\\nFROM (VALUES \\n ('India', 'Bangalore', 13_700_000),\\n ('India', 'Chennai', 12_200_000),\\n ('India', 'Ranchi', 1_547_000),\\n ('Austria', 'Vienna', 1_897_000),\\n ('Poland', 'Warsaw', 1_765_000)\\n) t(country, city, population)\\nGROUP BY country\\nORDER BY country;\\n```\\n\\nresults in:\\n\\n```\\n country | megacities \\n---------+-------------------\\n Austria | NULL \\n India | Bangalore,Chennai \\n Poland | NULL\\n```\\n\\nThe current implementation of `listagg` function does not support window frames.\\n:::\\n\\n:::{function} max(x) -> [same as input]\\nReturns the maximum value of all input values.\\n:::\\n\\n:::{function} max(x, n) -> array<[same as x]>\\n:noindex: true\\n\\nReturns `n` largest values of all input values of `x`.\\n:::\\n\\n:::{function} max_by(x, y) -> [same as x]\\nReturns the value of `x` associated with the maximum value of `y` over all input values.\\n:::\\n\\n:::{function} max_by(x, y, n) -> array<[same as x]>\\n:noindex: true\\n\\nReturns `n` values of `x` associated with the `n` largest of all input values of `y`\\nin descending order of `y`.\\n:::\\n\\n:::{function} min(x) -> [same as input]\\nReturns the minimum value of all input values.\\n:::\\n\\n:::{function} min(x, n) -> array<[same as x]>\\n:noindex: true\\n\\nReturns `n` smallest values of all input values of `x`.\\n:::\\n\\n:::{function} min_by(x, y) -> [same as x]\\nReturns the value of `x` associated with the minimum value of `y` over all input values.\\n:::\\n\\n:::{function} min_by(x, y, n) -> array<[same as x]>\\n:noindex: true\\n\\nReturns `n` values of `x` associated with the `n` smallest of all input values of `y`\\nin ascending order of `y`.\\n:::\\n\\n:::{function} sum(x) -> [same as input]\\nReturns the sum of all input values.\\n:::\", \"Bitwise aggregate functions\": \":::{function} bitwise_and_agg(x) -> bigint\\nReturns the bitwise AND of all input non-NULL values in 2's complement representation.\\nIf all records inside the group are NULL, or if the group is empty, the function returns NULL.\\n:::\\n\\n:::{function} bitwise_or_agg(x) -> bigint\\nReturns the bitwise OR of all input non-NULL values in 2's complement representation.\\nIf all records inside the group are NULL, or if the group is empty, the function returns NULL.\\n:::\\n\\n:::{function} bitwise_xor_agg(x) -> bigint\\nReturns the bitwise XOR of all input non-NULL values in 2's complement representation.\\nIf all records inside the group are NULL, or if the group is empty, the function returns NULL.\\n:::\", \"Map aggregate functions\": \":::{function} histogram(x) -> map<K,bigint>\\nReturns a map containing the count of the number of times each input value occurs.\\n:::\\n\\n:::{function} map_agg(key, value) -> map<K,V>\\nReturns a map created from the input `key` / `value` pairs.\\n:::\\n\\n:::{function} map_union(x(K,V)) -> map<K,V>\\nReturns the union of all the input maps. If a key is found in multiple\\ninput maps, that key's value in the resulting map comes from an arbitrary input map.\\n\\nFor example, take the following histogram function that creates multiple maps from the Iris dataset:\\n\\n```\\nSELECT histogram(floor(petal_length_cm)) petal_data\\nFROM memory.default.iris\\nGROUP BY species;\\n\\n petal_data\\n-- {4.0=6, 5.0=33, 6.0=11}\\n-- {4.0=37, 5.0=2, 3.0=11}\\n-- {1.0=50}\\n```\\n\\nYou can combine these maps using `map_union`:\\n\\n```\\nSELECT map_union(petal_data) petal_data_union\\nFROM (\\n SELECT histogram(floor(petal_length_cm)) petal_data\\n FROM memory.default.iris\\n GROUP BY species\\n );\\n\\n petal_data_union\\n--{4.0=6, 5.0=2, 6.0=11, 1.0=50, 3.0=11}\\n```\\n\\n:::\\n\\n:::{function} multimap_agg(key, value) -> map<K,array(V)>\\nReturns a multimap created from the input `key` / `value` pairs.\\nEach key can be associated with multiple values.\\n:::\", \"Approximate aggregate functions\": \":::{function} approx_distinct(x) -> bigint\\nReturns the approximate number of distinct input values.\\nThis function provides an approximation of `count(DISTINCT x)`.\\nZero is returned if all input values are null.\\n\\nThis function should produce a standard error of 2.3%, which is the\\nstandard deviation of the (approximately normal) error distribution over\\nall possible sets. It does not guarantee an upper bound on the error for\\nany specific input set.\\n:::\\n\\n:::{function} approx_distinct(x, e) -> bigint\\n:noindex: true\\n\\nReturns the approximate number of distinct input values.\\nThis function provides an approximation of `count(DISTINCT x)`.\\nZero is returned if all input values are null.\\n\\nThis function should produce a standard error of no more than `e`, which\\nis the standard deviation of the (approximately normal) error distribution\\nover all possible sets. It does not guarantee an upper bound on the error\\nfor any specific input set. The current implementation of this function\\nrequires that `e` be in the range of `[0.0040625, 0.26000]`.\\n:::\\n\\n:::{function} approx_most_frequent(buckets, value, capacity) -> map<[same as value], bigint>\\nComputes the top frequent values up to `buckets` elements approximately.\\nApproximate estimation of the function enables us to pick up the frequent\\nvalues with less memory. Larger `capacity` improves the accuracy of\\nunderlying algorithm with sacrificing the memory capacity. The returned\\nvalue is a map containing the top elements with corresponding estimated\\nfrequency.\\n\\nThe error of the function depends on the permutation of the values and its\\ncardinality. We can set the capacity same as the cardinality of the\\nunderlying data to achieve the least error.\\n\\n`buckets` and `capacity` must be `bigint`. `value` can be numeric\\nor string type.\\n\\nThe function uses the stream summary data structure proposed in the paper\\n[Efficient Computation of Frequent and Top-k Elements in Data Streams](https://www.cse.ust.hk/~raywong/comp5331/References/EfficientComputationOfFrequentAndTop-kElementsInDataStreams.pdf)\\nby A. Metwalley, D. Agrawl and A. Abbadi.\\n:::\\n\\n:::{function} approx_percentile(x, percentage) -> [same as x]\\nReturns the approximate percentile for all input values of `x` at the\\ngiven `percentage`. The value of `percentage` must be between zero and\\none and must be constant for all input rows.\\n:::\\n\\n:::{function} approx_percentile(x, percentages) -> array<[same as x]>\\n:noindex: true\\n\\nReturns the approximate percentile for all input values of `x` at each of\\nthe specified percentages. Each element of the `percentages` array must be\\nbetween zero and one, and the array must be constant for all input rows.\\n:::\\n\\n:::{function} approx_percentile(x, w, percentage) -> [same as x]\\n:noindex: true\\n\\nReturns the approximate weighed percentile for all input values of `x`\\nusing the per-item weight `w` at the percentage `percentage`. Weights must be\\ngreater or equal to 1. Integer-value weights can be thought of as a replication\\ncount for the value `x` in the percentile set. The value of `percentage` must be\\nbetween zero and one and must be constant for all input rows.\\n:::\\n\\n:::{function} approx_percentile(x, w, percentages) -> array<[same as x]>\\n:noindex: true\\n\\nReturns the approximate weighed percentile for all input values of `x`\\nusing the per-item weight `w` at each of the given percentages specified\\nin the array. Weights must be greater or equal to 1. Integer-value weights can\\nbe thought of as a replication count for the value `x` in the percentile\\nset. Each element of the `percentages` array must be between zero and one, and the array\\nmust be constant for all input rows.\\n:::\\n\\n:::{function} approx_set(x) -> HyperLogLog\\n:noindex: true\\n\\nSee {doc}`hyperloglog`.\\n:::\\n\\n:::{function} merge(x) -> HyperLogLog\\n:noindex: true\\n\\nSee {doc}`hyperloglog`.\\n:::\\n\\n:::{function} merge(qdigest(T)) -> qdigest(T)\\n:noindex: true\\n\\nSee {doc}`qdigest`.\\n:::\\n\\n:::{function} merge(tdigest) -> tdigest\\n:noindex: true\\n\\nSee {doc}`tdigest`.\\n:::\\n\\n:::{function} numeric_histogram(buckets, value) -> map<double, double>\\n:noindex: true\\n\\nComputes an approximate histogram with up to `buckets` number of buckets\\nfor all `value`s. This function is equivalent to the variant of\\n{func}`numeric_histogram` that takes a `weight`, with a per-item weight of `1`.\\n:::\\n\\n:::{function} numeric_histogram(buckets, value, weight) -> map<double, double>\\nComputes an approximate histogram with up to `buckets` number of buckets\\nfor all `value`s with a per-item weight of `weight`. The algorithm\\nis based loosely on:\\n\\n```\\nYael Ben-Haim and Elad Tom-Tov, \\\"A streaming parallel decision tree algorithm\\\",\\nJ. Machine Learning Research 11 (2010), pp. 849--872.\\n```\\n\\n`buckets` must be a `bigint`. `value` and `weight` must be numeric.\\n:::\\n\\n:::{function} qdigest_agg(x) -> qdigest([same as x])\\n:noindex: true\\n\\nSee {doc}`qdigest`.\\n:::\\n\\n:::{function} qdigest_agg(x, w) -> qdigest([same as x])\\n:noindex: true\\n\\nSee {doc}`qdigest`.\\n:::\\n\\n:::{function} qdigest_agg(x, w, accuracy) -> qdigest([same as x])\\n:noindex: true\\n\\nSee {doc}`qdigest`.\\n:::\\n\\n:::{function} tdigest_agg(x) -> tdigest\\n:noindex: true\\n\\nSee {doc}`tdigest`.\\n:::\\n\\n:::{function} tdigest_agg(x, w) -> tdigest\\n:noindex: true\\n\\nSee {doc}`tdigest`.\\n:::\", \"Statistical aggregate functions\": \":::{function} corr(y, x) -> double\\nReturns correlation coefficient of input values.\\n:::\\n\\n:::{function} covar_pop(y, x) -> double\\nReturns the population covariance of input values.\\n:::\\n\\n:::{function} covar_samp(y, x) -> double\\nReturns the sample covariance of input values.\\n:::\\n\\n:::{function} kurtosis(x) -> double\\nReturns the excess kurtosis of all input values. Unbiased estimate using\\nthe following expression:\\n\\n```\\nkurtosis(x) = n(n+1)/((n-1)(n-2)(n-3))sum[(x_i-mean)^4]/stddev(x)^4-3(n-1)^2/((n-2)(n-3))\\n```\\n\\n:::\\n\\n:::{function} regr_intercept(y, x) -> double\\nReturns linear regression intercept of input values. `y` is the dependent\\nvalue. `x` is the independent value.\\n:::\\n\\n:::{function} regr_slope(y, x) -> double\\nReturns linear regression slope of input values. `y` is the dependent\\nvalue. `x` is the independent value.\\n:::\\n\\n:::{function} skewness(x) -> double\\nReturns the Fisher\\u2019s moment coefficient of [skewness](https://wikipedia.org/wiki/Skewness) of all input values.\\n:::\\n\\n:::{function} stddev(x) -> double\\nThis is an alias for {func}`stddev_samp`.\\n:::\\n\\n:::{function} stddev_pop(x) -> double\\nReturns the population standard deviation of all input values.\\n:::\\n\\n:::{function} stddev_samp(x) -> double\\nReturns the sample standard deviation of all input values.\\n:::\\n\\n:::{function} variance(x) -> double\\nThis is an alias for {func}`var_samp`.\\n:::\\n\\n:::{function} var_pop(x) -> double\\nReturns the population variance of all input values.\\n:::\\n\\n:::{function} var_samp(x) -> double\\nReturns the sample variance of all input values.\\n:::\", \"Lambda aggregate functions\": \":::{function} reduce_agg(inputValue T, initialState S, inputFunction(S, T, S), combineFunction(S, S, S)) -> S\\nReduces all input values into a single value. `inputFunction` will be invoked\\nfor each non-null input value. In addition to taking the input value, `inputFunction`\\ntakes the current state, initially `initialState`, and returns the new state.\\n`combineFunction` will be invoked to combine two states into a new state.\\nThe final state is returned:\\n\\n```\\nSELECT id, reduce_agg(value, 0, (a, b) -> a + b, (a, b) -> a + b)\\nFROM (\\n VALUES\\n (1, 3),\\n (1, 4),\\n (1, 5),\\n (2, 6),\\n (2, 7)\\n) AS t(id, value)\\nGROUP BY id;\\n-- (1, 12)\\n-- (2, 13)\\n\\nSELECT id, reduce_agg(value, 1, (a, b) -> a * b, (a, b) -> a * b)\\nFROM (\\n VALUES\\n (1, 3),\\n (1, 4),\\n (1, 5),\\n (2, 6),\\n (2, 7)\\n) AS t(id, value)\\nGROUP BY id;\\n-- (1, 60)\\n-- (2, 42)\\n```\\n\\nThe state type must be a boolean, integer, floating-point, char, varchar or date/time/interval.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 0]\"}, {\"title\": \"AI functions\", \"description\": null, \"content\": {\"Configuration\": {\"Providers\": {\"Anthropic \": \"The Anthropic provider uses the [Anthropic API](https://www.anthropic.com/api)\\nto perform the AI functions:\\n\\n```\\nai.provider=anthropic\\nai.model=claude-3-5-sonnet-latest\\nai.anthropic.api-key=xxx\\n```\\n\\nUse [secrets](/security/secrets) to avoid actual API key values in the catalog\\nproperties files.\\n\\n(ai-openai)=\", \"OpenAI\": \"The OpenAI provider uses the [OpenAI API](https://platform.openai.com/)\\nto perform the AI functions:\\n\\n```\\nai.provider=openai\\nai.model=gpt-4o-mini\\nai.openai.api-key=xxx\\n```\\n\\nUse [secrets](/security/secrets) to avoid actual API key values in the catalog\\nproperties files.\\n\\n(ai-ollama)=\", \"Ollama\": \"The OpenAI provider can be used with [Ollama](https://ollama.com/)\\nto perform the AI functions, as Ollama is compatible with the OpenAI API:\\n\\n```\\nai.provider=openai\\nai.model=llama3.3\\nai.openai.endpoint=http://localhost:11434\\nai.openai.api-key=none\\n```\\n\\nAn API key must be specified, but is ignored by Ollama.\\n\\nOllama allows you to use [Llama, DeepSeek, Phi, Mistral, Gemma and other\\nmodels](https://ollama.com/search) on a self-hosted deployment or from a vendor.\"}, \"Model configuration\": \"All providers support a number of different models. You must configure at least\\none model to use for the AI function. The model must be suitable for textual\\nanalysis. Provider and model choice impacts performance, results, and cost of\\nall AI functions.\\n\\nCosts vary with AI function used based on the implementation prompt size, the\\nlength of the input, and the length of the output from the model, because model\\nproviders charge based input and output tokens.\\n\\nOptionally configure different models from the same provider for each functions\\nas an override:\\n\\n:::{list-table} AI function model configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`ai.model`', 'Required name of the model. Valid names vary by provider. Model must be\\\\nsuitable for textual analysis. The model is used for all functions, unless a\\\\nspecific model is configured for a function as override.'], ['`ai.analyze-sentiment.model`', 'Optional override to use a different model for {func}`ai_analyze_sentiment`.'], ['`ai.classify.model`', 'Optional override to use a different model for {func}`ai_classify`.'], ['`ai.extract.model`', 'Optional override to use a different model for {func}`ai_extract`.'], ['`ai.fix-grammar.model`', 'Optional override to use a different model for {func}`ai_fix_grammar`.'], ['`ai.generate.model`', 'Optional override to use a different model for {func}`ai_gen`.'], ['`ai.mask.model`', 'Optional override to use a different model for {func}`ai_mask`.'], ['`ai.translate.model`', 'Optional override to use a different model for {func}`ai_translate`.\\\\n:::']]\"}, \"Functions\": \"The following functions are available in each catalog configured with the `ai`\\nconnector under the `ai` schema and use the configured LLM provider:\\n\\n:::{function} ai_analyze_sentiment(text) -> varchar\\nAnalyzes the sentiment of the input text.\\n\\nThe sentiment result is `positive`, `negative`, `neutral`, or `mixed`.\\n\\n```\\nSELECT ai_analyze_sentiment('I love Trino');\\n-- positive\\n```\\n\\n:::\\n\\n:::{function} ai_classify(text, labels) -> varchar\\nClassifies the input text according to the provided labels.\\n\\n```\\nSELECT ai_classify('Buy now!', ARRAY['spam', 'not spam']);\\n-- spam\\n```\\n\\n:::\\n\\n:::{function} ai_extract(text, labels) -> map(varchar, varchar)\\nExtracts values for the provided labels from the input text.\\n\\n```\\nSELECT ai_extract('John is 25 years old', ARRAY['name', 'age']);\\n-- {name=John, age=25}\\n```\\n\\n:::\\n\\n:::{function} ai_fix_grammar(text) -> varchar\\nCorrects grammatical errors in the input text.\\n\\n```\\nSELECT ai_fix_grammar('I are happy. What you doing?');\\n-- I am happy. What are you doing?\\n```\\n\\n:::\\n\\n:::{function} ai_gen(prompt) -> varchar\\nGenerates text based on the input prompt.\\n\\n```\\nSELECT ai_gen('Describe Trino in a few words');\\n-- Distributed SQL query engine.\\n```\\n\\n:::\\n\\n:::{function} ai_mask(text, labels) -> varchar\\nMasks the values for the provided labels in the input text by replacing them\\nwith the text `[MASKED]`.\\n\\n```\\nSELECT ai_mask(\\n 'Contact me at 555-1234 or visit us at 123 Main St.',\\n ARRAY['phone', 'address']);\\n-- Contact me at [MASKED] or visit us at [MASKED].\\n```\\n\\n:::\\n\\n:::{function} ai_translate(text, language) -> varchar\\nTranslates the input text to the specified language.\\n\\n```\\nSELECT ai_translate('I like coffee', 'es');\\n-- Me gusta el caf\\u00e9\\n\\nSELECT ai_translate('I like coffee', 'zh-TW');\\n-- \\u6211\\u559c\\u6b61\\u5496\\u5561\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 1]\"}, {\"title\": \"Array functions and operators\", \"description\": null, \"content\": {\"Subscript operator: \\\\[\\\\]\": \"The `[]` operator is used to access an element of an array and is indexed\\nstarting from one:\\n\\n```\\nSELECT my_array[1] AS first_element\\n```\\n\\nThe following example constructs an array and then accesses the second element:\\n\\n```\\nSELECT ARRAY[1, 1.2, 4][2];\\n-- 1.2\\n```\\n\\n(concatenation-operator)=\", \"Concatenation operator: ||\": \"The `||` operator is used to concatenate an array with an array or an element of the same type:\\n\\n```\\nSELECT ARRAY[1] || ARRAY[2];\\n-- [1, 2]\\n\\nSELECT ARRAY[1] || 2;\\n-- [1, 2]\\n\\nSELECT 2 || ARRAY[1];\\n-- [2, 1]\\n```\", \"Array functions\": \":::{function} all_match(array(T), function(T,boolean)) -> boolean\\nReturns whether all elements of an array match the given predicate. Returns `true` if all the elements\\nmatch the predicate (a special case is when the array is empty); `false` if one or more elements don't\\nmatch; `NULL` if the predicate function returns `NULL` for one or more elements and `true` for all\\nother elements.\\n:::\\n\\n:::{function} any_match(array(T), function(T,boolean)) -> boolean\\nReturns whether any elements of an array match the given predicate. Returns `true` if one or more\\nelements match the predicate; `false` if none of the elements matches (a special case is when the\\narray is empty); `NULL` if the predicate function returns `NULL` for one or more elements and `false`\\nfor all other elements.\\n:::\\n\\n:::{function} array_distinct(x) -> array\\nRemove duplicate values from the array `x`.\\n:::\\n\\n:::{function} array_intersect(x, y) -> array\\nReturns an array of the elements in the intersection of `x` and `y`, without duplicates.\\n:::\\n\\n:::{function} array_union(x, y) -> array\\nReturns an array of the elements in the union of `x` and `y`, without duplicates.\\n:::\\n\\n:::{function} array_except(x, y) -> array\\nReturns an array of elements in `x` but not in `y`, without duplicates.\\n:::\\n\\n:::{function} array_histogram(x) -> map<K, bigint>\\nReturns a map where the keys are the unique elements in the input array\\n`x` and the values are the number of times that each element appears in\\n`x`. Null values are ignored.\\n\\n```\\nSELECT array_histogram(ARRAY[42, 7, 42, NULL]);\\n-- {42=2, 7=1}\\n```\\n\\nReturns an empty map if the input array has no non-null elements.\\n\\n```\\nSELECT array_histogram(ARRAY[NULL, NULL]);\\n-- {}\\n```\\n\\n:::\\n\\n:::{function} array_join(x, delimiter) -> varchar\\nConcatenates the elements of the given array using the delimiter.\\nNull elements are omitted in the result.\\n:::\\n\\n:::{function} array_join(x, delimiter, null_replacement) -> varchar\\n:noindex: true\\n\\nConcatenates the elements of the given array using the delimiter and an optional string to replace nulls.\\n:::\\n\\n:::{function} array_max(x) -> x\\nReturns the maximum value of input array.\\n:::\\n\\n:::{function} array_min(x) -> x\\nReturns the minimum value of input array.\\n:::\\n\\n:::{function} array_position(x, element) -> bigint\\nReturns the position of the first occurrence of the `element` in array `x` (or 0 if not found).\\n:::\\n\\n:::{function} array_remove(x, element) -> array\\nRemove all elements that equal `element` from array `x`.\\n:::\\n\\n:::{function} array_sort(x) -> array\\nSorts and returns the array `x`. The elements of `x` must be orderable.\\nNull elements will be placed at the end of the returned array.\\n:::\\n\\n:::{function} array_sort(array(T), function(T,T,int)) -> array(T)\\n:noindex: true\\n\\nSorts and returns the `array` based on the given comparator `function`.\\nThe comparator will take two nullable arguments representing two nullable\\nelements of the `array`. It returns -1, 0, or 1 as the first nullable\\nelement is less than, equal to, or greater than the second nullable element.\\nIf the comparator function returns other values (including `NULL`), the\\nquery will fail and raise an error.\\n\\n```\\nSELECT array_sort(ARRAY[3, 2, 5, 1, 2],\\n (x, y) -> IF(x < y, 1, IF(x = y, 0, -1)));\\n-- [5, 3, 2, 2, 1]\\n\\nSELECT array_sort(ARRAY['bc', 'ab', 'dc'],\\n (x, y) -> IF(x < y, 1, IF(x = y, 0, -1)));\\n-- ['dc', 'bc', 'ab']\\n\\n\\nSELECT array_sort(ARRAY[3, 2, null, 5, null, 1, 2],\\n -- sort null first with descending order\\n (x, y) -> CASE WHEN x IS NULL THEN -1\\n WHEN y IS NULL THEN 1\\n WHEN x < y THEN 1\\n WHEN x = y THEN 0\\n ELSE -1 END);\\n-- [null, null, 5, 3, 2, 2, 1]\\n\\nSELECT array_sort(ARRAY[3, 2, null, 5, null, 1, 2],\\n -- sort null last with descending order\\n (x, y) -> CASE WHEN x IS NULL THEN 1\\n WHEN y IS NULL THEN -1\\n WHEN x < y THEN 1\\n WHEN x = y THEN 0\\n ELSE -1 END);\\n-- [5, 3, 2, 2, 1, null, null]\\n\\nSELECT array_sort(ARRAY['a', 'abcd', 'abc'],\\n -- sort by string length\\n (x, y) -> IF(length(x) < length(y), -1,\\n IF(length(x) = length(y), 0, 1)));\\n-- ['a', 'abc', 'abcd']\\n\\nSELECT array_sort(ARRAY[ARRAY[2, 3, 1], ARRAY[4, 2, 1, 4], ARRAY[1, 2]],\\n -- sort by array length\\n (x, y) -> IF(cardinality(x) < cardinality(y), -1,\\n IF(cardinality(x) = cardinality(y), 0, 1)));\\n-- [[1, 2], [2, 3, 1], [4, 2, 1, 4]]\\n```\\n\\n:::\\n\\n:::{function} arrays_overlap(x, y) -> boolean\\nTests if arrays `x` and `y` have any non-null elements in common.\\nReturns null if there are no non-null elements in common but either array contains null.\\n:::\\n\\n:::{function} cardinality(x) -> bigint\\nReturns the cardinality (size) of the array `x`.\\n:::\\n\\n:::{function} concat(array1, array2, ..., arrayN) -> array\\n:noindex: true\\n\\nConcatenates the arrays `array1`, `array2`, `...`, `arrayN`.\\nThis function provides the same functionality as the SQL-standard concatenation operator (`||`).\\n:::\\n\\n:::{function} combinations(array(T), n) -> array(array(T))\\nReturns n-element sub-groups of input array. If the input array has no duplicates,\\n`combinations` returns n-element subsets.\\n\\n```\\nSELECT combinations(ARRAY['foo', 'bar', 'baz'], 2);\\n-- [['foo', 'bar'], ['foo', 'baz'], ['bar', 'baz']]\\n\\nSELECT combinations(ARRAY[1, 2, 3], 2);\\n-- [[1, 2], [1, 3], [2, 3]]\\n\\nSELECT combinations(ARRAY[1, 2, 2], 2);\\n-- [[1, 2], [1, 2], [2, 2]]\\n```\\n\\nOrder of sub-groups is deterministic but unspecified. Order of elements within\\na sub-group deterministic but unspecified. `n` must be not be greater than 5,\\nand the total size of sub-groups generated must be smaller than 100,000.\\n:::\\n\\n:::{function} contains(x, element) -> boolean\\nReturns true if the array `x` contains the `element`.\\n:::\\n\\n:::{function} contains_sequence(x, seq) -> boolean\\nReturn true if array `x` contains all of array `seq` as a subsequence (all values in the same consecutive order).\\n:::\\n\\n:::{function} element_at(array(E), index) -> E\\nReturns element of `array` at given `index`.\\nIf `index` > 0, this function provides the same functionality as the SQL-standard subscript operator (`[]`),\\nexcept that the function returns `NULL` when accessing an `index` larger than array length, whereas\\nthe subscript operator would fail in such a case.\\nIf `index` \\\\< 0, `element_at` accesses elements from the last to the first.\\n:::\\n\\n:::{function} filter(array(T), function(T,boolean)) -> array(T)\\nConstructs an array from those elements of `array` for which `function` returns true:\\n\\n```\\nSELECT filter(ARRAY[], x -> true);\\n-- []\\n\\nSELECT filter(ARRAY[5, -6, NULL, 7], x -> x > 0);\\n-- [5, 7]\\n\\nSELECT filter(ARRAY[5, NULL, 7, NULL], x -> x IS NOT NULL);\\n-- [5, 7]\\n```\\n\\n:::\\n\\n:::{function} flatten(x) -> array\\nFlattens an `array(array(T))` to an `array(T)` by concatenating the contained arrays.\\n:::\\n\\n:::{function} ngrams(array(T), n) -> array(array(T))\\nReturns `n`-grams (sub-sequences of adjacent `n` elements) for the `array`.\\nThe order of the `n`-grams in the result is unspecified.\\n\\n```\\nSELECT ngrams(ARRAY['foo', 'bar', 'baz', 'foo'], 2);\\n-- [['foo', 'bar'], ['bar', 'baz'], ['baz', 'foo']]\\n\\nSELECT ngrams(ARRAY['foo', 'bar', 'baz', 'foo'], 3);\\n-- [['foo', 'bar', 'baz'], ['bar', 'baz', 'foo']]\\n\\nSELECT ngrams(ARRAY['foo', 'bar', 'baz', 'foo'], 4);\\n-- [['foo', 'bar', 'baz', 'foo']]\\n\\nSELECT ngrams(ARRAY['foo', 'bar', 'baz', 'foo'], 5);\\n-- [['foo', 'bar', 'baz', 'foo']]\\n\\nSELECT ngrams(ARRAY[1, 2, 3, 4], 2);\\n-- [[1, 2], [2, 3], [3, 4]]\\n```\\n\\n:::\\n\\n:::{function} none_match(array(T), function(T,boolean)) -> boolean\\nReturns whether no elements of an array match the given predicate. Returns `true` if none of the elements\\nmatches the predicate (a special case is when the array is empty); `false` if one or more elements match;\\n`NULL` if the predicate function returns `NULL` for one or more elements and `false` for all other elements.\\n:::\\n\\n:::{function} reduce(array(T), initialState S, inputFunction(S,T,S), outputFunction(S,R)) -> R\\nReturns a single value reduced from `array`. `inputFunction` will\\nbe invoked for each element in `array` in order. In addition to taking\\nthe element, `inputFunction` takes the current state, initially\\n`initialState`, and returns the new state. `outputFunction` will be\\ninvoked to turn the final state into the result value. It may be the\\nidentity function (`i -> i`).\\n\\n```\\nSELECT reduce(ARRAY[], 0,\\n (s, x) -> s + x,\\n s -> s);\\n-- 0\\n\\nSELECT reduce(ARRAY[5, 20, 50], 0,\\n (s, x) -> s + x,\\n s -> s);\\n-- 75\\n\\nSELECT reduce(ARRAY[5, 20, NULL, 50], 0,\\n (s, x) -> s + x,\\n s -> s);\\n-- NULL\\n\\nSELECT reduce(ARRAY[5, 20, NULL, 50], 0,\\n (s, x) -> s + coalesce(x, 0),\\n s -> s);\\n-- 75\\n\\nSELECT reduce(ARRAY[5, 20, NULL, 50], 0,\\n (s, x) -> IF(x IS NULL, s, s + x),\\n s -> s);\\n-- 75\\n\\nSELECT reduce(ARRAY[2147483647, 1], BIGINT '0',\\n (s, x) -> s + x,\\n s -> s);\\n-- 2147483648\\n\\n-- calculates arithmetic average\\nSELECT reduce(ARRAY[5, 6, 10, 20],\\n CAST(ROW(0.0, 0) AS ROW(sum DOUBLE, count INTEGER)),\\n (s, x) -> CAST(ROW(x + s.sum, s.count + 1) AS\\n ROW(sum DOUBLE, count INTEGER)),\\n s -> IF(s.count = 0, NULL, s.sum / s.count));\\n-- 10.25\\n```\\n\\n:::\\n\\n:::{function} repeat(element, count) -> array\\nRepeat `element` for `count` times.\\n:::\\n\\n:::{function} reverse(x) -> array\\n:noindex: true\\n\\nReturns an array which has the reversed order of array `x`.\\n:::\\n\\n:::{function} sequence(start, stop) -> array(bigint)\\nGenerate a sequence of integers from `start` to `stop`, incrementing\\nby `1` if `start` is less than or equal to `stop`, otherwise `-1`.\\n:::\\n\\n:::{function} sequence(start, stop, step) -> array(bigint)\\n:noindex: true\\n\\nGenerate a sequence of integers from `start` to `stop`, incrementing by `step`.\\n:::\\n\\n:::{function} sequence(start, stop) -> array(date)\\n:noindex: true\\n\\nGenerate a sequence of dates from `start` date to `stop` date, incrementing\\nby `1` day if `start` date is less than or equal to `stop` date, otherwise `-1` day.\\n:::\\n\\n:::{function} sequence(start, stop, step) -> array(date)\\n:noindex: true\\n\\nGenerate a sequence of dates from `start` to `stop`, incrementing by `step`.\\nThe type of `step` can be either `INTERVAL DAY TO SECOND` or `INTERVAL YEAR TO MONTH`.\\n:::\\n\\n:::{function} sequence(start, stop, step) -> array(timestamp)\\n:noindex: true\\n\\nGenerate a sequence of timestamps from `start` to `stop`, incrementing by `step`.\\nThe type of `step` can be either `INTERVAL DAY TO SECOND` or `INTERVAL YEAR TO MONTH`.\\n:::\\n\\n:::{function} shuffle(x) -> array\\nGenerate a random permutation of the given array `x`.\\n:::\\n\\n:::{function} slice(x, start, length) -> array\\nSubsets array `x` starting from index `start` (or starting from the end\\nif `start` is negative) with a length of `length`.\\n:::\\n\\n:::{function} trim_array(x, n) -> array\\nRemove `n` elements from the end of array:\\n\\n```\\nSELECT trim_array(ARRAY[1, 2, 3, 4], 1);\\n-- [1, 2, 3]\\n\\nSELECT trim_array(ARRAY[1, 2, 3, 4], 2);\\n-- [1, 2]\\n```\\n\\n:::\\n\\n:::{function} transform(array(T), function(T,U)) -> array(U)\\nReturns an array that is the result of applying `function` to each element of `array`:\\n\\n```\\nSELECT transform(ARRAY[], x -> x + 1);\\n-- []\\n\\nSELECT transform(ARRAY[5, 6], x -> x + 1);\\n-- [6, 7]\\n\\nSELECT transform(ARRAY[5, NULL, 6], x -> coalesce(x, 0) + 1);\\n-- [6, 1, 7]\\n\\nSELECT transform(ARRAY['x', 'abc', 'z'], x -> x || '0');\\n-- ['x0', 'abc0', 'z0']\\n\\nSELECT transform(ARRAY[ARRAY[1, NULL, 2], ARRAY[3, NULL]],\\n a -> filter(a, x -> x IS NOT NULL));\\n-- [[1, 2], [3]]\\n```\\n\\n:::\\n\\n:::{function} euclidean_distance(array(double), array(double)) -> double\\nCalculates the euclidean distance:\\n\\n```\\nSELECT euclidean_distance(ARRAY[1.0, 2.0], ARRAY[3.0, 4.0]);\\n-- 2.8284271247461903\\n```\\n\\n:::\\n\\n:::{function} dot_product(array(double), array(double)) -> double\\nCalculates the dot product:\\n\\n```\\nSELECT dot_product(ARRAY[1.0, 2.0], ARRAY[3.0, 4.0]);\\n-- 11.0\\n```\\n\\n:::\\n\\n:::{function} zip(array1, array2[, ...]) -> array(row)\\nMerges the given arrays, element-wise, into a single array of rows. The M-th element of\\nthe N-th argument will be the N-th field of the M-th output element.\\nIf the arguments have an uneven length, missing values are filled with `NULL`.\\n\\n```\\nSELECT zip(ARRAY[1, 2], ARRAY['1b', null, '3b']);\\n-- [ROW(1, '1b'), ROW(2, null), ROW(null, '3b')]\\n```\\n\\n:::\\n\\n:::{function} zip_with(array(T), array(U), function(T,U,R)) -> array(R)\\nMerges the two given arrays, element-wise, into a single array using `function`.\\nIf one array is shorter, nulls are appended at the end to match the length of the\\nlonger array, before applying `function`.\\n\\n```\\nSELECT zip_with(ARRAY[1, 3, 5], ARRAY['a', 'b', 'c'],\\n (x, y) -> (y, x));\\n-- [ROW('a', 1), ROW('b', 3), ROW('c', 5)]\\n\\nSELECT zip_with(ARRAY[1, 2], ARRAY[3, 4],\\n (x, y) -> x + y);\\n-- [4, 6]\\n\\nSELECT zip_with(ARRAY['a', 'b', 'c'], ARRAY['d', 'e', 'f'],\\n (x, y) -> concat(x, y));\\n-- ['ad', 'be', 'cf']\\n\\nSELECT zip_with(ARRAY['a'], ARRAY['d', null, 'f'],\\n (x, y) -> coalesce(x, y));\\n-- ['a', null, 'f']\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 2]\"}, {\"title\": \"Binary functions and operators\", \"description\": null, \"content\": {\"Binary operators\": \"The `||` operator performs concatenation.\", \"Binary functions\": \":::{function} concat(binary1, ..., binaryN) -> varbinary\\n:noindex: true\\n\\nReturns the concatenation of `binary1`, `binary2`, `...`, `binaryN`.\\nThis function provides the same functionality as the\\nSQL-standard concatenation operator (`||`).\\n:::\\n\\n:::{function} length(binary) -> bigint\\n:noindex: true\\n\\nReturns the length of `binary` in bytes.\\n:::\\n\\n:::{function} lpad(binary, size, padbinary) -> varbinary\\n:noindex: true\\n\\nLeft pads `binary` to `size` bytes with `padbinary`.\\nIf `size` is less than the length of `binary`, the result is\\ntruncated to `size` characters. `size` must not be negative\\nand `padbinary` must be non-empty.\\n:::\\n\\n:::{function} rpad(binary, size, padbinary) -> varbinary\\n:noindex: true\\n\\nRight pads `binary` to `size` bytes with `padbinary`.\\nIf `size` is less than the length of `binary`, the result is\\ntruncated to `size` characters. `size` must not be negative\\nand `padbinary` must be non-empty.\\n:::\\n\\n:::{function} substr(binary, start) -> varbinary\\n:noindex: true\\n\\nReturns the rest of `binary` from the starting position `start`,\\nmeasured in bytes. Positions start with `1`. A negative starting position\\nis interpreted as being relative to the end of the string.\\n:::\\n\\n:::{function} substr(binary, start, length) -> varbinary\\n:noindex: true\\n\\nReturns a substring from `binary` of length `length` from the starting\\nposition `start`, measured in bytes. Positions start with `1`. A\\nnegative starting position is interpreted as being relative to the end of\\nthe string.\\n:::\\n\\n(function-reverse-varbinary)=\\n:::{function} reverse(binary) -> varbinary\\n:noindex: true\\n\\nReturns `binary` with the bytes in reverse order.\\n:::\", \"Base64 encoding functions\": \"The Base64 functions implement the encoding specified in {rfc}`4648`.\\n\\n:::{function} from_base64(string) -> varbinary\\nDecodes binary data from the base64 encoded `string`.\\n:::\\n\\n:::{function} to_base64(binary) -> varchar\\nEncodes `binary` into a base64 string representation.\\n:::\\n\\n:::{function} from_base64url(string) -> varbinary\\nDecodes binary data from the base64 encoded `string` using the URL safe alphabet.\\n:::\\n\\n:::{function} to_base64url(binary) -> varchar\\nEncodes `binary` into a base64 string representation using the URL safe alphabet.\\n:::\\n\\n:::{function} from_base32(string) -> varbinary\\nDecodes binary data from the base32 encoded `string`.\\n:::\\n\\n:::{function} to_base32(binary) -> varchar\\nEncodes `binary` into a base32 string representation.\\n:::\", \"Hex encoding functions\": \":::{function} from_hex(string) -> varbinary\\nDecodes binary data from the hex encoded `string`.\\n:::\\n\\n:::{function} to_hex(binary) -> varchar\\nEncodes `binary` into a hex string representation.\\n:::\", \"Integer encoding functions\": \":::{function} from_big_endian_32(binary) -> integer\\nDecodes the 32-bit two's complement big-endian `binary`.\\nThe input must be exactly 4 bytes.\\n:::\\n\\n:::{function} to_big_endian_32(integer) -> varbinary\\nEncodes `integer` into a 32-bit two's complement big-endian format.\\n:::\\n\\n:::{function} from_big_endian_64(binary) -> bigint\\nDecodes the 64-bit two's complement big-endian `binary`.\\nThe input must be exactly 8 bytes.\\n:::\\n\\n:::{function} to_big_endian_64(bigint) -> varbinary\\nEncodes `bigint` into a 64-bit two's complement big-endian format.\\n:::\", \"Floating-point encoding functions\": \":::{function} from_ieee754_32(binary) -> real\\nDecodes the 32-bit big-endian `binary` in IEEE 754 single-precision floating-point format.\\nThe input must be exactly 4 bytes.\\n:::\\n\\n:::{function} to_ieee754_32(real) -> varbinary\\nEncodes `real` into a 32-bit big-endian binary according to IEEE 754 single-precision floating-point format.\\n:::\\n\\n:::{function} from_ieee754_64(binary) -> double\\nDecodes the 64-bit big-endian `binary` in IEEE 754 double-precision floating-point format.\\nThe input must be exactly 8 bytes.\\n:::\\n\\n:::{function} to_ieee754_64(double) -> varbinary\\nEncodes `double` into a 64-bit big-endian binary according to IEEE 754 double-precision floating-point format.\\n:::\", \"Hashing functions\": \":::{function} crc32(binary) -> bigint\\nComputes the CRC-32 of `binary`. For general purpose hashing, use\\n{func}`xxhash64`, as it is much faster and produces a better quality hash.\\n:::\\n\\n:::{function} md5(binary) -> varbinary\\nComputes the MD5 hash of `binary`.\\n:::\\n\\n:::{function} sha1(binary) -> varbinary\\nComputes the SHA1 hash of `binary`.\\n:::\\n\\n:::{function} sha256(binary) -> varbinary\\nComputes the SHA256 hash of `binary`.\\n:::\\n\\n:::{function} sha512(binary) -> varbinary\\nComputes the SHA512 hash of `binary`.\\n:::\\n\\n:::{function} spooky_hash_v2_32(binary) -> varbinary\\nComputes the 32-bit SpookyHashV2 hash of `binary`.\\n:::\\n\\n:::{function} spooky_hash_v2_64(binary) -> varbinary\\nComputes the 64-bit SpookyHashV2 hash of `binary`.\\n:::\\n\\n:::{function} xxhash64(binary) -> varbinary\\nComputes the xxHash64 hash of `binary`.\\n:::\\n\\n:::{function} murmur3(binary) -> varbinary\\nComputes the 128-bit [MurmurHash3](https://wikipedia.org/wiki/MurmurHash)\\nhash of `binary`.\\n\\n```\\nSELECT murmur3(from_base64('aaaaaa'));\\n-- ba 58 55 63 55 69 b4 2f 49 20 37 2c a0 e3 96 ef\\n```\\n\\n:::\", \"HMAC functions\": \":::{function} hmac_md5(binary, key) -> varbinary\\nComputes HMAC with MD5 of `binary` with the given `key`.\\n:::\\n\\n:::{function} hmac_sha1(binary, key) -> varbinary\\nComputes HMAC with SHA1 of `binary` with the given `key`.\\n:::\\n\\n:::{function} hmac_sha256(binary, key) -> varbinary\\nComputes HMAC with SHA256 of `binary` with the given `key`.\\n:::\\n\\n:::{function} hmac_sha512(binary, key) -> varbinary\\nComputes HMAC with SHA512 of `binary` with the given `key`.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 3]\"}, {\"title\": \"Bitwise\", \"description\": null, \"content\": {\"Bitwise functions\": \":::{function} bit_count(x, bits) -> bigint\\nCount the number of bits set in `x` (treated as `bits`-bit signed\\ninteger) in 2's complement representation:\\n\\n```\\nSELECT bit_count(9, 64); -- 2\\nSELECT bit_count(9, 8); -- 2\\nSELECT bit_count(-7, 64); -- 62\\nSELECT bit_count(-7, 8); -- 6\\n```\\n\\n:::\\n\\n:::{function} bitwise_and(x, y) -> bigint\\nReturns the bitwise AND of `x` and `y` in 2's complement representation.\\n\\nBitwise AND of `19` (binary: `10011`) and `25` (binary: `11001`) results in\\n`17` (binary: `10001`):\\n\\n```\\nSELECT bitwise_and(19,25); -- 17\\n```\\n\\n:::\\n\\n:::{function} bitwise_not(x) -> bigint\\nReturns the bitwise NOT of `x` in 2's complement representation\\n(`NOT x = -x - 1`):\\n\\n```\\nSELECT bitwise_not(-12); -- 11\\nSELECT bitwise_not(19); -- -20\\nSELECT bitwise_not(25); -- -26\\n```\\n\\n:::\\n\\n:::{function} bitwise_or(x, y) -> bigint\\nReturns the bitwise OR of `x` and `y` in 2's complement representation.\\n\\nBitwise OR of `19` (binary: `10011`) and `25` (binary: `11001`) results in\\n`27` (binary: `11011`):\\n\\n```\\nSELECT bitwise_or(19,25); -- 27\\n```\\n\\n:::\\n\\n:::{function} bitwise_xor(x, y) -> bigint\\nReturns the bitwise XOR of `x` and `y` in 2's complement representation.\\n\\nBitwise XOR of `19` (binary: `10011`) and `25` (binary: `11001`) results in\\n`10` (binary: `01010`):\\n\\n```\\nSELECT bitwise_xor(19,25); -- 10\\n```\\n\\n:::\\n\\n:::{function} bitwise_left_shift(value, shift) -> [same as value]\\nReturns the left shifted value of `value`.\\n\\nShifting `1` (binary: `001`) by two bits results in `4` (binary: `00100`):\\n\\n```\\nSELECT bitwise_left_shift(1, 2); -- 4\\n```\\n\\nShifting `5` (binary: `0101`) by two bits results in `20` (binary: `010100`):\\n\\n```\\nSELECT bitwise_left_shift(5, 2); -- 20\\n```\\n\\nShifting a `value` by `0` always results in the original `value`:\\n\\n```\\nSELECT bitwise_left_shift(20, 0); -- 20\\nSELECT bitwise_left_shift(42, 0); -- 42\\n```\\n\\nShifting `0` by a `shift` always results in `0`:\\n\\n```\\nSELECT bitwise_left_shift(0, 1); -- 0\\nSELECT bitwise_left_shift(0, 2); -- 0\\n```\\n\\n:::\\n\\n:::{function} bitwise_right_shift(value, shift) -> [same as value]\\nReturns the logical right shifted value of `value`.\\n\\nShifting `8` (binary: `1000`) by three bits results in `1` (binary: `001`):\\n\\n```\\nSELECT bitwise_right_shift(8, 3); -- 1\\n```\\n\\nShifting `9` (binary: `1001`) by one bit results in `4` (binary: `100`):\\n\\n```\\nSELECT bitwise_right_shift(9, 1); -- 4\\n```\\n\\nShifting a `value` by `0` always results in the original `value`:\\n\\n```\\nSELECT bitwise_right_shift(20, 0); -- 20\\nSELECT bitwise_right_shift(42, 0); -- 42\\n```\\n\\nShifting a `value` by `64` or more bits results in `0`:\\n\\n```\\nSELECT bitwise_right_shift( 12, 64); -- 0\\nSELECT bitwise_right_shift(-45, 64); -- 0\\n```\\n\\nShifting `0` by a `shift` always results in `0`:\\n\\n```\\nSELECT bitwise_right_shift(0, 1); -- 0\\nSELECT bitwise_right_shift(0, 2); -- 0\\n```\\n\\n:::\\n\\n:::{function} bitwise_right_shift_arithmetic(value, shift) -> [same as value]\\nReturns the arithmetic right shifted value of `value`.\\n\\nReturns the same values as {func}`bitwise_right_shift` when shifting by less than\\n`64` bits. Shifting by `64` or more bits results in `0` for a positive and\\n`-1` for a negative `value`:\\n\\n```\\nSELECT bitwise_right_shift_arithmetic( 12, 64); -- 0\\nSELECT bitwise_right_shift_arithmetic(-45, 64); -- -1\\n```\\n\\n:::\\n\\nSee also {func}`bitwise_and_agg` and {func}`bitwise_or_agg`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 4]\"}, {\"title\": \"Color\", \"description\": null, \"content\": {\"Color functions\": \":::{function} bar(x, width) -> varchar\\nRenders a single bar in an ANSI bar chart using a default\\n`low_color` of red and a `high_color` of green. For example,\\nif `x` of 25% and width of 40 are passed to this function. A\\n10-character red bar will be drawn followed by 30 spaces to create\\na bar of 40 characters.\\n:::\\n\\n::::{function} bar(x, width, low_color, high_color) -> varchar\\n:noindex: true\\n\\nRenders a single line in an ANSI bar chart of the specified\\n`width`. The parameter `x` is a double value between 0 and 1.\\nValues of `x` that fall outside the range \\\\[0, 1\\\\] will be\\ntruncated to either a 0 or a 1 value. The `low_color` and\\n`high_color` capture the color to use for either end of\\nthe horizontal bar chart. For example, if `x` is 0.5, `width`\\nis 80, `low_color` is 0xFF0000, and `high_color` is 0x00FF00\\nthis function will return a 40 character bar that varies from red\\n(0xFF0000) and yellow (0xFFFF00) and the remainder of the 80\\ncharacter bar will be padded with spaces.\\n\\n:::{figure} ../images/functions_color_bar.png\\n:align: center\\n:::\\n::::\\n\\n:::{function} color(string) -> color\\nReturns a color capturing a decoded RGB value from a 4-character\\nstring of the format \\\"#000\\\". The input string should be varchar\\ncontaining a CSS-style short rgb string or one of `black`,\\n`red`, `green`, `yellow`, `blue`, `magenta`, `cyan`,\\n`white`.\\n:::\\n\\n:::{function} color(x, low, high, low_color, high_color) -> color\\n:noindex: true\\n\\nReturns a color interpolated between `low_color` and\\n`high_color` using the double parameters `x`, `low`, and\\n`high` to calculate a fraction which is then passed to the\\n`color(fraction, low_color, high_color)` function shown below.\\nIf `x` falls outside the range defined by `low` and `high`\\nits value is truncated to fit within this range.\\n:::\\n\\n:::{function} color(x, low_color, high_color) -> color\\n:noindex: true\\n\\nReturns a color interpolated between `low_color` and\\n`high_color` according to the double argument `x` between 0\\nand 1. The parameter `x` is a double value between 0 and 1.\\nValues of `x` that fall outside the range \\\\[0, 1\\\\] will be\\ntruncated to either a 0 or a 1 value.\\n:::\\n\\n:::{function} render(x, color) -> varchar\\nRenders value `x` using the specific color using ANSI\\ncolor codes. `x` can be either a double, bigint, or varchar.\\n:::\\n\\n:::{function} render(b) -> varchar\\n:noindex: true\\n\\nAccepts boolean value `b` and renders a green true or a red\\nfalse using ANSI color codes.\\n:::\\n\\n:::{function} rgb(red, green, blue) -> color\\nReturns a color value capturing the RGB value of three\\ncomponent color values supplied as int parameters ranging from 0\\nto 255: `red`, `green`, `blue`.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 5]\"}, {\"title\": \"Comparison functions and operators\", \"description\": null, \"content\": {\"Comparison operators\": \":::{list-table}\\n:widths: 30, 70\\n:header-rows: 1\\n\\n[['Operator', 'Description'], ['`<`', 'Less than'], ['`>`', 'Greater than'], ['`<=`', 'Less than or equal to'], ['`>=`', 'Greater than or equal to'], ['`=`', 'Equal'], ['`<>`', 'Not equal'], ['`!=`', 'Not equal (non-standard but popular syntax)\\\\n:::']]\\n\\n(range-operator)=\", \"Range operator: BETWEEN\": \"The `BETWEEN` operator tests if a value is within a specified range. It uses the\\nsyntax `value BETWEEN min AND max`:\\n\\n```\\nSELECT 3 BETWEEN 2 AND 6;\\n```\\n\\nThe preceding statement is equivalent to the following statement:\\n\\n```\\nSELECT 3 >= 2 AND 3 <= 6;\\n```\\n\\nTo test if a value does not fall within the specified range use `NOT BETWEEN`:\\n\\n```\\nSELECT 3 NOT BETWEEN 2 AND 6;\\n```\\n\\nThe statement shown above is equivalent to the following statement:\\n\\n```\\nSELECT 3 < 2 OR 3 > 6;\\n```\\n\\nA `NULL` in a `BETWEEN` or `NOT BETWEEN` statement is evaluated using the\\nstandard `NULL` evaluation rules applied to the equivalent expression above:\\n\\n```\\nSELECT NULL BETWEEN 2 AND 4; -- null\\n\\nSELECT 2 BETWEEN NULL AND 6; -- null\\n\\nSELECT 2 BETWEEN 3 AND NULL; -- false\\n\\nSELECT 8 BETWEEN NULL AND 6; -- false\\n```\\n\\nThe `BETWEEN` and `NOT BETWEEN` operators can also be used to evaluate any\\norderable type. For example, a `VARCHAR`:\\n\\n```\\nSELECT 'Paul' BETWEEN 'John' AND 'Ringo'; -- true\\n```\\n\\nNote that the value, min, and max parameters to `BETWEEN` and `NOT BETWEEN` must\\nbe the same type. For example, Trino produces an error if you ask it if `John`\\nis between `2.3` and `35.2`.\\n\\n(is-null-operator)=\", \"IS NULL and IS NOT NULL\": \"The `IS NULL` and `IS NOT NULL` operators test whether a value is null\\n(undefined). Both operators work for all data types.\\n\\nUsing `NULL` with `IS NULL` evaluates to `true`:\\n\\n```\\nSELECT NULL IS NULL; -- true\\n```\\n\\nBut any other constant does not:\\n\\n```\\nSELECT 3.0 IS NULL; -- false\\n```\\n\\n(is-distinct-operator)=\", \"IS DISTINCT FROM and IS NOT DISTINCT FROM\": \"In SQL a `NULL` value signifies an unknown value, so any comparison involving a\\n`NULL` produces `NULL`. The `IS DISTINCT FROM` and `IS NOT DISTINCT FROM`\\noperators treat `NULL` as a known value and both operators guarantee either a\\ntrue or false outcome even in the presence of `NULL` input:\\n\\n```\\nSELECT NULL IS DISTINCT FROM NULL; -- false\\n\\nSELECT NULL IS NOT DISTINCT FROM NULL; -- true\\n```\\n\\nIn the preceding example a `NULL` value is not considered distinct from `NULL`.\\nWhen you are comparing values which may include `NULL` use these operators to\\nguarantee either a `TRUE` or `FALSE` result.\\n\\nThe following truth table demonstrate the handling of `NULL` in\\n`IS DISTINCT FROM` and `IS NOT DISTINCT FROM`:\\n\\n| a | b | a = b | a \\\\<> b | a DISTINCT b | a NOT DISTINCT b |\\n| ------ | ------ | ------- | ------- | ------------ | ---------------- |\\n| `1` | `1` | `TRUE` | `FALSE` | `FALSE` | `TRUE` |\\n| `1` | `2` | `FALSE` | `TRUE` | `TRUE` | `FALSE` |\\n| `1` | `NULL` | `NULL` | `NULL` | `TRUE` | `FALSE` |\\n| `NULL` | `NULL` | `NULL` | `NULL` | `FALSE` | `TRUE` |\", \"GREATEST and LEAST\": \"These functions are not in the SQL standard, but are a common extension.\\nLike most other functions in Trino, they return null if any argument is\\nnull. Note that in some other databases, such as PostgreSQL, they only\\nreturn null if all arguments are null.\\n\\nThe following types are supported:\\n\\n['`DOUBLE`', '`BIGINT`', '`VARCHAR`', '`TIMESTAMP`', '`TIMESTAMP WITH TIME ZONE`', '`DATE`']\\n\\n:::{function} greatest(value1, value2, ..., valueN) -> [same as input]\\nReturns the largest of the provided values.\\n:::\\n\\n:::{function} least(value1, value2, ..., valueN) -> [same as input]\\nReturns the smallest of the provided values.\\n:::\\n\\n(quantified-comparison-predicates)=\", \"Quantified comparison predicates: ALL, ANY and SOME\": \"The `ALL`, `ANY` and `SOME` quantifiers can be used together with comparison\\noperators in the following way:\\n\\n```\\nexpression operator quantifier ( subquery )\\n```\\n\\nFor example:\\n\\n```\\nSELECT 'hello' = ANY (VALUES 'hello', 'world'); -- true\\n\\nSELECT 21 < ALL (VALUES 19, 20, 21); -- false\\n\\nSELECT 42 >= SOME (SELECT 41 UNION ALL SELECT 42 UNION ALL SELECT 43); -- true\\n```\\n\\nFollowing are the meanings of some quantifier and comparison operator\\ncombinations:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Expression', 'Meaning'], ['`A = ALL (...)`', 'Evaluates to `true` when `A` is equal to all values.'], ['`A <> ALL (...)`', \\\"Evaluates to `true` when `A` doesn't match any value.\\\"], ['`A < ALL (...)`', 'Evaluates to `true` when `A` is smaller than the smallest value.'], ['`A = ANY (...)`', 'Evaluates to `true` when `A` is equal to any of the values. This form\\\\nis equivalent to `A IN (...)`.'], ['`A <> ANY (...)`', \\\"Evaluates to `true` when `A` doesn't match one or more values.\\\"], ['`A < ANY (...)`', 'Evaluates to `true` when `A` is smaller than the biggest value.\\\\n:::']]\\n\\n`ANY` and `SOME` have the same meaning and can be used interchangeably.\\n\\n(like-operator)=\", \"Pattern comparison: LIKE\": \"The `LIKE` operator can be used to compare values with a pattern:\\n\\n```\\n... column [NOT] LIKE 'pattern' ESCAPE 'character';\\n```\\n\\nMatching characters is case sensitive, and the pattern supports two symbols for\\nmatching:\\n\\n['`_` matches any single character', '`%` matches zero or more characters']\\n\\nTypically it is often used as a condition in `WHERE` statements. An example is\\na query to find all continents starting with `E`, which returns `Europe`:\\n\\n```\\nSELECT * FROM (VALUES 'America', 'Asia', 'Africa', 'Europe', 'Australia', 'Antarctica') AS t (continent)\\nWHERE continent LIKE 'E%';\\n```\\n\\nYou can negate the result by adding `NOT`, and get all other continents, all\\nnot starting with `E`:\\n\\n```\\nSELECT * FROM (VALUES 'America', 'Asia', 'Africa', 'Europe', 'Australia', 'Antarctica') AS t (continent)\\nWHERE continent NOT LIKE 'E%';\\n```\\n\\nIf you only have one specific character to match, you can use the `_` symbol\\nfor each character. The following query uses two underscores and produces only\\n`Asia` as result:\\n\\n```\\nSELECT * FROM (VALUES 'America', 'Asia', 'Africa', 'Europe', 'Australia', 'Antarctica') AS t (continent)\\nWHERE continent LIKE 'A__A';\\n```\\n\\nThe wildcard characters `_` and `%` must be escaped to allow you to match\\nthem as literals. This can be achieved by specifying the `ESCAPE` character to\\nuse:\\n\\n```\\nSELECT 'South_America' LIKE 'South\\\\_America' ESCAPE '\\\\';\\n```\\n\\nThe above query returns `true` since the escaped underscore symbol matches. If\\nyou need to match the used escape character as well, you can escape it.\\n\\nIf you want to match for the chosen escape character, you simply escape itself.\\nFor example, you can use `\\\\\\\\` to match for `\\\\`.\\n\\n(in-operator)=\", \"Row comparison: IN\": \"The `IN` operator can be used in a `WHERE` clause to compare column values with \\na list of values. The list of values can be supplied by a subquery or directly \\nas static values in an array:\\n\\n```\\n... WHERE column [NOT] IN ('value1','value2');\\n... WHERE column [NOT] IN ( subquery );\\n```\\n\\nUse the optional `NOT` keyword to negate the condition.\\n\\nThe following example shows a simple usage with a static array:\\n\\n```\\nSELECT * FROM region WHERE name IN ('AMERICA', 'EUROPE');\\n```\\n\\nThe values in the clause are used for multiple comparisons that are combined as\\na logical `OR`. The preceding query is equivalent to the following query:\\n\\n```\\nSELECT * FROM region WHERE name = 'AMERICA' OR name = 'EUROPE';\\n```\\n\\nYou can negate the comparisons by adding `NOT`, and get all other regions\\nexcept the values in list:\\n\\n```\\nSELECT * FROM region WHERE name NOT IN ('AMERICA', 'EUROPE');\\n```\\n\\nWhen using a subquery to determine the values to use in the comparison, the\\nsubquery must return a single column and one or more rows. For example, the\\nfollowing query returns nation name of countries in regions starting with the\\nletter `A`, specifically Africa, America, and Asia:\\n\\n```\\nSELECT nation.name\\nFROM nation\\nWHERE regionkey IN (\\n SELECT regionkey\\n FROM region\\n WHERE starts_with(name, 'A')\\n)\\nORDER by nation.name;\\n```\", \"Examples\": \"The following example queries showcase aspects of using comparison functions and\\noperators related to implied ordering of values, implicit casting, and different\\ntypes.\\n\\nOrdering:\\n\\n```\\nSELECT 'M' BETWEEN 'A' AND 'Z'; -- true\\nSELECT 'A' < 'B'; -- true\\nSELECT 'A' < 'a'; -- true\\nSELECT TRUE > FALSE; -- true\\nSELECT 'M' BETWEEN 'A' AND 'Z'; -- true\\nSELECT 'm' BETWEEN 'A' AND 'Z'; -- false\\n```\\n\\nThe following queries show a subtle difference between `char` and `varchar`\\ntypes. The length parameter for `varchar` is an optional maximum length\\nparameter and comparison is based on the data only, ignoring the length:\\n\\n```\\nSELECT cast('Test' as varchar(20)) = cast('Test' as varchar(25)); --true\\nSELECT cast('Test' as varchar(20)) = cast('Test ' as varchar(25)); --false\\n```\\n\\nThe length parameter for `char` defines a fixed length character array.\\nComparison with different length automatically includes a cast to the same\\nlarger length. The cast is performed as automatic padding with spaces, and\\ntherefore both queries in the following return `true`:\\n\\n```\\nSELECT cast('Test' as char(20)) = cast('Test' as char(25)); -- true\\nSELECT cast('Test' as char(20)) = cast('Test ' as char(25)); -- true\\n```\\n\\nThe following queries show how date types are ordered, and how date is\\nimplicitly cast to timestamp with zero time values:\\n\\n```\\nSELECT DATE '2024-08-22' < DATE '2024-08-31';\\nSELECT DATE '2024-08-22' < TIMESTAMP '2024-08-22 8:00:00';\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 6]\"}, {\"title\": \"Conditional expressions\", \"description\": null, \"content\": {\"CASE\": \"The standard SQL `CASE` expression has two forms.\\nThe \\\"simple\\\" form searches each `value` expression from left to right\\nuntil it finds one that equals `expression`:\\n\\n```\\nCASE expression\\n WHEN value THEN result\\n [ WHEN ... ]\\n [ ELSE result ]\\nEND\\n```\\n\\nThe `result` for the matching `value` is returned.\\nIf no match is found, the `result` from the `ELSE` clause is\\nreturned if it exists, otherwise null is returned. Example:\\n\\n```\\nSELECT a,\\n CASE a\\n WHEN 1 THEN 'one'\\n WHEN 2 THEN 'two'\\n ELSE 'many'\\n END\\n```\\n\\nThe \\\"searched\\\" form evaluates each boolean `condition` from left\\nto right until one is true and returns the matching `result`:\\n\\n```\\nCASE\\n WHEN condition THEN result\\n [ WHEN ... ]\\n [ ELSE result ]\\nEND\\n```\\n\\nIf no conditions are true, the `result` from the `ELSE` clause is\\nreturned if it exists, otherwise null is returned. Example:\\n\\n```\\nSELECT a, b,\\n CASE\\n WHEN a = 1 THEN 'aaa'\\n WHEN b = 2 THEN 'bbb'\\n ELSE 'ccc'\\n END\\n```\\n\\nSQL UDFs can use [`CASE` statements](/udf/sql/case) that use a slightly\\ndifferent syntax from the CASE expressions. Specifically note the requirements\\nfor terminating each clause with a semicolon `;` and the usage of `END CASE`.\\n\\n(if-expression)=\", \"IF\": \"The `IF` expression has two forms, one supplying only a\\n`true_value` and the other supplying both a `true_value` and a\\n`false_value`:\\n\\n:::{function} if(condition, true_value)\\nEvaluates and returns `true_value` if `condition` is true,\\notherwise null is returned and `true_value` is not evaluated.\\n:::\\n\\n:::{function} if(condition, true_value, false_value)\\n:noindex: true\\n\\nEvaluates and returns `true_value` if `condition` is true,\\notherwise evaluates and returns `false_value`.\\n:::\\n\\nThe following `IF` and `CASE` expressions are equivalent:\\n\\n```\\nSELECT\\n orderkey,\\n totalprice,\\n IF(totalprice >= 150000, 'High Value', 'Low Value')\\nFROM tpch.sf1.orders;\\n```\\n\\n```\\nSELECT\\n orderkey,\\n totalprice,\\n CASE\\n WHEN totalprice >= 150000 THEN 'High Value'\\n ELSE 'Low Value'\\n END\\nFROM tpch.sf1.orders;\\n```\\n\\nSQL UDFs can use [`IF` statements](/udf/sql/if) that use a slightly different\\nsyntax from `IF` expressions. Specifically note the requirement for terminating\\neach clause with a semicolon `;` and the usage of `END IF`.\\n\\n(coalesce-function)=\", \"COALESCE\": \":::{function} coalesce(value1, value2[, ...])\\nReturns the first non-null `value` in the argument list.\\nLike a `CASE` expression, arguments are only evaluated if necessary.\\n:::\\n\\n(nullif-function)=\", \"NULLIF\": \":::{function} nullif(value1, value2)\\nReturns null if `value1` equals `value2`, otherwise returns `value1`.\\n:::\\n\\n(try-function)=\", \"TRY\": {\"Examples\": \"Source table with some invalid data:\\n\\n```\\nSELECT * FROM shipping;\\n```\\n\\n```\\n origin_state | origin_zip | packages | total_cost\\n--------------+------------+----------+------------\\n California | 94131 | 25 | 100\\n California | P332a | 5 | 72\\n California | 94025 | 0 | 155\\n New Jersey | 08544 | 225 | 490\\n(4 rows)\\n```\\n\\nQuery failure without `TRY`:\\n\\n```\\nSELECT CAST(origin_zip AS BIGINT) FROM shipping;\\n```\\n\\n```\\nQuery failed: Cannot cast 'P332a' to BIGINT\\n```\\n\\n`NULL` values with `TRY`:\\n\\n```\\nSELECT TRY(CAST(origin_zip AS BIGINT)) FROM shipping;\\n```\\n\\n```\\n origin_zip\\n------------\\n 94131\\n NULL\\n 94025\\n 08544\\n(4 rows)\\n```\\n\\nQuery failure without `TRY`:\\n\\n```\\nSELECT total_cost / packages AS per_package FROM shipping;\\n```\\n\\n```\\nQuery failed: Division by zero\\n```\\n\\nDefault values with `TRY` and `COALESCE`:\\n\\n```\\nSELECT COALESCE(TRY(total_cost / packages), 0) AS per_package FROM shipping;\\n```\\n\\n```\\n per_package\\n-------------\\n 4\\n 14\\n 0\\n 19\\n(4 rows)\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 7]\"}, {\"title\": \"Conversion functions\", \"description\": null, \"content\": {\"Conversion functions\": \":::{function} cast(value AS type) -> type\\nExplicitly cast a value as a type. This can be used to cast a\\nvarchar to a numeric value type and vice versa.\\n:::\\n\\n:::{function} try_cast(value AS type) -> type\\nLike {func}`cast`, but returns null if the cast fails.\\n:::\", \"Formatting\": \":::{function} format(format, args...) -> varchar\\nReturns a formatted string using the specified [format string](https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/Formatter.html#syntax)\\nand arguments:\\n\\n```\\nSELECT format('%s%%', 123);\\n-- '123%'\\n\\nSELECT format('%.5f', pi());\\n-- '3.14159'\\n\\nSELECT format('%03d', 8);\\n-- '008'\\n\\nSELECT format('%,.2f', 1234567.89);\\n-- '1,234,567.89'\\n\\nSELECT format('%-7s,%7s', 'hello', 'world');\\n-- 'hello , world'\\n\\nSELECT format('%2$s %3$s %1$s', 'a', 'b', 'c');\\n-- 'b c a'\\n\\nSELECT format('%1$tA, %1$tB %1$te, %1$tY', date '2006-07-04');\\n-- 'Tuesday, July 4, 2006'\\n```\\n\\n:::\\n\\n:::{function} format_number(number) -> varchar\\nReturns a formatted string using a unit symbol:\\n\\n```\\nSELECT format_number(123456); -- '123K'\\nSELECT format_number(1000000); -- '1M'\\n```\\n\\n:::\", \"Data size\": \"The `parse_data_size` function supports the following units:\\n\\n:::{list-table}\\n:widths: 30, 40, 30\\n:header-rows: 1\\n\\n[['Unit', 'Description', 'Value'], ['``B``', 'Bytes', '1'], ['``kB``', 'Kilobytes', '1024'], ['``MB``', 'Megabytes', '1024{sup}`2`'], ['``GB``', 'Gigabytes', '1024{sup}`3`'], ['``TB``', 'Terabytes', '1024{sup}`4`'], ['``PB``', 'Petabytes', '1024{sup}`5`'], ['``EB``', 'Exabytes', '1024{sup}`6`'], ['``ZB``', 'Zettabytes', '1024{sup}`7`'], ['``YB``', 'Yottabytes', '1024{sup}`8`\\\\n:::']]\\n\\n:::{function} parse_data_size(string) -> decimal(38)\\nParses `string` of format `value unit` into a number, where\\n`value` is the fractional number of `unit` values:\\n\\n```\\nSELECT parse_data_size('1B'); -- 1\\nSELECT parse_data_size('1kB'); -- 1024\\nSELECT parse_data_size('1MB'); -- 1048576\\nSELECT parse_data_size('2.3MB'); -- 2411724\\n```\\n\\n:::\", \"Miscellaneous\": \":::{function} typeof(expr) -> varchar\\nReturns the name of the type of the provided expression:\\n\\n```\\nSELECT typeof(123); -- integer\\nSELECT typeof('cat'); -- varchar(3)\\nSELECT typeof(cos(2) + 1.5); -- double\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 8]\"}, {\"title\": \"Date and time functions and operators\", \"description\": null, \"content\": {\"Date and time operators\": \"| Operator | Example | Result |\\n| -------- | --------------------------------------------------- | ------------------------- |\\n| `+` | `date '2012-08-08' + interval '2' day` | `2012-08-10` |\\n| `+` | `time '01:00' + interval '3' hour` | `04:00:00.000` |\\n| `+` | `timestamp '2012-08-08 01:00' + interval '29' hour` | `2012-08-09 06:00:00.000` |\\n| `+` | `timestamp '2012-10-31 01:00' + interval '1' month` | `2012-11-30 01:00:00.000` |\\n| `+` | `interval '2' day + interval '3' hour` | `2 03:00:00.000` |\\n| `+` | `interval '3' year + interval '5' month` | `3-5` |\\n| `-` | `date '2012-08-08' - interval '2' day` | `2012-08-06` |\\n| `-` | `time '01:00' - interval '3' hour` | `22:00:00.000` |\\n| `-` | `timestamp '2012-08-08 01:00' - interval '29' hour` | `2012-08-06 20:00:00.000` |\\n| `-` | `timestamp '2012-10-31 01:00' - interval '1' month` | `2012-09-30 01:00:00.000` |\\n| `-` | `interval '2' day - interval '3' hour` | `1 21:00:00.000` |\\n| `-` | `interval '3' year - interval '5' month` | `2-7` |\\n\\n(at-time-zone-operator)=\", \"Time zone conversion\": \"The `AT TIME ZONE` operator sets the time zone of a timestamp:\\n\\n```\\nSELECT timestamp '2012-10-31 01:00 UTC';\\n-- 2012-10-31 01:00:00.000 UTC\\n\\nSELECT timestamp '2012-10-31 01:00 UTC' AT TIME ZONE 'America/Los_Angeles';\\n-- 2012-10-30 18:00:00.000 America/Los_Angeles\\n```\", \"Date and time functions\": \":::{data} current_date\\nReturns the current date as of the start of the query.\\n:::\\n\\n:::{data} current_time\\nReturns the current time with time zone as of the start of the query.\\n:::\\n\\n:::{data} current_timestamp\\nReturns the current timestamp with time zone as of the start of the query,\\nwith `3` digits of subsecond precision,\\n:::\\n\\n:::{data} current_timestamp(p)\\n:noindex: true\\n\\nReturns the current {ref}`timestamp with time zone\\n<timestamp-with-time-zone-data-type>` as of the start of the query, with\\n`p` digits of subsecond precision:\\n\\n```\\nSELECT current_timestamp(6);\\n-- 2020-06-24 08:25:31.759993 America/Los_Angeles\\n```\\n\\n:::\\n\\n:::{function} current_timezone() -> varchar\\nReturns the current time zone in the format defined by IANA\\n(e.g., `America/Los_Angeles`) or as fixed offset from UTC (e.g., `+08:35`)\\n:::\\n\\n:::{function} date(x) -> date\\nThis is an alias for `CAST(x AS date)`.\\n:::\\n\\n:::{function} last_day_of_month(x) -> date\\nReturns the last day of the month.\\n:::\\n\\n:::{function} from_iso8601_timestamp(string) -> timestamp(3) with time zone\\nParses the ISO 8601 formatted date `string`, optionally with time and time\\nzone, into a `timestamp(3) with time zone`. The time defaults to\\n`00:00:00.000`, and the time zone defaults to the session time zone:\\n\\n```\\nSELECT from_iso8601_timestamp('2020-05-11');\\n-- 2020-05-11 00:00:00.000 America/Vancouver\\n\\nSELECT from_iso8601_timestamp('2020-05-11T11:15:05');\\n-- 2020-05-11 11:15:05.000 America/Vancouver\\n\\nSELECT from_iso8601_timestamp('2020-05-11T11:15:05.055+01:00');\\n-- 2020-05-11 11:15:05.055 +01:00\\n```\\n\\n:::\\n\\n:::{function} from_iso8601_timestamp_nanos(string) -> timestamp(9) with time zone\\nParses the ISO 8601 formatted date and time `string`. The time zone\\ndefaults to the session time zone:\\n\\n```\\nSELECT from_iso8601_timestamp_nanos('2020-05-11T11:15:05');\\n-- 2020-05-11 11:15:05.000000000 America/Vancouver\\n\\nSELECT from_iso8601_timestamp_nanos('2020-05-11T11:15:05.123456789+01:00');\\n-- 2020-05-11 11:15:05.123456789 +01:00\\n```\\n\\n:::\\n\\n:::{function} from_iso8601_date(string) -> date\\nParses the ISO 8601 formatted date `string` into a `date`. The date can\\nbe a calendar date, a week date using ISO week numbering, or year and day\\nof year combined:\\n\\n```\\nSELECT from_iso8601_date('2020-05-11');\\n-- 2020-05-11\\n\\nSELECT from_iso8601_date('2020-W10');\\n-- 2020-03-02\\n\\nSELECT from_iso8601_date('2020-123');\\n-- 2020-05-02\\n```\\n\\n:::\\n\\n:::{function} at_timezone(timestamp(p) with time zone, zone) -> timestamp(p) with time zone\\nConverts a `timestamp(p) with time zone` to a time zone specified in `zone`.\\n\\nIn the following example, the input timezone is `GMT`, which is seven hours\\nahead of `America/Los_Angeles` in November 2022:\\n\\n```\\nSELECT at_timezone(TIMESTAMP '2022-11-01 09:08:07.321 GMT', 'America/Los_Angeles')\\n-- 2022-11-01 02:08:07.321 America/Los_Angeles\\n```\\n\\n:::\\n\\n:::{function} with_timezone(timestamp(p), zone) -> timestamp(p) with time zone\\nReturns the timestamp specified in `timestamp` with the time zone\\nspecified in `zone` with precision `p`:\\n\\n```\\nSELECT current_timezone()\\n-- America/New_York\\n\\nSELECT with_timezone(TIMESTAMP '2022-11-01 09:08:07.321', 'America/Los_Angeles')\\n-- 2022-11-01 09:08:07.321 America/Los_Angeles\\n```\\n\\n:::\\n\\n:::{function} from_unixtime(unixtime) -> timestamp(3) with time zone\\nReturns the UNIX timestamp `unixtime` as a timestamp with time zone. `unixtime` is the\\nnumber of seconds since `1970-01-01 00:00:00 UTC`.\\n:::\\n\\n:::{function} from_unixtime(unixtime, zone) -> timestamp(3) with time zone\\n:noindex: true\\n\\nReturns the UNIX timestamp `unixtime` as a timestamp with time zone\\nusing `zone` for the time zone. `unixtime` is the number of seconds\\nsince `1970-01-01 00:00:00 UTC`.\\n:::\\n\\n:::{function} from_unixtime(unixtime, hours, minutes) -> timestamp(3) with time zone\\n:noindex: true\\n\\nReturns the UNIX timestamp `unixtime` as a timestamp with time zone\\nusing `hours` and `minutes` for the time zone offset. `unixtime` is\\nthe number of seconds since `1970-01-01 00:00:00` in `double` data type.\\n:::\\n\\n:::{function} from_unixtime_nanos(unixtime) -> timestamp(9) with time zone\\nReturns the UNIX timestamp `unixtime` as a timestamp with time zone. `unixtime` is the\\nnumber of nanoseconds since `1970-01-01 00:00:00.000000000 UTC`:\\n\\n```\\nSELECT from_unixtime_nanos(100);\\n-- 1970-01-01 00:00:00.000000100 UTC\\n\\nSELECT from_unixtime_nanos(DECIMAL '1234');\\n-- 1970-01-01 00:00:00.000001234 UTC\\n\\nSELECT from_unixtime_nanos(DECIMAL '1234.499');\\n-- 1970-01-01 00:00:00.000001234 UTC\\n\\nSELECT from_unixtime_nanos(DECIMAL '-1234');\\n-- 1969-12-31 23:59:59.999998766 UTC\\n```\\n\\n:::\\n\\n:::{data} localtime\\nReturns the current time as of the start of the query.\\n:::\\n\\n:::{data} localtimestamp\\nReturns the current timestamp as of the start of the query, with `3`\\ndigits of subsecond precision.\\n:::\\n\\n:::{data} localtimestamp(p)\\n:noindex: true\\n\\nReturns the current {ref}`timestamp <timestamp-data-type>` as of the start\\nof the query, with `p` digits of subsecond precision:\\n\\n```\\nSELECT localtimestamp(6);\\n-- 2020-06-10 15:55:23.383628\\n```\\n\\n:::\\n\\n:::{function} now() -> timestamp(3) with time zone\\nThis is an alias for `current_timestamp`.\\n:::\\n\\n:::{function} to_iso8601(x) -> varchar\\nFormats `x` as an ISO 8601 string. `x` can be date, timestamp, or\\ntimestamp with time zone.\\n:::\\n\\n:::{function} to_milliseconds(interval) -> bigint\\nReturns the day-to-second `interval` as milliseconds.\\n:::\\n\\n:::{function} to_unixtime(timestamp) -> double\\nReturns `timestamp` as a UNIX timestamp.\\n:::\\n\\n:::{note}\\nThe following SQL-standard functions do not use parenthesis:\\n\\n['`current_date`', '`current_time`', '`current_timestamp`', '`localtime`', '`localtimestamp`\\\\n:::']\", \"Truncation function\": \"The `date_trunc` function supports the following units:\\n\\n| Unit | Example Truncated Value |\\n| --------- | ------------------------- |\\n| `millisecond` | `2001-08-22 03:04:05.321` |\\n| `second` | `2001-08-22 03:04:05.000` |\\n| `minute` | `2001-08-22 03:04:00.000` |\\n| `hour` | `2001-08-22 03:00:00.000` |\\n| `day` | `2001-08-22 00:00:00.000` |\\n| `week` | `2001-08-20 00:00:00.000` |\\n| `month` | `2001-08-01 00:00:00.000` |\\n| `quarter` | `2001-07-01 00:00:00.000` |\\n| `year` | `2001-01-01 00:00:00.000` |\\n\\nThe above examples use the timestamp `2001-08-22 03:04:05.321` as the input.\\n\\n:::{function} date_trunc(unit, x) -> [same as input]\\nReturns `x` truncated to `unit`:\\n\\n```\\nSELECT date_trunc('day' , TIMESTAMP '2022-10-20 05:10:00');\\n-- 2022-10-20 00:00:00.000\\n\\nSELECT date_trunc('month' , TIMESTAMP '2022-10-20 05:10:00');\\n-- 2022-10-01 00:00:00.000\\n\\nSELECT date_trunc('year', TIMESTAMP '2022-10-20 05:10:00');\\n-- 2022-01-01 00:00:00.000\\n```\\n\\n:::\\n\\n(datetime-interval-functions)=\", \"Interval functions\": \"The functions in this section support the following interval units:\\n\\n| Unit | Description |\\n| ------------- | ------------------ |\\n| `millisecond` | Milliseconds |\\n| `second` | Seconds |\\n| `minute` | Minutes |\\n| `hour` | Hours |\\n| `day` | Days |\\n| `week` | Weeks |\\n| `month` | Months |\\n| `quarter` | Quarters of a year |\\n| `year` | Years |\\n\\n:::{function} date_add(unit, value, timestamp) -> [same as input]\\nAdds an interval `value` of type `unit` to `timestamp`.\\nSubtraction can be performed by using a negative value:\\n\\n```\\nSELECT date_add('second', 86, TIMESTAMP '2020-03-01 00:00:00');\\n-- 2020-03-01 00:01:26.000\\n\\nSELECT date_add('hour', 9, TIMESTAMP '2020-03-01 00:00:00');\\n-- 2020-03-01 09:00:00.000\\n\\nSELECT date_add('day', -1, TIMESTAMP '2020-03-01 00:00:00 UTC');\\n-- 2020-02-29 00:00:00.000 UTC\\n```\\n\\n:::\\n\\n:::{function} date_diff(unit, timestamp1, timestamp2) -> bigint\\nReturns `timestamp2 - timestamp1` expressed in terms of `unit`:\\n\\n```\\nSELECT date_diff('second', TIMESTAMP '2020-03-01 00:00:00', TIMESTAMP '2020-03-02 00:00:00');\\n-- 86400\\n\\nSELECT date_diff('hour', TIMESTAMP '2020-03-01 00:00:00 UTC', TIMESTAMP '2020-03-02 00:00:00 UTC');\\n-- 24\\n\\nSELECT date_diff('day', DATE '2020-03-01', DATE '2020-03-02');\\n-- 1\\n\\nSELECT date_diff('second', TIMESTAMP '2020-06-01 12:30:45.000000000', TIMESTAMP '2020-06-02 12:30:45.123456789');\\n-- 86400\\n\\nSELECT date_diff('millisecond', TIMESTAMP '2020-06-01 12:30:45.000000000', TIMESTAMP '2020-06-02 12:30:45.123456789');\\n-- 86400123\\n```\\n\\n:::\", \"Duration function\": \"The `parse_duration` function supports the following units:\\n\\n| Unit | Description |\\n| ---- | ------------ |\\n| `ns` | Nanoseconds |\\n| `us` | Microseconds |\\n| `ms` | Milliseconds |\\n| `s` | Seconds |\\n| `m` | Minutes |\\n| `h` | Hours |\\n| `d` | Days |\\n\\n:::{function} parse_duration(string) -> interval\\nParses `string` of format `value unit` into an interval, where\\n`value` is fractional number of `unit` values:\\n\\n```\\nSELECT parse_duration('42.8ms');\\n-- 0 00:00:00.043\\n\\nSELECT parse_duration('3.81 d');\\n-- 3 19:26:24.000\\n\\nSELECT parse_duration('5m');\\n-- 0 00:05:00.000\\n```\\n\\n:::\\n\\n:::{function} human_readable_seconds(double) -> varchar\\nFormats the double value of `seconds` into a human-readable string containing\\n`weeks`, `days`, `hours`, `minutes`, and `seconds`:\\n\\n```\\nSELECT human_readable_seconds(96);\\n-- 1 minute, 36 seconds\\n\\nSELECT human_readable_seconds(3762);\\n-- 1 hour, 2 minutes, 42 seconds\\n\\nSELECT human_readable_seconds(56363463);\\n-- 93 weeks, 1 day, 8 hours, 31 minutes, 3 seconds\\n```\\n\\n:::\", \"MySQL date functions\": \"The functions in this section use a format string that is compatible with\\nthe MySQL `date_parse` and `str_to_date` functions. The following table,\\nbased on the MySQL manual, describes the format specifiers:\\n\\n| Specifier | Description |\\n| --------- | ------------------------------------------------------------------------------------------------------------------- |\\n| `%a` | Abbreviated weekday name (`Sun` .. `Sat`) |\\n| `%b` | Abbreviated month name (`Jan` .. `Dec`) |\\n| `%c` | Month, numeric (`1` .. `12`), this specifier does not support `0` as a month. |\\n| `%D` | Day of the month with English suffix (`0th`, `1st`, `2nd`, `3rd`, ...) |\\n| `%d` | Day of the month, numeric (`01` .. `31`), this specifier does not support `0` as a month or day. |\\n| `%e` | Day of the month, numeric (`1` .. `31`), this specifier does not support `0` as a day. |\\n| `%f` | Fraction of second (6 digits for printing: `000000` .. `999000`; 1 - 9 digits for parsing: `0` .. `999999999`), timestamp is truncated to milliseconds. |\\n| `%H` | Hour (`00` .. `23`) |\\n| `%h` | Hour (`01` .. `12`) |\\n| `%I` | Hour (`01` .. `12`) |\\n| `%i` | Minutes, numeric (`00` .. `59`) |\\n| `%j` | Day of year (`001` .. `366`) |\\n| `%k` | Hour (`0` .. `23`) |\\n| `%l` | Hour (`1` .. `12`) |\\n| `%M` | Month name (`January` .. `December`) |\\n| `%m` | Month, numeric (`01` .. `12`), this specifier does not support `0` as a month. |\\n| `%p` | `AM` or `PM` |\\n| `%r` | Time of day, 12-hour (equivalent to `%h:%i:%s %p`) |\\n| `%S` | Seconds (`00` .. `59`) |\\n| `%s` | Seconds (`00` .. `59`) |\\n| `%T` | Time of day, 24-hour (equivalent to `%H:%i:%s`) |\\n| `%U` | Week (`00` .. `53`), where Sunday is the first day of the week |\\n| `%u` | Week (`00` .. `53`), where Monday is the first day of the week |\\n| `%V` | Week (`01` .. `53`), where Sunday is the first day of the week; used with `%X` |\\n| `%v` | Week (`01` .. `53`), where Monday is the first day of the week; used with `%x` |\\n| `%W` | Weekday name (`Sunday` .. `Saturday`) |\\n| `%w` | Day of the week (`0` .. `6`), where Sunday is the first day of the week, this specifier is not supported,consider using {func}`day_of_week` (it uses `1-7` instead of `0-6`). |\\n| `%X` | Year for the week where Sunday is the first day of the week, numeric, four digits; used with `%V` |\\n| `%x` | Year for the week, where Monday is the first day of the week, numeric, four digits; used with `%v` |\\n| `%Y` | Year, numeric, four digits |\\n| `%y` | Year, numeric (two digits), when parsing, two-digit year format assumes range `1970` .. `2069`, so \\\"70\\\" will result in year `1970` but \\\"69\\\" will produce `2069`. |\\n| `%%` | A literal `%` character |\\n| `%x` | `x`, for any `x` not listed above |\\n\\n:::{warning}\\nThe following specifiers are not currently supported: `%D %U %u %V %w %X`\\n:::\\n\\n:::{function} date_format(timestamp, format) -> varchar\\nFormats `timestamp` as a string using `format`:\\n\\n```\\nSELECT date_format(TIMESTAMP '2022-10-20 05:10:00', '%m-%d-%Y %H');\\n-- 10-20-2022 05\\n```\\n\\n:::\\n\\n:::{js:function} date_parse(string, format) \\u2192 timestamp(3)\\nParses `string` into a timestamp using `format`:\\n\\n```\\nSELECT date_parse('2022/10/20/05', '%Y/%m/%d/%H');\\n-- 2022-10-20 05:00:00.000\\n```\\n\\n:::\", \"Java date functions\": \"The functions in this section use a format string that is compatible with\\nJodaTime's [DateTimeFormat] pattern format.\\n\\n:::{function} format_datetime(timestamp, format) -> varchar\\nFormats `timestamp` as a string using `format`.\\n:::\\n\\n:::{function} parse_datetime(string, format) -> timestamp with time zone\\nParses `string` into a timestamp with time zone using `format`.\\n:::\", \"Extraction function\": \"The `extract` function supports the following fields:\\n\\n| Field | Description |\\n| ----------------- | ----------------------- |\\n| `YEAR` | {func}`year` |\\n| `QUARTER` | {func}`quarter` |\\n| `MONTH` | {func}`month` |\\n| `WEEK` | {func}`week` |\\n| `DAY` | {func}`day` |\\n| `DAY_OF_MONTH` | {func}`day` |\\n| `DAY_OF_WEEK` | {func}`day_of_week` |\\n| `DOW` | {func}`day_of_week` |\\n| `DAY_OF_YEAR` | {func}`day_of_year` |\\n| `DOY` | {func}`day_of_year` |\\n| `YEAR_OF_WEEK` | {func}`year_of_week` |\\n| `YOW` | {func}`year_of_week` |\\n| `HOUR` | {func}`hour` |\\n| `MINUTE` | {func}`minute` |\\n| `SECOND` | {func}`second` |\\n| `TIMEZONE_HOUR` | {func}`timezone_hour` |\\n| `TIMEZONE_MINUTE` | {func}`timezone_minute` |\\n\\nThe types supported by the `extract` function vary depending on the\\nfield to be extracted. Most fields support all date and time types.\\n\\n::::{function} extract(field FROM x) -> bigint\\nReturns `field` from `x`:\\n\\n```\\nSELECT extract(YEAR FROM TIMESTAMP '2022-10-20 05:10:00');\\n-- 2022\\n```\\n\\n:::{note}\\nThis SQL-standard function uses special syntax for specifying the arguments.\\n:::\\n::::\", \"Convenience extraction functions\": \":::{function} day(x) -> bigint\\nReturns the day of the month from `x`.\\n:::\\n\\n:::{function} day_of_month(x) -> bigint\\nThis is an alias for {func}`day`.\\n:::\\n\\n:::{function} day_of_week(x) -> bigint\\nReturns the ISO day of the week from `x`.\\nThe value ranges from `1` (Monday) to `7` (Sunday).\\n:::\\n\\n:::{function} day_of_year(x) -> bigint\\nReturns the day of the year from `x`.\\nThe value ranges from `1` to `366`.\\n:::\\n\\n:::{function} dow(x) -> bigint\\nThis is an alias for {func}`day_of_week`.\\n:::\\n\\n:::{function} doy(x) -> bigint\\nThis is an alias for {func}`day_of_year`.\\n:::\\n\\n:::{function} hour(x) -> bigint\\nReturns the hour of the day from `x`.\\nThe value ranges from `0` to `23`.\\n:::\\n\\n:::{function} millisecond(x) -> bigint\\nReturns the millisecond of the second from `x`.\\n:::\\n\\n:::{function} minute(x) -> bigint\\nReturns the minute of the hour from `x`.\\n:::\\n\\n:::{function} month(x) -> bigint\\nReturns the month of the year from `x`.\\n:::\\n\\n:::{function} quarter(x) -> bigint\\nReturns the quarter of the year from `x`.\\nThe value ranges from `1` to `4`.\\n:::\\n\\n:::{function} second(x) -> bigint\\nReturns the second of the minute from `x`.\\n:::\\n\\n:::{function} timezone_hour(timestamp) -> bigint\\nReturns the hour of the time zone offset from `timestamp`.\\n:::\\n\\n:::{function} timezone_minute(timestamp) -> bigint\\nReturns the minute of the time zone offset from `timestamp`.\\n:::\\n\\n:::{function} week(x) -> bigint\\nReturns the [ISO week] of the year from `x`.\\nThe value ranges from `1` to `53`.\\n:::\\n\\n:::{function} week_of_year(x) -> bigint\\nThis is an alias for {func}`week`.\\n:::\\n\\n:::{function} year(x) -> bigint\\nReturns the year from `x`.\\n:::\\n\\n:::{function} year_of_week(x) -> bigint\\nReturns the year of the [ISO week] from `x`.\\n:::\\n\\n:::{function} yow(x) -> bigint\\nThis is an alias for {func}`year_of_week`.\\n:::\\n\\n:::{function} timezone(timestamp(p) with time zone) -> varchar \\n\\nReturns the timezone identifier from `timestamp(p) with time zone`. The format\\nof the returned identifier is identical to the [format used in the input\\ntimestamp](timestamp-p-with-time-zone-data-type):\\n\\n```\\nSELECT timezone(TIMESTAMP '2024-01-01 12:00:00 Asia/Tokyo'); -- Asia/Tokyo\\nSELECT timezone(TIMESTAMP '2024-01-01 12:00:00 +01:00'); -- +01:00\\nSELECT timezone(TIMESTAMP '2024-02-29 12:00:00 UTC'); -- UTC\\n```\\n\\n:::\\n\\n:::{function} timezone(time(p) with time zone) -> varchar\\n:no-index:\\nReturns the timezone identifier from a `time(p) with time zone`. The format\\nof the returned identifier is identical to the [format used in the input\\ntime](time-with-time-zone-data-type):\\n\\n```\\nSELECT timezone(TIME '12:00:00+09:00'); -- +09:00\\n```\\n\\n:::\\n\\n[datetimeformat]: http://joda-time.sourceforge.net/apidocs/org/joda/time/format/DateTimeFormat.html\\n[iso week]: https://wikipedia.org/wiki/ISO_week_date\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 9]\"}, {\"title\": \"Decimal functions and operators\", \"description\": null, \"content\": {\"Decimal literals\": \"Use the `DECIMAL 'xxxxxxx.yyyyyyy'` syntax to define a decimal literal.\\n\\nThe precision of a decimal type for a literal will be equal to the number of digits\\nin the literal (including trailing and leading zeros). The scale will be equal\\nto the number of digits in the fractional part (including trailing zeros).\\n\\n:::{list-table}\\n:widths: 50, 50\\n:header-rows: 1\\n\\n[['Example literal', 'Data type'], [\\\"`DECIMAL '0'`\\\", '`DECIMAL(1)`'], [\\\"`DECIMAL '12345'`\\\", '`DECIMAL(5)`'], [\\\"`DECIMAL '0000012345.1234500000'`\\\", '`DECIMAL(20, 10)`\\\\n:::']]\", \"Binary arithmetic decimal operators\": \"Standard mathematical operators are supported. The table below explains\\nprecision and scale calculation rules for result.\\nAssuming `x` is of type `DECIMAL(xp, xs)` and `y` is of type `DECIMAL(yp, ys)`.\\n\\n:::{list-table}\\n:widths: 30, 40, 30\\n:header-rows: 1\\n\\n[['Operation', 'Result type precision', 'Result type scale'], ['`x + y` and `x - y`', '```\\\\nmin(38,\\\\n 1 +\\\\n max(xs, ys) +\\\\n max(xp - xs, yp - ys)\\\\n)\\\\n```', '`max(xs, ys)`'], ['`x * y`', '```\\\\nmin(38, xp + yp)\\\\n```', '`xs + ys`'], ['`x / y`', '```\\\\nmin(38,\\\\n xp + ys-xs\\\\n + max(0, ys-xs)\\\\n )\\\\n```', '`max(xs, ys)`'], ['`x % y`', '```\\\\nmin(xp - xs, yp - ys) +\\\\nmax(xs, bs)\\\\n```', '`max(xs, ys)`\\\\n:::']]\\n\\nIf the mathematical result of the operation is not exactly representable with\\nthe precision and scale of the result data type,\\nthen an exception condition is raised: `Value is out of range`.\\n\\nWhen operating on decimal types with different scale and precision, the values are\\nfirst coerced to a common super type. For types near the largest representable precision (38),\\nthis can result in Value is out of range errors when one of the operands doesn't fit\\nin the common super type. For example, the common super type of decimal(38, 0) and\\ndecimal(38, 1) is decimal(38, 1), but certain values that fit in decimal(38, 0)\\ncannot be represented as a decimal(38, 1).\", \"Comparison operators\": \"All standard {doc}`comparison` work for the decimal type.\", \"Unary decimal operators\": \"The `-` operator performs negation. The type of result is same as type of argument.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 10]\"}, {\"title\": \"Geospatial functions\", \"description\": null, \"content\": {\"Constructors\": \":::{function} ST_AsBinary(Geometry) -> varbinary\\nReturns the WKB representation of the geometry.\\n:::\\n\\n:::{function} ST_AsText(Geometry) -> varchar\\nReturns the WKT representation of the geometry. For empty geometries,\\n`ST_AsText(ST_LineFromText('LINESTRING EMPTY'))` will produce `'MULTILINESTRING EMPTY'`\\nand `ST_AsText(ST_Polygon('POLYGON EMPTY'))` will produce `'MULTIPOLYGON EMPTY'`.\\n:::\\n\\n:::{function} ST_GeometryFromText(varchar) -> Geometry\\nReturns a geometry type object from WKT representation.\\n:::\\n\\n:::{function} ST_GeomFromBinary(varbinary) -> Geometry\\nReturns a geometry type object from WKB or EWKB representation.\\n:::\\n\\n:::{function} ST_GeomFromKML(varchar) -> Geometry\\nReturns a geometry type object from KML representation.\\n:::\\n\\n:::{function} geometry_from_hadoop_shape(varbinary) -> Geometry\\nReturns a geometry type object from Spatial Framework for Hadoop representation.\\n:::\\n\\n:::{function} ST_LineFromText(varchar) -> LineString\\nReturns a geometry type linestring object from WKT representation.\\n:::\\n\\n:::{function} ST_LineString(array(Point)) -> LineString\\nReturns a LineString formed from an array of points. If there are fewer than\\ntwo non-empty points in the input array, an empty LineString will be returned.\\nArray elements must not be `NULL` or the same as the previous element.\\nThe returned geometry may not be simple, e.g. may self-intersect or may contain\\nduplicate vertexes depending on the input.\\n:::\\n\\n:::{function} ST_MultiPoint(array(Point)) -> MultiPoint\\nReturns a MultiPoint geometry object formed from the specified points. Returns `NULL` if input array is empty.\\nArray elements must not be `NULL` or empty.\\nThe returned geometry may not be simple and may contain duplicate points if input array has duplicates.\\n:::\\n\\n:::{function} ST_Point(lon: double, lat: double) -> Point\\nReturns a geometry type point object with the given coordinate values.\\n:::\\n\\n:::{function} ST_Polygon(varchar) -> Polygon\\nReturns a geometry type polygon object from WKT representation.\\n:::\\n\\n:::{function} to_spherical_geography(Geometry) -> SphericalGeography\\nConverts a Geometry object to a SphericalGeography object on the sphere of the Earth's radius. This\\nfunction is only applicable to `POINT`, `MULTIPOINT`, `LINESTRING`, `MULTILINESTRING`,\\n`POLYGON`, `MULTIPOLYGON` geometries defined in 2D space, or `GEOMETRYCOLLECTION` of such\\ngeometries. For each point of the input geometry, it verifies that `point.x` is within\\n`[-180.0, 180.0]` and `point.y` is within `[-90.0, 90.0]`, and uses them as (longitude, latitude)\\ndegrees to construct the shape of the `SphericalGeography` result.\\n:::\\n\\n:::{function} to_geometry(SphericalGeography) -> Geometry\\nConverts a SphericalGeography object to a Geometry object.\\n:::\", \"Relationship tests\": \":::{function} ST_Contains(geometryA: Geometry, geometryB: Geometry) -> boolean\\nReturns `true` if and only if no points of the second geometry lie in the exterior\\nof the first geometry, and at least one point of the interior of the first geometry\\nlies in the interior of the second geometry.\\n:::\\n\\n:::{function} ST_Crosses(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the supplied geometries have some, but not all, interior points in common.\\n:::\\n\\n:::{function} ST_Disjoint(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the give geometries do not *spatially intersect* --\\nif they do not share any space together.\\n:::\\n\\n:::{function} ST_Equals(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the given geometries represent the same geometry.\\n:::\\n\\n:::{function} ST_Intersects(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the given geometries spatially intersect in two dimensions\\n(share any portion of space) and `false` if they do not (they are disjoint).\\n:::\\n\\n:::{function} ST_Overlaps(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the given geometries share space, are of the same dimension,\\nbut are not completely contained by each other.\\n:::\\n\\n:::{function} ST_Relate(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if first geometry is spatially related to second geometry.\\n:::\\n\\n:::{function} ST_Touches(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if the given geometries have at least one point in common,\\nbut their interiors do not intersect.\\n:::\\n\\n:::{function} ST_Within(first: Geometry, second: Geometry) -> boolean\\nReturns `true` if first geometry is completely inside second geometry.\\n:::\", \"Operations\": \":::{function} geometry_nearest_points(first: Geometry, second: Geometry) -> row(Point, Point)\\nReturns the points on each geometry nearest the other. If either geometry\\nis empty, return `NULL`. Otherwise, return a row of two Points that have\\nthe minimum distance of any two points on the geometries. The first Point\\nwill be from the first Geometry argument, the second from the second Geometry\\nargument. If there are multiple pairs with the minimum distance, one pair\\nis chosen arbitrarily.\\n:::\\n\\n:::{function} geometry_union(array(Geometry)) -> Geometry\\nReturns a geometry that represents the point set union of the input geometries. Performance\\nof this function, in conjunction with {func}`array_agg` to first aggregate the input geometries,\\nmay be better than {func}`geometry_union_agg`, at the expense of higher memory utilization.\\n:::\\n\\n:::{function} ST_Boundary(Geometry) -> Geometry\\nReturns the closure of the combinatorial boundary of this geometry.\\n:::\\n\\n:::{function} ST_Buffer(Geometry, distance) -> Geometry\\nReturns the geometry that represents all points whose distance from the specified geometry\\nis less than or equal to the specified distance. If the points of the geometry are extremely\\nclose together (``delta < 1e-8``), this might return an empty geometry.\\n:::\\n\\n:::{function} ST_Difference(first: Geometry, second: Geometry) -> Geometry\\nReturns the geometry value that represents the point set difference of the given geometries.\\n:::\\n\\n:::{function} ST_Envelope(Geometry) -> Geometry\\nReturns the bounding rectangular polygon of a geometry.\\n:::\\n\\n:::{function} ST_EnvelopeAsPts(Geometry) -> array(Geometry)\\nReturns an array of two points: the lower left and upper right corners of the bounding\\nrectangular polygon of a geometry. Returns `NULL` if input geometry is empty.\\n:::\\n\\n:::{function} ST_ExteriorRing(Geometry) -> Geometry\\nReturns a line string representing the exterior ring of the input polygon.\\n:::\\n\\n:::{function} ST_Intersection(first: Geometry, second: Geometry) -> Geometry\\nReturns the geometry value that represents the point set intersection of two geometries.\\n:::\\n\\n:::{function} ST_SymDifference(first: Geometry, second: Geometry) -> Geometry\\nReturns the geometry value that represents the point set symmetric difference of two geometries.\\n:::\\n\\n:::{function} ST_Union(first: Geometry, second: Geometry) -> Geometry\\nReturns a geometry that represents the point set union of the input geometries.\\n\\nSee also: {func}`geometry_union`, {func}`geometry_union_agg`\\n:::\", \"Accessors\": \":::{function} ST_Area(Geometry) -> double\\nReturns the 2D Euclidean area of a geometry.\\n\\nFor Point and LineString types, returns 0.0.\\nFor GeometryCollection types, returns the sum of the areas of the individual\\ngeometries.\\n:::\\n\\n:::{function} ST_Area(SphericalGeography) -> double\\n:noindex: true\\n\\nReturns the area of a polygon or multi-polygon in square meters using a spherical model for Earth.\\n:::\\n\\n:::{function} ST_Centroid(Geometry) -> Geometry\\nReturns the point value that is the mathematical centroid of a geometry.\\n:::\\n\\n:::{function} ST_ConvexHull(Geometry) -> Geometry\\nReturns the minimum convex geometry that encloses all input geometries.\\n:::\\n\\n:::{function} ST_CoordDim(Geometry) -> bigint\\nReturns the coordinate dimension of the geometry.\\n:::\\n\\n:::{function} ST_Dimension(Geometry) -> bigint\\nReturns the inherent dimension of this geometry object, which must be\\nless than or equal to the coordinate dimension.\\n:::\\n\\n:::{function} ST_Distance(first: Geometry, second: Geometry) -> double\\n:noindex: true\\n\\nReturns the 2-dimensional cartesian minimum distance (based on spatial ref)\\nbetween two geometries in projected units.\\n:::\\n\\n:::{function} ST_Distance(first: SphericalGeography, second: SphericalGeography) -> double\\nReturns the great-circle distance in meters between two SphericalGeography points.\\n:::\\n\\n:::{function} ST_GeometryN(Geometry, index) -> Geometry\\nReturns the geometry element at a given index (indices start at 1).\\nIf the geometry is a collection of geometries (e.g., GEOMETRYCOLLECTION or MULTI\\\\*),\\nreturns the geometry at a given index.\\nIf the given index is less than 1 or greater than the total number of elements in the collection,\\nreturns `NULL`.\\nUse {func}`ST_NumGeometries` to find out the total number of elements.\\nSingular geometries (e.g., POINT, LINESTRING, POLYGON), are treated as collections of one element.\\nEmpty geometries are treated as empty collections.\\n:::\\n\\n:::{function} ST_InteriorRingN(Geometry, index) -> Geometry\\nReturns the interior ring element at the specified index (indices start at 1). If\\nthe given index is less than 1 or greater than the total number of interior rings\\nin the input geometry, returns `NULL`. The input geometry must be a polygon.\\nUse {func}`ST_NumInteriorRing` to find out the total number of elements.\\n:::\\n\\n:::{function} ST_GeometryType(Geometry) -> varchar\\nReturns the type of the geometry.\\n:::\\n\\n:::{function} ST_IsClosed(Geometry) -> boolean\\nReturns `true` if the linestring's start and end points are coincident.\\n:::\\n\\n:::{function} ST_IsEmpty(Geometry) -> boolean\\nReturns `true` if this Geometry is an empty geometrycollection, polygon, point etc.\\n:::\\n\\n:::{function} ST_IsSimple(Geometry) -> boolean\\nReturns `true` if this Geometry has no anomalous geometric points, such as self intersection or self tangency.\\n:::\\n\\n:::{function} ST_IsRing(Geometry) -> boolean\\nReturns `true` if and only if the line is closed and simple.\\n:::\\n\\n:::{function} ST_IsValid(Geometry) -> boolean\\nReturns `true` if and only if the input geometry is well-formed.\\nUse {func}`geometry_invalid_reason` to determine why the geometry is not well-formed.\\n:::\\n\\n:::{function} ST_Length(Geometry) -> double\\nReturns the length of a linestring or multi-linestring using Euclidean measurement on a\\ntwo-dimensional plane (based on spatial ref) in projected units.\\n:::\\n\\n:::{function} ST_Length(SphericalGeography) -> double\\n:noindex: true\\n\\nReturns the length of a linestring or multi-linestring on a spherical model of the Earth.\\nThis is equivalent to the sum of great-circle distances between adjacent points on the linestring.\\n:::\\n\\n:::{function} ST_PointN(LineString, index) -> Point\\nReturns the vertex of a linestring at a given index (indices start at 1).\\nIf the given index is less than 1 or greater than the total number of elements in the collection,\\nreturns `NULL`.\\nUse {func}`ST_NumPoints` to find out the total number of elements.\\n:::\\n\\n:::{function} ST_Points(Geometry) -> array(Point)\\nReturns an array of points in a linestring.\\n:::\\n\\n:::{function} ST_XMax(Geometry) -> double\\nReturns X maxima of a bounding box of a geometry.\\n:::\\n\\n:::{function} ST_YMax(Geometry) -> double\\nReturns Y maxima of a bounding box of a geometry.\\n:::\\n\\n:::{function} ST_XMin(Geometry) -> double\\nReturns X minima of a bounding box of a geometry.\\n:::\\n\\n:::{function} ST_YMin(Geometry) -> double\\nReturns Y minima of a bounding box of a geometry.\\n:::\\n\\n:::{function} ST_StartPoint(Geometry) -> point\\nReturns the first point of a LineString geometry as a Point.\\nThis is a shortcut for `ST_PointN(geometry, 1)`.\\n:::\\n\\n:::{function} simplify_geometry(Geometry, double) -> Geometry\\nReturns a \\\"simplified\\\" version of the input geometry using the Douglas-Peucker algorithm.\\nWill avoid creating derived geometries (polygons in particular) that are invalid.\\n:::\\n\\n:::{function} ST_EndPoint(Geometry) -> point\\nReturns the last point of a LineString geometry as a Point.\\nThis is a shortcut for `ST_PointN(geometry, ST_NumPoints(geometry))`.\\n:::\\n\\n:::{function} ST_X(Point) -> double\\nReturns the X coordinate of the point.\\n:::\\n\\n:::{function} ST_Y(Point) -> double\\nReturns the Y coordinate of the point.\\n:::\\n\\n:::{function} ST_InteriorRings(Geometry) -> array(Geometry)\\nReturns an array of all interior rings found in the input geometry, or an empty\\narray if the polygon has no interior rings. Returns `NULL` if the input geometry\\nis empty. The input geometry must be a polygon.\\n:::\\n\\n:::{function} ST_NumGeometries(Geometry) -> bigint\\nReturns the number of geometries in the collection.\\nIf the geometry is a collection of geometries (e.g., GEOMETRYCOLLECTION or MULTI\\\\*),\\nreturns the number of geometries,\\nfor single geometries returns 1,\\nfor empty geometries returns 0.\\n:::\\n\\n:::{function} ST_Geometries(Geometry) -> array(Geometry)\\nReturns an array of geometries in the specified collection. Returns a one-element array\\nif the input geometry is not a multi-geometry. Returns `NULL` if input geometry is empty.\\n:::\\n\\n:::{function} ST_NumPoints(Geometry) -> bigint\\nReturns the number of points in a geometry. This is an extension to the SQL/MM\\n`ST_NumPoints` function which only applies to point and linestring.\\n:::\\n\\n:::{function} ST_NumInteriorRing(Geometry) -> bigint\\nReturns the cardinality of the collection of interior rings of a polygon.\\n:::\\n\\n:::{function} line_interpolate_point(LineString, double) -> Geometry\\nReturns a Point interpolated along a LineString at the fraction given. The fraction\\nmust be between 0 and 1, inclusive.\\n:::\\n\\n:::{function} line_interpolate_points(LineString, double, repeated) -> array(Geometry)\\nReturns an array of Points interpolated along a LineString. The fraction must be\\nbetween 0 and 1, inclusive.\\n:::\\n\\n:::{function} line_locate_point(LineString, Point) -> double\\nReturns a float between 0 and 1 representing the location of the closest point on\\nthe LineString to the given Point, as a fraction of total 2d line length.\\n\\nReturns `NULL` if a LineString or a Point is empty or `NULL`.\\n:::\\n\\n:::{function} geometry_invalid_reason(Geometry) -> varchar\\nReturns the reason for why the input geometry is not valid.\\nReturns `NULL` if the input is valid.\\n:::\\n\\n:::{function} great_circle_distance(latitude1, longitude1, latitude2, longitude2) -> double\\nReturns the great-circle distance between two points on Earth's surface in kilometers.\\n:::\\n\\n:::{function} to_geojson_geometry(SphericalGeography) -> varchar\\nReturns the GeoJSON encoded defined by the input spherical geography.\\n:::\\n\\n:::{function} from_geojson_geometry(varchar) -> SphericalGeography\\nReturns the spherical geography type object from the GeoJSON representation stripping non geometry key/values.\\nFeature and FeatureCollection are not supported.\\n:::\", \"Aggregations\": \":::{function} convex_hull_agg(Geometry) -> Geometry\\nReturns the minimum convex geometry that encloses all input geometries.\\n:::\\n\\n:::{function} geometry_union_agg(Geometry) -> Geometry\\nReturns a geometry that represents the point set union of all input geometries.\\n:::\", \"Bing tiles\": \"These functions convert between geometries and\\n[Bing tiles](https://msdn.microsoft.com/library/bb259689.aspx).\\n\\n:::{function} bing_tile(x, y, zoom_level) -> BingTile\\nCreates a Bing tile object from XY coordinates and a zoom level.\\nZoom levels from 1 to 23 are supported.\\n:::\\n\\n:::{function} bing_tile(quadKey) -> BingTile\\n:noindex: true\\n\\nCreates a Bing tile object from a quadkey.\\n:::\\n\\n:::{function} bing_tile_at(latitude, longitude, zoom_level) -> BingTile\\nReturns a Bing tile at a given zoom level containing a point at a given latitude\\nand longitude. Latitude must be within `[-85.05112878, 85.05112878]` range.\\nLongitude must be within `[-180, 180]` range. Zoom levels from 1 to 23 are supported.\\n:::\\n\\n:::{function} bing_tiles_around(latitude, longitude, zoom_level) -> array(BingTile)\\nReturns a collection of Bing tiles that surround the point specified\\nby the latitude and longitude arguments at a given zoom level.\\n:::\\n\\n:::{function} bing_tiles_around(latitude, longitude, zoom_level, radius_in_km) -> array(BingTile)\\n:noindex: true\\n\\nReturns a minimum set of Bing tiles at specified zoom level that cover a circle of specified\\nradius in km around a specified (latitude, longitude) point.\\n:::\\n\\n:::{function} bing_tile_coordinates(tile) -> row<x, y>\\nReturns the XY coordinates of a given Bing tile.\\n:::\\n\\n:::{function} bing_tile_polygon(tile) -> Geometry\\nReturns the polygon representation of a given Bing tile.\\n:::\\n\\n:::{function} bing_tile_quadkey(tile) -> varchar\\nReturns the quadkey of a given Bing tile.\\n:::\\n\\n:::{function} bing_tile_zoom_level(tile) -> tinyint\\nReturns the zoom level of a given Bing tile.\\n:::\\n\\n:::{function} geometry_to_bing_tiles(geometry, zoom_level) -> array(BingTile)\\nReturns the minimum set of Bing tiles that fully covers a given geometry at\\na given zoom level. Zoom levels from 1 to 23 are supported.\\n:::\", \"Encoded polylines\": \"These functions convert between geometries and\\n[encoded polylines](https://developers.google.com/maps/documentation/utilities/polylinealgorithm).\\n\\n:::{function} to_encoded_polyline(Geometry) -> varchar\\nEncodes a linestring or multipoint to a polyline.\\n:::\\n\\n:::{function} from_encoded_polyline(varchar) -> Geometry\\nDecodes a polyline to a linestring.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 11]\"}, {\"title\": \"HyperLogLog functions\", \"description\": null, \"content\": {\"Data structures\": \"Trino implements HyperLogLog data sketches as a set of 32-bit buckets which\\nstore a *maximum hash*. They can be stored sparsely (as a map from bucket ID\\nto bucket), or densely (as a contiguous memory block). The HyperLogLog data\\nstructure starts as the sparse representation, switching to dense when it is\\nmore efficient. The P4HyperLogLog structure is initialized densely and\\nremains dense for its lifetime.\\n\\n{ref}`hyperloglog-type` implicitly casts to {ref}`p4hyperloglog-type`,\\nwhile one can explicitly cast `HyperLogLog` to `P4HyperLogLog`:\\n\\n```\\ncast(hll AS P4HyperLogLog)\\n```\", \"Serialization\": \"Data sketches can be serialized to and deserialized from `varbinary`. This\\nallows them to be stored for later use. Combined with the ability to merge\\nmultiple sketches, this allows one to calculate {func}`approx_distinct` of the\\nelements of a partition of a query, then for the entirety of a query with very\\nlittle cost.\\n\\nFor example, calculating the `HyperLogLog` for daily unique users will allow\\nweekly or monthly unique users to be calculated incrementally by combining the\\ndailies. This is similar to computing weekly revenue by summing daily revenue.\\nUses of {func}`approx_distinct` with `GROUPING SETS` can be converted to use\\n`HyperLogLog`. Examples:\\n\\n```\\nCREATE TABLE visit_summaries (\\n visit_date date,\\n hll varbinary\\n);\\n\\nINSERT INTO visit_summaries\\nSELECT visit_date, cast(approx_set(user_id) AS varbinary)\\nFROM user_visits\\nGROUP BY visit_date;\\n\\nSELECT cardinality(merge(cast(hll AS HyperLogLog))) AS weekly_unique_users\\nFROM visit_summaries\\nWHERE visit_date >= current_date - interval '7' day;\\n```\", \"Functions\": \":::{function} approx_set(x) -> HyperLogLog\\nReturns the `HyperLogLog` sketch of the input data set of `x`. This\\ndata sketch underlies {func}`approx_distinct` and can be stored and\\nused later by calling `cardinality()`.\\n:::\\n\\n:::{function} cardinality(hll) -> bigint\\n:noindex: true\\n\\nThis will perform {func}`approx_distinct` on the data summarized by the\\n`hll` HyperLogLog data sketch.\\n:::\\n\\n:::{function} empty_approx_set() -> HyperLogLog\\nReturns an empty `HyperLogLog`.\\n:::\\n\\n:::{function} merge(HyperLogLog) -> HyperLogLog\\nReturns the `HyperLogLog` of the aggregate union of the individual `hll`\\nHyperLogLog structures.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 12]\"}, {\"title\": \"Ipaddress\", \"description\": null, \"content\": {\"IP Address Functions\": \"(ip-address-contains)=\\n:::{function} contains(network, address) -> boolean\\n:noindex: true\\n\\nReturns true if the `address` exists in the CIDR `network`:\\n\\n```\\nSELECT contains('10.0.0.0/8', IPADDRESS '10.255.255.255'); -- true\\nSELECT contains('10.0.0.0/8', IPADDRESS '11.255.255.255'); -- false\\n\\nSELECT contains('2001:0db8:0:0:0:ff00:0042:8329/128', IPADDRESS '2001:0db8:0:0:0:ff00:0042:8329'); -- true\\nSELECT contains('2001:0db8:0:0:0:ff00:0042:8329/128', IPADDRESS '2001:0db8:0:0:0:ff00:0042:8328'); -- false\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 13]\"}, {\"title\": \"JSON functions and operators\", \"description\": null, \"content\": {\"JSON path language\": {\"JSON path syntax and semantics\": {\"literals\": [\"numeric literals\", \"They include exact and approximate numbers, and are interpreted as if they\\nwere SQL values.\"], \"variables\": [\"context variable\", \"It refers to the currently processed input of the JSON\\nfunction.\"], \"arithmetic binary expressions\": \"The JSON path language supports five arithmetic binary operators:\\n\\n```\\n<path1> + <path2>\\n<path1> - <path2>\\n<path1> * <path2>\\n<path1> / <path2>\\n<path1> % <path2>\\n```\\n\\nBoth operands, `<path1>` and `<path2>`, are evaluated to sequences of\\nitems. For arithmetic binary operators, each input sequence must contain a\\nsingle numeric item. The arithmetic operation is performed according to SQL\\nsemantics, and it returns a sequence containing a single element with the\\nresult.\\n\\nThe operators follow the same precedence rules as in SQL arithmetic operations,\\nand parentheses can be used for grouping.\", \"arithmetic unary expressions\": \"```\\n+ <path>\\n- <path>\\n```\\n\\nThe operand `<path>` is evaluated to a sequence of items. Every item must be\\na numeric value. The unary plus or minus is applied to every item in the\\nsequence, following SQL semantics, and the results form the returned sequence.\", \"member accessor\": \"The member accessor returns the value of the member with the specified key for\\neach JSON object in the input sequence.\\n\\n```\\n<path>.key\\n<path>.\\\"key\\\"\\n```\\n\\nThe condition when a JSON object does not have such a member is called a\\nstructural error. In the lax mode, it is suppressed, and the faulty object is\\nexcluded from the result.\\n\\nLet `<path>` return a sequence of three JSON objects:\\n\\n```\\n{\\\"customer\\\" : 100, \\\"region\\\" : \\\"AFRICA\\\"},\\n{\\\"region\\\" : \\\"ASIA\\\"},\\n{\\\"customer\\\" : 300, \\\"region\\\" : \\\"AFRICA\\\", \\\"comment\\\" : null}\\n```\\n\\nthe expression `<path>.customer` succeeds in the first and the third object,\\nbut the second object lacks the required member. In strict mode, path\\nevaluation fails. In lax mode, the second object is silently skipped, and the\\nresulting sequence is `100, 300`.\\n\\nAll items in the input sequence must be JSON objects.\\n\\n:::{note}\\nTrino does not support JSON objects with duplicate keys.\\n:::\", \"wildcard member accessor\": \"Returns values from all key-value pairs for each JSON object in the input\\nsequence. All the partial results are concatenated into the returned sequence.\\n\\n```\\n<path>.*\\n```\\n\\nLet `<path>` return a sequence of three JSON objects:\\n\\n```\\n{\\\"customer\\\" : 100, \\\"region\\\" : \\\"AFRICA\\\"},\\n{\\\"region\\\" : \\\"ASIA\\\"},\\n{\\\"customer\\\" : 300, \\\"region\\\" : \\\"AFRICA\\\", \\\"comment\\\" : null}\\n```\\n\\nThe results is:\\n\\n```\\n100, \\\"AFRICA\\\", \\\"ASIA\\\", 300, \\\"AFRICA\\\", null\\n```\\n\\nAll items in the input sequence must be JSON objects.\\n\\nThe order of values returned from a single JSON object is arbitrary. The\\nsub-sequences from all JSON objects are concatenated in the same order in which\\nthe JSON objects appear in the input sequence.\\n\\n(json-descendant-member-accessor)=\", \"descendant member accessor\": \"Returns the values associated with the specified key in all JSON objects on all\\nlevels of nesting in the input sequence.\\n\\n```\\n<path>..key\\n<path>..\\\"key\\\"\\n```\\n\\nThe order of returned values is that of preorder depth first search. First, the\\nenclosing object is visited, and then all child nodes are visited.\\n\\nThis method does not perform array unwrapping in the lax mode. The results\\nare the same in the lax and strict modes. The method traverses into JSON\\narrays and JSON objects. Non-structural JSON items are skipped.\\n\\nLet `<path>` be a sequence containing a JSON object:\\n\\n```\\n{\\n \\\"id\\\" : 1,\\n \\\"notes\\\" : [{\\\"type\\\" : 1, \\\"comment\\\" : \\\"foo\\\"}, {\\\"type\\\" : 2, \\\"comment\\\" : null}],\\n \\\"comment\\\" : [\\\"bar\\\", \\\"baz\\\"]\\n}\\n```\\n\\n```\\n<path>..comment --> [\\\"bar\\\", \\\"baz\\\"], \\\"foo\\\", null\\n```\", \"array accessor\": \"Returns the elements at the specified indexes for each JSON array in the input\\nsequence. Indexes are zero-based.\\n\\n```\\n<path>[ <subscripts> ]\\n```\\n\\nThe `<subscripts>` list contains one or more subscripts. Each subscript\\nspecifies a single index or a range (ends inclusive):\\n\\n```\\n<path>[<path1>, <path2> to <path3>, <path4>,...]\\n```\\n\\nIn lax mode, any non-array items resulting from the evaluation of the input\\nsequence are wrapped into single-element arrays. Note that this is an exception\\nto the rule of automatic array wrapping.\\n\\nEach array in the input sequence is processed in the following way:\\n\\n['The variable `last` is set to the last index of the array.', 'All subscript indexes are computed in order of declaration. For a\\\\nsingleton subscript `<path1>`, the result must be a singleton numeric item.\\\\nFor a range subscript `<path2> to <path3>`, two numeric items are expected.', 'The specified array elements are added in order to the output sequence.']\\n\\nLet `<path>` return a sequence of three JSON arrays:\\n\\n```\\n[0, 1, 2], [\\\"a\\\", \\\"b\\\", \\\"c\\\", \\\"d\\\"], [null, null]\\n```\\n\\nThe following expression returns a sequence containing the last element from\\nevery array:\\n\\n```\\n<path>[last] --> 2, \\\"d\\\", null\\n```\\n\\nThe following expression returns the third and fourth element from every array:\\n\\n```\\n<path>[2 to 3] --> 2, \\\"c\\\", \\\"d\\\"\\n```\\n\\nNote that the first array does not have the fourth element, and the last array\\ndoes not have the third or fourth element. Accessing non-existent elements is a\\nstructural error. In strict mode, it causes the path expression to fail. In lax\\nmode, such errors are suppressed, and only the existing elements are returned.\\n\\nAnother example of a structural error is an improper range specification such\\nas `5 to 3`.\\n\\nNote that the subscripts may overlap, and they do not need to follow the\\nelement order. The order in the returned sequence follows the subscripts:\\n\\n```\\n<path>[1, 0, 0] --> 1, 0, 0, \\\"b\\\", \\\"a\\\", \\\"a\\\", null, null, null\\n```\", \"wildcard array accessor\": \"Returns all elements of each JSON array in the input sequence.\\n\\n```\\n<path>[*]\\n```\\n\\nIn lax mode, any non-array items resulting from the evaluation of the input\\nsequence are wrapped into single-element arrays. Note that this is an exception\\nto the rule of automatic array wrapping.\\n\\nThe output order follows the order of the original JSON arrays. Also, the order\\nof elements within the arrays is preserved.\\n\\nLet `<path>` return a sequence of three JSON arrays:\\n\\n```\\n[0, 1, 2], [\\\"a\\\", \\\"b\\\", \\\"c\\\", \\\"d\\\"], [null, null]\\n<path>[*] --> 0, 1, 2, \\\"a\\\", \\\"b\\\", \\\"c\\\", \\\"d\\\", null, null\\n```\", \"filter\": {\"Comparison rules\": \"Null values in the context of comparison behave different than SQL null:\\n\\n['null == null --> `true`', 'null != null, null \\\\\\\\< null, ... --> `false`', 'null compared to a scalar value --> `false`', 'null compared to a JSON array or a JSON object --> `false`']\\n\\nWhen comparing two scalar values, `true` or `false` is returned if the\\ncomparison is successfully performed. The semantics of the comparison is the\\nsame as in SQL. In case of an error, e.g. comparing text and number,\\n`unknown` is returned.\\n\\nComparing a scalar value with a JSON array or a JSON object, and comparing JSON\\narrays/objects is an error, so `unknown` is returned.\", \"Examples of filter\": \"Let `<path>` return a sequence of three JSON objects:\\n\\n```\\n{\\\"customer\\\" : 100, \\\"region\\\" : \\\"AFRICA\\\"},\\n{\\\"region\\\" : \\\"ASIA\\\"},\\n{\\\"customer\\\" : 300, \\\"region\\\" : \\\"AFRICA\\\", \\\"comment\\\" : null}\\n```\\n\\n```\\n<path>?(@.region != \\\"ASIA\\\") --> {\\\"customer\\\" : 100, \\\"region\\\" : \\\"AFRICA\\\"},\\n {\\\"customer\\\" : 300, \\\"region\\\" : \\\"AFRICA\\\", \\\"comment\\\" : null}\\n<path>?(!exists(@.customer)) --> {\\\"region\\\" : \\\"ASIA\\\"}\\n```\\n\\nThe following accessors are collectively referred to as **item methods**.\"}, \"double()\": \"Converts numeric or text values into double values.\\n\\n```\\n<path>.double()\\n```\\n\\nLet `<path>` return a sequence `-1, 23e4, \\\"5.6\\\"`:\\n\\n```\\n<path>.double() --> -1e0, 23e4, 5.6e0\\n```\", \"ceiling(), floor(), and abs()\": \"Gets the ceiling, the floor or the absolute value for every numeric item in the\\nsequence. The semantics of the operations is the same as in SQL.\\n\\nLet `<path>` return a sequence `-1.5, -1, 1.3`:\\n\\n```\\n<path>.ceiling() --> -1.0, -1, 2.0\\n<path>.floor() --> -2.0, -1, 1.0\\n<path>.abs() --> 1.5, 1, 1.3\\n```\", \"keyvalue()\": \"Returns a collection of JSON objects including one object per every member of\\nthe original object for every JSON object in the sequence.\\n\\n```\\n<path>.keyvalue()\\n```\\n\\nThe returned objects have three members:\\n\\n['\\\"name\\\", which is the original key,', '\\\"value\\\", which is the original bound value,', '\\\"id\\\", which is the unique number, specific to an input object.']\\n\\nLet `<path>` be a sequence of three JSON objects:\\n\\n```\\n{\\\"customer\\\" : 100, \\\"region\\\" : \\\"AFRICA\\\"},\\n{\\\"region\\\" : \\\"ASIA\\\"},\\n{\\\"customer\\\" : 300, \\\"region\\\" : \\\"AFRICA\\\", \\\"comment\\\" : null}\\n```\\n\\n```\\n<path>.keyvalue() --> {\\\"name\\\" : \\\"customer\\\", \\\"value\\\" : 100, \\\"id\\\" : 0},\\n {\\\"name\\\" : \\\"region\\\", \\\"value\\\" : \\\"AFRICA\\\", \\\"id\\\" : 0},\\n {\\\"name\\\" : \\\"region\\\", \\\"value\\\" : \\\"ASIA\\\", \\\"id\\\" : 1},\\n {\\\"name\\\" : \\\"customer\\\", \\\"value\\\" : 300, \\\"id\\\" : 2},\\n {\\\"name\\\" : \\\"region\\\", \\\"value\\\" : \\\"AFRICA\\\", \\\"id\\\" : 2},\\n {\\\"name\\\" : \\\"comment\\\", \\\"value\\\" : null, \\\"id\\\" : 2}\\n```\\n\\nIt is required that all items in the input sequence are JSON objects.\\n\\nThe order of the returned values follows the order of the original JSON\\nobjects. However, within objects, the order of returned entries is arbitrary.\", \"type()\": \"Returns a textual value containing the type name for every item in the\\nsequence.\\n\\n```\\n<path>.type()\\n```\\n\\nThis method does not perform array unwrapping in the lax mode.\\n\\nThe returned values are:\\n\\n['`\\\"null\\\"` for JSON null,', '`\\\"number\\\"` for a numeric item,', '`\\\"string\\\"` for a textual item,', '`\\\"boolean\\\"` for a boolean item,', '`\\\"date\\\"` for an item of type date,', '`\\\"time without time zone\\\"` for an item of type time,', '`\\\"time with time zone\\\"` for an item of type time with time zone,', '`\\\"timestamp without time zone\\\"` for an item of type timestamp,', '`\\\"timestamp with time zone\\\"` for an item of type timestamp with time zone,', '`\\\"array\\\"` for JSON array,', '`\\\"object\\\"` for JSON object,']\", \"size()\": \"Returns a numeric value containing the size for every JSON array in the\\nsequence.\\n\\n```\\n<path>.size()\\n```\\n\\nThis method does not perform array unwrapping in the lax mode. Instead, all\\nnon-array items are wrapped in singleton JSON arrays, so their size is `1`.\\n\\nIt is required that all items in the input sequence are JSON arrays.\\n\\nLet `<path>` return a sequence of three JSON arrays:\\n\\n```\\n[0, 1, 2], [\\\"a\\\", \\\"b\\\", \\\"c\\\", \\\"d\\\"], [null, null]\\n<path>.size() --> 3, 4, 2\\n```\"}, \"Limitations\": \"The SQL standard describes the `datetime()` JSON path item method and the\\n`like_regex()` JSON path predicate. Trino does not support them.\\n\\n(json-path-modes)=\", \"JSON path modes\": {\"Examples of the lax mode behavior\": \"Let `<path>` return a sequence of three items, a JSON array, a JSON object,\\nand a scalar numeric value:\\n\\n```\\n[1, \\\"a\\\", null], {\\\"key1\\\" : 1.0, \\\"key2\\\" : true}, -2e3\\n```\\n\\nThe following example shows the wildcard array accessor in the lax mode. The\\nJSON array returns all its elements, while the JSON object and the number are\\nwrapped in singleton arrays and then unnested, so effectively they appear\\nunchanged in the output sequence:\\n\\n```\\n<path>[*] --> 1, \\\"a\\\", null, {\\\"key1\\\" : 1.0, \\\"key2\\\" : true}, -2e3\\n```\\n\\nWhen calling the `size()` method, the JSON object and the number are also\\nwrapped in singleton arrays:\\n\\n```\\n<path>.size() --> 3, 1, 1\\n```\\n\\nIn some cases, the lax mode cannot prevent failure. In the following example,\\neven though the JSON array is unwrapped prior to calling the `floor()`\\nmethod, the item `\\\"a\\\"` causes type mismatch.\\n\\n```\\n<path>.floor() --> ERROR\\n```\\n\\n(json-exists)=\"}}, \"json_exists\": {\"Examples\": \"Let `customers` be a table containing two columns: `id:bigint`,\\n`description:varchar`.\\n\\n| id | description |\\n| --- | ----------------------------------------------------- |\\n| 101 | '{\\\"comment\\\" : \\\"nice\\\", \\\"children\\\" : \\\\[10, 13, 16\\\\]}' |\\n| 102 | '{\\\"comment\\\" : \\\"problematic\\\", \\\"children\\\" : \\\\[8, 11\\\\]}' |\\n| 103 | '{\\\"comment\\\" : \\\"knows best\\\", \\\"children\\\" : \\\\[2\\\\]}' |\\n\\nThe following query checks which customers have children above the age of 10:\\n\\n```\\nSELECT\\n id,\\n json_exists(\\n description,\\n 'lax $.children[*]?(@ > 10)'\\n ) AS children_above_ten\\nFROM customers\\n```\\n\\n| id | children_above_ten |\\n| --- | ------------------ |\\n| 101 | true |\\n| 102 | true |\\n| 103 | false |\\n\\nIn the following query, the path mode is strict. We check the third child for\\neach customer. This should cause a structural error for the customers who do\\nnot have three or more children. This error is handled according to the `ON\\nERROR` clause.\\n\\n```\\nSELECT\\n id,\\n json_exists(\\n description,\\n 'strict $.children[2]?(@ > 10)'\\n UNKNOWN ON ERROR\\n ) AS child_3_above_ten\\nFROM customers\\n```\\n\\n| id | child_3_above_ten |\\n| --- | ----------------- |\\n| 101 | true |\\n| 102 | NULL |\\n| 103 | NULL |\\n\\n(json-query)=\"}, \"json_query\": {\"Examples\": \"Let `customers` be a table containing two columns: `id:bigint`,\\n`description:varchar`.\\n\\n| id | description |\\n| --- | ----------------------------------------------------- |\\n| 101 | '{\\\"comment\\\" : \\\"nice\\\", \\\"children\\\" : \\\\[10, 13, 16\\\\]}' |\\n| 102 | '{\\\"comment\\\" : \\\"problematic\\\", \\\"children\\\" : \\\\[8, 11\\\\]}' |\\n| 103 | '{\\\"comment\\\" : \\\"knows best\\\", \\\"children\\\" : \\\\[2\\\\]}' |\\n\\nThe following query gets the `children` array for each customer:\\n\\n```\\nSELECT\\n id,\\n json_query(\\n description,\\n 'lax $.children'\\n ) AS children\\nFROM customers\\n```\\n\\n| id | children |\\n| --- | -------------- |\\n| 101 | '\\\\[10,13,16\\\\]' |\\n| 102 | '\\\\[8,11\\\\]' |\\n| 103 | '\\\\[2\\\\]' |\\n\\nThe following query gets the collection of children for each customer.\\nNote that the `json_query` function can only output a single JSON item. If\\nyou don't use array wrapper, you get an error for every customer with multiple\\nchildren. The error is handled according to the `ON ERROR` clause.\\n\\n```\\nSELECT\\n id,\\n json_query(\\n description,\\n 'lax $.children[*]'\\n WITHOUT ARRAY WRAPPER\\n NULL ON ERROR\\n ) AS children\\nFROM customers\\n```\\n\\n| id | children |\\n| --- | -------- |\\n| 101 | NULL |\\n| 102 | NULL |\\n| 103 | '2' |\\n\\nThe following query gets the last child for each customer, wrapped in a JSON\\narray:\\n\\n```\\nSELECT\\n id,\\n json_query(\\n description,\\n 'lax $.children[last]'\\n WITH ARRAY WRAPPER\\n ) AS last_child\\nFROM customers\\n```\\n\\n| id | last_child |\\n| --- | ---------- |\\n| 101 | '\\\\[16\\\\]' |\\n| 102 | '\\\\[11\\\\]' |\\n| 103 | '\\\\[2\\\\]' |\\n\\nThe following query gets all children above the age of 12 for each customer,\\nwrapped in a JSON array. The second and the third customer don't have children\\nof this age. Such case is handled according to the `ON EMPTY` clause. The\\ndefault value returned `ON EMPTY` is `NULL`. In the following example,\\n`EMPTY ARRAY ON EMPTY` is specified.\\n\\n```\\nSELECT\\n id,\\n json_query(\\n description,\\n 'strict $.children[*]?(@ > 12)'\\n WITH ARRAY WRAPPER\\n EMPTY ARRAY ON EMPTY\\n ) AS children\\nFROM customers\\n```\\n\\n| id | children |\\n| --- | ----------- |\\n| 101 | '\\\\[13,16\\\\]' |\\n| 102 | '\\\\[\\\\]' |\\n| 103 | '\\\\[\\\\]' |\\n\\nThe following query shows the result of the `QUOTES` clause. Note that `KEEP\\nQUOTES` is the default.\\n\\n```\\nSELECT\\n id,\\n json_query(description, 'strict $.comment' KEEP QUOTES) AS quoted_comment,\\n json_query(description, 'strict $.comment' OMIT QUOTES) AS unquoted_comment\\nFROM customers\\n```\\n\\n| id | quoted_comment | unquoted_comment |\\n| --- | --------------- | ---------------- |\\n| 101 | '\\\"nice\\\"' | 'nice' |\\n| 102 | '\\\"problematic\\\"' | 'problematic' |\\n| 103 | '\\\"knows best\\\"' | 'knows best' |\\n\\nIf an error occurs, the returned value depends on the `ON ERROR` clause. The\\ndefault value returned `ON ERROR` is `NULL`. One example of error is\\nmultiple items returned by the path. Other errors caught and handled according\\nto the `ON ERROR` clause are:\\n\\n['Input conversion errors, such as malformed JSON', 'JSON path evaluation errors, e.g. division by zero', 'Output conversion errors']\\n\\n(json-value)=\"}, \"json_value\": {\"Examples\": \"Let `customers` be a table containing two columns: `id:bigint`,\\n`description:varchar`.\\n\\n| id | description |\\n| --- | ----------------------------------------------------- |\\n| 101 | '{\\\"comment\\\" : \\\"nice\\\", \\\"children\\\" : \\\\[10, 13, 16\\\\]}' |\\n| 102 | '{\\\"comment\\\" : \\\"problematic\\\", \\\"children\\\" : \\\\[8, 11\\\\]}' |\\n| 103 | '{\\\"comment\\\" : \\\"knows best\\\", \\\"children\\\" : \\\\[2\\\\]}' |\\n\\nThe following query gets the `comment` for each customer as `char(12)`:\\n\\n```\\nSELECT id, json_value(\\n description,\\n 'lax $.comment'\\n RETURNING char(12)\\n ) AS comment\\nFROM customers\\n```\\n\\n| id | comment |\\n| --- | -------------- |\\n| 101 | 'nice ' |\\n| 102 | 'problematic ' |\\n| 103 | 'knows best ' |\\n\\nThe following query gets the first child's age for each customer as\\n`tinyint`:\\n\\n```\\nSELECT id, json_value(\\n description,\\n 'lax $.children[0]'\\n RETURNING tinyint\\n ) AS child\\nFROM customers\\n```\\n\\n| id | child |\\n| --- | ----- |\\n| 101 | 10 |\\n| 102 | 8 |\\n| 103 | 2 |\\n\\nThe following query gets the third child's age for each customer. In the strict\\nmode, this should cause a structural error for the customers who do not have\\nthe third child. This error is handled according to the `ON ERROR` clause.\\n\\n```\\nSELECT id, json_value(\\n description,\\n 'strict $.children[2]'\\n DEFAULT 'err' ON ERROR\\n ) AS child\\nFROM customers\\n```\\n\\n| id | child |\\n| --- | ----- |\\n| 101 | '16' |\\n| 102 | 'err' |\\n| 103 | 'err' |\\n\\nAfter changing the mode to lax, the structural error is suppressed, and the\\ncustomers without a third child produce empty sequence. This case is handled\\naccording to the `ON EMPTY` clause.\\n\\n```\\nSELECT id, json_value(\\n description,\\n 'lax $.children[2]'\\n DEFAULT 'missing' ON EMPTY\\n ) AS child\\nFROM customers\\n```\\n\\n| id | child |\\n| --- | --------- |\\n| 101 | '16' |\\n| 102 | 'missing' |\\n| 103 | 'missing' |\\n\\n(json-table)=\"}, \"json_table\": {\"Examples\": \"The following query uses `json_table` to extract values from a JSON array and\\nreturn them as rows in a table with three columns:\\n\\n```\\nSELECT\\n *\\nFROM\\n json_table(\\n '[\\n {\\\"id\\\":1,\\\"name\\\":\\\"Africa\\\",\\\"wikiDataId\\\":\\\"Q15\\\"},\\n {\\\"id\\\":2,\\\"name\\\":\\\"Americas\\\",\\\"wikiDataId\\\":\\\"Q828\\\"},\\n {\\\"id\\\":3,\\\"name\\\":\\\"Asia\\\",\\\"wikiDataId\\\":\\\"Q48\\\"},\\n {\\\"id\\\":4,\\\"name\\\":\\\"Europe\\\",\\\"wikiDataId\\\":\\\"Q51\\\"}\\n ]',\\n 'strict $' COLUMNS (\\n NESTED PATH 'strict $[*]' COLUMNS (\\n id integer PATH 'strict $.id',\\n name varchar PATH 'strict $.name',\\n wiki_data_id varchar PATH 'strict $.\\\"wikiDataId\\\"'\\n )\\n )\\n );\\n```\\n\\n| id | child | wiki_data_id |\\n| -- | --------- | ------------- |\\n| 1 | Africa | Q1 |\\n| 2 | Americas | Q828 |\\n| 3 | Asia | Q48 |\\n| 4 | Europe | Q51 |\\n\\nThe following query uses `json_table` to extract values from an array of nested\\nJSON objects. It flattens the nested JSON data into a single table. The example\\nquery processes an array of continent names, where each continent contains an\\narray of countries and their populations.\\n\\nThe `NESTED PATH 'lax $[*]'` clause iterates through the continent objects,\\nwhile the `NESTED PATH 'lax $.countries[*]'` iterates through each country\\nwithin each continent. This creates a flat table structure with four rows\\ncombining each continent with each of its countries. Continent values repeat for\\neach of their countries.\\n\\n```\\nSELECT\\n *\\nFROM\\n json_table(\\n '[\\n {\\\"continent\\\": \\\"Asia\\\", \\\"countries\\\": [\\n {\\\"name\\\": \\\"Japan\\\", \\\"population\\\": 125.7},\\n {\\\"name\\\": \\\"Thailand\\\", \\\"population\\\": 71.6}\\n ]},\\n {\\\"continent\\\": \\\"Europe\\\", \\\"countries\\\": [\\n {\\\"name\\\": \\\"France\\\", \\\"population\\\": 67.4},\\n {\\\"name\\\": \\\"Germany\\\", \\\"population\\\": 83.2}\\n ]}\\n ]',\\n 'lax $' COLUMNS (\\n NESTED PATH 'lax $[*]' COLUMNS (\\n continent varchar PATH 'lax $.continent',\\n NESTED PATH 'lax $.countries[*]' COLUMNS (\\n country varchar PATH 'lax $.name',\\n population double PATH 'lax $.population'\\n )\\n )\\n ));\\n```\\n\\n| continent | country | population |\\n| ---------- | --------- | ------------- |\\n| Asia | Japan | 125.7 |\\n| Asia | Thailand | 71.6 |\\n| Europe | France | 67.4 |\\n| Europe | Germany | 83.2 |\\n\\nThe following query uses `PLAN` to specify an `OUTER` join between a parent path\\nand a child path:\\n\\n```\\nSELECT\\n *\\nFROM\\n JSON_TABLE(\\n '[]',\\n 'lax $' AS \\\"root_path\\\"\\n COLUMNS(\\n a varchar(1) PATH 'lax \\\"A\\\"',\\n NESTED PATH 'lax $[*]' AS \\\"nested_path\\\"\\n COLUMNS (b varchar(1) PATH 'lax \\\"B\\\"'))\\n PLAN (\\\"root_path\\\" OUTER \\\"nested_path\\\")\\n );\\n```\\n\\n| a | b |\\n| ---- | ---- |\\n| A | null |\\n\\nThe following query uses `PLAN` to specify an `INNER` join between a parent path\\nand a child path:\\n\\n```\\nSELECT\\n *\\nFROM\\n JSON_TABLE(\\n '[]',\\n 'lax $' AS \\\"root_path\\\"\\n COLUMNS(\\n a varchar(1) PATH 'lax \\\"A\\\"',\\n NESTED PATH 'lax $[*]' AS \\\"nested_path\\\"\\n COLUMNS (b varchar(1) PATH 'lax \\\"B\\\"'))\\n PLAN (\\\"root_path\\\" INNER \\\"nested_path\\\")\\n );\\n```\\n\\n| a | b |\\n| ---- | ---- |\\n| null | null |\\n\\n(json-array)=\"}, \"json_array\": {\"Argument types\": \"The array elements can be arbitrary expressions. Each passed value is converted\\ninto a JSON item according to its type, and optional `FORMAT` and\\n`ENCODING` specification.\\n\\nYou can pass SQL values of types boolean, numeric, and character string. They\\nare converted to corresponding JSON literals:\\n\\n```\\nSELECT json_array(true, 12e-1, 'text')\\n--> '[true,1.2,\\\"text\\\"]'\\n```\\n\\nAdditionally to SQL values, you can pass JSON values. They are character or\\nbinary strings with a specified format and optional encoding:\\n\\n```\\nSELECT json_array(\\n '[ \\\"text\\\" ] ' FORMAT JSON,\\n X'5B0035005D00' FORMAT JSON ENCODING UTF16\\n )\\n--> '[[\\\"text\\\"],[5]]'\\n```\\n\\nYou can also nest other JSON-returning functions. In that case, the `FORMAT`\\noption is implicit:\\n\\n```\\nSELECT json_array(\\n json_query('{\\\"key\\\" : [ \\\"value\\\" ]}', 'lax $.key')\\n )\\n--> '[[\\\"value\\\"]]'\\n```\\n\\nOther passed values are cast to varchar, and they become JSON text literals:\\n\\n```\\nSELECT json_array(\\n DATE '2001-01-31',\\n UUID '12151fd2-7586-11e9-8f9e-2a86e4085a59'\\n )\\n--> '[\\\"2001-01-31\\\",\\\"12151fd2-7586-11e9-8f9e-2a86e4085a59\\\"]'\\n```\\n\\nYou can omit the arguments altogether to get an empty array:\\n\\n```\\nSELECT json_array() --> '[]'\\n```\", \"Null handling\": \"If a value passed for an array element is `null`, it is treated according to\\nthe specified null treatment option. If `ABSENT ON NULL` is specified, the\\nnull element is omitted in the result. If `NULL ON NULL` is specified, JSON\\n`null` is added to the result. `ABSENT ON NULL` is the default\\nconfiguration:\\n\\n```\\nSELECT json_array(true, null, 1)\\n--> '[true,1]'\\n\\nSELECT json_array(true, null, 1 ABSENT ON NULL)\\n--> '[true,1]'\\n\\nSELECT json_array(true, null, 1 NULL ON NULL)\\n--> '[true,null,1]'\\n```\", \"Returned type\": \"The SQL standard imposes that there is no dedicated data type to represent JSON\\ndata in SQL. Instead, JSON data is represented as character or binary strings.\\nBy default, the `json_array` function returns varchar containing the textual\\nrepresentation of the JSON array. With the `RETURNING` clause, you can\\nspecify other character string type:\\n\\n```\\nSELECT json_array(true, 1 RETURNING VARCHAR(100))\\n--> '[true,1]'\\n```\\n\\nYou can also specify to use varbinary and the required encoding as return type.\\nThe default encoding is UTF8:\\n\\n```\\nSELECT json_array(true, 1 RETURNING VARBINARY)\\n--> X'5b 74 72 75 65 2c 31 5d'\\n\\nSELECT json_array(true, 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF8)\\n--> X'5b 74 72 75 65 2c 31 5d'\\n\\nSELECT json_array(true, 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF16)\\n--> X'5b 00 74 00 72 00 75 00 65 00 2c 00 31 00 5d 00'\\n\\nSELECT json_array(true, 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF32)\\n--> X'5b 00 00 00 74 00 00 00 72 00 00 00 75 00 00 00 65 00 00 00 2c 00 00 00 31 00 00 00 5d 00 00 00'\\n```\\n\\n(json-object)=\"}, \"json_object\": {\"Argument passing conventions\": \"There are two conventions for passing keys and values:\\n\\n```\\nSELECT json_object('key1' : 1, 'key2' : true)\\n--> '{\\\"key1\\\":1,\\\"key2\\\":true}'\\n\\nSELECT json_object(KEY 'key1' VALUE 1, KEY 'key2' VALUE true)\\n--> '{\\\"key1\\\":1,\\\"key2\\\":true}'\\n```\\n\\nIn the second convention, you can omit the `KEY` keyword:\\n\\n```\\nSELECT json_object('key1' VALUE 1, 'key2' VALUE true)\\n--> '{\\\"key1\\\":1,\\\"key2\\\":true}'\\n```\", \"Argument types\": \"The keys can be arbitrary expressions. They must be of character string type.\\nEach key is converted into a JSON text item, and it becomes a key in the\\ncreated JSON object. Keys must not be null.\\n\\nThe values can be arbitrary expressions. Each passed value is converted\\ninto a JSON item according to its type, and optional `FORMAT` and\\n`ENCODING` specification.\\n\\nYou can pass SQL values of types boolean, numeric, and character string. They\\nare converted to corresponding JSON literals:\\n\\n```\\nSELECT json_object('x' : true, 'y' : 12e-1, 'z' : 'text')\\n--> '{\\\"x\\\":true,\\\"y\\\":1.2,\\\"z\\\":\\\"text\\\"}'\\n```\\n\\nAdditionally to SQL values, you can pass JSON values. They are character or\\nbinary strings with a specified format and optional encoding:\\n\\n```\\nSELECT json_object(\\n 'x' : '[ \\\"text\\\" ] ' FORMAT JSON,\\n 'y' : X'5B0035005D00' FORMAT JSON ENCODING UTF16\\n )\\n--> '{\\\"x\\\":[\\\"text\\\"],\\\"y\\\":[5]}'\\n```\\n\\nYou can also nest other JSON-returning functions. In that case, the `FORMAT`\\noption is implicit:\\n\\n```\\nSELECT json_object(\\n 'x' : json_query('{\\\"key\\\" : [ \\\"value\\\" ]}', 'lax $.key')\\n )\\n--> '{\\\"x\\\":[\\\"value\\\"]}'\\n```\\n\\nOther passed values are cast to varchar, and they become JSON text literals:\\n\\n```\\nSELECT json_object(\\n 'x' : DATE '2001-01-31',\\n 'y' : UUID '12151fd2-7586-11e9-8f9e-2a86e4085a59'\\n )\\n--> '{\\\"x\\\":\\\"2001-01-31\\\",\\\"y\\\":\\\"12151fd2-7586-11e9-8f9e-2a86e4085a59\\\"}'\\n```\\n\\nYou can omit the arguments altogether to get an empty object:\\n\\n```\\nSELECT json_object() --> '{}'\\n```\", \"Null handling\": \"The values passed for JSON object keys must not be null. It is allowed to pass\\n`null` for JSON object values. A null value is treated according to the\\nspecified null treatment option. If `NULL ON NULL` is specified, a JSON\\nobject entry with `null` value is added to the result. If `ABSENT ON NULL`\\nis specified, the entry is omitted in the result. `NULL ON NULL` is the\\ndefault configuration.:\\n\\n```\\nSELECT json_object('x' : null, 'y' : 1)\\n--> '{\\\"x\\\":null,\\\"y\\\":1}'\\n\\nSELECT json_object('x' : null, 'y' : 1 NULL ON NULL)\\n--> '{\\\"x\\\":null,\\\"y\\\":1}'\\n\\nSELECT json_object('x' : null, 'y' : 1 ABSENT ON NULL)\\n--> '{\\\"y\\\":1}'\\n```\", \"Key uniqueness\": \"If a duplicate key is encountered, it is handled according to the specified key\\nuniqueness constraint.\\n\\nIf `WITH UNIQUE KEYS` is specified, a duplicate key results in a query\\nfailure:\\n\\n```\\nSELECT json_object('x' : null, 'x' : 1 WITH UNIQUE KEYS)\\n--> failure: \\\"duplicate key passed to JSON_OBJECT function\\\"\\n```\\n\\nNote that this option is not supported if any of the arguments has a\\n`FORMAT` specification.\\n\\nIf `WITHOUT UNIQUE KEYS` is specified, duplicate keys are not supported due\\nto implementation limitation. `WITHOUT UNIQUE KEYS` is the default\\nconfiguration.\", \"Returned type\": \"The SQL standard imposes that there is no dedicated data type to represent JSON\\ndata in SQL. Instead, JSON data is represented as character or binary strings.\\nBy default, the `json_object` function returns varchar containing the textual\\nrepresentation of the JSON object. With the `RETURNING` clause, you can\\nspecify other character string type:\\n\\n```\\nSELECT json_object('x' : 1 RETURNING VARCHAR(100))\\n--> '{\\\"x\\\":1}'\\n```\\n\\nYou can also specify to use varbinary and the required encoding as return type.\\nThe default encoding is UTF8:\\n\\n```\\nSELECT json_object('x' : 1 RETURNING VARBINARY)\\n--> X'7b 22 78 22 3a 31 7d'\\n\\nSELECT json_object('x' : 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF8)\\n--> X'7b 22 78 22 3a 31 7d'\\n\\nSELECT json_object('x' : 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF16)\\n--> X'7b 00 22 00 78 00 22 00 3a 00 31 00 7d 00'\\n\\nSELECT json_object('x' : 1 RETURNING VARBINARY FORMAT JSON ENCODING UTF32)\\n--> X'7b 00 00 00 22 00 00 00 78 00 00 00 22 00 00 00 3a 00 00 00 31 00 00 00 7d 00 00 00'\\n```\\n\\n:::{warning}\\nThe following functions and operators are not compliant with the SQL\\nstandard, and should be considered deprecated. According to the SQL\\nstandard, there shall be no `JSON` data type. Instead, JSON values\\nshould be represented as string values. The remaining functionality of the\\nfollowing functions is covered by the functions described previously.\\n:::\"}, \"Cast to JSON\": \"The following types can be cast to JSON:\\n\\n['`BOOLEAN`', '`TINYINT`', '`SMALLINT`', '`INTEGER`', '`BIGINT`', '`REAL`', '`DOUBLE`', '`VARCHAR`']\\n\\nAdditionally, `ARRAY`, `MAP`, and `ROW` types can be cast to JSON when\\nthe following requirements are met:\\n\\n['`ARRAY` types can be cast when the element type of the array is one\\\\nof the supported types.', '`MAP` types can be cast when the key type of the map is `VARCHAR` and\\\\nthe value type of the map is a supported type,', '`ROW` types can be cast when every field type of the row is a supported\\\\ntype.']\\n\\n:::{note}\\nCast operations with supported {ref}`character string types\\n<string-data-types>` treat the input as a string, not validated as JSON.\\nThis means that a cast operation with a string-type input of invalid JSON\\nresults in a successful cast to invalid JSON.\\n\\nInstead, consider using the {func}`json_parse` function to\\ncreate validated JSON from a string.\\n:::\\n\\nThe following examples show the behavior of casting to JSON with these types:\\n\\n```\\nSELECT CAST(NULL AS JSON);\\n-- NULL\\n\\nSELECT CAST(1 AS JSON);\\n-- JSON '1'\\n\\nSELECT CAST(9223372036854775807 AS JSON);\\n-- JSON '9223372036854775807'\\n\\nSELECT CAST('abc' AS JSON);\\n-- JSON '\\\"abc\\\"'\\n\\nSELECT CAST(true AS JSON);\\n-- JSON 'true'\\n\\nSELECT CAST(1.234 AS JSON);\\n-- JSON '1.234'\\n\\nSELECT CAST(ARRAY[1, 23, 456] AS JSON);\\n-- JSON '[1,23,456]'\\n\\nSELECT CAST(ARRAY[1, NULL, 456] AS JSON);\\n-- JSON '[1,null,456]'\\n\\nSELECT CAST(ARRAY[ARRAY[1, 23], ARRAY[456]] AS JSON);\\n-- JSON '[[1,23],[456]]'\\n\\nSELECT CAST(MAP(ARRAY['k1', 'k2', 'k3'], ARRAY[1, 23, 456]) AS JSON);\\n-- JSON '{\\\"k1\\\":1,\\\"k2\\\":23,\\\"k3\\\":456}'\\n\\nSELECT CAST(CAST(ROW(123, 'abc', true) AS\\n ROW(v1 BIGINT, v2 VARCHAR, v3 BOOLEAN)) AS JSON);\\n-- JSON '{\\\"v1\\\":123,\\\"v2\\\":\\\"abc\\\",\\\"v3\\\":true}'\\n```\\n\\nCasting from NULL to `JSON` is not straightforward. Casting\\nfrom a standalone `NULL` will produce SQL `NULL` instead of\\n`JSON 'null'`. However, when casting from arrays or map containing\\n`NULL`s, the produced `JSON` will have `null`s in it.\", \"Cast from JSON\": \"Casting to `BOOLEAN`, `TINYINT`, `SMALLINT`, `INTEGER`,\\n`BIGINT`, `REAL`, `DOUBLE` or `VARCHAR` is supported.\\nCasting to `ARRAY` and `MAP` is supported when the element type of\\nthe array is one of the supported types, or when the key type of the map\\nis `VARCHAR` and value type of the map is one of the supported types.\\nBehaviors of the casts are shown with the examples below:\\n\\n```\\nSELECT CAST(JSON 'null' AS VARCHAR);\\n-- NULL\\n\\nSELECT CAST(JSON '1' AS INTEGER);\\n-- 1\\n\\nSELECT CAST(JSON '9223372036854775807' AS BIGINT);\\n-- 9223372036854775807\\n\\nSELECT CAST(JSON '\\\"abc\\\"' AS VARCHAR);\\n-- abc\\n\\nSELECT CAST(JSON 'true' AS BOOLEAN);\\n-- true\\n\\nSELECT CAST(JSON '1.234' AS DOUBLE);\\n-- 1.234\\n\\nSELECT CAST(JSON '[1,23,456]' AS ARRAY(INTEGER));\\n-- [1, 23, 456]\\n\\nSELECT CAST(JSON '[1,null,456]' AS ARRAY(INTEGER));\\n-- [1, NULL, 456]\\n\\nSELECT CAST(JSON '[[1,23],[456]]' AS ARRAY(ARRAY(INTEGER)));\\n-- [[1, 23], [456]]\\n\\nSELECT CAST(JSON '{\\\"k1\\\":1,\\\"k2\\\":23,\\\"k3\\\":456}' AS MAP(VARCHAR, INTEGER));\\n-- {k1=1, k2=23, k3=456}\\n\\nSELECT CAST(JSON '{\\\"v1\\\":123,\\\"v2\\\":\\\"abc\\\",\\\"v3\\\":true}' AS\\n ROW(v1 BIGINT, v2 VARCHAR, v3 BOOLEAN));\\n-- {v1=123, v2=abc, v3=true}\\n\\nSELECT CAST(JSON '[123,\\\"abc\\\",true]' AS\\n ROW(v1 BIGINT, v2 VARCHAR, v3 BOOLEAN));\\n-- {v1=123, v2=abc, v3=true}\\n```\\n\\nJSON arrays can have mixed element types and JSON maps can have mixed\\nvalue types. This makes it impossible to cast them to SQL arrays and maps in\\nsome cases. To address this, Trino supports partial casting of arrays and maps:\\n\\n```\\nSELECT CAST(JSON '[[1, 23], 456]' AS ARRAY(JSON));\\n-- [JSON '[1,23]', JSON '456']\\n\\nSELECT CAST(JSON '{\\\"k1\\\": [1, 23], \\\"k2\\\": 456}' AS MAP(VARCHAR, JSON));\\n-- {k1 = JSON '[1,23]', k2 = JSON '456'}\\n\\nSELECT CAST(JSON '[null]' AS ARRAY(JSON));\\n-- [JSON 'null']\\n```\\n\\nWhen casting from `JSON` to `ROW`, both JSON array and JSON object are supported.\", \"Other JSON functions\": \"In addition to the functions explained in more details in the preceding\\nsections, the following functions are available:\\n\\n:::{function} is_json_scalar(json) -> boolean\\nDetermine if `json` is a scalar (i.e. a JSON number, a JSON string, `true`, `false` or `null`):\\n\\n```\\nSELECT is_json_scalar('1'); -- true\\nSELECT is_json_scalar('[1, 2, 3]'); -- false\\n```\\n\\n:::\\n\\n:::{function} json_array_contains(json, value) -> boolean\\nDetermine if `value` exists in `json` (a string containing a JSON array):\\n\\n```\\nSELECT json_array_contains('[1, 2, 3]', 2); -- true\\n```\\n\\n:::\\n\\n::::{function} json_array_get(json_array, index) -> json\\n\\n:::{warning}\\nThe semantics of this function are broken. If the extracted element\\nis a string, it will be converted into an invalid `JSON` value that\\nis not properly quoted (the value will not be surrounded by quotes\\nand any interior quotes will not be escaped).\\n\\nWe recommend against using this function. It cannot be fixed without\\nimpacting existing usages and may be removed in a future release.\\n:::\\n\\nReturns the element at the specified index into the `json_array`.\\nThe index is zero-based:\\n\\n```\\nSELECT json_array_get('[\\\"a\\\", [3, 9], \\\"c\\\"]', 0); -- JSON 'a' (invalid JSON)\\nSELECT json_array_get('[\\\"a\\\", [3, 9], \\\"c\\\"]', 1); -- JSON '[3,9]'\\n```\\n\\nThis function also supports negative indexes for fetching element indexed\\nfrom the end of an array:\\n\\n```\\nSELECT json_array_get('[\\\"c\\\", [3, 9], \\\"a\\\"]', -1); -- JSON 'a' (invalid JSON)\\nSELECT json_array_get('[\\\"c\\\", [3, 9], \\\"a\\\"]', -2); -- JSON '[3,9]'\\n```\\n\\nIf the element at the specified index doesn't exist, the function returns null:\\n\\n```\\nSELECT json_array_get('[]', 0); -- NULL\\nSELECT json_array_get('[\\\"a\\\", \\\"b\\\", \\\"c\\\"]', 10); -- NULL\\nSELECT json_array_get('[\\\"c\\\", \\\"b\\\", \\\"a\\\"]', -10); -- NULL\\n```\\n\\n::::\\n\\n:::{function} json_array_length(json) -> bigint\\nReturns the array length of `json` (a string containing a JSON array):\\n\\n```\\nSELECT json_array_length('[1, 2, 3]'); -- 3\\n```\\n\\n:::\\n\\n:::{function} json_extract(json, json_path) -> json\\nEvaluates the [JSONPath]-like expression `json_path` on `json`\\n(a string containing JSON) and returns the result as a JSON string:\\n\\n```\\nSELECT json_extract(json, '$.store.book');\\nSELECT json_extract(json, '$.store[book]');\\nSELECT json_extract(json, '$.store[\\\"book name\\\"]');\\n```\\n\\nThe {ref}`json_query function<json-query>` provides a more powerful and\\nfeature-rich alternative to parse and extract JSON data.\\n:::\\n\\n:::{function} json_extract_scalar(json, json_path) -> varchar\\nLike {func}`json_extract`, but returns the result value as a string (as opposed\\nto being encoded as JSON). The value referenced by `json_path` must be a\\nscalar (boolean, number or string).\\n\\n```\\nSELECT json_extract_scalar('[1, 2, 3]', '$[2]');\\nSELECT json_extract_scalar(json, '$.store.book[0].author');\\n```\\n\\n:::\\n\\n::::{function} json_format(json) -> varchar\\nReturns the JSON text serialized from the input JSON value.\\nThis is inverse function to {func}`json_parse`.\\n\\n```\\nSELECT json_format(JSON '[1, 2, 3]'); -- '[1,2,3]'\\nSELECT json_format(JSON '\\\"a\\\"'); -- '\\\"a\\\"'\\n```\\n\\n:::{note}\\n{func}`json_format` and `CAST(json AS VARCHAR)` have completely\\ndifferent semantics.\\n\\n{func}`json_format` serializes the input JSON value to JSON text conforming to\\n{rfc}`7159`. The JSON value can be a JSON object, a JSON array, a JSON string,\\na JSON number, `true`, `false` or `null`.\\n\\n```\\nSELECT json_format(JSON '{\\\"a\\\": 1, \\\"b\\\": 2}'); -- '{\\\"a\\\":1,\\\"b\\\":2}'\\nSELECT json_format(JSON '[1, 2, 3]'); -- '[1,2,3]'\\nSELECT json_format(JSON '\\\"abc\\\"'); -- '\\\"abc\\\"'\\nSELECT json_format(JSON '42'); -- '42'\\nSELECT json_format(JSON 'true'); -- 'true'\\nSELECT json_format(JSON 'null'); -- 'null'\\n```\\n\\n`CAST(json AS VARCHAR)` casts the JSON value to the corresponding SQL VARCHAR value.\\nFor JSON string, JSON number, `true`, `false` or `null`, the cast\\nbehavior is same as the corresponding SQL type. JSON object and JSON array\\ncannot be cast to VARCHAR.\\n\\n```\\nSELECT CAST(JSON '{\\\"a\\\": 1, \\\"b\\\": 2}' AS VARCHAR); -- ERROR!\\nSELECT CAST(JSON '[1, 2, 3]' AS VARCHAR); -- ERROR!\\nSELECT CAST(JSON '\\\"abc\\\"' AS VARCHAR); -- 'abc' (the double quote is gone)\\nSELECT CAST(JSON '42' AS VARCHAR); -- '42'\\nSELECT CAST(JSON 'true' AS VARCHAR); -- 'true'\\nSELECT CAST(JSON 'null' AS VARCHAR); -- NULL\\n```\\n\\n:::\\n::::\\n\\n::::{function} json_parse(string) -> json\\nReturns the JSON value deserialized from the input JSON text.\\nThis is inverse function to {func}`json_format`:\\n\\n```\\nSELECT json_parse('[1, 2, 3]'); -- JSON '[1,2,3]'\\nSELECT json_parse('\\\"abc\\\"'); -- JSON '\\\"abc\\\"'\\n```\\n\\n:::{note}\\n{func}`json_parse` and `CAST(string AS JSON)` have completely\\ndifferent semantics.\\n\\n{func}`json_parse` expects a JSON text conforming to {rfc}`7159`, and returns\\nthe JSON value deserialized from the JSON text.\\nThe JSON value can be a JSON object, a JSON array, a JSON string, a JSON number,\\n`true`, `false` or `null`.\\n\\n```\\nSELECT json_parse('not_json'); -- ERROR!\\nSELECT json_parse('[\\\"a\\\": 1, \\\"b\\\": 2]'); -- JSON '[\\\"a\\\": 1, \\\"b\\\": 2]'\\nSELECT json_parse('[1, 2, 3]'); -- JSON '[1,2,3]'\\nSELECT json_parse('\\\"abc\\\"'); -- JSON '\\\"abc\\\"'\\nSELECT json_parse('42'); -- JSON '42'\\nSELECT json_parse('true'); -- JSON 'true'\\nSELECT json_parse('null'); -- JSON 'null'\\n```\\n\\n`CAST(string AS JSON)` takes any VARCHAR value as input, and returns\\na JSON string with its value set to input string.\\n\\n```\\nSELECT CAST('not_json' AS JSON); -- JSON '\\\"not_json\\\"'\\nSELECT CAST('[\\\"a\\\": 1, \\\"b\\\": 2]' AS JSON); -- JSON '\\\"[\\\\\\\"a\\\\\\\": 1, \\\\\\\"b\\\\\\\": 2]\\\"'\\nSELECT CAST('[1, 2, 3]' AS JSON); -- JSON '\\\"[1, 2, 3]\\\"'\\nSELECT CAST('\\\"abc\\\"' AS JSON); -- JSON '\\\"\\\\\\\"abc\\\\\\\"\\\"'\\nSELECT CAST('42' AS JSON); -- JSON '\\\"42\\\"'\\nSELECT CAST('true' AS JSON); -- JSON '\\\"true\\\"'\\nSELECT CAST('null' AS JSON); -- JSON '\\\"null\\\"'\\n```\\n\\n:::\\n::::\\n\\n:::{function} json_size(json, json_path) -> bigint\\nLike {func}`json_extract`, but returns the size of the value.\\nFor objects or arrays, the size is the number of members,\\nand the size of a scalar value is zero.\\n\\n```\\nSELECT json_size('{\\\"x\\\": {\\\"a\\\": 1, \\\"b\\\": 2}}', '$.x'); -- 2\\nSELECT json_size('{\\\"x\\\": [1, 2, 3]}', '$.x'); -- 3\\nSELECT json_size('{\\\"x\\\": {\\\"a\\\": 1, \\\"b\\\": 2}}', '$.x.a'); -- 0\\n```\\n\\n:::\\n\\n[jsonpath]: http://goessner.net/articles/JsonPath/\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 14]\"}, {\"title\": \"Lambda expressions\", \"description\": null, \"content\": {\"Limitations\": \"Most SQL expressions can be used in a lambda body, with a few exceptions:\\n\\n['Subqueries are not supported: `x -> 2 + (SELECT 3)`', 'Aggregations are not supported: `x -> max(y)`']\", \"Examples\": \"Obtain the squared elements of an array column with {func}`transform`:\\n\\n```\\nSELECT numbers,\\n transform(numbers, n -> n * n) as squared_numbers\\nFROM (\\n VALUES\\n (ARRAY[1, 2]),\\n (ARRAY[3, 4]),\\n (ARRAY[5, 6, 7])\\n) AS t(numbers);\\n```\\n\\n```\\n numbers | squared_numbers\\n-----------+-----------------\\n [1, 2] | [1, 4]\\n [3, 4] | [9, 16]\\n [5, 6, 7] | [25, 36, 49]\\n(3 rows)\\n```\\n\\nThe function {func}`transform` can be also employed to safely cast the elements\\nof an array to strings:\\n\\n```\\nSELECT transform(prices, n -> TRY_CAST(n AS VARCHAR) || '$') as price_tags\\nFROM (\\n VALUES\\n (ARRAY[100, 200]),\\n (ARRAY[30, 4])\\n) AS t(prices);\\n```\\n\\n```\\n price_tags\\n--------------\\n [100$, 200$]\\n [30$, 4$]\\n(2 rows)\\n```\\n\\nBesides the array column being manipulated,\\nother columns can be captured as well within the lambda expression.\\nThe following statement provides a showcase of this feature\\nfor calculating the value of the linear function `f(x) = ax + b`\\nwith {func}`transform`:\\n\\n```\\nSELECT xvalues,\\n a,\\n b,\\n transform(xvalues, x -> a * x + b) as linear_function_values\\nFROM (\\n VALUES\\n (ARRAY[1, 2], 10, 5),\\n (ARRAY[3, 4], 4, 2)\\n) AS t(xvalues, a, b);\\n```\\n\\n```\\n xvalues | a | b | linear_function_values\\n---------+----+---+------------------------\\n [1, 2] | 10 | 5 | [15, 25]\\n [3, 4] | 4 | 2 | [14, 18]\\n(2 rows)\\n```\\n\\nFind the array elements containing at least one value greater than `100`\\nwith {func}`any_match`:\\n\\n```\\nSELECT numbers\\nFROM (\\n VALUES\\n (ARRAY[1,NULL,3]),\\n (ARRAY[10,20,30]),\\n (ARRAY[100,200,300])\\n) AS t(numbers)\\nWHERE any_match(numbers, n -> COALESCE(n, 0) > 100);\\n-- [100, 200, 300]\\n```\\n\\nCapitalize the first word in a string via {func}`regexp_replace`:\\n\\n```\\nSELECT regexp_replace('once upon a time ...', '^(\\\\w)(\\\\w*)(\\\\s+.*)$',x -> upper(x[1]) || x[2] || x[3]);\\n-- Once upon a time ...\\n```\\n\\nLambda expressions can be also applied in aggregation functions.\\nFollowing statement is a sample the overly complex calculation of the sum of all elements of a column\\nby making use of {func}`reduce_agg`:\\n\\n```\\nSELECT reduce_agg(value, 0, (a, b) -> a + b, (a, b) -> a + b) sum_values\\nFROM (\\n VALUES (1), (2), (3), (4), (5)\\n) AS t(value);\\n-- 15\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 15]\"}, {\"title\": \"List of functions by topic\", \"description\": null, \"content\": {\"Aggregate\": \"For more details, see {doc}`aggregate`\\n\\n['{func}`any_value`', '{func}`approx_distinct`', '{func}`approx_most_frequent`', '{func}`approx_percentile`', '`approx_set()`', '{func}`arbitrary`', '{func}`array_agg`', '{func}`avg`', '{func}`bitwise_and_agg`', '{func}`bitwise_or_agg`', '{func}`bool_and`', '{func}`bool_or`', '{func}`checksum`', '{func}`corr`', '{func}`count`', '{func}`count_if`', '{func}`covar_pop`', '{func}`covar_samp`', '{func}`every`', '{func}`geometric_mean`', '{func}`histogram`', '{func}`kurtosis`', '{func}`map_agg`', '{func}`map_union`', '{func}`max`', '{func}`max_by`', '`merge()`', '{func}`min`', '{func}`min_by`', '{func}`multimap_agg`', '{func}`numeric_histogram`', '`qdigest_agg()`', '{func}`regr_intercept`', '{func}`regr_slope`', '{func}`skewness`', '{func}`sum`', '{func}`stddev`', '{func}`stddev_pop`', '{func}`stddev_samp`', '`tdigest_agg()`', '{func}`variance`', '{func}`var_pop`', '{func}`var_samp`']\", \"Array\": \"For more details, see {doc}`array`\\n\\n['{func}`all_match`', '{func}`any_match`', '{func}`array_distinct`', '{func}`array_except`', '{func}`array_intersect`', '{func}`array_join`', '{func}`array_max`', '{func}`array_min`', '{func}`array_position`', '{func}`array_remove`', '{func}`array_sort`', '{func}`array_union`', '{func}`arrays_overlap`', '{func}`cardinality`', '{func}`combinations`', '`concat()`', '{func}`contains`', '{func}`element_at`', '{func}`filter`', '{func}`flatten`', '{func}`ngrams`', '{func}`none_match`', '{func}`reduce`', '{func}`repeat`', '`reverse()`', '{func}`sequence`', '{func}`shuffle`', '{func}`slice`', '{func}`transform`', '{func}`trim_array`', '{func}`zip`', '{func}`zip_with`']\", \"Binary\": \"For more details, see {doc}`binary`\\n\\n['`concat()`', '{func}`crc32`', '{func}`from_base32`', '{func}`from_base64`', '{func}`from_base64url`', '{func}`from_big_endian_32`', '{func}`from_big_endian_64`', '{func}`from_hex`', '{func}`from_ieee754_32`', '{func}`from_ieee754_64`', '{func}`hmac_md5`', '{func}`hmac_sha1`', '{func}`hmac_sha256`', '{func}`hmac_sha512`', '`length()`', '`lpad()`', '{func}`md5`', '{func}`murmur3`', '`reverse()`', '`rpad()`', '{func}`sha1`', '{func}`sha256`', '{func}`sha512`', '{func}`spooky_hash_v2_32`', '{func}`spooky_hash_v2_64`', '`substr()`', '{func}`to_base32`', '{func}`to_base64`', '{func}`to_base64url`', '{func}`to_big_endian_32`', '{func}`to_big_endian_64`', '{func}`to_hex`', '{func}`to_ieee754_32`', '{func}`to_ieee754_64`', '{func}`xxhash64`']\", \"Bitwise\": \"For more details, see {doc}`bitwise`\\n\\n['{func}`bit_count`', '{func}`bitwise_and`', '{func}`bitwise_left_shift`', '{func}`bitwise_not`', '{func}`bitwise_or`', '{func}`bitwise_right_shift`', '{func}`bitwise_right_shift_arithmetic`', '{func}`bitwise_xor`']\", \"Color\": \"For more details, see {doc}`color`\\n\\n['{func}`bar`', '{func}`color`', '{func}`render`', '{func}`rgb`']\", \"Comparison\": \"For more details, see {doc}`comparison`\\n\\n['{func}`greatest`', '{func}`least`']\", \"Conditional\": \"For more details, see {doc}`conditional`\\n\\n['[case](case-expression)', '[coalesce](coalesce-function)', '[if](if-expression)', '[nullif](nullif-function)', '[try](try-function)']\", \"Conversion\": \"For more details, see {doc}`conversion`\\n\\n['{func}`cast`', '{func}`format`', '{func}`try_cast`', '{func}`typeof`']\", \"Date and time\": \"For more details, see {doc}`datetime`\\n\\n['{ref}`AT TIME ZONE <at-time-zone-operator>`', '{data}`current_date`', '{data}`current_time`', '{data}`current_timestamp`', '{data}`localtime`', '{data}`localtimestamp`', '{func}`current_timezone`', '{func}`date`', '{func}`date_add`', '{func}`date_diff`', '{func}`date_format`', '{func}`date_parse`', '{func}`date_trunc`', '{func}`format_datetime`', '{func}`from_iso8601_date`', '{func}`from_iso8601_timestamp`', '{func}`from_unixtime`', '{func}`from_unixtime_nanos`', '{func}`human_readable_seconds`', '{func}`last_day_of_month`', '{func}`now`', '{func}`parse_duration`', '{func}`timezone`', '{func}`to_iso8601`', '{func}`to_milliseconds`', '{func}`to_unixtime`', '{func}`with_timezone`']\", \"Geospatial\": \"For more details, see {doc}`geospatial`\\n\\n['{func}`bing_tile`', '{func}`bing_tile_at`', '{func}`bing_tile_coordinates`', '{func}`bing_tile_polygon`', '{func}`bing_tile_quadkey`', '{func}`bing_tile_zoom_level`', '{func}`bing_tiles_around`', '{func}`convex_hull_agg`', '{func}`from_encoded_polyline`', '{func}`from_geojson_geometry`', '{func}`geometry_from_hadoop_shape`', '{func}`geometry_invalid_reason`', '{func}`geometry_nearest_points`', '{func}`geometry_to_bing_tiles`', '{func}`geometry_union`', '{func}`geometry_union_agg`', '{func}`great_circle_distance`', '{func}`line_interpolate_point`', '{func}`line_locate_point`', '{func}`simplify_geometry`', '{func}`ST_Area`', '{func}`ST_AsBinary`', '{func}`ST_AsText`', '{func}`ST_Boundary`', '{func}`ST_Buffer`', '{func}`ST_Centroid`', '{func}`ST_Contains`', '{func}`ST_ConvexHull`', '{func}`ST_CoordDim`', '{func}`ST_Crosses`', '{func}`ST_Difference`', '{func}`ST_Dimension`', '{func}`ST_Disjoint`', '{func}`ST_Distance`', '{func}`ST_EndPoint`', '{func}`ST_Envelope`', '{func}`ST_Equals`', '{func}`ST_ExteriorRing`', '{func}`ST_Geometries`', '{func}`ST_GeometryFromText`', '{func}`ST_GeometryN`', '{func}`ST_GeometryType`', '{func}`ST_GeomFromBinary`', '{func}`ST_InteriorRings`', '{func}`ST_InteriorRingN`', '{func}`ST_Intersects`', '{func}`ST_Intersection`', '{func}`ST_IsClosed`', '{func}`ST_IsEmpty`', '{func}`ST_IsSimple`', '{func}`ST_IsRing`', '{func}`ST_IsValid`', '{func}`ST_Length`', '{func}`ST_LineFromText`', '{func}`ST_LineString`', '{func}`ST_MultiPoint`', '{func}`ST_NumGeometries`', '{func}`ST_NumInteriorRing`', '{func}`ST_NumPoints`', '{func}`ST_Overlaps`', '{func}`ST_Point`', '{func}`ST_PointN`', '{func}`ST_Points`', '{func}`ST_Polygon`', '{func}`ST_Relate`', '{func}`ST_StartPoint`', '{func}`ST_SymDifference`', '{func}`ST_Touches`', '{func}`ST_Union`', '{func}`ST_Within`', '{func}`ST_X`', '{func}`ST_XMax`', '{func}`ST_XMin`', '{func}`ST_Y`', '{func}`ST_YMax`', '{func}`ST_YMin`', '{func}`to_encoded_polyline`', '{func}`to_geojson_geometry`', '{func}`to_geometry`', '{func}`to_spherical_geography`']\", \"HyperLogLog\": \"For more details, see {doc}`hyperloglog`\\n\\n['{func}`approx_set`', '`cardinality()`', '{func}`empty_approx_set`', '{func}`merge`']\", \"JSON\": \"For more details, see {doc}`json`\\n\\n['{func}`is_json_scalar`', '{ref}`json_array() <json-array>`', '{func}`json_array_contains`', '{func}`json_array_get`', '{func}`json_array_length`', '{ref}`json_exists() <json-exists>`', '{func}`json_extract`', '{func}`json_extract_scalar`', '{func}`json_format`', '{func}`json_parse`', '{ref}`json_object() <json-object>`', '{ref}`json_query() <json-query>`', '{func}`json_size`', '{ref}`json_value() <json-value>`']\", \"Lambda\": \"For more details, see {doc}`lambda`\\n\\n['{func}`any_match`', '{func}`reduce_agg`', '{func}`regexp_replace`', '{func}`transform`']\", \"Machine learning\": \"For more details, see {doc}`ml`\\n\\n['{func}`classify`', '{func}`features`', '{func}`learn_classifier`', '{func}`learn_libsvm_classifier`', '{func}`learn_libsvm_regressor`', '{func}`learn_regressor`', '{func}`regress`']\", \"Map\": \"For more details, see {doc}`map`\\n\\n['{func}`cardinality`', '{func}`element_at`', '{func}`map`', '{func}`map_concat`', '{func}`map_entries`', '{func}`map_filter`', '{func}`map_from_entries`', '{func}`map_keys`', '{func}`map_values`', '{func}`map_zip_with`', '{func}`multimap_from_entries`', '{func}`transform_keys`', '{func}`transform_values`']\", \"Math\": \"For more details, see {doc}`math`\\n\\n['{func}`abs`', '{func}`acos`', '{func}`asin`', '{func}`atan`', '{func}`beta_cdf`', '{func}`cbrt`', '{func}`ceil`', '{func}`cos`', '{func}`cosh`', '{func}`cosine_distance`', '{func}`cosine_similarity`', '{func}`degrees`', '{func}`e`', '{func}`exp`', '{func}`floor`', '{func}`from_base`', '{func}`infinity`', '{func}`inverse_beta_cdf`', '{func}`inverse_normal_cdf`', '{func}`is_finite`', '{func}`is_nan`', '{func}`ln`', '{func}`log`', '{func}`log2`', '{func}`log10`', '{func}`mod`', '{func}`nan`', '{func}`normal_cdf`', '{func}`pi`', '{func}`pow`', '{func}`power`', '{func}`radians`', '{func}`rand`', '{func}`random`', '{func}`round`', '{func}`sign`', '{func}`sin`', '{func}`sinh`', '{func}`sqrt`', '{func}`tan`', '{func}`tanh`', '{func}`to_base`', '{func}`truncate`', '{func}`width_bucket`', '{func}`wilson_interval_lower`', '{func}`wilson_interval_upper`']\", \"Quantile digest\": \"For more details, see {doc}`qdigest`\\n\\n['`merge()`', '{func}`qdigest_agg`', '{func}`value_at_quantile`', '{func}`values_at_quantiles`']\", \"Regular expression\": \"For more details, see {doc}`regexp`\\n\\n['{func}`regexp_count`', '{func}`regexp_extract`', '{func}`regexp_extract_all`', '{func}`regexp_like`', '{func}`regexp_position`', '{func}`regexp_replace`', '{func}`regexp_split`']\", \"Row pattern recognition expressions\": [\"{ref}`classifier <classifier-function>`\", \"{ref}`first <logical-navigation-functions>`\", \"{ref}`last <logical-navigation-functions>`\", \"{ref}`match_number <match-number-function>`\", \"{ref}`next <physical-navigation-functions>`\", \"{ref}`permute <permute-function>`\", \"{ref}`prev <physical-navigation-functions>`\"], \"Session\": \"For more details, see {doc}`session`\\n\\n['{data}`current_catalog`', '{func}`current_groups`', '{data}`current_schema`', '{data}`current_user`']\", \"Set Digest\": \"For more details, see {doc}`setdigest`\\n\\n['{func}`make_set_digest`', '{func}`merge_set_digest`', '{ref}`cardinality() <setdigest-cardinality>`', '{func}`intersection_cardinality`', '{func}`jaccard_index`', '{func}`hash_counts`']\", \"String\": \"For more details, see {doc}`string`\\n\\n['{func}`chr`', '{func}`codepoint`', '{func}`concat`', '{func}`concat_ws`', '{func}`format`', '{func}`from_utf8`', '{func}`hamming_distance`', '{func}`length`', '{func}`levenshtein_distance`', '{func}`lower`', '{func}`lpad`', '{func}`ltrim`', '{func}`luhn_check`', '{func}`normalize`', '{func}`position`', '{func}`randmom_string`, catalog function of the [](/connector/faker)', '{func}`replace`', '{func}`reverse`', '{func}`rpad`', '{func}`rtrim`', '{func}`soundex`', '{func}`split`', '{func}`split_part`', '{func}`split_to_map`', '{func}`split_to_multimap`', '{func}`starts_with`', '{func}`strpos`', '{func}`substr`', '{func}`substring`', '{func}`to_utf8`', '{func}`translate`', '{func}`trim`', '{func}`upper`', '{func}`word_stem`']\", \"System\": \"For more details, see {doc}`system`\\n\\n['{func}`version`']\", \"Table\": \"For more details, see [](/functions/table)\\n\\n['[exclude_columns()](exclude-columns-table-function)', '[sequence()](sequence-table-function)']\", \"T-Digest\": \"For more details, see {doc}`tdigest`\\n\\n['`merge()`', '{func}`tdigest_agg`', '`value_at_quantile()`']\", \"Teradata\": \"For more details, see {doc}`teradata`\\n\\n['{func}`char2hexint`', '{func}`index`', '{func}`to_char`', '{func}`to_timestamp`', '{func}`to_date`']\", \"URL\": \"For more details, see {doc}`url`\\n\\n['{func}`url_decode`', '{func}`url_encode`', '{func}`url_extract_fragment`', '{func}`url_extract_host`', '{func}`url_extract_parameter`', '{func}`url_extract_path`', '{func}`url_extract_port`', '{func}`url_extract_protocol`', '{func}`url_extract_query`']\", \"UUID\": \"For more details, see {doc}`uuid`\\n\\n['{func}`uuid`']\", \"Window\": \"For more details, see {doc}`window`\\n\\n['{func}`cume_dist`', '{func}`dense_rank`', '{func}`first_value`', '{func}`lag`', '{func}`last_value`', '{func}`lead`', '{func}`nth_value`', '{func}`ntile`', '{func}`percent_rank`', '{func}`rank`', '{func}`row_number`']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 16]\"}, {\"title\": \"List of functions and operators\", \"description\": null, \"content\": {\"\\\\#\": [\"[\\\\[\\\\] substring operator](subscript-operator)\", \"[|| concatenation operator](concatenation-operator)\", \"[< comparison operator](comparison-operators)\", \"[> comparison operator](comparison-operators)\", \"[<= comparison operator](comparison-operators)\", \"[>= comparison operator](comparison-operators)\", \"[= comparison operator](comparison-operators)\", \"[<> comparison operator](comparison-operators)\", \"[!= comparison operator](comparison-operators)\", \"[-> lambda expression](lambda-expressions)\", \"[+ mathematical operator](mathematical-operators)\", \"[- mathematical operator](mathematical-operators)\", \"[* mathematical operator](mathematical-operators)\", \"[/ mathematical operator](mathematical-operators)\", \"[% mathematical operator](mathematical-operators)\"], \"A\": [\"{func}`abs`\", \"{func}`acos`\", \"[ALL](quantified-comparison-predicates)\", \"{func}`all_match`\", \"[AND](logical-operators)\", \"[ANY](quantified-comparison-predicates)\", \"{func}`any_match`\", \"{func}`any_value`\", \"{func}`approx_distinct`\", \"{func}`approx_most_frequent`\", \"{func}`approx_percentile`\", \"{func}`approx_set`\", \"{func}`arbitrary`\", \"{func}`array_agg`\", \"{func}`array_distinct`\", \"{func}`array_except`\", \"{func}`array_intersect`\", \"{func}`array_join`\", \"{func}`array_max`\", \"{func}`array_min`\", \"{func}`array_position`\", \"{func}`array_remove`\", \"{func}`array_sort`\", \"{func}`array_union`\", \"{func}`arrays_overlap`\", \"{func}`asin`\", \"[AT TIME ZONE](at-time-zone-operator)\", \"{func}`at_timezone`\", \"{func}`atan`\", \"{func}`atan2`\", \"{func}`avg`\"], \"B\": [\"{func}`bar`\", \"{func}`beta_cdf`\", \"[BETWEEN](range-operator)\", \"{func}`bing_tile`\", \"{func}`bing_tile_at`\", \"{func}`bing_tile_coordinates`\", \"{func}`bing_tile_polygon`\", \"{func}`bing_tile_quadkey`\", \"{func}`bing_tile_zoom_level`\", \"{func}`bing_tiles_around`\", \"{func}`bit_count`\", \"{func}`bitwise_and`\", \"{func}`bitwise_and_agg`\", \"{func}`bitwise_left_shift`\", \"{func}`bitwise_not`\", \"{func}`bitwise_or`\", \"{func}`bitwise_or_agg`\", \"{func}`bitwise_right_shift`\", \"{func}`bitwise_right_shift_arithmetic`\", \"{func}`bitwise_xor`\", \"{func}`bool_and`\", \"{func}`bool_or`\"], \"C\": [\"{func}`cardinality`\", \"[CASE](case-expression)\", \"{func}`cast`\", \"{func}`cbrt`\", \"{func}`ceil`\", \"{func}`ceiling`\", \"{func}`char2hexint`\", \"{func}`checksum`\", \"{func}`chr`\", \"{func}`classify`\", \"[classifier](classifier-function)\", \"[coalesce](coalesce-function)\", \"{func}`codepoint`\", \"{func}`color`\", \"{func}`combinations`\", \"{func}`concat`\", \"{func}`concat_ws`\", \"{func}`contains`\", \"{func}`contains_sequence`\", \"{func}`convex_hull_agg`\", \"{func}`corr`\", \"{func}`cos`\", \"{func}`cosh`\", \"{func}`cosine_distance`\", \"{func}`cosine_similarity`\", \"{func}`count`\", \"{func}`count_if`\", \"{func}`covar_pop`\", \"{func}`covar_samp`\", \"{func}`crc32`\", \"{func}`cume_dist`\", \"{data}`current_date`\", \"{func}`current_groups`\", \"{data}`current_time`\", \"{data}`current_timestamp`\", \"{func}`current_timezone`\", \"{data}`current_user`\"], \"D\": [\"{func}`date`\", \"{func}`date_add`\", \"{func}`date_diff`\", \"{func}`date_format`\", \"{func}`date_parse`\", \"{func}`date_trunc`\", \"{func}`day`\", \"{func}`day_of_month`\", \"{func}`day_of_week`\", \"{func}`day_of_year`\", \"[DECIMAL](decimal-literal)\", \"{func}`degrees`\", \"{func}`dense_rank`\", \"{func}`dow`\", \"{func}`doy`\"], \"E\": [\"{func}`e`\", \"{func}`element_at`\", \"{func}`empty_approx_set`\", \"`evaluate_classifier_predictions`\", \"{func}`every`\", \"{func}`exclude_columns`\", \"{func}`extract`\", \"{func}`exp`\"], \"F\": [\"{func}`features`\", \"{func}`filter`\", \"[first](logical-navigation-functions)\", \"{func}`first_value`\", \"{func}`flatten`\", \"{func}`floor`\", \"{func}`format`\", \"{func}`format_datetime`\", \"{func}`format_number`\", \"{func}`from_base`\", \"{func}`from_base32`\", \"{func}`from_base64`\", \"{func}`from_base64url`\", \"{func}`from_big_endian_32`\", \"{func}`from_big_endian_64`\", \"{func}`from_encoded_polyline`\", \"`from_geojson_geometry`\", \"{func}`from_hex`\", \"{func}`from_ieee754_32`\", \"{func}`from_ieee754_64`\", \"{func}`from_iso8601_date`\", \"{func}`from_iso8601_timestamp`\", \"{func}`from_iso8601_timestamp_nanos`\", \"{func}`from_unixtime`\", \"{func}`from_unixtime_nanos`\", \"{func}`from_utf8`\"], \"G\": [\"{func}`geometric_mean`\", \"{func}`geometry_from_hadoop_shape`\", \"{func}`geometry_invalid_reason`\", \"{func}`geometry_nearest_points`\", \"{func}`geometry_to_bing_tiles`\", \"{func}`geometry_union`\", \"{func}`geometry_union_agg`\", \"{func}`great_circle_distance`\", \"{func}`greatest`\"], \"H\": [\"{func}`hamming_distance`\", \"{func}`hash_counts`\", \"{func}`histogram`\", \"{func}`hmac_md5`\", \"{func}`hmac_sha1`\", \"{func}`hmac_sha256`\", \"{func}`hmac_sha512`\", \"{func}`hour`\", \"{func}`human_readable_seconds`\"], \"I\": [\"[if](if-expression)\", \"{func}`index`\", \"{func}`infinity`\", \"{func}`intersection_cardinality`\", \"{func}`inverse_beta_cdf`\", \"{func}`inverse_normal_cdf`\", \"{func}`is_finite`\", \"{func}`is_infinite`\", \"{func}`is_json_scalar`\", \"{func}`is_nan`\", \"[IS NOT DISTINCT](is-distinct-operator)\", \"[IS NOT NULL](is-null-operator)\", \"[IS DISTINCT](is-distinct-operator)\", \"[IS NULL](is-null-operator)\"], \"J\": [\"{func}`jaccard_index`\", \"[json_array()](json-array)\", \"{func}`json_array_contains`\", \"{func}`json_array_get`\", \"{func}`json_array_length`\", \"[json_exists()](json-exists)\", \"{func}`json_extract`\", \"{func}`json_extract_scalar`\", \"{func}`json_format`\", \"[json_object()](json-object)\", \"{func}`json_parse`\", \"[json_query()](json-query)\", \"{func}`json_size`\", \"[json_value()](json-value)\"], \"K\": [\"{func}`kurtosis`\"], \"L\": [\"{func}`lag`\", \"[last](logical-navigation-functions)\", \"{func}`last_day_of_month`\", \"{func}`last_value`\", \"{func}`lead`\", \"{func}`learn_classifier`\", \"{func}`learn_libsvm_classifier`\", \"{func}`learn_libsvm_regressor`\", \"{func}`learn_regressor`\", \"{func}`least`\", \"{func}`length`\", \"{func}`levenshtein_distance`\", \"{func}`line_interpolate_point`\", \"{func}`line_interpolate_points`\", \"{func}`line_locate_point`\", \"{func}`listagg`\", \"{func}`ln`\", \"{data}`localtime`\", \"{data}`localtimestamp`\", \"{func}`log`\", \"{func}`log10`\", \"{func}`log2`\", \"{func}`lower`\", \"{func}`lpad`\", \"{func}`ltrim`\", \"{func}`luhn_check`\"], \"M\": [\"{func}`make_set_digest`\", \"{func}`map`\", \"{func}`map_agg`\", \"{func}`map_concat`\", \"{func}`map_entries`\", \"{func}`map_filter`\", \"{func}`map_from_entries`\", \"{func}`map_keys`\", \"{func}`map_union`\", \"{func}`map_values`\", \"{func}`map_zip_with`\", \"[match_number](match-number-function)\", \"{func}`max`\", \"{func}`max_by`\", \"{func}`md5`\", \"{func}`merge`\", \"{func}`merge_set_digest`\", \"{func}`millisecond`\", \"{func}`min`\", \"{func}`min_by`\", \"{func}`minute`\", \"{func}`mod`\", \"{func}`month`\", \"{func}`multimap_agg`\", \"{func}`multimap_from_entries`\", \"{func}`murmur3`\"], \"N\": [\"{func}`nan`\", \"[next](physical-navigation-functions)\", \"{func}`ngrams`\", \"{func}`none_match`\", \"{func}`normal_cdf`\", \"{func}`normalize`\", \"[NOT](logical-operators)\", \"[NOT BETWEEN](range-operator)\", \"{func}`now`\", \"{func}`nth_value`\", \"{func}`ntile`\", \"[nullif](nullif-function)\", \"{func}`numeric_histogram`\"], \"O\": [\"`objectid`\", \"{func}`objectid_timestamp`\", \"[OR](logical-operators)\"], \"P\": [\"{func}`parse_datetime`\", \"{func}`parse_duration`\", \"{func}`parse_data_size`\", \"{func}`percent_rank`\", \"[permute](permute-function)\", \"{func}`pi`\", \"{func}`position`\", \"{func}`pow`\", \"{func}`power`\", \"[prev](physical-navigation-functions)\"], \"Q\": [\"{func}`qdigest_agg`\", \"{func}`quarter`\"], \"R\": [\"{func}`radians`\", \"{func}`rand`\", \"{func}`random`\", \"{func}`random_string`, catalog function of the [](/connector/faker)\", \"{func}`rank`\", \"{func}`reduce`\", \"{func}`reduce_agg`\", \"{func}`regexp_count`\", \"{func}`regexp_extract`\", \"{func}`regexp_extract_all`\", \"{func}`regexp_like`\", \"{func}`regexp_position`\", \"{func}`regexp_replace`\", \"{func}`regexp_split`\", \"{func}`regress`\", \"{func}`regr_intercept`\", \"{func}`regr_slope`\", \"{func}`render`\", \"{func}`repeat`\", \"{func}`replace`\", \"{func}`reverse`\", \"{func}`rgb`\", \"{func}`round`\", \"{func}`row_number`\", \"{func}`rpad`\", \"{func}`rtrim`\"], \"S\": [\"{func}`second`\", \"{func}`sequence` (scalar function)\", \"[sequence()](sequence-table-function) (table function)\", \"{func}`sha1`\", \"{func}`sha256`\", \"{func}`sha512`\", \"{func}`shuffle`\", \"{func}`sign`\", \"{func}`simplify_geometry`\", \"{func}`sin`\", \"{func}`sinh`\", \"{func}`skewness`\", \"{func}`slice`\", \"[SOME](quantified-comparison-predicates)\", \"{func}`soundex`\", \"`spatial_partitioning`\", \"`spatial_partitions`\", \"{func}`split`\", \"{func}`split_part`\", \"{func}`split_to_map`\", \"{func}`split_to_multimap`\", \"{func}`spooky_hash_v2_32`\", \"{func}`spooky_hash_v2_64`\", \"{func}`sqrt`\", \"{func}`ST_Area`\", \"{func}`ST_AsBinary`\", \"{func}`ST_AsText`\", \"{func}`ST_Boundary`\", \"{func}`ST_Buffer`\", \"{func}`ST_Centroid`\", \"{func}`ST_Contains`\", \"{func}`ST_ConvexHull`\", \"{func}`ST_CoordDim`\", \"{func}`ST_Crosses`\", \"{func}`ST_Difference`\", \"{func}`ST_Dimension`\", \"{func}`ST_Disjoint`\", \"{func}`ST_Distance`\", \"{func}`ST_EndPoint`\", \"{func}`ST_Envelope`\", \"{func}`ST_EnvelopeAsPts`\", \"{func}`ST_Equals`\", \"{func}`ST_ExteriorRing`\", \"{func}`ST_Geometries`\", \"{func}`ST_GeometryFromText`\", \"{func}`ST_GeometryN`\", \"{func}`ST_GeometryType`\", \"{func}`ST_GeomFromBinary`\", \"{func}`ST_InteriorRingN`\", \"{func}`ST_InteriorRings`\", \"{func}`ST_Intersection`\", \"{func}`ST_Intersects`\", \"{func}`ST_IsClosed`\", \"{func}`ST_IsEmpty`\", \"{func}`ST_IsRing`\", \"{func}`ST_IsSimple`\", \"{func}`ST_IsValid`\", \"{func}`ST_Length`\", \"{func}`ST_LineFromText`\", \"{func}`ST_LineString`\", \"{func}`ST_MultiPoint`\", \"{func}`ST_NumGeometries`\", \"`ST_NumInteriorRing`\", \"{func}`ST_NumPoints`\", \"{func}`ST_Overlaps`\", \"{func}`ST_Point`\", \"{func}`ST_PointN`\", \"{func}`ST_Points`\", \"{func}`ST_Polygon`\", \"{func}`ST_Relate`\", \"{func}`ST_StartPoint`\", \"{func}`ST_SymDifference`\", \"{func}`ST_Touches`\", \"{func}`ST_Union`\", \"{func}`ST_Within`\", \"{func}`ST_X`\", \"{func}`ST_XMax`\", \"{func}`ST_XMin`\", \"{func}`ST_Y`\", \"{func}`ST_YMax`\", \"{func}`ST_YMin`\", \"{func}`starts_with`\", \"{func}`stddev`\", \"{func}`stddev_pop`\", \"{func}`stddev_samp`\", \"{func}`strpos`\", \"{func}`substr`\", \"{func}`substring`\", \"{func}`sum`\"], \"T\": [\"{func}`tan`\", \"{func}`tanh`\", \"{func}`tdigest_agg`\", \"{func}`timestamp_objectid`\", \"{func}`timezone`\", \"{func}`timezone_hour`\", \"{func}`timezone_minute`\", \"{func}`to_base`\", \"{func}`to_base32`\", \"{func}`to_base64`\", \"{func}`to_base64url`\", \"{func}`to_big_endian_32`\", \"{func}`to_big_endian_64`\", \"{func}`to_char`\", \"{func}`to_date`\", \"{func}`to_encoded_polyline`\", \"`to_geojson_geometry`\", \"{func}`to_geometry`\", \"{func}`to_hex`\", \"{func}`to_ieee754_32`\", \"{func}`to_ieee754_64`\", \"{func}`to_iso8601`\", \"{func}`to_milliseconds`\", \"{func}`to_spherical_geography`\", \"{func}`to_timestamp`\", \"{func}`to_unixtime`\", \"{func}`to_utf8`\", \"{func}`transform`\", \"{func}`transform_keys`\", \"{func}`transform_values`\", \"{func}`translate`\", \"{func}`trim`\", \"{func}`trim_array`\", \"{func}`truncate`\", \"[try](try-function)\", \"{func}`try_cast`\", \"{func}`typeof`\"], \"U\": [\"{func}`upper`\", \"{func}`url_decode`\", \"{func}`url_encode`\", \"{func}`url_extract_fragment`\", \"{func}`url_extract_host`\", \"{func}`url_extract_parameter`\", \"{func}`url_extract_path`\", \"{func}`url_extract_protocol`\", \"{func}`url_extract_port`\", \"{func}`url_extract_query`\", \"{func}`uuid`\"], \"V\": [\"{func}`value_at_quantile`\", \"{func}`values_at_quantiles`\", \"{func}`var_pop`\", \"{func}`var_samp`\", \"{func}`variance`\", \"{func}`version`\"], \"W\": [\"{func}`week`\", \"{func}`week_of_year`\", \"{func}`width_bucket`\", \"{func}`wilson_interval_lower`\", \"{func}`wilson_interval_upper`\", \"{func}`with_timezone`\", \"{func}`word_stem`\"], \"X\": [\"{func}`xxhash64`\"], \"Y\": [\"{func}`year`\", \"{func}`year_of_week`\", \"{func}`yow`\"], \"Z\": [\"{func}`zip`\", \"{func}`zip_with`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 17]\"}, {\"title\": \"Logical operators\", \"description\": null, \"content\": {\"Logical operators\": \"| Operator | Description | Example |\\n| -------- | ---------------------------- | ------- |\\n| `AND` | True if both values are true | a AND b |\\n| `OR` | True if either value is true | a OR b |\\n| `NOT` | True if the value is false | NOT a |\", \"Effect of NULL on logical operators\": \"The result of an `AND` comparison may be `NULL` if one or both\\nsides of the expression are `NULL`. If at least one side of an\\n`AND` operator is `FALSE` the expression evaluates to `FALSE`:\\n\\n```\\nSELECT CAST(null AS boolean) AND true; -- null\\n\\nSELECT CAST(null AS boolean) AND false; -- false\\n\\nSELECT CAST(null AS boolean) AND CAST(null AS boolean); -- null\\n```\\n\\nThe result of an `OR` comparison may be `NULL` if one or both\\nsides of the expression are `NULL`. If at least one side of an\\n`OR` operator is `TRUE` the expression evaluates to `TRUE`:\\n\\n```\\nSELECT CAST(null AS boolean) OR CAST(null AS boolean); -- null\\n\\nSELECT CAST(null AS boolean) OR false; -- null\\n\\nSELECT CAST(null AS boolean) OR true; -- true\\n```\\n\\nThe following truth table demonstrates the handling of\\n`NULL` in `AND` and `OR`:\\n\\n| a | b | a AND b | a OR b |\\n| ------- | ------- | ------- | ------- |\\n| `TRUE` | `TRUE` | `TRUE` | `TRUE` |\\n| `TRUE` | `FALSE` | `FALSE` | `TRUE` |\\n| `TRUE` | `NULL` | `NULL` | `TRUE` |\\n| `FALSE` | `TRUE` | `FALSE` | `TRUE` |\\n| `FALSE` | `FALSE` | `FALSE` | `FALSE` |\\n| `FALSE` | `NULL` | `FALSE` | `NULL` |\\n| `NULL` | `TRUE` | `NULL` | `TRUE` |\\n| `NULL` | `FALSE` | `FALSE` | `NULL` |\\n| `NULL` | `NULL` | `NULL` | `NULL` |\\n\\nThe logical complement of `NULL` is `NULL` as shown in the following example:\\n\\n```\\nSELECT NOT CAST(null AS boolean); -- null\\n```\\n\\nThe following truth table demonstrates the handling of `NULL` in `NOT`:\\n\\n| a | NOT a |\\n| ------- | ------- |\\n| `TRUE` | `FALSE` |\\n| `FALSE` | `TRUE` |\\n| `NULL` | `NULL` |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 18]\"}, {\"title\": \"Map functions and operators\", \"description\": null, \"content\": {\"Subscript operator: \\\\[\\\\]\": \"The `[]` operator is used to retrieve the value corresponding to a given key from a map.\\nThis operator throws an error if the key is not contained in the map.\\nSee also `element_at` function that returns `NULL` in such case.\\n\\n```\\nSELECT name_to_age_map['Bob'] AS bob_age;\\n```\\n\\nThe following example constructs a map and then accesses the element with \\nthe key `key2`:\\n\\n```\\nSELECT MAP(ARRAY['key1', 'key2', 'key3' ], ARRAY['v1', 'v2', 'v3'])['key2'];\\n-- v2\\n```\", \"Map functions\": \":::{function} cardinality(x) -> bigint\\n:noindex: true\\n\\nReturns the cardinality (size) of the map `x`.\\n:::\\n\\n:::{function} element_at(map(K,V), key) -> V\\n:noindex: true\\n\\nReturns value for given `key`, or `NULL` if the key is not contained in the map.\\n:::\\n\\n:::{function} map() -> map<unknown, unknown>\\nReturns an empty map.\\n\\n```\\nSELECT map();\\n-- {}\\n```\\n\\n:::\\n\\n:::{function} map(array(K), array(V)) -> map(K,V)\\n:noindex: true\\n\\nReturns a map created using the given key/value arrays.\\n\\n```\\nSELECT map(ARRAY[1,3], ARRAY[2,4]);\\n-- {1 -> 2, 3 -> 4}\\n```\\n\\nSee also {func}`map_agg` and {func}`multimap_agg` for creating a map as an aggregation.\\n:::\\n\\n:::{function} map_from_entries(array(row(K,V))) -> map(K,V)\\nReturns a map created from the given array of entries.\\n\\n```\\nSELECT map_from_entries(ARRAY[(1, 'x'), (2, 'y')]);\\n-- {1 -> 'x', 2 -> 'y'}\\n```\\n\\n:::\\n\\n:::{function} multimap_from_entries(array(row(K,V))) -> map(K,array(V))\\nReturns a multimap created from the given array of entries. Each key can be associated with multiple values.\\n\\n```\\nSELECT multimap_from_entries(ARRAY[(1, 'x'), (2, 'y'), (1, 'z')]);\\n-- {1 -> ['x', 'z'], 2 -> ['y']}\\n```\\n\\n:::\\n\\n:::{function} map_entries(map(K,V)) -> array(row(K,V))\\nReturns an array of all entries in the given map.\\n\\n```\\nSELECT map_entries(MAP(ARRAY[1, 2], ARRAY['x', 'y']));\\n-- [ROW(1, 'x'), ROW(2, 'y')]\\n```\\n\\n:::\\n\\n:::{function} map_concat(map1(K,V), map2(K,V), ..., mapN(K,V)) -> map(K,V)\\nReturns the union of all the given maps. If a key is found in multiple given maps,\\nthat key's value in the resulting map comes from the last one of those maps.\\n:::\\n\\n:::{function} map_filter(map(K,V), function(K,V,boolean)) -> map(K,V)\\nConstructs a map from those entries of `map` for which `function` returns true:\\n\\n```\\nSELECT map_filter(MAP(ARRAY[], ARRAY[]), (k, v) -> true);\\n-- {}\\n\\nSELECT map_filter(MAP(ARRAY[10, 20, 30], ARRAY['a', NULL, 'c']),\\n (k, v) -> v IS NOT NULL);\\n-- {10 -> a, 30 -> c}\\n\\nSELECT map_filter(MAP(ARRAY['k1', 'k2', 'k3'], ARRAY[20, 3, 15]),\\n (k, v) -> v > 10);\\n-- {k1 -> 20, k3 -> 15}\\n```\\n\\n:::\\n\\n:::{function} map_keys(x(K,V)) -> array(K)\\nReturns all the keys in the map `x`.\\n:::\\n\\n:::{function} map_values(x(K,V)) -> array(V)\\nReturns all the values in the map `x`.\\n:::\\n\\n:::{function} map_zip_with(map(K,V1), map(K,V2), function(K,V1,V2,V3)) -> map(K,V3)\\nMerges the two given maps into a single map by applying `function` to the pair of values with the same key.\\nFor keys only presented in one map, NULL will be passed as the value for the missing key.\\n\\n```\\nSELECT map_zip_with(MAP(ARRAY[1, 2, 3], ARRAY['a', 'b', 'c']),\\n MAP(ARRAY[1, 2, 3], ARRAY['d', 'e', 'f']),\\n (k, v1, v2) -> concat(v1, v2));\\n-- {1 -> ad, 2 -> be, 3 -> cf}\\n\\nSELECT map_zip_with(MAP(ARRAY['k1', 'k2'], ARRAY[1, 2]),\\n MAP(ARRAY['k2', 'k3'], ARRAY[4, 9]),\\n (k, v1, v2) -> (v1, v2));\\n-- {k1 -> ROW(1, null), k2 -> ROW(2, 4), k3 -> ROW(null, 9)}\\n\\nSELECT map_zip_with(MAP(ARRAY['a', 'b', 'c'], ARRAY[1, 8, 27]),\\n MAP(ARRAY['a', 'b', 'c'], ARRAY[1, 2, 3]),\\n (k, v1, v2) -> k || CAST(v1 / v2 AS VARCHAR));\\n-- {a -> a1, b -> b4, c -> c9}\\n```\\n\\n:::\\n\\n:::{function} transform_keys(map(K1,V), function(K1,V,K2)) -> map(K2,V)\\nReturns a map that applies `function` to each entry of `map` and transforms the keys:\\n\\n```\\nSELECT transform_keys(MAP(ARRAY[], ARRAY[]), (k, v) -> k + 1);\\n-- {}\\n\\nSELECT transform_keys(MAP(ARRAY [1, 2, 3], ARRAY ['a', 'b', 'c']),\\n (k, v) -> k + 1);\\n-- {2 -> a, 3 -> b, 4 -> c}\\n\\nSELECT transform_keys(MAP(ARRAY ['a', 'b', 'c'], ARRAY [1, 2, 3]),\\n (k, v) -> v * v);\\n-- {1 -> 1, 4 -> 2, 9 -> 3}\\n\\nSELECT transform_keys(MAP(ARRAY ['a', 'b'], ARRAY [1, 2]),\\n (k, v) -> k || CAST(v as VARCHAR));\\n-- {a1 -> 1, b2 -> 2}\\n\\nSELECT transform_keys(MAP(ARRAY [1, 2], ARRAY [1.0, 1.4]),\\n (k, v) -> MAP(ARRAY[1, 2], ARRAY['one', 'two'])[k]);\\n-- {one -> 1.0, two -> 1.4}\\n```\\n\\n:::\\n\\n:::{function} transform_values(map(K,V1), function(K,V1,V2)) -> map(K,V2)\\nReturns a map that applies `function` to each entry of `map` and transforms the values:\\n\\n```\\nSELECT transform_values(MAP(ARRAY[], ARRAY[]), (k, v) -> v + 1);\\n-- {}\\n\\nSELECT transform_values(MAP(ARRAY [1, 2, 3], ARRAY [10, 20, 30]),\\n (k, v) -> v + k);\\n-- {1 -> 11, 2 -> 22, 3 -> 33}\\n\\nSELECT transform_values(MAP(ARRAY [1, 2, 3], ARRAY ['a', 'b', 'c']),\\n (k, v) -> k * k);\\n-- {1 -> 1, 2 -> 4, 3 -> 9}\\n\\nSELECT transform_values(MAP(ARRAY ['a', 'b'], ARRAY [1, 2]),\\n (k, v) -> k || CAST(v as VARCHAR));\\n-- {a -> a1, b -> b2}\\n\\nSELECT transform_values(MAP(ARRAY [1, 2], ARRAY [1.0, 1.4]),\\n (k, v) -> MAP(ARRAY[1, 2], ARRAY['one', 'two'])[k]\\n || '_' || CAST(v AS VARCHAR));\\n-- {1 -> one_1.0, 2 -> two_1.4}\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 19]\"}, {\"title\": \"Mathematical functions and operators\", \"description\": null, \"content\": {\"Mathematical operators\": \"| Operator | Description |\\n| -------- | ----------------------------------------------- |\\n| `+` | Addition |\\n| `-` | Subtraction |\\n| `*` | Multiplication |\\n| `/` | Division (integer division performs truncation) |\\n| `%` | Modulus (remainder) |\", \"Mathematical functions\": \":::{function} abs(x) -> [same as input]\\nReturns the absolute value of `x`.\\n:::\\n\\n:::{function} cbrt(x) -> double\\nReturns the cube root of `x`.\\n:::\\n\\n:::{function} ceil(x) -> [same as input]\\nThis is an alias for {func}`ceiling`.\\n:::\\n\\n:::{function} ceiling(x) -> [same as input]\\nReturns `x` rounded up to the nearest integer.\\n:::\\n\\n:::{function} degrees(x) -> double\\nConverts angle `x` in radians to degrees.\\n:::\\n\\n:::{function} e() -> double\\nReturns the constant Euler's number.\\n:::\\n\\n:::{function} exp(x) -> double\\nReturns Euler's number raised to the power of `x`.\\n:::\\n\\n:::{function} floor(x) -> [same as input]\\nReturns `x` rounded down to the nearest integer.\\n:::\\n\\n:::{function} ln(x) -> double\\nReturns the natural logarithm of `x`.\\n:::\\n\\n:::{function} log(b, x) -> double\\nReturns the base `b` logarithm of `x`.\\n:::\\n\\n:::{function} log2(x) -> double\\nReturns the base 2 logarithm of `x`.\\n:::\\n\\n:::{function} log10(x) -> double\\nReturns the base 10 logarithm of `x`.\\n:::\\n\\n:::{function} mod(n, m) -> [same as input]\\nReturns the modulus (remainder) of `n` divided by `m`.\\n:::\\n\\n:::{function} pi() -> double\\nReturns the constant Pi.\\n:::\\n\\n:::{function} pow(x, p) -> double\\nThis is an alias for {func}`power`.\\n:::\\n\\n:::{function} power(x, p) -> double\\nReturns `x` raised to the power of `p`.\\n:::\\n\\n:::{function} radians(x) -> double\\nConverts angle `x` in degrees to radians.\\n:::\\n\\n:::{function} round(x) -> [same as input]\\nReturns `x` rounded to the nearest integer.\\n:::\\n\\n:::{function} round(x, d) -> [same as input]\\n:noindex: true\\n\\nReturns `x` rounded to `d` decimal places.\\n:::\\n\\n:::{function} sign(x) -> [same as input]\\nReturns the signum function of `x`, that is:\\n\\n['0 if the argument is 0,', '1 if the argument is greater than 0,', '-1 if the argument is less than 0.']\\n\\nFor floating point arguments, the function additionally returns:\\n\\n['-0 if the argument is -0,', 'NaN if the argument is NaN,', '1 if the argument is +Infinity,', '-1 if the argument is -Infinity.\\\\n:::']\\n\\n:::{function} sqrt(x) -> double\\nReturns the square root of `x`.\\n:::\\n\\n:::{function} truncate(x) -> double\\nReturns `x` rounded to integer by dropping digits after decimal point.\\n:::\\n\\n:::{function} width_bucket(x, bound1, bound2, n) -> bigint\\nReturns the bin number of `x` in an equi-width histogram with the\\nspecified `bound1` and `bound2` bounds and `n` number of buckets.\\n:::\\n\\n:::{function} width_bucket(x, bins) -> bigint\\n:noindex: true\\n\\nReturns the bin number of `x` according to the bins specified by the\\narray `bins`. The `bins` parameter must be an array of doubles and is\\nassumed to be in sorted ascending order.\\n:::\", \"Random functions\": \":::{function} rand() -> double\\nThis is an alias for {func}`random()`.\\n:::\\n\\n:::{function} random() -> double\\nReturns a pseudo-random value in the range 0.0 \\\\<= x \\\\< 1.0.\\n:::\\n\\n:::{function} random(n) -> [same as input]\\n:noindex: true\\n\\nReturns a pseudo-random number between 0 and n (exclusive).\\n:::\\n\\n:::{function} random(m, n) -> [same as input]\\n:noindex: true\\n\\nReturns a pseudo-random number between m and n (exclusive).\\n:::\", \"Trigonometric functions\": \"All trigonometric function arguments are expressed in radians.\\nSee unit conversion functions {func}`degrees` and {func}`radians`.\\n\\n:::{function} acos(x) -> double\\nReturns the arc cosine of `x`.\\n:::\\n\\n:::{function} asin(x) -> double\\nReturns the arc sine of `x`.\\n:::\\n\\n:::{function} atan(x) -> double\\nReturns the arc tangent of `x`.\\n:::\\n\\n:::{function} atan2(y, x) -> double\\nReturns the arc tangent of `y / x`.\\n:::\\n\\n:::{function} cos(x) -> double\\nReturns the cosine of `x`.\\n:::\\n\\n:::{function} cosh(x) -> double\\nReturns the hyperbolic cosine of `x`.\\n:::\\n\\n:::{function} sin(x) -> double\\nReturns the sine of `x`.\\n:::\\n\\n:::{function} sinh(x) -> double\\nReturns the hyperbolic sine of `x`.\\n:::\\n\\n:::{function} tan(x) -> double\\nReturns the tangent of `x`.\\n:::\\n\\n:::{function} tanh(x) -> double\\nReturns the hyperbolic tangent of `x`.\\n:::\", \"Geometric functions\": \":::{function} cosine_distance(array(double), array(double)) -> double\\nCalculates the cosine distance between two dense vectors:\\n\\n```\\nSELECT cosine_distance(ARRAY[1.0, 2.0], ARRAY[3.0, 4.0]);\\n-- 0.01613008990009257\\n```\\n\\n:::\\n\\n:::{function} cosine_distance(x, y) -> double\\n:no-index:\\nCalculates the cosine distance between two sparse vectors:\\n\\n```\\nSELECT cosine_distance(MAP(ARRAY['a'], ARRAY[1.0]), MAP(ARRAY['a'], ARRAY[2.0]));\\n-- 0.0\\n```\\n\\n:::\\n\\n:::{function} cosine_similarity(array(double), array(double)) -> double\\nCalculates the cosine similarity of two dense vectors:\\n\\n```\\nSELECT cosine_similarity(ARRAY[1.0, 2.0], ARRAY[3.0, 4.0]);\\n-- 0.9838699100999074\\n```\\n\\n:::\\n\\n:::{function} cosine_similarity(x, y) -> double\\n:no-index:\\nCalculates the cosine similarity of two sparse vectors:\\n\\n```\\nSELECT cosine_similarity(MAP(ARRAY['a'], ARRAY[1.0]), MAP(ARRAY['a'], ARRAY[2.0]));\\n-- 1.0\\n```\\n\\n:::\", \"Floating point functions\": \":::{function} infinity() -> double\\nReturns the constant representing positive infinity.\\n:::\\n\\n:::{function} is_finite(x) -> boolean\\nDetermine if `x` is finite.\\n:::\\n\\n:::{function} is_infinite(x) -> boolean\\nDetermine if `x` is infinite.\\n:::\\n\\n:::{function} is_nan(x) -> boolean\\nDetermine if `x` is not-a-number.\\n:::\\n\\n:::{function} nan() -> double\\nReturns the constant representing not-a-number.\\n:::\", \"Base conversion functions\": \":::{function} from_base(string, radix) -> bigint\\nReturns the value of `string` interpreted as a base-`radix` number.\\n:::\\n\\n:::{function} to_base(x, radix) -> varchar\\nReturns the base-`radix` representation of `x`.\\n:::\", \"Statistical functions\": \":::{function} t_pdf(x, df) -> double\\nComputes the Student's t-distribution probability density function for given x and\\ndegrees of freedom (df). The x must be a real value and degrees of freedom must be\\nan integer and positive value.\\n:::\\n\\n:::{function} wilson_interval_lower(successes, trials, z) -> double\\nReturns the lower bound of the Wilson score interval of a Bernoulli trial process\\nat a confidence specified by the z-score `z`.\\n:::\\n\\n:::{function} wilson_interval_upper(successes, trials, z) -> double\\nReturns the upper bound of the Wilson score interval of a Bernoulli trial process\\nat a confidence specified by the z-score `z`.\\n:::\", \"Cumulative distribution functions\": \":::{function} beta_cdf(a, b, v) -> double\\nCompute the Beta cdf with given a, b parameters: P(N \\\\< v; a, b).\\nThe a, b parameters must be positive real numbers and value v must be a real value.\\nThe value v must lie on the interval \\\\[0, 1\\\\].\\n:::\\n\\n:::{function} inverse_beta_cdf(a, b, p) -> double\\nCompute the inverse of the Beta cdf with given a, b parameters for the cumulative\\nprobability (p): P(N \\\\< n). The a, b parameters must be positive real values.\\nThe probability p must lie on the interval \\\\[0, 1\\\\].\\n:::\\n\\n:::{function} inverse_normal_cdf(mean, sd, p) -> double\\nCompute the inverse of the Normal cdf with given mean and standard\\ndeviation (sd) for the cumulative probability (p): P(N \\\\< n). The mean must be\\na real value and the standard deviation must be a real and positive value.\\nThe probability p must lie on the interval (0, 1).\\n:::\\n\\n:::{function} normal_cdf(mean, sd, v) -> double\\nCompute the Normal cdf with given mean and standard deviation (sd): P(N \\\\< v; mean, sd).\\nThe mean and value v must be real values and the standard deviation must be a real\\nand positive value.\\n:::\\n\\n:::{function} t_cdf(x, df) -> double\\nCompute the Student's t-distribution cumulative density function for given x and degrees of freedom (df).\\nThe x must be a real value and degrees of freedom must be an integer and positive value.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 20]\"}, {\"title\": \"Machine learning functions\", \"description\": null, \"content\": {\"Feature vector\": \"To solve a problem with the machine learning technique, especially as a\\nsupervised learning problem, it is necessary to represent the data set\\nwith the sequence of pairs of labels and feature vector. A label is a\\ntarget value you want to predict from the unseen feature and a feature is \\na N-dimensional vector whose elements are numerical values. In Trino, a\\nfeature vector is represented as a map-type value, whose key is an index\\nof each feature, so that it can express a sparse vector.\\nSince classifiers and regressors can recognize the map-type feature\\nvector, there is a function to construct the feature from the existing\\nnumerical values, {func}`features`:\\n\\n```\\nSELECT features(1.0, 2.0, 3.0) AS features;\\n```\\n\\n```\\n features\\n-----------------------\\n {0=1.0, 1=2.0, 2=3.0}\\n```\\n\\nThe output from {func}`features` can be directly passed to ML functions.\", \"Classification\": \"Classification is a type of supervised learning problem to predict the distinct\\nlabel from the given feature vector. The interface looks similar to the\\nconstruction of the SVM model from the sequence of pairs of labels and features\\nimplemented in Teradata Aster or [BigQuery ML](https://cloud.google.com/bigquery-ml/docs/bigqueryml-intro).\\nThe function to train a classification model looks like as follows:\\n\\n```\\nSELECT\\n learn_classifier(\\n species,\\n features(sepal_length, sepal_width, petal_length, petal_width)\\n ) AS model\\nFROM\\n iris\\n```\\n\\nIt returns the trained model in a serialized format.\\n\\n```\\n model\\n-------------------------------------------------\\n 3c 43 6c 61 73 73 69 66 69 65 72 28 76 61 72 63\\n 68 61 72 29 3e\\n```\\n\\n{func}`classify` returns the predicted label by using the trained model.\\nThe trained model can not be saved natively, and needs to be passed in\\nthe format of a nested query:\\n\\n```\\nSELECT\\n classify(features(5.9, 3, 5.1, 1.8), model) AS predicted_label\\nFROM (\\n SELECT\\n learn_classifier(species, features(sepal_length, sepal_width, petal_length, petal_width)) AS model\\n FROM\\n iris\\n) t\\n```\\n\\n```\\n predicted_label\\n-----------------\\n Iris-virginica\\n```\\n\\nAs a result you need to run the training process at the same time when predicting values.\\nInternally, the model is trained by [libsvm](https://www.csie.ntu.edu.tw/~cjlin/libsvm/).\\nYou can use {func}`learn_libsvm_classifier` to control the internal parameters of the model.\", \"Regression\": \"Regression is another type of supervised learning problem, predicting continuous\\nvalue, unlike the classification problem. The target must be numerical values that can\\nbe described as `double`.\\n\\nThe following code shows the creation of the model predicting `sepal_length`\\nfrom the other 3 features:\\n\\n```\\nSELECT\\n learn_regressor(sepal_length, features(sepal_width, petal_length, petal_width)) AS model\\nFROM\\n iris\\n```\\n\\nThe way to use the model is similar to the classification case:\\n\\n```\\nSELECT\\n regress(features(3, 5.1, 1.8), model) AS predicted_target\\nFROM (\\n SELECT\\n learn_regressor(sepal_length, features(sepal_width, petal_length, petal_width)) AS model\\n FROM iris\\n) t;\\n```\\n\\n```\\n predicted_target\\n-------------------\\n 6.407376822560477\\n```\\n\\nInternally, the model is trained by [libsvm](https://www.csie.ntu.edu.tw/~cjlin/libsvm/).\\n{func}`learn_libsvm_regressor` provides you a way to control the training process.\", \"Machine learning functions\": \":::{function} features(double, ...) -> map(bigint, double)\\nReturns the map representing the feature vector.\\n:::\\n\\n:::{function} learn_classifier(label, features) -> Classifier\\nReturns an SVM-based classifier model, trained with the given label and feature data sets.\\n:::\\n\\n:::{function} learn_libsvm_classifier(label, features, params) -> Classifier\\nReturns an SVM-based classifier model, trained with the given label and feature data sets.\\nYou can control the training process by libsvm parameters.\\n:::\\n\\n:::{function} classify(features, model) -> label\\nReturns a label predicted by the given classifier SVM model.\\n:::\\n\\n:::{function} learn_regressor(target, features) -> Regressor\\nReturns an SVM-based regressor model, trained with the given target and feature data sets.\\n:::\\n\\n:::{function} learn_libsvm_regressor(target, features, params) -> Regressor\\nReturns an SVM-based regressor model, trained with the given target and feature data sets.\\nYou can control the training process by libsvm parameters.\\n:::\\n\\n:::{function} regress(features, model) -> target\\nReturns a predicted target value by the given regressor SVM model.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 21]\"}, {\"title\": \"Quantile digest functions\", \"description\": null, \"content\": {\"Data structures\": \"A quantile digest is a data sketch which stores approximate percentile\\ninformation. The Trino type for this data structure is called `qdigest`,\\nand it takes a parameter which must be one of `bigint`, `double` or\\n`real` which represent the set of numbers that may be ingested by the\\n`qdigest`. They may be merged without losing precision, and for storage\\nand retrieval they may be cast to/from `VARBINARY`.\", \"Functions\": \":::{function} merge(qdigest) -> qdigest\\n:noindex: true\\n\\nMerges all input `qdigest`s into a single `qdigest`.\\n:::\\n\\n:::{function} value_at_quantile(qdigest(T), quantile) -> T\\nReturns the approximate percentile value from the quantile digest given\\nthe number `quantile` between 0 and 1.\\n:::\\n\\n:::{function} quantile_at_value(qdigest(T), T) -> quantile\\nReturns the approximate `quantile` number between 0 and 1 from the\\nquantile digest given an input value. Null is returned if the quantile digest\\nis empty or the input value is outside the range of the quantile digest.\\n:::\\n\\n:::{function} values_at_quantiles(qdigest(T), quantiles) -> array(T)\\nReturns the approximate percentile values as an array given the input\\nquantile digest and array of values between 0 and 1 which\\nrepresent the quantiles to return.\\n:::\\n\\n:::{function} qdigest_agg(x) -> qdigest([same as x])\\nReturns the `qdigest` which is composed of all input values of `x`.\\n:::\\n\\n:::{function} qdigest_agg(x, w) -> qdigest([same as x])\\n:noindex: true\\n\\nReturns the `qdigest` which is composed of all input values of `x` using\\nthe per-item weight `w`.\\n:::\\n\\n:::{function} qdigest_agg(x, w, accuracy) -> qdigest([same as x])\\n:noindex: true\\n\\nReturns the `qdigest` which is composed of all input values of `x` using\\nthe per-item weight `w` and maximum error of `accuracy`. `accuracy`\\nmust be a value greater than zero and less than one, and it must be constant\\nfor all input rows.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 22]\"}, {\"title\": \"Regexp\", \"description\": null, \"content\": {\"Regular expression functions\": \"All the regular expression functions use the [Java pattern] syntax,\\nwith a few notable exceptions:\\n\\n['When using multi-line mode (enabled via the `(?m)` flag),\\\\nonly `\\\\\\\\n` is recognized as a line terminator. Additionally,\\\\nthe `(?d)` flag is not supported and must not be used.', 'Case-insensitive matching (enabled via the `(?i)` flag) is always\\\\nperformed in a Unicode-aware manner. However, context-sensitive and\\\\nlocal-sensitive matching is not supported. Additionally, the\\\\n`(?u)` flag is not supported and must not be used.', 'Surrogate pairs are not supported. For example, `\\\\\\\\uD800\\\\\\\\uDC00` is\\\\nnot treated as `U+10000` and must be specified as `\\\\\\\\x{10000}`.', 'Boundaries (`\\\\\\\\b`) are incorrectly handled for a non-spacing mark\\\\nwithout a base character.', '`\\\\\\\\Q` and `\\\\\\\\E` are not supported in character classes\\\\n(such as `[A-Z123]`) and are instead treated as literals.', 'Unicode character classes (`\\\\\\\\p{prop}`) are supported with\\\\nthe following differences:', ['All underscores in names must be removed. For example, use\\\\n`OldItalic` instead of `Old_Italic`.', 'Scripts must be specified directly, without the\\\\n`Is`, `script=` or `sc=` prefixes.\\\\nExample: `\\\\\\\\p{Hiragana}`', 'Blocks must be specified with the `In` prefix.\\\\nThe `block=` and `blk=` prefixes are not supported.\\\\nExample: `\\\\\\\\p{Mongolian}`', 'Categories must be specified directly, without the `Is`,\\\\n`general_category=` or `gc=` prefixes.\\\\nExample: `\\\\\\\\p{L}`', 'Binary properties must be specified directly, without the `Is`.\\\\nExample: `\\\\\\\\p{NoncharacterCodePoint}`']]\\n\\n:::{function} regexp_count(string, pattern) -> bigint\\nReturns the number of occurrence of `pattern` in `string`:\\n\\n```\\nSELECT regexp_count('1a 2b 14m', '\\\\s*[a-z]+\\\\s*'); -- 3\\n```\\n\\n:::\\n\\n:::{function} regexp_extract_all(string, pattern) -> array(varchar)\\nReturns the substring(s) matched by the regular expression `pattern`\\nin `string`:\\n\\n```\\nSELECT regexp_extract_all('1a 2b 14m', '\\\\d+'); -- [1, 2, 14]\\n```\\n\\n:::\\n\\n:::{function} regexp_extract_all(string, pattern, group) -> array(varchar)\\n:noindex: true\\n\\nFinds all occurrences of the regular expression `pattern` in `string`\\nand returns the [capturing group number] `group`:\\n\\n```\\nSELECT regexp_extract_all('1a 2b 14m', '(\\\\d+)([a-z]+)', 2); -- ['a', 'b', 'm']\\n```\\n\\n:::\\n\\n:::{function} regexp_extract(string, pattern) -> varchar\\nReturns the first substring matched by the regular expression `pattern`\\nin `string`:\\n\\n```\\nSELECT regexp_extract('1a 2b 14m', '\\\\d+'); -- 1\\n```\\n\\n:::\\n\\n:::{function} regexp_extract(string, pattern, group) -> varchar\\n:noindex: true\\n\\nFinds the first occurrence of the regular expression `pattern` in\\n`string` and returns the [capturing group number] `group`:\\n\\n```\\nSELECT regexp_extract('1a 2b 14m', '(\\\\d+)([a-z]+)', 2); -- 'a'\\n```\\n\\n:::\\n\\n:::{function} regexp_like(string, pattern) -> boolean\\nEvaluates the regular expression `pattern` and determines if it is\\ncontained within `string`.\\n\\nThe `pattern` only needs to be contained within\\n`string`, rather than needing to match all of `string`. In other words,\\nthis performs a *contains* operation rather than a *match* operation. You can\\nmatch the entire string by anchoring the pattern using `^` and `$`:\\n\\n```\\nSELECT regexp_like('1a 2b 14m', '\\\\d+b'); -- true\\n```\\n\\n:::\\n\\n:::{function} regexp_position(string, pattern) -> integer\\nReturns the index of the first occurrence (counting from 1) of `pattern` in `string`.\\nReturns -1 if not found:\\n\\n```\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b'); -- 8\\n```\\n\\n:::\\n\\n:::{function} regexp_position(string, pattern, start) -> integer\\n:noindex: true\\n\\nReturns the index of the first occurrence of `pattern` in `string`,\\nstarting from `start` (include `start`). Returns -1 if not found:\\n\\n```\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b', 5); -- 8\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b', 12); -- 19\\n```\\n\\n:::\\n\\n:::{function} regexp_position(string, pattern, start, occurrence) -> integer\\n:noindex: true\\n\\nReturns the index of the nth `occurrence` of `pattern` in `string`,\\nstarting from `start` (include `start`). Returns -1 if not found:\\n\\n```\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b', 12, 1); -- 19\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b', 12, 2); -- 31\\nSELECT regexp_position('I have 23 apples, 5 pears and 13 oranges', '\\\\b\\\\d+\\\\b', 12, 3); -- -1\\n```\\n\\n:::\\n\\n:::{function} regexp_replace(string, pattern) -> varchar\\nRemoves every instance of the substring matched by the regular expression\\n`pattern` from `string`:\\n\\n```\\nSELECT regexp_replace('1a 2b 14m', '\\\\d+[ab] '); -- '14m'\\n```\\n\\n:::\\n\\n:::{function} regexp_replace(string, pattern, replacement) -> varchar\\n:noindex: true\\n\\nReplaces every instance of the substring matched by the regular expression\\n`pattern` in `string` with `replacement`. [Capturing groups] can be\\nreferenced in `replacement` using `$g` for a numbered group or\\n`${name}` for a named group. A dollar sign (`$`) may be included in the\\nreplacement by escaping it with a backslash (`\\\\$`):\\n\\n```\\nSELECT regexp_replace('1a 2b 14m', '(\\\\d+)([ab]) ', '3c$2 '); -- '3ca 3cb 14m'\\n```\\n\\n:::\\n\\n:::{function} regexp_replace(string, pattern, function) -> varchar\\n:noindex: true\\n\\nReplaces every instance of the substring matched by the regular expression\\n`pattern` in `string` using `function`. The {doc}`lambda expression <lambda>`\\n`function` is invoked for each match with the [capturing groups] passed as an\\narray. Capturing group numbers start at one; there is no group for the entire match\\n(if you need this, surround the entire expression with parenthesis).\\n\\n```\\nSELECT regexp_replace('new york', '(\\\\w)(\\\\w*)', x -> upper(x[1]) || lower(x[2])); --'New York'\\n```\\n\\n:::\\n\\n:::{function} regexp_split(string, pattern) -> array(varchar)\\nSplits `string` using the regular expression `pattern` and returns an\\narray. Trailing empty strings are preserved:\\n\\n```\\nSELECT regexp_split('1a 2b 14m', '\\\\s*[a-z]+\\\\s*'); -- [1, 2, 14, ]\\n```\\n\\n:::\\n\\n[capturing group number]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/regex/Pattern.html#gnumber\\n[capturing groups]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/regex/Pattern.html#cg\\n[java pattern]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/regex/Pattern.html\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 23]\"}, {\"title\": \"Session\", \"description\": null, \"content\": {\"Session information\": \"Functions providing information about the query execution environment.\\n\\n:::{data} current_user\\nReturns the current user running the query.\\n:::\\n\\n:::{function} current_groups\\nReturns the list of groups for the current user running the query.\\n:::\\n\\n:::{data} current_catalog\\nReturns a character string that represents the current catalog name.\\n:::\\n\\n::::{data} current_schema\\nReturns a character string that represents the current unqualified schema name.\\n\\n:::{note}\\nThis is part of the SQL standard and does not use parenthesis.\\n:::\\n::::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 24]\"}, {\"title\": \"Set Digest functions\", \"description\": null, \"content\": {\"Data structures\": \"Trino implements Set Digest data sketches by encapsulating the following components:\\n\\n['[HyperLogLog](https://wikipedia.org/wiki/HyperLogLog)', '[MinHash with a single hash function](http://wikipedia.org/wiki/MinHash#Variant_with_a_single_hash_function)']\\n\\nThe HyperLogLog structure is used for the approximation of the distinct elements\\nin the original set.\\n\\nThe MinHash structure is used to store a low memory footprint signature of the original set.\\nThe similarity of any two sets is estimated by comparing their signatures.\\n\\nThe Trino type for this data structure is called `setdigest`.\\nTrino offers the ability to merge multiple Set Digest data sketches.\", \"Serialization\": \"Data sketches can be serialized to and deserialized from `varbinary`. This\\nallows them to be stored for later use.\", \"Functions\": \":::{function} make_set_digest(x) -> setdigest\\nComposes all input values of `x` into a `setdigest`.\\n\\nCreate a `setdigest` corresponding to a `bigint` array:\\n\\n```\\nSELECT make_set_digest(value)\\nFROM (VALUES 1, 2, 3) T(value);\\n```\\n\\nCreate a `setdigest` corresponding to a `varchar` array:\\n\\n```\\nSELECT make_set_digest(value)\\nFROM (VALUES 'Trino', 'SQL', 'on', 'everything') T(value);\\n```\\n\\n:::\\n\\n:::{function} merge_set_digest(setdigest) -> setdigest\\nReturns the `setdigest` of the aggregate union of the individual `setdigest`\\nSet Digest structures.\\n:::\\n\\n(setdigest-cardinality)=\\n:::{function} cardinality(setdigest) -> long\\n:noindex: true\\n\\nReturns the cardinality of the set digest from its internal\\n`HyperLogLog` component.\\n\\nExamples:\\n\\n```\\nSELECT cardinality(make_set_digest(value))\\nFROM (VALUES 1, 2, 2, 3, 3, 3, 4, 4, 4, 4, 5) T(value);\\n-- 5\\n```\\n\\n:::\\n\\n:::{function} intersection_cardinality(x,y) -> long\\nReturns the estimation for the cardinality of the intersection of the two set digests.\\n\\n`x` and `y` must be of type `setdigest`\\n\\nExamples:\\n\\n```\\nSELECT intersection_cardinality(make_set_digest(v1), make_set_digest(v2))\\nFROM (VALUES (1, 1), (NULL, 2), (2, 3), (3, 4)) T(v1, v2);\\n-- 3\\n```\\n\\n:::\\n\\n:::{function} jaccard_index(x, y) -> double\\nReturns the estimation of [Jaccard index](https://wikipedia.org/wiki/Jaccard_index) for\\nthe two set digests.\\n\\n`x` and `y` must be of type `setdigest`.\\n\\nExamples:\\n\\n```\\nSELECT jaccard_index(make_set_digest(v1), make_set_digest(v2))\\nFROM (VALUES (1, 1), (NULL,2), (2, 3), (NULL, 4)) T(v1, v2);\\n-- 0.5\\n```\\n\\n:::\\n\\n:::{function} hash_counts(x) -> map(bigint, smallint)\\nReturns a map containing the [Murmur3Hash128](https://wikipedia.org/wiki/MurmurHash#MurmurHash3)\\nhashed values and the count of their occurences within\\nthe internal `MinHash` structure belonging to `x`.\\n\\n`x` must be of type `setdigest`.\\n\\nExamples:\\n\\n```\\nSELECT hash_counts(make_set_digest(value))\\nFROM (VALUES 1, 1, 1, 2, 2) T(value);\\n-- {19144387141682250=3, -2447670524089286488=2}\\n```\\n\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 25]\"}, {\"title\": \"String functions and operators\", \"description\": null, \"content\": {\"String operators\": \"The `||` operator performs concatenation.\\n\\nThe `LIKE` statement can be used for pattern matching and is documented in\\n{ref}`like-operator`.\", \"String functions\": \":::{note}\\nThese functions assume that the input strings contain valid UTF-8 encoded\\nUnicode code points. There are no explicit checks for valid UTF-8 and\\nthe functions may return incorrect results on invalid UTF-8.\\nInvalid UTF-8 data can be corrected with {func}`from_utf8`.\\n\\nAdditionally, the functions operate on Unicode code points and not user\\nvisible *characters* (or *grapheme clusters*). Some languages combine\\nmultiple code points into a single user-perceived *character*, the basic\\nunit of a writing system for a language, but the functions will treat each\\ncode point as a separate unit.\\n\\nThe {func}`lower` and {func}`upper` functions do not perform\\nlocale-sensitive, context-sensitive, or one-to-many mappings required for\\nsome languages. Specifically, this will return incorrect results for\\nLithuanian, Turkish and Azeri.\\n:::\\n\\n:::{function} chr(n) -> varchar\\nReturns the Unicode code point `n` as a single character string.\\n:::\\n\\n:::{function} codepoint(string) -> integer\\nReturns the Unicode code point of the only character of `string`.\\n:::\\n\\n:::{function} concat(string1, ..., stringN) -> varchar\\nReturns the concatenation of `string1`, `string2`, `...`, `stringN`.\\nThis function provides the same functionality as the\\nSQL-standard concatenation operator (`||`).\\n:::\\n\\n:::{function} concat_ws(string0, string1, ..., stringN) -> varchar\\nReturns the concatenation of `string1`, `string2`, `...`, `stringN`\\nusing `string0` as a separator. If `string0` is null, then the return\\nvalue is null. Any null values provided in the arguments after the\\nseparator are skipped.\\n:::\\n\\n:::{function} concat_ws(string0, array(varchar)) -> varchar\\n:noindex: true\\n\\nReturns the concatenation of elements in the array using `string0` as a\\nseparator. If `string0` is null, then the return value is null. Any\\nnull values in the array are skipped.\\n:::\\n\\n:::{function} format(format, args...) -> varchar\\n:noindex: true\\n\\nSee {func}`format`.\\n:::\\n\\n:::{function} hamming_distance(string1, string2) -> bigint\\nReturns the Hamming distance of `string1` and `string2`,\\ni.e. the number of positions at which the corresponding characters are different.\\nNote that the two strings must have the same length.\\n:::\\n\\n:::{function} length(string) -> bigint\\nReturns the length of `string` in characters.\\n:::\\n\\n:::{function} levenshtein_distance(string1, string2) -> bigint\\nReturns the Levenshtein edit distance of `string1` and `string2`,\\ni.e. the minimum number of single-character edits (insertions,\\ndeletions or substitutions) needed to change `string1` into `string2`.\\n:::\\n\\n:::{function} lower(string) -> varchar\\nConverts `string` to lowercase.\\n:::\\n\\n:::{function} lpad(string, size, padstring) -> varchar\\nLeft pads `string` to `size` characters with `padstring`.\\nIf `size` is less than the length of `string`, the result is\\ntruncated to `size` characters. `size` must not be negative\\nand `padstring` must be non-empty.\\n:::\\n\\n:::{function} ltrim(string) -> varchar\\nRemoves leading whitespace from `string`.\\n:::\\n\\n:::{function} luhn_check(string) -> boolean\\nTests whether a `string` of digits is valid according to the\\n[Luhn algorithm](https://wikipedia.org/wiki/Luhn_algorithm).\\n\\nThis checksum function, also known as `modulo 10` or `mod 10`, is\\nwidely applied on credit card numbers and government identification numbers\\nto distinguish valid numbers from mistyped, incorrect numbers.\\n\\nValid identification number:\\n\\n```\\nselect luhn_check('79927398713');\\n-- true\\n```\\n\\nInvalid identification number:\\n\\n```\\nselect luhn_check('79927398714');\\n-- false\\n```\\n\\n:::\\n\\n::::{function} position(substring IN string) -> bigint\\nReturns the starting position of the first instance of `substring` in\\n`string`. Positions start with `1`. If not found, `0` is returned.\\n\\n:::{note}\\nThis SQL-standard function has special syntax and uses the\\n`IN` keyword for the arguments. See also {func}`strpos`.\\n:::\\n::::\\n\\n:::{function} replace(string, search) -> varchar\\nRemoves all instances of `search` from `string`.\\n:::\\n\\n:::{function} replace(string, search, replace) -> varchar\\n:noindex: true\\n\\nReplaces all instances of `search` with `replace` in `string`.\\n:::\\n\\n:::{function} reverse(string) -> varchar\\nReturns `string` with the characters in reverse order.\\n:::\\n\\n:::{function} rpad(string, size, padstring) -> varchar\\nRight pads `string` to `size` characters with `padstring`.\\nIf `size` is less than the length of `string`, the result is\\ntruncated to `size` characters. `size` must not be negative\\nand `padstring` must be non-empty.\\n:::\\n\\n:::{function} rtrim(string) -> varchar\\nRemoves trailing whitespace from `string`.\\n:::\\n\\n:::{function} soundex(char) -> string\\n`soundex` returns a character string containing the phonetic representation of `char`.\\n\\n: It is typically used to evaluate the similarity of two expressions phonetically, that is\\nhow the string sounds when spoken:\\n\\n```\\nSELECT name\\nFROM nation\\nWHERE SOUNDEX(name) = SOUNDEX('CHYNA');\\n\\n name |\\n-------+----\\n CHINA |\\n(1 row)\\n```\\n\\n:::\\n\\n:::{function} split(string, delimiter) -> array(varchar)\\nSplits `string` on `delimiter` and returns an array.\\n:::\\n\\n:::{function} split(string, delimiter, limit) -> array(varchar)\\n:noindex: true\\n\\nSplits `string` on `delimiter` and returns an array of size at most\\n`limit`. The last element in the array always contain everything\\nleft in the `string`. `limit` must be a positive number.\\n:::\\n\\n:::{function} split_part(string, delimiter, index) -> varchar\\nSplits `string` on `delimiter` and returns the field `index`.\\nField indexes start with `1`. If the index is larger than\\nthe number of fields, then null is returned.\\n:::\\n\\n:::{function} split_to_map(string, entryDelimiter, keyValueDelimiter) -> map<varchar, varchar>\\nSplits `string` by `entryDelimiter` and `keyValueDelimiter` and returns a map.\\n`entryDelimiter` splits `string` into key-value pairs. `keyValueDelimiter` splits\\neach pair into key and value.\\n:::\\n\\n:::{function} split_to_multimap(string, entryDelimiter, keyValueDelimiter) -> map(varchar, array(varchar))\\nSplits `string` by `entryDelimiter` and `keyValueDelimiter` and returns a map\\ncontaining an array of values for each unique key. `entryDelimiter` splits `string`\\ninto key-value pairs. `keyValueDelimiter` splits each pair into key and value. The\\nvalues for each key will be in the same order as they appeared in `string`.\\n:::\\n\\n:::{function} strpos(string, substring) -> bigint\\nReturns the starting position of the first instance of `substring` in\\n`string`. Positions start with `1`. If not found, `0` is returned.\\n:::\\n\\n:::{function} strpos(string, substring, instance) -> bigint\\n:noindex: true\\n\\nReturns the position of the N-th `instance` of `substring` in `string`.\\nWhen `instance` is a negative number the search will start from the end of `string`.\\nPositions start with `1`. If not found, `0` is returned.\\n:::\\n\\n:::{function} starts_with(string, substring) -> boolean\\nTests whether `substring` is a prefix of `string`.\\n:::\\n\\n:::{function} substr(string, start) -> varchar\\nThis is an alias for {func}`substring`.\\n:::\\n\\n:::{function} substring(string, start) -> varchar\\nReturns the rest of `string` from the starting position `start`.\\nPositions start with `1`. A negative starting position is interpreted\\nas being relative to the end of the string.\\n:::\\n\\n:::{function} substr(string, start, length) -> varchar\\n:noindex: true\\n\\nThis is an alias for {func}`substring`.\\n:::\\n\\n:::{function} substring(string, start, length) -> varchar\\n:noindex: true\\n\\nReturns a substring from `string` of length `length` from the starting\\nposition `start`. Positions start with `1`. A negative starting\\nposition is interpreted as being relative to the end of the string.\\n:::\\n\\n:::{function} translate(source, from, to) -> varchar\\nReturns the `source` string translated by replacing characters found in the\\n`from` string with the corresponding characters in the `to` string. If the `from`\\nstring contains duplicates, only the first is used. If the `source` character\\ndoes not exist in the `from` string, the `source` character will be copied\\nwithout translation. If the index of the matching character in the `from`\\nstring is beyond the length of the `to` string, the `source` character will\\nbe omitted from the resulting string.\\n\\nHere are some examples illustrating the translate function:\\n\\n```\\nSELECT translate('abcd', '', ''); -- 'abcd'\\nSELECT translate('abcd', 'a', 'z'); -- 'zbcd'\\nSELECT translate('abcda', 'a', 'z'); -- 'zbcdz'\\nSELECT translate('Palho\\u00e7a', '\\u00e7','c'); -- 'Palhoca'\\nSELECT translate('abcd', 'b', U&'\\\\+01F600'); -- a\\ud83d\\ude00cd\\nSELECT translate('abcd', 'a', ''); -- 'bcd'\\nSELECT translate('abcd', 'a', 'zy'); -- 'zbcd'\\nSELECT translate('abcd', 'ac', 'z'); -- 'zbd'\\nSELECT translate('abcd', 'aac', 'zq'); -- 'zbd'\\n```\\n\\n:::\\n\\n:::{function} trim(string) -> varchar\\n:noindex: true\\n\\nRemoves leading and trailing whitespace from `string`.\\n:::\\n\\n:::{function} trim( [ [ specification ] [ string ] FROM ] source ) -> varchar\\nRemoves any leading and/or trailing characters as specified up to and\\nincluding `string` from `source`:\\n\\n```\\nSELECT trim('!' FROM '!foo!'); -- 'foo'\\nSELECT trim(LEADING FROM ' abcd'); -- 'abcd'\\nSELECT trim(BOTH '$' FROM '$var$'); -- 'var'\\nSELECT trim(TRAILING 'ER' FROM upper('worker')); -- 'WORK'\\n```\\n\\n:::\\n\\n:::{function} upper(string) -> varchar\\nConverts `string` to uppercase.\\n:::\\n\\n:::{function} word_stem(word) -> varchar\\nReturns the stem of `word` in the English language.\\n:::\\n\\n:::{function} word_stem(word, lang) -> varchar\\n:noindex: true\\n\\nReturns the stem of `word` in the `lang` language.\\n:::\", \"Unicode functions\": \":::{function} normalize(string) -> varchar\\nTransforms `string` with NFC normalization form.\\n:::\\n\\n::::{function} normalize(string, form) -> varchar\\n:noindex: true\\n\\nTransforms `string` with the specified normalization form.\\n`form` must be one of the following keywords:\\n\\n| Form | Description |\\n| ------ | -------------------------------------------------------------- |\\n| `NFD` | Canonical Decomposition |\\n| `NFC` | Canonical Decomposition, followed by Canonical Composition |\\n| `NFKD` | Compatibility Decomposition |\\n| `NFKC` | Compatibility Decomposition, followed by Canonical Composition |\\n\\n:::{note}\\nThis SQL-standard function has special syntax and requires\\nspecifying `form` as a keyword, not as a string.\\n:::\\n::::\\n\\n:::{function} to_utf8(string) -> varbinary\\nEncodes `string` into a UTF-8 varbinary representation.\\n:::\\n\\n:::{function} from_utf8(binary) -> varchar\\nDecodes a UTF-8 encoded string from `binary`. Invalid UTF-8 sequences\\nare replaced with the Unicode replacement character `U+FFFD`.\\n:::\\n\\n:::{function} from_utf8(binary, replace) -> varchar\\n:noindex: true\\n\\nDecodes a UTF-8 encoded string from `binary`. Invalid UTF-8 sequences\\nare replaced with `replace`. The replacement string `replace` must either\\nbe a single character or empty (in which case invalid characters are\\nremoved).\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 26]\"}, {\"title\": \"System\", \"description\": null, \"content\": {\"System information\": \"Functions providing information about the Trino cluster system environment. More\\ninformation is available by querying the various schemas and tables exposed by\\nthe {doc}`/connector/system`.\\n\\n:::{function} version() -> varchar\\nReturns the Trino version used on the cluster. Equivalent to the value of\\nthe `node_version` column in the `system.runtime.nodes` table.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 27]\"}, {\"title\": \"Table functions\", \"description\": null, \"content\": {\"Built-in table functions\": {\"`exclude_columns` table function\": \"Use the `exclude_columns` table function to return a new table based on an input\\ntable `table`, with the exclusion of all columns specified in `descriptor`:\\n\\n:::{function} exclude_columns(input => table, columns => descriptor) -> table\\n:noindex: true\\n\\nThe argument `input` is a table or a query.\\nThe argument `columns` is a descriptor without types.\\n:::\\n\\nExample query using the orders table from the TPC-H dataset, provided by the\\n[](/connector/tpch):\\n\\n```\\nSELECT *\\nFROM TABLE(exclude_columns(\\n input => TABLE(orders),\\n columns => DESCRIPTOR(clerk, comment)));\\n```\\n\\nThe table function is useful for queries where you want to return nearly all\\ncolumns from tables with many columns. You can avoid enumerating all columns,\\nand only need to specify the columns to exclude.\\n\\n(sequence-table-function)=\", \"`sequence` table function\": \"Use the `sequence` table function to return a table with a single column\\n`sequential_number` containing a sequence of bigint:\\n\\n:::{function} sequence(start => bigint, stop => bigint, step => bigint) -> table(sequential_number bigint)\\n:noindex: true\\n\\n`start` is the first element in the sequence. The default value is `0`.\\n\\n`stop` is the end of the range, inclusive. The last element in the\\nsequence is equal to `stop`, or it is the last value within range,\\nreachable by steps.\\n\\n`step` is the difference between subsequent values. The default value is\\n`1`.\\n:::\\n\\nExample query:\\n\\n```\\nSELECT *\\nFROM TABLE(sequence(\\n start => 1000000,\\n stop => -2000000,\\n step => -3));\\n```\\n\\nThe result of the `sequence` table function might not be ordered. If required,\\nenforce ordering in the enclosing query:\\n\\n```\\nSELECT *\\nFROM TABLE(sequence(\\n start => 0,\\n stop => 100,\\n step => 5))\\nORDER BY sequential_number;\\n```\"}, \"Table function invocation\": {\"Function resolution\": \"Every table function is provided by a catalog, and it belongs to a schema in\\nthe catalog. You can qualify the function name with a schema name, or with\\ncatalog and schema names:\\n\\n```\\nSELECT * FROM TABLE(schema_name.my_function(1, 100))\\nSELECT * FROM TABLE(catalog_name.schema_name.my_function(1, 100))\\n```\\n\\nOtherwise, the standard Trino name resolution is applied. The connection\\nbetween the function and the catalog must be identified, because the function\\nis executed by the corresponding connector. If the function is not registered\\nby the specified catalog, the query fails.\\n\\nThe table function name is resolved case-insensitive, analogically to scalar\\nfunction and table resolution in Trino.\", \"Arguments\": \"There are three types of arguments.\\n\\n['Scalar arguments']\\n\\nThey must be constant expressions, and they can be of any SQL type, which is\\ncompatible with the declared argument type:\\n\\n```\\nfactor => 42\\n```\\n\\n['Descriptor arguments']\\n\\nDescriptors consist of fields with names and optional data types:\\n\\n```\\nschema => DESCRIPTOR(id BIGINT, name VARCHAR)\\ncolumns => DESCRIPTOR(date, status, comment)\\n```\\n\\nTo pass `null` for a descriptor, use:\\n\\n```\\nschema => CAST(null AS DESCRIPTOR)\\n```\\n\\n['Table arguments']\\n\\nYou can pass a table name, or a query. Use the keyword `TABLE`:\\n\\n```\\ninput => TABLE(orders)\\ndata => TABLE(SELECT * FROM region, nation WHERE region.regionkey = nation.regionkey)\\n```\\n\\nIf the table argument is declared as {ref}`set semantics<tf-set-or-row-semantics>`,\\nyou can specify partitioning and ordering. Each partition is processed\\nindependently by the table function. If you do not specify partitioning, the\\nargument is processed as a single partition. You can also specify\\n`PRUNE WHEN EMPTY` or `KEEP WHEN EMPTY`. With `PRUNE WHEN EMPTY` you\\ndeclare that you are not interested in the function result if the argument is\\nempty. This information is used by the Trino engine to optimize the query. The\\n`KEEP WHEN EMPTY` option indicates that the function should be executed even\\nif the table argument is empty. By specifying `KEEP WHEN EMPTY` or\\n`PRUNE WHEN EMPTY`, you override the property set for the argument by the\\nfunction author.\\n\\nThe following example shows how the table argument properties should be ordered:\\n\\n```\\ninput => TABLE(orders)\\n PARTITION BY orderstatus\\n KEEP WHEN EMPTY\\n ORDER BY orderdate\\n```\", \"Argument passing conventions\": \"There are two conventions of passing arguments to a table function:\\n\\n['**Arguments passed by name**:', '```\\\\nSELECT * FROM TABLE(my_function(row_count => 100, column_count => 1))\\\\n```']\\n\\nIn this convention, you can pass the arguments in arbitrary order. Arguments\\ndeclared with default values can be skipped. Argument names are resolved\\ncase-sensitive, and with automatic uppercasing of unquoted names.\\n\\n['**Arguments passed positionally**:', '```\\\\nSELECT * FROM TABLE(my_function(1, 100))\\\\n```']\\n\\nIn this convention, you must follow the order in which the arguments are\\ndeclared. You can skip a suffix of the argument list, provided that all the\\nskipped arguments are declared with default values.\\n\\nYou cannot mix the argument conventions in one invocation.\\n\\nYou can also use parameters in arguments:\\n\\n```\\nPREPARE stmt FROM\\nSELECT * FROM TABLE(my_function(row_count => ? + 1, column_count => ?));\\n\\nEXECUTE stmt USING 100, 1;\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 28]\"}, {\"title\": \"T-Digest functions\", \"description\": null, \"content\": {\"Data structures\": \"A T-digest is a data sketch which stores approximate percentile\\ninformation. The Trino type for this data structure is called `tdigest`.\\nT-digests can be merged, and for storage and retrieval they can be cast\\nto and from `VARBINARY`.\", \"Functions\": \":::{function} merge(tdigest) -> tdigest\\n:noindex: true\\n\\nAggregates all inputs into a single `tdigest`.\\n:::\\n\\n:::{function} value_at_quantile(tdigest, quantile) -> double\\n:noindex: true\\n\\nReturns the approximate percentile value from the T-digest, given\\nthe number `quantile` between 0 and 1.\\n:::\\n\\n:::{function} values_at_quantiles(tdigest, quantiles) -> array(double)\\n:noindex: true\\n\\nReturns the approximate percentile values as an array, given the input\\nT-digest and an array of values between 0 and 1, which\\nrepresent the quantiles to return.\\n:::\\n\\n:::{function} tdigest_agg(x) -> tdigest\\nComposes all input values of `x` into a `tdigest`. `x` can be\\nof any numeric type.\\n:::\\n\\n:::{function} tdigest_agg(x, w) -> tdigest\\n:noindex: true\\n\\nComposes all input values of `x` into a `tdigest` using\\nthe per-item weight `w`. `w` must be greater or equal than 1.\\n`x` and `w` can be of any numeric type.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 29]\"}, {\"title\": \"Teradata functions\", \"description\": null, \"content\": {\"String functions\": \":::{function} char2hexint(string) -> varchar\\nReturns the hexadecimal representation of the UTF-16BE encoding of the string.\\n:::\\n\\n:::{function} index(string, substring) -> bigint\\nAlias for {func}`strpos` function.\\n:::\", \"Date functions\": \"The functions in this section use a format string that is compatible with\\nthe Teradata datetime functions. The following table, based on the\\nTeradata reference manual, describes the supported format specifiers:\\n\\n| Specifier | Description |\\n| ------------- | ---------------------------------- |\\n| `- / , . ; :` | Punctuation characters are ignored |\\n| `dd` | Day of month (1-31) |\\n| `hh` | Hour of day (1-12) |\\n| `hh24` | Hour of the day (0-23) |\\n| `mi` | Minute (0-59) |\\n| `mm` | Month (01-12) |\\n| `ss` | Second (0-59) |\\n| `yyyy` | 4-digit year |\\n| `yy` | 2-digit year |\\n\\n:::{warning}\\nCase insensitivity is not currently supported. All specifiers must be lowercase.\\n:::\\n\\n:::{function} to_char(timestamp, format) -> varchar\\nFormats `timestamp` as a string using `format`.\\n:::\\n\\n:::{function} to_timestamp(string, format) -> timestamp\\nParses `string` into a `TIMESTAMP` using `format`.\\n:::\\n\\n:::{function} to_date(string, format) -> date\\nParses `string` into a `DATE` using `format`.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 30]\"}, {\"title\": \"URL functions\", \"description\": null, \"content\": {\"Extraction functions\": \"The URL extraction functions extract components from HTTP URLs\\n(or any valid URIs conforming to {rfc}`2396`).\\nThe following syntax is supported:\\n\\n```\\n[protocol:][//host[:port]][path][?query][#fragment]\\n```\\n\\nThe extracted components do not contain URI syntax separators\\nsuch as `:` or `?`.\\n\\n:::{function} url_extract_fragment(url) -> varchar\\nReturns the fragment identifier from `url`.\\n:::\\n\\n:::{function} url_extract_host(url) -> varchar\\nReturns the host from `url`.\\n:::\\n\\n:::{function} url_extract_parameter(url, name) -> varchar\\nReturns the value of the first query string parameter named `name`\\nfrom `url`. Parameter extraction is handled in the typical manner\\nas specified by {rfc}`1866#section-8.2.1`.\\n:::\\n\\n:::{function} url_extract_path(url) -> varchar\\nReturns the path from `url`.\\n:::\\n\\n:::{function} url_extract_port(url) -> bigint\\nReturns the port number from `url`.\\n:::\\n\\n:::{function} url_extract_protocol(url) -> varchar\\nReturns the protocol from `url`:\\n\\n```\\nSELECT url_extract_protocol('http://localhost:8080/req_path');\\n-- http\\n\\nSELECT url_extract_protocol('https://127.0.0.1:8080/req_path');\\n-- https\\n\\nSELECT url_extract_protocol('ftp://path/file');\\n-- ftp\\n```\\n\\n:::\\n\\n:::{function} url_extract_query(url) -> varchar\\nReturns the query string from `url`.\\n:::\", \"Encoding functions\": \":::{function} url_encode(value) -> varchar\\nEscapes `value` by encoding it so that it can be safely included in\\nURL query parameter names and values:\\n\\n['Alphanumeric characters are not encoded.', 'The characters `.`, `-`, `*` and `_` are not encoded.', 'The ASCII space character is encoded as `+`.', 'All other characters are converted to UTF-8 and the bytes are encoded\\\\nas the string `%XX` where `XX` is the uppercase hexadecimal\\\\nvalue of the UTF-8 byte.\\\\n:::']\\n\\n:::{function} url_decode(value) -> varchar\\nUnescapes the URL encoded `value`.\\nThis function is the inverse of {func}`url_encode`.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 31]\"}, {\"title\": \"Uuid\", \"description\": null, \"content\": {\"UUID functions\": \":::{function} uuid() -> uuid\\nReturns a pseudo randomly generated {ref}`uuid-type` (type 4).\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 32]\"}, {\"title\": \"Window functions\", \"description\": null, \"content\": {\"Aggregate functions\": \"All {doc}`aggregate` can be used as window functions by adding the `OVER`\\nclause. The aggregate function is computed for each row over the rows within the\\ncurrent row's window frame. Note that [ordering during\\naggregation](aggregate-function-ordering-during-aggregation) is not supported.\\n\\nFor example, the following query produces a rolling sum of order prices\\nby day for each clerk:\\n\\n```\\nSELECT clerk, orderdate, orderkey, totalprice,\\n sum(totalprice) OVER (PARTITION BY clerk\\n ORDER BY orderdate) AS rolling_sum\\nFROM orders\\nORDER BY clerk, orderdate, orderkey\\n```\", \"Ranking functions\": \":::{function} cume_dist() -> bigint\\nReturns the cumulative distribution of a value in a group of values.\\nThe result is the number of rows preceding or peer with the row in the\\nwindow ordering of the window partition divided by the total number of\\nrows in the window partition. Thus, any tie values in the ordering will\\nevaluate to the same distribution value. The window frame must not be \\nspecified.\\n:::\\n\\n:::{function} dense_rank() -> bigint\\nReturns the rank of a value in a group of values. This is similar to\\n{func}`rank`, except that tie values do not produce gaps in the sequence.\\nThe window frame must not be specified.\\n:::\\n\\n:::{function} ntile(n) -> bigint\\nDivides the rows for each window partition into `n` buckets ranging\\nfrom `1` to at most `n`. Bucket values will differ by at most `1`.\\nIf the number of rows in the partition does not divide evenly into the\\nnumber of buckets, then the remainder values are distributed one per\\nbucket, starting with the first bucket.\\n\\nFor example, with `6` rows and `4` buckets, the bucket values would\\nbe as follows: `1` `1` `2` `2` `3` `4`\\n\\nFor the {func}`ntile` function, the window frame must not be specified.\\n:::\\n\\n:::{function} percent_rank() -> double\\nReturns the percentage ranking of a value in group of values. The result\\nis `(r - 1) / (n - 1)` where `r` is the {func}`rank` of the row and\\n`n` is the total number of rows in the window partition. The window frame \\nmust not be specified.\\n:::\\n\\n:::{function} rank() -> bigint\\nReturns the rank of a value in a group of values. The rank is one plus\\nthe number of rows preceding the row that are not peer with the row.\\nThus, tie values in the ordering will produce gaps in the sequence.\\nThe ranking is performed for each window partition. The window frame must \\nnot be specified.\\n:::\\n\\n:::{function} row_number() -> bigint\\nReturns a unique, sequential number for each row, starting with one,\\naccording to the ordering of rows within the window partition. \\nThe window frame must not be specified.\\n:::\", \"Value functions\": \"By default, null values are respected. If `IGNORE NULLS` is specified, all rows where\\n`x` is null are excluded from the calculation. If `IGNORE NULLS` is specified and `x`\\nis null for all rows, the `default_value` is returned, or if it is not specified,\\n`null` is returned.\\n\\n:::{function} first_value(x) -> [same as input]\\nReturns the first value of the window.\\n:::\\n\\n:::{function} last_value(x) -> [same as input]\\nReturns the last value of the window.\\n:::\\n\\n:::{function} nth_value(x, offset) -> [same as input]\\nReturns the value at the specified offset from the beginning of the window.\\nOffsets start at `1`. The offset can be any scalar\\nexpression. If the offset is null or greater than the number of values in\\nthe window, `null` is returned. It is an error for the offset to be zero or\\nnegative.\\n:::\\n\\n:::{function} lead(x[, offset [, default_value]]) -> [same as input]\\nReturns the value at `offset` rows after the current row in the window partition.\\nOffsets start at `0`, which is the current row. The\\noffset can be any scalar expression. The default `offset` is `1`. If the\\noffset is null, an error is raised. If the offset refers to a row that is not\\nwithin the partition, the `default_value` is returned, or if it is not specified\\n`null` is returned.\\nThe {func}`lead` function requires that the window ordering be specified.\\nWindow frame must not be specified.\\n:::\\n\\n:::{function} lag(x[, offset [, default_value]]) -> [same as input]\\nReturns the value at `offset` rows before the current row in the window partition.\\nOffsets start at `0`, which is the current row. The\\noffset can be any scalar expression. The default `offset` is `1`. If the\\noffset is null, an error is raised. If the offset refers to a row that is not\\nwithin the partition, the `default_value` is returned, or if it is not specified\\n`null` is returned.\\nThe {func}`lag` function requires that the window ordering be specified.\\nWindow frame must not be specified.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22, \\\"subpages\\\", 33]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 22]\"}, {\"title\": \"Installation\", \"description\": \"Documentation section: installation\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/installation\"}, \"subpages\": [{\"title\": \"Trino in a Docker container\", \"description\": null, \"content\": {\"Running the container\": \"To run Trino in Docker, you must have the Docker engine installed on your\\nmachine. You can download Docker from the [Docker website](https://www.docker.com),\\nor use the packaging system of your operating systems.\\n\\nUse the `docker` command to create a container from the `trinodb/trino`\\nimage. Assign it the `trino` name, to make it easier to reference it later.\\nRun it in the background, and map the default Trino port, which is 8080,\\nfrom inside the container to port 8080 on your workstation.\\n\\n```\\ndocker run --name trino -d -p 8080:8080 trinodb/trino\\n```\\n\\nWithout specifying the container image tag, it defaults to `latest`,\\nbut a number of any released Trino version can be used, for example\\n`trinodb/trino:|trino_version|`.\\n\\nRun `docker ps` to see all the containers running in the background.\\n\\n```\\n% docker ps\\nCONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES\\n955c3b3d3d0a trinodb/trino:390 \\\"/usr/lib/trino/bin/\\u2026\\\" 39 hours ago Up 39 hours (healthy) 0.0.0.0:8080->8080/tcp trino\\n```\\n\\nWhen Trino is still starting, it shows `(health: starting)`,\\nand `(healthy)` when it's ready.\\n\\n:::{note}\\nThere are multiple ways to use Trino within containers. You can either run\\nTrino in Docker containers locally, as explained in the following sections,\\nor use a container orchestration platform like Kubernetes. For the Kubernetes\\ninstructions see {doc}`/installation/kubernetes`.\\n:::\", \"Executing queries\": \"The image includes the Trino command-line interface (CLI) client, `trino`.\\nExecute it in the existing container to connect to the Trino server running\\ninside it. After starting the client, type and execute a query on a table\\nof the `tpch` catalog, which includes example data:\\n\\n```\\n$ docker exec -it trino trino\\ntrino> select count(*) from tpch.sf1.nation;\\n _col0\\n-------\\n 25\\n(1 row)\\n\\nQuery 20181105_001601_00002_e6r6y, FINISHED, 1 node\\nSplits: 21 total, 21 done (100.00%)\\n0:06 [25 rows, 0B] [4 rows/s, 0B/s]\\n```\\n\\nOnce you are done with your exploration, enter the `quit` command.\\n\\nAlternatively, you can use the Trino CLI installed directly on your workstation.\\nThe default server URL in the CLI of <http://localhost:8080> matches the port used\\nin the command to start the container. More information about using the CLI can\\nbe found in {doc}`/client/cli`. You can also connect with any other client\\napplication using the {doc}`/client/jdbc`.\", \"Configuring Trino\": \"The image already contains a default configuration to get started, and some\\ncatalogs to allow you to explore Trino. You can also use the container with your\\ncustom configuration files in a local `etc` directory structure as created in\\nthe {doc}`/installation/deployment`. If you mount this directory as a volume\\nin the path `/etc/trino` when starting the container, your configuration\\nis used instead of the default in the image.\\n\\n```\\n$ docker run --name trino -d -p 8080:8080 --volume $PWD/etc:/etc/trino trinodb/trino\\n```\\n\\nTo keep the default configuration and only configure catalogs, mount a folder\\nat `/etc/trino/catalog`, or individual catalog property files in it.\\n\\nIf you want to use additional plugins, mount them at `/usr/lib/trino/plugin`.\\n\\nTo avoid having to create catalog files and mount them in the container,\\nyou can enable dynamic catalog management by setting the `CATALOG_MANAGEMENT`\\nenvironmental variable to `dynamic`.\\n\\n```\\n$ docker run --name trino -d -p 8080:8080 -e CATALOG_MANAGEMENT=dynamic trinodb/trino\\n```\\n\\nAfter connecting to Trino, execute {ref}`sql-catalog-management` statements to\\ncreate drop catalogs as desired. To make these changes persistent across\\ncontainer restarts, a volume must be mounted at `/etc/trino/catalog`.\", \"Cleaning up\": \"You can stop and start the container, using the `docker stop trino` and\\n`docker start trino` commands. To fully remove the stopped container, run\\n`docker rm trino`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 0]\"}, {\"title\": \"Deploying Trino\", \"description\": null, \"content\": {\"Requirements\": {\"Linux operating system\": [\"64-bit required\", \"newer release preferred, especially when running on containers\", \"adequate ulimits for the user that runs the Trino process. These limits may\\ndepend on the specific Linux distribution you are using. The number of open\\nfile descriptors needed for a particular Trino instance scales as roughly the\\nnumber of machines in the cluster, times some factor depending on the\\nworkload. The `nofile` limit sets the maximum number of file descriptors\\nthat a process can have, while the `nproc` limit restricts the number of\\nprocesses, and therefore threads on the JVM, a user can create. We recommend\\nsetting limits to the following values at a minimum. Typically, this\\nconfiguration is located in `/etc/security/limits.conf`:\", \"```\\ntrino soft nofile 131072\\ntrino hard nofile 131072\\ntrino soft nproc 128000\\ntrino hard nproc 128000\\n```\"], \"Java runtime environment\": \"Trino requires a 64-bit version of Java 24, with a minimum required version of\\n24.0.1 and a recommendation to use the latest patch version. Earlier versions\\nsuch as Java 8, Java 11, Java 17, Java 21 or Java 23 do not work.\\nNewer versions such as Java 25 are not supported -- they may work, but are not tested.\\n\\nWe recommend using the Eclipse Temurin OpenJDK distribution from\\n[Adoptium](https://adoptium.net/) as the JDK for Trino, as Trino is tested\\nagainst that distribution. Eclipse Temurin is also the JDK used by the [Trino\\nDocker image](https://hub.docker.com/r/trinodb/trino).\"}, \"Installing Trino\": \"Download the Trino server tarball, {maven_download}`server`, and unpack it. The\\ntarball contains a single top-level directory, `trino-server-|trino_version|`,\\nwhich we call the *installation* directory.\\n\\nThe default tarball contains all plugins and must be configured for use. The\\nminimal `server-core` tarball, {maven_download}`server-core`, contains a minimal\\nset of essential plugins, and it is therefore mostly suitable as a base for\\ncustom tarball creation.\\n\\nThe [trino-packages project](https://github.com/trinodb/trino-packages) includes\\na module to create a fully configured tarball with an example configuration. The\\ncustom tarball is ready to use and can be further configured and adjusted to\\nyour needs.\\n\\nTrino needs a *data* directory for storing logs, etc. By default, an\\ninstallation from the tarball uses the same location for the installation and data\\ndirectories.\\n\\nWe recommend creating a data directory outside the installation directory,\\nwhich allows it to be easily preserved when upgrading Trino. This directory path\\nmust be configured with the [](node-properties).\\n\\nThe user that runs the Trino process must have full read access to the\\ninstallation directory, and read and write access to the data directory.\", \"Configuring Trino\": {\"Node properties\": \"The node properties file, `etc/node.properties`, contains configuration\\nspecific to each node. A *node* is a single installed instance of Trino\\non a machine. This file is typically created by the deployment system when\\nTrino is first installed. The following is a minimal `etc/node.properties`:\\n\\n```\\nnode.environment=production\\nnode.id=ffffffff-ffff-ffff-ffff-ffffffffffff\\nnode.data-dir=/var/trino/data\\n```\\n\\nThe above properties are described below:\\n\\n['`node.environment`:\\\\nThe name of the environment. All Trino nodes in a cluster must have the same\\\\nenvironment name. The name must start with a lowercase alphanumeric character\\\\nand only contain lowercase alphanumeric or underscore (`_`) characters.', '`node.id`:\\\\nThe unique identifier for this installation of Trino. This must be\\\\nunique for every node. This identifier should remain consistent across\\\\nreboots or upgrades of Trino. If running multiple installations of\\\\nTrino on a single machine (i.e. multiple nodes on the same machine),\\\\neach installation must have a unique identifier. The identifier must start\\\\nwith an alphanumeric character and only contain alphanumeric, `-`, or `_`\\\\ncharacters.', '`node.data-dir`:\\\\nThe location (filesystem path) of the data directory. Trino stores\\\\nlogs and other data here.']\\n\\n(jvm-config)=\", \"JVM config\": {\"Temporary directory\": \"The temporary directory used by the JVM must allow execution of code, because\\nTrino accesses and uses shared library binaries for purposes such as\\n[](file-compression).\\n\\nSpecifically, the partition mount and directory must not have the `noexec` flag\\nset. The default `/tmp` directory is mounted with this flag in some operating\\nsystem installations, which prevents Trino from starting. You can work around\\nthis by overriding the temporary directory by adding\\n`-Djava.io.tmpdir=/path/to/other/tmpdir` to the list of JVM options.\\n\\n(config-properties)=\"}, \"Config properties\": \"The config properties file, `etc/config.properties`, contains the\\nconfiguration for the Trino server. Every Trino server can function as both a\\ncoordinator and a worker. A cluster is required to include one coordinator, and\\ndedicating a machine to only perform coordination work provides the best\\nperformance on larger clusters. Scaling and parallelization is achieved by using\\nmany workers.\\n\\nThe following is a minimal configuration for the coordinator:\\n\\n```\\ncoordinator=true\\nnode-scheduler.include-coordinator=false\\nhttp-server.http.port=8080\\ndiscovery.uri=http://example.net:8080\\n```\\n\\nAnd this is a minimal configuration for the workers:\\n\\n```\\ncoordinator=false\\nhttp-server.http.port=8080\\ndiscovery.uri=http://example.net:8080\\n```\\n\\nAlternatively, if you are setting up a single machine for testing, that\\nfunctions as both a coordinator and worker, use this configuration:\\n\\n```\\ncoordinator=true\\nnode-scheduler.include-coordinator=true\\nhttp-server.http.port=8080\\ndiscovery.uri=http://example.net:8080\\n```\\n\\nThese properties require some explanation:\\n\\n['`coordinator`:\\\\nAllow this Trino instance to function as a coordinator, so to\\\\naccept queries from clients and manage query execution.', \\\"`node-scheduler.include-coordinator`:\\\\nAllow scheduling work on the coordinator.\\\\nFor larger clusters, processing work on the coordinator\\\\ncan impact query performance because the machine's resources are not\\\\navailable for the critical task of scheduling, managing and monitoring\\\\nquery execution.\\\", '`http-server.http.port`:\\\\nSpecifies the port for the [HTTP server](/admin/properties-http-server).\\\\nTrino uses HTTP for all communication, internal and external.', '`discovery.uri`:\\\\nThe Trino coordinator has a discovery service that is used by all the nodes\\\\nto find each other. Every Trino instance registers itself with the discovery\\\\nservice on startup and continuously heartbeats to keep its registration\\\\nactive. The discovery service shares the HTTP server with Trino and thus\\\\nuses the same port. Replace `example.net:8080` to match the host and\\\\nport of the Trino coordinator. If you have disabled HTTP on the coordinator,\\\\nthe URI scheme must be `https`, not `http`.']\\n\\nThe above configuration properties are a *minimal set* to help you get started.\\nAll additional configuration is optional and varies widely based on the specific\\ncluster and supported use cases. The {doc}`/admin` and {doc}`/security` sections\\ncontain documentation for many aspects, including {doc}`/admin/resource-groups`\\nfor configuring queuing policies and {doc}`/admin/fault-tolerant-execution`.\\n\\nThe {doc}`/admin/properties` provides a comprehensive list of the supported\\nproperties for topics such as {doc}`/admin/properties-general`,\\n{doc}`/admin/properties-resource-management`,\\n{doc}`/admin/properties-query-management`,\\n{doc}`/admin/properties-web-interface`, and others.\\n\\nFurther configuration can include [](/admin/logging), [](/admin/opentelemetry),\\n[](/admin/jmx), [](/admin/openmetrics), and other functionality described in the\\n[](/admin) section.\\n\\n(catalog-properties)=\", \"Catalog properties\": \"Trino accesses data in a [data source](trino-concept-data-source) with a\\n[connector](trino-concept-connector), which is configured in a\\n[catalog](trino-concept-catalog). The connector provides all the schemas and\\ntables inside the catalog.\\n\\nFor example, the Hive connector maps each Hive database to a schema. If the Hive\\nconnector is configured in the `example` catalog, and Hive contains a table\\n`clicks` in the database `web`, that table can be accessed in Trino as\\n`example.web.clicks`.\\n\\nCatalogs are registered by creating a catalog properties file\\nin the `etc/catalog` directory.\\nFor example, create `etc/catalog/jmx.properties` with the following\\ncontents to mount the `jmx` connector as the `jmx` catalog:\\n\\n```\\nconnector.name=jmx\\n```\\n\\nSee {doc}`/connector` for more information about configuring catalogs.\\n\\n(running-trino)=\"}, \"Running Trino\": \"The installation provides a `bin/launcher` script that can be used manually \\nor as a daemon startup script. It accepts the following commands:\\n\\n:::{list-table} `launcher` commands\\n:widths: 15, 85\\n:header-rows: 1\\n\\n[['Command', 'Action'], ['`run`', 'Starts the server in the foreground and leaves it running. To shut down\\\\nthe server, use Ctrl+C in this terminal or the `stop` command from\\\\nanother terminal.'], ['`start`', 'Starts the server as a daemon and returns its process ID.'], ['`stop`', 'Shuts down a server started with either `start` or `run`. Sends the\\\\nSIGTERM signal.'], ['`restart`', 'Stops then restarts a running server, or starts a stopped server,\\\\nassigning a new process ID.'], ['`kill`', 'Shuts down a possibly hung server by sending the SIGKILL signal.'], ['`status`', 'Prints a status line, either *Stopped pid* or *Running as pid*.\\\\n:::']]\\n\\nA number of additional options allow you to specify configuration file and\\ndirectory locations, as well as Java options. Run the launcher with `--help`\\nto see the supported commands, command line options, and default values.\\n\\nThe `-v` or `--verbose` option for each command prepends the server's\\ncurrent settings before the command's usual output.\\n\\nTrino can be started as a daemon by running the following:\\n\\n```\\nbin/launcher start\\n```\\n\\nUse the status command with the verbose option for the pid and a list of\\nconfiguration settings:\\n\\n```\\nbin/launcher -v status\\n```\\n\\nAlternatively, it can be run in the foreground, with the logs and other\\noutput written to stdout/stderr. Both streams should be captured\\nif using a supervision system like daemontools:\\n\\n```\\nbin/launcher run\\n```\\n\\nThe launcher configures default values for the configuration directory `etc`,\\nconfiguration files in `etc`, the data directory identical to the installation\\ndirectory, the pid file as `var/run/launcher.pid` and log files in the `var/log`\\ndirectory.\\n\\nYou can change these values to adjust your Trino usage to any requirements, such\\nas using a directory outside the installation directory, specific mount points\\nor locations, and even using other file names. For example, the [Trino\\nRPM](https://github.com/trinodb/trino-packages) adjusts the used directories to\\nbetter follow the Linux Filesystem Hierarchy Standard (FHS).\\n\\nAfter starting Trino, you can find log files in the `log` directory inside\\nthe data directory `var`:\\n\\n['`launcher.log`:\\\\nThis log is created by the launcher and is connected to the stdout\\\\nand stderr streams of the server. It contains a few log messages\\\\nthat occur while the server logging is being initialized, and any\\\\nerrors or diagnostics produced by the JVM.', '`server.log`:\\\\nThis is the main log file used by Trino. It typically contains\\\\nthe relevant information if the server fails during initialization.\\\\nIt is automatically rotated and compressed.', '`http-request.log`:\\\\nThis is the HTTP request log which contains every HTTP request\\\\nreceived by the server. It is automatically rotated and compressed.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 1]\"}, {\"title\": \"Trino on Kubernetes with Helm\", \"description\": null, \"content\": {\"Requirements\": [\"A Kubernetes cluster with a\\n[supported version](https://kubernetes.io/releases/) of Kubernetes.\", [\"If you don't have a Kubernetes cluster, you can\\n{ref}`run one locally using kind <running-a-local-kubernetes-cluster-with-kind>`.\"], \"[kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) with a version\\nthat adheres to the\\n[Kubernetes version skew policy](https://kubernetes.io/releases/version-skew-policy/)\\ninstalled on the machine managing the Kubernetes deployment.\", \"[helm](https://helm.sh) with a version that adheres to the\\n[Helm version skew policy](https://helm.sh/docs/topics/version_skew/)\\ninstalled on the machine managing the Kubernetes deployment.\"], \"Running Trino using Helm\": \"Run the following commands from the system with `helm` and `kubectl`\\ninstalled and configured to connect to your running Kubernetes cluster:\\n\\n['Validate `kubectl` is pointing to the correct cluster by running the\\\\ncommand:', '```\\\\nkubectl cluster-info\\\\n```', 'You should see output that shows the correct Kubernetes control plane\\\\naddress.', \\\"Add the Trino Helm chart repository to Helm if you haven't done so already.\\\\nThis tells Helm where to find the Trino charts. You can name the repository\\\\nwhatever you want, `trino` is a good choice.\\\", '```\\\\nhelm repo add trino https://trinodb.github.io/charts\\\\n```', 'Install Trino on the Kubernetes cluster using the Helm chart. Start by\\\\nrunning the `install` command to use all default values and create\\\\na cluster called `example-trino-cluster`.', '```\\\\nhelm install example-trino-cluster trino/trino\\\\n```', 'This generates the Kubernetes configuration files by inserting properties\\\\ninto helm templates. The Helm chart contains\\\\n[default values](https://trinodb.github.io/charts/charts/trino/)\\\\nthat can be overridden by a YAML file to update default settings.', ['*(Optional)* To override the default values,\\\\n{ref}`create your own YAML configuration <creating-your-own-yaml>` to\\\\ndefine the parameters of your deployment. To run the install command using\\\\nthe `example.yaml`, add the `f` parameter in you `install` command.\\\\nBe sure to follow\\\\n{ref}`best practices and naming conventions <kubernetes-configuration-best-practices>`\\\\nfor your configuration files.', '```\\\\nhelm install -f example.yaml example-trino-cluster trino/trino\\\\n```'], 'You should see output as follows:', '```\\\\nNAME: example-trino-cluster\\\\nLAST DEPLOYED: Tue Sep 13 14:12:09 2022\\\\nNAMESPACE: default\\\\nSTATUS: deployed\\\\nREVISION: 1\\\\nTEST SUITE: None\\\\nNOTES:\\\\nGet the application URL by running these commands:\\\\n export POD_NAME=$(kubectl get pods --namespace default --selector \\\"app.kubernetes.io/name=trino,app.kubernetes.io/instance=example-trino-cluster,app.kubernetes.io/component=coordinator\\\" --output name)\\\\n echo \\\"Visit http://127.0.0.1:8080 to use your application\\\"\\\\n kubectl port-forward $POD_NAME 8080:8080\\\\n```', 'This output depends on your configuration and cluster name. For example, the\\\\nport `8080` is set by the `.service.port` in the `example.yaml`.', 'Run the following command to check that all pods, deployments, and services\\\\nare running properly.', '```\\\\nkubectl get all\\\\n```', 'You should expect to see output that shows running pods, deployments, and\\\\nreplica sets. A good indicator that everything is running properly is to see\\\\nall pods are returning a ready status in the `READY` column.', '```\\\\nNAME READY STATUS RESTARTS AGE\\\\npod/example-trino-cluster-coordinator-bfb74c98d-rnrxd 1/1 Running 0 161m\\\\npod/example-trino-cluster-worker-76f6bf54d6-hvl8n 1/1 Running 0 161m\\\\npod/example-trino-cluster-worker-76f6bf54d6-tcqgb 1/1 Running 0 161m\\\\n\\\\nNAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE\\\\nservice/example-trino-cluster ClusterIP 10.96.25.35 <none> 8080/TCP 161m\\\\n\\\\nNAME READY UP-TO-DATE AVAILABLE AGE\\\\ndeployment.apps/example-trino-cluster-coordinator 1/1 1 1 161m\\\\ndeployment.apps/example-trino-cluster-worker 2/2 2 2 161m\\\\n\\\\nNAME DESIRED CURRENT READY AGE\\\\nreplicaset.apps/example-trino-cluster-coordinator-bfb74c98d 1 1 1 161m\\\\nreplicaset.apps/example-trino-cluster-worker-76f6bf54d6 2 2 2 161m\\\\n```', 'The output shows running pods. These include the actual Trino containers. To\\\\nbetter understand this output, check out the following resources:', ['[kubectl get command reference](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#get).', '[kubectl get command example](https://kubernetes.io/docs/reference/kubectl/docker-cli-to-kubectl/#docker-ps).', '[Debugging Kubernetes reference](https://kubernetes.io/docs/tasks/debug/).'], 'If all pods, deployments, and replica sets are running and in the ready\\\\nstate, Trino has been successfully deployed.']\\n\\n:::{note}\\nUnlike some Kubernetes applications, where it's better to have many small\\npods, Trino works best with fewer pods each having more resources\\navailable. We strongly recommend to avoid having multiple Trino pods on a\\nsingle physical host to avoid contention for resources.\\n:::\\n\\n(executing-queries)=\", \"Executing queries\": \"The pods running the Trino containers are all running on a private network\\ninternal to Kubernetes. In order to access them, specifically the coordinator,\\nyou need to create a tunnel to the coordinator pod and your computer. You can do\\nthis by running the commands generated upon installation.\\n\\n['Create the tunnel from the client to the coordinator service.', '```\\\\nkubectl port-forward svc/trino 8080:8080\\\\n```', 'Now you can connect to the Trino coordinator at `http://localhost:8080`.', 'To connect to Trino, you can use the\\\\n{doc}`command-line interface </client/cli>`, a\\\\n{doc}`JDBC client </client/jdbc>`, or any of the\\\\n{doc}`other clients </client>`. For this example,\\\\n{ref}`install the command-line interface <cli-installation>`, and connect to\\\\nTrino in a new console session.', '```\\\\ntrino --server http://localhost:8080\\\\n```', 'Using the sample data in the `tpch` catalog, type and execute a query on\\\\nthe `nation` table using the `tiny` schema:', '```\\\\ntrino> select count(*) from tpch.tiny.nation;\\\\n _col0\\\\n-------\\\\n 25\\\\n(1 row)\\\\n\\\\nQuery 20181105_001601_00002_e6r6y, FINISHED, 1 node\\\\nSplits: 21 total, 21 done (100.00%)\\\\n0:06 [25 rows, 0B] [4 rows/s, 0B/s]\\\\n```', 'Try other SQL queries to explore the data set and test your cluster.', 'Once you are done with your exploration, enter the `quit` command in the\\\\nCLI.', \\\"Kill the tunnel to the coordinator pod. The is only available while the\\\\n`kubectl` process is running, so you can just kill the `kubectl` process\\\\nthat's forwarding the port. In most cases that means pressing `CTRL` +\\\\n`C` in the terminal where the port-forward command is running.\\\"]\", \"Configuration\": {\"Creating your own YAML configuration\": \"When you use your own YAML Kubernetes configuration, you only override the values you specify.\\nThe remaining properties use their default values. Add an `example.yaml` with\\nthe following configuration:\\n\\n```\\nimage:\\n tag: \\\"|trino_version|\\\"\\nserver:\\n workers: 3\\ncoordinator:\\n jvm:\\n maxHeapSize: \\\"8G\\\"\\nworker:\\n jvm:\\n maxHeapSize: \\\"8G\\\"\\n```\\n\\nThese values are higher than the defaults and allow Trino to use more memory\\nand run more demanding queries. If the values are too high, Kubernetes might\\nnot be able to schedule some Trino pods, depending on other applications\\ndeployed in this cluster and the size of the cluster nodes.\\n\\n['`.image.tag` is set to the current version, |trino_version|. Set\\\\nthis value if you need to use a specific version of Trino. The default is\\\\n`latest`, which is not recommended. Using `latest` will publish a new\\\\nversion of Trino with each release and a following Kubernetes deployment.', '`.server.workers` is set to `3`. This value sets the number of\\\\nworkers, in this case, a coordinator and three worker nodes are deployed.', '`.coordinator.jvm.maxHeapSize` is set to `8GB`.\\\\nThis sets the maximum heap size in the JVM of the coordinator. See\\\\n{ref}`jvm-config`.', '`.worker.jvm.maxHeapSize` is set to `8GB`.\\\\nThis sets the maximum heap size in the JVM of the worker. See\\\\n{ref}`jvm-config`.']\\n\\n:::{warning}\\nSome memory settings need to be tuned carefully as setting some values\\noutside the range of the maximum heap size will cause Trino startup to\\nfail. See the warnings listed on {doc}`/admin/properties-resource-management`.\\n:::\\n\\nReference [the full list of properties](https://trinodb.github.io/charts/charts/trino/)\\nthat can be overridden in the Helm chart.\\n\\n(kubernetes-configuration-best-practices)=\\n:::{note}\\nAlthough `example.yaml` is used to refer to the Kubernetes configuration\\nfile in this document, you should use clear naming guidelines for the cluster\\nand deployment you are managing. For example,\\n`cluster-example-trino-etl.yaml` might refer to a Trino deployment for a\\ncluster used primarily for extract-transform-load queries deployed on the\\n`example` Kubernetes cluster. See\\n[Configuration Best Practices](https://kubernetes.io/docs/concepts/configuration/overview/)\\nfor more tips on configuring Kubernetes deployments.\\n:::\", \"Adding catalogs\": \"A common use-case is to add custom catalogs. You can do this by adding values to\\nthe `catalogs` property in the `example.yaml` file.\\n\\n```\\ncatalogs:\\n lakehouse: |-\\n connector.name=iceberg\\n hive.metastore.uri=thrift://example.net:9083\\n rdbms: |-\\n connector.name=postgresql\\n connection-url=jdbc:postgresql://example.net:5432/database\\n connection-user=root\\n connection-password=secret\\n tpch: |-\\n connector.name=tpch\\n tpch.splits-per-node=4\\n```\\n\\nThis adds both `lakehouse` and `rdbms` catalogs to the Kubernetes deployment\\nconfiguration.\\n\\n(running-a-local-kubernetes-cluster-with-kind)=\"}, \"Running a local Kubernetes cluster with kind\": \"For local deployments, you can use\\n[kind (Kubernetes in Docker)](https://kind.sigs.k8s.io). Follow the steps\\nbelow to run `kind` on your system.\\n\\n['`kind` runs on [Docker](https://www.docker.com), so first check if Docker\\\\nis installed:', '```\\\\ndocker --version\\\\n```', 'If this command fails, install Docker by following\\\\n[Docker installation instructions](https://docs.docker.com/engine/install/).', 'Install `kind` by following the\\\\n[kind installation instructions](https://kind.sigs.k8s.io/docs/user/quick-start/#installation).', 'Run a Kubernetes cluster in `kind` by running the command:', '```\\\\nkind create cluster --name trino\\\\n```', ':::{note}\\\\nThe `name` parameter is optional but is used to showcase how the\\\\nnamespace is applied in future commands. The cluster name defaults to\\\\n`kind` if no parameter is added. Use `trino` to make the application\\\\non this cluster obvious.\\\\n:::', 'Verify that `kubectl` is running against the correct Kubernetes cluster.', '```\\\\nkubectl cluster-info --context kind-trino\\\\n```', \\\"If you have multiple Kubernetes clusters already configured within\\\\n`~/.kube/config`, you need to pass the `context` parameter to the\\\\n`kubectl` commands to operate with the local `kind` cluster. `kubectl`\\\\nuses the\\\\n[default context](https://kubernetes.io/docs/reference/kubectl/cheatsheet/#kubectl-context-and-configuration)\\\\nif this parameter isn't supplied. Notice the context is the name of the\\\\ncluster with the `kind-` prefix added. Now you can look at all the\\\\nKubernetes objects running on your `kind` cluster.\\\", 'Set up Trino by following the {ref}`running-trino-using-helm` steps. When\\\\nrunning the `kubectl get all` command, add the `context` parameter.', '```\\\\nkubectl get all --context kind-trino\\\\n```', 'Run some queries by following the [Executing queries](#executing-queries) steps.', 'Once you are done with the cluster using kind, you can delete the cluster.', '```\\\\nkind delete cluster -n trino\\\\n```']\", \"Cleaning up\": \"To uninstall Trino from the Kubernetes cluster, run the following command:\\n\\n```\\nhelm uninstall my-trino-cluster\\n```\\n\\nYou should expect to see the following output:\\n\\n```\\nrelease \\\"my-trino-cluster\\\" uninstalled\\n```\\n\\nTo validate that this worked, you can run this `kubectl` command to make sure\\nthere are no remaining Kubernetes objects related to the Trino cluster.\\n\\n```\\nkubectl get all\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 2]\"}, {\"title\": \"Plugins \", \"description\": null, \"content\": {\"Download\": \"Typically, downloading a plugin is not necessary because Trino binaries include\\nmany plugins as part of the binary package.\\n\\nEvery Trino release publishes each plugin as a ZIP archive to the [Maven Central\\nRepository](https://central.sonatype.com/). Refer to [](plugins-list) for details.\\nThe specific location is derived from the Maven coordinates of each plugin as\\ndefined in the `pom.xml` of the source code for the plugin.\\n\\nFor example, the PostgreSQL connector plugin can be found in the\\n`plugin/trino-postgresql` directory, and the `pom.xml` file contains the\\nfollowing identifier section:\\n\\n```\\n<parent>\\n <groupId>io.trino</groupId>\\n <artifactId>trino-root</artifactId>\\n <version>470</version>\\n <relativePath>../../pom.xml</relativePath>\\n</parent>\\n\\n<artifactId>trino-postgresql</artifactId>\\n<packaging>trino-plugin</packaging>\\n```\\n\\nThe Maven coordinates are therefore `io.trino:trino-postgresql:470` with version\\nor `io.trino:trino-postgresql` without version. Use this term for a [search to\\nlocate the\\nartifact](https://central.sonatype.com/search?q=io.trino%3Atrino-postgresql).\\n\\nAfter searching, click **View all** next to **Latest version**, then click\\n**Browse** to find the ZIP file for the desired version.\\n\\nThe coordinates translate into a path to the ZIP archive on the Maven Central\\nRepository. Use this URL to download the plugin.\\n\\n```\\nhttps://repo1.maven.org/maven2/io/trino/trino-postgresql/470/trino-postgresql-470.zip\\n```\\n\\nAvailability of plugins from other projects and organizations varies widely, and\\nmay require building a plugin from source.\\n\\nWhen downloading a plugin you must ensure to download a version of the plugin\\nthat is compatible with your Trino installation. Full compatibility is only\\nguaranteed when using the same Trino version used for the plugin build and the\\ndeployment, and therefore using the same version is recommended. Use the\\ndocumentation or the source code of the specific plugin to confirm and refer to\\nthe [SPI compatibility notes](spi-compatibility) for further technical details.\\n\\n(plugins-installation)=\", \"Installation\": \"To install a plugin, extract the ZIP archive into a directory in the `plugin`\\ndirectory of your Trino installation on all nodes of the cluster. The directory\\ncontains all necessary resources. \\n\\nFor example, for a plugin called `example-plugin` with a version of `1.0`,\\nextract the `example-plugin-1.0.zip` archive. Rename the resulting directory\\n`example-plugin-1.0` to `example-plugin` and copy it into the `plugin` directory\\nof your Trino installation on all workers and the coordinator of the cluster.\\n\\n:::{note} \\nEvery Trino plugin must be in a separate directory underneath the `plugin`\\ndirectory. Do not put JAR files directly into the `plugin` directory. Each\\nplugin directory should only contain JAR files. Any subdirectories and other\\nfiles are ignored.\\n:::\\n\\nBy default, the plugin directory is the `plugin` directory relative to the\\ndirectory in which Trino is installed, but it is configurable using the\\nconfiguration variable `plugin.dir` with the launcher. The [Docker\\nimage](/installation/containers) uses the path `/usr/lib/trino/plugin`.\\n\\nRestart Trino to use the plugin. \\n\\nThe [trino-packages project](https://github.com/trinodb/trino-packages) contains\\nexample projects to create a tarball and Docker image with a selection of\\nplugins by installing only the desired plugins.\\n\\n(plugins-removal)=\", \"Removal\": \"Plugins can be safely removed if the functionality is not needed or desired on\\nyour Trino cluster. Use the following steps for a safe removal across the\\ncluster:\\n\\n['Shut down Trino on all nodes.', 'Delete the directory in the `plugin` folder of the Trino installation on all\\\\nnodes. ', 'Start Trino on all nodes.']\\n\\nRefer to the [](plugins-list) for relevant directory names.\\n\\nFor repeated deployments, you can remove the plugin from the binary package for\\nyour installation by creating a custom tarball or a custom Docker image.\\n\\n(plugins-development)=\", \"Development\": \"You can develop plugins in your own fork of the Trino codebase or a separate\\nproject. Refer to the [](/develop) for further details.\\n\\n(plugins-list)=\", \"List of plugins\": \"The following list of plugins is available from the Trino project. They are\\nincluded in the build and release process and the resulting the binary packages.\\nYou can also [download](plugins-download) them from the Maven Central Repository\\nwith the listed coordinates.\\n\\n:::{list-table} List of plugins \\n:widths: 25, 25, 25, 25 \\n:header-rows: 1\\n\\n[['Plugin directory', 'Description', 'Maven coordinates', 'Download'], ['ai-functions', '[](/functions/ai)', '[io.trino:trino-ai-functions](https://central.sonatype.com/search?q=io.trino%3Atrino-ai-functions)', '{maven_download}`ai-functions` '], ['bigquery', '[](/connector/bigquery)', '[io.trino:trino-bigquery](https://central.sonatype.com/search?q=io.trino%3Atrino-bigquery)', '{maven_download}`bigquery`'], ['blackhole', '[](/connector/blackhole)', '[io.trino:trino-blackhole](https://central.sonatype.com/search?q=io.trino%3Atrino-blackhole)', '{maven_download}`blackhole`'], ['cassandra', '[](/connector/cassandra)', '[io.trino:trino-cassandra](https://central.sonatype.com/search?q=io.trino%3Atrino-cassandra)', '{maven_download}`cassandra`'], ['clickhouse', '[](/connector/clickhouse)', '[io.trino:trino-clickhouse](https://central.sonatype.com/search?q=io.trino%3Atrino-clickhouse)', '{maven_download}`clickhouse`'], ['delta-lake', '[](/connector/delta-lake)', '[io.trino:trino-delta-lake](https://central.sonatype.com/search?q=io.trino%3Atrino-delta-lake)', '{maven_download}`delta-lake`'], ['druid', '[](/connector/druid)', '[io.trino:trino-druid](https://central.sonatype.com/search?q=io.trino%3Atrino-druid)', '{maven_download}`druid`'], ['duckdb', '[](/connector/duckdb)', '[io.trino:trino-duckdb](https://central.sonatype.com/search?q=io.trino%3Atrino-duckdb)', '{maven_download}`duckdb`'], ['elasticsearch', '[](/connector/elasticsearch)', '[io.trino:trino-elasticsearch](https://central.sonatype.com/search?q=io.trino%3Atrino-elasticsearch)', '{maven_download}`elasticsearch`'], ['example-http', '[](/develop/example-http)', '[io.trino:trino-example-http](https://central.sonatype.com/search?q=io.trino%3Atrino-example-http)', '{maven_download}`example-http`'], ['exasol', '[](/connector/exasol)', '[io.trino:trino-exasol](https://central.sonatype.com/search?q=io.trino%3Atrino-exasol)', '{maven_download}`exasol`'], ['exchange-filesystem', '[](/admin/fault-tolerant-execution) exchange file system', '[io.trino:trino-exchange-filesystem](https://central.sonatype.com/search?q=io.trino%3Atrino-exchange-filesystem)', '{maven_download}`exchange-filesystem`'], ['exchange-hdfs', '[](/admin/fault-tolerant-execution) exchange file system for HDFS', '[io.trino:trino-exchange-hdfs](https://central.sonatype.com/search?q=io.trino%3Atrino-exchange-hdfs)', '{maven_download}`exchange-hdfs`'], ['faker', '[](/connector/faker)', '[io.trino:trino-faker](https://central.sonatype.com/search?q=io.trino%3Atrino-faker)', '{maven_download}`faker`'], ['functions-python', '[](/udf/python)', '[io.trino:trino-functions-python](https://central.sonatype.com/search?q=io.trino%3Atrino-functions-python)', '{maven_download}`functions-python`'], ['geospatial', '[](/functions/geospatial)', '[io.trino:trino-geospatial](https://central.sonatype.com/search?q=io.trino%3Atrino-geospatial)', '{maven_download}`geospatial`'], ['google-sheets', '[](/connector/googlesheets)', '[io.trino:trino-google-sheets](https://central.sonatype.com/search?q=io.trino%3Atrino-google-sheets)', '{maven_download}`google-sheets`'], ['hive', '[](/connector/hive)', '[io.trino:trino-hive](https://central.sonatype.com/search?q=io.trino%3Atrino-hive)', '{maven_download}`hive`'], ['http-event-listener', '[](/admin/event-listeners-http)', '[io.trino:trino-http-event-listener](https://central.sonatype.com/search?q=io.trino%3Atrino-http-event-listener)', '{maven_download}`http-event-listener`'], ['http-server-event-listener', 'HTTP server event listener', '[io.trino:trino-http-server-event-listener](https://central.sonatype.com/search?q=io.trino%3Atrino-http-server-event-listener)', '{maven_download}`http-server-event-listener`'], ['hudi', '[](/connector/hudi)', '[io.trino:trino-hudi](https://central.sonatype.com/search?q=io.trino%3Atrino-hudi)', '{maven_download}`hudi`'], ['iceberg', '[](/connector/iceberg)', '[io.trino:trino-iceberg](https://central.sonatype.com/search?q=io.trino%3Atrino-iceberg)', '{maven_download}`iceberg`'], ['ignite', '[](/connector/ignite)', '[io.trino:trino-ignite](https://central.sonatype.com/search?q=io.trino%3Atrino-ignite)', '{maven_download}`ignite`'], ['jmx', '[](/connector/jmx)', '[io.trino:trino-jmx](https://central.sonatype.com/search?q=io.trino%3Atrino-jmx)', '{maven_download}`jmx`'], ['kafka', '[](/connector/kafka)', '[io.trino:trino-kafka](https://central.sonatype.com/search?q=io.trino%3Atrino-kafka)', '{maven_download}`kafka`'], ['kafka-event-listener', '[](/admin/event-listeners-kafka)', '[io.trino:trino-kafka-event-listener](https://central.sonatype.com/search?q=io.trino%3Atrino-kafka-event-listener)', '{maven_download}`kafka-event-listener`'], ['loki', '[](/connector/loki)', '[io.trino:trino-loki](https://central.sonatype.com/search?q=io.trino%3Atrino-loki)', '{maven_download}`loki`'], ['mariadb', '[](/connector/mariadb)', '[io.trino:trino-mariadb](https://central.sonatype.com/search?q=io.trino%3Atrino-mariadb)', '{maven_download}`mariadb`'], ['memory', '[](/connector/memory)', '[io.trino:trino-memory](https://central.sonatype.com/search?q=io.trino%3Atrino-memory)', '{maven_download}`memory`'], ['ml', '[](/functions/ml)', '[io.trino:trino-ml](https://central.sonatype.com/search?q=io.trino%3Atrino-ml)', '{maven_download}`ml`'], ['mongodb', '[](/connector/mongodb)', '[io.trino:trino-mongodb](https://central.sonatype.com/search?q=io.trino%3Atrino-mongodb)', '{maven_download}`mongodb`'], ['mysql', '[](/connector/mysql)', '[io.trino:trino-mysql](https://central.sonatype.com/search?q=io.trino%3Atrino-mysql)', '{maven_download}`mysql`'], ['mysql-event-listener', '[](/admin/event-listeners-mysql)', '[io.trino:trino-mysql-event-listener](https://central.sonatype.com/search?q=io.trino%3Atrino-mysql-event-listener)', '{maven_download}`mysql-event-listener`'], ['opa', '[](/security/opa-access-control)', '[io.trino:trino-opa](https://central.sonatype.com/search?q=io.trino%3Atrino-opa)', '{maven_download}`opa`'], ['openlineage', '[](/admin/event-listeners-openlineage)', '[io.trino:trino-openlineage](https://central.sonatype.com/search?q=io.trino%3Atrino-openlineage)', '{maven_download}`openlineage`'], ['opensearch', '[](/connector/opensearch)', '[io.trino:trino-opensearch](https://central.sonatype.com/search?q=io.trino%3Atrino-opensearch)', '{maven_download}`opensearch`'], ['oracle', '[](/connector/oracle)', '[io.trino:trino-oracle](https://central.sonatype.com/search?q=io.trino%3Atrino-oracle)', '{maven_download}`oracle`'], ['password-authenticators', 'Password authentication', '[io.trino:trino-password-authenticators](https://central.sonatype.com/search?q=io.trino%3Atrino-password-authenticators)', '{maven_download}`password-authenticators`'], ['pinot', '[](/connector/pinot)', '[io.trino:trino-pinot](https://central.sonatype.com/search?q=io.trino%3Atrino-pinot)', '{maven_download}`pinot`'], ['postgresql', '[](/connector/postgresql)', '[io.trino:trino-postgresql](https://central.sonatype.com/search?q=io.trino%3Atrino-postgresql)', '{maven_download}`postgresql`'], ['prometheus', '[](/connector/prometheus)', '[io.trino:trino-prometheus](https://central.sonatype.com/search?q=io.trino%3Atrino-prometheus)', '{maven_download}`prometheus`'], ['ranger', '[](/security/ranger-access-control)', '[io.trino:trino-ranger](https://central.sonatype.com/search?q=io.trino%3Atrino-ranger)', '{maven_download}`ranger`'], ['redis', '[](/connector/redis)', '[io.trino:trino-redis](https://central.sonatype.com/search?q=io.trino%3Atrino-redis)', '{maven_download}`redis`'], ['redshift', '[](/connector/redshift)', '[io.trino:trino-redshift](https://central.sonatype.com/search?q=io.trino%3Atrino-redshift)', '{maven_download}`redshift`'], ['resource-group-managers', '[](/admin/resource-groups)', '[io.trino:trino-resource-group-managers](https://central.sonatype.com/search?q=io.trino%3Atrino-resource-group-managers)', '{maven_download}`resource-group-managers`'], ['session-property-managers', '[](/admin/session-property-managers)', '[io.trino:trino-session-property-managers](https://central.sonatype.com/search?q=io.trino%3Atrino-session-property-managers)', '{maven_download}`session-property-managers`'], ['singlestore', '[](/connector/singlestore)', '[io.trino:trino-singlestore](https://central.sonatype.com/search?q=io.trino%3Atrino-singlestore)', '{maven_download}`singlestore`'], ['snowflake', '[](/connector/snowflake)', '[io.trino:trino-snowflake](https://central.sonatype.com/search?q=io.trino%3Atrino-snowflake)', '{maven_download}`snowflake`'], ['spooling-filesystem', 'Server side support for [](protocol-spooling)', '[io.trino:trino-spooling-filesystem](https://central.sonatype.com/search?q=io.trino%3Atrino-spooling-filesystem)', '{maven_download}`spooling-filesystem`'], ['sqlserver', '[](/connector/sqlserver)', '[io.trino:trino-sqlserver](https://central.sonatype.com/search?q=io.trino%3Atrino-sqlserver)', '{maven_download}`sqlserver`'], ['teradata-functions', '[](/functions/teradata)', '[io.trino:trino-teradata-functions](https://central.sonatype.com/search?q=io.trino%3Atrino-teradata-functions)', '{maven_download}`teradata-functions`'], ['thrift', '[](/connector/thrift)', '[io.trino:trino-thrift](https://central.sonatype.com/search?q=io.trino%3Atrino-thrift)', '{maven_download}`thrift`'], ['tpcds', '[](/connector/tpcds)', '[io.trino:trino-tpcds](https://central.sonatype.com/search?q=io.trino%3Atrino-tpcds)', '{maven_download}`tpcds`'], ['tpch', '[](/connector/tpch)', '[io.trino:trino-tpch](https://central.sonatype.com/search?q=io.trino%3Atrino-tpch)', '{maven_download}`tpch`'], ['vertica', '[](/connector/vertica)', '[io.trino:trino-vertica](https://central.sonatype.com/search?q=io.trino%3Atrino-vertica)', '{maven_download}`vertica`\\\\n:::']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 3]\"}, {\"title\": \"Improve query processing resilience\", \"description\": null, \"content\": {\"Architecture\": \"The coordinator node uses a configured exchange manager service that buffers\\ndata during query processing in an external location, such as an S3 object\\nstorage bucket. Worker nodes send data to the buffer as they execute their\\nquery tasks.\", \"Best practices and considerations\": \"A fault-tolerant cluster is best suited for large batch queries. Users may\\nexperience latency or similar behavior if they issue a high volume of\\nshort-running queries on a fault-tolerant cluster. As such, it is recommended to\\nrun a dedicated fault-tolerant cluster for handling batch operations, separate\\nfrom a cluster that is designated for a higher query volume.\\n\\nCatalogs using the following connectors support fault-tolerant execution of read\\nand write operations:\\n\\n['{doc}`/connector/delta-lake`', '{doc}`/connector/hive`', '{doc}`/connector/iceberg`', '{doc}`/connector/mysql`', '{doc}`/connector/postgresql`', '{doc}`/connector/sqlserver`']\\n\\nCatalogs using other connectors only support fault-tolerant execution of read\\noperations. When fault-tolerant execution is enabled on a cluster, write\\noperations fail on any catalogs that do not support fault-tolerant\\nexecution of those operations.\\n\\nThe exchange manager may send a large amount of data to the exchange storage,\\nresulting in high I/O load on that storage. You can configure multiple storage\\nlocations for use by the exchange manager to help balance the I/O load between\\nthem.\", \"Configuration\": \"The following steps describe how to configure a Trino cluster for\\nfault-tolerant execution with an S3-based exchange:\\n\\n['Set up an S3 bucket to use as the exchange storage. For this example we are\\\\nusing an AWS S3 bucket, but other storage options are described in the\\\\n{doc}`reference documentation </admin/fault-tolerant-execution>`\\\\nas well. You can use multiple S3 buckets for exchange storage.', 'For each bucket in AWS, collect the following information:', ['S3 URI location for the bucket, such as `s3://exchange-spooling-bucket`', 'Region that the bucket is located in, such as `us-west-1`', 'AWS access and secret keys for the bucket'], 'For a {doc}`Kubernetes deployment of Trino </installation/kubernetes>`, add\\\\nthe following exchange manager configuration in the\\\\n`server.exchangeManager` and `additionalExchangeManagerProperties`\\\\nsections of the Helm chart, using the gathered S3 bucket information:', '```\\\\nserver:\\\\n exchangeManager:\\\\n name=filesystem\\\\n base-directories=s3://exchange-spooling-bucket-1,s3://exchange-spooling-bucket-2\\\\n\\\\nadditionalExchangeManagerProperties:\\\\n exchange.s3.region=us-west-1\\\\n exchange.s3.aws-access-key=example-access-key\\\\n exchange.s3.aws-secret-key=example-secret-key\\\\n```', 'In non-Kubernetes installations, the same properties must be defined in an\\\\n`exchange-manager.properties` configuration file on the coordinator and\\\\nall worker nodes.', 'Add the following configuration for fault-tolerant execution in the\\\\n`additionalConfigProperties:` section of the Helm chart:', '```\\\\nadditionalConfigProperties:\\\\n retry-policy=TASK\\\\n```', 'In non-Kubernetes installations, the same property must be defined in the\\\\n`config.properties` file on the coordinator and all worker nodes.', 'Re-deploy your instance of Trino or, for non-Kubernetes\\\\ninstallations, restart the cluster.']\\n\\nYour Trino cluster is now configured with fault-tolerant query\\nexecution. If a query run on the cluster would normally fail due to an\\ninterruption of query processing, fault-tolerant execution now resumes the\\nquery processing to ensure successful execution of the query.\", \"Next steps\": \"For more information about fault-tolerant execution, including simple query\\nretries that do not require an exchange manager and advanced configuration\\noperations, see the {doc}`reference documentation\\n</admin/fault-tolerant-execution>`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 23]\"}, {\"title\": \"Language\", \"description\": \"Documentation section: language\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/language\"}, \"subpages\": [{\"title\": \"Comments\", \"description\": null, \"content\": {\"Synopsis\": \"Comments are part of a SQL statement or script that are ignored for processing.\\nComments begin with double dashes and extend to the end of the line. Block\\ncomments begin with `/*` and extend to the next occurrence of `*/`, possibly\\nspanning over multiple lines.\", \"Examples\": \"The following example displays a comment line, a comment after a valid\\nstatement, and a block comment:\\n\\n```\\n-- This is a comment.\\nSELECT * FROM table; -- This comment is ignored.\\n\\n/* This is a block comment\\n that spans multiple lines\\n until it is closed. */\\n```\", \"See also\": \"[](/sql/comment)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 0]\"}, {\"title\": \"Keywords and identifiers\", \"description\": null, \"content\": {\"Reserved keywords\": \"The following table lists all the keywords that are reserved in Trino,\\nalong with their status in the SQL standard. These reserved keywords must\\nbe quoted (using double quotes) in order to be used as an identifier.\\n\\n| Keyword | SQL:2016 | SQL-92 |\\n| ------------------- | -------- | -------- |\\n| `ALTER` | reserved | reserved |\\n| `AND` | reserved | reserved |\\n| `AS` | reserved | reserved |\\n| `AUTO` | | |\\n| `BETWEEN` | reserved | reserved |\\n| `BY` | reserved | reserved |\\n| `CASE` | reserved | reserved |\\n| `CAST` | reserved | reserved |\\n| `CONSTRAINT` | reserved | reserved |\\n| `CREATE` | reserved | reserved |\\n| `CROSS` | reserved | reserved |\\n| `CUBE` | reserved | |\\n| `CURRENT_CATALOG` | reserved | |\\n| `CURRENT_DATE` | reserved | reserved |\\n| `CURRENT_PATH` | reserved | |\\n| `CURRENT_ROLE` | reserved | reserved |\\n| `CURRENT_SCHEMA` | reserved | |\\n| `CURRENT_TIME` | reserved | reserved |\\n| `CURRENT_TIMESTAMP` | reserved | reserved |\\n| `CURRENT_USER` | reserved | |\\n| `DEALLOCATE` | reserved | reserved |\\n| `DELETE` | reserved | reserved |\\n| `DESCRIBE` | reserved | reserved |\\n| `DISTINCT` | reserved | reserved |\\n| `DROP` | reserved | reserved |\\n| `ELSE` | reserved | reserved |\\n| `END` | reserved | reserved |\\n| `ESCAPE` | reserved | reserved |\\n| `EXCEPT` | reserved | reserved |\\n| `EXISTS` | reserved | reserved |\\n| `EXTRACT` | reserved | reserved |\\n| `FALSE` | reserved | reserved |\\n| `FOR` | reserved | reserved |\\n| `FROM` | reserved | reserved |\\n| `FULL` | reserved | reserved |\\n| `GROUP` | reserved | reserved |\\n| `GROUPING` | reserved | |\\n| `HAVING` | reserved | reserved |\\n| `IN` | reserved | reserved |\\n| `INNER` | reserved | reserved |\\n| `INSERT` | reserved | reserved |\\n| `INTERSECT` | reserved | reserved |\\n| `INTO` | reserved | reserved |\\n| `IS` | reserved | reserved |\\n| `JOIN` | reserved | reserved |\\n| `JSON_ARRAY` | reserved | |\\n| `JSON_EXISTS` | reserved | |\\n| `JSON_OBJECT` | reserved | |\\n| `JSON_QUERY` | reserved | |\\n| `JSON_TABLE` | reserved | |\\n| `JSON_VALUE` | reserved | |\\n| `LEFT` | reserved | reserved |\\n| `LIKE` | reserved | reserved |\\n| `LISTAGG` | reserved | |\\n| `LOCALTIME` | reserved | |\\n| `LOCALTIMESTAMP` | reserved | |\\n| `NATURAL` | reserved | reserved |\\n| `NORMALIZE` | reserved | |\\n| `NOT` | reserved | reserved |\\n| `NULL` | reserved | reserved |\\n| `ON` | reserved | reserved |\\n| `OR` | reserved | reserved |\\n| `ORDER` | reserved | reserved |\\n| `OUTER` | reserved | reserved |\\n| `PREPARE` | reserved | reserved |\\n| `RECURSIVE` | reserved | |\\n| `RIGHT` | reserved | reserved |\\n| `ROLLUP` | reserved | |\\n| `SELECT` | reserved | reserved |\\n| `SKIP` | reserved | |\\n| `TABLE` | reserved | reserved |\\n| `THEN` | reserved | reserved |\\n| `TRIM` | reserved | reserved |\\n| `TRUE` | reserved | reserved |\\n| `UESCAPE` | reserved | |\\n| `UNION` | reserved | reserved |\\n| `UNNEST` | reserved | |\\n| `USING` | reserved | reserved |\\n| `VALUES` | reserved | reserved |\\n| `WHEN` | reserved | reserved |\\n| `WHERE` | reserved | reserved |\\n| `WITH` | reserved | reserved |\\n\\n(language-identifiers)=\", \"Identifiers\": \"Tokens that identify names of catalogs, schemas, tables, columns, functions, or\\nother objects, are identifiers.\\n\\nIdentifiers must start with a letter, and subsequently include alphanumeric\\ncharacters and underscores. Identifiers with other characters must be delimited\\nwith double quotes (`\\\"`). When delimited with double quotes, identifiers can use\\nany character. Escape a `\\\"` with another preceding double quote in a delimited\\nidentifier.\\n\\nIdentifiers are not treated as case sensitive.\\n\\nFollowing are some valid examples:\\n\\n```\\ntablename\\nSchemaName\\nexample_catalog.a_schema.\\\"table$partitions\\\"\\n\\\"identifierWith\\\"\\\"double\\\"\\\"quotes\\\"\\n```\\n\\nThe following identifiers are invalid in Trino and must be quoted when used:\\n\\n```\\ntable-name\\n123SchemaName\\ncolum$name@field\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 1]\"}, {\"title\": \"SQL statement support\", \"description\": null, \"content\": {\"Globally available statements\": {\"Catalog management\": \"The following statements are used to [manage dynamic\\ncatalogs](/admin/properties-catalog):\\n\\n['{doc}`/sql/create-catalog`', '{doc}`/sql/drop-catalog`']\\n\\n(sql-read-operations)=\"}, \"Read operations\": \"The following statements provide read access to data and metadata exposed by a\\nconnector accessing a data source. They are supported by all connectors:\\n\\n['{doc}`/sql/select` including {doc}`/sql/match-recognize`', '{doc}`/sql/describe`', '{doc}`/sql/show-catalogs`', '{doc}`/sql/show-columns`', '{doc}`/sql/show-create-materialized-view`', '{doc}`/sql/show-create-schema`', '{doc}`/sql/show-create-table`', '{doc}`/sql/show-create-view`', '{doc}`/sql/show-grants`', '{doc}`/sql/show-roles`', '{doc}`/sql/show-schemas`', '{doc}`/sql/show-tables`', '{doc}`/sql/show-stats`']\\n\\n(sql-write-operations)=\", \"Write operations\": {\"Data management\": [\"{doc}`/sql/insert`\", \"{doc}`/sql/update`\", \"{doc}`/sql/delete`\", \"{doc}`/sql/truncate`\", \"{doc}`/sql/merge`\"], \"Schema and table management\": [\"{doc}`/sql/create-table`\", \"{doc}`/sql/create-table-as`\", \"{doc}`/sql/drop-table`\", \"{doc}`/sql/alter-table`\", \"{doc}`/sql/create-schema`\", \"{doc}`/sql/drop-schema`\", \"{doc}`/sql/alter-schema`\", \"{doc}`/sql/comment`\"], \"View management\": [\"{doc}`/sql/create-view`\", \"{doc}`/sql/drop-view`\", \"{doc}`/sql/alter-view`\"], \"Materialized view management\": [\"{doc}`/sql/create-materialized-view`\", \"{doc}`/sql/alter-materialized-view`\", \"{doc}`/sql/drop-materialized-view`\", \"{doc}`/sql/refresh-materialized-view`\"], \"User-defined function management\": \"The following statements are used to manage [](udf-catalog):\\n\\n['[](/sql/create-function)', '[](/sql/drop-function)', '[](/sql/show-functions)']\\n\\n(sql-security-operations)=\"}, \"Security operations\": \"The following statements provide security-related operations to security\\nconfiguration, data, and metadata exposed by a connector accessing a data\\nsource. Most connectors do not support these operations:\\n\\nConnector roles:\\n\\n['{doc}`/sql/create-role`', '{doc}`/sql/drop-role`', '{doc}`/sql/grant-roles`', '{doc}`/sql/revoke-roles`', '{doc}`/sql/set-role`', '{doc}`/sql/show-role-grants`']\\n\\nGrants management:\\n\\n['{doc}`/sql/deny`', '{doc}`/sql/grant`', '{doc}`/sql/revoke`']\\n\\n(sql-transactions)=\", \"Transactions\": \"The following statements manage transactions. Most connectors do not support\\ntransactions:\\n\\n['{doc}`/sql/start-transaction`', '{doc}`/sql/commit`', '{doc}`/sql/rollback`']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 2]\"}, {\"title\": \"Data types\", \"description\": null, \"content\": {\"Trino type support and mapping\": \"Connectors to data sources are not required to support all Trino data types\\ndescribed on this page. If there are data types similar to Trino's that are used\\non the data source, the connector may map the Trino and remote data types to\\neach other as needed.\\n\\nDepending on the connector and the data source, type mapping may apply\\nin either direction as follows:\\n\\n['**Data source to Trino** mapping applies to any operation where columns in the\\\\ndata source are read by Trino, such as a {doc}`/sql/select` statement, and the\\\\nunderlying source data type needs to be represented by a Trino data type.', '**Trino to data source** mapping applies to any operation where the columns\\\\nor expressions in Trino need to be translated into data types or expressions\\\\ncompatible with the underlying data source. For example,\\\\n{doc}`/sql/create-table-as` statements specify Trino types that are then\\\\nmapped to types on the remote data source. Predicates like `WHERE` also use\\\\nthese mappings in order to ensure that the predicate is translated to valid\\\\nsyntax on the remote data source.']\\n\\nData type support and mappings vary depending on the connector. Refer to the\\n{doc}`connector documentation </connector>` for more information.\\n\\n(boolean-data-types)=\", \"Boolean\": {\"`BOOLEAN`\": \"This type captures boolean values `true` and `false`.\\n\\n(integer-data-types)=\"}, \"Integer\": {\"`TINYINT`\": \"A 8-bit signed two's complement integer with a minimum value of\\n`-2^7` or `-0x80` and a maximum value of `2^7 - 1` or `0x7F`.\", \"`SMALLINT`\": \"A 16-bit signed two's complement integer with a minimum value of\\n`-2^15` or `-0x8000` and a maximum value of `2^15 - 1` or `0x7FFF`.\", \"`INTEGER` or `INT`\": \"A 32-bit signed two's complement integer with a minimum value of `-2^31` or\\n`-0x80000000` and a maximum value of `2^31 - 1` or `0x7FFFFFFF`. The names\\n`INTEGER` and `INT` can both be used for this type.\", \"`BIGINT`\": \"A 64-bit signed two's complement integer with a minimum value of `-2^63` or\\n`-0x8000000000000000` and a maximum value of `2^63 - 1` or `0x7FFFFFFFFFFFFFFF`.\\n\\n(floating-point-data-types)=\"}, \"Floating-point\": {\"`REAL`\": \"A real is a 32-bit inexact, variable-precision implementing the\\nIEEE Standard 754 for Binary Floating-Point Arithmetic.\\n\\nExample literals: `REAL '10.3'`, `REAL '10.3e0'`, `REAL '1.03e1'`\", \"`DOUBLE`\": \"A double is a 64-bit inexact, variable-precision implementing the\\nIEEE Standard 754 for Binary Floating-Point Arithmetic.\\n\\nExample literals: `DOUBLE '10.3'`, `DOUBLE '1.03e1'`, `10.3e0`, `1.03e1`\\n\\n(exact-numeric-data-types)=\"}, \"Exact numeric\": {\"`DECIMAL`\": \"A exact decimal number. Precision up to 38 digits is supported but performance\\nis best up to 18 digits.\\n\\nThe decimal type takes two literal parameters:\\n\\n['**precision** - total number of digits', '**scale** - number of digits in fractional part. Scale is optional and defaults to 0.']\\n\\nExample type definitions: `DECIMAL(10,3)`, `DECIMAL(20)`\\n\\nExample literals: `DECIMAL '10.3'`, `DECIMAL '1234567890'`, `1.1`\\n\\n(string-data-types)=\"}, \"String\": {\"`VARCHAR`\": \"Variable length character data with an optional maximum length.\\n\\nExample type definitions: `varchar`, `varchar(20)`\\n\\nSQL statements support simple literal, as well as Unicode usage:\\n\\n[\\\"literal string : `'Hello winter !'`\\\", \\\"Unicode string with default escape character: `U&'Hello winter \\\\\\\\2603 !'`\\\", \\\"Unicode string with custom escape character: `U&'Hello winter #2603 !' UESCAPE '#'`\\\"]\\n\\nA Unicode string is prefixed with `U&` and requires an escape character\\nbefore any Unicode character usage with 4 digits. In the examples above\\n`\\\\2603` and `#2603` represent a snowman character. Long Unicode codes\\nwith 6 digits require usage of the plus symbol before the code. For example,\\nyou need to use `\\\\+01F600` for a grinning face emoji.\\n\\nSingle quotes in string literals can be escaped by using another single quote: \\n`'I am big, it''s the pictures that got small!'`\", \"`CHAR`\": \"Fixed length character data. A `CHAR` type without length specified has a\\ndefault length of 1. A `CHAR(x)` value always has a fixed length of `x`\\ncharacters. For example, casting `dog` to `CHAR(7)` adds four implicit trailing\\nspaces.\\n\\nAs with `VARCHAR`, a single quote in a `CHAR` literal can be escaped with\\nanother single quote:\\n\\n```\\nSELECT CHAR 'All right, Mr. DeMille, I''m ready for my close-up.'\\n```\\n\\nExample type definitions: `char`, `char(20)`\", \"`VARBINARY`\": \"Variable length binary data.\\n\\nSQL statements support usage of binary literal data with the prefix `X` or `x`.\\nThe binary data has to use hexadecimal format. For example, the binary form of\\n`eh?` is `X'65683F'` as you can confirm with the following statement:\\n\\n```\\nSELECT from_utf8(x'65683F');\\n```\\n\\nBinary literals ignore any whitespace characters. For example, the literal\\n`X'FFFF 0FFF 3FFF FFFF'` is equivalent to `X'FFFF0FFF3FFFFFFF'`.\\n\\n:::{note}\\nBinary strings with length are not yet supported: `varbinary(n)`\\n:::\", \"`JSON`\": \"JSON value type, which can be a JSON object, a JSON array, a JSON number, a JSON string,\\n`true`, `false` or `null`.\\n\\n(date-time-data-types)=\"}, \"Date and time\": {\"`DATE`\": \"Calendar date (year, month, day).\\n\\nExample: `DATE '2001-08-22'`\", \"`TIME`\": \"`TIME` is an alias for `TIME(3)` (millisecond precision).\", \"`TIME(P)`\": \"Time of day (hour, minute, second) without a time zone with `P` digits of precision\\nfor the fraction of seconds. A precision of up to 12 (picoseconds) is supported.\\n\\nExample: `TIME '01:02:03.456'`\\n\\n(time-with-time-zone-data-type)=\", \"`TIME WITH TIME ZONE`\": \"Time of day (hour, minute, second, millisecond) with a time zone.\\nValues of this type are rendered using the time zone from the value.\\nTime zones are expressed as the numeric UTC offset value:\\n\\n```\\nSELECT TIME '01:02:03.456 -08:00';\\n-- 1:02:03.456-08:00\\n```\\n\\n(timestamp-data-type)=\", \"`TIMESTAMP`\": \"`TIMESTAMP` is an alias for `TIMESTAMP(3)` (millisecond precision).\", \"`TIMESTAMP(P)`\": \"Calendar date and time of day without a time zone with `P` digits of precision\\nfor the fraction of seconds. A precision of up to 12 (picoseconds) is supported.\\nThis type is effectively a combination of the `DATE` and `TIME(P)` types.\\n\\n`TIMESTAMP(P) WITHOUT TIME ZONE` is an equivalent name.\\n\\nTimestamp values can be constructed with the `TIMESTAMP` literal\\nexpression. Alternatively, language constructs such as\\n`localtimestamp(p)`, or a number of {doc}`date and time functions and\\noperators </functions/datetime>` can return timestamp values.\\n\\nCasting to lower precision causes the value to be rounded, and not\\ntruncated. Casting to higher precision appends zeros for the additional\\ndigits.\\n\\nThe following examples illustrate the behavior:\\n\\n```\\nSELECT TIMESTAMP '2020-06-10 15:55:23';\\n-- 2020-06-10 15:55:23\\n\\nSELECT TIMESTAMP '2020-06-10 15:55:23.383345';\\n-- 2020-06-10 15:55:23.383345\\n\\nSELECT typeof(TIMESTAMP '2020-06-10 15:55:23.383345');\\n-- timestamp(6)\\n\\nSELECT cast(TIMESTAMP '2020-06-10 15:55:23.383345' as TIMESTAMP(1));\\n -- 2020-06-10 15:55:23.4\\n\\nSELECT cast(TIMESTAMP '2020-06-10 15:55:23.383345' as TIMESTAMP(12));\\n-- 2020-06-10 15:55:23.383345000000\\n```\\n\\n(timestamp-with-time-zone-data-type)=\", \"`TIMESTAMP WITH TIME ZONE`\": \"`TIMESTAMP WITH TIME ZONE` is an alias for `TIMESTAMP(3) WITH TIME ZONE`\\n(millisecond precision).\\n\\n(timestamp-p-with-time-zone-data-type)=\", \"`TIMESTAMP(P) WITH TIME ZONE`\": \"Instant in time that includes the date and time of day with `P` digits of\\nprecision for the fraction of seconds and with a time zone. Values of this type\\nare rendered using the time zone from the value. Time zones can be expressed in\\nthe following ways:\\n\\n['`UTC`, with `GMT`, `Z`, or `UT` usable as aliases for UTC.', '`+hh:mm` or `-hh:mm` with `hh:mm` as an hour and minute offset from UTC.\\\\nCan be written with or without `UTC`, `GMT`, or `UT` as an alias for\\\\nUTC.', 'An [IANA time zone name](https://www.iana.org/time-zones).']\\n\\nThe following examples demonstrate some of these syntax options:\\n\\n```\\nSELECT TIMESTAMP '2001-08-22 03:04:05.321 UTC';\\n-- 2001-08-22 03:04:05.321 UTC\\n\\nSELECT TIMESTAMP '2001-08-22 03:04:05.321 -08:30';\\n-- 2001-08-22 03:04:05.321 -08:30\\n\\nSELECT TIMESTAMP '2001-08-22 03:04:05.321 GMT-08:30';\\n-- 2001-08-22 03:04:05.321 -08:30\\n\\nSELECT TIMESTAMP '2001-08-22 03:04:05.321 America/New_York';\\n-- 2001-08-22 03:04:05.321 America/New_York\\n```\", \"`INTERVAL YEAR TO MONTH`\": \"Span of years and months.\\n\\nExample: `INTERVAL '3' MONTH`\", \"`INTERVAL DAY TO SECOND`\": \"Span of days, hours, minutes, seconds and milliseconds.\\n\\nExample: `INTERVAL '2' DAY`\\n\\n(structural-data-types)=\"}, \"Structural\": {\"`ARRAY`\": \"An array of the given component type.\\n\\nExample: `ARRAY[1, 2, 3]`\\n\\nMore information in [](/functions/array).\\n\\n(map-type)=\", \"`MAP`\": \"A map between the given component types. A map is a collection of key-value\\npairs, where each key is associated with a single value.\\n\\nExample: `MAP(ARRAY['foo', 'bar'], ARRAY[1, 2])`\\n\\nMore information in [](/functions/map).\\n\\n(row-type)=\", \"`ROW`\": \"A structure made up of fields that allows mixed types.\\nThe fields may be of any SQL type.\\n\\nBy default, row fields are not named, but names can be assigned.\\n\\nExample: `CAST(ROW(1, 2e0) AS ROW(x BIGINT, y DOUBLE))`\\n\\nNamed row fields are accessed with field reference operator (`.`).\\n\\nExample: `CAST(ROW(1, 2.0) AS ROW(x BIGINT, y DOUBLE)).x`\\n\\nNamed or unnamed row fields are accessed by position with the subscript\\noperator (`[]`). The position starts at `1` and must be a constant.\\n\\nExample: `ROW(1, 2.0)[1]`\"}, \"Network address\": {\"`IPADDRESS`\": \"An IP address that can represent either an IPv4 or IPv6 address. Internally,\\nthe type is a pure IPv6 address. Support for IPv4 is handled using the\\n*IPv4-mapped IPv6 address* range ({rfc}`4291#section-2.5.5.2`).\\nWhen creating an `IPADDRESS`, IPv4 addresses will be mapped into that range.\\nWhen formatting an `IPADDRESS`, any address within the mapped range will\\nbe formatted as an IPv4 address. Other addresses will be formatted as IPv6\\nusing the canonical format defined in {rfc}`5952`.\\n\\nExamples: `IPADDRESS '10.0.0.1'`, `IPADDRESS '2001:db8::1'`\"}, \"UUID\": {\"`UUID`\": \"This type represents a UUID (Universally Unique IDentifier), also known as a\\nGUID (Globally Unique IDentifier), using the format defined in {rfc}`4122`.\\n\\nExample: `UUID '12151fd2-7586-11e9-8f9e-2a86e4085a59'`\"}, \"HyperLogLog\": {\"`HyperLogLog`\": \"A HyperLogLog sketch allows efficient computation of {func}`approx_distinct`. It starts as a\\nsparse representation, switching to a dense representation when it becomes more efficient.\\n\\n(p4hyperloglog-type)=\", \"`P4HyperLogLog`\": \"A P4HyperLogLog sketch is similar to {ref}`hyperloglog-type`, but it starts (and remains)\\nin the dense representation.\"}, \"SetDigest\": {\"`SetDigest`\": \"A SetDigest (setdigest) is a data sketch structure used\\nin calculating [Jaccard similarity coefficient](https://wikipedia.org/wiki/Jaccard_index)\\nbetween two sets.\\n\\nSetDigest encapsulates the following components:\\n\\n['[HyperLogLog](https://wikipedia.org/wiki/HyperLogLog)', '[MinHash with a single hash function](http://wikipedia.org/wiki/MinHash#Variant_with_a_single_hash_function)']\\n\\nThe HyperLogLog structure is used for the approximation of the distinct elements\\nin the original set.\\n\\nThe MinHash structure is used to store a low memory footprint signature of the original set.\\nThe similarity of any two sets is estimated by comparing their signatures.\\n\\nSetDigests are additive, meaning they can be merged together.\"}, \"Quantile digest\": {\"`QDigest`\": \"A quantile digest (qdigest) is a summary structure which captures the approximate\\ndistribution of data for a given input set, and can be queried to retrieve approximate\\nquantile values from the distribution. The level of accuracy for a qdigest\\nis tunable, allowing for more precise results at the expense of space.\\n\\nA qdigest can be used to give approximate answer to queries asking for what value\\nbelongs at a certain quantile. A useful property of qdigests is that they are\\nadditive, meaning they can be merged together without losing precision.\\n\\nA qdigest may be helpful whenever the partial results of `approx_percentile`\\ncan be reused. For example, one may be interested in a daily reading of the 99th\\npercentile values that are read over the course of a week. Instead of calculating\\nthe past week of data with `approx_percentile`, `qdigest`s could be stored\\ndaily, and quickly merged to retrieve the 99th percentile value.\"}, \"T-Digest\": {\"`TDigest`\": \"A T-digest (tdigest) is a summary structure which, similarly to qdigest, captures the\\napproximate distribution of data for a given input set. It can be queried to retrieve\\napproximate quantile values from the distribution.\\n\\nTDigest has the following advantages compared to QDigest:\\n\\n['higher performance', 'lower memory usage', 'higher accuracy at high and low percentiles']\\n\\nT-digests are additive, meaning they can be merged together.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 24]\"}, {\"title\": \"Object Storage\", \"description\": \"Documentation section: object-storage\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/object-storage\"}, \"subpages\": [{\"title\": \"Object storage file formats\", \"description\": null, \"content\": {\"ORC format configuration properties\": \"The following properties are used to configure the read and write operations\\nwith ORC files performed by supported object storage connectors:\\n\\n:::{list-table} ORC format configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property Name', 'Description', 'Default'], ['`orc.time-zone`', 'Sets the default time zone for legacy ORC files that did not declare a time\\\\nzone.', 'JVM default'], ['`orc.bloom-filters.enabled`', 'Enable bloom filters for predicate pushdown.', '`false`'], ['`orc.read-legacy-short-zone-id`', 'Allow reads on ORC files with short zone ID in the stripe footer.', '`false`\\\\n:::']]\\n\\n[](file-compression) is automatically performed and some details can be\\nconfigured.\\n\\n(parquet-format-configuration)=\", \"Parquet format configuration properties\": \"The following properties are used to configure the read and write operations\\nwith Parquet files performed by supported object storage connectors:\\n\\n:::{list-table} Parquet format configuration properties\\n:widths: 30, 50, 20\\n:header-rows: 1\\n\\n[['Property Name', 'Description', 'Default'], ['`parquet.time-zone`', 'Adjusts timestamp values to a specific time zone. For Hive 3.1+, set this to\\\\nUTC.', 'JVM default'], ['`parquet.writer.validation-percentage`', 'Percentage of parquet files to validate after write by re-reading the whole\\\\nfile. The equivalent catalog session property is\\\\n`parquet_optimized_writer_validation_percentage`. Validation can be turned\\\\noff by setting this property to `0`.', '`5`'], ['`parquet.writer.page-size`', 'Maximum size of pages written by Parquet writer. The equivalent catalog \\\\nsession property is `parquet_writer_page_size`.', '`1 MB`'], ['`parquet.writer.page-value-count`', 'Maximum values count of pages written by Parquet writer. The equivalent \\\\ncatalog session property is `parquet_writer_page_value_count`.', '`80000`'], ['`parquet.writer.block-size`', 'Maximum size of row groups written by Parquet writer. The equivalent \\\\ncatalog session property is `parquet_writer_block_size`.', '`128 MB`'], ['`parquet.writer.batch-size`', 'Maximum number of rows processed by the parquet writer in a batch.\\\\nThe equivalent catalog session property is `parquet_writer_batch_size`.', '`10000`'], ['`parquet.use-bloom-filter`', 'Whether bloom filters are used for predicate pushdown when reading Parquet\\\\nfiles. Set this property to `false` to disable the usage of bloom filters by\\\\ndefault. The equivalent catalog session property is\\\\n`parquet_use_bloom_filter`.', '`true`'], ['`parquet.use-column-index`', 'Skip reading Parquet pages by using Parquet column indices. The equivalent\\\\ncatalog session property is `parquet_use_column_index`. Only supported by\\\\nthe Delta Lake and Hive connectors.', '`true`'], ['`parquet.ignore-statistics`', 'Ignore statistics from Parquet to allow querying files with corrupted or\\\\nincorrect statistics. The equivalent catalog session property is\\\\n`parquet_ignore_statistics`.', '`false`'], ['`parquet.max-read-block-row-count`', 'Sets the maximum number of rows read in a batch. The equivalent catalog\\\\nsession property is named `parquet_max_read_block_row_count` and supported\\\\nby the Delta Lake, Hive, Iceberg and Hudi connectors.', '`8192`'], ['`parquet.small-file-threshold`', '[Data size](prop-type-data-size) below which a Parquet file is read\\\\nentirely. The equivalent catalog session property is named\\\\n`parquet_small_file_threshold`.', '`3MB`'], ['`parquet.experimental.vectorized-decoding.enabled`', 'Enable using Java Vector API (SIMD) for faster decoding of parquet files.\\\\nThe equivalent catalog session property is\\\\n`parquet_vectorized_decoding_enabled`.', '`true`'], ['`parquet.max-footer-read-size`', 'Sets the maximum allowed read size for Parquet file footers. Attempting to\\\\nread a file with a footer larger than this value will result in an error.\\\\nThis prevents workers from going into full GC or crashing due to poorly\\\\nconfigured Parquet writers.', '`15MB`\\\\n:::']]\\n\\n[](file-compression) is automatically performed and some details can be\\nconfigured.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 0]\"}, {\"title\": \"Alluxio file system support\", \"description\": null, \"content\": {\"Configuration\": \"Use the following properties to configure general aspects of Alluxio file system\\nsupport in your catalog properties file:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.alluxio.enabled`', 'Activate the Alluxio file system support. Defaults to `false`.\\\\n:::']]\", \"Alluxio client configuration\": \"The Alluxio cluster connection is configured in the `alluxio-site.properties`\\nproperties file. The same config file must be located in `/opt/alluxio/conf` on\\nall Trino cluster nodes. Follow the [Alluxio client configuration\\ndocumentation](https://docs.alluxio.io/os/user/stable/en/operation/Configuration.html)\\nfor more details.\\n\\nExample content of `alluxio-site.properties`:\\n\\n```\\nalluxio.master.hostname=127.0.0.1\\nalluxio.master.port=19998\\nalluxio.security.authentication.type=NOSASL\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 1]\"}, {\"title\": \"Azure Storage file system support\", \"description\": null, \"content\": {\"General configuration\": \"Use the following properties to configure general aspects of Azure Storage file\\nsystem support:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.native-azure.enabled`', 'Activate the native implementation for Azure Storage support. Defaults to\\\\n`false`. Set to `true` to use Azure Storage and enable all other properties.'], ['`azure.auth-type`', 'Authentication type to use for Azure Storage access. Defaults to `DEFAULT` which\\\\nloads from environment variables if configured or [](azure-user-assigned-managed-identity-authentication). \\\\nUse `ACCESS_KEY` for [](azure-access-key-authentication) or and `OAUTH` \\\\nfor [](azure-oauth-authentication).'], ['`azure.endpoint`', 'Hostname suffix of the Azure storage endpoint.\\\\nDefaults to `core.windows.net` for the global Azure cloud.\\\\nUse `core.usgovcloudapi.net` for the Azure US Government cloud,\\\\n`core.cloudapi.de` for the Azure Germany cloud,\\\\nor `core.chinacloudapi.cn` for the Azure China cloud.'], ['`azure.read-block-size`', '[Data size](prop-type-data-size) for blocks during read operations. Defaults\\\\nto `4MB`.'], ['`azure.write-block-size`', '[Data size](prop-type-data-size) for blocks during write operations.\\\\nDefaults to `4MB`.'], ['`azure.max-write-concurrency`', 'Maximum number of concurrent write operations. Defaults to 8.'], ['`azure.max-single-upload-size`', '[Data size](prop-type-data-size) Defaults to `4MB`.'], ['`azure.max-http-requests`', 'Maximum [integer](prop-type-integer) number of concurrent HTTP requests to\\\\nAzure from every node. Defaults to double the number of processors on the\\\\nnode. Minimum `1`. Use this property to reduce the number of requests when\\\\nyou encounter rate limiting issues.'], ['`azure.application-id`', 'Specify the application identifier appended to the `User-Agent` header\\\\nfor all requests sent to Azure Storage. Defaults to `Trino`. '], ['`azure.multipart-write-enabled`', 'Enable multipart writes for large files. Defaults to `false`. \\\\n:::']]\\n\\n(azure-user-assigned-managed-identity-authentication)=\", \"User-assigned managed identity authentication\": \"Use the following properties to configure [user-assigned managed \\nidentity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/) \\nauthentication to Azure Storage:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`azure.auth-type`', 'Must be set to `DEFAULT`.'], ['`azure.user-assigned-managed-identity.client-id`', 'Specifies the client ID of user-assigned managed identity.'], ['`azure.user-assigned-managed-identity.resource-id`', 'Specifies the resource ID of user-assigned managed identity.\\\\n:::']]\\n\\nOnly one of `azure.user-assigned-managed-identity.client-id` or `azure.user-assigned-managed-identity.resource-id` can be \\nspecified.\\n\\n(azure-access-key-authentication)=\", \"Access key authentication\": \"Use the following properties to configure access key authentication to Azure\\nStorage:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`azure.auth-type`', 'Must be set to `ACCESS_KEY`.'], ['`azure.access-key`', 'The decrypted access key for the Azure Storage account. Requires\\\\nauthentication type `ACCESSS_KEY`.\\\\n:::']]\\n\\n(azure-oauth-authentication)=\", \"OAuth 2.0 authentication\": \"Use the following properties to configure OAuth 2.0 authentication to Azure\\nStorage:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`azure.auth-type`', 'Must be set to `OAUTH`.'], ['`azure.oauth.tenant-id`', 'Tenant ID for Azure authentication.'], ['`azure.oauth.endpoint`', 'The endpoint URL for OAuth 2.0 authentication.'], ['`azure.oauth.client-id`', \\\"The OAuth 2.0 service principal's client or application ID.\\\"], ['`azure.oauth.secret`', 'A OAuth 2.0 client secret for the service principal.\\\\n:::']]\", \"Access multiple storage accounts\": \"To allow Trino to access multiple Azure storage accounts from a single\\ncatalog configuration, you can use [](azure-oauth-authentication) with\\nan Azure service principal. The following steps describe how to create\\na service principal in Azure and assign an IAM role granting access to the\\nstorage accounts:\\n\\n['Create a service principal in Azure Active Directory using Azure\\\\n**App Registrations** and save the client secret.', \\\"Assign access to the storage accounts from the account's\\\\n**Access Control (IAM)** section. You can add **Role Assignments** and\\\\nselect appropriate roles, such as **Storage Blob Data Contributor**.\\\", 'Assign access using the option **User, group, or service principal** and\\\\nselect the service principal created. Save to finalize the role\\\\nassignment.']\\n\\nOnce you create the service principal and configure the storage accounts\\nuse the **Client ID**, **Secret** and **Tenant ID** values from the\\napplication registration, to configure the catalog using properties from\\n[](azure-oauth-authentication).\\n\\n(fs-legacy-azure-migration)=\", \"Migration from legacy Azure Storage file system\": \"Trino includes legacy Azure Storage support to use with a catalog using the\\nDelta Lake, Hive, Hudi, or Iceberg connectors. Upgrading existing deployments to\\nthe current native implementation is recommended. Legacy support is deprecated\\nand will be removed.\\n\\nTo migrate a catalog to use the native file system implementation for Azure,\\nmake the following edits to your catalog configuration:\\n\\n['Add the `fs.native-azure.enabled=true` catalog configuration property.', 'Configure the `azure.auth-type` catalog configuration property.', 'Refer to the following table to rename your existing legacy catalog\\\\nconfiguration properties to the corresponding native configuration\\\\nproperties. Supported configuration values are identical unless otherwise\\\\nnoted.']\\n\\n:::{list-table}\\n:widths: 35, 35, 65\\n:header-rows: 1\\n\\n[['Legacy property', 'Native property', 'Notes'], ['`hive.azure.abfs-access-key`', '`azure.access-key`'], ['`hive.azure.abfs.oauth.endpoint`', '`azure.oauth.endpoint`', 'Also see `azure.oauth.tenant-id` in [](azure-oauth-authentication).'], ['`hive.azure.abfs.oauth.client-id`', '`azure.oauth.client-id`'], ['`hive.azure.abfs.oauth.secret`', '`azure.oauth.secret`'], ['`hive.azure.abfs.oauth2.passthrough`', '`azure.use-oauth-passthrough-token`']]\\n\\n:::\\n\\n['Remove the following legacy configuration properties if they exist in your\\\\ncatalog configuration:', ['`hive.azure.abfs-storage-account`', '`hive.azure.wasb-access-key`', '`hive.azure.wasb-storage-account`']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 2]\"}, {\"title\": \"File system cache\", \"description\": null, \"content\": {\"Distributed caching\": \"File system caching is distributed in Trino as part of the mechanism of any other\\nquery processing. Query processing, detailed more in [](/overview/concepts) is\\nbroken up into different stages, where tasks and splits are processed by\\ndifferent nodes in the cluster. The lowest level splits retrieve data from the\\ndata source with the help of the connector of the specific catalog. For\\nfile system caching, these splits result in the retrieval of files from object\\nstorage.\\n\\nDifferent nodes process splits with data from objects storage randomly over\\ntime, but with preference for using a fixed set of nodes for a given file. If\\nthe preferred nodes are too busy, the split, and hence the caching, takes place\\non a non-preferred, less busy node. File system caching keeps copies of the\\nretrieved files on a local cache storage, separate for each node. Over time the\\nsame files from object storage are cached on any nodes that require the data\\nfile for processing a specific task. Each cache on each node is managed\\nseparately, following the TTL and size configuration, and cached files are\\nevicted from the cache.\\n\\nYou can limit the number of hosts that are preferred to process these tasks with\\n`fs.cache.preferred-hosts-count`. Query processing still uses all other nodes as\\nrequired for the parallel processing of tasks, and therefore potentially caches\\nfiles on more nodes than the preferred hosts only. A low setting, such as the\\ndefault 2, can reduce the overall size of the cache because it can reduce how\\noften the same file is cached on multiple nodes. A higher setting, up to the\\nnumber of nodes in the cluster, distributes the workload across more workers by\\ndefault, and leads to more resilience against node failures at the expense of\\neffective cache size.\\n\\n(fs-cache-benefits)=\", \"Benefits\": \"Enabling caching can result in the following significant benefits:\\n\\n**Reduced load on storage**\\n\\nEvery retrieved and cached file avoids repeated retrieval from the storage in\\nsubsequent queries on the same worker. As a result the storage system does not\\nhave to provide the file again and again.\\n\\nFor example, if your query accesses 100MB of files from the storage, the first\\ntime the query runs 100MB are downloaded and cached. Any following query uses\\nthese files. If your users run another 100 queries accessing the same files,\\nyour storage system does not have to provide all data repeatedly. Without\\ncaching it has to provide the same files again and again, resulting in up to\\n10GB of total files to serve.\\n\\n**Increased query performance**\\n\\nCaching can provide significant performance benefits, by avoiding the repeated\\nnetwork transfers and instead accessing copies of the files from a local\\ncache. Performance gains are more significant if the performance of directly\\naccessing the storage is low compared to accessing the local cache.\\n\\nFor example, if you access storage in a different network, different data\\ncenter, or even different cloud-provider region query performance is slow. Adding\\ncaching using fast, local storage has a significant impact and makes your\\nqueries much faster.\\n\\nOn the other hand, if your storage is already running at very high performance\\nfor I/O and network access, and your local cache storage is at similar speeds,\\nor even slower, performance benefits can be minimal.\\n\\n**Reduced query costs**\\n\\nA result of the reduced load on the storage, mentioned earlier, is significantly\\nreduced network traffic and access to storage. Network traffic and access, often\\nin the form of API access, are often a considerable cost factor, specifically\\nalso when hosted in public cloud provider systems.\\n\\n(fs-cache-configuration)=\", \"Configuration\": \"Use the properties from the following table in your catalog properties files to\\nenable and configure caching for the specific catalogs.\\n\\n:::{list-table} File system cache configuration properties\\n:widths: 25, 75\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.cache.enabled`', 'Enable object storage caching. Defaults to no caching with the value `false`.'], ['`fs.cache.directories`', 'Required, comma-separated list of absolute paths to directories to use for\\\\ncaching. All directories must exist on the coordinator and all workers.\\\\nTrino must have read and write permissions for files and nested directories.\\\\nA valid example with only one directory is `/tmp/trino-cache`.', 'Directories must be specific for each catalog with caching enabled. When\\\\nenabling caching in multiple catalogs, you must use different directories\\\\nand set the values for `fs.cache.max-sizes` or\\\\n`fs.cache.max-disk-usage-percentages` accordingly.'], ['`fs.cache.max-sizes`', 'Comma-separated list of maximum [data sizes](prop-type-data-size) for each\\\\ncaching directory. Order of values must be identical to the directories\\\\nlist. Configuring either `fs.cache.max-sizes` or\\\\n`fs.cache.max-disk-usage-percentages` is required.'], ['`fs.cache.max-disk-usage-percentages`', 'Comma-separated list of maximum percentage values of the used disk for each\\\\ndirectory. Each value is an integer between 1 and 100. Order of values must\\\\nbe identical to the directories list. If multiple directories use the same\\\\ndisk, ensure that total percentages per drive remains below 100 percent.\\\\nConfiguring either `fs.cache.max-sizes` or\\\\n`fs.cache.max-disk-usage-percentages` is required.'], ['`fs.cache.ttl`', 'The maximum [duration](prop-type-duration) for objects to remain in the cache\\\\nbefore eviction. Defaults to `7d`. The minimum value of `0s` means that caching\\\\nis effectively turned off.'], ['`fs.cache.preferred-hosts-count`', 'The number of preferred nodes for caching files. Defaults to 2. Processing\\\\nidentifies and subsequently prefers using specific nodes. If the preferred\\\\nnodes identified for caching a split are unavailable or too busy, then an\\\\navailable node is chosen at random from the cluster. More information in\\\\n[](fs-cache-distributed).'], ['`fs.cache.page-size`', 'The page [data size](prop-type-data-size) used for caching data. Each transfer of files\\\\nuses at least this amount of data. Defaults to `1MB`. Values must be between\\\\n`64kB` and `15MB`. Larger value potentially result in too much data transfer\\\\nsmaller values are less efficient since they result in more individual downloads.\\\\n:::']]\", \"Monitoring\": \"The cache exposes the\\n[Alluxio JMX client metrics](https://docs.alluxio.io/ee-da/user/stable/en/reference/Metrics-List.html#client-metrics)\\nunder the `org.alluxio` package, and metrics on external reads and cache reads under\\n`io.trino.filesystem.alluxio.AlluxioCacheStats`.\\n\\nThe cache code uses [OpenTelemetry tracing](/admin/opentelemetry).\", \"Recommendations\": \"The speed of the local cache storage is crucial to the performance of the cache.\\nThe most common and cost-efficient approach is to attach high performance SSD\\ndisk or equivalents. Fast cache performance can be also be achieved with a RAM\\ndisk used as in-memory cache.\\n\\nIn all cases, avoid using the root partition and disk of the node. Instead\\nattach one or more dedicated storage devices for the cache on each node. Storage\\nshould be local, dedicated on each node, and not shared.\\n\\nYour deployment method for Trino decides how to attach storage and create the\\ndirectories for caching. Typically you need to connect a fast storage system,\\nlike an SSD drive, and ensure that is it mounted on the configured path.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 3]\"}, {\"title\": \"Google Cloud Storage file system support\", \"description\": null, \"content\": {\"General configuration\": \"Use the following properties to configure general aspects of Google Cloud\\nStorage file system support:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.native-gcs.enabled`', 'Activate the native implementation for Google Cloud Storage support.\\\\nDefaults to `false`. Set to `true` to use Google Cloud Storage and enable\\\\nall other properties.'], ['`gcs.project-id`', 'Identifier for the project on Google Cloud Storage.'], ['`gcs.endpoint`', 'Optional URL for the Google Cloud Storage endpoint. Configure this property\\\\nif your storage is accessed using a custom URL, for example\\\\n`http://storage.example.com:8000`.'], ['`gcs.client.max-retries`', 'Maximum number of RPC attempts. Defaults to 20.'], ['`gcs.client.backoff-scale-factor`', 'Scale factor for RPC retry delays. Defaults to 3.'], ['`gcs.client.max-retry-time`', 'Total time [duration](prop-type-duration) limit for RPC call retries.\\\\nDefaults to `25s`.'], ['`gcs.client.min-backoff-delay`', 'Minimum delay [duration](prop-type-duration) between RPC retries. Defaults\\\\nto `10ms`.'], ['`gcs.client.max-backoff-delay`', 'Maximum delay [duration](prop-type-duration) between RPC retries. Defaults\\\\nto `2s`.'], ['`gcs.read-block-size`', 'Minimum [data size](prop-type-data-size) for blocks read per RPC. Defaults\\\\nto `2MiB`. See `com.google.cloud.BaseStorageReadChannel`.'], ['`gcs.write-block-size`', 'Minimum [data size](prop-type-data-size) for blocks written per RPC. The\\\\nDefaults to `16MiB`. See `com.google.cloud.BaseStorageWriteChannel`.'], ['`gcs.page-size`', 'Maximum number of blobs to return per page. Defaults to 100.'], ['`gcs.batch-size`', 'Number of blobs to delete per batch. Defaults to 100. [Recommended batch\\\\nsize](https://cloud.google.com/storage/docs/batch) is 100.'], ['`gcs.application-id`', 'Specify the application identifier appended to the `User-Agent` header\\\\nfor all requests sent to Google Cloud Storage. Defaults to `Trino`.\\\\n:::']]\", \"Authentication\": \"Use one of the following properties to configure the authentication to Google\\nCloud Storage:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`gcs.use-access-token`', 'Flag to set usage of a client-provided OAuth 2.0 token to access Google\\\\nCloud Storage. Defaults to `false`.'], ['`gcs.json-key`', 'Your Google Cloud service account key in JSON format. Not to be set together\\\\nwith `gcs.json-key-file-path`.'], ['`gcs.json-key-file-path`', 'Path to the JSON file on each node that contains your Google Cloud Platform\\\\nservice account key. Not to be set together with `gcs.json-key`.\\\\n:::']]\\n\\n(fs-legacy-gcs-migration)=\", \"Migration from legacy Google Cloud Storage file system\": \"Trino includes legacy Google Cloud Storage support to use with a catalog using\\nthe Delta Lake, Hive, Hudi, or Iceberg connectors. Upgrading existing\\ndeployments to the current native implementation is recommended. Legacy support\\nis deprecated and will be removed.\\n\\nTo migrate a catalog to use the native file system implementation for Google\\nCloud Storage, make the following edits to your catalog configuration:\\n\\n['Add the `fs.native-gcs.enabled=true` catalog configuration property.', 'Refer to the following table to rename your existing legacy catalog\\\\nconfiguration properties to the corresponding native configuration\\\\nproperties. Supported configuration values are identical unless otherwise\\\\nnoted.']\\n\\n:::{list-table}\\n:widths: 35, 35, 65\\n:header-rows: 1\\n\\n[['Legacy property', 'Native property', 'Notes'], ['`hive.gcs.use-access-token`', '`gcs.use-access-token`'], ['`hive.gcs.json-key-file-path`', '`gcs.json-key-file-path`', 'Also see `gcs.json-key` in preceding sections\\\\n:::']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 4]\"}, {\"title\": \"HDFS file system support\", \"description\": null, \"content\": {\"General configuration\": \"Use the following properties to configure general aspects of HDFS support:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.hadoop.enabled`', 'Activate the support for HDFS access. Defaults to `false`. Set to `true` to\\\\nuse HDFS and enable all other properties.'], ['`hive.config.resources`', 'An optional, comma-separated list of HDFS configuration files. These files\\\\nmust exist on the machines running Trino. For basic setups, Trino configures\\\\nthe HDFS client automatically and does not require any configuration files.\\\\nIn some cases, such as when using federated HDFS or NameNode high\\\\navailability, it is necessary to specify additional HDFS client options to\\\\naccess your HDFS cluster in the HDFS XML configuration files and reference\\\\nthem with this parameter:', '```\\\\nhive.config.resources=/etc/hadoop/conf/core-site.xml\\\\n```', 'Only specify additional configuration files if necessary for your setup, and\\\\nreduce the configuration files to have the minimum set of required\\\\nproperties. Additional properties may cause problems.'], ['`hive.fs.new-directory-permissions`', 'Controls the permissions set on new directories created for schemas and\\\\ntables. Value must either be `skip` or an octal number, with a leading 0. If\\\\nset to `skip`, permissions of newly created directories are not set by\\\\nTrino. Defaults to `0777`.'], ['`hive.fs.new-file-inherit-ownership`', 'Flag to determine if new files inherit the ownership information from the\\\\ndirectory. Defaults to `false`.'], ['`hive.dfs.verify-checksum`', 'Flag to determine if file checksums must be verified. Defaults to `false`.'], ['`hive.dfs.ipc-ping-interval`', '[Duration](prop-type-duration) between IPC pings from Trino to HDFS.\\\\nDefaults to `10s`.'], ['`hive.dfs-timeout`', 'Timeout [duration](prop-type-duration) for access operations on HDFS.\\\\nDefaults to `60s`.'], ['`hive.dfs.connect.timeout`', 'Timeout [duration](prop-type-duration) for connection operations to HDFS.\\\\nDefaults to `500ms`.'], ['`hive.dfs.connect.max-retries`', 'Maximum number of retries for HDFS connection attempts. Defaults to `5`.'], ['`hive.dfs.key-provider.cache-ttl`', 'Caching time [duration](prop-type-duration) for the key provider. Defaults\\\\nto `30min`.'], ['`hive.dfs.domain-socket-path`', 'Path to the UNIX domain socket for the DataNode. The path must exist on each\\\\nnode. For example, `/var/lib/hadoop-hdfs/dn_socket`.'], ['`hive.hdfs.socks-proxy`', 'URL for a SOCKS proxy to use for accessing HDFS. For example,\\\\n`hdfs-master:1180`.'], ['`hive.hdfs.wire-encryption.enabled`', 'Enable HDFS wire encryption. In a Kerberized Hadoop cluster that uses HDFS\\\\nwire encryption, this must be set to `true` to enable Trino to access HDFS.\\\\nNote that using wire encryption may impact query execution performance.\\\\nDefaults to `false`.'], ['`hive.fs.cache.max-size`', 'Maximum number of cached file system objects in the HDFS cache. Defaults to\\\\n`1000`.'], ['`hive.dfs.replication`', 'Integer value to set the HDFS replication factor. By default, no value is\\\\nset.\\\\n:::']]\", \"Security\": {\"HDFS impersonation\": \"HDFS impersonation is enabled by adding `hive.hdfs.impersonation.enabled=true`\\nto the catalog properties file. With this configuration HDFS, Trino can\\nimpersonate the end user who is running the query. This can be used with HDFS\\npermissions and {abbr}`ACLs (Access Control Lists)` to provide additional\\nsecurity for data. HDFS permissions and ACLs are explained in the [HDFS\\nPermissions\\nGuide](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-hdfs/HdfsPermissionsGuide.html).\\n\\nTo use impersonation, the Hadoop cluster must be configured to allow the user or\\nprincipal that Trino is running as to impersonate the users who log in to Trino.\\nImpersonation in Hadoop is configured in the file {file}`core-site.xml`. A\\ncomplete description of the configuration options is available in the [Hadoop\\ndocumentation](https://hadoop.apache.org/docs/current/hadoop-project-dist/hadoop-common/Superusers.html#Configurations).\\n\\nIn the case of a user running a query from the [command line\\ninterface](/client/cli), the end user is the username associated with the Trino\\nCLI process or argument to the optional `--user` option.\\n\\n(hdfs-security-kerberos)=\", \"HDFS Kerberos authentication\": {\"Keytab files\": \"Keytab files are needed for Kerberos authentication and contain encryption keys\\nthat are used to authenticate principals to the Kerberos {abbr}`KDC (Key\\nDistribution Center)`. These encryption keys must be stored securely; you must\\ntake the same precautions to protect them that you take to protect ssh private\\nkeys.\\n\\nIn particular, access to keytab files must be limited to only the accounts\\nthat must use them to authenticate. In practice, this is the user that\\nthe Trino process runs as. The ownership and permissions on keytab files\\nmust be set to prevent other users from reading or modifying the files.\\n\\nKeytab files must be distributed to every node running Trino, and must have the\\ncorrect permissions on every node after distributing them.\"}}, \"Security configuration examples\": {\"Default `NONE` authentication without impersonation\": \"```\\nhive.hdfs.authentication.type=NONE\\n```\\n\\nThe default authentication type for HDFS is `NONE`. When the authentication type\\nis `NONE`, Trino connects to HDFS using Hadoop's simple authentication\\nmechanism. Kerberos is not used.\\n\\n(hive-security-simple-impersonation)=\", \"`NONE` authentication with impersonation\": \"```\\nhive.hdfs.authentication.type=NONE\\nhive.hdfs.impersonation.enabled=true\\n```\\n\\nWhen using `NONE` authentication with impersonation, Trino impersonates the user\\nwho is running the query when accessing HDFS. The user Trino is running as must\\nbe allowed to impersonate this user, as discussed in the section\\n[](hdfs-security-impersonation). Kerberos is not used.\\n\\n(hive-security-kerberos)=\", \"`KERBEROS` authentication without impersonation\": \"```\\nhive.hdfs.authentication.type=KERBEROS\\nhive.hdfs.trino.principal=trino@EXAMPLE.COM\\nhive.hdfs.trino.keytab=/etc/trino/trino.keytab\\n```\\n\\nWhen the authentication type is `KERBEROS`, Trino accesses HDFS as the principal\\nspecified by the `hive.hdfs.trino.principal` property. Trino authenticates this\\nprincipal using the keytab specified by the `hive.hdfs.trino.keytab` keytab.\\n\\n(hive-security-kerberos-impersonation)=\", \"`KERBEROS` authentication with impersonation\": \"```\\nhive.hdfs.authentication.type=KERBEROS\\nhive.hdfs.impersonation.enabled=true\\nhive.hdfs.trino.principal=trino@EXAMPLE.COM\\nhive.hdfs.trino.keytab=/etc/trino/trino.keytab\\n```\\n\\nWhen using `KERBEROS` authentication with impersonation, Trino impersonates the\\nuser who is running the query when accessing HDFS. The principal specified by\\nthe `hive.hdfs.trino.principal` property must be allowed to impersonate the\\ncurrent Trino user, as discussed in the section [](hdfs-security-impersonation). Trino\\nauthenticates `hive.hdfs.trino.principal` using the keytab specified by\\n`hive.hdfs.trino.keytab`.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 5]\"}, {\"title\": \"Local file system support\", \"description\": null, \"content\": {\"General configuration\": \"Use the following properties to configure general aspects of local file system\\nsupport:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.native-local.enabled`', 'Activate the support for local file system access. Defaults to `false`. Set\\\\nto `true` to use local file system and enable all other properties.'], ['`local.location`', 'Local path on all nodes to the root of the shared file system using the prefix\\\\n`local://` with the path to the mount point.']]\\n\\n:::\\n\\nThe following example displays the related section from a\\n`etc/catalog/example.properties` catalog configuration using the Hive connector.\\nThe coordinator and all workers nodes have an external storage mounted at\\n`/storage/datalake`, resulting in the location `local:///storage/datalake`.\\n\\n```\\nconnector.name=hive\\n...\\nfs.native-local.enabled=true\\nlocal.location=local:///storage/datalake\\n```\\n\\nCreating a schema named `default` results in the path\\n`/storage/datalake/default`. Tables within that schema result in separated\\ndirectories such as `/storage/datalake/default/table1`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 6]\"}, {\"title\": \"S3 file system support\", \"description\": null, \"content\": {\"General configuration\": \"Use the following properties to configure general aspects of S3 file system\\nsupport:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`fs.native-s3.enabled`', 'Activate the native implementation for S3 storage support. Defaults to\\\\n`false`. Set to `true` to use S3 and enable all other properties.'], ['`s3.endpoint`', 'Required endpoint URL for S3.'], ['`s3.region`', 'Required region name for S3.'], ['`s3.cross-region-access`', 'Enable cross region access. Defaults to `false`.'], ['`s3.path-style-access`', 'Use path-style access for all requests to S3'], ['`s3.storage-class`', 'S3 storage class to use while writing data. Defaults to `STANDARD`. Other allowed\\\\nvalues are: `STANDARD_IA`, `INTELLIGENT_TIERING`, `REDUCED_REDUNDANCY`, `ONEZONE_IA`,\\\\n`GLACIER`, `DEEP_ARCHIVE`, `OUTPOSTS`, `GLACIER_IR`, `SNOW`, `EXPRESS_ONEZONE`.'], ['`s3.signer-type`', 'AWS signing protocol to use for authenticating S3 requests. Supported values are: \\\\n`AwsS3V4Signer`, `Aws4Signer`, `AsyncAws4Signer`, `Aws4UnsignedPayloadSigner`, \\\\n`EventStreamAws4Signer`.'], ['`s3.exclusive-create`', 'Whether conditional write is supported by the S3-compatible storage. Defaults to `true`.'], ['`s3.canned-acl`', '[Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)\\\\nto use when uploading files to S3. Defaults to `NONE`, which has the same\\\\neffect as `PRIVATE`. If the files are to be uploaded to an S3 bucket owned\\\\nby a different AWS user, the canned ACL may be set to one of the following:\\\\n`PRIVATE`, `PUBLIC_READ`, `PUBLIC_READ_WRITE`, `AUTHENTICATED_READ`,\\\\n`BUCKET_OWNER_READ`, or `BUCKET_OWNER_FULL_CONTROL`.'], ['`s3.sse.type`', 'Set the type of S3 server-side encryption (SSE) to use. Defaults to `NONE`\\\\nfor no encryption. Other valid values are `S3` for encryption by S3 managed\\\\nkeys, `KMS` for encryption with a key from the AWS Key Management\\\\nService (KMS), and `CUSTOMER` for encryption with a customer-provided key\\\\nfrom `s3.sse.customer-key`. Note that S3 automatically uses SSE so `NONE` \\\\nand `S3` are equivalent. S3-compatible systems might behave differently.'], ['`s3.sse.kms-key-id`', 'The identifier of a key in KMS to use for SSE.'], ['`s3.sse.customer-key`', 'The 256-bit, base64-encoded AES-256 encryption key to encrypt or decrypt\\\\ndata from S3 when using the SSE-C mode for SSE with `s3.sse.type` set to\\\\n`CUSTOMER`. '], ['`s3.streaming.part-size`', 'Part size for S3 streaming upload. Values between `5MB` and `256MB` are\\\\nvalid. Defaults to `32MB`.'], ['`s3.requester-pays`', 'Switch to activate billing transfer cost to the requester. Defaults to\\\\n`false`.'], ['`s3.max-connections`', 'Maximum number of connections to S3. Defaults to `500`.'], ['`s3.connection-ttl`', 'Maximum time [duration](prop-type-duration) allowed to reuse connections in\\\\nthe connection pool before being replaced.'], ['`s3.connection-max-idle-time`', 'Maximum time [duration](prop-type-duration) allowed for connections to\\\\nremain idle in the connection pool before being closed.'], ['`s3.socket-connect-timeout`', 'Maximum time [duration](prop-type-duration) allowed for socket connection\\\\nrequests to complete before timing out.'], ['`s3.socket-timeout`', 'Maximum time [duration](prop-type-duration) for socket read/write operations\\\\nbefore timing out.'], ['`s3.tcp-keep-alive`', 'Enable TCP keep alive on created connections. Defaults to `false`.'], ['`s3.http-proxy`', 'URL of a HTTP proxy server to use for connecting to S3.'], ['`s3.http-proxy.secure`', 'Set to `true` to enable HTTPS for the proxy server.'], ['`s3.http-proxy.username`', 'Proxy username to use if connecting through a proxy server.'], ['`s3.http-proxy.password`', 'Proxy password to use if connecting through a proxy server.'], ['`s3.http-proxy.non-proxy-hosts`', 'Hosts list to access without going through the proxy server.'], ['`s3.http-proxy.preemptive-basic-auth`', 'Whether to attempt to authenticate preemptively against proxy server\\\\nwhen using base authorization, defaults to `false`.'], ['`s3.retry-mode`', 'Specifies how the AWS SDK attempts retries. Default value is `LEGACY`.\\\\nOther allowed values are `STANDARD` and `ADAPTIVE`. The `STANDARD` mode\\\\nincludes a standard set of errors that are retried. `ADAPTIVE` mode\\\\nincludes the functionality of `STANDARD` mode with automatic client-side \\\\nthrottling.'], ['`s3.max-error-retries`', 'Specifies maximum number of retries the client will make on errors.\\\\nDefaults to `20`.'], ['`s3.use-web-identity-token-credentials-provider`', 'Set to `true` to only use the web identity token credentials provider,\\\\ninstead of the default providers chain. This can be useful when running\\\\nTrino on Amazon EKS and using [IAM roles for service accounts\\\\n(IRSA)](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)\\\\nDefaults to `false`.'], ['`s3.application-id`', 'Specify the application identifier appended to the `User-Agent` header \\\\nfor all requests sent to S3. Defaults to `Trino`.\\\\n:::']]\", \"Authentication\": \"Use the following properties to configure the authentication to S3 with access\\nand secret keys, STS, or an IAM role:\\n\\n:::{list-table}\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`s3.aws-access-key`', 'AWS access key to use for authentication.'], ['`s3.aws-secret-key`', 'AWS secret key to use for authentication.'], ['`s3.sts.endpoint`', 'The endpoint URL of the AWS Security Token Service to use for authenticating\\\\nto S3.'], ['`s3.sts.region`', 'AWS region of the STS service.'], ['`s3.iam-role`', 'ARN of an IAM role to assume when connecting to S3.'], ['`s3.role-session-name`', 'Role session name to use when connecting to S3. Defaults to\\\\n`trino-filesystem`.'], ['`s3.external-id`', 'External ID for the IAM role trust policy when connecting to S3.\\\\n:::']]\", \"Security mapping\": \"Trino supports flexible security mapping for S3, allowing for separate\\ncredentials or IAM roles for specific users or S3 locations. The IAM role\\nfor a specific query can be selected from a list of allowed roles by providing\\nit as an *extra credential*.\\n\\nEach security mapping entry may specify one or more match criteria.\\nIf multiple criteria are specified, all criteria must match.\\nThe following match criteria are available:\\n\\n['`user`: Regular expression to match against username. Example: `alice|bob`', '`group`: Regular expression to match against any of the groups that the user\\\\nbelongs to. Example: `finance|sales`', '`prefix`: S3 URL prefix. You can specify an entire bucket or a path within a\\\\nbucket. The URL must start with `s3://` but also matches for `s3a` or `s3n`.\\\\nExample: `s3://bucket-name/abc/xyz/`']\\n\\nThe security mapping must provide one or more configuration settings:\\n\\n['`accessKey` and `secretKey`: AWS access key and secret key. This overrides\\\\nany globally configured credentials, such as access key or instance credentials.', '`iamRole`: IAM role to use if no user provided role is specified as an\\\\nextra credential. This overrides any globally configured IAM role. This role\\\\nis allowed to be specified as an extra credential, although specifying it\\\\nexplicitly has no effect.', \\\"`roleSessionName`: Optional role session name to use with `iamRole`. This can only\\\\nbe used when `iamRole` is specified. If `roleSessionName` includes the string\\\\n`${USER}`, then the `${USER}` portion of the string is replaced with the\\\\ncurrent session's username. If `roleSessionName` is not specified, it defaults\\\\nto `trino-session`.\\\", '`allowedIamRoles`: IAM roles that are allowed to be specified as an extra\\\\ncredential. This is useful because a particular AWS account may have permissions\\\\nto use many roles, but a specific user should only be allowed to use a subset\\\\nof those roles.', '`kmsKeyId`: ID of KMS-managed key to be used for client-side encryption.', '`allowedKmsKeyIds`: KMS-managed key IDs that are allowed to be specified as an extra\\\\ncredential. If list contains `*`, then any key can be specified via extra credential.', '`sseCustomerKey`: The customer provided key (SSE-C) for server-side encryption.', '`allowedSseCustomerKey`: The SSE-C keys that are allowed to be specified as an extra\\\\ncredential. If list contains `*`, then any key can be specified via extra credential.', '`endpoint`: The S3 storage endpoint server. This optional property can be used\\\\nto override S3 endpoints on a per-bucket basis.', '`region`: The S3 region to connect to. This optional property can be used\\\\nto override S3 regions on a per-bucket basis.']\\n\\nThe security mapping entries are processed in the order listed in the JSON configuration.\\nTherefore, specific mappings must be specified before less specific mappings.\\nFor example, the mapping list might have URL prefix `s3://abc/xyz/` followed by\\n`s3://abc/` to allow different configuration for a specific path within a bucket\\nthan for other paths within the bucket. You can specify the default configuration\\nby not including any match criteria for the last entry in the list.\\n\\nIn addition to the preceding rules, the default mapping can contain the optional\\n`useClusterDefault` boolean property set to `true` to use the default S3 configuration.\\nIt cannot be used with any other configuration settings.\\n\\nIf no mapping entry matches and no default is configured, access is denied.\\n\\nThe configuration JSON is read from a file via `s3.security-mapping.config-file`\\nor from an HTTP endpoint via `s3.security-mapping.config-uri`.\\n\\nExample JSON configuration:\\n\\n```\\n{\\n \\\"mappings\\\": [\\n {\\n \\\"prefix\\\": \\\"s3://bucket-name/abc/\\\",\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/test_path\\\"\\n },\\n {\\n \\\"user\\\": \\\"bob|charlie\\\",\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/test_default\\\",\\n \\\"allowedIamRoles\\\": [\\n \\\"arn:aws:iam::123456789101:role/test1\\\",\\n \\\"arn:aws:iam::123456789101:role/test2\\\",\\n \\\"arn:aws:iam::123456789101:role/test3\\\"\\n ]\\n },\\n {\\n \\\"prefix\\\": \\\"s3://special-bucket/\\\",\\n \\\"accessKey\\\": \\\"AKIAxxxaccess\\\",\\n \\\"secretKey\\\": \\\"iXbXxxxsecret\\\"\\n },\\n {\\n \\\"prefix\\\": \\\"s3://regional-bucket/\\\",\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/regional-user\\\",\\n \\\"endpoint\\\": \\\"https://bucket.vpce-1a2b3c4d-5e6f.s3.us-east-1.vpce.amazonaws.com\\\",\\n \\\"region\\\": \\\"us-east-1\\\"\\n },\\n {\\n \\\"prefix\\\": \\\"s3://encrypted-bucket/\\\",\\n \\\"kmsKeyId\\\": \\\"kmsKey_10\\\"\\n },\\n {\\n \\\"user\\\": \\\"test.*\\\",\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/test_users\\\"\\n },\\n {\\n \\\"group\\\": \\\"finance\\\",\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/finance_users\\\"\\n },\\n {\\n \\\"iamRole\\\": \\\"arn:aws:iam::123456789101:role/default\\\"\\n }\\n ]\\n}\\n```\\n\\n:::{list-table} Security mapping properties\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`s3.security-mapping.enabled`', 'Activate the security mapping feature. Defaults to `false`.\\\\nMust be set to `true` for all other properties be used.'], ['`s3.security-mapping.config-file`', 'Path to the JSON configuration file containing security mappings.'], ['`s3.security-mapping.config-uri`', 'HTTP endpoint URI containing security mappings.'], ['`s3.security-mapping.json-pointer`', 'A JSON pointer (RFC 6901) to mappings inside the JSON retrieved from the\\\\nconfiguration file or HTTP endpoint. The default is the root of the document.'], ['`s3.security-mapping.iam-role-credential-name`', 'The name of the *extra credential* used to provide the IAM role.'], ['`s3.security-mapping.kms-key-id-credential-name`', 'The name of the *extra credential* used to provide the KMS-managed key ID.'], ['`s3.security-mapping.sse-customer-key-credential-name`', 'The name of the *extra credential* used to provide the server-side encryption with customer-provided keys (SSE-C).'], ['`s3.security-mapping.refresh-period`', 'How often to refresh the security mapping configuration, specified as a\\\\n{ref}`prop-type-duration`. By default, the configuration is not refreshed.'], ['`s3.security-mapping.colon-replacement`', 'The character or characters to be used instead of a colon character\\\\nwhen specifying an IAM role name as an extra credential.\\\\nAny instances of this replacement value in the extra credential value\\\\nare converted to a colon.\\\\nChoose a value not used in any of your IAM ARNs.\\\\n:::']]\\n\\n(fs-legacy-s3-migration)=\", \"Migration from legacy S3 file system\": \"Trino includes legacy Amazon S3 support to use with a catalog using the Delta\\nLake, Hive, Hudi, or Iceberg connectors. Upgrading existing deployments to the\\ncurrent native implementation is recommended. Legacy support is deprecated and\\nwill be removed.\\n\\nTo migrate a catalog to use the native file system implementation for S3, make\\nthe following edits to your catalog configuration:\\n\\n['Add the `fs.native-s3.enabled=true` catalog configuration property.', 'Refer to the following table to rename your existing legacy catalog\\\\nconfiguration properties to the corresponding native configuration\\\\nproperties. Supported configuration values are identical unless otherwise\\\\nnoted.']\\n\\n:::{list-table}\\n:widths: 35, 35, 65\\n:header-rows: 1\\n\\n[['Legacy property', 'Native property', 'Notes'], ['`hive.s3.aws-access-key`', '`s3.aws-access-key`'], ['`hive.s3.aws-secret-key`', '`s3.aws-secret-key`'], ['`hive.s3.iam-role`', '`s3.iam-role`', 'Also see `s3.role-session-name` in preceding sections\\\\nfor more role configuration options.'], ['`hive.s3.external-id`', '`s3.external-id`'], ['`hive.s3.endpoint`', '`s3.endpoint`', 'Add the `https://` prefix to make the value a correct URL.'], ['`hive.s3.region`', '`s3.region`'], ['`hive.s3.sse.enabled`', 'None', '`s3.sse.type` set to the default value of `NONE` is equivalent to\\\\n`hive.s3.sse.enabled=false`.'], ['`hive.s3.sse.type`', '`s3.sse.type`'], ['`hive.s3.sse.kms-key-id`', '`s3.sse.kms-key-id`'], ['`hive.s3.upload-acl-type`', '`s3.canned-acl`', 'See preceding sections for supported values.'], ['`hive.s3.streaming.part-size`', '`s3.streaming.part-size`'], ['`hive.s3.proxy.host`, `hive.s3.proxy.port`', '`s3.http-proxy`', 'Specify the host and port in one URL, for example `localhost:8888`.'], ['`hive.s3.proxy.protocol`', '`s3.http-proxy.secure`', 'Set to `TRUE` to enable HTTPS.'], ['`hive.s3.proxy.non-proxy-hosts`', '`s3.http-proxy.non-proxy-hosts`'], ['`hive.s3.proxy.username`', '`s3.http-proxy.username`'], ['`hive.s3.proxy.password`', '`s3.http-proxy.password`'], ['`hive.s3.proxy.preemptive-basic-auth`', '`s3.http-proxy.preemptive-basic-auth`'], ['`hive.s3.sts.endpoint`', '`s3.sts.endpoint`'], ['`hive.s3.sts.region`', '`s3.sts.region`'], ['`hive.s3.max-error-retries`', '`s3.max-error-retries`', 'Also see `s3.retry-mode` in preceding sections for more retry behavior\\\\nconfiguration options.'], ['`hive.s3.connect-timeout`', '`s3.socket-connect-timeout`'], ['`hive.s3.connect-ttl`', '`s3.connection-ttl`', 'Also see `s3.connection-max-idle-time` in preceding section for more\\\\nconnection keep-alive options.'], ['`hive.s3.socket-timeout`', '`s3.socket-timeout`', 'Also see `s3.tcp-keep-alive` in preceding sections for more socket\\\\nconnection keep-alive options.'], ['`hive.s3.max-connections`', '`s3.max-connections`'], ['`hive.s3.path-style-access`', '`s3.path-style-access`'], ['`hive.s3.signer-type`', '`s3.signer-type`']]\\n\\n:::\\n\\n['Remove the following legacy configuration properties if they exist in your\\\\ncatalog configuration:', ['`hive.s3.storage-class`', '`hive.s3.signer-class`', '`hive.s3.staging-directory`', '`hive.s3.pin-client-to-current-region`', '`hive.s3.ssl.enabled`', '`hive.s3.sse.enabled`', '`hive.s3.kms-key-id`', '`hive.s3.encryption-materials-provider`', '`hive.s3.streaming.enabled`', '`hive.s3.max-client-retries`', '`hive.s3.max-backoff-time`', '`hive.s3.max-retry-time`', '`hive.s3.multipart.min-file-size`', '`hive.s3.multipart.min-part-size`', '`hive.s3-file-system-type`', '`hive.s3.user-agent-prefix`']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 7]\"}, {\"title\": \"Metastores\", \"description\": null, \"content\": {\"General metastore configuration properties\": \"The following table describes general metastore configuration properties, most\\nof which are used with either metastore.\\n\\nAt a minimum, each Delta Lake, Hive or Hudi object storage catalog file must set\\nthe `hive.metastore` configuration property to define the type of metastore to\\nuse. Iceberg catalogs instead use the `iceberg.catalog.type` configuration\\nproperty to define the type of metastore to use.\\n\\nAdditional configuration properties specific to the Thrift and Glue Metastores\\nare also available. They are discussed later in this topic.\\n\\n:::{list-table} General metastore configuration properties\\n:widths: 35, 50, 15\\n:header-rows: 1\\n\\n[['Property Name', 'Description', 'Default'], ['`hive.metastore`', 'The type of Hive metastore to use. Trino currently supports the default Hive\\\\nThrift metastore (`thrift`), and the AWS Glue Catalog (`glue`) as metadata\\\\nsources. You must use this for all object storage catalogs except Iceberg.', '`thrift`'], ['`iceberg.catalog.type`', 'The Iceberg table format manages most metadata in metadata files in the\\\\nobject storage itself. A small amount of metadata, however, still requires\\\\nthe use of a metastore. In the Iceberg ecosystem, these smaller metastores\\\\nare called Iceberg metadata catalogs, or just catalogs. The examples in each\\\\nsubsection depict the contents of a Trino catalog file that uses the\\\\nIceberg connector to configures different Iceberg metadata catalogs.', 'You must set this property in all Iceberg catalog property files. Valid\\\\nvalues are `hive_metastore`, `glue`, `jdbc`, `rest`, `nessie`, and\\\\n`snowflake`.', '`hive_metastore`'], ['`hive.metastore-cache.cache-partitions`', 'Enable caching for partition metadata. You can disable caching to avoid\\\\ninconsistent behavior that results from it.', '`true`'], ['`hive.metastore-cache.cache-missing`', 'Enable caching the fact that a table is missing to prevent future metastore\\\\ncalls for that table.', '`true`'], ['`hive.metastore-cache.cache-missing-partitions`', 'Enable caching the fact that a partition is missing to prevent future\\\\nmetastore calls for that partition.', '`false`'], ['`hive.metastore-cache.cache-missing-stats`', 'Enable caching the fact that table statistics for a specific table are \\\\nmissing to prevent future metastore calls.', '`false`'], ['`hive.metastore-cache-ttl`', '[Duration](prop-type-duration) of how long cached metastore data is considered valid.', '`0s`'], ['`hive.metastore-stats-cache-ttl`', '[Duration](prop-type-duration) of how long cached metastore statistics are considered valid.', '`5m`'], ['`hive.metastore-cache-maximum-size`', 'Maximum number of metastore data objects in the Hive metastore cache.', '`20000`'], ['`hive.metastore-refresh-interval`', 'Asynchronously refresh cached metastore data after access if it is older\\\\nthan this but is not yet expired, allowing subsequent accesses to see fresh\\\\ndata.'], ['`hive.metastore-refresh-max-threads`', 'Maximum threads used to refresh cached metastore data.', '`10`'], ['`hive.user-metastore-cache-ttl`', '[Duration](prop-type-duration) of how long cached metastore statistics, which are user specific\\\\nin user impersonation scenarios, are considered valid.', '`0s`'], ['`hive.user-metastore-cache-maximum-size`', 'Maximum number of metastore data objects in the Hive metastore cache,\\\\nwhich are user specific in user impersonation scenarios.', '`1000`'], ['`hive.hide-delta-lake-tables`', 'Controls whether to hide Delta Lake tables in table listings. Currently\\\\napplies only when using the AWS Glue metastore.', '`false`\\\\n:::']]\\n\\n(hive-thrift-metastore)=\", \"Thrift metastore configuration properties\": {\"Iceberg-specific Hive catalog configuration properties\": \"When using the Hive catalog, the Iceberg connector supports the same\\n{ref}`general Thrift metastore configuration properties <hive-thrift-metastore>` \\nas previously described with the following additional property:\\n\\n:::{list-table} Iceberg Hive catalog configuration property\\n:widths: 35, 50, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`iceberg.hive-catalog.locking-enabled`', 'Commit to tables using Hive locks.', '`true`\\\\n:::']]\\n\\n:::{warning}\\nSetting `iceberg.hive-catalog.locking-enabled=false` will cause the catalog to\\ncommit to tables without using Hive locks. This should only be set to false if all\\nfollowing conditions are met:\\n\\n['[HIVE-26882](https://issues.apache.org/jira/browse/HIVE-26882) is available on\\\\nthe Hive metastore server. Requires version 2.3.10, 4.0.0-beta-1 or later.', '[HIVE-28121](https://issues.apache.org/jira/browse/HIVE-28121) is available on\\\\nthe Hive metastore server, if it is backed by MySQL or MariaDB. Requires version\\\\n2.3.10, 4.1.0, 4.0.1 or later.', 'All other catalogs committing to tables that this catalogs commits to are also\\\\non Iceberg 1.3 or later, and disabled Hive locks on commit.\\\\n:::']\\n\\n(hive-thrift-metastore-authentication)=\", \"Thrift metastore authentication\": {\"Default `NONE` authentication without impersonation\": \"```\\nhive.metastore.authentication.type=NONE\\n```\\n\\nThe default authentication type for the Hive metastore is `NONE`. When the\\nauthentication type is `NONE`, Trino connects to an unsecured Hive\\nmetastore. Kerberos is not used.\\n\\n(hive-security-metastore-impersonation)=\", \"`KERBEROS` authentication with impersonation\": \"```\\nhive.metastore.authentication.type=KERBEROS\\nhive.metastore.thrift.impersonation.enabled=true\\nhive.metastore.service.principal=hive/hive-metastore-host.example.com@EXAMPLE.COM\\nhive.metastore.client.principal=trino@EXAMPLE.COM\\nhive.metastore.client.keytab=/etc/trino/hive.keytab\\n```\\n\\nWhen the authentication type for the Hive metastore Thrift service is\\n`KERBEROS`, Trino connects as the Kerberos principal specified by the\\nproperty `hive.metastore.client.principal`. Trino authenticates this\\nprincipal using the keytab specified by the `hive.metastore.client.keytab`\\nproperty, and verifies that the identity of the metastore matches\\n`hive.metastore.service.principal`.\\n\\nWhen using `KERBEROS` Metastore authentication with impersonation, the\\nprincipal specified by the `hive.metastore.client.principal` property must be\\nallowed to impersonate the current Trino user, as discussed in the section\\n[](hdfs-security-impersonation).\\n\\nKeytab files must be distributed to every node in the Trino cluster.\\n\\n(hive-glue-metastore)=\"}}, \"AWS Glue catalog configuration properties\": {\"Iceberg-specific Glue catalog configuration properties\": \"When using the Glue catalog, the Iceberg connector supports the same\\n{ref}`general Glue configuration properties <hive-glue-metastore>` as previously\\ndescribed with the following additional property:\\n\\n:::{list-table} Iceberg Glue catalog configuration property\\n:widths: 35, 50, 15\\n:header-rows: 1\\n\\n[['Property name', 'Description', 'Default'], ['`iceberg.glue.cache-table-metadata`', 'While updating the table in AWS Glue, store the table metadata with the\\\\npurpose of accelerating `information_schema.columns` and\\\\n`system.metadata.table_comments` queries.', '`true`\\\\n:::']]\"}, \"Iceberg-specific metastores\": {\"REST catalog\": \"In order to use the Iceberg REST catalog, configure the catalog type\\nwith `iceberg.catalog.type=rest`, and provide further details with the\\nfollowing properties:\\n\\n:::{list-table} Iceberg REST catalog configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`iceberg.rest-catalog.uri`', 'REST server API endpoint URI (required). Example:\\\\n`http://iceberg-with-rest:8181`'], ['`iceberg.rest-catalog.prefix`', 'The prefix for the resource path to use with the REST catalog server (optional).\\\\nExample: `dev`'], ['`iceberg.rest-catalog.warehouse`', 'Warehouse identifier/location for the catalog (optional). Example:\\\\n`s3://my_bucket/warehouse_location`'], ['`iceberg.rest-catalog.security`', 'The type of security to use (default: `NONE`). Possible values are `NONE`, \\\\n`SIGV4` or `OAUTH2`. `OAUTH2` requires either a `token` or `credential`.'], ['`iceberg.rest-catalog.session`', 'Session information included when communicating with the REST Catalog.\\\\nOptions are `NONE` or `USER` (default: `NONE`).'], ['`iceberg.rest-catalog.session-timeout`', '[Duration](prop-type-duration) to keep authentication session in cache. Defaults to `1h`.'], ['`iceberg.rest-catalog.oauth2.token`', 'The bearer token used for interactions with the server. A `token` or\\\\n`credential` is required for `OAUTH2` security. Example: `AbCdEf123456`'], ['`iceberg.rest-catalog.oauth2.credential`', 'The credential to exchange for a token in the OAuth2 client credentials flow\\\\nwith the server. A `token` or `credential` is required for `OAUTH2`\\\\nsecurity. Example: `AbCdEf123456`'], ['`iceberg.rest-catalog.oauth2.scope`', 'Scope to be used when communicating with the REST Catalog. Applicable only\\\\nwhen using `credential`.'], ['`iceberg.rest-catalog.oauth2.server-uri`', 'The endpoint to retrieve access token from OAuth2 Server.'], ['`iceberg.rest-catalog.oauth2.token-refresh-enabled`', 'Controls whether a token should be refreshed if information about its expiration time is available.\\\\nDefaults to `true`'], ['`iceberg.rest-catalog.vended-credentials-enabled`', 'Use credentials provided by the REST backend for file system access.\\\\nDefaults to `false`.'], ['`iceberg.rest-catalog.nested-namespace-enabled`', 'Support querying objects under nested namespace.\\\\nDefaults to `false`.'], ['`iceberg.rest-catalog.view-endpoints-enabled`', 'Enable view endpoints. Defaults to `true`.'], ['`iceberg.rest-catalog.signing-name`', 'AWS SigV4 signing service name. Defaults to `execute-api`.'], ['`iceberg.rest-catalog.case-insensitive-name-matching`', 'Match namespace, table, and view names case insensitively. Defaults to `false`.'], ['`iceberg.rest-catalog.case-insensitive-name-matching.cache-ttl`', '[Duration](prop-type-duration) for which case-insensitive namespace, table, \\\\nand view names are cached. Defaults to `1m`.\\\\n:::']]\\n\\nThe following example shows a minimal catalog configuration using an Iceberg\\nREST metadata catalog:\\n\\n```\\nconnector.name=iceberg\\niceberg.catalog.type=rest\\niceberg.rest-catalog.uri=http://iceberg-with-rest:8181\\n```\\n\\n`iceberg.security` must be `read_only` when connecting to Databricks Unity catalog\\nusing an Iceberg REST catalog:\\n\\n```\\nconnector.name=iceberg\\niceberg.catalog.type=rest\\niceberg.rest-catalog.uri=https://dbc-12345678-9999.cloud.databricks.com/api/2.1/unity-catalog/iceberg\\niceberg.security=read_only\\niceberg.rest-catalog.security=OAUTH2\\niceberg.rest-catalog.oauth2.token=***\\n```\\n\\nThe REST catalog supports [view management](sql-view-management) \\nusing the [Iceberg View specification](https://iceberg.apache.org/view-spec/).\\n\\nThe REST catalog does not support [materialized view management](sql-materialized-view-management).\\n\\n(iceberg-jdbc-catalog)=\", \"JDBC catalog\": \"The Iceberg JDBC catalog is supported for the Iceberg connector. At a minimum,\\n`iceberg.jdbc-catalog.driver-class`, `iceberg.jdbc-catalog.connection-url`,\\n`iceberg.jdbc-catalog.default-warehouse-dir`, and\\n`iceberg.jdbc-catalog.catalog-name` must be configured. When using any\\ndatabase besides PostgreSQL, a JDBC driver jar file must be placed in the plugin\\ndirectory.\\n\\n:::{list-table} JDBC catalog configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`iceberg.jdbc-catalog.driver-class`', 'JDBC driver class name.'], ['`iceberg.jdbc-catalog.connection-url`', 'The URI to connect to the JDBC server.'], ['`iceberg.jdbc-catalog.connection-user`', 'Username for JDBC client.'], ['`iceberg.jdbc-catalog.connection-password`', 'Password for JDBC client.'], ['`iceberg.jdbc-catalog.catalog-name`', 'Iceberg JDBC metastore catalog name.'], ['`iceberg.jdbc-catalog.default-warehouse-dir`', 'The default warehouse directory to use for JDBC.'], ['`iceberg.jdbc-catalog.schema-version`', 'JDBC catalog schema version.\\\\nValid values are `V0` or `V1`. Defaults to `V1`.'], ['`iceberg.jdbc-catalog.retryable-status-codes`', 'On connection error to JDBC metastore, retry if\\\\nit is one of these JDBC status codes.\\\\nValid value is a comma-separated list of status codes.\\\\nNote: JDBC catalog always retries the following status\\\\ncodes: `08000,08003,08006,08007,40001`. Specify only\\\\nadditional codes (such as `57000,57P03,57P04` if using\\\\nPostgreSQL driver) here.\\\\n:::']]\\n\\n:::{warning}\\nThe JDBC catalog may have compatibility issues if Iceberg introduces breaking\\nchanges in the future. Consider the {ref}`REST catalog\\n<iceberg-rest-catalog>` as an alternative solution.\\n\\nThe JDBC catalog requires the metadata tables to already exist.\\nRefer to [Iceberg repository](https://github.com/apache/iceberg/blob/main/core/src/main/java/org/apache/iceberg/jdbc/JdbcUtil.java)\\nfor creating those tables.\\n:::\\n\\nThe following example shows a minimal catalog configuration using an\\nIceberg JDBC metadata catalog:\\n\\n```\\nconnector.name=iceberg\\niceberg.catalog.type=jdbc\\niceberg.jdbc-catalog.catalog-name=test\\niceberg.jdbc-catalog.driver-class=org.postgresql.Driver\\niceberg.jdbc-catalog.connection-url=jdbc:postgresql://example.net:5432/database\\niceberg.jdbc-catalog.connection-user=admin\\niceberg.jdbc-catalog.connection-password=test\\niceberg.jdbc-catalog.default-warehouse-dir=s3://bucket\\n```\\n\\nThe JDBC catalog does not support [materialized view management](sql-materialized-view-management).\\n\\n(iceberg-nessie-catalog)=\", \"Nessie catalog\": \"In order to use a Nessie catalog, configure the catalog type with\\n`iceberg.catalog.type=nessie` and provide further details with the following\\nproperties:\\n\\n:::{list-table} Nessie catalog configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`iceberg.nessie-catalog.uri`', 'Nessie API endpoint URI (required). Example:\\\\n`https://localhost:19120/api/v2`'], ['`iceberg.nessie-catalog.ref`', 'The branch/tag to use for Nessie. Defaults to `main`.'], ['`iceberg.nessie-catalog.default-warehouse-dir`', 'Default warehouse directory for schemas created without an explicit\\\\n`location` property. Example: `/tmp`'], ['`iceberg.nessie-catalog.read-timeout`', 'The read timeout [duration](prop-type-duration) for requests to the Nessie\\\\nserver. Defaults to `25s`.'], ['`iceberg.nessie-catalog.connection-timeout`', 'The connection timeout [duration](prop-type-duration) for connection\\\\nrequests to the Nessie server. Defaults to `5s`.'], ['`iceberg.nessie-catalog.enable-compression`', 'Configure whether compression should be enabled or not for requests to the\\\\nNessie server. Defaults to `true`.'], ['`iceberg.nessie-catalog.authentication.type`', 'The authentication type to use. Available value is `BEARER`. Defaults to no\\\\nauthentication.'], ['`iceberg.nessie-catalog.authentication.token`', 'The token to use with `BEARER` authentication. Example:\\\\n`SXVLUXUhIExFQ0tFUiEK`'], ['`iceberg.nessie-catalog.client-api-version`', 'Optional version of the Client API version to use. By default it is inferred from the `iceberg.nessie-catalog.uri` value.\\\\nValid values are `V1` or `V2`.\\\\n:::']]\\n\\n```\\nconnector.name=iceberg\\niceberg.catalog.type=nessie\\niceberg.nessie-catalog.uri=https://localhost:19120/api/v2\\niceberg.nessie-catalog.default-warehouse-dir=/tmp\\n```\\n\\nThe Nessie catalog does not support [view management](sql-view-management) or\\n[materialized view management](sql-materialized-view-management).\\n\\n(iceberg-snowflake-catalog)=\", \"Snowflake catalog\": \"In order to use a Snowflake catalog, configure the catalog type with\\n`iceberg.catalog.type=snowflake` and provide further details with the following\\nproperties:\\n\\n:::{list-table} Snowflake catalog configuration properties\\n:widths: 40, 60\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`iceberg.snowflake-catalog.account-uri`', 'Snowflake JDBC account URI (required). Example:\\\\n`jdbc:snowflake://example123456789.snowflakecomputing.com`'], ['`iceberg.snowflake-catalog.user`', 'Snowflake user (required).'], ['`iceberg.snowflake-catalog.password`', 'Snowflake password (required).'], ['`iceberg.snowflake-catalog.database`', 'Snowflake database name (required).'], ['`iceberg.snowflake-catalog.role`', 'Snowflake role name\\\\n:::']]\\n\\n```\\nconnector.name=iceberg\\niceberg.catalog.type=snowflake\\niceberg.snowflake-catalog.account-uri=jdbc:snowflake://example1234567890.snowflakecomputing.com\\niceberg.snowflake-catalog.user=user\\niceberg.snowflake-catalog.password=secret\\niceberg.snowflake-catalog.database=db\\n```\\n\\nWhen using the Snowflake catalog, data management tasks such as creating tables,\\nmust be performed in Snowflake because using the catalog from external systems\\nlike Trino only supports `SELECT` queries and other [read operations](sql-read-operations).\\n\\nAdditionally, the [Snowflake-created Iceberg\\ntables](https://docs.snowflake.com/en/sql-reference/sql/create-iceberg-table-snowflake)\\ndo not expose partitioning information, which prevents efficient parallel reads\\nand therefore can have significant negative performance implications.\\n\\nThe Snowflake catalog does not support [view management](sql-view-management) or\\n[materialized view management](sql-materialized-view-management).\\n\\nFurther information is available in the [Snowflake catalog\\ndocumentation](https://docs.snowflake.com/en/user-guide/tables-iceberg-catalog).\\n\\n(partition-projection)=\"}, \"Access tables with Athena partition projection metadata\": \"[Partition projection](https://docs.aws.amazon.com/athena/latest/ug/partition-projection.html)\\nis a feature of AWS Athena often used to speed up query processing with highly\\npartitioned tables when using the Hive connector.\\n\\nTrino supports partition projection table properties stored in the Hive\\nmetastore or Glue catalog, and it reimplements this functionality. Currently,\\nthere is a limitation in comparison to AWS Athena for date projection, as it\\nonly supports intervals of `DAYS`, `HOURS`, `MINUTES`, and `SECONDS`.\\n\\nIf there are any compatibility issues blocking access to a requested table when\\npartition projection is enabled, set the\\n`partition_projection_ignore` table property to `true` for a table to bypass\\nany errors.\\n\\nRefer to {ref}`hive-table-properties` and {ref}`hive-column-properties` for\\nconfiguration of partition projection.\", \"Configure metastore for Avro\": \"For catalogs using the Hive connector, you must add the following property\\ndefinition to the Hive metastore configuration file `hive-site.xml` and\\nrestart the metastore service to enable first-class support for Avro tables when\\nusing Hive 3.x:\\n\\n```\\n<property>\\n <!-- https://community.hortonworks.com/content/supportkb/247055/errorjavalangunsupportedoperationexception-storage.html -->\\n <name>metastore.storage.schema.reader.impl</name>\\n <value>org.apache.hadoop.hive.metastore.SerDeStorageSchemaReader</value>\\n </property>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 25]\"}, {\"title\": \"Optimizer\", \"description\": \"Documentation section: optimizer\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/optimizer\"}, \"subpages\": [{\"title\": \"Adaptive plan optimizations\", \"description\": null, \"content\": {\"Adaptive reordering of partitioned joins\": \"By default, Trino enables adaptive reordering of partitioned joins. This\\noptimization allows Trino to dynamically reorder the join inputs, based\\non the actual size of the build and probe sides during query execution.\\nThis is particularly useful when table statistics are not available\\nbeforehand, as it can improve query performance by making more efficient\\njoin order decisions based on runtime information.\\n\\nTo deactivate this optimization, set the\\n`fault-tolerant-execution-adaptive-join-reordering-enabled`\\nconfiguration property to `false`. The equivalent session property is\\n`fault_tolerant_execution_adaptive_join_reordering_enabled`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 0]\"}, {\"title\": \"Cost-based optimizations\", \"description\": null, \"content\": {\"Join enumeration\": \"The order in which joins are executed in a query can have a significant impact\\non the query's performance. The aspect of join ordering that has the largest\\nimpact on performance is the size of the data being processed and transferred\\nover the network. If a join which produces a lot of data is performed early in\\nthe query's execution, then subsequent stages need to process large amounts of\\ndata for longer than necessary, increasing the time and resources needed for\\nprocessing the query.\\n\\nWith cost-based join enumeration, Trino uses {doc}`/optimizer/statistics`\\nprovided by connectors to estimate the costs for different join orders and\\nautomatically picks the join order with the lowest computed costs.\\n\\nThe join enumeration strategy is governed by the `join_reordering_strategy`\\n{ref}`session property <session-properties-definition>`, with the\\n`optimizer.join-reordering-strategy` configuration property providing the\\ndefault value.\\n\\nThe possible values are:\\n\\n['`AUTOMATIC` (default) - enable full automatic join enumeration', '`ELIMINATE_CROSS_JOINS` - eliminate unnecessary cross joins', '`NONE` - purely syntactic join order']\\n\\nIf you are using `AUTOMATIC` join enumeration and statistics are not\\navailable or a cost can not be computed for any other reason, the\\n`ELIMINATE_CROSS_JOINS` strategy is used instead.\", \"Join distribution selection\": {\"Capping replicated table size\": \"The join distribution type is automatically chosen when the join reordering\\nstrategy is set to `AUTOMATIC` or when the join distribution type is set to\\n`AUTOMATIC`. In both cases, it is possible to cap the maximum size of the\\nreplicated table with the `join-max-broadcast-table-size` configuration\\nproperty or with the `join_max_broadcast_table_size` session property. This\\nallows you to improve cluster concurrency and prevent bad plans when the\\ncost-based optimizer misestimates the size of the joined tables.\\n\\nBy default, the replicated table size is capped to 100MB.\"}, \"Syntactic join order\": \"If not using cost-based optimization, Trino defaults to syntactic join ordering.\\nWhile there is no formal way to optimize queries for this case, it is possible\\nto take advantage of how Trino implements joins to make them more performant.\\n\\nTrino uses in-memory hash joins. When processing a join statement, Trino loads\\nthe right-most table of the join into memory as the build side, then streams the\\nnext right-most table as the probe side to execute the join. If a query has\\nmultiple joins, the result of this first join stays in memory as the build side,\\nand the third right-most table is then used as the probe side, and so on for\\nadditional joins. In the case where join order is made more complex, such as\\nwhen using parentheses to specify specific parents for joins, Trino may execute\\nmultiple lower-level joins at once, but each step of that process follows the\\nsame logic, and the same applies when the results are ultimately joined\\ntogether.\\n\\nBecause of this behavior, it is optimal to syntactically order joins in your SQL\\nqueries from the largest tables to the smallest, as this minimizes memory usage.\\n\\nAs an example, if you have a small, medium, and large table and are using left\\njoins:\\n\\n```\\nSELECT\\n *\\nFROM\\n large_table l\\n LEFT JOIN medium_table m ON l.user_id = m.user_id\\n LEFT JOIN small_table s ON s.user_id = l.user_id\\n```\\n\\n:::{warning}\\nThis means of optimization is not a feature of Trino. It is an artifact of\\nhow joins are implemented, and therefore this behavior may change without\\nnotice.\\n:::\", \"Connector implementations\": \"In order for the Trino optimizer to use the cost based strategies,\\nthe connector implementation must provide {doc}`statistics`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 1]\"}, {\"title\": \"Cost In Explain\", \"description\": null, \"content\": {\"Cost in EXPLAIN\": \"During planning, the cost associated with each node of the plan is computed\\nbased on the table statistics for the tables in the query. This calculated\\ncost is printed as part of the output of an {doc}`/sql/explain` statement.\\n\\nCost information is displayed in the plan tree using the format `{rows: XX\\n(XX), cpu: XX, memory: XX, network: XX}`. `rows` refers to the expected\\nnumber of rows output by each plan node during execution. The value in the\\nparentheses following the number of rows refers to the expected size of the data\\noutput by each plan node in bytes. Other parameters indicate the estimated\\namount of CPU, memory, and network utilized by the execution of a plan node.\\nThese values do not represent any actual unit, but are numbers that are used to\\ncompare the relative costs between plan nodes, allowing the optimizer to choose\\nthe best plan for executing a query. If any of the values is not known, a `?`\\nis printed.\\n\\nFor example:\\n\\n```\\nEXPLAIN SELECT comment FROM tpch.sf1.nation WHERE nationkey > 3;\\n```\\n\\n```\\n- Output[comment] => [[comment]]\\n Estimates: {rows: 22 (1.69kB), cpu: 6148.25, memory: 0.00, network: 1734.25}\\n - RemoteExchange[GATHER] => [[comment]]\\n Estimates: {rows: 22 (1.69kB), cpu: 6148.25, memory: 0.00, network: 1734.25}\\n - ScanFilterProject[table = tpch:nation:sf1.0, filterPredicate = (\\\"nationkey\\\" > BIGINT '3')] => [[comment]]\\n Estimates: {rows: 25 (1.94kB), cpu: 2207.00, memory: 0.00, network: 0.00}/{rows: 22 (1.69kB), cpu: 4414.00, memory: 0.00, network: 0.00}/{rows: 22 (1.69kB), cpu: 6148.25, memory: 0.00, network: 0.00}\\n nationkey := tpch:nationkey\\n comment := tpch:comment\\n```\\n\\nGenerally, there is only one cost printed for each plan node. However, when a\\n`Scan` operator is combined with a `Filter` and/or `Project` operator,\\nthen multiple cost structures are printed, each corresponding to an\\nindividual logical part of the combined operator. For example, three cost\\nstructures are printed for a `ScanFilterProject` operator, corresponding\\nto the `Scan`, `Filter`, and `Project` parts of the operator, in that order.\\n\\nEstimated cost is also printed in {doc}`/sql/explain-analyze` in addition to actual\\nruntime statistics.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 2]\"}, {\"title\": \"Pushdown\", \"description\": null, \"content\": {\"Predicate pushdown\": \"Predicate pushdown optimizes row-based filtering. It uses the inferred filter,\\ntypically resulting from a condition in a `WHERE` clause to omit unnecessary\\nrows. The processing is pushed down to the data source by the connector and then\\nprocessed by the data source.\\n\\nIf predicate pushdown for a specific clause is successful, the `EXPLAIN` plan\\nfor the query does not include a `ScanFilterProject` operation for that\\nclause.\\n\\n(projection-pushdown)=\", \"Projection pushdown\": \"Projection pushdown optimizes column-based filtering. It uses the columns\\nspecified in the `SELECT` clause and other parts of the query to limit access\\nto these columns. The processing is pushed down to the data source by the\\nconnector and then the data source only reads and returns the necessary\\ncolumns.\\n\\nIf projection pushdown is successful, the `EXPLAIN` plan for the query only\\naccesses the relevant columns in the `Layout` of the `TableScan` operation.\\n\\n(dereference-pushdown)=\", \"Dereference pushdown\": \"Projection pushdown and dereference pushdown limit access to relevant columns,\\nexcept dereference pushdown is more selective. It limits access to only read the\\nspecified fields within a top level or nested `ROW` data type.\\n\\nFor example, consider a table in the Hive connector that has a `ROW` type\\ncolumn with several fields. If a query only accesses one field, dereference\\npushdown allows the file reader to read only that single field within the row.\\nThe same applies to fields of a row nested within the top level row. This can\\nresult in significant savings in the amount of data read from the storage\\nsystem.\\n\\n(aggregation-pushdown)=\", \"Aggregation pushdown\": {\"Limitations\": \"Aggregation pushdown does not support a number of more complex statements:\\n\\n['complex grouping operations such as `ROLLUP`, `CUBE`, or `GROUPING SETS`', 'expressions inside the aggregation function call: `sum(a * b)`', 'coercions: `sum(integer_column)`', '{ref}`aggregations with ordering <aggregate-function-ordering-during-aggregation>`', '{ref}`aggregations with filter <aggregate-function-filtering-during-aggregation>`']\\n\\n(join-pushdown)=\"}, \"Join pushdown\": \"Join pushdown allows the connector to delegate the table join operation to the\\nunderlying data source. This can result in performance gains, and allows Trino\\nto perform the remaining query processing on a smaller amount of data.\\n\\nThe specifics for the supported pushdown of table joins varies for each data\\nsource, and therefore for each connector.\\n\\nHowever, there are some generic conditions that must be met in order for a join\\nto be pushed down:\\n\\n['all predicates that are part of the join must be possible to be pushed down', 'the tables in the join must be from the same catalog']\\n\\nYou can verify if pushdown for a specific join is performed by looking at the\\n{doc}`EXPLAIN </sql/explain>` plan of the query. The explain plan does not\\nshow a `Join` operator, if the join is pushed down to the data source by the\\nconnector:\\n\\n```\\nEXPLAIN SELECT c.custkey, o.orderkey\\nFROM orders o JOIN customer c ON c.custkey = o.custkey;\\n```\\n\\nThe following plan results from the PostgreSQL connector querying TPC-H\\ndata in a PostgreSQL database. It does not show any `Join` operator as a\\nresult of the successful join push down.\\n\\n```\\nFragment 0 [SINGLE]\\n Output layout: [custkey, orderkey]\\n Output partitioning: SINGLE []\\n Output[custkey, orderkey]\\n \\u2502 Layout: [custkey:bigint, orderkey:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: ?}\\n \\u2514\\u2500 RemoteSource[1]\\n Layout: [orderkey:bigint, custkey:bigint]\\n\\nFragment 1 [SOURCE]\\n Output layout: [orderkey, custkey]\\n Output partitioning: SINGLE []\\n TableScan[postgres:Query[SELECT l.\\\"orderkey\\\" AS \\\"orderkey_0\\\", l.\\\"custkey\\\" AS \\\"custkey_1\\\", r.\\\"custkey\\\" AS \\\"custkey_2\\\" FROM (SELECT \\\"orderkey\\\", \\\"custkey\\\" FROM \\\"tpch\\\".\\\"orders\\\") l INNER JOIN (SELECT \\\"custkey\\\" FROM \\\"tpch\\\".\\\"customer\\\") r O\\n Layout: [orderkey:bigint, custkey:bigint]\\n Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: 0B}\\n orderkey := orderkey_0:bigint:int8\\n custkey := custkey_1:bigint:int8\\n```\\n\\nIt is typically beneficial to push down a join. Pushing down a join can also\\nincrease the row count compared to the size of the input to the join. This\\nmay impact performance.\\n\\n(limit-pushdown)=\", \"Limit pushdown\": \"A {ref}`limit-clause` reduces the number of returned records for a statement.\\nLimit pushdown enables a connector to push processing of such queries of\\nunsorted record to the underlying data source.\\n\\nA pushdown of this clause can improve the performance of the query and\\nsignificantly reduce the amount of data transferred from the data source to\\nTrino.\\n\\nQueries include sections such as `LIMIT N` or `FETCH FIRST N ROWS`.\\n\\nImplementation and support is connector-specific since different data sources have varying capabilities.\\n\\n(topn-pushdown)=\", \"Top-N pushdown\": \"The combination of a {ref}`limit-clause` with an {ref}`order-by-clause` creates\\na small set of records to return out of a large sorted dataset. It relies on the\\norder to determine which records need to be returned, and is therefore quite\\ndifferent to optimize compared to a {ref}`limit-pushdown`.\\n\\nThe pushdown for such a query is called a Top-N pushdown, since the operation is\\nreturning the top N rows. It enables a connector to push processing of such\\nqueries to the underlying data source, and therefore significantly reduces the\\namount of data transferred to and processed by Trino.\\n\\nQueries include sections such as `ORDER BY ... LIMIT N` or `ORDER BY ...\\nFETCH FIRST N ROWS`.\\n\\nImplementation and support is connector-specific since different data sources\\nsupport different SQL syntax and processing.\\n\\nFor example, you can find two queries to learn how to identify Top-N pushdown behavior in the following section.\\n\\nFirst, a concrete example of a Top-N pushdown query on top of a PostgreSQL database:\\n\\n```\\nSELECT id, name\\nFROM postgresql.public.company\\nORDER BY id\\nLIMIT 5;\\n```\\n\\nYou can get the explain plan by prepending the above query with `EXPLAIN`:\\n\\n```\\nEXPLAIN SELECT id, name\\nFROM postgresql.public.company\\nORDER BY id\\nLIMIT 5;\\n```\\n\\n```\\nFragment 0 [SINGLE]\\n Output layout: [id, name]\\n Output partitioning: SINGLE []\\n Stage Execution Strategy: UNGROUPED_EXECUTION\\n Output[id, name]\\n \\u2502 Layout: [id:integer, name:varchar]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: ?}\\n \\u2514\\u2500 RemoteSource[1]\\n Layout: [id:integer, name:varchar]\\n\\nFragment 1 [SOURCE]\\n Output layout: [id, name]\\n Output partitioning: SINGLE []\\n Stage Execution Strategy: UNGROUPED_EXECUTION\\n TableScan[postgresql:public.company public.company sortOrder=[id:integer:int4 ASC NULLS LAST] limit=5, grouped = false]\\n Layout: [id:integer, name:varchar]\\n Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: 0B}\\n name := name:varchar:text\\n id := id:integer:int4\\n```\\n\\nSecond, an example of a Top-N query on the `tpch` connector which does not support\\nTop-N pushdown functionality:\\n\\n```\\nSELECT custkey, name\\nFROM tpch.sf1.customer\\nORDER BY custkey\\nLIMIT 5;\\n```\\n\\nThe related query plan:\\n\\n```\\nFragment 0 [SINGLE]\\n Output layout: [custkey, name]\\n Output partitioning: SINGLE []\\n Stage Execution Strategy: UNGROUPED_EXECUTION\\n Output[custkey, name]\\n \\u2502 Layout: [custkey:bigint, name:varchar(25)]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 TopN[5 by (custkey ASC NULLS LAST)]\\n \\u2502 Layout: [custkey:bigint, name:varchar(25)]\\n \\u2514\\u2500 LocalExchange[SINGLE] ()\\n \\u2502 Layout: [custkey:bigint, name:varchar(25)]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 RemoteSource[1]\\n Layout: [custkey:bigint, name:varchar(25)]\\n\\nFragment 1 [SOURCE]\\n Output layout: [custkey, name]\\n Output partitioning: SINGLE []\\n Stage Execution Strategy: UNGROUPED_EXECUTION\\n TopNPartial[5 by (custkey ASC NULLS LAST)]\\n \\u2502 Layout: [custkey:bigint, name:varchar(25)]\\n \\u2514\\u2500 TableScan[tpch:customer:sf1.0, grouped = false]\\n Layout: [custkey:bigint, name:varchar(25)]\\n Estimates: {rows: 150000 (4.58MB), cpu: 4.58M, memory: 0B, network: 0B}\\n custkey := tpch:custkey\\n name := tpch:name\\n```\\n\\nIn the preceding query plan, the Top-N operation `TopN[5 by (custkey ASC NULLS LAST)]`\\nis being applied in the `Fragment 0` by Trino and not by the source database.\\n\\nNote that, compared to the query executed on top of the `tpch` connector,\\nthe explain plan of the query applied on top of the `postgresql` connector\\nis missing the reference to the operation `TopN[5 by (id ASC NULLS LAST)]`\\nin the `Fragment 0`.\\nThe absence of the `TopN` Trino operator in the `Fragment 0` from the query plan\\ndemonstrates that the query benefits of the Top-N pushdown optimization.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 3]\"}, {\"title\": \"Table statistics\", \"description\": null, \"content\": {\"Available statistics\": \"The following statistics are available in Trino:\\n\\n['For a table:', ['**row count**: the total number of rows in the table'], 'For each column in a table:', ['**data size**: the size of the data that needs to be read', '**nulls fraction**: the fraction of null values', '**distinct value count**: the number of distinct values', '**low value**: the smallest value in the column', '**high value**: the largest value in the column']]\\n\\nThe set of statistics available for a particular query depends on the connector\\nbeing used and can also vary by table. For example, the\\nHive connector does not currently provide statistics on data size.\\n\\nTable statistics can be displayed via the Trino SQL interface using the\\n[](/sql/show-stats) command.\\n\\nDepending on the connector support, table statistics are updated by Trino when\\nexecuting [data management statements](sql-data-management) like `INSERT`,\\n`UPDATE`, or `DELETE`. For example, the [Delta Lake\\nconnector](delta-lake-table-statistics), the [Hive connector](hive-analyze), and\\nthe [Iceberg connector](iceberg-table-statistics) all support table statistics\\nmanagement from Trino. \\n\\nYou can also initialize statistics collection with the [](/sql/analyze) command.\\nThis is needed when other systems manipulate the data without Trino, and\\ntherefore statistics tracked by Trino are out of date. Other connectors rely on\\nthe underlying data source to manage table statistics or do not support table\\nstatistics use at all.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 26]\"}, {\"title\": \"Overview\", \"description\": \"Documentation section: overview\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/overview\"}, \"subpages\": [{\"title\": \"Trino concepts\", \"description\": null, \"content\": {\"Overview\": \"To understand Trino, you must first understand the terms and concepts\\nused throughout the Trino documentation.\\n\\nWhile it is easy to understand statements and queries, as an end-user\\nyou should have familiarity with concepts such as stages and splits to\\ntake full advantage of Trino to execute efficient queries. As a\\nTrino administrator or a Trino contributor you should understand how\\nTrino's concepts of stages map to tasks and how tasks contain a set\\nof drivers which process data.\\n\\nThis section provides a solid definition for the core concepts\\nreferenced throughout Trino, and these sections are sorted from most\\ngeneral to most specific.\\n\\n:::{note}\\nThe book [Trino: The Definitive Guide](https://trino.io/trino-the-definitive-guide.html) and the research\\npaper [Presto: SQL on Everything](https://trino.io/paper.html) can\\nprovide further information about Trino and the concepts in use.\\n:::\\n\\n(trino-concept-architecture)=\", \"Architecture\": {\"Cluster\": \"A Trino cluster consists of several Trino [nodes](trino-concept-node) - one\\n[coordinator](trino-concept-coordinator) and zero or more\\n[workers](trino-concept-worker). Users connect to the coordinator with their\\n[SQL](glossSQL) query tool. The coordinator collaborates with the workers. The\\ncoordinator and the workers access the connected [data\\nsources](trino-concept-data-source). This access is configured in\\n[catalogs](trino-concept-catalog).\\n\\nProcessing each query is a stateful operation. The workload is orchestrated by\\nthe coordinator and spread parallel across all workers in the cluster. Each node\\nruns Trino in one JVM instance, and processing is parallelized further using\\nthreads.\\n\\n(trino-concept-node)=\", \"Node\": \"Any Trino server in a specific Trino cluster is considered a **node** of the\\n[cluster](trino-concept-cluster). Technically this refers to the Java process\\nrunning the Trino program, but node is often used to refer to the computer\\nrunning the process due to the recommendation to run only one Trino process per\\ncomputer.\\n\\n(trino-concept-coordinator)=\", \"Coordinator\": \"The Trino coordinator is the server that is responsible for parsing\\nstatements, planning queries, and managing Trino worker nodes. It is\\nthe \\\"brain\\\" of a Trino installation and is also the node to which a\\nclient connects to submit statements for execution. Every Trino\\ninstallation must have a Trino coordinator alongside one or more\\nTrino workers. For development or testing purposes, a single\\ninstance of Trino can be configured to perform both roles.\\n\\nThe coordinator keeps track of the activity on each worker and\\ncoordinates the execution of a query. The coordinator creates\\na logical model of a query involving a series of stages, which is then\\ntranslated into a series of connected tasks running on a cluster of\\nTrino workers.\\n\\nCoordinators communicate with workers and clients using a REST API.\\n\\n(trino-concept-worker)=\", \"Worker\": \"A Trino worker is a server in a Trino installation, which is responsible\\nfor executing tasks and processing data. Worker nodes fetch data from\\nconnectors and exchange intermediate data with each other. The coordinator\\nis responsible for fetching results from the workers and returning the\\nfinal results to the client.\\n\\nWhen a Trino worker process starts up, it advertises itself to the discovery\\nserver in the coordinator, which makes it available to the Trino coordinator\\nfor task execution.\\n\\nWorkers communicate with other workers and Trino coordinators\\nusing a REST API.\\n\\n(trino-concept-client)=\"}, \"Client\": \"Clients allow you to connect to Trino, submit SQL queries, and receive the\\nresults. Clients can access all configured data sources using\\n[catalogs](trino-concept-catalog). Clients are full-featured client applications\\nor client drivers and libraries that allow you to connect with any application\\nsupporting that driver, or even your own custom application or script.\\n\\nClients applications include command line tools, desktop applications, web-based\\napplications, and software-as-a-service solutions with features such as\\ninteractive SQL query authoring with editors, or rich user interfaces for\\ngraphical query creation, query running and result rendering, visualizations\\nwith charts and graphs, reporting, and dashboard creation.\\n\\nClient application that support other query languages or user interface\\ncomponents to build a query, must translate each request to [SQL as supported by\\nTrino](/language).\\n\\nMore details are available in the [Trino client documentation](/client).\\n\\n(trino-concept-plugin)=\", \"Plugin\": \"Trino uses a plugin architecture to extend its capabilities and integrate with\\nvarious data sources and other systems. Details about different types of\\nplugins, installation, removal, and other aspects are available in the [Plugin\\ndocumentation](/installation/plugins).\\n\\n(trino-concept-data-source)=\", \"Data source\": {\"Connector\": \"A connector adapts Trino to a data source such as a data lake using Hadoop/Hive\\nor Apache Iceberg, or a relational database such as PostgreSQL. You can think of\\na connector the same way you think of a driver for a database. It is an\\nimplementation of Trino's [service provider interface\\n(SPI)](/develop/spi-overview), which allows Trino to interact with a resource\\nusing a standard API.\\n\\nTrino contains [many built-in connectors](/connector):\\n\\n['Connectors for data lakes and lakehouses including the [Delta\\\\nLake](/connector/delta-lake), [Hive](/connector/hive),\\\\n[Hudi](/connector/hudi), and [Iceberg](/connector/iceberg) connectors.', 'Connectors for relational database management systems, including the\\\\n[MySQL](/connector/mysql), [PostgreSQL](/connector/postgresql),\\\\n[Oracle](/connector/oracle), and [SQL Server](/connector/sqlserver)\\\\nconnectors.', 'Connectors for a variety of other systems, including the\\\\n[Cassandra](/connector/cassandra), [ClickHouse](/connector/clickhouse),\\\\n[OpenSearch](/connector/opensearch), [Pinot](/connector/pinot),\\\\n[Prometheus](/connector/prometheus), [SingleStore](/connector/singlestore),\\\\nand [Snowflake](/connector/snowflake) connectors.', 'A number of other utility connectors such as the [JMX](/connector/jmx),\\\\n[System](/connector/system), and [TPC-H](/connector/tpch) connectors.']\\n\\nEvery catalog uses a specific connector. If you examine a catalog configuration\\nfile, you see that each contains a mandatory property `connector.name` with the\\nvalue identifying the connector.\\n\\n(trino-concept-catalog)=\", \"Catalog\": \"A Trino catalog is a collection of configuration properties used to access a\\nspecific data source, including the required connector and any other details\\nsuch as credentials and URL. Catalogs are defined in properties files stored in\\nthe Trino configuration directory. The name of the properties file determines\\nthe name of the catalog. For example, the properties file\\n`etc/example.properties` results in a catalog name `example`.\\n\\nYou can configure and use many catalogs, with different or identical connectors,\\nto access different data sources. For example, if you have two data lakes, you\\ncan configure two catalogs in a single Trino cluster that both use the Hive\\nconnector, allowing you to query data from both clusters, even within the same\\nSQL query. You can also use a Hive connector for one catalog to access a data\\nlake, and use the Iceberg connector for another catalog to access the data\\nlakehouse. Or, you can configure different catalogs to access different\\nPostgreSQL database. The combination of different catalogs is determined by your\\nneeds to access different data sources only.\\n\\nA catalog contains one or more schemas, which in turn contain objects such as\\ntables, views, or materialized views. When addressing an objects such as tables\\nin Trino, the fully-qualified name is always rooted in a catalog. For example, a\\nfully-qualified table name of `example.test_data.test` refers to the `test`\\ntable in the `test_data` schema in the `example` catalog.\", \"Schema\": \"Schemas are a way to organize tables. Together, a catalog and schema define a\\nset of tables and other objects that can be queried. When accessing Hive or a\\nrelational database such as MySQL with Trino, a schema translates to the same\\nconcept in the target database. Other types of connectors may organize tables\\ninto schemas in a way that makes sense for the underlying data source.\", \"Table\": \"A table is a set of unordered rows, which are organized into named columns with\\n[types](/language/types). This is the same as in any relational database. Type\\nmapping from source data to Trino is defined by the connector, varies across\\nconnectors, and is documented in the specific connector documentation, for\\nexample the [type mapping in the PostgreSQL connector](postgresql-type-mapping).\"}, \"Query execution model\": {\"Statement\": \"Trino executes ANSI-compatible SQL statements. When the Trino\\ndocumentation refers to a statement, it is referring to statements as\\ndefined in the ANSI SQL standard, which consists of clauses,\\nexpressions, and predicates.\\n\\nSome readers might be curious why this section lists separate concepts\\nfor statements and queries. This is necessary because, in Trino,\\nstatements simply refer to the textual representation of a statement written\\nin SQL. When a statement is executed, Trino creates a query along\\nwith a query plan that is then distributed across a series of Trino\\nworkers.\", \"Query\": \"When Trino parses a statement, it converts it into a query and creates\\na distributed query plan, which is then realized as a series of\\ninterconnected stages running on Trino workers. When you retrieve\\ninformation about a query in Trino, you receive a snapshot of every\\ncomponent that is involved in producing a result set in response to a\\nstatement.\\n\\nThe difference between a statement and a query is simple. A statement\\ncan be thought of as the SQL text that is passed to Trino, while a query\\nrefers to the configuration and components instantiated to execute\\nthat statement. A query encompasses stages, tasks, splits, connectors,\\nand other components and data sources working in concert to produce a\\nresult.\\n\\n(trino-concept-stage)=\", \"Stage\": \"When Trino executes a query, it does so by breaking up the execution\\ninto a hierarchy of stages. For example, if Trino needs to aggregate\\ndata from one billion rows stored in Hive, it does so by creating a\\nroot stage to aggregate the output of several other stages, all of\\nwhich are designed to implement different sections of a distributed\\nquery plan.\\n\\nThe hierarchy of stages that comprises a query resembles a tree.\\nEvery query has a root stage, which is responsible for aggregating\\nthe output from other stages. Stages are what the coordinator uses to\\nmodel a distributed query plan, but stages themselves don't run on\\nTrino workers.\\n\\n(trino-concept-task)=\", \"Task\": \"As mentioned in the previous section, stages model a particular\\nsection of a distributed query plan, but stages themselves don't\\nexecute on Trino workers. To understand how a stage is executed,\\nyou need to understand that a stage is implemented as a series of\\ntasks distributed over a network of Trino workers.\\n\\nTasks are the \\\"work horse\\\" in the Trino architecture as a distributed\\nquery plan is deconstructed into a series of stages, which are then\\ntranslated to tasks, which then act upon or process splits. A Trino\\ntask has inputs and outputs, and just as a stage can be executed in\\nparallel by a series of tasks, a task is executing in parallel with a\\nseries of drivers.\\n\\n(trino-concept-splits)=\", \"Split\": \"Tasks operate on splits, which are sections of a larger data\\nset. Stages at the lowest level of a distributed query plan retrieve\\ndata via splits from connectors, and intermediate stages at a higher\\nlevel of a distributed query plan retrieve data from other stages.\\n\\nWhen Trino is scheduling a query, the coordinator queries a\\nconnector for a list of all splits that are available for a table.\\nThe coordinator keeps track of which machines are running which tasks,\\nand what splits are being processed by which tasks.\", \"Driver\": \"Tasks contain one or more parallel drivers. Drivers act upon data and\\ncombine operators to produce output that is then aggregated by a task\\nand then delivered to another task in another stage. A driver is a\\nsequence of operator instances, or you can think of a driver as a\\nphysical set of operators in memory. It is the lowest level of\\nparallelism in the Trino architecture. A driver has one input and\\none output.\", \"Operator\": \"An operator consumes, transforms and produces data. For example, a table\\nscan fetches data from a connector and produces data that can be consumed\\nby other operators, and a filter operator consumes data and produces a\\nsubset by applying a predicate over the input data.\", \"Exchange\": \"Exchanges transfer data between Trino nodes for different stages of\\na query. Tasks produce data into an output buffer and consume data\\nfrom other tasks using an exchange client.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27, \\\"subpages\\\", 0]\"}, {\"title\": \"Use cases\", \"description\": null, \"content\": {\"What Trino is not\": \"Since Trino is being called a *database* by many members of the community,\\nit makes sense to begin with a definition of what Trino is not.\\n\\nDo not mistake the fact that Trino understands SQL with it providing\\nthe features of a standard database. Trino is not a general-purpose\\nrelational database. It is not a replacement for databases like MySQL,\\nPostgreSQL or Oracle. Trino was not designed to handle Online\\nTransaction Processing (OLTP). This is also true for many other\\ndatabases designed and optimized for data warehousing or analytics.\", \"What Trino is\": \"Trino is a tool designed to efficiently query vast amounts of data\\nusing distributed queries. If you work with terabytes or petabytes of\\ndata, you are likely using tools that interact with Hadoop and HDFS.\\nTrino was designed as an alternative to tools that query HDFS\\nusing pipelines of MapReduce jobs, such as Hive or Pig, but Trino\\nis not limited to accessing HDFS. Trino can be and has been extended\\nto operate over different kinds of data sources, including traditional\\nrelational databases and other data sources such as Cassandra.\\n\\nTrino was designed to handle data warehousing and analytics: data analysis,\\naggregating large amounts of data and producing reports. These workloads\\nare often classified as Online Analytical Processing (OLAP).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 27]\"}, {\"title\": \"Release\", \"description\": \"Documentation section: release\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/release\"}, \"subpages\": [{\"title\": \"Release 0.100\", \"description\": null, \"content\": {\"System connector\": \"The {doc}`/connector/system` now works like other connectors: global system\\ntables are only available in the `system` catalog, rather than in a special\\nschema that is available in every catalog. Additionally, connectors may now\\nprovide system tables that are available within that connector's catalog by\\nimplementing the `getSystemTables()` method on the `Connector` interface.\", \"General\": [\"Fix `%f` specifier in {func}`date_format` and {func}`date_parse`.\", \"Add `WITH ORDINALITY` support to `UNNEST`.\", \"Add {func}`array_distinct` function.\", \"Add {func}`split` function.\", \"Add {func}`degrees` and {func}`radians` functions.\", \"Add {func}`to_base` and {func}`from_base` functions.\", \"Rename config property `task.shard.max-threads` to `task.max-worker-threads`.\\nThis property sets the number of threads used to concurrently process splits.\\nThe old property name is deprecated and will be removed in a future release.\", \"Fix referencing `NULL` values in {ref}`row-type`.\", \"Make {ref}`map-type` comparable.\", \"Fix leak of tasks blocked during query teardown.\", \"Improve query queue config validation.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 0]\"}, {\"title\": \"Release 0.101\", \"description\": null, \"content\": {\"General\": [\"Add support for {doc}`/sql/create-table` (in addition to {doc}`/sql/create-table-as`).\", \"Add `IF EXISTS` support to {doc}`/sql/drop-table` and {doc}`/sql/drop-view`.\", \"Add {func}`array_agg` function.\", \"Add {func}`array_intersect` function.\", \"Add {func}`array_position` function.\", \"Add {func}`regexp_split` function.\", \"Add support for `millisecond` to {func}`date_diff` and {func}`date_add`.\", \"Fix excessive memory usage in {func}`map_agg`.\", \"Fix excessive memory usage in queries that perform partitioned top-N operations\\nwith {func}`row_number`.\", \"Optimize {ref}`array-type` comparison operators.\", \"Fix analysis of `UNION` queries for tables with hidden columns.\", \"Fix `JOIN` associativity to be left-associative instead of right-associative.\", \"Add `source` column to `runtime.queries` table in {doc}`/connector/system`.\", \"Add `coordinator` column to `runtime.nodes` table in {doc}`/connector/system`.\", \"Add `errorCode`, `errorName` and `errorType` to `error` object in REST API\\n(`errorCode` previously existed but was always zero).\", \"Fix `DatabaseMetaData.getIdentifierQuoteString()` in JDBC driver.\", \"Handle thread interruption in JDBC driver `ResultSet`.\", \"Add `history` command and support for running previous commands via `!n` to the CLI.\", \"Change Driver to make as much progress as possible before blocking. This improves\\nresponsiveness of some limit queries.\", \"Add predicate push down support to JMX connector.\", \"Add support for unary `PLUS` operator.\", \"Improve scheduling speed by reducing lock contention.\", \"Extend optimizer to understand physical properties such as local grouping and sorting.\", \"Add support for streaming execution of window functions.\", \"Make `UNION` run partitioned, if underlying plan is partitioned.\", \"Add `hash_partition_count` session property to control hash partitions.\"], \"Web UI\": \"The main page of the web UI has been completely rewritten to use ReactJS. It also has\\na number of new features, such as the ability to pause auto-refresh via the \\\"Z\\\" key and\\nalso with a toggle in the UI.\", \"Hive\": [\"Add support for connecting to S3 using EC2 instance credentials.\\nThis feature is enabled by default. To disable it, set\\n`hive.s3.use-instance-credentials=false` in your Hive catalog properties file.\", \"Treat ORC files as splittable.\", \"Change PrestoS3FileSystem to use lazy seeks, which improves ORC performance.\", \"Fix ORC `DOUBLE` statistic for columns containing `NaN`.\", \"Lower the Hive metadata refresh interval from two minutes to one second.\", \"Invalidate Hive metadata cache for failed operations.\", \"Support `s3a` file system scheme.\", \"Fix discovery of splits to correctly backoff when the queue is full.\", \"Add support for non-canonical Parquet structs.\", \"Add support for accessing Parquet columns by name. By default, columns in Parquet\\nfiles are accessed by their ordinal position in the Hive table definition. To access\\ncolumns based on the names recorded in the Parquet file, set\\n`hive.parquet.use-column-names=true` in your Hive catalog properties file.\", \"Add JMX stats to PrestoS3FileSystem.\", \"Add `hive.recursive-directories` config option to recursively scan\\npartition directories for data.\"], \"SPI\": [\"Add connector callback for rollback of `INSERT` and `CREATE TABLE AS`.\", \"Introduce an abstraction for representing physical organizations of a table\\nand describing properties such as partitioning, grouping, predicate and columns.\\n`ConnectorPartition` and related interfaces are deprecated and will be removed\\nin a future version.\", \"Rename `ConnectorColumnHandle` to `ColumnHandle`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 1]\"}, {\"title\": \"Release 0.102\", \"description\": null, \"content\": {\"Unicode support\": \"All string functions have been updated to support Unicode. The functions assume\\nthat the string contains valid UTF-8 encoded code points. There are no explicit\\nchecks for valid UTF-8, and the functions may return incorrect results on\\ninvalid UTF-8. Invalid UTF-8 data can be corrected with {func}`from_utf8`.\\n\\nAdditionally, the functions operate on Unicode code points and not user visible\\n*characters* (or *grapheme clusters*). Some languages combine multiple code points\\ninto a single user-perceived *character*, the basic unit of a writing system for a\\nlanguage, but the functions will treat each code point as a separate unit.\", \"Regular expression functions\": \"All {doc}`/functions/regexp` have been rewritten to improve performance.\\nThe new versions are often twice as fast and in some cases can be many\\norders of magnitude faster (due to removal of quadratic behavior).\\nThis change introduced some minor incompatibilities that are explained\\nin the documentation for the functions.\", \"General\": [\"Add support for partitioned right outer joins, which allows for larger tables to\\nbe joined on the inner side.\", \"Add support for full outer joins.\", \"Support returning booleans as numbers in JDBC driver\", \"Fix {func}`contains` to return `NULL` if the value was not found, but a `NULL` was.\", \"Fix nested {ref}`row-type` rendering in `DESCRIBE`.\", \"Add {func}`array_join`.\", \"Optimize map subscript operator.\", \"Add {func}`from_utf8` and {func}`to_utf8` functions.\", \"Add `task_writer_count` session property to set `task.writer-count`.\", \"Add cast from `ARRAY(F)` to `ARRAY(T)`.\", \"Extend implicit coercions to `ARRAY` element types.\", \"Implement implicit coercions in `VALUES` expressions.\", \"Fix potential deadlock in scheduler.\"], \"Hive\": [\"Collect more metrics from `PrestoS3FileSystem`.\", \"Retry when seeking in `PrestoS3FileSystem`.\", \"Ignore `InvalidRange` error in `PrestoS3FileSystem`.\", \"Implement rename and delete in `PrestoS3FileSystem`.\", \"Fix assertion failure when running `SHOW TABLES FROM schema`.\", \"Fix S3 socket leak when reading ORC files.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 2]\"}, {\"title\": \"Release 0.103\", \"description\": null, \"content\": {\"Cluster resource management\": \"There is a new cluster resource manager, which can be enabled via the\\n`experimental.cluster-memory-manager-enabled` flag. Currently, the only\\nresource that's tracked is memory, and the cluster resource manager guarantees\\nthat the cluster will not deadlock waiting for memory. However, in a low memory\\nsituation it is possible that only one query will make progress. Memory limits can\\nnow be configured via `query.max-memory` which controls the total distributed\\nmemory a query may use and `query.max-memory-per-node` which limits the amount\\nof memory a query may use on any one node. On each worker, the\\n`resources.reserved-system-memory` flags controls how much memory is reserved\\nfor internal Presto data structures and temporary allocations.\", \"Task parallelism\": \"Queries involving a large number of aggregations or a large hash table for a\\njoin can be slow due to single threaded execution in the intermediate stages.\\nThis release adds experimental configuration and session properties to execute\\nthis single threaded work in parallel. Depending on the exact query this may\\nreduce wall time, but will likely increase CPU usage.\\n\\nUse the configuration parameter `task.default-concurrency` or the session\\nproperty `task_default_concurrency` to set the default number of parallel\\nworkers to use for join probes, hash builds and final aggregations.\\nAdditionally, the session properties `task_join_concurrency`,\\n`task_hash_build_concurrency` and `task_aggregation_concurrency` can be\\nused to control the parallelism for each type of work.\\n\\nThis is an experimental feature and will likely change in a future release. It\\nis also expected that this will eventually be handled automatically by the\\nquery planner and these options will be removed entirely.\", \"Hive\": [\"Removed the `hive.max-split-iterator-threads` parameter and renamed\\n`hive.max-global-split-iterator-threads` to `hive.max-split-iterator-threads`.\", \"Fix excessive object creation when querying tables with a large number of partitions.\", \"Do not retry requests when an S3 path is not found.\"], \"General\": [\"Add {func}`array_remove`.\", \"Fix NPE in {func}`max_by` and {func}`min_by` caused when few rows were present in the aggregation.\", \"Reduce memory usage of {func}`map_agg`.\", \"Change HTTP client defaults: 2 second idle timeout, 10 second request\\ntimeout and 250 connections per host.\", \"Add SQL command autocompletion to CLI.\", \"Increase CLI history file size.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 3]\"}, {\"title\": \"Release 0.104\", \"description\": null, \"content\": {\"General\": [\"Handle thread interruption in StatementClient.\", \"Fix CLI hang when server becomes unreachable during a query.\", \"Add {func}`covar_pop`, {func}`covar_samp`, {func}`corr`, {func}`regr_slope`,\\nand {func}`regr_intercept` functions.\", \"Fix potential deadlock in cluster memory manager.\", \"Add a visualization of query execution timeline.\", \"Allow mixed case in input to {func}`from_hex`.\", \"Display \\\"BLOCKED\\\" state in web UI.\", \"Reduce CPU usage in coordinator.\", \"Fix excess object retention in workers due to long running queries.\", \"Reduce memory usage of {func}`array_distinct`.\", \"Add optimizer for projection push down which can\\nimprove the performance of certain query shapes.\", \"Improve query performance by storing pre-partitioned pages.\", \"Support `TIMESTAMP` for {func}`first_value`, {func}`last_value`,\\n{func}`nth_value`, {func}`lead` and {func}`lag`.\"], \"Hive\": [\"Upgrade to Parquet 1.6.0.\", \"Collect request time and retry statistics in `PrestoS3FileSystem`.\", \"Fix retry attempt counting for S3.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 4]\"}, {\"title\": \"Release 0.105\", \"description\": null, \"content\": {\"General\": [\"Fix issue which can cause queries to be blocked permanently.\", \"Close connections correctly in JDBC connectors.\", \"Add implicit coercions for values of equi-join criteria.\", \"Fix detection of window function calls without an `OVER` clause.\"], \"SPI\": [\"Remove `ordinalPosition` from `ColumnMetadata`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 5]\"}, {\"title\": \"Release 0.106\", \"description\": null, \"content\": {\"General\": [\"Parallelize startup of table scan task splits.\", \"Fixed index join driver resource leak.\", \"Improve memory accounting for JOINs and GROUP BYs.\", \"Improve CPU efficiency of coordinator.\", \"Added `Asia/Chita`, `Asia/Srednekolymsk`, and `Pacific/Bougainville` time zones.\", \"Fix task leak caused by race condition in stage state machine.\", \"Fix blocking in Hive split source.\", \"Free resources sooner for queries that finish prematurely.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 6]\"}, {\"title\": \"Release 0.107\", \"description\": null, \"content\": {\"General\": [\"Added `query_max_memory` session property. Note: this session property cannot\\nincrease the limit above the limit set by the `query.max-memory` configuration option.\", \"Fixed task leak caused by queries that finish early, such as a `LIMIT` query\\nor cancelled query, when the cluster is under high load.\", \"Added `task.info-refresh-max-wait` to configure task info freshness.\", \"Add support for `DELETE` to language and connector SPI.\", \"Reenable error classification code for syntax errors.\", \"Fix out of bounds exception in {func}`lower` and {func}`upper`\\nwhen the string contains the code point `U+10FFFF`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 7]\"}, {\"title\": \"Release 0.108\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect query results when a window function follows a {func}`row_number`\\nfunction and both are partitioned on the same column(s).\", \"Fix planning issue where queries that apply a `false` predicate\\nto the result of a non-grouped aggregation produce incorrect results.\", \"Fix exception when `ORDER BY` clause contains duplicate columns.\", \"Fix issue where a query (read or write) that should fail can instead\\ncomplete successfully with zero rows.\", \"Add {func}`normalize`, {func}`from_iso8601_timestamp`, {func}`from_iso8601_date`\\nand {func}`to_iso8601` functions.\", \"Add support for {func}`position` syntax.\", \"Add Teradata compatibility functions: {func}`index`, {func}`char2hexint`,\\n{func}`to_char`, {func}`to_date` and {func}`to_timestamp`.\", \"Make `ctrl-C` in CLI cancel the query (rather than a partial cancel).\", \"Allow calling `Connection.setReadOnly(false)` in the JDBC driver.\\nThe read-only status for the connection is currently ignored.\", \"Add missing `CAST` from `VARCHAR` to `TIMESTAMP WITH TIME ZONE`.\", \"Allow optional time zone in `CAST` from `VARCHAR` to `TIMESTAMP` and\\n`TIMESTAMP WITH TIME ZONE`.\", \"Trim values when converting from `VARCHAR` to date/time types.\", \"Add support for fixed time zones `+00:00` and `-00:00`.\", \"Properly account for query memory when using the {func}`row_number` function.\", \"Skip execution of inner join when the join target is empty.\", \"Improve query detail UI page.\", \"Fix printing of table layouts in {doc}`/sql/explain`.\", \"Add {doc}`/connector/blackhole`.\"], \"Cassandra\": [\"Randomly select Cassandra node for split generation.\", \"Fix handling of `UUID` partition keys.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 8]\"}, {\"title\": \"Release 0.109\", \"description\": null, \"content\": {\"General\": [\"Add {func}`slice`, {func}`md5`, {func}`array_min` and {func}`array_max` functions.\", \"Fix bug that could cause queries submitted soon after startup to hang forever.\", \"Fix bug that could cause `JOIN` queries to hang forever, if the right side of\\nthe `JOIN` had too little data or skewed data.\", \"Improve index join planning heuristics to favor streaming execution.\", \"Improve validation of date/time literals.\", \"Produce RPM package for Presto server.\", \"Always redistribute data when writing tables to avoid skew. This can\\nbe disabled by setting the session property `redistribute_writes`\\nor the config property `redistribute-writes` to false.\"], \"Remove \\\"Big Query\\\" support\": \"The experimental support for big queries has been removed in favor of\\nthe new resource manager which can be enabled via the\\n`experimental.cluster-memory-manager-enabled` config option.\\nThe `experimental_big_query` session property and the following config\\noptions are no longer supported: `experimental.big-query-initial-hash-partitions`,\\n`experimental.max-concurrent-big-queries` and `experimental.max-queued-big-queries`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 9]\"}, {\"title\": \"Release 0.110\", \"description\": null, \"content\": {\"General\": [\"Fix result truncation bug in window function {func}`row_number` when performing a\\npartitioned top-N that chooses the maximum or minimum `N` rows. For example:\", \"```\\nSELECT * FROM (\\n SELECT row_number() OVER (PARTITION BY orderstatus ORDER BY orderdate) AS rn,\\n custkey, orderdate, orderstatus\\n FROM orders\\n) WHERE rn <= 5;\\n```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 10]\"}, {\"title\": \"Release 0.111\", \"description\": null, \"content\": {\"General\": [\"Add {func}`histogram` function.\", \"Optimize `CASE` expressions on a constant.\", \"Add basic support for `IF NOT EXISTS` for `CREATE TABLE`.\", \"Semi-joins are hash-partitioned if `distributed_join` is turned on.\", \"Add support for partial cast from JSON. For example, `json` can be cast to `array(json)`, `map(varchar, json)`, etc.\", \"Add implicit coercions for `UNION`.\", \"Expose query stats in the JDBC driver `ResultSet`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 11]\"}, {\"title\": \"Release 0.112\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect handling of filters and limits in {func}`row_number` optimizer.\\nThis caused certain query shapes to produce incorrect results.\", \"Fix non-string object arrays in JMX connector.\"], \"Hive\": [\"Tables created using {doc}`/sql/create-table` (not {doc}`/sql/create-table-as`)\\nhad invalid metadata and were not readable.\", \"Improve performance of `IN` and `OR` clauses when reading `ORC` data.\\nPreviously, the ranges for a column were always compacted into a single range\\nbefore being passed to the reader, preventing the reader from taking full\\nadvantage of row skipping. The compaction only happens now if the number of\\nranges exceeds the `hive.domain-compaction-threshold` config property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 12]\"}, {\"title\": \"Release 0.113\", \"description\": null, \"content\": {\"Cluster resource management\": \"The cluster resource manager announced in {doc}`/release/release-0.103` is now enabled by default.\\nYou can disable it with the `experimental.cluster-memory-manager-enabled` flag.\\nMemory limits can now be configured via `query.max-memory` which controls the total distributed\\nmemory a query may use and `query.max-memory-per-node` which limits the amount\\nof memory a query may use on any one node. On each worker, the\\n`resources.reserved-system-memory` config property controls how much memory is reserved\\nfor internal Presto data structures and temporary allocations.\", \"Session properties\": \"All session properties have a type, default value, and description.\\nThe value for {doc}`/sql/set-session` can now be any constant expression, and\\nthe {doc}`/sql/show-session` command prints the current effective value and\\ndefault value for all session properties.\\n\\nThis type safety extends to the {doc}`SPI </develop/spi-overview>` where properties\\ncan be validated and converted to any Java type using\\n`SessionPropertyMetadata`. For an example, see `HiveSessionProperties`.\\n\\n:::{note}\\nThis is a backwards incompatible change with the previous connector SPI.\\nIf you have written a connector that uses session properties, you will need\\nto update your code to declare the properties in the `Connector`\\nimplementation and callers of `ConnectorSession.getProperty()` will now\\nneed the expected Java type of the property.\\n:::\", \"General\": [\"Allow using any type with value window functions {func}`first_value`,\\n{func}`last_value`, {func}`nth_value`, {func}`lead` and {func}`lag`.\", \"Add {func}`element_at` function.\", \"Add {func}`url_encode` and {func}`url_decode` functions.\", \"{func}`concat` now allows arbitrary number of arguments.\", \"Fix JMX connector. In the previous release it always returned zero rows.\", \"Fix handling of literal `NULL` in `IS DISTINCT FROM`.\", \"Fix an issue that caused some specific queries to fail in planning.\"], \"Hive\": [\"Fix the Hive metadata cache to properly handle negative responses.\\nThis makes the background refresh work properly by clearing the cached\\nmetadata entries when an object is dropped outside of Presto.\\nIn particular, this fixes the common case where a table is dropped using\\nHive but Presto thinks it still exists.\", \"Fix metastore socket leak when SOCKS connect fails.\"], \"SPI\": [\"Changed the internal representation of structural types.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 13]\"}, {\"title\": \"Release 0.114\", \"description\": null, \"content\": {\"General\": [\"Fix `%k` specifier for {func}`date_format` and {func}`date_parse`.\\nIt previously used `24` rather than `0` for the midnight hour.\"], \"Hive\": [\"Fix ORC reader for Hive connector.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 14]\"}, {\"title\": \"Release 0.115\", \"description\": null, \"content\": {\"General\": [\"Fix an issue with hierarchical queue rules where queries could be rejected after being accepted.\", \"Add {func}`sha1`, {func}`sha256` and {func}`sha512` functions.\", \"Add {func}`power` as an alias for {func}`pow`.\", \"Add support for `LIMIT ALL` syntax.\"], \"Hive\": [\"Fix a race condition which could cause queries to finish without reading all the data.\", \"Fix a bug in Parquet reader that causes failures while reading lists that has an element\\nschema name other than `array_element` in its Parquet-level schema.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 15]\"}, {\"title\": \"Release 0.116\", \"description\": null, \"content\": {\"Cast between JSON and VARCHAR\": \"Casts of both directions between JSON and VARCHAR have been removed. If you\\nhave such casts in your scripts or views, they will fail with a message when\\nyou move to release 0.116. To get the semantics of the current casts, use:\\n\\n['`JSON_PARSE(x)` instead of `CAST(x as JSON)`', '`JSON_FORMAT(x)` instead of `CAST(x as VARCHAR)`']\\n\\nIn a future release, we intend to reintroduce casts between JSON and VARCHAR\\nalong with other casts involving JSON. The semantics of the new JSON and\\nVARCHAR cast will be consistent with the other casts being introduced. But it\\nwill be different from the semantics in 0.115 and before. When that comes,\\ncast between JSON and VARCHAR in old scripts and views will produce unexpected\\nresult.\", \"Cluster memory manager improvements\": \"The cluster memory manager now has a low memory killer. If the cluster runs low\\non memory, the killer will kill queries to improve throughput. It can be enabled\\nwith the `query.low-memory-killer.enabled` config flag, and the delay between\\nwhen the cluster runs low on memory and when the killer will be invoked can be\\nconfigured with the `query.low-memory-killer.delay` option.\", \"General\": [\"Add {func}`multimap_agg` function.\", \"Add {func}`checksum` function.\", \"Add {func}`max` and {func}`min` that takes a second argument and produces\\n`n` largest or `n` smallest values.\", \"Add `query_max_run_time` session property and `query.max-run-time`\\nconfig. Queries are failed after the specified duration.\", \"Removed `experimental.cluster-memory-manager-enabled` config. The cluster\\nmemory manager is now always enabled.\", \"Removed `task.max-memory` config.\", \"`optimizer.optimize-hash-generation` and `distributed-joins-enabled` are\\nboth enabled by default now.\", \"Add optimization for `IF` on a constant condition.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 16]\"}, {\"title\": \"Release 0.117\", \"description\": null, \"content\": {\"General\": [\"Add back casts between JSON and VARCHAR to provide an easier migration path\\nto {func}`json_parse` and {func}`json_format`. These will be removed in a\\nfuture release.\", \"Fix bug in semi joins and group bys on a single `BIGINT` column where\\n0 could match `NULL`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 17]\"}, {\"title\": \"Release 0.118\", \"description\": null, \"content\": {\"General\": [\"Fix planning error for `UNION` queries that require implicit coercions.\", \"Fix null pointer exception when using {func}`checksum`.\", \"Fix completion condition for `SqlTask` that can cause queries to be blocked.\"], \"Authorization\": \"We've added experimental support for authorization of SQL queries in Presto.\\nThis is currently only supported by the Hive connector. You can enable Hive\\nchecks by setting the `hive.security` property to `none`, `read-only`,\\nor `sql-standard`.\\n\\n:::{note}\\nThe authentication support is experimental and only lightly tested. We are\\nactively working on this feature, so expect backwards incompatible changes.\\nSee the `ConnectorAccessControl` interface the SPI for details.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 18]\"}, {\"title\": \"Release 0.119\", \"description\": null, \"content\": {\"General\": [\"Add {doc}`/connector/redis`.\", \"Add {func}`geometric_mean` function.\", \"Fix restoring interrupt status in `StatementClient`.\", \"Support getting server version in JDBC driver.\", \"Improve correctness and compliance of JDBC `DatabaseMetaData`.\", \"Catalog and schema are now optional on the server. This allows connecting\\nand executing metadata commands or queries that use fully qualified names.\\nPreviously, the CLI and JDBC driver would use a catalog and schema named\\n`default` if they were not specified.\", \"Fix scheduler handling of partially canceled queries.\", \"Execute views with the permissions of the view owner.\", \"Replaced the `task.http-notification-threads` config option with two\\nindependent options: `task.http-response-threads` and `task.http-timeout-threads`.\", \"Improve handling of negated expressions in join criteria.\", \"Fix {func}`arbitrary`, {func}`max_by` and {func}`min_by` functions when used\\nwith an array, map or row type.\", \"Fix union coercion when the same constant or column appears more than once on\\nthe same side.\", \"Support `RENAME COLUMN` in {doc}`/sql/alter-table`.\"], \"SPI\": [\"Add more system table distribution modes.\", \"Add owner to view metadata.\"], \"CLI\": [\"Fix handling of full width characters.\", \"Skip printing query URL if terminal is too narrow.\", \"Allow performing a partial query cancel using `ctrl-P`.\", \"Allow toggling debug mode during query by pressing `D`.\", \"Fix handling of query abortion after result has been partially received.\", \"Fix handling of `ctrl-C` when displaying results without a pager.\"], \"Verifier\": [\"Add `expected-double-precision` config to specify the expected level of\\nprecision when comparing double values.\", \"Return non-zero exit code when there are failures.\"], \"Cassandra\": [\"Add support for Cassandra blob types.\"], \"Hive\": [\"Support adding and renaming columns using {doc}`/sql/alter-table`.\", \"Automatically configure the S3 region when running in EC2.\", \"Allow configuring multiple Hive metastores for high availability.\", \"Add support for `TIMESTAMP` and `VARBINARY` in Parquet.\"], \"MySQL and PostgreSQL\": [\"Enable streaming results instead of buffering everything in memory.\", \"Fix handling of pattern characters when matching table or column names.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 19]\"}, {\"title\": \"Release 0.120\", \"description\": null, \"content\": {\"Release 0.120\": \":::{warning}\\nThis release is broken and should not be used.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 20]\"}, {\"title\": \"Release 0.121\", \"description\": null, \"content\": {\"General\": [\"Fix regression that causes task scheduler to not retry requests in some cases.\", \"Throttle task info refresher on errors.\", \"Fix planning failure that prevented the use of large `IN` lists.\", \"Fix comparison of `array(T)` where `T` is a comparable, non-orderable type.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 21]\"}, {\"title\": \"Release 0.122\", \"description\": null, \"content\": {\"General\": [\"The deprecated casts between JSON and VARCHAR will now fail and provide the\\nuser with instructions to migrate their query. For more details, see\\n{doc}`/release/release-0.116`.\", \"Fix `NoSuchElementException` when cross join is used inside `IN` query.\", \"Fix `GROUP BY` to support maps of structural types.\", \"The web interface now displays a lock icon next to authenticated users.\", \"The {func}`min_by` and {func}`max_by` aggregations now have an additional form\\nthat return multiple values.\", \"Fix incorrect results when using `IN` lists of more than 1000 elements of\\n`timestamp with time zone`, `time with time zone` or structural types.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 22]\"}, {\"title\": \"Release 0.123\", \"description\": null, \"content\": {\"General\": [\"Remove `node-scheduler.location-aware-scheduling-enabled` config.\", \"Fixed query failures that occur when the `optimizer.optimize-hash-generation`\\nconfig is disabled.\", \"Fix exception when using the `ResultSet` returned from the\\n`DatabaseMetaData.getColumns` method in the JDBC driver.\", \"Increase default value of `failure-detector.threshold` config.\", \"Fix race in queueing system which could cause queries to fail with\\n\\\"Entering secondary queue failed\\\".\", \"Fix issue with {func}`histogram` that can cause failures or incorrect results\\nwhen there are more than ten buckets.\", \"Optimize execution of cross join.\", \"Run Presto server as `presto` user in RPM init scripts.\"], \"Table properties\": \"When creating tables with {doc}`/sql/create-table` or {doc}`/sql/create-table-as`,\\nyou can now add connector specific properties to the new table. For example, when\\ncreating a Hive table you can specify the file format. To list all available table,\\nproperties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.table_properties\\n```\", \"Hive\": \"We have implemented `INSERT` and `DELETE` for Hive. Both `INSERT` and `CREATE`\\nstatements support partitioned tables. For example, to create a partitioned table\\nexecute the following:\\n\\n```\\nCREATE TABLE orders (\\n order_date VARCHAR,\\n order_region VARCHAR,\\n order_id BIGINT,\\n order_info VARCHAR\\n) WITH (partitioned_by = ARRAY['order_date', 'order_region'])\\n```\\n\\nTo `DELETE` from a Hive table, you must specify a `WHERE` clause that matches\\nentire partitions. For example, to delete from the above table, execute the following:\\n\\n```\\nDELETE FROM orders\\nWHERE order_date = '2015-10-15' AND order_region = 'APAC'\\n```\\n\\n:::{note}\\nCurrently, Hive deletion is only supported for partitioned tables.\\nAdditionally, partition keys must be of type VARCHAR.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 23]\"}, {\"title\": \"Release 0.124\", \"description\": null, \"content\": {\"General\": [\"Fix race in memory tracking of `JOIN` which could cause the cluster to become over\\ncommitted and possibly crash.\", \"The {func}`approx_percentile` aggregation now also accepts an array of percentages.\", \"Allow nested row type references.\", \"Fix correctness for some queries with `IN` lists. When all constants in the\\nlist are in the range of 32-bit signed integers but the test value can be\\noutside of the range, `true` may be produced when the correct result should\\nbe `false`.\", \"Fail queries submitted while coordinator is starting.\", \"Add JMX stats to track authentication and authorization successes and failures.\", \"Add configuration support for the system access control plugin. The system access\\ncontroller can be selected and configured using `etc/access-control.properties`.\\nNote that Presto currently does not ship with any system access controller\\nimplementations.\", \"Add support for `WITH NO DATA` syntax in `CREATE TABLE ... AS SELECT`.\", \"Fix issue where invalid plans are generated for queries with multiple aggregations\\nthat require input values to be cast in different ways.\", \"Fix performance issue due to redundant processing in queries involving `DISTINCT`\\nand `LIMIT`.\", \"Add optimization that can reduce the amount of data sent over the network\\nfor grouped aggregation queries. This feature can be enabled by\\n`optimizer.use-intermediate-aggregations` config property or\\n`task_intermediate_aggregation` session property.\"], \"Hive\": [\"Do not count expected exceptions as errors in the Hive metastore client stats.\", \"Improve performance when reading ORC files with many tiny stripes.\"], \"Verifier\": [\"Add support for pre and post control and test queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 24]\"}, {\"title\": \"Release 0.125\", \"description\": null, \"content\": {\"General\": [\"Fix an issue where certain operations such as `GROUP BY`, `DISTINCT`, etc. on the\\noutput of a `RIGHT` or `FULL OUTER JOIN` can return incorrect results if they reference columns\\nfrom the left relation that are also used in the join clause, and not every row from the right relation\\nhas a match.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 25]\"}, {\"title\": \"Release 0.126\", \"description\": null, \"content\": {\"General\": [\"Add error location information (line and column number) for semantic errors.\", \"Fix a CLI crash during tab-completion when no schema is currently selected.\", \"Fix reset of session properties in CLI when running {doc}`/sql/use`.\", \"Fix occasional query planning failure due to a bug in the projection\\npush down optimizer.\", \"Fix a parsing issue when expressions contain the form `POSITION(x in (y))`.\", \"Add a new version of {func}`approx_percentile` that takes an `accuracy`\\nparameter.\", \"Allow specifying columns names in {doc}`/sql/insert` queries.\", \"Add `field_length` table property to blackhole connector to control the\\nsize of generated `VARCHAR` and `VARBINARY` fields.\", \"Bundle Teradata functions plugin in server package.\", \"Improve handling of physical properties which can increase performance for\\nqueries involving window functions.\", \"Add ability to control whether index join lookups and caching are shared\\nwithin a task. This allows us to optimize for index cache hits or for more\\nCPU parallelism. This option is toggled by the `task.share-index-loading`\\nconfig property or the `task_share_index_loading` session property.\", \"Add Tableau web connector.\", \"Improve performance of queries that use an `IN` expression with a large\\nlist of constant values.\", \"Enable connector predicate push down for all comparable and equatable types.\", \"Fix query planning failure when using certain operations such as `GROUP BY`,\\n`DISTINCT`, etc. on the output columns of `UNNEST`.\", \"In `ExchangeClient` set `maxResponseSize` to be slightly smaller than\\nthe configured value. This reduces the possibility of encountering\\n`PageTooLargeException`.\", \"Fix memory leak in coordinator.\", \"Add validation for names of table properties.\"], \"Hive\": [\"Fix reading structural types containing nulls in Parquet.\", \"Fix writing DATE type when timezone offset is negative. Previous versions\\nwould write the wrong date (off by one day).\", \"Fix an issue where `VARCHAR` columns added to an existing table could not be\\nqueried.\", \"Fix over-creation of initial splits.\", \"Fix `hive.immutable-partitions` config property to also apply to\\nunpartitioned tables.\", \"Allow non-`VARCHAR` columns in `DELETE` query.\", \"Support `DATE` columns as partition columns in parquet tables.\", \"Improve error message for cases where partition columns are also table columns.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 26]\"}, {\"title\": \"Release 0.127\", \"description\": null, \"content\": {\"General\": [\"Disable index join repartitioning when it disrupts streaming execution.\", \"Fix memory accounting leak in some `JOIN` queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 27]\"}, {\"title\": \"Release 0.128\", \"description\": null, \"content\": {\"Graceful shutdown\": \"Workers can now be instructed to shutdown. This is done by submiting a `PUT`\\nrequest to `/v1/info/state` with the body `\\\"SHUTTING_DOWN\\\"`. Once instructed\\nto shutdown, the worker will no longer receive new tasks, and will exit once\\nall existing tasks have completed.\", \"General\": [\"Fix cast from json to structural types when rows or maps have arrays,\\nrows, or maps nested in them.\", \"Fix Example HTTP connector.\\nIt would previously fail with a JSON deserialization error.\", \"Optimize memory usage in TupleDomain.\", \"Fix an issue that can occur when an `INNER JOIN` has equi-join clauses that\\nalign with the grouping columns used by a preceding operation such as\\n`GROUP BY`, `DISTINCT`, etc. When this triggers, the join may fail to\\nproduce some of the output rows.\"], \"MySQL\": [\"Fix handling of MySQL database names with underscores.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 28]\"}, {\"title\": \"Release 0.129\", \"description\": null, \"content\": {\"General\": [\"Fix a planner issue that could cause queries involving `OUTER JOIN` to\\nreturn incorrect results.\", \"Some queries, particularly those using {func}`max_by` or {func}`min_by`, now\\naccurately reflect their true memory usage and thus appear to use more memory\\nthan before.\", \"Fix {doc}`/sql/show-session` to not show hidden session properties.\", \"Fix hang in large queries with `ORDER BY` and `LIMIT`.\", \"Fix an issue when casting empty arrays or arrays containing only `NULL` to\\nother types.\", \"Table property names are now properly treated as case-insensitive.\", \"Minor UI improvements for query detail page.\", \"Do not display useless stack traces for expected exceptions in verifier.\", \"Improve performance of queries involving `UNION ALL` that write data.\", \"Introduce the `P4HyperLogLog` type, which uses an implementation of the HyperLogLog data\\nstructure that trades off accuracy and memory requirements when handling small sets for an\\nimprovement in performance.\"], \"JDBC driver\": [\"Throw exception when using {doc}`/sql/set-session` or {doc}`/sql/reset-session`\\nrather than silently ignoring the command.\", \"The driver now properly supports non-query statements.\\nThe `Statement` interface supports all variants of the `execute` methods.\\nIt also supports the `getUpdateCount` and `getLargeUpdateCount` methods.\"], \"CLI\": [\"Always clear screen when canceling query with `ctrl-C`.\", \"Make client request timeout configurable.\"], \"Network topology aware scheduling\": \"The scheduler can now be configured to take network topology into account when\\nscheduling splits. This is set using the `node-scheduler.network-topology`\\nconfig. See {doc}`/admin/tuning` for more information.\", \"Hive\": [\"The S3 region is no longer automatically configured when running in EC2.\\nTo enable this feature, use `hive.s3.pin-client-to-current-region=true`\\nin your Hive catalog properties file. Enabling this feature is required\\nto access S3 data in the China isolated region, but prevents accessing\\ndata outside the current region.\", \"Server-side encryption is now supported for S3. To enable this feature,\\nuse `hive.s3.sse.enabled=true` in your Hive catalog properties file.\", \"Add support for the `retention_days` table property.\", \"Add support for S3 `EncryptionMaterialsProvider`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 29]\"}, {\"title\": \"Release 0.130\", \"description\": null, \"content\": {\"General\": [\"Fix a performance regression in `GROUP BY` and `JOIN` queries when the\\nlength of the keys is between 16 and 31 bytes.\", \"Add {func}`map_concat` function.\", \"Performance improvements for filters, projections and dictionary encoded data.\\nThis optimization is turned off by default. It can be configured via the\\n`optimizer.columnar-processing-dictionary` config property or the\\n`columnar_processing_dictionary` session property.\", \"Improve performance of aggregation queries with large numbers of groups.\", \"Improve performance for queries that use {ref}`array-type` type.\", \"Fix querying remote views in MySQL and PostgreSQL connectors.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 30]\"}, {\"title\": \"Release 0.131\", \"description\": null, \"content\": {\"General\": [\"Fix poor performance of transporting dictionary encoded data over the network.\", \"Fix code generator to prevent \\\"Method code too large\\\" error.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 31]\"}, {\"title\": \"Release 0.132\", \"description\": null, \"content\": {\"General\": [\"Fix a correctness issue that can occur when any join depends on the output\\nof another outer join that has an inner side (or either side for the full outer\\ncase) for which the connector declares that it has no data during planning.\", \"Improve error messages for unresolved operators.\", \"Add support for creating constant arrays with more than 255 elements.\", \"Fix analyzer for queries with `GROUP BY ()` such that errors are raised\\nduring analysis rather than execution.\", \"Add `resource_overcommit` session property. This disables all memory\\nlimits for the query. Instead it may be killed at any time, if the coordinator\\nneeds to reclaim memory.\", \"Add support for transactional connectors.\", \"Add support for non-correlated scalar sub-queries.\", \"Add support for SQL binary literals.\", \"Add variant of {func}`random` that produces an integer number between 0 and a\\nspecified upper bound.\", \"Perform bounds checks when evaluating {func}`abs`.\", \"Improve accuracy of memory accounting for {func}`map_agg` and {func}`array_agg`.\\nThese functions will now appear to use more memory than before.\", \"Various performance optimizations for functions operating on {ref}`array-type`.\", \"Add server version to web UI.\"], \"CLI\": [\"Fix sporadic *\\\"Failed to disable interrupt character\\\"* error after exiting pager.\"], \"Hive\": [\"Report metastore and namenode latency in milliseconds rather than seconds in\\nJMX stats.\", \"Fix `NullPointerException` when inserting a null value for a partition column.\", \"Improve CPU efficiency when writing data.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 32]\"}, {\"title\": \"Release 0.133\", \"description\": null, \"content\": {\"General\": [\"Add support for calling connector-defined procedures using {doc}`/sql/call`.\", \"Add {doc}`/connector/system` procedure for killing running queries.\", \"Properly expire idle transactions that consist of just the start transaction statement\\nand nothing else.\", \"Fix possible deadlock in worker communication when task restart is detected.\", \"Performance improvements for aggregations on dictionary encoded data.\\nThis optimization is turned off by default. It can be configured via the\\n`optimizer.dictionary-aggregation` config property or the\\n`dictionary_aggregation` session property.\", \"Fix race which could cause queries to fail when using {func}`concat` on\\n{ref}`array-type`, or when enabling `columnar_processing_dictionary`.\", \"Add sticky headers and the ability to sort the tasks table on the query page\\nin the web interface.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 33]\"}, {\"title\": \"Release 0.134\", \"description\": null, \"content\": {\"General\": [\"Add cumulative memory statistics tracking and expose the stat in the web interface.\", \"Remove nullability and partition key flags from {doc}`/sql/show-columns`.\", \"Remove non-standard `is_partition_key` column from `information_schema.columns`.\", \"Fix performance regression in creation of `DictionaryBlock`.\", \"Fix rare memory accounting leak in queries with `JOIN`.\"], \"Hive\": [\"The comment for partition keys is now prefixed with *\\\"Partition Key\\\"*.\"], \"SPI\": [\"Remove legacy partition API methods and classes.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 34]\"}, {\"title\": \"Release 0.135\", \"description\": null, \"content\": {\"General\": [\"Add summary of change in CPU usage to verifier output.\", \"Add cast between JSON and VARCHAR, BOOLEAN, DOUBLE, BIGINT. For the old\\nbehavior of cast between JSON and VARCHAR (pre-{doc}`/release/release-0.122`),\\nuse {func}`json_parse` and {func}`json_format`.\", \"Fix bug in 0.134 that prevented query page in web UI from displaying in\\nSafari.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 35]\"}, {\"title\": \"Release 0.136\", \"description\": null, \"content\": {\"General\": [\"Add `control.query-types` and `test.query-types` to verifier, which can\\nbe used to select the type of queries to run.\", \"Fix issue where queries with `ORDER BY LIMIT` with a limit greater than\\n2147483647 could fail or return incorrect results.\", \"Add query plan visualization with live stats to the web UI.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 36]\"}, {\"title\": \"Release 0.137\", \"description\": null, \"content\": {\"General\": [\"Fix `current_date` to return correct results for all time zones.\", \"Fix invalid plans when scalar subqueries use `GROUP BY`, `DISTINCT` or `JOIN`.\", \"Do not allow creating views with a column type of `UNKNOWN`.\", \"Improve expression optimizer to remove some redundant operations.\", \"Add {func}`bit_count`, {func}`bitwise_not`, {func}`bitwise_and`,\\n{func}`bitwise_or`, and {func}`bitwise_xor` functions.\", \"Add {func}`approx_distinct` aggregation support for `VARBINARY` input.\", \"Add create time to query detail page in UI.\", \"Add support for `VARCHAR(length)` type.\", \"Track per-stage peak memory usage.\", \"Allow using double input for {func}`approx_percentile` with an array of\\npercentiles.\", \"Add API to JDBC driver to track query progress.\"], \"Hive\": [\"Do not allow inserting into tables when the Hive type does not match\\nthe Presto type. Previously, Presto would insert data that did not\\nmatch the table or partition type and that data could not be read by\\nHive. For example, Presto would write files containing `BIGINT`\\ndata for a Hive column type of `INT`.\", \"Add validation to {doc}`/sql/create-table` and {doc}`/sql/create-table-as`\\nto check that partition keys are the last columns in the table and in the same\\norder as the table properties.\", \"Remove `retention_days` table property. This property is not used by Hive.\", \"Fix Parquet decoding of `MAP` containing a null value.\", \"Add support for accessing ORC columns by name. By default, columns in ORC\\nfiles are accessed by their ordinal position in the Hive table definition.\\nTo access columns based on the names recorded in the ORC file, set\\n`hive.orc.use-column-names=true` in your Hive catalog properties file.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 37]\"}, {\"title\": \"Release 0.138\", \"description\": null, \"content\": {\"General\": [\"Fix planning bug with `NULL` literal coercions.\", \"Reduce query startup time by reducing lock contention in scheduler.\"], \"New Hive Parquet reader\": \"We have added a new Parquet reader implementation. The new reader supports vectorized\\nreads, lazy loading, and predicate push down, all of which make the reader more\\nefficient and typically reduces wall clock time for a query. Although the new\\nreader has been heavily tested, it is an extensive rewrite of the Apache Hive\\nParquet reader, and may have some latent issues, so it is not enabled by default.\\nIf you are using Parquet we suggest you test out the new reader on a per-query basis\\nby setting the `<hive-catalog>.parquet_optimized_reader_enabled` session property,\\nor you can enable the reader by default by setting the Hive catalog property\\n`hive.parquet-optimized-reader.enabled=true`. To enable Parquet predicate push down\\nthere is a separate session property `<hive-catalog>.parquet_predicate_pushdown_enabled`\\nand configuration property `hive.parquet-predicate-pushdown.enabled=true`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 38]\"}, {\"title\": \"Release 0.139\", \"description\": null, \"content\": {\"Dynamic split concurrency\": \"The number of running leaf splits per query is now dynamically adjusted to improve\\noverall cluster throughput. `task.initial-splits-per-node` can be used to set\\nthe initial number of splits, and `task.split-concurrency-adjustment-interval`\\ncan be used to change how frequently adjustments happen. The session properties\\n`initial_splits_per_node` and `split_concurrency_adjustment_interval` can\\nalso be used.\", \"General\": [\"Fix planning bug that causes some joins to not be redistributed when\\n`distributed-joins-enabled` is true.\", \"Fix rare leak of stage objects and tasks for queries using `LIMIT`.\", \"Add experimental `task.join-concurrency` config which can be used to increase\\nconcurrency for the probe side of joins.\"], \"Hive\": [\"Remove cursor-based readers for ORC and DWRF file formats, as they have been\\nreplaced by page-based readers.\", \"Fix creating tables on S3 with {doc}`/sql/create-table-as`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 39]\"}, {\"title\": \"Release 0.140\", \"description\": null, \"content\": {\"General\": [\"Add the `TRY` function to handle specific data exceptions. See\\n{doc}`/functions/conditional`.\", \"Optimize predicate expressions to minimize redundancies.\", \"Add environment name to UI.\", \"Fix logging of `failure_host` and `failure_task` fields in\\n`QueryCompletionEvent`.\", \"Fix race which can cause queries to fail with a `REMOTE_TASK_ERROR`.\", \"Optimize {func}`array_distinct` for `array(bigint)`.\", \"Optimize `>` operator for {ref}`array-type`.\", \"Fix an optimization issue that could result in non-deterministic functions\\nbeing evaluated more than once producing unexpected results.\", \"Fix incorrect result for rare `IN` lists that contain certain combinations\\nof non-constant expressions that are null and non-null.\", \"Improve performance of joins, aggregations, etc. by removing unnecessarily\\nduplicated columns.\", \"Optimize `NOT IN` queries to produce more compact predicates.\"], \"Hive\": [\"Remove bogus \\\"from deserializer\\\" column comments.\", \"Change categorization of Hive writer errors to be more specific.\", \"Add date and timestamp support to new Parquet Reader\"], \"SPI\": [\"Remove partition key from `ColumnMetadata`.\", \"Change return type of `ConnectorTableLayout.getDiscretePredicates()`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 40]\"}, {\"title\": \"Release 0.141\", \"description\": null, \"content\": {\"General\": [\"Fix server returning an HTTP 500 response for queries with parse errors.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 41]\"}, {\"title\": \"Release 0.142\", \"description\": null, \"content\": {\"General\": [\"Fix planning bug for `JOIN` criteria that optimizes to a `FALSE` expression.\", \"Fix planning bug when the output of `UNION` doesn't match the table column order\\nin `INSERT` queries.\", \"Fix error when `ORDER BY` clause in window specification refers to the same column multiple times.\", \"Add support for {ref}`complex grouping operations<complex-grouping-operations>`\\n\\\\- `CUBE`, `ROLLUP` and `GROUPING SETS`.\", \"Add support for `IF NOT EXISTS` in `CREATE TABLE AS` queries.\", \"Add {func}`substring` function.\", \"Add `http.server.authentication.krb5.keytab` config option to set the location of the Kerberos\\nkeytab file explicitly.\", \"Add `optimize_metadata_queries` session property to enable the metadata-only query optimization.\", \"Improve support for non-equality predicates in `JOIN` criteria.\", \"Add support for non-correlated subqueries in aggregation queries.\", \"Improve performance of {func}`json_extract`.\"], \"Hive\": [\"Change ORC input format to report actual bytes read as opposed to estimated bytes.\", \"Fix cache invalidation when renaming tables.\", \"Fix Parquet reader to handle uppercase column names.\", \"Fix issue where the `hive.respect-table-format` config option was being ignored.\", \"Add {doc}`hive.compression-codec </connector/hive>` config option to control\\ncompression used when writing. The default is now `GZIP` for all formats.\", \"Collect and expose end-to-end execution time JMX metric for requests to AWS services.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 42]\"}, {\"title\": \"Release 0.143\", \"description\": null, \"content\": {\"General\": [\"Fix race condition in output buffer that can cause a page to be lost.\", \"Fix case-sensitivity issue when de-referencing row fields.\", \"Fix bug in phased scheduler that could cause queries to block forever.\", \"Fix {doc}`/sql/delete` for predicates that optimize to false.\", \"Add support for scalar subqueries in {doc}`/sql/delete` queries.\", \"Add config option `query.max-cpu-time` to limit CPU time used by a query.\", \"Add loading indicator and error message to query detail page in UI.\", \"Add query teardown to query timeline visualizer.\", \"Add string padding functions {func}`lpad` and {func}`rpad`.\", \"Add {func}`width_bucket` function.\", \"Add {func}`truncate` function.\", \"Improve query startup time in large clusters.\", \"Improve error messages for `CAST` and {func}`slice`.\"], \"Hive\": [\"Fix native memory leak when reading or writing gzip compressed data.\", \"Fix performance regression due to complex expressions not being applied\\nwhen pruning partitions.\", \"Fix data corruption in {doc}`/sql/create-table-as` when\\n`hive.respect-table-format` config is set to false and user-specified\\nstorage format does not match default.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 43]\"}, {\"title\": \"Release 0.144.1\", \"description\": null, \"content\": {\"Hive\": [\"Fix bug when grouping on a bucketed column which causes incorrect results.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 44]\"}, {\"title\": \"Release 0.144.2\", \"description\": null, \"content\": {\"General\": [\"Fix potential memory leak in coordinator query history.\", \"Add `driver.max-page-partitioning-buffer-size` config to control buffer size\\nused to repartition pages for exchanges.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 45]\"}, {\"title\": \"Release 0.144.3\", \"description\": null, \"content\": {\"General\": [\"Fix bugs in planner where coercions were not taken into account when computing\\ntypes.\", \"Fix compiler failure when `TRY` is a sub-expression.\", \"Fix compiler failure when `TRY` is called on a constant or an input reference.\", \"Fix race condition that can cause queries that process data from non-columnar data\\nsources to fail.\"], \"Hive\": [\"Fix reading symlinks when the target is in a different HDFS instance.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 46]\"}, {\"title\": \"Release 0.144.4\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for grouping sets for some queries with filters.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 47]\"}, {\"title\": \"Release 0.144.5\", \"description\": null, \"content\": {\"General\": [\"Fix window functions to correctly handle empty frames between unbounded and\\nbounded in the same direction. For example, a frame such as\\n`ROWS BETWEEN UNBOUNDED PRECEDING AND 2 PRECEDING`\\nwould incorrectly use the first row as the window frame for the first two\\nrows rather than using an empty frame.\", \"Fix correctness issue when grouping on columns that are also arguments to aggregation functions.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 48]\"}, {\"title\": \"Release 0.144.6\", \"description\": null, \"content\": {\"General\": \"This release fixes several problems with large and negative intervals.\\n\\n[\\\"Fix parsing of negative interval literals. Previously, the sign of each field was treated\\\\nindependently instead of applying to the entire interval value. For example, the literal\\\\n`INTERVAL '-2-3' YEAR TO MONTH` was interpreted as a negative interval of `21` months\\\\nrather than `27` months (positive `3` months was added to negative `24` months).\\\", 'Fix handling of `INTERVAL DAY TO SECOND` type in REST API. Previously, intervals greater than\\\\n`2,147,483,647` milliseconds (about `24` days) were returned as the wrong value.', 'Fix handling of `INTERVAL YEAR TO MONTH` type. Previously, intervals greater than\\\\n`2,147,483,647` months were returned as the wrong value from the REST API\\\\nand parsed incorrectly when specified as a literal.', 'Fix formatting of negative intervals in REST API. Previously, negative intervals\\\\nhad a negative sign before each component and could not be parsed.', 'Fix formatting of negative intervals in JDBC `PrestoInterval` classes.']\\n\\n:::{note}\\nOlder versions of the JDBC driver will misinterpret most negative\\nintervals from new servers. Make sure to update the JDBC driver\\nalong with the server.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 49]\"}, {\"title\": \"Release 0.144.7\", \"description\": null, \"content\": {\"General\": [\"Fail queries with non-equi conjuncts in `OUTER JOIN`s, instead of silently\\ndropping such conjuncts from the query and producing incorrect results.\", \"Add {func}`cosine_similarity` function.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 50]\"}, {\"title\": \"Release 0.144\", \"description\": null, \"content\": {\"General\": [\"Fix already exists check when adding a column to be case-insensitive.\", \"Fix correctness issue when complex grouping operations have a partitioned source.\", \"Fix missing coercion when using `INSERT` with `NULL` literals.\", \"Fix regression that the queries fail when aggregation functions present in `AT TIME ZONE`.\", \"Fix potential memory starvation when a query is run with `resource_overcommit=true`.\", \"Queries run with `resource_overcommit=true` may now be killed before\\nthey reach `query.max-memory` if the cluster is low on memory.\", \"Discard output stage JSON from completion event when it is very long.\\nThis limit can be configured with `event.max-output-stage-size`.\", \"Add support for {doc}`/sql/explain-analyze`.\", \"Change `infoUri` field of `/v1/statement` to point to query HTML page instead of JSON.\", \"Improve performance when processing results in CLI and JDBC driver.\", \"Improve performance of `GROUP BY` queries.\"], \"Hive\": [\"Fix ORC reader to actually use `hive.orc.stream-buffer-size` configuration property.\", \"Add support for creating and inserting into bucketed tables.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 51]\"}, {\"title\": \"Release 0.145\", \"description\": null, \"content\": {\"General\": [\"Fix potential memory leak in coordinator query history.\", \"Fix column resolution issue when qualified name refers to a view.\", \"Fail arithmetic operations on overflow.\", \"Fix bugs in planner where coercions were not taken into account when computing\\ntypes.\", \"Fix compiler failure when `TRY` is a sub-expression.\", \"Fix compiler failure when `TRY` is called on a constant or an input reference.\", \"Add support for the `integer` type to the Presto engine and the Hive,\\nRaptor, Redis, Kafka, Cassandra and example-http connectors.\", \"Add initial support for the `decimal` data type.\", \"Add `driver.max-page-partitioning-buffer-size` config to control buffer size\\nused to repartition pages for exchanges.\", \"Improve performance for distributed JOIN and GROUP BY queries with billions\\nof groups.\", \"Improve reliability in highly congested networks by adjusting the default\\nconnection idle timeouts.\"], \"Verifier\": [\"Change verifier to only run read-only queries by default. This behavior can be\\nchanged with the `control.query-types` and `test.query-types` config flags.\"], \"CLI\": [\"Improve performance of output in batch mode.\", \"Fix hex rendering in batch mode.\", \"Abort running queries when CLI is terminated.\"], \"Hive\": [\"Fix bug when grouping on a bucketed column which causes incorrect results.\", \"Add `max_split_size` and `max_initial_split_size` session properties to control\\nthe size of generated splits.\", \"Add retries to the metastore security calls.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 52]\"}, {\"title\": \"Release 0.146\", \"description\": null, \"content\": {\"General\": [\"Fix error in {func}`map_concat` when the second map is empty.\", \"Require at least 4096 file descriptors to run Presto.\", \"Support casting between map types.\", \"Add {doc}`/connector/mongodb`.\"], \"Hive\": [\"Fix incorrect skipping of data in Parquet during predicate push-down.\", \"Fix reading of Parquet maps and lists containing nulls.\", \"Fix reading empty ORC file with `hive.orc.use-column-names` enabled.\", \"Fix writing to S3 when the staging directory is a symlink to a directory.\", \"Legacy authorization properties, such as `hive.allow-drop-table`, are now\\nonly enforced when `hive.security=none` is set, which is the default\\nsecurity system. Specifically, the `sql-standard` authorization system\\ndoes not enforce these settings.\"], \"Black Hole\": [\"Add support for `varchar(n)`.\"], \"Cassandra\": [\"Add support for Cassandra 3.0.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 53]\"}, {\"title\": \"Release 0.147\", \"description\": null, \"content\": {\"General\": [\"Fix race condition that can cause queries that process data from non-columnar\\ndata sources to fail.\", \"Fix incorrect formatting of dates and timestamps before year 1680.\", \"Fix handling of syntax errors when parsing `EXTRACT`.\", \"Fix potential scheduling deadlock for connectors that expose node-partitioned data.\", \"Fix performance regression that increased planning time.\", \"Fix incorrect results for grouping sets for some queries with filters.\", \"Add {doc}`/sql/show-create-view` and {doc}`/sql/show-create-table`.\", \"Add support for column aliases in `WITH` clause.\", \"Support `LIKE` clause for {doc}`/sql/show-catalogs` and {doc}`/sql/show-schemas`.\", \"Add support for `INTERSECT`.\", \"Add support for casting row types.\", \"Add {func}`sequence` function.\", \"Add {func}`sign` function.\", \"Add {func}`flatten` function.\", \"Add experimental implementation of {doc}`resource groups </admin/resource-groups>`.\", \"Add localfile connector.\", \"Remove experimental intermediate aggregation optimizer. The `optimizer.use-intermediate-aggregations`\\nconfig option and `task_intermediate_aggregation` session property are no longer supported.\", \"Add support for colocated joins for connectors that expose node-partitioned data.\", \"Improve the performance of {func}`array_intersect`.\", \"Generalize the intra-node parallel execution system to work with all query stages.\\nThe `task.concurrency` configuration property replaces the old `task.join-concurrency`\\nand `task.default-concurrency` options. Similarly, the `task_concurrency` session\\nproperty replaces the `task_join_concurrency`, `task_hash_build_concurrency`, and\\n`task_aggregation_concurrency` properties.\"], \"Hive\": [\"Fix reading symlinks when the target is in a different HDFS instance.\", \"Fix `NoClassDefFoundError` for `SubnetUtils` in HDFS client.\", \"Fix error when reading from Hive tables with inconsistent bucketing metadata.\", \"Correctly report read bytes when reading Parquet data.\", \"Include path in unrecoverable S3 exception messages.\", \"When replacing an existing Presto view, update the view data\\nin the Hive metastore rather than dropping and recreating it.\", \"Rename table property `clustered_by` to `bucketed_by`.\", \"Add support for `varchar(n)`.\"], \"Kafka\": [\"Fix `error code 6` when reading data from Kafka.\", \"Add support for `varchar(n)`.\"], \"Redis\": [\"Add support for `varchar(n)`.\"], \"MySQL and PostgreSQL\": [\"Cleanup temporary data when a `CREATE TABLE AS` fails.\", \"Add support for `varchar(n)`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 54]\"}, {\"title\": \"Release 0.148\", \"description\": null, \"content\": {\"General\": [\"Fix issue where auto-commit transaction can be rolled back for a successfully\\ncompleted query.\", \"Fix detection of colocated joins.\", \"Fix planning bug involving partitioning with constants.\", \"Fix window functions to correctly handle empty frames between unbounded and\\nbounded in the same direction. For example, a frame such as\\n`ROWS BETWEEN UNBOUNDED PRECEDING AND 2 PRECEDING`\\nwould incorrectly use the first row as the window frame for the first two\\nrows rather than using an empty frame.\", \"Fix correctness issue when grouping on columns that are also arguments to aggregation functions.\", \"Fix failure when chaining `AT TIME ZONE`, e.g.\\n`SELECT TIMESTAMP '2016-01-02 12:34:56' AT TIME ZONE 'America/Los_Angeles' AT TIME ZONE 'UTC'`.\", \"Fix data duplication when `task.writer-count` configuration mismatches between coordinator and worker.\", \"Fix bug where `node-scheduler.max-pending-splits-per-node-per-task` config is not always\\nhonored by node scheduler. This bug could stop the cluster from making further progress.\", \"Fix incorrect results for grouping sets with partitioned source.\", \"Add `colocated-joins-enabled` to enable colocated joins by default for\\nconnectors that expose node-partitioned data.\", \"Add support for colocated unions.\", \"Reduce initial memory usage of {func}`array_agg` function.\", \"Improve planning of co-partitioned `JOIN` and `UNION`.\", \"Improve planning of aggregations over partitioned data.\", \"Improve the performance of the {func}`array_sort` function.\", \"Improve outer join predicate push down.\", \"Increase default value for `query.initial-hash-partitions` to `100`.\", \"Change default value of `query.max-memory-per-node` to `10%` of the Java heap.\", \"Change default `task.max-worker-threads` to `2` times the number of cores.\", \"Use HTTPS in JDBC driver when using port 443.\", \"Warn if Presto server is not using G1 garbage collector.\", \"Move interval types out of SPI.\"], \"Interval fixes\": \"This release fixes several problems with large and negative intervals.\\n\\n[\\\"Fix parsing of negative interval literals. Previously, the sign of each field was treated\\\\nindependently instead of applying to the entire interval value. For example, the literal\\\\n`INTERVAL '-2-3' YEAR TO MONTH` was interpreted as a negative interval of `21` months\\\\nrather than `27` months (positive `3` months was added to negative `24` months).\\\", 'Fix handling of `INTERVAL DAY TO SECOND` type in REST API. Previously, intervals greater than\\\\n`2,147,483,647` milliseconds (about `24` days) were returned as the wrong value.', 'Fix handling of `INTERVAL YEAR TO MONTH` type. Previously, intervals greater than\\\\n`2,147,483,647` months were returned as the wrong value from the REST API\\\\nand parsed incorrectly when specified as a literal.', 'Fix formatting of negative intervals in REST API. Previously, negative intervals\\\\nhad a negative sign before each component and could not be parsed.', 'Fix formatting of negative intervals in JDBC `PrestoInterval` classes.']\\n\\n:::{note}\\nOlder versions of the JDBC driver will misinterpret most negative\\nintervals from new servers. Make sure to update the JDBC driver\\nalong with the server.\\n:::\", \"Functions and language features\": [\"Add {func}`element_at` function for map type.\", \"Add {func}`split_to_map` function.\", \"Add {func}`zip` function.\", \"Add {func}`map_union` aggregation function.\", \"Add `ROW` syntax for constructing row types.\", \"Add support for `REVOKE` permission syntax.\", \"Add support for `SMALLINT` and `TINYINT` types.\", \"Add support for non-equi outer joins.\"], \"Verifier\": [\"Add `skip-cpu-check-regex` config property which can be used to skip the CPU\\ntime comparison for queries that match the given regex.\", \"Add `check-cpu` config property which can be used to disable CPU time comparison.\"], \"Hive\": [\"Fix `NoClassDefFoundError` for `KMSClientProvider` in HDFS client.\", \"Fix creating tables on S3 in an empty database.\", \"Implement `REVOKE` permission syntax.\", \"Add support for `SMALLINT` and `TINYINT`\", \"Support `DELETE` from unpartitioned tables.\", \"Add support for Kerberos authentication when talking to Hive/HDFS.\", \"Push down filters for columns of type `DECIMAL`.\", \"Improve CPU efficiency when reading ORC files.\"], \"Cassandra\": [\"Allow configuring load balancing policy and no host available retry.\", \"Add support for `varchar(n)`.\"], \"Kafka\": [\"Update to Kafka client 0.8.2.2. This enables support for LZ4 data.\"], \"JMX\": [\"Add `jmx.history` schema with in-memory periodic samples of values from JMX MBeans.\"], \"MySQL and PostgreSQL\": [\"Push down predicates for `VARCHAR`, `DATE`, `TIME` and `TIMESTAMP` types.\"], \"Other connectors\": [\"Add support for `varchar(n)` to the Redis, TPC-H, MongoDB, Local File\\nand Example HTTP connectors.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 55]\"}, {\"title\": \"Release 0.149\", \"description\": null, \"content\": {\"General\": [\"Fix runtime failure for queries that use grouping sets over unions.\", \"Do not ignore null values in {func}`array_agg`.\", \"Fix failure when casting row values that contain null fields.\", \"Fix failure when using complex types as map keys.\", \"Fix potential memory tracking leak when queries are cancelled.\", \"Fix rejection of queries that do not match any queue/resource group rules.\\nPreviously, a 500 error was returned to the client.\", \"Fix {func}`trim` and {func}`rtrim` functions to produce more intuitive results\\nwhen the argument contains invalid `UTF-8` sequences.\", \"Add a new web interface with cluster overview, realtime stats, and improved sorting\\nand filtering of queries.\", \"Add support for `FLOAT` type.\", \"Rename `query.max-age` to `query.min-expire-age`.\", \"`optimizer.columnar-processing` and `optimizer.columnar-processing-dictionary`\\nproperties were merged to `optimizer.processing-optimization` with possible\\nvalues `disabled`, `columnar` and `columnar_dictionary`\", \"`columnar_processing` and `columnar_processing_dictionary` session\\nproperties were merged to `processing_optimization` with possible values\\n`disabled`, `columnar` and `columnar_dictionary`\", \"Change `%y` (2-digit year) in {func}`date_parse` to evaluate to a year between\\n1970 and 2069 inclusive.\", \"Add `queued` flag to `StatementStats` in REST API.\", \"Improve error messages for math operations.\", \"Improve memory tracking in exchanges to avoid running out of Java heap space.\", \"Improve performance of subscript operator for the `MAP` type.\", \"Improve performance of `JOIN` and `GROUP BY` queries.\"], \"Hive\": [\"Clean up empty staging directories after inserts.\", \"Add `hive.dfs.ipc-ping-interval` config for HDFS.\", \"Change default value of `hive.dfs-timeout` to 60 seconds.\", \"Fix ORC/DWRF reader to avoid repeatedly fetching the same data when stripes\\nare skipped.\", \"Fix force local scheduling for S3 or other non-HDFS file systems.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 56]\"}, {\"title\": \"Release 0.150\", \"description\": null, \"content\": {\"General\": [\"Fix web UI bug that caused rendering to fail when a stage has no tasks.\", \"Fix failure due to ambiguity when calling {func}`round` on `tinyint` arguments.\", \"Fix race in exchange HTTP endpoint, which could cause queries to fail randomly.\", \"Add support for parsing timestamps with nanosecond precision in {func}`date_parse`.\", \"Add CPU quotas to resource groups.\"], \"Hive\": [\"Add support for writing to bucketed tables.\", \"Add execution optimizations for bucketed tables.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 57]\"}, {\"title\": \"Release 0.151\", \"description\": null, \"content\": {\"General\": [\"Fix issue where aggregations may produce the wrong result when `task.concurrency` is set to `1`.\", \"Fix query failure when `array`, `map`, or `row` type is used in non-equi `JOIN`.\", \"Fix performance regression for queries using `OUTER JOIN`.\", \"Fix query failure when using the {func}`arbitrary` aggregation function on `integer` type.\", \"Add various math functions that operate directly on `float` type.\", \"Add flag `deprecated.legacy-array-agg` to restore legacy {func}`array_agg`\\nbehavior (ignore `NULL` input). This flag will be removed in a future release.\", \"Add support for uncorrelated `EXISTS` clause.\", \"Add {func}`cosine_similarity` function.\", \"Allow Tableau web connector to use catalogs other than `hive`.\"], \"Verifier\": [\"Add `shadow-writes.enabled` option which can be used to transform `CREATE TABLE AS SELECT`\\nqueries to write to a temporary table (rather than the originally specified table).\"], \"SPI\": [\"Remove `getDataSourceName` from `ConnectorSplitSource`.\", \"Remove `dataSourceName` constructor parameter from `FixedSplitSource`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 58]\"}, {\"title\": \"Release 0.152.1\", \"description\": null, \"content\": {\"General\": [\"Fix race which could cause failed queries to have no error details.\", \"Fix race in HTTP layer which could cause queries to fail.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 59]\"}, {\"title\": \"Release 0.152.2\", \"description\": null, \"content\": {\"Hive\": [\"Improve performance of ORC reader when decoding dictionary encoded {ref}`map-type`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 60]\"}, {\"title\": \"Release 0.152.3\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for grouping sets when `task.concurrency` is greater than one.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 61]\"}, {\"title\": \"Release 0.152\", \"description\": null, \"content\": {\"General\": [\"Add {func}`array_union` function.\", \"Add {func}`reverse` function for arrays.\", \"Fix issue that could cause queries with `varchar` literals to fail.\", \"Fix categorization of errors from {func}`url_decode`, allowing it to be used with `TRY`.\", \"Fix error reporting for invalid JSON paths provided to JSON functions.\", \"Fix view creation for queries containing `GROUPING SETS`.\", \"Fix query failure when referencing a field of a `NULL` row.\", \"Improve query performance for multiple consecutive window functions.\", \"Prevent web UI from breaking when query fails without an error code.\", \"Display port on the task list in the web UI when multiple workers share the same host.\", \"Add support for `EXCEPT`.\", \"Rename `FLOAT` type to `REAL` for better compatibility with the SQL standard.\", \"Fix potential performance regression when transporting rows between nodes.\"], \"JDBC driver\": [\"Fix sizes returned from `DatabaseMetaData.getColumns()` for\\n`COLUMN_SIZE`, `DECIMAL_DIGITS`, `NUM_PREC_RADIX` and `CHAR_OCTET_LENGTH`.\"], \"Hive\": [\"Fix resource leak in Parquet reader.\", \"Rename JMX stat `AllViews` to `GetAllViews` in `ThriftHiveMetastore`.\", \"Add file based security, which can be configured with the `hive.security` and\\n`security.config-file` config properties. See [](hive-authorization) for more\\ndetails.\", \"Add support for custom S3 credentials providers using the\\n`presto.s3.credentials-provider` Hadoop configuration property.\"], \"MySQL\": [\"Fix reading MySQL `tinyint(1)` columns. Previously, these columns were\\nincorrectly returned as a boolean rather than an integer.\", \"Add support for `INSERT`.\", \"Add support for reading data as `tinyint` and `smallint` types rather than `integer`.\"], \"PostgreSQL\": [\"Add support for `INSERT`.\", \"Add support for reading data as `tinyint` and `smallint` types rather than `integer`.\"], \"SPI\": [\"Remove `owner` from `ConnectorTableMetadata`.\", \"Replace the generic `getServices()` method in `Plugin` with specific\\nmethods such as `getConnectorFactories()`, `getTypes()`, etc.\\nDependencies like `TypeManager` are now provided directly rather\\nthan being injected into `Plugin`.\", \"Add first-class support for functions in the SPI. This replaces the old\\n`FunctionFactory` interface. Plugins can return a list of classes from the\\n`getFunctions()` method:\", [\"Scalar functions are methods or classes annotated with `@ScalarFunction`.\", \"Aggregation functions are methods or classes annotated with `@AggregationFunction`.\", \"Window functions are an implementation of `WindowFunction`. Most implementations\\nshould be a subclass of `RankingWindowFunction` or `ValueWindowFunction`.\"]], \"Verifier\": [\"Fix handling of shadow write queries with a `LIMIT`.\"], \"Local file\": [\"Fix file descriptor leak.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 62]\"}, {\"title\": \"Release 0.153\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for grouping sets when `task.concurrency` is greater than one.\", \"Fix silent numeric overflow when casting `INTEGER` to large `DECIMAL` types.\", \"Fix issue where `GROUP BY ()` would produce no results if the input had no rows.\", \"Fix null handling in {func}`array_distinct` when applied to the `array(bigint)` type.\", \"Fix handling of `-2^63` as the element index for {func}`json_array_get`.\", \"Fix correctness issue when the input to `TRY_CAST` evaluates to null.\\nFor types such as booleans, numbers, dates, timestamps, etc., rather than\\nreturning null, a default value specific to the type such as\\n`false`, `0` or `1970-01-01` was returned.\", \"Fix potential thread deadlock in coordinator.\", \"Fix rare correctness issue with an aggregation on a single threaded right join when\\n`task.concurrency` is `1`.\", \"Fix query failure when casting a map with null values.\", \"Fix failure when view column names contain upper-case letters.\", \"Fix potential performance regression due to skew issue when\\ngrouping or joining on columns of the following types: `TINYINT`,\\n`SMALLINT`, `INTEGER`, `BIGINT`, `REAL`, `DOUBLE`,\\n`COLOR`, `DATE`, `INTERVAL`, `TIME`, `TIMESTAMP`.\", \"Fix potential memory leak for delete queries.\", \"Fix query stats to not include queued time in planning time.\", \"Fix query completion event to log final stats for the query.\", \"Fix spurious log messages when queries are torn down.\", \"Remove broken `%w` specifier for {func}`date_format` and {func}`date_parse`.\", \"Improve performance of {ref}`array-type` when underlying data is dictionary encoded.\", \"Improve performance of outer joins with non-equality criteria.\", \"Require task concurrency and task writer count to be a power of two.\", \"Use nulls-last ordering for {func}`array_sort`.\", \"Validate that `TRY` is used with exactly one argument.\", \"Allow running Presto with early-access Java versions.\", \"Add Accumulo connector.\"], \"Functions and language features\": [\"Allow subqueries in non-equality outer join criteria.\", \"Add support for {doc}`/sql/create-schema`, {doc}`/sql/drop-schema`\\nand {doc}`/sql/alter-schema`.\", \"Add initial support for correlated subqueries.\", \"Add execution support for prepared statements.\", \"Add `DOUBLE PRECISION` as an alias for the `DOUBLE` type.\", \"Add {func}`typeof` for discovering expression types.\", \"Add decimal support to {func}`avg`, {func}`ceil`, {func}`floor`, {func}`round`,\\n{func}`truncate`, {func}`abs`, {func}`mod` and {func}`sign`.\", \"Add {func}`shuffle` function for arrays.\"], \"Pluggable resource groups\": \"Resource group management is now pluggable. A `Plugin` can\\nprovide management factories via `getResourceGroupConfigurationManagerFactories()`\\nand the factory can be enabled via the `etc/resource-groups.properties`\\nconfiguration file by setting the `resource-groups.configuration-manager`\\nproperty. See the `presto-resource-group-managers` plugin for an example\\nand {doc}`/admin/resource-groups` for more details.\", \"Web UI\": [\"Fix rendering failures due to null nested data structures.\", \"Do not include coordinator in active worker count on cluster overview page.\", \"Replace buffer skew indicators on query details page with scheduled time skew.\", \"Add stage total buffer, pending tasks and wall time to stage statistics on query details page.\", \"Add option to filter task lists by status on query details page.\", \"Add copy button for query text, query ID, and user to query details page.\"], \"JDBC driver\": [\"Add support for `real` data type, which corresponds to the Java `float` type.\"], \"CLI\": [\"Add support for configuring the HTTPS Truststore.\"], \"Hive\": [\"Fix permissions for new tables when using SQL-standard authorization.\", \"Improve performance of ORC reader when decoding dictionary encoded {ref}`map-type`.\", \"Allow certain combinations of queries to be executed in a transaction-ish manner,\\nfor example, when dropping a partition and then recreating it. Atomicity is not\\nguaranteed due to fundamental limitations in the design of Hive.\", \"Support per-transaction cache for Hive metastore.\", \"Fail queries that attempt to rename partition columns.\", \"Add support for ORC bloom filters in predicate push down.\\nThis is can be enabled using the `hive.orc.bloom-filters.enabled`\\nconfiguration property or the `orc_bloom_filters_enabled` session property.\", \"Add new optimized RCFile reader.\\nThis can be enabled using the `hive.rcfile-optimized-reader.enabled`\\nconfiguration property or the `rcfile_optimized_reader_enabled` session property.\", \"Add support for the Presto `real` type, which corresponds to the Hive `float` type.\", \"Add support for `char(x)` type.\", \"Add support for creating, dropping and renaming schemas (databases).\\nThe filesystem location can be specified when creating a schema,\\nwhich allows, for example, easily creating tables on S3.\", \"Record Presto query ID for tables or partitions written by Presto\\nusing the `trino_query_id` table or partition property.\", \"Include path name in error message when listing a directory fails.\", \"Rename `allow-all` authorization method to `legacy`. This\\nmethod is deprecated and will be removed in a future release.\", \"Do not retry S3 requests that are aborted intentionally.\", \"Set the user agent suffix for S3 requests to `presto`.\", \"Allow configuring the user agent prefix for S3 requests\\nusing the `hive.s3.user-agent-prefix` configuration property.\", \"Add support for S3-compatible storage using the `hive.s3.endpoint`\\nand `hive.s3.signer-type` configuration properties.\", \"Add support for using AWS KMS with S3 as an encryption materials provider\\nusing the `hive.s3.kms-key-id` configuration property.\", \"Allow configuring a custom S3 encryption materials provider using the\\n`hive.s3.encryption-materials-provider` configuration property.\"], \"JMX\": [\"Make name configuration for history tables case-insensitive.\"], \"MySQL\": [\"Optimize fetching column names when describing a single table.\", \"Add support for `char(x)` and `real` data types.\"], \"PostgreSQL\": [\"Optimize fetching column names when describing a single table.\", \"Add support for `char(x)` and `real` data types.\", \"Add support for querying materialized views.\"], \"Blackhole\": [\"Add `page_processing_delay` table property.\"], \"SPI\": [\"Add `schemaExists()` method to `ConnectorMetadata`.\", \"Add transaction to grant/revoke in `ConnectorAccessControl`.\", \"Add `isCoordinator()` and `getVersion()` methods to `Node`.\", \"Remove `setOptionalConfig()` method from `Plugin`.\", \"Remove `ServerInfo` class.\", \"Make `NodeManager` specific to a connector instance.\", \"Replace `ConnectorFactoryContext` with `ConnectorContext`.\", \"Use `@SqlNullable` for functions instead of `@Nullable`.\", \"Prevent plugins from seeing classes that are not part of the JDK (bootstrap classes) or the SPI.\", \"Update `presto-maven-plugin`, which provides a Maven packaging and\\nlifecycle for plugins, to validate that every SPI dependency is marked\\nas `provided` scope and that only SPI dependencies use `provided`\\nscope. This helps find potential dependency and class loader issues\\nat build time rather than at runtime.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 63]\"}, {\"title\": \"Release 0.154\", \"description\": null, \"content\": {\"General\": [\"Fix planning issue that could cause `JOIN` queries involving functions\\nthat return null on non-null input to produce incorrect results.\", \"Fix regression that would cause certain queries involving uncorrelated\\nsubqueries in `IN` predicates to fail during planning.\", \"Fix potential *\\\"Input symbols do not match output symbols\\\"*\\nerror when writing to bucketed tables.\", \"Fix potential *\\\"Requested array size exceeds VM limit\\\"* error\\nthat triggers the JVM's `OutOfMemoryError` handling.\", \"Improve performance of window functions with identical partitioning and\\nordering but different frame specifications.\", \"Add `code-cache-collection-threshold` config which controls when Presto\\nwill attempt to force collection of the JVM code cache and reduce the\\ndefault threshold to `40%`.\", \"Add support for using `LIKE` with {doc}`/sql/create-table`.\", \"Add support for `DESCRIBE INPUT` to describe the requirements for\\nthe input parameters to a prepared statement.\"], \"Hive\": [\"Fix handling of metastore cache TTL. With the introduction of the\\nper-transaction cache, the cache timeout was reset after each access,\\nwhich means cache entries might never expire.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 64]\"}, {\"title\": \"Release 0.155\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results when queries contain multiple grouping sets that\\nresolve to the same set.\", \"Fix incorrect results when using `map` with `IN` predicates.\", \"Fix compile failure for outer joins that have a complex join criteria.\", \"Fix error messages for failures during commit.\", \"Fix memory accounting for simple aggregation, top N and distinct queries.\\nThese queries may now report higher memory usage than before.\", \"Reduce unnecessary memory usage of {func}`map_agg`, {func}`multimap_agg`\\nand {func}`map_union`.\", \"Make `INCLUDING`, `EXCLUDING` and `PROPERTIES` non-reserved keywords.\", \"Remove support for the experimental feature to compute approximate queries\\nbased on sampled tables.\", \"Properly account for time spent creating page source.\", \"Various optimizations to reduce coordinator CPU usage.\"], \"Hive\": [\"Fix schema evolution support in new Parquet reader.\", \"Fix `NoClassDefFoundError` when using Hadoop KMS.\", \"Add support for Avro file format.\", \"Always produce dictionary blocks for DWRF dictionary encoded streams.\"], \"SPI\": [\"Remove legacy connector API.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 65]\"}, {\"title\": \"Release 0.156\", \"description\": null, \"content\": {\"General\": [\"Fix potential correctness issue in queries that contain correlated scalar aggregation subqueries.\", \"Fix query failure when using `AT TIME ZONE` in `VALUES` list.\", \"Add support for quantified comparison predicates: `ALL`, `ANY`, and `SOME`.\", \"Add support for {ref}`array-type` and {ref}`row-type` that contain `NULL`\\nin {func}`checksum` aggregation.\", \"Add support for filtered aggregations. Example: `SELECT sum(a) FILTER (WHERE b > 0) FROM ...`\", \"Add a variant of {func}`from_unixtime` function that takes a timezone argument.\", \"Improve performance of `GROUP BY` queries that compute a mix of distinct\\nand non-distinct aggregations. This optimization can be turned on by setting\\nthe `optimizer.optimize-mixed-distinct-aggregations` configuration option or\\nvia the `optimize_mixed_distinct_aggregations` session property.\", \"Change default task concurrency to 16.\"], \"Hive\": [\"Add support for legacy RCFile header version in new RCFile reader.\"], \"Redis\": [\"Support `iso8601` data format for the `hash` row decoder.\"], \"SPI\": [\"Make `ConnectorPageSink#finish()` asynchronous.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 66]\"}, {\"title\": \"Release 0.157.1\", \"description\": null, \"content\": {\"General\": [\"Fix regression that could cause high CPU and heap usage on coordinator,\\nwhen processing certain types of long running queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 67]\"}, {\"title\": \"Release 0.157\", \"description\": null, \"content\": {\"General\": [\"Fix regression that could cause queries containing scalar subqueries to fail\\nduring planning.\", \"Reduce CPU usage of coordinator in large, heavily loaded clusters.\", \"Add support for `DESCRIBE OUTPUT`.\", \"Add {func}`bitwise_and_agg` and {func}`bitwise_or_agg` aggregation functions.\", \"Add JMX stats for the scheduler.\", \"Add `query.min-schedule-split-batch-size` config flag to set the minimum number of\\nsplits to consider for scheduling per batch.\", \"Remove support for scheduling multiple tasks in the same stage on a single worker.\", \"Rename `node-scheduler.max-pending-splits-per-node-per-stage` to\\n`node-scheduler.max-pending-splits-per-task`. The old name may still be used, but is\\ndeprecated and will be removed in a future version.\"], \"Hive\": [\"Fail attempts to create tables that are bucketed on non-existent columns.\", \"Improve error message when trying to query tables that are bucketed on non-existent columns.\", \"Add support for processing partitions whose schema does not match the table schema.\", \"Add support for creating external Hive tables using the `external_location` table property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 68]\"}, {\"title\": \"Release 0.158\", \"description\": null, \"content\": {\"General\": [\"Fix regression that could cause high CPU and heap usage on coordinator\\nwhen processing certain types of long running queries.\", \"Fix incorrect pruning of output columns in `EXPLAIN ANALYZE`.\", \"Fix ordering of `CHAR` values so that trailing spaces are ordered after control characters.\", \"Fix query failures for connectors that produce non-remotely accessible splits.\", \"Fix non-linear performance issue when parsing certain SQL expressions.\", \"Fix case-sensitivity issues when operating on columns of `ROW` data type.\", \"Fix failure when creating views for tables names that need quoting.\", \"Return `NULL` from {func}`element_at` for out-of-range indices instead of failing.\", \"Remove redundancies in query plans, which can reduce data transfers over the network and reduce CPU requirements.\", \"Validate resource groups configuration file on startup to ensure that all\\nselectors reference a configured resource group.\", \"Add experimental on-disk merge sort for aggregations. This can be enabled with\\nthe `experimental.spill-enabled` configuration flag.\", \"Push down predicates for `DECIMAL`, `TINYINT`, `SMALLINT` and `REAL` data types.\"], \"Hive\": [\"Add hidden `$bucket` column for bucketed tables that\\ncontains the bucket number for the current row.\", \"Prevent inserting into non-managed (i.e., external) tables.\", \"Add configurable size limit to Hive metastore cache to avoid using too much\\ncoordinator memory.\"], \"Cassandra\": [\"Allow starting the server even if a contact point hostname cannot be resolved.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 69]\"}, {\"title\": \"Release 0.159\", \"description\": null, \"content\": {\"General\": [\"Improve predicate performance for `JOIN` queries.\"], \"Hive\": [\"Optimize filtering of partition names to reduce object creation.\", \"Add limit on the number of partitions that can potentially be read per table scan.\\nThis limit is configured using `hive.max-partitions-per-scan` and defaults to 100,000.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 70]\"}, {\"title\": \"Release 0.160\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure when query has multiple unions with identical underlying columns.\", \"Fix planning failure when multiple `IN` predicates contain an identical subquery.\", \"Fix resource waste where coordinator floods rebooted workers if worker\\ncomes back before coordinator times out the query.\", \"Add {doc}`/functions/lambda`.\"], \"Hive\": [\"Fix planning failure when inserting into columns of struct types with uppercase field names.\", \"Fix resource leak when using Kerberos authentication with impersonation.\", \"Fix creating external tables so that they are properly recognized by the Hive metastore.\\nThe Hive table property `EXTERNAL` is now set to `TRUE` in addition to the setting\\nthe table type. Any previously created tables need to be modified to have this property.\", \"Add `bucket_execution_enabled` session property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 71]\"}, {\"title\": \"Release 0.161\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for queries involving multiple nested EXCEPT clauses.\\nA query such as `a EXCEPT (b EXCEPT c)` was incorrectly evaluated as\\n`a EXCEPT b EXCEPT c` and thus could return the wrong result.\", \"Fix failure when executing prepared statements that contain parameters in the join criteria.\", \"Fix failure when describing the output of prepared statements that contain aggregations.\", \"Fix planning failure when a lambda is used in the context of an aggregation or subquery.\", \"Fix column resolution rules for `ORDER BY` to match the behavior expected\\nby the SQL standard. This is a change in semantics that breaks\\nbackwards compatibility. To ease migration of existing queries, the legacy\\nbehavior can be restored by the `deprecated.legacy-order-by` config option\\nor the `legacy_order_by` session property.\", \"Improve error message when coordinator responds with `403 FORBIDDEN`.\", \"Improve performance for queries containing expressions in the join criteria\\nthat reference columns on one side of the join.\", \"Improve performance of {func}`map_concat` when one argument is empty.\", \"Remove `/v1/execute` resource.\", \"Add new column to {doc}`/sql/show-columns` (and {doc}`/sql/describe`)\\nto show extra information from connectors.\", \"Add {func}`map` to construct an empty {ref}`map-type`.\"], \"Hive connector\": [\"Remove `\\\"Partition Key: \\\"` prefix from column comments and\\nreplace it with the new extra information field described above.\"], \"JMX connector\": [\"Add support for escaped commas in `jmx.dump-tables` config property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 72]\"}, {\"title\": \"Release 0.162\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue when the type of the value in the `IN` predicate does\\nnot match the type of the elements in the subquery.\", \"Fix correctness issue when the value on the left-hand side of an `IN`\\nexpression or a quantified comparison is `NULL`.\", \"Fix correctness issue when the subquery of a quantified comparison produces no rows.\", \"Fix correctness issue due to improper inlining of TRY arguments.\", \"Fix correctness issue when the right side of a JOIN produces a very large number of rows.\", \"Fix correctness issue for expressions with multiple nested `AND` and `OR` conditions.\", \"Improve performance of window functions with similar `PARTITION BY` clauses.\", \"Improve performance of certain multi-way JOINs by automatically choosing the\\nbest evaluation order. This feature is turned off by default and can be enabled\\nvia the `reorder-joins` config option or `reorder_joins` session property.\", \"Add {func}`xxhash64` and {func}`to_big_endian_64` functions.\", \"Add aggregated operator statistics to final query statistics.\", \"Allow specifying column comments for {doc}`/sql/create-table`.\"], \"Hive\": [\"Fix performance regression when querying Hive tables with large numbers of partitions.\"], \"SPI\": [\"Connectors can now return optional output metadata for write operations.\", \"Add ability for event listeners to get connector-specific output metadata.\", \"Add client-supplied payload field `X-Presto-Client-Info` to `EventListener`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 73]\"}, {\"title\": \"Release 0.163\", \"description\": null, \"content\": {\"General\": [\"Fix data corruption when transporting dictionary-encoded data.\", \"Fix potential deadlock when resource groups are configured with memory limits.\", \"Improve performance for `OUTER JOIN` queries.\", \"Improve exchange performance by reading from buffers in parallel.\", \"Improve performance when only a subset of the columns resulting from a `JOIN` are referenced.\", \"Make `ALL`, `SOME` and `ANY` non-reserved keywords.\", \"Add {func}`from_big_endian_64` function.\", \"Change {func}`xxhash64` return type from `BIGINT` to `VARBINARY`.\", \"Change subscript operator for map types to fail if the key is not present in the map. The former\\nbehavior (returning `NULL`) can be restored by setting the `deprecated.legacy-map-subscript`\\nconfig option.\", \"Improve `EXPLAIN ANALYZE` to render stats more accurately and to include input statistics.\", \"Improve tolerance to communication errors for long running queries. This can be adjusted\\nwith the `query.remote-task.max-error-duration` config option.\"], \"Accumulo\": [\"Fix issue that could cause incorrect results for large rows.\"], \"MongoDB\": [\"Fix NullPointerException when a field contains a null.\"], \"Cassandra\": [\"Add support for `VARBINARY`, `TIMESTAMP` and `REAL` data types.\"], \"Hive\": [\"Fix issue that would prevent predicates from being pushed into Parquet reader.\", \"Fix Hive metastore user permissions caching when tables are dropped or renamed.\", \"Add experimental file based metastore which stores information in HDFS or S3 instead of a database.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 74]\"}, {\"title\": \"Release 0.164\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for queries that perform `DISTINCT` and `LIMIT` on the results of a `JOIN`.\", \"Fix correctness issue when casting between maps where the key or value is the `REAL` type.\", \"Fix correctness issue in {func}`min_by` and {func}`max_by` when nulls are present in the comparison column.\", \"Fail queries when `FILTER` clause is specified for scalar functions.\", \"Fix planning failure for certain correlated subqueries that contain aggregations.\", \"Fix planning failure when arguments to selective aggregates are derived from other selective aggregates.\", \"Fix boolean expression optimization bug that can cause long planning times, planning failures and coordinator instability.\", \"Fix query failure when `TRY` or lambda expression with the exact same body is repeated in an expression.\", \"Fix split source resource leak in coordinator that can occur when a query fails.\", \"Improve {func}`array_join` performance.\", \"Improve error message for map subscript operator when key is not present in the map.\", \"Improve client error message for invalid session.\", \"Add `VALIDATE` mode for {doc}`/sql/explain`.\"], \"Web UI\": [\"Add resource group to query detail page.\"], \"Hive\": [\"Fix handling of ORC files containing extremely large metadata.\", \"Fix failure when creating views in file based metastore.\", \"Improve performance for queries that read bucketed tables by optimizing scheduling.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 75]\"}, {\"title\": \"Release 0.165\", \"description\": null, \"content\": {\"General\": [\"Make `AT` a non-reserved keyword.\", \"Improve performance of {func}`transform`.\", \"Improve exchange performance by deserializing in parallel.\", \"Add support for compressed exchanges. This can be enabled with the `exchange.compression-enabled`\\nconfig option.\", \"Add input and hash collision statistics to {doc}`/sql/explain-analyze` output.\"], \"Hive\": [\"Add support for MAP and ARRAY types in optimized Parquet reader.\"], \"MySQL and PostgreSQL\": [\"Fix connection leak on workers.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 76]\"}, {\"title\": \"Release 0.166\", \"description\": null, \"content\": {\"General\": [\"Fix failure due to implicit coercion issue in `IN` expressions for\\ncertain combinations of data types (e.g., `double` and `decimal`).\", \"Add `query.max-length` config flag to set the maximum length of a query.\\nThe default maximum length is 1MB.\", \"Improve performance of {func}`approx_percentile`.\"], \"Hive\": [\"Include original exception from metastore for `AlreadyExistsException` when adding partitions.\", \"Add support for the Hive JSON file format (`org.apache.hive.hcatalog.data.JsonSerDe`).\"], \"Cassandra\": [\"Add configuration properties for speculative execution.\"], \"SPI\": [\"Add peak memory reservation to `SplitStatistics` in split completion events.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 77]\"}, {\"title\": \"Release 0.167\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure when a window function depends on the output of another window function.\", \"Fix planning failure for certain aggregation with both `DISTINCT` and `GROUP BY`.\", \"Fix incorrect aggregation of operator summary statistics.\", \"Fix a join issue that could cause joins that produce and filter many rows\\nto monopolize worker threads, even after the query has finished.\", \"Expand plan predicate pushdown capabilities involving implicitly coerced types.\", \"Short-circuit inner and right join when right side is empty.\", \"Optimize constant patterns for `LIKE` predicates that use an escape character.\", \"Validate escape sequences in `LIKE` predicates per the SQL standard.\", \"Reduce memory usage of {func}`min_by` and {func}`max_by`.\", \"Add {func}`transform_keys`, {func}`transform_values` and {func}`zip_with` lambda functions.\", \"Add {func}`levenshtein_distance` function.\", \"Add JMX stat for the elapsed time of the longest currently active split.\", \"Add JMX stats for compiler caches.\", \"Raise required Java version to 8u92.\"], \"Security\": [\"The `http.server.authentication.enabled` config option that previously enabled\\nKerberos has been replaced with `http-server.authentication.type=KERBEROS`.\", \"Add support for {doc}`/security/ldap` using username and password.\", \"Add a read-only {doc}`/develop/system-access-control` named `read-only`.\", \"Allow access controls to filter the results of listing catalogs, schemas and tables.\", \"Add access control checks for {doc}`/sql/show-schemas` and {doc}`/sql/show-tables`.\"], \"Web UI\": [\"Add operator-level performance analysis.\", \"Improve visibility of blocked and reserved query states.\", \"Lots of minor improvements.\"], \"JDBC driver\": [\"Allow escaping in `DatabaseMetaData` patterns.\"], \"Hive\": [\"Fix write operations for `ViewFileSystem` by using a relative location.\", \"Remove support for the `hive-cdh4` and `hive-hadoop1` connectors which\\nsupport CDH 4 and Hadoop 1.x, respectively.\", \"Remove the `hive-cdh5` connector as an alias for `hive-hadoop2`.\", \"Remove support for the legacy S3 block-based file system.\", \"Add support for KMS-managed keys for S3 server-side encryption.\"], \"Cassandra\": [\"Add support for Cassandra 3.x by removing the deprecated Thrift interface used to\\nconnect to Cassandra. The following config options are now defunct and must be removed:\\n`cassandra.thrift-port`, `cassandra.thrift-connection-factory-class`,\\n`cassandra.transport-factory-options` and `cassandra.partitioner`.\"], \"SPI\": [\"Add methods to `SystemAccessControl` and `ConnectorAccessControl` to\\nfilter the list of catalogs, schemas and tables.\", \"Add access control checks for {doc}`/sql/show-schemas` and {doc}`/sql/show-tables`.\", \"Add `beginQuery` and `cleanupQuery` notifications to `ConnectorMetadata`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 78]\"}, {\"title\": \"Release 0.168\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issues for certain `JOIN` queries that require implicit coercions\\nfor terms in the join criteria.\", \"Fix invalid \\\"No more locations already set\\\" error.\", \"Fix invalid \\\"No more buffers already set\\\" error.\", \"Temporarily revert empty join short-circuit optimization due to issue with hanging queries.\", \"Improve performance of `DECIMAL` type and operators.\", \"Optimize window frame computation for empty frames.\", \"{func}`json_extract` and {func}`json_extract_scalar` now support escaping double\\nquotes or backslashes using a backslash with a JSON path subscript. This changes\\nthe semantics of any invocation using a backslash, as backslashes were previously\\ntreated as normal characters.\", \"Improve performance of {func}`filter` and {func}`map_filter` lambda functions.\", \"Add {doc}`/connector/memory`.\", \"Add {func}`arrays_overlap` and {func}`array_except` functions.\", \"Allow concatenating more than two arrays with `concat()` or maps with {func}`map_concat`.\", \"Add a time limit for the iterative optimizer. It can be adjusted via the `iterative_optimizer_timeout`\\nsession property or `experimental.iterative-optimizer-timeout` configuration option.\", \"`ROW` types are now orderable if all of the field types are orderable.\\nThis allows using them in comparison expressions, `ORDER BY` and\\nfunctions that require orderable types (e.g., {func}`max`).\"], \"JDBC driver\": [\"Update `DatabaseMetaData` to reflect features that are now supported.\", \"Update advertised JDBC version to 4.2, which part of Java 8.\", \"Return correct driver and server versions rather than `1.0`.\"], \"Hive\": [\"Fix reading decimals for RCFile text format using non-optimized reader.\", \"Fix bug which prevented the file based metastore from being used.\", \"Enable optimized RCFile reader by default.\", \"Common user errors are now correctly categorized.\", \"Add new, experimental, RCFile writer optimized for Presto. The new writer can be enabled with the\\n`rcfile_optimized_writer_enabled` session property or the `hive.rcfile-optimized-writer.enabled`\\nHive catalog property.\"], \"Cassandra\": [\"Add predicate pushdown for clustering key.\"], \"MongoDB\": [\"Allow SSL connections using the `mongodb.ssl.enabled` config flag.\"], \"SPI\": [\"ConnectorIndex now returns `ConnectorPageSource` instead of `RecordSet`. Existing connectors\\nthat support index join can use the `RecordPageSource` to adapt to the new API.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 79]\"}, {\"title\": \"Release 0.169\", \"description\": null, \"content\": {\"General\": [\"Fix regression that could cause queries involving `JOIN` and certain language features\\nsuch as `current_date`, `current_time` or `extract` to fail during planning.\", \"Limit the maximum allowed input size to {func}`levenshtein_distance`.\", \"Improve performance of {func}`map_agg` and {func}`multimap_agg`.\", \"Improve memory accounting when grouping on a single `BIGINT` column.\"], \"JDBC driver\": [\"Return correct class name for `ARRAY` type from `ResultSetMetaData.getColumnClassName()`.\"], \"CLI\": [\"Fix support for non-standard offset time zones (e.g., `GMT+01:00`).\"], \"Cassandra\": [\"Add custom error codes.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 80]\"}, {\"title\": \"Release 0.170\", \"description\": null, \"content\": {\"General\": [\"Fix race condition that could cause queries to fail with `InterruptedException` in rare cases.\", \"Fix a performance regression for `GROUP BY` queries over `UNION`.\", \"Fix a performance regression that occurs when a significant number of exchange\\nsources produce no data during an exchange (e.g., in a skewed hash join).\"], \"Web UI\": [\"Fix broken rendering when catalog properties are set.\", \"Fix rendering of live plan when query is queued.\"], \"JDBC driver\": [\"Add support for `DatabaseMetaData.getTypeInfo()`.\"], \"Hive\": [\"Improve decimal support for the Parquet reader.\", \"Remove misleading \\\"HDFS\\\" string from error messages.\"], \"Cassandra\": [\"Fix an intermittent connection issue for Cassandra 2.1.\", \"Remove support for selecting by partition key when the partition key is only partially specified.\\nThe `cassandra.limit-for-partition-key-select` and `cassandra.fetch-size-for-partition-key-select`\\nconfig options are no longer supported.\", \"Remove partition key cache to improve consistency and reduce load on the Cassandra cluster due to background cache refresh.\", \"Reduce the number of connections opened to the Cassandra cluster. Now Presto opens a single connection from each node.\", \"Use exponential backoff for retries when Cassandra hosts are down. The retry timeout can be controlled via the\\n`cassandra.no-host-available-retry-timeout` config option, which has a default value of `1m`.\\nThe `cassandra.no-host-available-retry-count` config option is no longer supported.\"], \"Verifier\": [\"Add support for `INSERT` queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 81]\"}, {\"title\": \"Release 0.171\", \"description\": null, \"content\": {\"General\": [\"Fix planning regression for queries that compute a mix of distinct and non-distinct aggregations.\", \"Fix casting from certain complex types to `JSON` when source type contains `JSON` or `DECIMAL`.\", \"Fix issue for data definition queries that prevented firing completion events or purging them from\\nthe coordinator's memory.\", \"Add support for capture in lambda expressions.\", \"Add support for `ARRAY` and `ROW` type as the compared value in {func}`min_by` and {func}`max_by`.\", \"Add support for `CHAR(n)` data type to common string functions.\", \"Add {func}`codepoint`, {func}`skewness` and {func}`kurtosis` functions.\", \"Improve validation of resource group configuration.\", \"Fail queries when casting unsupported types to JSON; see {doc}`/functions/json` for supported types.\"], \"Web UI\": [\"Fix the threads UI (`/ui/thread`).\"], \"Hive\": [\"Fix issue where some files are not deleted on cancellation of `INSERT` or `CREATE` queries.\", \"Allow writing to non-managed (external) Hive tables. This is disabled by default but can be\\nenabled via the `hive.non-managed-table-writes-enabled` configuration option.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 82]\"}, {\"title\": \"Release 0.172\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue in `ORDER BY` queries due to improper implicit coercions.\", \"Fix planning failure when `GROUP BY` queries contain lambda expressions.\", \"Fix planning failure when left side of `IN` expression contains subqueries.\", \"Fix incorrect permissions check for `SHOW TABLES`.\", \"Fix planning failure when `JOIN` clause contains lambda expressions that reference columns or variables from the enclosing scope.\", \"Reduce memory usage of {func}`map_agg` and {func}`map_union`.\", \"Reduce memory usage of `GROUP BY` queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 83]\"}, {\"title\": \"Release 0.173\", \"description\": null, \"content\": {\"General\": [\"Fix issue where `FILTER` was ignored for {func}`count` with a constant argument.\", \"Support table comments for {doc}`/sql/create-table` and {doc}`/sql/create-table-as`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 84]\"}, {\"title\": \"Release 0.174\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for correlated subqueries containing a `LIMIT` clause.\", \"Fix query failure when {func}`reduce` function is used with lambda expressions\\ncontaining {func}`array_sort`, {func}`shuffle`, {func}`reverse`, {func}`array_intersect`,\\n{func}`arrays_overlap`, {func}`concat` (for arrays) or {func}`map_concat`.\", \"Fix a bug that causes underestimation of the amount of memory used by {func}`max_by`,\\n{func}`min_by`, {func}`max`, {func}`min`, and {func}`arbitrary` aggregations over\\nvarchar/varbinary columns.\", \"Fix a memory leak in the coordinator that causes long-running queries in highly loaded\\nclusters to consume unnecessary memory.\", \"Improve performance of aggregate window functions.\", \"Improve parallelism of queries involving `GROUPING SETS`, `CUBE` or `ROLLUP`.\", \"Improve parallelism of `UNION` queries.\", \"Filter and projection operations are now always processed columnar if possible, and Presto\\nwill automatically take advantage of dictionary encodings where effective.\\nThe `processing_optimization` session property and `optimizer.processing-optimization`\\nconfiguration option have been removed.\", \"Add support for escaped unicode sequences in string literals.\", \"Add {doc}`/sql/show-grants` and `information_schema.table_privileges` table.\"], \"Hive\": [\"Change default value of `hive.metastore-cache-ttl` and `hive.metastore-refresh-interval` to 0\\nto disable cross-transaction metadata caching.\"], \"Web UI\": [\"Fix ES6 compatibility issue with older browsers.\", \"Display buffered bytes for every stage in the live plan UI.\"], \"SPI\": [\"Add support for retrieving table grants.\", \"Rename SPI access control check from `checkCanShowTables` to `checkCanShowTablesMetadata`,\\nwhich is used for both {doc}`/sql/show-tables` and {doc}`/sql/show-grants`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 85]\"}, {\"title\": \"Release 0.175\", \"description\": null, \"content\": {\"General\": [\"Fix *\\\"position is not valid\\\"* query execution failures.\", \"Fix memory accounting bug that can potentially cause `OutOfMemoryError`.\", \"Fix regression that could cause certain queries involving `UNION` and\\n`GROUP BY` or `JOIN` to fail during planning.\", \"Fix planning failure for `GROUP BY` queries containing correlated\\nsubqueries in the `SELECT` clause.\", \"Fix execution failure for certain `DELETE` queries.\", \"Reduce occurrences of *\\\"Method code too large\\\"* errors.\", \"Reduce memory utilization for certain queries involving `ORDER BY`.\", \"Improve performance of map subscript from O(n) to O(1) when the map is\\nproduced by an eligible operation, including the map constructor and\\nHive readers (except ORC and optimized Parquet). More read and write\\noperations will take advantage of this in future releases.\", \"Add `enable_intermediate_aggregations` session property to enable the\\nuse of intermediate aggregations within un-grouped aggregations.\", \"Add support for `INTERVAL` data type to {func}`avg` and {func}`sum` aggregation functions.\", \"Add support for `INT` as an alias for the `INTEGER` data type.\", \"Add resource group information to query events.\"], \"Hive\": [\"Make table creation metastore operations idempotent, which allows\\nrecovery when retrying timeouts or other errors.\"], \"MongoDB\": [\"Rename `mongodb.connection-per-host` config option to `mongodb.connections-per-host`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 86]\"}, {\"title\": \"Release 0.176\", \"description\": null, \"content\": {\"General\": [\"Fix an issue where a query (and some of its tasks) continues to\\nconsume CPU/memory on the coordinator and workers after the query fails.\", \"Fix a regression that cause the GC overhead and pauses to increase significantly when processing maps.\", \"Fix a memory tracking bug that causes the memory to be overestimated for `GROUP BY` queries on `bigint` columns.\", \"Improve the performance of the {func}`transform_values` function.\", \"Add support for casting from `JSON` to `REAL` type.\", \"Add {func}`parse_duration` function.\"], \"MySQL\": [\"Disallow having a database in the `connection-url` config property.\"], \"Accumulo\": [\"Decrease planning time by fetching index metrics in parallel.\"], \"MongoDB\": [\"Allow predicate pushdown for ObjectID.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 87]\"}, {\"title\": \"Release 0.177\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue when performing range comparisons over columns of type `CHAR`.\", \"Fix correctness issue due to mishandling of nulls and non-deterministic expressions in\\ninequality joins unless `fast_inequality_join` is disabled.\", \"Fix excessive GC overhead caused by lambda expressions. There are still known GC issues\\nwith captured lambda expressions. This will be fixed in a future release.\", \"Check for duplicate columns in `CREATE TABLE` before asking the connector to create\\nthe table. This improves the error message for most connectors and will prevent errors\\nfor connectors that do not perform validation internally.\", \"Add support for null values on the left-hand side of a semijoin (i.e., `IN` predicate\\nwith subqueries).\", \"Add `SHOW STATS` to display table and query statistics.\", \"Improve implicit coercion support for functions involving lambda. Specifically, this makes\\nit easier to use the {func}`reduce` function.\", \"Improve plans for queries involving `ORDER BY` and `LIMIT` by avoiding unnecessary\\ndata exchanges.\", \"Improve performance of queries containing window functions with identical `PARTITION BY`\\nand `ORDER BY` clauses.\", \"Improve performance of certain queries involving `OUTER JOIN` and aggregations, or\\ncontaining certain forms of correlated subqueries. This optimization is experimental\\nand can be turned on via the `push_aggregation_through_join` session property or the\\n`optimizer.push-aggregation-through-join` config option.\", \"Improve performance of certain queries involving joins and aggregations. This optimization\\nis experimental and can be turned on via the `push_partial_aggregation_through_join`\\nsession property.\", \"Improve error message when a lambda expression has a different number of arguments than expected.\", \"Improve error message when certain invalid `GROUP BY` expressions containing lambda expressions.\"], \"Hive\": [\"Fix handling of trailing spaces for the `CHAR` type when reading RCFile.\", \"Allow inserts into tables that have more partitions than the partitions-per-scan limit.\", \"Add support for exposing Hive table statistics to the engine. This option is experimental and\\ncan be turned on via the `statistics_enabled` session property.\", \"Ensure file name is always present for error messages about corrupt ORC files.\"], \"Cassandra\": [\"Remove caching of metadata in the Cassandra connector. Metadata caching makes Presto violate\\nthe consistency defined by the Cassandra cluster. It's also unnecessary because the Cassandra\\ndriver internally caches metadata. The `cassandra.max-schema-refresh-threads`,\\n`cassandra.schema-cache-ttl` and `cassandra.schema-refresh-interval` config options have\\nbeen removed.\", \"Fix intermittent issue in the connection retry mechanism.\"], \"Web UI\": [\"Change cluster HUD realtime statistics to be aggregated across all running queries.\", \"Change parallelism statistic on cluster HUD to be averaged per-worker.\", \"Fix bug that always showed indeterminate progress bar in query list view.\", \"Change running drivers statistic to exclude blocked drivers.\", \"Change unit of CPU and scheduled time rate sparklines to seconds on query details page.\", \"Change query details page refresh interval to three seconds.\", \"Add uptime and connected status indicators to every page.\"], \"CLI\": [\"Add support for preprocessing commands. When the `PRESTO_PREPROCESSOR` environment\\nvariable is set, all commands are piped through the specified program before being sent to\\nthe Presto server.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 88]\"}, {\"title\": \"Release 0.178\", \"description\": null, \"content\": {\"General\": [\"Fix various memory accounting bugs, which reduces the likelihood of full GCs/OOMs.\", \"Fix a regression that causes queries that use the keyword \\\"stats\\\" to fail to parse.\", \"Fix an issue where a query does not get cleaned up on the coordinator after query failure.\", \"Add ability to cast to `JSON` from `REAL`, `TINYINT` or `SMALLINT`.\", \"Add support for `GROUPING` operation to {ref}`complex grouping operations<complex-grouping-operations>`.\", \"Add support for correlated subqueries in `IN` predicates.\", \"Add {func}`to_ieee754_32` and {func}`to_ieee754_64` functions.\"], \"Hive\": [\"Fix high CPU usage due to schema caching when reading Avro files.\", \"Preserve decompression error causes when decoding ORC files.\"], \"Memory connector\": [\"Fix a bug that prevented creating empty tables.\"], \"SPI\": [\"Make environment available to resource group configuration managers.\", \"Add additional performance statistics to query completion event.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 89]\"}, {\"title\": \"Release 0.179\", \"description\": null, \"content\": {\"General\": [\"Fix issue which could cause incorrect results when processing dictionary encoded data.\\nIf the expression can fail on bad input, the results from filtered-out rows containing\\nbad input may be included in the query output ({issue}`x8262`).\", \"Fix planning failure when similar expressions appear in the `ORDER BY` clause of a query that\\ncontains `ORDER BY` and `LIMIT`.\", \"Fix planning failure when `GROUPING()` is used with the `legacy_order_by` session property set to `true`.\", \"Fix parsing failure when `NFD`, `NFC`, `NFKD` or `NFKC` are used as identifiers.\", \"Fix a memory leak on the coordinator that manifests itself with canceled queries.\", \"Fix excessive GC overhead caused by captured lambda expressions.\", \"Reduce the memory usage of map/array aggregation functions.\", \"Redact sensitive config property values in the server log.\", \"Update timezone database to version 2017b.\", \"Add {func}`repeat` function.\", \"Add {func}`crc32` function.\", \"Add file based global security, which can be configured with the `etc/access-control.properties`\\nand `security.config-file` config properties. See {doc}`/security/built-in-system-access-control`\\nfor more details.\", \"Add support for configuring query runtime and queueing time limits to resource groups.\"], \"Hive\": [\"Fail queries that access encrypted S3 objects that do not have their unencrypted content lengths set in their metadata.\"], \"JDBC driver\": [\"Add support for setting query timeout through `Statement.setQueryTimeout()`.\"], \"SPI\": [\"Add grantee and revokee to `GRANT` and `REVOKE` security checks.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 90]\"}, {\"title\": \"Release 0.180\", \"description\": null, \"content\": {\"General\": [\"Fix a rare bug where rows containing only `null` values are not returned\\nto the client. This only occurs when an entire result page contains only\\n`null` values. The only known case is a query over an ORC encoded Hive table\\nthat does not perform any transformation of the data.\", \"Fix incorrect results when performing comparisons between values of approximate\\ndata types (`REAL`, `DOUBLE`) and columns of certain exact numeric types\\n(`INTEGER`, `BIGINT`, `DECIMAL`).\", \"Fix memory accounting for {func}`min_by` and {func}`max_by` on complex types.\", \"Fix query failure due to `NoClassDefFoundError` when scalar functions declared\\nin plugins are implemented with instance methods.\", \"Improve performance of map subscript from O(n) to O(1) in all cases. Previously, only maps\\nproduced by certain functions and readers could take advantage of this improvement.\", \"Skip unknown costs in `EXPLAIN` output.\", \"Support {doc}`/security/internal-communication` between Presto nodes.\", \"Add initial support for `CROSS JOIN` against `LATERAL` derived tables.\", \"Add support for `VARBINARY` concatenation.\", \"Add {doc}`/connector/thrift` that makes it possible to use Presto with\\nexternal systems without the need to implement a custom connector.\", \"Add experimental `/v1/resourceGroupState` REST endpoint on coordinator.\"], \"Hive\": [\"Fix skipping short decimal values in the optimized Parquet reader\\nwhen they are backed by the `int32` or `int64` types.\", \"Ignore partition bucketing if table is not bucketed. This allows dropping\\nthe bucketing from table metadata but leaving it for old partitions.\", \"Improve error message for Hive partitions dropped during execution.\", \"The optimized RCFile writer is enabled by default, but can be disabled\\nwith the `hive.rcfile-optimized-writer.enabled` config option.\\nThe writer supports validation which reads back the entire file after\\nwriting. Validation is disabled by default, but can be enabled with the\\n`hive.rcfile.writer.validate` config option.\"], \"Cassandra\": [\"Add support for `INSERT`.\", \"Add support for pushdown of non-equality predicates on clustering keys.\"], \"JDBC driver\": [\"Add support for authenticating using Kerberos.\", \"Allow configuring SSL/TLS and Kerberos properties on a per-connection basis.\", \"Add support for executing queries using a SOCKS or HTTP proxy.\"], \"CLI\": [\"Add support for executing queries using an HTTP proxy.\"], \"SPI\": [\"Add running time limit and queued time limit to `ResourceGroupInfo`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 91]\"}, {\"title\": \"Release 0.181\", \"description\": null, \"content\": {\"General\": [\"Fix query failure and memory usage tracking when query contains\\n{func}`transform_keys` or {func}`transform_values`.\", \"Prevent `CREATE TABLE IF NOT EXISTS` queries from ever failing with *\\\"Table already exists\\\"*.\", \"Fix query failure when `ORDER BY` expressions reference columns that are used in\\nthe `GROUP BY` clause by their fully-qualified name.\", \"Fix excessive GC overhead caused by large arrays and maps containing `VARCHAR` elements.\", \"Improve error handling when passing too many arguments to various\\nfunctions or operators that take a variable number of arguments.\", \"Improve performance of `count(*)` aggregations over subqueries with known\\nconstant cardinality.\", \"Add `VERBOSE` option for {doc}`/sql/explain-analyze` that provides additional\\nlow-level details about query performance.\", \"Add per-task distribution information to the output of `EXPLAIN ANALYZE`.\", \"Add support for `DROP COLUMN` in {doc}`/sql/alter-table`.\", \"Change local scheduler to prevent starvation of long running queries\\nwhen the cluster is under constant load from short queries. The new\\nbehavior is disabled by default and can be enabled by setting the\\nconfig property `task.level-absolute-priority=true`.\", \"Improve the fairness of the local scheduler such that long-running queries\\nwhich spend more time on the CPU per scheduling quanta (e.g., due to\\nslow connectors) do not get a disproportionate share of CPU. The new\\nbehavior is disabled by default and can be enabled by setting the\\nconfig property `task.legacy-scheduling-behavior=false`.\", \"Add a config option to control the prioritization of queries based on\\nelapsed scheduled time. The `task.level-time-multiplier` property\\ncontrols the target scheduled time of a level relative to the next\\nlevel. Higher values for this property increase the fraction of CPU\\nthat will be allocated to shorter queries. This config property only\\nhas an effect when `task.level-absolute-priority=true` and\\n`task.legacy-scheduling-behavior=false`.\"], \"Hive\": [\"Fix potential native memory leak when writing tables using RCFile.\", \"Correctly categorize certain errors when writing tables using RCFile.\", \"Decrease the number of file system metadata calls when reading tables.\", \"Add support for dropping columns.\"], \"JDBC driver\": [\"Add support for query cancellation using `Statement.cancel()`.\"], \"PostgreSQL\": [\"Add support for operations on external tables.\"], \"Accumulo\": [\"Improve query performance by scanning index ranges in parallel.\"], \"SPI\": [\"Fix regression that broke serialization for `SchemaTableName`.\", \"Add access control check for `DROP COLUMN`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 92]\"}, {\"title\": \"Release 0.182\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue that causes {func}`corr` to return positive numbers for inverse correlations.\", \"Fix the {doc}`/sql/explain` query plan for tables that are partitioned\\non `TIMESTAMP` or `DATE` columns.\", \"Fix query failure when using certain window functions that take arrays or maps as arguments (e.g., {func}`approx_percentile`).\", \"Implement subtraction for all `TIME` and `TIMESTAMP` types.\", \"Improve planning performance for queries that join multiple tables with\\na large number columns.\", \"Improve the performance of joins with only non-equality conditions by using\\na nested loops join instead of a hash join.\", \"Improve the performance of casting from `JSON` to `ARRAY` or `MAP` types.\", \"Add a new {ref}`ipaddress-type` type to represent IP addresses.\", \"Add {func}`to_milliseconds` function to convert intervals (day to second) to milliseconds.\", \"Add support for column aliases in `CREATE TABLE AS` statements.\", \"Add a config option to reject queries during cluster initialization.\\nQueries are rejected if the active worker count is less than the\\n`query-manager.initialization-required-workers` property while the\\ncoordinator has been running for less than `query-manager.initialization-timeout`.\", \"Add {doc}`/connector/tpcds`. This connector provides a set of schemas to\\nsupport the TPC Benchmark\\u2122 DS (TPC-DS).\"], \"CLI\": [\"Fix an issue that would sometimes prevent queries from being cancelled when exiting from the pager.\"], \"Hive\": [\"Fix reading decimal values in the optimized Parquet reader when they are backed\\nby the `int32` or `int64` types.\", \"Add a new experimental ORC writer implementation optimized for Presto.\\nWe have some upcoming improvements, so we recommend waiting a few releases before\\nusing this in production. The new writer can be enabled with the\\n`hive.orc.optimized-writer.enabled` configuration property or with the\\n`orc_optimized_writer_enabled` session property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 93]\"}, {\"title\": \"Release 0.183\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure for queries that use `GROUPING` and contain aggregation expressions\\nthat require implicit coercions.\", \"Fix planning failure for queries that contains a non-equi left join that is semantically\\nequivalent to an inner join.\", \"Fix issue where a query may have a reported memory that is higher than actual usage when\\nan aggregation is followed by other non-trivial work in the same stage. This can lead to failures\\ndue to query memory limit, or lower cluster throughput due to perceived insufficient memory.\", \"Fix query failure for `CHAR` functions {func}`trim`, {func}`rtrim`, and {func}`substr` when\\nthe return value would have trailing spaces under `VARCHAR` semantics.\", \"Fix formatting in `EXPLAIN ANALYZE` output.\", \"Improve error message when a query contains an unsupported form of correlated subquery.\", \"Improve performance of `CAST(json_parse(...) AS ...)`.\", \"Add {func}`map_from_entries` and {func}`map_entries` functions.\", \"Change spilling for aggregations to only occur when the cluster runs out of memory.\", \"Remove the `experimental.operator-memory-limit-before-spill` config property\\nand the `operator_memory_limit_before_spill` session property.\", \"Allow configuring the amount of memory that can be used for merging spilled aggregation data\\nfrom disk using the `experimental.aggregation-operator-unspill-memory-limit` config\\nproperty or the `aggregation_operator_unspill_memory_limit` session property.\"], \"Web UI\": [\"Add output rows, output size, written rows and written size to query detail page.\"], \"Hive\": [\"Work around [ORC-222](https://issues.apache.org/jira/browse/ORC-222) which results in\\ninvalid summary statistics in ORC or DWRF files when the input data contains invalid string data.\\nPreviously, this would usually cause the query to fail, but in rare cases it could\\ncause wrong results by incorrectly skipping data based on the invalid statistics.\", \"Fix issue where reported memory is lower than actual usage for table columns containing\\nstring values read from ORC or DWRF files. This can lead to high GC overhead or out-of-memory crash.\", \"Improve error message for small ORC files that are completely corrupt or not actually ORC.\", \"Add predicate pushdown for the hidden column `\\\"$path\\\"`.\"], \"TPC-H\": [\"Add column statistics for schemas `tiny` and `sf1`.\"], \"TPC-DS\": [\"Add column statistics for schemas `tiny` and `sf1`.\"], \"SPI\": [\"Map columns or values represented with `ArrayBlock` and `InterleavedBlock` are\\nno longer supported. They must be represented as `MapBlock` or `SingleMapBlock`.\", \"Extend column statistics with minimal and maximal value.\", \"Replace `nullsCount` with `nullsFraction` in column statistics.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 94]\"}, {\"title\": \"Release 0.184\", \"description\": null, \"content\": {\"General\": [\"Fix query execution failure for `split_to_map(...)[...]`.\", \"Fix issue that caused queries containing `CROSS JOIN` to continue using CPU resources\\neven after they were killed.\", \"Fix planning failure for some query shapes containing `count(*)` and a non-empty\\n`GROUP BY` clause.\", \"Fix communication failures caused by lock contention in the local scheduler.\", \"Improve performance of {func}`element_at` for maps to be constant time rather than\\nproportional to the size of the map.\", \"Improve performance of queries with gathering exchanges.\", \"Require `coalesce()` to have at least two arguments, as mandated by the SQL standard.\", \"Add {func}`hamming_distance` function.\"], \"JDBC driver\": [\"Always invoke the progress callback with the final stats at query completion.\"], \"Web UI\": [\"Add worker status page with information about currently running threads\\nand resource utilization (CPU, heap, memory pools). This page is accessible\\nby clicking a hostname on a query task list.\"], \"Hive\": [\"Fix partition filtering for keys of `CHAR`, `DECIMAL`, or `DATE` type.\", \"Reduce system memory usage when reading table columns containing string values\\nfrom ORC or DWRF files. This can prevent high GC overhead or out-of-memory crashes.\"], \"TPC-DS\": [\"Fix display of table statistics when running `SHOW STATS FOR ...`.\"], \"SPI\": [\"Row columns or values represented with `ArrayBlock` and `InterleavedBlock` are\\nno longer supported. They must be represented as `RowBlock` or `SingleRowBlock`.\", \"Add `source` field to `ConnectorSession`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 95]\"}, {\"title\": \"Release 0.185\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect column names in `QueryCompletedEvent`.\", \"Fix excessive CPU usage in coordinator for queries that have\\nlarge string literals containing non-ASCII characters.\", \"Fix potential infinite loop during query optimization when constant\\nexpressions fail during evaluation.\", \"Fix incorrect ordering when the same field appears multiple times\\nwith different ordering specifications in a window function `ORDER BY`\\nclause. For example: `OVER (ORDER BY x ASC, x DESC)`.\", \"Do not allow dropping or renaming hidden columns.\", \"When preparing to drop a column, ignore hidden columns when\\nchecking if the table only has one column.\", \"Improve performance of joins where the condition is a range over a function.\\nFor example: `a JOIN b ON b.x < f(a.x) AND b.x > g(a.x)`\", \"Improve performance of certain window functions (e.g., `LAG`) with similar specifications.\", \"Extend {func}`substr` function to work on `VARBINARY` in addition to `CHAR` and `VARCHAR`.\", \"Add cast from `JSON` to `ROW`.\", \"Allow usage of `TRY` within lambda expressions.\"], \"Hive\": [\"Improve ORC reader efficiency by only reading small ORC streams when accessed in the query.\", \"Improve RCFile IO efficiency by increasing the buffer size from 1 to 8 MB.\", \"Fix native memory leak for optimized RCFile writer.\", \"Fix potential native memory leak for optimized ORC writer.\"], \"Memory connector\": [\"Add support for views.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 96]\"}, {\"title\": \"Release 0.186\", \"description\": null, \"content\": {\"General\": [\"Fix excessive GC overhead caused by map to map cast.\", \"Fix implicit coercions for `ROW` types, allowing operations between\\ncompatible types such as `ROW(INTEGER)` and `ROW(BIGINT)`.\", \"Fix issue that may cause queries containing expensive functions, such as regular\\nexpressions, to continue using CPU resources even after they are killed.\", \"Fix performance issue caused by redundant casts.\", \"Fix {func}`json_parse` to not ignore trailing characters. Previously,\\ninput such as `[1,2]abc` would successfully parse as `[1,2]`.\", \"Fix leak in running query counter for failed queries. The counter would\\nincrement but never decrement for queries that failed before starting.\", \"Reduce coordinator HTTP thread usage for queries that are queued or waiting for data.\", \"Reduce memory usage when building data of `VARCHAR` or `VARBINARY` types.\", \"Estimate memory usage for `GROUP BY` more precisely to avoid out of memory errors.\", \"Add queued time and elapsed time to the client protocol.\", \"Add `query_max_execution_time` session property and `query.max-execution-time` config\\nproperty. Queries will be aborted after they execute for more than the specified duration.\", \"Add {func}`inverse_normal_cdf` function.\", \"Add {doc}`/functions/geospatial` including functions for processing Bing tiles.\", \"Add {doc}`/admin/spill` for joins.\", \"Add {doc}`/connector/redshift`.\"], \"Resource groups\": [\"Query Queues are deprecated in favor of {doc}`/admin/resource-groups`\\nand will be removed in a future release.\", \"Rename the `maxRunning` property to `hardConcurrencyLimit`. The old\\nproperty name is deprecated and will be removed in a future release.\", \"Fail on unknown property names when loading the JSON config file.\"], \"JDBC driver\": [\"Allow specifying an empty password.\", \"Add `getQueuedTimeMillis()` and `getElapsedTimeMillis()` to `QueryStats`.\"], \"Hive\": [\"Fix `FileSystem closed` errors when using Kerberos authentication.\", \"Add support for path style access to the S3 file system. This can be enabled\\nby setting the `hive.s3.path-style-access=true` config property.\"], \"SPI\": [\"Add an `ignoreExisting` flag to `ConnectorMetadata::createTable()`.\", \"Remove the `getTotalBytes()` method from `RecordCursor` and `ConnectorPageSource`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 97]\"}, {\"title\": \"Release 0.187\", \"description\": null, \"content\": {\"General\": [\"Fix a stability issue that may cause query failures due to a large number of HTTP requests timing out.\\nThe issue has been observed in a large deployment under stress.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 98]\"}, {\"title\": \"Release 0.188\", \"description\": null, \"content\": {\"General\": [\"Fix handling of negative start indexes in array {func}`slice` function.\", \"Fix inverted sign for time zones `Etc/GMT-12`, `Etc/GMT-11`, ..., `Etc/GMT-1`,\\n`Etc/GMT+1`, ... `Etc/GMT+12`.\", \"Improve performance of server logging and HTTP request logging.\", \"Reduce GC spikes by compacting join memory over time instead of all at once\\nwhen memory is low. This can increase reliability at the cost of additional\\nCPU. This can be enabled via the `pages-index.eager-compaction-enabled`\\nconfig property.\", \"Improve performance of and reduce GC overhead for compaction of in-memory data structures,\\nprimarily used in joins.\", \"Mitigate excessive GC and degraded query performance by forcing expiration of\\ngenerated classes for functions and expressions one hour after generation.\", \"Mitigate performance issue caused by JVM when generated code is used\\nfor multiple hours or days.\"], \"CLI\": [\"Fix transaction support. Previously, after the first statement in the\\ntransaction, the transaction would be abandoned and the session would\\nsilently revert to auto-commit mode.\"], \"JDBC driver\": [\"Support using `Statement.cancel()` for all types of statements.\"], \"Resource group\": [\"Add environment support to the `db` resource groups manager.\\nPreviously, configurations for different clusters had to be stored in separate databases.\\nWith this change, different cluster configurations can be stored in the same table and\\nPresto will use the new `environment` column to differentiate them.\"], \"SPI\": [\"Add query plan to the query completed event.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 99]\"}, {\"title\": \"Release 0.189\", \"description\": null, \"content\": {\"General\": [\"Fix query failure while logging the query plan.\", \"Fix a bug that causes clients to hang when executing `LIMIT` queries when\\n`optimizer.force-single-node-output` is disabled.\", \"Fix a bug in the {func}`bing_tile_at` and {func}`bing_tile_polygon` functions\\nwhere incorrect results were produced for points close to tile edges.\", \"Fix variable resolution when lambda argument has the same name as a table column.\", \"Improve error message when running `SHOW TABLES` on a catalog that does not exist.\", \"Improve performance for queries with highly selective filters.\", \"Execute {doc}`/sql/use` on the server rather than in the CLI, allowing it\\nto be supported by any client. This requires clients to add support for\\nthe protocol changes (otherwise the statement will be silently ignored).\", \"Allow casting `JSON` to `ROW` even if the `JSON` does not contain every\\nfield in the `ROW`.\", \"Add support for dereferencing row fields in lambda expressions.\"], \"Security\": [\"Support configuring multiple authentication types, which allows supporting\\nclients that have different authentication requirements or gracefully\\nmigrating between authentication types without needing to update all clients\\nat once. Specify multiple values for `http-server.authentication.type`,\\nseparated with commas.\", \"Add support for TLS client certificates as an authentication mechanism by\\nspecifying `CERTIFICATE` for `http-server.authentication.type`.\\nThe distinguished name from the validated certificate will be provided as a\\n`javax.security.auth.x500.X500Principal`. The certificate authority (CA)\\nused to sign client certificates will be need to be added to the HTTP server\\nKeyStore (should technically be a TrustStore but separating them out is not\\nyet supported).\", \"Skip sending final leg of SPNEGO authentication when using Kerberos.\"], \"JDBC driver\": [\"Per the JDBC specification, close the `ResultSet` when `Statement` is closed.\", \"Add support for TLS client certificate authentication by configuring the\\n`SSLKeyStorePath` and `SSLKeyStorePassword` parameters.\", \"Add support for transactions using SQL statements or the standard JDBC mechanism.\", \"Allow executing the `USE` statement. Note that this is primarily useful when\\nrunning arbitrary SQL on behalf of users. For programmatic use, continuing\\nto use `setCatalog()` and `setSchema()` on `Connection` is recommended.\", \"Allow executing `SET SESSION` and `RESET SESSION`.\"], \"Resource group\": [\"Add `WEIGHTED_FAIR` resource group scheduling policy.\"], \"Hive\": [\"Do not require setting `hive.metastore.uri` when using the file metastore.\", \"Reduce memory usage when reading string columns from ORC or DWRF files.\"], \"MySQL, PostgreSQL, Redshift, and SQL Server shanges\": [\"Change mapping for columns with `DECIMAL(p,s)` data type from Presto `DOUBLE`\\ntype to the corresponding Presto `DECIMAL` type.\"], \"Kafka\": [\"Fix documentation for raw decoder.\"], \"Thrift connector\": [\"Add support for index joins.\"], \"SPI\": [\"Deprecate `SliceArrayBlock`.\", \"Add `SessionPropertyConfigurationManager` plugin to enable overriding default\\nsession properties dynamically.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 100]\"}, {\"title\": \"Release 0.190\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for {func}`array_min` and {func}`array_max` when arrays contain `NaN`.\", \"Fix planning failure for queries involving `GROUPING` that require implicit coercions\\nin expressions containing aggregate functions.\", \"Fix potential workload imbalance when using topology-aware scheduling.\", \"Fix performance regression for queries containing `DISTINCT` aggregates over the same column.\", \"Fix a memory leak that occurs on workers.\", \"Improve error handling when a `HAVING` clause contains window functions.\", \"Avoid unnecessary data redistribution when writing when the target table has\\nthe same partition property as the data being written.\", \"Ignore case when sorting the output of `SHOW FUNCTIONS`.\", \"Improve rendering of the `BingTile` type.\", \"The {func}`approx_distinct` function now supports a standard error\\nin the range of `[0.0040625, 0.26000]`.\", \"Add support for `ORDER BY` in aggregation functions.\", \"Add dictionary processing for joins which can improve join performance up to 50%.\\nThis optimization can be disabled using the `dictionary-processing-joins-enabled`\\nconfig property or the `dictionary_processing_join` session property.\", \"Add support for casting to `INTERVAL` types.\", \"Add {func}`ST_Buffer` geospatial function.\", \"Allow treating decimal literals as values of the `DECIMAL` type rather than `DOUBLE`.\\nThis behavior can be enabled by setting the `parse-decimal-literals-as-double`\\nconfig property or the `parse_decimal_literals_as_double` session property to `false`.\", \"Add JMX counter to track the number of submitted queries.\"], \"Resource groups\": [\"Add priority column to the DB resource group selectors.\", \"Add exact match source selector to the DB resource group selectors.\"], \"CLI\": [\"Add support for setting client tags.\"], \"JDBC driver\": [\"Add `getPeakMemoryBytes()` to `QueryStats`.\"], \"Accumulo\": [\"Improve table scan parallelism.\"], \"Hive\": [\"Fix query failures for the file-based metastore implementation when partition\\ncolumn values contain a colon.\", \"Improve performance for writing to bucketed tables when the data being written\\nis already partitioned appropriately (e.g., the output is from a bucketed join).\", \"Add config property `hive.max-outstanding-splits-size` for the maximum\\namount of memory used to buffer splits for a single table scan. Additionally,\\nthe default value is substantially higher than the previous hard-coded limit,\\nwhich can prevent certain queries from failing.\"], \"Thrift connector\": [\"Make Thrift retry configurable.\", \"Add JMX counters for Thrift requests.\"], \"SPI\": [\"Remove the `RecordSink` interface, which was difficult to use\\ncorrectly and had no advantages over the `PageSink` interface.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 101]\"}, {\"title\": \"Release 0.191\", \"description\": null, \"content\": {\"General\": [\"Fix regression that could cause high CPU usage for join queries when dictionary\\nprocessing for joins is enabled.\", \"Fix {func}`bit_count` for bits between 33 and 63.\", \"The `query.low-memory-killer.enabled` config property has been replaced\\nwith `query.low-memory-killer.policy`. Use `total-reservation` to continue\\nusing the previous policy of killing the largest query. There is also a new\\npolicy, `total-reservation-on-blocked-nodes`, which kills the query that\\nis using the most memory on nodes that are out of memory (blocked).\", \"Add support for grouped join execution. When both sides of a join have the\\nsame table partitioning and the partitioning is addressable, partial data\\ncan be loaded into memory at a time, making it possible to execute the join\\nwith less peak memory usage. The colocated join feature must be enabled with\\nthe `colocated-joins-enabled` config property or the `colocated_join`\\nsession property, and the `concurrent_lifespans_per_task` session property\\nmust be specified.\", \"Allow connectors to report the amount of physical written data.\", \"Add ability to dynamically scale out the number of writer tasks rather\\nthan allocating a fixed number of tasks. Additional tasks are added when the\\nthe average amount of physical data per writer is above a minimum threshold.\\nWriter scaling can be enabled with the `scale-writers` config property or\\nthe `scale_writers` session property. The minimum size can be set with the\\n`writer-min-size` config property or the `writer_min_size` session property.\\nThe tradeoff for writer scaling is that write queries can take longer to run\\ndue to the decreased writer parallelism while the writer count ramps up.\"], \"Resource groups\": [\"Add query type to the exact match source selector in the DB resource group selectors.\"], \"CLI\": [\"Improve display of values of the Geometry type.\"], \"Hive\": [\"Add support for grouped join execution for Hive tables when both\\nsides of a join have the same bucketing property.\", \"Report physical written data for the legacy RCFile writer, optimized RCFile\\nwriter, and optimized ORC writer. These writers thus support writer scaling,\\nwhich can both reduce the number of written files and create larger files.\\nThis is especially important for tables that have many small partitions, as\\nsmall files can take a disproportionately longer time to read.\"], \"Thrift connector\": [\"Add page size distribution metrics.\"], \"MySQL, PostgreSQL, Redshift, and SQL Server\": [\"Fix querying `information_schema.columns` if there are tables with\\nno columns or no supported columns.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 102]\"}, {\"title\": \"Release 0.192\", \"description\": null, \"content\": {\"General\": [\"Fix performance regression in split scheduling introduced in 0.191. If a query\\nscans a non-trivial number of splits (~1M splits in an hour), the coordinator\\nCPU utilization can be very high, leading to elevated communication failures.\", \"Fix correctness issue in the {func}`geometry_to_bing_tiles` function that causes\\nit to return irrelevant tiles when bottom or right side of the bounding box of the\\ngeometry is aligned with the tile border.\", \"Fix handling of invalid WKT (well-known text) input in geospatial functions.\", \"Fix an issue that can cause long-running queries to hang when writer scaling is enabled.\", \"Fix cast from `REAL` or `DOUBLE` to `DECIMAL` to conform to the SQL standard.\\nFor example, previously `cast (double '100000000000000000000000000000000' as decimal(38))`\\nwould return `100000000000000005366162204393472`. Now it returns `100000000000000000000000000000000`.\", \"Fix bug in validation of resource groups that prevented use of the `WEIGHTED_FAIR` policy.\", \"Fail queries properly when the coordinator fails to fetch data from workers.\\nPreviously, it would return an HTTP 500 error to the client.\", \"Improve memory tracking for queries involving `DISTINCT` or {func}`row_number` that could cause\\nover-committing memory resources for short time periods.\", \"Improve performance for queries involving `grouping()`.\", \"Improve buffer utilization calculation for writer scaling.\", \"Remove tracking of per-driver peak memory reservation.\", \"Add `resource-groups.max-refresh-interval` config option to limit the maximum acceptable\\nstaleness of resource group configuration.\", \"Remove `dictionary-processing-joins-enabled` configuration option and `dictionary_processing_join`\\nsession property.\"], \"Web UI\": [\"Fix incorrect reporting of input size and positions in live plan view.\"], \"CLI\": [\"Fix update of prompt after `USE` statement.\", \"Fix correctness issue when rendering arrays of Bing tiles that causes\\nthe first entry to be repeated multiple times.\"], \"Hive\": [\"Fix reading partitioned table statistics from newer Hive metastores.\", \"Do not treat file system errors as corruptions for ORC.\", \"Prevent reads from tables or partitions with `object_not_readable` attribute set.\", \"Add support for validating ORC files after they have been written. This behavior can\\nbe turned on via the `hive.orc.writer.validate` configuration property.\", \"Expose ORC writer statistics via JMX.\", \"Add configuration options to control ORC writer min/max rows per stripe and row group,\\nmaximum stripe size, and memory limit for dictionaries.\", \"Allow reading empty ORC files.\", \"Handle ViewFs when checking file system cache expiration.\", \"Improve error reporting when the target table of an insert query is dropped.\", \"Remove retry when creating Hive record reader. This can help queries fail faster.\"], \"MySQL\": [\"Remove support for `TIME WITH TIME ZONE` and `TIMESTAMP WITH TIME ZONE`\\ntypes due to MySQL types not being able to store timezone information.\", \"Add support for `REAL` type, which maps to MySQL's `FLOAT` type.\"], \"PostgreSQL\": [\"Add support for `VARBINARY` type, which maps to PostgreSQL's `BYTEA` type.\"], \"MongoDB\": [\"Fix support for pushing down inequality operators for string types.\", \"Add support for reading documents as `MAP` values.\", \"Add support for MongoDB's `Decimal128` type.\", \"Treat document and array of documents as `JSON` instead of `VARCHAR`.\"], \"JMX\": [\"Allow nulls in history table values.\"], \"SPI\": [\"Remove `SliceArrayBlock` class.\", \"Add `offset` and `length` parameters to `Block.getPositions()`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 103]\"}, {\"title\": \"Release 0.193\", \"description\": null, \"content\": {\"General\": [\"Fix an infinite loop during planning for queries containing non-trivial predicates.\", \"Fix `row_number()` optimization that causes query failure or incorrect results\\nfor queries that constrain the result of `row_number()` to be less than one.\", \"Fix failure during query planning when lambda expressions are used in `UNNEST` or `VALUES` clauses.\", \"Fix `Tried to free more revocable memory than is reserved` error for queries that have spilling enabled\\nand run in the reserved memory pool.\", \"Improve the performance of the {func}`ST_Contains` function.\", \"Add {func}`map_zip_with` lambda function.\", \"Add {func}`normal_cdf` function.\", \"Add `SET_DIGEST` type and related functions.\", \"Add query stat that tracks peak total memory.\", \"Improve performance of queries that filter all data from a table up-front (e.g., due to partition pruning).\", \"Turn on new local scheduling algorithm by default (see {doc}`release-0.181`).\", \"Remove the `information_schema.__internal_partitions__` table.\"], \"Security\": [\"Apply the authentication methods in the order they are listed in the\\n`http-server.authentication.type` configuration.\"], \"CLI\": [\"Fix rendering of maps of Bing tiles.\", \"Abort the query when the result pager exits.\"], \"JDBC driver\": [\"Use SSL by default for port 443.\"], \"Hive\": [\"Allow dropping any column in a table. Previously, dropping columns other\\nthan the last one would fail with `ConcurrentModificationException`.\", \"Correctly write files for text format tables that use non-default delimiters.\\nPreviously, they were written with the default delimiter.\", \"Fix reading data from S3 if the data is in a region other than `us-east-1`.\\nPreviously, such queries would fail with\\n`\\\"The authorization header is malformed; the region 'us-east-1' is wrong; expecting '<region_name>'\\\"`,\\nwhere `<region_name>` is the S3 region hosting the bucket that is queried.\", \"Enable `SHOW PARTITIONS FROM <table> WHERE <condition>` to work for tables\\nthat have more than `hive.max-partitions-per-scan` partitions as long as\\nthe specified `<condition>` reduces the number of partitions to below this limit.\"], \"Blackhole\": [\"Do not allow creating tables in a nonexistent schema.\", \"Add support for `CREATE SCHEMA`.\"], \"Memory connector\": [\"Allow renaming tables across schemas. Previously, the target schema was ignored.\", \"Do not allow creating tables in a nonexistent schema.\"], \"MongoDB\": [\"Add `INSERT` support. It was previously removed in 0.155.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 104]\"}, {\"title\": \"Release 0.194\", \"description\": null, \"content\": {\"General\": [\"Fix planning performance regression that can affect queries over Hive tables\\nwith many partitions.\", \"Fix deadlock in memory management logic introduced in the previous release.\", \"Add {func}`word_stem` function.\", \"Restrict `n` (number of result elements) to 10,000 or less for\\n`min(col, n)`, `max(col, n)`, `min_by(col1, col2, n)`, and `max_by(col1, col2, n)`.\", \"Improve error message when a session property references an invalid catalog.\", \"Reduce memory usage of {func}`histogram` aggregation function.\", \"Improve coordinator CPU efficiency when discovering splits.\", \"Include minimum and maximum values for columns in `SHOW STATS`.\"], \"Web UI\": [\"Fix previously empty peak memory display in the query details page.\"], \"CLI\": [\"Fix regression in CLI that makes it always print \\\"query aborted by user\\\" when\\nthe result is displayed with a pager, even if the query completes successfully.\", \"Return a non-zero exit status when an error occurs.\", \"Add `--client-info` option for specifying client info.\", \"Add `--ignore-errors` option to continue processing in batch mode when an error occurs.\"], \"JDBC driver\": [\"Allow configuring connection network timeout with `setNetworkTimeout()`.\", \"Allow setting client tags via the `ClientTags` client info property.\", \"Expose update type via `getUpdateType()` on `PrestoStatement`.\"], \"Hive\": [\"Consistently fail queries that attempt to read partitions that are offline.\\nPreviously, the query can have one of the following outcomes: fail as expected,\\nskip those partitions and finish successfully, or hang indefinitely.\", \"Allow setting username used to access Hive metastore via the `hive.metastore.username` config property.\", \"Add `hive_storage_format` and `respect_table_format` session properties, corresponding to\\nthe `hive.storage-format` and `hive.respect-table-format` config properties.\", \"Reduce ORC file reader memory consumption by allocating buffers lazily.\\nBuffers are only allocated for columns that are actually accessed.\"], \"Cassandra\": [\"Fix failure when querying `information_schema.columns` when there is no equality predicate on `table_name`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 105]\"}, {\"title\": \"Release 0.195\", \"description\": null, \"content\": {\"General\": [\"Fix {func}`histogram` for map type when type coercion is required.\", \"Fix `nullif` for map type when type coercion is required.\", \"Fix incorrect termination of queries when the coordinator to worker communication is under high load.\", \"Fix race condition that causes queries with a right or full outer join to fail.\", \"Change reference counting for varchar, varbinary, and complex types to be approximate. This\\napproximation reduces GC activity when computing large aggregations with these types.\", \"Change communication system to be more resilient to issues such as long GC pauses or networking errors.\\nThe min/max sliding scale of for timeouts has been removed and instead only max time is used.\\nThe `exchange.min-error-duration` and `query.remote-task.min-error-duration` are now ignored and will be\\nremoved in a future release.\", \"Increase coordinator timeout for cleanup of worker tasks for failed queries. This improves the health of\\nthe system when workers are offline for long periods due to GC or network errors.\", \"Remove the `compiler.interpreter-enabled` config property.\"], \"Security\": [\"Presto now supports generic password authentication using a pluggable {doc}`/develop/password-authenticator`.\\nEnable password authentication by setting `http-server.authentication.type` to include `PASSWORD` as an\\nauthentication type.\", \"{doc}`/security/ldap` is now implemented as a password authentication\\nplugin. You will need to update your configuration if you are using it.\"], \"CLI and JDBC\": [\"Provide a better error message when TLS client certificates are expired or not yet valid.\"], \"MySQL\": [\"Fix an error that can occur while listing tables if one of the listed tables is dropped.\"], \"Hive\": [\"Add support for LZ4 compressed ORC files.\", \"Add support for reading Zstandard compressed ORC files.\", \"Validate ORC compression block size when reading ORC files.\", \"Set timeout of Thrift metastore client. This was accidentally removed in 0.191.\"], \"MySQL, Redis, Kafka, and MongoDB\": [\"Fix failure when querying `information_schema.columns` when there is no equality predicate on `table_name`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 106]\"}, {\"title\": \"Release 0.196\", \"description\": null, \"content\": {\"General\": [\"Fix behavior of `JOIN ... USING` to conform to standard SQL semantics.\\nThe old behavior can be restored by setting the `deprecated.legacy-join-using`\\nconfiguration option or the `legacy_join_using` session property.\", \"Fix memory leak for queries with `ORDER BY`.\", \"Fix tracking of query peak memory usage.\", \"Fix skew in dynamic writer scaling by eagerly freeing memory in the source output\\nbuffers. This can be disabled by setting `exchange.acknowledge-pages=false`.\", \"Fix planning failure for lambda with capture in rare cases.\", \"Fix decimal precision of `round(x, d)` when `x` is a `DECIMAL`.\", \"Fix returned value from `round(x, d)` when `x` is a `DECIMAL` with\\nscale `0` and `d` is a negative integer. Previously, no rounding was done\\nin this case.\", \"Improve performance of the {func}`array_join` function.\", \"Improve performance of the {func}`ST_Envelope` function.\", \"Optimize {func}`min_by` and {func}`max_by` by avoiding unnecessary object\\ncreation in order to reduce GC overhead.\", \"Show join partitioning explicitly in `EXPLAIN`.\", \"Add {func}`is_json_scalar` function.\", \"Add {func}`regexp_replace` function variant that executes a lambda for\\neach replacement.\"], \"Security\": [\"Add rules to the `file` {doc}`/security/built-in-system-access-control`\\nto enforce a specific matching between authentication credentials and a\\nexecuting username.\"], \"Hive\": [\"Fix a correctness issue where non-null values can be treated as null values\\nwhen writing dictionary-encoded strings to ORC files with the new ORC writer.\", \"Fix invalid failure due to string statistics mismatch while validating ORC files\\nafter they have been written with the new ORC writer. This happens when\\nthe written strings contain invalid UTF-8 code points.\", \"Add support for reading array, map, or row type columns from partitions\\nwhere the partition schema is different from the table schema. This can\\noccur when the table schema was updated after the partition was created.\\nThe changed column types must be compatible. For rows types, trailing fields\\nmay be added or dropped, but the corresponding fields (by ordinal)\\nmust have the same name.\", \"Add `hive.non-managed-table-creates-enabled` configuration option\\nthat controls whether or not users may create non-managed (external) tables.\\nThe default value is `true`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 107]\"}, {\"title\": \"Release 0.197\", \"description\": null, \"content\": {\"General\": [\"Fix query scheduling hang when the `concurrent_lifespans_per_task` session property is set.\", \"Fix failure when a query contains a `TIMESTAMP` literal corresponding to a local time that\\ndoes not occur in the default time zone of the Presto JVM. For example, if Presto was running\\nin a CET zone (e.g., `Europe/Brussels`) and the client session was in UTC, an expression\\nsuch as `TIMESTAMP '2017-03-26 02:10:00'` would cause a failure.\", \"Extend predicate inference and pushdown for queries using a `<symbol> IN <subquery>` predicate.\", \"Support predicate pushdown for the `<column> IN <values list>` predicate\\nwhere values in the `values list` require casting to match the type of `column`.\", \"Optimize {func}`min` and {func}`max` to avoid unnecessary object creation in order to reduce GC overhead.\", \"Optimize the performance of {func}`ST_XMin`, {func}`ST_XMax`, {func}`ST_YMin`, and {func}`ST_YMax`.\", \"Add `DATE` variant for {func}`sequence` function.\", \"Add {func}`ST_IsSimple` geospatial function.\", \"Add support for broadcast spatial joins.\"], \"Resource groups\": [\"Change configuration check for weights in resource group policy to validate that\\neither all of the sub-groups or none of the sub-groups have a scheduling weight configured.\", \"Add support for named variables in source and user regular expressions that can be\\nused to parameterize resource group names.\", \"Add support for optional fields in DB resource group exact match selectors.\"], \"Hive\": [\"Fix reading of Hive partition statistics with unset fields. Previously, unset fields\\nwere incorrectly interpreted as having a value of zero.\", \"Fix integer overflow when writing a single file greater than 2GB with optimized ORC writer.\", \"Fix system memory accounting to include stripe statistics size and\\nwriter validation size for the optimized ORC writer.\", \"Dynamically allocate the compression buffer for the optimized ORC writer\\nto avoid unnecessary memory allocation. Add config property\\n`hive.orc.writer.max-compression-buffer-size` to limit the maximum size of the buffer.\", \"Add session property `orc_optimized_writer_max_stripe_size` to tune the\\nmaximum stipe size for the optimized ORC writer.\", \"Add session property `orc_string_statistics_limit` to drop the string\\nstatistics when writing ORC files if they exceed the limit.\", \"Use the view owner returned from the metastore at the time of the query rather than\\nalways using the user who created the view. This allows changing the owner of a view.\"], \"CLI\": [\"Fix hang when CLI fails to communicate with Presto server.\"], \"SPI\": [\"Include connector session properties for the connector metadata calls made\\nwhen running `SHOW` statements or querying `information_schema`.\", \"Add count and time of full GC that occurred while query was running to `QueryCompletedEvent`.\", \"Change the `ResourceGroupManager` interface to include a `match()` method and\\nremove the `getSelectors()` method and the `ResourceGroupSelector` interface.\", \"Rename the existing `SelectionContext` class to be `SelectionCriteria` and\\ncreate a new `SelectionContext` class that is returned from the `match()` method\\nand contains the resource group ID and a manager-defined context field.\", \"Use the view owner from `ConnectorViewDefinition` when present.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 108]\"}, {\"title\": \"Release 0.198\", \"description\": null, \"content\": {\"General\": [\"Perform semantic analysis before enqueuing queries.\", \"Add support for selective aggregates (`FILTER`) with `DISTINCT` argument qualifiers.\", \"Support `ESCAPE` for `LIKE` predicate in `SHOW SCHEMAS` and `SHOW TABLES` queries.\", \"Parse decimal literals (e.g. `42.0`) as `DECIMAL` by default. Previously, they were parsed as\\n`DOUBLE`. This behavior can be turned off via the `parse-decimal-literals-as-double` config option or\\nthe `parse_decimal_literals_as_double` session property.\", \"Fix `current_date` failure when the session time zone has a \\\"gap\\\" at `1970-01-01 00:00:00`.\\nThe time zone `America/Bahia_Banderas` is one such example.\", \"Add variant of {func}`sequence` function for `DATE` with an implicit one-day step increment.\", \"Increase the maximum number of arguments for the {func}`zip` function from 4 to 5.\", \"Add {func}`ST_IsValid`, {func}`geometry_invalid_reason`, {func}`simplify_geometry`, and\\n{func}`great_circle_distance` functions.\", \"Support {func}`min` and {func}`max` aggregation functions when the input type is unknown at query analysis time.\\nIn particular, this allows using the functions with `NULL` literals.\", \"Add configuration property `task.max-local-exchange-buffer-size` for setting local exchange buffer size.\", \"Add trace token support to the scheduler and exchange HTTP clients. Each HTTP request sent\\nby the scheduler and exchange HTTP clients will have a \\\"trace token\\\" (a unique ID) in their\\nheaders, which will be logged in the HTTP request logs. This information can be used to\\ncorrelate the requests and responses during debugging.\", \"Improve query performance when dynamic writer scaling is enabled.\", \"Improve performance of {func}`ST_Intersects`.\", \"Improve query latency when tables are known to be empty during query planning.\", \"Optimize {func}`array_agg` to avoid excessive object overhead and native memory usage with G1 GC.\", \"Improve performance for high-cardinality aggregations with `DISTINCT` argument qualifiers. This\\nis an experimental optimization that can be activated by disabling the `use_mark_distinct` session\\nproperty or the `optimizer.use-mark-distinct` config option.\", \"Improve parallelism of queries that have an empty grouping set.\", \"Improve performance of join queries involving the {func}`ST_Distance` function.\"], \"Resource groups\": [\"Query Queues have been removed. Resource Groups are always enabled. The\\nconfig property `experimental.resource-groups-enabled` has been removed.\", \"Change `WEIGHTED_FAIR` scheduling policy to select oldest eligible sub group\\nof groups where utilization and share are identical.\"], \"CLI\": [\"The `--enable-authentication` option has been removed. Kerberos authentication\\nis automatically enabled when `--krb5-remote-service-name` is specified.\", \"Kerberos authentication now requires HTTPS.\"], \"Hive\": [\"Add support for using [AWS Glue](https://aws.amazon.com/glue/) as the metastore.\\nEnable it by setting the `hive.metastore` config property to `glue`.\", \"Fix a bug in the ORC writer that will write incorrect data of type `VARCHAR` or `VARBINARY`\\ninto files.\"], \"JMX\": [\"Add wildcard character `*` which allows querying several MBeans with a single query.\"], \"SPI\": [\"Add performance statistics to query plan in `QueryCompletedEvent`.\", \"Remove `Page.getBlocks()`. This call was rarely used and performed an expensive copy.\\nInstead, use `Page.getBlock(channel)` or the new helper `Page.appendColumn()`.\", \"Improve validation of `ArrayBlock`, `MapBlock`, and `RowBlock` during construction.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 109]\"}, {\"title\": \"Release 0.199\", \"description\": null, \"content\": {\"General\": [\"Allow users to create views for their own use when they do not have permission\\nto grant others access to the underlying tables or views. To enable this,\\ncreation permission is now only checked at query time, not at creation time,\\nand the query time check is skipped if the user is the owner of the view.\", \"Add support for spatial left join.\", \"Add {func}`hmac_md5`, {func}`hmac_sha1`, {func}`hmac_sha256`, and {func}`hmac_sha512` functions.\", \"Add {func}`array_sort` function that takes a lambda as a comparator.\", \"Add {func}`line_locate_point` geospatial function.\", \"Add support for `ORDER BY` clause in aggregations for queries that use grouping sets.\", \"Add support for yielding when unspilling an aggregation.\", \"Expand grouped execution support to `GROUP BY` and `UNION ALL`, making it possible\\nto execute aggregations with less peak memory usage.\", \"Change the signature of `round(x, d)` and `truncate(x, d)` functions so that\\n`d` is of type `INTEGER`. Previously, `d` could be of type `BIGINT`.\\nThis behavior can be restored with the `deprecated.legacy-round-n-bigint` config option\\nor the `legacy_round_n_bigint` session property.\", \"Accessing anonymous row fields via `.field0`, `.field1`, etc., is no longer allowed.\\nThis behavior can be restored with the `deprecated.legacy-row-field-ordinal-access`\\nconfig option or the `legacy_row_field_ordinal_access` session property.\", \"Optimize the {func}`ST_Intersection` function for rectangles aligned with coordinate axes\\n(e.g., polygons produced by the {func}`ST_Envelope` and {func}`bing_tile_polygon` functions).\", \"Finish joins early when possible if one side has no rows. This happens for\\neither side of an inner join, for the left side of a left join, and for the\\nright side of a right join.\", \"Improve predicate evaluation performance during predicate pushdown in planning.\", \"Improve the performance of queries that use `LIKE` predicates on the columns of `information_schema` tables.\", \"Improve the performance of map-to-map cast.\", \"Improve the performance of {func}`ST_Touches`, {func}`ST_Within`, {func}`ST_Overlaps`, {func}`ST_Disjoint`,\\nand {func}`ST_Crosses` functions.\", \"Improve the serialization performance of geometry values.\", \"Improve the performance of functions that return maps.\", \"Improve the performance of joins and aggregations that include map columns.\"], \"Server RPM\": [\"Add support for installing on machines with OpenJDK.\"], \"Security\": [\"Add support for authentication with JWT access token.\"], \"JDBC driver\": [\"Make driver compatible with Java 9+. It previously failed with `IncompatibleClassChangeError`.\"], \"Hive\": [\"Fix ORC writer failure when writing `NULL` values into columns of type `ROW`, `MAP`, or `ARRAY`.\", \"Fix ORC writers incorrectly writing non-null values as `NULL` for all types.\", \"Support reading Hive partitions that have a different bucket count than the table,\\nas long as the ratio is a power of two (`1:2^n` or `2^n:1`).\", \"Add support for the `skip.header.line.count` table property.\", \"Prevent reading from tables with the `skip.footer.line.count` table property.\", \"Partitioned tables now have a hidden system table that contains the partition values.\\nA table named `example` will have a partitions table named `example$partitions`.\\nThis provides the same functionality and data as `SHOW PARTITIONS`.\", \"Partition name listings, both via the `$partitions` table and using\\n`SHOW PARTITIONS`, are no longer subject to the limit defined by the\\n`hive.max-partitions-per-scan` config option.\", \"Allow marking partitions as offline via the `presto_offline` partition property.\"], \"Thrift connector\": [\"Most of the config property names are different due to replacing the\\nunderlying Thrift client implementation. Please see {doc}`/connector/thrift`\\nfor details on the new properties.\"], \"SPI\": [\"Allow connectors to provide system tables dynamically.\", \"Add `resourceGroupId` and `queryType` fields to `SessionConfigurationContext`.\", \"Simplify the constructor of `RowBlock`.\", \"`Block.writePositionTo()` now closes the current entry.\", \"Replace the `writeObject()` method in `BlockBuilder` with `appendStructure()`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 110]\"}, {\"title\": \"Release 0.200\", \"description\": null, \"content\": {\"General\": [\"Disable early termination of inner or right joins when the right side\\nhas zero rows. This optimization can cause indefinite query hangs\\nfor queries that join against a small number of rows.\\nThis regression was introduced in 0.199.\", \"Fix query execution failure for {func}`bing_tile_coordinates`.\", \"Remove the `log()` function. The arguments to the function were in the\\nwrong order according to the SQL standard, resulting in incorrect results\\nwhen queries were translated to or from other SQL implementations. The\\nequivalent to `log(x, b)` is `ln(x) / ln(b)`. The function can be\\nrestored with the `deprecated.legacy-log-function` config option.\", \"Allow including a comment when adding a column to a table with `ALTER TABLE`.\", \"Add {func}`from_ieee754_32` and {func}`from_ieee754_64` functions.\", \"Add {func}`ST_GeometryType` geospatial function.\"], \"Hive\": [\"Fix reading min/max statistics for columns of `REAL` type in partitioned tables.\", \"Fix failure when reading Parquet files with optimized Parquet reader\\nrelated with the predicate push down for structural types.\\nPredicates on structural types are now ignored for Parquet files.\", \"Fix failure when reading ORC files that contain UTF-8 Bloom filter streams.\\nSuch Bloom filters are now ignored.\"], \"MySQL\": [\"Avoid reading extra rows from MySQL at query completion.\\nThis typically affects queries with a `LIMIT` clause.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 111]\"}, {\"title\": \"Release 0.201\", \"description\": null, \"content\": {\"General\": [\"Change grouped aggregations to use `IS NOT DISTINCT FROM` semantics rather than equality\\nsemantics. This fixes incorrect results and degraded performance when grouping on `NaN`\\nfloating point values, and adds support for grouping on structural types that contain nulls.\", \"Fix planning error when column names are reused in `ORDER BY` query.\", \"System memory pool is now unused by default and it will eventually be removed completely.\\nAll memory allocations will now be served from the general/user memory pool. The old behavior\\ncan be restored with the `deprecated.legacy-system-pool-enabled` config option.\", \"Improve performance and memory usage for queries using {func}`row_number` followed by a\\nfilter on the row numbers generated.\", \"Improve performance and memory usage for queries using `ORDER BY` followed by a `LIMIT`.\", \"Improve performance of queries that process structural types and contain joins, aggregations,\\nor table writes.\", \"Add session property `prefer-partial-aggregation` to allow users to disable partial\\naggregations for queries that do not benefit.\", \"Add support for `current_user` (see {doc}`/functions/session`).\"], \"Security\": [\"Change rules in the {doc}`/security/built-in-system-access-control` for enforcing matches\\nbetween authentication credentials and a chosen username to allow more fine-grained\\ncontrol and ability to define superuser-like credentials.\"], \"Hive\": [\"Replace ORC writer stripe minimum row configuration `hive.orc.writer.stripe-min-rows`\\nwith stripe minimum data size `hive.orc.writer.stripe-min-size`.\", \"Change ORC writer validation configuration `hive.orc.writer.validate` to switch to a\\nsampling percentage `hive.orc.writer.validation-percentage`.\", \"Fix optimized ORC writer writing incorrect data of type `map` or `array`.\", \"Fix `SHOW PARTITIONS` and the `$partitions` table for tables that have null partition\\nvalues.\", \"Fix impersonation for the simple HDFS authentication to use login user rather than current\\nuser.\"], \"SPI\": [\"Support resource group selection based on resource estimates.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 112]\"}, {\"title\": \"Release 0.202\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for queries involving aggregations over the result of an outer join ({issue}`x10592`).\", \"Fix {func}`map` to raise an error on duplicate keys rather than silently producing a corrupted map.\", \"Fix {func}`map_from_entries` to raise an error when input array contains a `null` entry.\", \"Fix out-of-memory error for bucketed execution by scheduling new splits on the same worker as\\nthe recently finished one.\", \"Fix query failure when performing a `GROUP BY` on `json` or `ipaddress` types.\", \"Fix correctness issue in {func}`line_locate_point`, {func}`ST_IsValid`, and {func}`geometry_invalid_reason`\\nfunctions to not return values outside of the expected range.\", \"Fix failure in {func}`geometry_to_bing_tiles` and {func}`ST_NumPoints` functions when\\nprocessing geometry collections.\", \"Fix query failure in aggregation spilling ({issue}`x10587`).\", \"Remove support for `SHOW PARTITIONS` statement.\", \"Improve support for correlated subqueries containing equality predicates.\", \"Improve performance of correlated `EXISTS` subqueries.\", \"Limit the number of grouping sets in a `GROUP BY` clause.\\nThe default limit is `2048` and can be set via the `analyzer.max-grouping-sets`\\nconfiguration property or the `max_grouping_sets` session property.\", \"Allow coercion between row types regardless of field names.\\nPreviously, a row type is coercible to another only if the field name in the source type\\nmatches the target type, or when target type has anonymous field name.\", \"Increase default value for `experimental.filter-and-project-min-output-page-size` to `500kB`.\", \"Improve performance of equals operator on `array(bigint)` and `array(double)` types.\", \"Respect `X-Forwarded-Proto` header in client protocol responses.\", \"Add support for column-level access control.\\nConnectors have not yet been updated to take advantage of this support.\", \"Add support for correlated subqueries with correlated `OR` predicates.\", \"Add {func}`multimap_from_entries` function.\", \"Add {func}`bing_tiles_around`, {func}`ST_NumGeometries`, {func}`ST_GeometryN`, and {func}`ST_ConvexHull` geospatial functions.\", \"Add {func}`wilson_interval_lower` and {func}`wilson_interval_upper` functions.\", \"Add `IS DISTINCT FROM` for `json` and `ipaddress` type.\"], \"Hive\": [\"Fix optimized ORC writer encoding of `TIMESTAMP` before `1970-01-01`. Previously, the\\nwritten value was off by one second.\", \"Fix query failure when a Hive bucket has no splits. This commonly happens when a\\npredicate filters some buckets out entirely.\", \"Remove the `hive.bucket-writing` config property.\", \"Add support for creating and writing bucketed sorted tables. The list of\\nsorting columns may be specified using the `sorted_by` table property.\\nWriting to sorted tables can be disabled using the `hive.sorted-writing`\\nconfig property or the `sorted_writing_enabled` session property. The\\nmaximum number of temporary files for can be controlled using the\\n`hive.max-sort-files-per-bucket` property.\", \"Collect and store basic table statistics (`rowCount`, `fileCount`, `rawDataSize`,\\n`totalSize`) when writing.\", \"Add `hive.orc.tiny-stripe-threshold` config property and `orc_tiny_stripe_threshold`\\nsession property to control the stripe/file size threshold when ORC reader decides to\\nread multiple consecutive stripes or entire fires at once. Previously, this feature\\npiggybacks on other properties.\"], \"CLI\": [\"Add peak memory usage to `--debug` output.\"], \"SPI\": [\"Make `PageSorter` and `PageIndexer` supported interfaces.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 113]\"}, {\"title\": \"Release 0.203\", \"description\": null, \"content\": {\"General\": [\"Fix spurious duplicate key errors from {func}`map`.\", \"Fix planning failure when a correlated subquery containing a `LIMIT`\\nclause is used within `EXISTS` ({issue}`x10696`).\", \"Fix out of memory error caused by missing pushback checks in data exchanges.\", \"Fix execution failure for queries containing a cross join when using bucketed execution.\", \"Fix execution failure for queries containing an aggregation function\\nwith `DISTINCT` and a highly selective aggregation filter.\\nFor example: `sum(DISTINCT x) FILTER (WHERE y = 0)`\", \"Fix quoting in error message for `SHOW PARTITIONS`.\", \"Eliminate redundant calls to check column access permissions.\", \"Improve query creation reliability by delaying query start until the client\\nacknowledges the query ID by fetching the first response link. This eliminates\\ntimeouts during the initial request for queries that take a long time to analyze.\", \"Remove support for legacy `ORDER BY` semantics.\", \"Distinguish between inner and left spatial joins in explain plans.\"], \"Security\": [\"Fix sending authentication challenge when at least two of the\\n`KERBEROS`, `PASSWORD`, or `JWT` authentication types are configured.\", \"Allow using PEM encoded (PKCS #8) keystore and truststore with the HTTP server\\nand the HTTP client used for internal communication. This was already supported\\nfor the CLI and JDBC driver.\"], \"Server RPM\": [\"Declare a dependency on `uuidgen`. The `uuidgen` program is required during\\ninstallation of the Presto server RPM package and lack of it resulted in an invalid\\nconfig file being generated during installation.\"], \"Hive connector\": [\"Fix complex type handling in the optimized Parquet reader. Previously, null values,\\noptional fields, and Parquet backward compatibility rules were not handled correctly.\", \"Fix an issue that could cause the optimized ORC writer to fail with a `LazyBlock` error.\", \"Improve error message for max open writers.\"], \"Thrift connector\": [\"Fix retry of requests when the remote Thrift server indicates that the\\nerror is retryable.\"], \"Local file connector\": [\"Fix parsing of timestamps when the JVM time zone is UTC ({issue}`x9601`).\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 114]\"}, {\"title\": \"Release 0.204\", \"description\": null, \"content\": {\"General\": [\"Use distributed join if one side is naturally partitioned on join keys.\", \"Improve performance of correlated subqueries when filters from outer query\\ncan be propagated to the subquery.\", \"Improve performance for correlated subqueries that contain inequalities.\", \"Add support for all geometry types in {func}`ST_Area`.\", \"Add {func}`ST_EnvelopeAsPts` function.\", \"Add {func}`to_big_endian_32` and {func}`from_big_endian_32` functions.\", \"Add cast between `VARBINARY` type and `IPADDRESS` type.\", \"Make {func}`lpad` and {func}`rpad` functions support `VARBINARY` in addition to `VARCHAR`.\", \"Allow using arrays of mismatched lengths with {func}`zip_with`.\\nThe missing positions are filled with `NULL`.\", \"Track execution statistics of `AddExchanges` and `PredicatePushdown` optimizer rules.\"], \"Event listener\": [\"Add resource estimates to query events.\"], \"Web UI\": [\"Fix kill query button.\", \"Display resource estimates in Web UI query details page.\"], \"Resource group\": [\"Fix unnecessary queuing in deployments where no resource group configuration was specified.\"], \"Hive connector\": [\"Fix over-estimation of memory usage for scan operators when reading ORC files.\", \"Fix memory accounting for sort buffer used for writing sorted bucketed tables.\", \"Disallow creating tables with unsupported partition types.\", \"Support overwriting partitions for insert queries. This behavior is controlled\\nby session property `insert_existing_partitions_behavior`.\", \"Prevent the optimized ORC writer from writing excessively large stripes for\\nhighly compressed, dictionary encoded columns.\", \"Enable optimized Parquet reader and predicate pushdown by default.\"], \"Cassandra connector\": [\"Add support for reading from materialized views.\", \"Optimize partition list retrieval for Cassandra 2.2+.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 115]\"}, {\"title\": \"Release 0.205\", \"description\": null, \"content\": {\"General\": [\"Fix parsing of row types where the field types contain spaces.\\nPreviously, row expressions that included spaces would fail to parse.\\nFor example: `cast(row(timestamp '2018-06-01') AS row(timestamp with time zone))`.\", \"Fix distributed planning failure for complex queries when using bucketed execution.\", \"Fix {func}`ST_ExteriorRing` to only accept polygons.\\nPreviously, it erroneously accepted other geometries.\", \"Add the `task.min-drivers-per-task` and `task.max-drivers-per-task` config options.\\nThe former specifies the guaranteed minimum number of drivers a task will run concurrently\\ngiven that it has enough work to do. The latter specifies the maximum number of drivers\\na task can run concurrently.\", \"Add the `concurrent-lifespans-per-task` config property to control the default value\\nof the `concurrent_lifespans_per_task` session property.\", \"Add the `query_max_total_memory` session property and the `query.max-total-memory`\\nconfig property. Queries will be aborted after their total (user + system) memory\\nreservation exceeds this threshold.\", \"Improve stats calculation for outer joins and correlated subqueries.\", \"Reduce memory usage when a `Block` contains all null or all non-null values.\", \"Change the internal hash function used in `approx_distinct`. The result of `approx_distinct`\\nmay change in this version compared to the previous version for the same set of values. However,\\nthe standard error of the results should still be within the configured bounds.\", \"Improve efficiency and reduce memory usage for scalar correlated subqueries with aggregations.\", \"Remove the legacy local scheduler and associated configuration properties,\\n`task.legacy-scheduling-behavior` and `task.level-absolute-priority`.\", \"Do not allow using the `FILTER` clause for the `COALESCE`, `IF`, or `NULLIF` functions.\\nThe syntax was previously allowed but was otherwise ignored.\"], \"Security\": [\"Remove unnecessary check for `SELECT` privileges for `DELETE` queries.\\nPreviously, `DELETE` queries could fail if the user only has `DELETE`\\nprivileges but not `SELECT` privileges.\\nThis only affected connectors that implement `checkCanSelectFromColumns()`.\", \"Add a check that the view owner has permission to create the view when\\nrunning `SELECT` queries against a view. This only affected connectors that\\nimplement `checkCanCreateViewWithSelectFromColumns()`.\", \"Change `DELETE FROM <table> WHERE <condition>` to check that the user has `SELECT`\\nprivileges on the objects referenced by the `WHERE` condition as is required by the SQL standard.\", \"Improve the error message when access is denied when selecting from a view due to the\\nview owner having insufficient permissions to create the view.\"], \"JDBC driver\": [\"Add support for prepared statements.\", \"Add partial query cancellation via `partialCancel()` on `PrestoStatement`.\", \"Use `VARCHAR` rather than `LONGNVARCHAR` for the Presto `varchar` type.\", \"Use `VARBINARY` rather than `LONGVARBINARY` for the Presto `varbinary` type.\"], \"Hive connector\": [\"Improve the performance of `INSERT` queries when all partition column values are constants.\", \"Improve stripe size estimation for the optimized ORC writer.\\nThis reduces the number of cases where tiny ORC stripes will be written.\", \"Respect the `skip.footer.line.count` Hive table property.\"], \"CLI\": [\"Prevent the CLI from crashing when running on certain 256 color terminals.\"], \"SPI\": [\"Add a context parameter to the `create()` method in `SessionPropertyConfigurationManagerFactory`.\", \"Disallow non-static methods to be annotated with `@ScalarFunction`. Non-static SQL function\\nimplementations must now be declared in a class annotated with `@ScalarFunction`.\", \"Disallow having multiple public constructors in `@ScalarFunction` classes. All non-static\\nimplementations of SQL functions will now be associated with a single constructor.\\nThis improves support for providing specialized implementations of SQL functions with generic arguments.\", \"Deprecate `checkCanSelectFromTable/checkCanSelectFromView` and\\n`checkCanCreateViewWithSelectFromTable/checkCanCreateViewWithSelectFromView` in `ConnectorAccessControl`\\nand `SystemAccessControl`. `checkCanSelectFromColumns` and `checkCanCreateViewWithSelectFromColumns`\\nshould be used instead.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 116]\"}, {\"title\": \"Release 0.206\", \"description\": null, \"content\": {\"General\": [\"Fix execution failure for certain queries containing a join followed by an aggregation\\nwhen `dictionary_aggregation` is enabled.\", \"Fix planning failure when a query contains a `GROUP BY`, but the cardinality of the\\ngrouping columns is one. For example: `SELECT c1, sum(c2) FROM t WHERE c1 = 'foo' GROUP BY c1`\", \"Fix high memory pressure on the coordinator during the execution of queries\\nusing bucketed execution.\", \"Add {func}`ST_Union`, {func}`ST_Geometries`, {func}`ST_PointN`, {func}`ST_InteriorRings`,\\nand {func}`ST_InteriorRingN` geospatial functions.\", \"Add {func}`split_to_multimap` function.\", \"Expand the {func}`approx_distinct` function to support the following types:\\n`INTEGER`, `SMALLINT`, `TINYINT`, `DECIMAL`, `REAL`, `DATE`,\\n`TIMESTAMP`, `TIMESTAMP WITH TIME ZONE`, `TIME`, `TIME WITH TIME ZONE`, `IPADDRESS`.\", \"Add a resource group ID column to the `system.runtime.queries` table.\", \"Add support for executing `ORDER BY` without `LIMIT` in a distributed manner.\\nThis can be disabled with the `distributed-sort` configuration property\\nor the `distributed_sort` session property.\", \"Add implicit coercion from `VARCHAR(n)` to `CHAR(n)`, and remove implicit coercion the other way around.\\nAs a result, comparing a `CHAR` with a `VARCHAR` will now follow\\ntrailing space insensitive `CHAR` comparison semantics.\", \"Improve query cost estimation by only including non-null rows when computing average row size.\", \"Improve query cost estimation to better account for overhead when estimating data size.\", \"Add new semantics that conform to the SQL standard for temporal types.\\nIt affects the `TIMESTAMP` (aka `TIMESTAMP WITHOUT TIME ZONE`) type,\\n`TIME` (aka `TIME WITHOUT TIME ZONE`) type, and `TIME WITH TIME ZONE` type.\\nThe legacy behavior remains default.\\nAt this time, it is not recommended to enable the new semantics.\\nFor any connector that supports temporal types, code changes are required before the connector\\ncan work correctly with the new semantics. No connectors have been updated yet.\\nIn addition, the new semantics are not yet stable as more breaking changes are planned,\\nparticularly around the `TIME WITH TIME ZONE` type.\"], \"JDBC driver\": [\"Add `applicationNamePrefix` parameter, which is combined with\\nthe `ApplicationName` property to construct the client source name.\"], \"Hive connector\": [\"Reduce ORC reader memory usage by reducing unnecessarily large internal buffers.\", \"Support reading from tables with `skip.footer.line.count` and `skip.header.line.count`\\nwhen using HDFS authentication with Kerberos.\", \"Add support for case-insensitive column lookup for Parquet readers.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 117]\"}, {\"title\": \"Release 0.207\", \"description\": null, \"content\": {\"General\": [\"Fix a planning issue for queries where correlated references were used in `VALUES`.\", \"Remove support for legacy `JOIN ... USING` behavior.\", \"Change behavior for unnesting an array of `row` type to produce multiple columns.\", \"Deprecate the `reorder_joins` session property and the `reorder-joins`\\nconfiguration property. They are replaced by the `join_reordering_strategy`\\nsession property and the `optimizer.join-reordering-strategy` configuration\\nproperty. `NONE` maintains the order of the joins as written and is equivalent\\nto `reorder_joins=false`. `ELIMINATE_CROSS_JOINS` will eliminate any\\nunnecessary cross joins from the plan and is equivalent to `reorder_joins=true`.\\n`AUTOMATIC` will use the new cost-based optimizer to select the best join order.\\nTo simplify migration, setting the `reorder_joins` session property overrides the\\nnew session and configuration properties.\", \"Deprecate the `distributed_joins` session property and the\\n`distributed-joins-enabled` configuration property. They are replaced by the\\n`join_distribution_type` session property and the `join-distribution-type`\\nconfiguration property. `PARTITIONED` turns on hash partitioned joins and\\nis equivalent to `distributed_joins-enabled=true`. `BROADCAST` changes the\\njoin strategy to broadcast and is equivalent to `distributed_joins-enabled=false`.\\n`AUTOMATIC` will use the new cost-based optimizer to select the best join\\nstrategy. If no statistics are available, `AUTOMATIC` is the same as\\n`REPARTITIONED`. To simplify migration, setting the `distributed_joins`\\nsession property overrides the new session and configuration properties.\", \"Add support for column properties.\", \"Add `optimizer.max-reordered-joins` configuration property to set the maximum number of joins that\\ncan be reordered at once using cost-based join reordering.\", \"Add support for `char` type to {func}`approx_distinct`.\"], \"Security\": [\"Fail on startup when configuration for file based system access control is invalid.\", \"Add support for securing communication between cluster nodes with Kerberos authentication.\"], \"Web UI\": [\"Add peak total (user + system) memory to query details UI.\"], \"Hive connector\": [\"Fix handling of `VARCHAR(length)` type in the optimized Parquet reader. Previously, predicate pushdown\\nfailed with `Mismatched Domain types: varchar(length) vs varchar`.\", \"Fail on startup when configuration for file based access control is invalid.\", \"Add support for HDFS wire encryption.\", \"Allow ORC files to have struct columns with missing fields. This allows the table schema to be changed\\nwithout rewriting the ORC files.\", \"Change collector for columns statistics to only consider a sample of partitions. The sample size can be\\nchanged by setting the `hive.partition-statistics-sample-size` property.\"], \"Memory connector\": [\"Add support for dropping schemas.\"], \"SPI\": [\"Remove deprecated table/view-level access control methods.\", \"Change predicate in constraint for accessing table layout to be optional.\", \"Change schema name in `ConnectorMetadata` to be optional rather than nullable.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 118]\"}, {\"title\": \"Release 0.208\", \"description\": null, \"content\": {\"General\": [\"Fix an issue with memory accounting that would lead to garbage collection pauses\\nand out of memory exceptions.\", \"Fix an issue that produces incorrect results when `push_aggregation_through_join`\\nis enabled ({issue}`x10724`).\", \"Preserve field names when unnesting columns of type `ROW`.\", \"Make the cluster out of memory killer more resilient to memory accounting leaks.\\nPreviously, memory accounting leaks on the workers could effectively disable\\nthe out of memory killer.\", \"Improve planning time for queries over tables with high column count.\", \"Add a limit on the number of stages in a query. The default is `100` and can\\nbe changed with the `query.max-stage-count` configuration property and the\\n`query_max_stage_count` session property.\", \"Add {func}`spooky_hash_v2_32` and {func}`spooky_hash_v2_64` functions.\", \"Add a cluster memory leak detector that logs queries that have possibly accounted for\\nmemory usage incorrectly on workers. This is a tool to for debugging internal errors.\", \"Add support for correlated subqueries requiring coercions.\", \"Add experimental support for running on Linux ppc64le.\"], \"CLI\": [\"Fix creation of the history file when it does not exist.\", \"Add `PRESTO_HISTORY_FILE` environment variable to override location of history file.\"], \"Hive connector\": [\"Remove size limit for writing bucketed sorted tables.\", \"Support writer scaling for Parquet.\", \"Improve stripe size estimation for the optimized ORC writer. This reduces the\\nnumber of cases where tiny ORC stripes will be written.\", \"Provide the actual size of CHAR, VARCHAR, and VARBINARY columns to the cost based optimizer.\", \"Collect column level statistics when writing tables. This is disabled by default,\\nand can be enabled by setting the `hive.collect-column-statistics-on-write` property.\"], \"Thrift connector\": [\"Include error message from remote server in query failure message.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 119]\"}, {\"title\": \"Release 0.209\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect predicate pushdown when grouping sets contain the empty grouping set ({issue}`x11296`).\", \"Fix `X-Forwarded-Proto` header handling for requests to the `/` path ({issue}`x11168`).\", \"Fix a regression that results in execution failure when at least one\\nof the arguments to {func}`min_by` or {func}`max_by` is a constant `NULL`.\", \"Fix failure when some buckets are completely filtered out during bucket-by-bucket execution.\", \"Fix execution failure of queries due to a planning deficiency involving\\ncomplex nested joins where a join that is not eligible for bucket-by-bucket\\nexecution feeds into the build side of a join that is eligible.\", \"Improve numerical stability for {func}`corr`, {func}`covar_samp`,\\n{func}`regr_intercept`, and {func}`regr_slope`.\", \"Do not include column aliases when checking column access permissions.\", \"Eliminate unnecessary data redistribution for scalar correlated subqueries.\", \"Remove table scan original constraint information from `EXPLAIN` output.\", \"Introduce distinct error codes for global and per-node memory limit errors.\", \"Include statistics and cost estimates for `EXPLAIN (TYPE DISTRIBUTED)` and `EXPLAIN ANALYZE`.\", \"Support equality checks for `ARRAY`, `MAP`, and `ROW` values containing nulls.\", \"Improve statistics estimation and fix potential negative nulls fraction\\nestimates for expressions that include `NOT` or `OR`.\", \"Completely remove the `SHOW PARTITIONS` statement.\", \"Add {func}`bing_tiles_around` variant that takes a radius.\", \"Add the {func}`convex_hull_agg` and {func}`geometry_union_agg` geospatial aggregation functions.\", \"Add `(TYPE IO, FORMAT JSON)` option for {doc}`/sql/explain` that shows\\ninput tables with constraints and the output table in JSON format.\", \"Add Kudu connector.\", \"Raise required Java version to 8u151. This avoids correctness issues for\\nmap to map cast when running under some earlier JVM versions, including 8u92.\"], \"Web UI\": [\"Fix the kill query button on the live plan and stage performance pages.\"], \"CLI\": [\"Prevent spurious *\\\"No route to host\\\"* errors on macOS when using IPv6.\"], \"JDBC driver\": [\"Prevent spurious *\\\"No route to host\\\"* errors on macOS when using IPv6.\"], \"Hive connector\": [\"Fix data loss when writing bucketed sorted tables. Partitions would\\nbe missing arbitrary rows if any of the temporary files for a bucket\\nhad the same size. The `numRows` partition property contained the\\ncorrect number of rows and can be used to detect if this occurred.\", \"Fix cleanup of temporary files when writing bucketed sorted tables.\", \"Allow creating schemas when using `file` based security.\", \"Reduce the number of cases where tiny ORC stripes will be written when\\nsome columns are highly dictionary compressed.\", \"Improve memory accounting when reading ORC files. Previously, buffer\\nmemory and object overhead was not tracked for stream readers.\", \"ORC struct columns are now mapped by name rather than ordinal.\\nThis correctly handles missing or extra struct fields in the ORC file.\", \"Add procedure `system.create_empty_partition()` for creating empty partitions.\"], \"Kafka connector\": [\"Support Avro formatted Kafka messages.\", \"Support backward compatible Avro schema evolution.\"], \"SPI\": [\"Allow using `Object` as a parameter type or return type for SQL\\nfunctions when the corresponding SQL type is an unbounded generic.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 120]\"}, {\"title\": \"Release 0.210\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure when aliasing columns of tables containing hidden\\ncolumns ({issue}`x11385`).\", \"Fix correctness issue when `GROUP BY DISTINCT` terms contain references to\\nthe same column using different syntactic forms ({issue}`x11120`).\", \"Fix failures when querying `information_schema` tables using capitalized names.\", \"Improve performance when converting between `ROW` types.\", \"Remove user CPU time tracking as introduces non-trivial overhead.\", \"Select join distribution type automatically for queries involving outer joins.\"], \"Hive connector\": [\"Fix a security bug introduced in 0.209 when using `hive.security=file`,\\nwhich would allow any user to create, drop, or rename schemas.\", \"Prevent ORC writer from writing stripes larger than the max configured size\\nwhen converting a highly dictionary compressed column to direct encoding.\", \"Support creating Avro tables with a custom schema using the `avro_schema_url`\\ntable property.\", \"Support backward compatible Avro schema evolution.\", \"Support cross-realm Kerberos authentication for HDFS and Hive Metastore.\"], \"JDBC driver\": [\"Deallocate prepared statement when `PreparedStatement` is closed. Previously,\\n`Connection` became unusable after many prepared statements were created.\", \"Remove `getUserTimeMillis()` from `QueryStats` and `StageStats`.\"], \"SPI\": [\"`SystemAccessControl.checkCanSetUser()` now takes an `Optional<Principal>`\\nrather than a nullable `Principal`.\", \"Rename `connectorId` to `catalogName` in `ConnectorFactory`,\\n`QueryInputMetadata`, and `QueryOutputMetadata`.\", \"Pass `ConnectorTransactionHandle` to `ConnectorAccessControl.checkCanSetCatalogSessionProperty()`.\", \"Remove `getUserTime()` from `SplitStatistics` (referenced in `SplitCompletedEvent`).\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 121]\"}, {\"title\": \"Release 0.211\", \"description\": null, \"content\": {\"General\": [\"Fix missing final query plan in `QueryCompletedEvent`. Statistics and cost estimates\\nare removed from the plan text because they may not be available during event generation.\", \"Update the default value of the `http-server.https.excluded-cipher` config\\nproperty to exclude cipher suites with a weak hash algorithm or without forward secrecy.\\nSpecifically, this means all ciphers that use the RSA key exchange are excluded by default.\\nConsequently, TLS 1.0 or TLS 1.1 are no longer supported with the default configuration.\\nThe `http-server.https.excluded-cipher` config property can be set to empty string\\nto restore the old behavior.\", \"Add {func}`ST_GeomFromBinary` and {func}`ST_AsBinary` functions that convert\\ngeometries to and from Well-Known Binary format.\", \"Remove the `verbose_stats` session property, and rename the `task.verbose-stats`\\nconfiguration property to `task.per-operator-cpu-timer-enabled`.\", \"Improve query planning performance for queries containing multiple joins\\nand a large number of columns ({issue}`x11196`).\", \"Add built-in {doc}`file based property manager </admin/session-property-managers>`\\nto automate the setting of session properties based on query characteristics.\", \"Allow running on a JVM from any vendor that meets the functional requirements.\"], \"Hive connector\": [\"Fix regression in 0.210 that causes query failure when writing ORC or DWRF files\\nthat occurs for specific patterns of input data. When the writer attempts to give up\\nusing dictionary encoding for a column that is highly compressed, the process of\\ntransitioning to use direct encoding instead can fail.\", \"Fix coordinator OOM when a query scans many partitions of a Hive table ({issue}`x11322`).\", \"Improve readability of columns, partitioning, and transactions in explain plains.\"], \"Thrift connector\": [\"Fix lack of retry for network errors while sending requests.\"], \"Resource group\": [\"Add documentation for new resource group scheduling policies.\", \"Remove running and queue time limits from resource group configuration.\\nLegacy behavior can be replicated by using the\\n{doc}`file based property manager </admin/session-property-managers>`\\nto set session properties.\"], \"SPI\": [\"Clarify semantics of `predicate` in `ConnectorTableLayout`.\", \"Reduce flexibility of `unenforcedConstraint` that a connector can return in `getTableLayouts`.\\nFor each column in the predicate, the connector must enforce the entire domain or none.\", \"Make the null vector in `ArrayBlock`, `MapBlock`, and `RowBlock` optional.\\nWhen it is not present, all entries in the `Block` are non-null.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 122]\"}, {\"title\": \"Release 0.212\", \"description\": null, \"content\": {\"General\": [\"Fix query failures when the {func}`ST_GeomFromBinary` function is run on multiple rows.\", \"Fix memory accounting for the build side of broadcast joins.\", \"Fix occasional query failures when running `EXPLAIN ANALYZE`.\", \"Enhance {func}`ST_ConvexHull` and {func}`convex_hull_agg` functions to support geometry collections.\", \"Improve performance for some queries using `DISTINCT`.\", \"Improve performance for some queries that perform filtered global aggregations.\", \"Remove `round(x, d)` and `truncate(x, d)` functions where `d` is a `BIGINT` ({issue}`x11462`).\", \"Add {func}`ST_LineString` function to form a `LineString` from an array of points.\"], \"Hive connector\": [\"Prevent ORC writer from writing stripes larger than the max configured size for some rare data\\npatterns ({issue}`x11526`).\", \"Restrict the maximum line length for text files. The default limit of 100MB can be changed\\nusing the `hive.text.max-line-length` configuration property.\", \"Add sanity checks that fail queries if statistics read from the metastore are corrupt. Corrupt\\nstatistics can be ignored by setting the `hive.ignore-corrupted-statistics`\\nconfiguration property or the `ignore_corrupted_statistics` session property.\"], \"Thrift connector\": [\"Fix retry for network errors that occur while sending a Thrift request.\", \"Remove failed connections from connection pool.\"], \"Verifier\": [\"Record the query ID of the test query regardless of query outcome.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 123]\"}, {\"title\": \"Release 0.213\", \"description\": null, \"content\": {\"General\": [\"Fix split scheduling backpressure when plan contains colocated join. Previously, splits\\nfor the second and subsequent scan nodes (in scheduling order) were scheduled continuously\\nuntil completion, rather than pausing due to sufficient pending splits.\", \"Fix query execution failure or indefinite hang during grouped execution when all splits\\nfor any lifespan are completely filtered out.\", \"Fix grouped execution to respect the configured concurrent lifespans per task.\\nPreviously, it always used a single lifespan per task.\", \"Fix execution failure when using grouped execution with right or full outer joins\\nwhere the right side is not partitioned on the join key.\", \"Fix a scenario where too many rows are returned to clients in a single response.\", \"Do not allow setting invalid property values with {doc}`/sql/set-session`.\", \"Disable stats calculator by default as it can cause a planning failure for\\ncertain complex queries. It can be enabled with the `experimental.enable-stats-calculator`\\nconfiguration property or the `enable_stats_calculator` session property.\", \"Avoid making guesses when estimating filters for joins. Previously, if nothing\\nwas known about the filter, a `0.9` coefficient was applied as a filter factor.\\nNow, if nothing is known about a filter, the estimate will be unknown. A `0.9`\\ncoefficient will be applied for all additional conjuncts if at least a single\\nconjunct can be reasonably estimated.\", \"Improve inference of predicates for inner joins.\", \"Improve `EXPLAIN ANALYZE` output by adding CPU time and enhancing accuracy of CPU fraction.\", \"Include stats and cost estimates in textual plans created on query completion.\", \"Enhance `SHOW STATS` to support `IN` and `BETWEEN` predicates in the\\n`WHERE` condition of the `SELECT` clause.\", \"Remove transaction from explain plan for indexes joins.\", \"Add `max_drivers_per_task` session property, allowing users to limit concurrency by\\nspecifying a number lower than the system configured maximum. This can cause the\\nquery to run slower and consume less resources.\", \"Add `join-max-broadcast-table-size` configuration property and\\n`join_max_broadcast_table_size` session property to control the maximum estimated size\\nof a table that can be broadcast when using `AUTOMATIC` join distribution type ({issue}`x11667`).\", \"Add experimental config option `experimental.reserved-pool-enabled` to disable the reserved memory pool.\", \"Add `targetResultSize` query parameter to `/v1/statement` endpoint to control response data size.\"], \"Geospatial\": [\"Fix {func}`ST_Distance` function to return `NULL` if any of the inputs is an\\nempty geometry as required by the SQL/MM specification.\", \"Add {func}`ST_MultiPoint` function to construct multi-point geometry from an array of points.\", \"Add {func}`geometry_union` function to efficiently union arrays of geometries.\", \"Add support for distributed spatial joins ({issue}`x11072`).\"], \"Server RPM\": [\"Allow running on a JVM from any vendor.\"], \"Web UI\": [\"Remove legacy plan UI.\", \"Add support for filtering queries by all error categories.\", \"Add dialog to show errors refreshing data from coordinator.\", \"Change worker thread list to not show thread stacks by default to improve page peformance.\"], \"Hive connector\": [\"Fix LZO and LZOP decompression to work with certain data compressed by Hadoop.\", \"Fix ORC writer validation percentage so that zero does not result in 100% validation.\", \"Fix potential out-of-bounds read for ZSTD on corrupted input.\", \"Stop assuming no distinct values when column null fraction statistic is less than `1.0`.\", \"Treat `-1` as an absent null count for compatibility with statistics written by\\n[Impala](https://issues.apache.org/jira/browse/IMPALA-7497).\", \"Preserve original exception for metastore network errors.\", \"Preserve exceptions from Avro deserializer\", \"Categorize text line length exceeded error.\", \"Remove the old Parquet reader. The `hive.parquet-optimized-reader.enabled`\\nconfiguration property and `parquet_optimized_reader_enabled` session property\\nno longer exist.\", \"Remove the `hive.parquet-predicate-pushdown.enabled` configuration property\\nand `parquet_predicate_pushdown_enabled` session property.\\nPushdown is always enabled now in the Parquet reader.\", \"Enable optimized ORC writer by default. It can be disabled using the\\n`hive.orc.optimized-writer.enabled` configuration property or the\\n`orc_optimized_writer_enabled` session property.\", \"Use ORC file format as the default for new tables or partitions.\", \"Add support for Avro tables where the Avro schema URL is an HDFS location.\", \"Add `hive.parquet.writer.block-size` and `hive.parquet.writer.page-size`\\nconfiguration properties and `parquet_writer_block_size` and\\n`parquet_writer_page_size` session properties for tuning Parquet writer options.\"], \"Memory connector\": [\"Improve table data size accounting.\"], \"Thrift connector\": [\"Include constraint in explain plan for index joins.\", \"Improve readability of columns, tables, layouts, and indexes in explain plans.\"], \"Verifier\": [\"Rewrite queries in parallel when shadowing writes.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 124]\"}, {\"title\": \"Release 0.214\", \"description\": null, \"content\": {\"General\": [\"Fix history leak in coordinator for failed or canceled queries.\", \"Fix memory leak related to query tracking in coordinator that was introduced\\nin {doc}`/release/release-0.213`.\", \"Fix planning failures when lambdas are used in join filter expression.\", \"Fix responses to client for certain types of errors that are encountered\\nduring query creation.\", \"Improve error message when an invalid comparator is provided to the\\n{func}`array_sort` function.\", \"Improve performance of lookup operations on map data types.\", \"Improve planning and query performance for queries with `TINYINT`,\\n`SMALLINT` and `VARBINARY` literals.\", \"Fix issue where queries containing distributed `ORDER BY` and aggregation\\ncould sometimes fail to make progress when data was spilled.\", \"Make top N row number optimization work in some cases when columns are pruned.\", \"Add session property `optimize-top-n-row-number` and configuration property\\n`optimizer.optimize-top-n-row-number` to toggle the top N row number\\noptimization.\", \"Add {func}`ngrams` function to generate N-grams from an array.\", \"Add {ref}`qdigest <qdigest-type>` type and associated {doc}`/functions/qdigest`.\", \"Add functionality to delay query execution until a minimum number of workers\\nnodes are available. The minimum number of workers can be set with the\\n`query-manager.required-workers` configuration property, and the max wait\\ntime with the `query-manager.required-workers-max-wait` configuration property.\", \"Remove experimental pre-allocated memory system, and the related configuration\\nproperty `experimental.preallocate-memory-threshold`.\"], \"Security\": [\"Add functionality to refresh the configuration of file-based access controllers.\\nThe refresh interval can be set using the `security.refresh-period`\\nconfiguration property.\"], \"JDBC driver\": [\"Clear update count after calling `Statement.getMoreResults()`.\"], \"Web UI\": [\"Show query warnings on the query detail page.\", \"Allow selecting non-default sort orders in query list view.\"], \"Hive connector\": [\"Prevent ORC writer from writing stripes larger than the maximum configured size.\", \"Add `hive.s3.upload-acl-type` configuration property to specify the type of\\nACL to use while uploading files to S3.\", \"Add Hive metastore API recording tool for remote debugging purposes.\", \"Add support for retrying on metastore connection errors.\"], \"Verifier\": [\"Handle SQL execution timeouts while rewriting queries.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 125]\"}, {\"title\": \"Release 0.215\", \"description\": null, \"content\": {\"General\": [\"Fix regression in 0.214 that could cause queries to produce incorrect results for queries\\nusing map types.\", \"Fix reporting of the processed input data for source stages in `EXPLAIN ANALYZE`.\", \"Fail queries that use non-leaf resource groups. Previously, they would remain queued forever.\", \"Improve CPU usage for specific queries ({issue}`x11757`).\", \"Extend stats and cost model to support {func}`row_number` window function estimates.\", \"Improve the join type selection and the reordering of join sides for cases where\\nthe join output size cannot be estimated.\", \"Add dynamic scheduling support to grouped execution. When a stage is executed\\nwith grouped execution and the stage has no remote sources, table partitions can be\\nscheduled to tasks in a dynamic way, which can help mitigating skew for queries using\\ngrouped execution. This feature can be enabled with the\\n`dynamic_schedule_for_grouped_execution` session property or the\\n`dynamic-schedule-for-grouped-execution` config property.\", \"Add {func}`beta_cdf` and {func}`inverse_beta_cdf` functions.\", \"Split the reporting of raw input data and processed input data for source operators.\", \"Remove collection and reporting of raw input data statistics for the `Values`,\\n`Local Exchange`, and `Local Merge Sort` operators.\", \"Simplify `EXPLAIN (TYPE IO)` output when there are too many discrete components.\\nThis avoids large output at the cost of reduced granularity.\", \"Add {func}`parse_presto_data_size` function.\", \"Add support for `UNION ALL` to optimizer's cost model.\", \"Add support for estimating the cost of filters by using a default filter factor.\\nThe default value for the filter factor can be configured with the `default_filter_factor_enabled`\\nsession property or the `optimizer.default-filter-factor-enabled`.\"], \"Geospatial\": [\"Add input validation checks to {func}`ST_LineString` to conform with the specification.\", \"Improve spatial join performance.\", \"Enable spatial joins for join conditions expressed with the {func}`ST_Within` function.\"], \"Web UI\": [\"Fix *Capture Snapshot* button for showing current thread stacks.\", \"Fix dropdown for expanding stage skew component on the query details page.\", \"Improve the performance of the thread snapshot component on the worker status page.\", \"Make the reporting of *Cumulative Memory* usage consistent on the query list and query details pages.\", \"Remove legacy thread UI.\"], \"Hive\": [\"Add predicate pushdown support for the `DATE` type to the Parquet reader. This change also fixes\\na bug that may cause queries with predicates on `DATE` columns to fail with type mismatch errors.\"], \"Redis\": [\"Prevent printing the value of the `redis.password` configuration property to log files.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 126]\"}, {\"title\": \"Release 0.54\", \"description\": null, \"content\": {\"Release 0.54\": [\"Restore binding for the node resource on the coordinator, which provides\\nthe state of all nodes as seen by the coordinator's failure detector.\\nAccess `/v1/node` to see all nodes, or `/v1/node/failed` to see failed nodes.\", \"Prevent the {doc}`/client/cli` from hanging when the server goes away.\", \"Add Hive connector `hive-hadoop1` for Apache Hadoop 1.x.\", \"Add support for Snappy and LZ4 compression codecs for the `hive-cdh4` connector.\", \"Add Example HTTP connector `example-http` that reads CSV data via HTTP.\\nThe connector requires a metadata URI that returns a JSON document\\ndescribing the table metadata and the CSV files to read.\", \"Its primary purpose is to serve as an example of how to write a connector,\\nbut it can also be used directly. Create `etc/catalog/example.properties`\\nwith the following contents to mount the `example-http` connector as the\\n`example` catalog:\", \"```\\nconnector.name=example-http\\nmetadata-uri=http://s3.amazonaws.com/presto-example/v1/example-metadata.json\\n```\", \"Show correct error message when a catalog or schema does not exist.\", \"Verify JVM requirements on startup.\", \"Log an error when the JVM code cache is full.\", \"Upgrade the embedded Discovery server to allow using\\nnon-UUID values for the `node.id` property.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 127]\"}, {\"title\": \"Release 0.55\", \"description\": null, \"content\": {\"RC binary 2-4x gain in CPU efficiency\": \"Presto uses custom fast-path decoding logic for specific Hive file\\nformats. In this release we have added a fast path for RCFile when using\\nthe Binary SerDe (`LazyBinaryColumnarSerDe`). In our\\nmicro benchmarks, we see a gain between 2x and 4x in CPU efficiency compared\\nto the generic (slow) path. Since Hive data decoding accounts for a\\nsignificant portion of the CPU time, this should\\nresult in measurable gains for most queries over RC Binary encoded data.\\nNote that this optimization may not result in a reduction in latency\\nif your cluster is network or disk I/O bound.\", \"Hash distributed aggregations\": \"`GROUP BY` aggregations are now distributed across a fixed number of machines.\\nThis is controlled by the property `query.initial-hash-partitions` set in\\n`etc/config.properties` of the coordinator and workers. If the value is\\nlarger than the number of machines available during query scheduling, Presto\\nwill use all available machines. The default value is `8`.\\n\\nThe maximum memory size of an aggregation is now\\n`query.initial-hash-partitions` times `task.max-memory`.\", \"Simple distinct aggregations\": \"We have added support for the `DISTINCT` argument qualifier for aggregation\\nfunctions. This is currently limited to queries without a `GROUP BY` clause and\\nwhere all the aggregation functions have the same input expression. For example:\\n\\n```\\nSELECT count(DISTINCT country)\\nFROM users\\n```\\n\\nSupport for complete `DISTINCT` functionality is in our roadmap.\", \"Range predicate pushdown\": \"We've modified the connector API to support range predicates in addition to simple equality predicates.\\nThis lays the ground work for adding connectors to systems that support range\\nscans (e.g., HBase, Cassandra, JDBC, etc).\\n\\nIn addition to receiving range predicates, the connector can also communicate\\nback the ranges of each partition for use in the query optimizer. This can be a\\nmajor performance gain for `JOIN` queries where one side of the join has\\nonly a few partitions. For example:\\n\\n```\\nSELECT * FROM data_1_year JOIN data_1_week USING (ds)\\n```\\n\\nIf `data_1_year` and `data_1_week` are both partitioned on `ds`, the\\nconnector will report back that one table has partitions for 365 days and the\\nother table has partitions for only 7 days. Then the optimizer will limit\\nthe scan of the `data_1_year` table to only the 7 days that could possible\\nmatch. These constraints are combined with other predicates in the\\nquery to further limit the data scanned.\\n\\n:::{note}\\nThis is a backwards incompatible change with the previous connector SPI,\\nso if you have written a connector, you will need to update your code\\nbefore deploying this release.\\n:::\", \"json_array_get function\": \"The {func}`json_array_get` function makes it simple to fetch a single element from a\\nscalar json array.\", \"Non-reserved keywords\": \"The keywords `DATE`, `TIME`, `TIMESTAMP`, and `INTERVAL` are no longer\\nreserved keywords in the grammar. This means that you can access a column\\nnamed `date` without quoting the identifier.\", \"CLI source option\": \"The Presto CLI now has an option to set the query source. The source\\nvalue is shown in the UI and is recorded in events. When using the CLI in\\nshell scripts it is useful to set the `--source` option to distinguish shell\\nscripts from normal users.\", \"SHOW SCHEMAS FROM\": \"Although the documentation included the syntax `SHOW SCHEMAS [FROM catalog]`,\\nit was not implemented. This release now implements this statement correctly.\", \"Hive bucketed table fixes\": \"For queries over Hive bucketed tables, Presto will attempt to limit scans to\\nthe buckets that could possible contain rows that match the WHERE clause.\\nUnfortunately, the algorithm we were using to select the buckets was not\\ncorrect, and sometimes we would either select the wrong files or fail to\\nselect any files. We have aligned\\nthe algorithm with Hive and now the optimization works as expected.\\n\\nWe have also improved the algorithm for detecting tables that are not properly\\nbucketed. It is common for tables to declare bucketing in the Hive metadata, but\\nnot actually be bucketed in HDFS. When Presto detects this case, it fallback to a full scan of the\\npartition. Not only does this change make bucketing safer, but it makes it easier\\nto migrate a table to use bucketing without rewriting all of the data.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 128]\"}, {\"title\": \"Release 0.56\", \"description\": null, \"content\": {\"Table creation\": \"Tables can be created from the result of a query:\\n\\n```\\nCREATE TABLE orders_by_date AS\\nSELECT orderdate, sum(totalprice) AS price\\nFROM orders\\nGROUP BY orderdate\\n```\\n\\nTables are created in Hive without partitions (unpartitioned) and use\\nRCFile with the Binary SerDe (`LazyBinaryColumnarSerDe`) as this is\\ncurrently the best format for Presto.\\n\\n:::{note}\\nThis is a backwards incompatible change to `ConnectorMetadata` in the SPI,\\nso if you have written a connector, you will need to update your code before\\ndeploying this release. We recommend changing your connector to extend from\\nthe new `ReadOnlyConnectorMetadata` abstract base class unless you want to\\nsupport table creation.\\n:::\", \"Cross joins\": \"Cross joins are supported using the standard ANSI SQL syntax:\\n\\n```\\nSELECT *\\nFROM a\\nCROSS JOIN b\\n```\\n\\nInner joins that result in a cross join due to the join criteria evaluating\\nto true at analysis time are also supported.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 129]\"}, {\"title\": \"Release 0.57\", \"description\": null, \"content\": {\"Distinct aggregations\": \"The `DISTINCT` argument qualifier for aggregation functions is now\\nfully supported. For example:\\n\\n```\\nSELECT country, count(DISTINCT city), count(DISTINCT age)\\nFROM users\\nGROUP BY country\\n```\\n\\n:::{note}\\n{func}`approx_distinct` should be used in preference to this\\nwhenever an approximate answer is allowable as it is substantially\\nfaster and does not have any limits on the number of distinct items it\\ncan process. `COUNT(DISTINCT ...)` must transfer every item over the\\nnetwork and keep each distinct item in memory.\\n:::\", \"Hadoop 2.x\": \"Use the `hive-hadoop2` connector to read Hive data from Hadoop 2.x.\\nSee {doc}`/installation/deployment` for details.\", \"Amazon S3\": \"All Hive connectors support reading data from\\n[Amazon S3](http://aws.amazon.com/s3/).\\nThis requires two additional catalog properties for the Hive connector\\nto specify your AWS Access Key ID and Secret Access Key:\\n\\n```\\nhive.s3.aws-access-key=AKIAIOSFODNN7EXAMPLE\\nhive.s3.aws-secret-key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\\n```\", \"Miscellaneous\": [\"Allow specifying catalog and schema in the {doc}`/client/jdbc` URL.\", \"Implement more functionality in the JDBC driver.\", \"Allow certain custom `InputFormat`s to work by propagating\\nHive serialization properties to the `RecordReader`.\", \"Many execution engine performance improvements.\", \"Fix optimizer performance regression.\", \"Fix weird `MethodHandle` exception.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 130]\"}, {\"title\": \"Release 0.58\", \"description\": null, \"content\": {\"Release 0.58\": [\"Add first version of Cassandra connector. This plugin is still in\\ndevelopment and is not yet bundled with the server. See the `README`\\nin the plugin source directory for details.\", \"Support UDFs for internal plugins. This is not yet part of the SPI\\nand is a stopgap feature intended for advanced users. UDFs must be\\nimplemented using the internal Presto APIs which often change\\nsubstantially between releases.\", \"Fix Hive connector semaphore release bug.\", \"Fix handling of non-splittable files without blocks.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 131]\"}, {\"title\": \"Release 0.59\", \"description\": null, \"content\": {\"Release 0.59\": [\"Fix hang in `HiveSplitSource`. A query over a large table can hang\\nin split discovery due to a bug introduced in 0.57.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 132]\"}, {\"title\": \"Release 0.60\", \"description\": null, \"content\": {\"JDBC improvements\": \"The Presto version of the JDBC `DatabaseMetaData` interface now includes\\nproper implementations of `getTables`, `getSchemas` and `getCatalogs`.\\n\\nThe JDBC driver is now always packaged as a standalone jar without any\\ndependencies. Previously, this artifact was published with the Maven\\nclassifier `standalone`. The new build does not publish this artifact\\nanymore.\", \"USE CATALOG and USE SCHEMA\": \"The {doc}`/client/cli` now supports `USE CATALOG` and\\n`USE SCHEMA`.\", \"TPC-H connector\": \"We have added a new connector that will generate synthetic data following the\\nTPC-H specification. This connector makes it easy to generate large datasets for\\ntesting and bug reports. When generating bug reports, we encourage users to use\\nthis catalog since it eases the process of reproducing the issue. The data is\\ngenerated dynamically for each query, so no disk space is used by this\\nconnector. To add the `tpch` catalog to your system, create the catalog\\nproperty file `etc/catalog/tpch.properties` on both the coordinator and workers\\nwith the following contents:\\n\\n```\\nconnector.name=tpch\\n```\\n\\nAdditionally, update the `datasources` property in the config properties file,\\n`etc/config.properties`, for the workers to include `tpch`.\", \"SPI\": \"The `Connector` interface now has explicit methods for supplying the services\\nexpected by the query engine. Previously, this was handled by a generic\\n`getService` method.\\n\\n:::{note}\\nThis is a backwards incompatible change to `Connector` in the SPI,\\nso if you have written a connector, you will need to update your code before\\ndeploying this release.\\n:::\\n\\nAdditionally, we have added the `NodeManager` interface to the SPI to allow a\\nplugin to detect all nodes in the Presto cluster. This is important for some\\nconnectors that can divide a table evenly between all nodes as long as the\\nconnector knows how many nodes exist. To access the node manager, simply add\\nthe following to the `Plugin` class:\\n\\n```\\n@Inject\\npublic void setNodeManager(NodeManager nodeManager)\\n{\\n this.nodeManager = nodeManager;\\n}\\n```\", \"Optimizations\": {\"DISTINCT LIMIT\": \"For queries with the following form:\\n\\n```\\nSELECT DISTINCT ...\\nFROM T\\nLIMIT N\\n```\\n\\nWe have added an optimization that stops the query as soon as `N` distinct\\nrows are found.\", \"Range predicates\": \"When optimizing a join, Presto analyzes the ranges of the partitions on each\\nside of a join and pushes these ranges to the other side. When tables have a\\nlot of partitions, this can result in a very large filter with one expression\\nfor each partition. The optimizer now summarizes the predicate ranges to reduce\\nthe complexity of the filters.\", \"Compound filters\": \"Complex expressions involving `AND`, `OR`, or `NOT` are now optimized by\\nthe expression optimizer.\", \"Window functions\": \"Window functions with a `PARTITION BY` clause are now distributed based on the\\npartition key.\"}, \"Bug fixes\": [\"Scheduling\", \"In the changes to schedule splits in batches, we introduced two bugs that\\nresulted in an unbalanced workload across nodes which increases query latency.\\nThe first problem was not inspecting the queued split count of the nodes while\\nscheduling the batch, and the second problem was not counting the splits\\nawaiting creation in the task executor.\", \"JSON conversion of complex Hive types\", \"Presto converts complex Hive types (array, map, struct and union) into JSON.\\nPreviously, numeric keys in maps were converted to numbers, not strings,\\nwhich is invalid as JSON only allows strings for object keys. This prevented\\nthe {doc}`/functions/json` from working.\", \"Hive hidden files\", \"Presto will now ignore files in Hive that start with an underscore `_` or\\na dot `.`. This matches the behavior of Hadoop MapReduce / Hive.\", \"Failures incorrectly reported as no data\", \"Certain types of failures would result in the query appearing to succeed and\\nreturn an incomplete result (often zero rows). There was a race condition\\nbetween the error propagation and query teardown. In some cases, the query\\nwould be torn down before the exception made it to the coordinator. This was a\\nregression introduced during the query teardown optimization work. There are\\nnow tests to catch this type of bug.\", \"Exchange client leak\", \"When a query finished early (e.g., limit or failure) and the exchange operator\\nwas blocked waiting for data from other nodes, the exchange was not be closed\\nproperly. This resulted in continuous failing HTTP requests which leaked\\nresources and produced large log files.\", \"Hash partitioning\", \"A query with many `GROUP BY` items could fail due to an overflow in the hash\\nfunction.\", \"Compiled NULL literal\", \"In some cases queries with a select expression like `CAST(NULL AS varchar)`\\nwould fail due to a bug in the output type detection code in expression\\ncompiler.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 133]\"}, {\"title\": \"Release 0.61\", \"description\": null, \"content\": {\"Add support for table value constructors\": \"Presto now supports the SQL table value constructor syntax to create inline tables.\\nThe `VALUES` clause can be used anywhere a `SELECT` statement is allowed.\\nFor example, as a top-level query:\\n\\n```\\nVALUES ('a', 1), ('b', 2);\\n```\\n\\n```\\n _col0 | _col1\\n-------+-------\\n a | 1\\n b | 2\\n(2 rows)\\n```\\n\\nAlternatively, in the `FROM` clause:\\n\\n```\\nSELECT *\\nFROM (\\n VALUES\\n ('a', 'ape'),\\n ('b', 'bear')\\n) AS animal (letter, animal)\\nJOIN (\\n VALUES\\n ('a', 'apple'),\\n ('b', 'banana')\\n) AS fruit (letter, fruit)\\nUSING (letter);\\n```\\n\\n```\\n letter | animal | letter | fruit\\n--------+--------+--------+---------\\n a | ape | a | apple\\n b | bear | b | banana\\n(2 rows)\\n```\", \"Cassandra\": [\"Add support for upper-case schema, table, and columns names.\", \"Add support for `DECIMAL` type.\"], \"Amazon S3 support\": [\"Completely rewritten Hadoop FileSystem implementation for S3 using the Amazon AWS SDK,\\nwith major performance and reliability improvements.\", \"Add support for writing data to S3.\"], \"Miscellaneous\": [\"General improvements to the JDBC driver, specifically with respect to metadata handling.\", \"Fix division by zero errors in variance aggregation functions (`VARIANCE`, `STDDEV`, etc.).\", \"Fix a bug when using `DISTINCT` aggregations in the `HAVING` clause.\", \"Fix an out of memory issue when writing large tables.\", \"Fix a bug when using `ORDER BY rand()` in a `JOIN` query.\", \"Fix handling of timestamps in maps and lists in Hive connector.\", \"Add instrumentation for Hive metastore and HDFS API calls to track failures and latency. These metrics are exposed via JMX.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 134]\"}, {\"title\": \"Release 0.62\", \"description\": null, \"content\": {\"Release 0.62\": [\"Fix an issue with active queries JMX counter reporting incorrect numbers\", \"Hive binary map keys were not being decoded correctly\", \"Performance improvements for `APPROX_DISTINCT`\", \"Fix performance regression when planning queries over a large number of partitions\", \"Minor improvement to coordinator UI when displaying long SQL queries\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 135]\"}, {\"title\": \"Release 0.63\", \"description\": null, \"content\": {\"Release 0.63\": [\"Minor improvements to coordinator UI\", \"Minor planner optimization to avoid redundant computation in some cases\", \"Error handling and classification improvements\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 136]\"}, {\"title\": \"Release 0.64\", \"description\": null, \"content\": {\"Release 0.64\": [\"Fix approximate aggregation error bound calculation\", \"Error handling and classification improvements\", \"Fix `GROUP BY` failure when keys are too large\", \"Add thread visualization UI at `/ui/thread`\", \"Fix regression in `CREATE TABLE` that can cause column data to be swapped.\\nThis bug was introduced in version 0.57.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 137]\"}, {\"title\": \"Release 0.65\", \"description\": null, \"content\": {\"Release 0.65\": [\"Fix `NullPointerException` when tearing down queries\", \"Fix exposed third-party dependencies in JDBC driver JAR\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 138]\"}, {\"title\": \"Release 0.66\", \"description\": null, \"content\": {\"Type system\": \"In this release we have replaced the existing simple fixed type system\\nwith a fully extensible type system and have added several new types.\\nWe have also expanded the function system to support custom\\narithmetic, comparison and cast operators. For example, the new date/time\\ntypes include an operator for adding an `INTERVAL` to a `TIMESTAMP`.\\n\\nExisting functions have been updated to operate on and return the\\nnewly added types. For example, the ANSI color functions now operate\\non a `COLOR` type, and the date/time functions operate on standard\\nSQL date/time types (described below).\\n\\nFinally, plugins can now provide custom types and operators in addition\\nto connectors and functions. This feature is highly experimental, so expect\\nthe interfaces to change over the next few releases. Also, since in SQL\\nthere is only one namespace for types, you should be careful to make names\\nfor custom types unique as we will add other common SQL types to Presto\\nin the near future.\", \"Date/time types\": {\"Time zones\": \"This release has full support for time zone rules, which are needed to\\nperform date/time calculations correctly. Typically, the session time\\nzone is used for temporal calculations. This is the time zone of the\\nclient computer that submits the query, if available. Otherwise, it is\\nthe time zone of the server running the Presto coordinator.\\n\\nQueries that operate with time zones that follow daylight saving can\\nproduce unexpected results. For example, if we run the following query\\nto add 24 hours using in the `America/Los Angeles` time zone:\\n\\n```\\nSELECT date_add('hour', 24, TIMESTAMP '2014-03-08 09:00:00');\\n-- 2014-03-09 10:00:00.000\\n```\\n\\nThe timestamp appears to only advance 23 hours. This is because on\\nMarch 9th clocks in `America/Los Angeles` are turned forward 1 hour,\\nso March 9th only has 23 hours. To advance the day part of the timestamp,\\nuse the `day` unit instead:\\n\\n```\\nSELECT date_add('day', 1, TIMESTAMP '2014-03-08 09:00:00');\\n-- 2014-03-09 09:00:00.000\\n```\\n\\nThis works because the {func}`date_add` function treats the timestamp as\\nlist of fields, adds the value to the specified field and then rolls any\\noverflow into the next higher field.\\n\\nTime zones are also necessary for parsing and printing timestamps.\\nQueries that use this functionality can also produce unexpected results.\\nFor example, on the same machine:\\n\\n```\\nSELECT TIMESTAMP '2014-03-09 02:30:00';\\n```\\n\\nThe above query causes an error because there was no 2:30 AM on March 9th\\nin `America/Los_Angeles` due to a daylight saving time transition.\\n\\nIn addition to normal `TIMESTAMP` values, Presto also supports the\\n`TIMESTAMP WITH TIME ZONE` type, where every value has an explicit time zone.\\nFor example, the following query creates a `TIMESTAMP WITH TIME ZONE`:\\n\\n```\\nSELECT TIMESTAMP '2014-03-14 09:30:00 Europe/Berlin';\\n-- 2014-03-14 09:30:00.000 Europe/Berlin\\n```\\n\\nYou can also change the time zone of an existing timestamp using the\\n`AT TIME ZONE` clause:\\n\\n```\\nSELECT TIMESTAMP '2014-03-14 09:30:00 Europe/Berlin'\\n AT TIME ZONE 'America/Los_Angeles';\\n-- 2014-03-14 01:30:00.000 America/Los_Angeles\\n```\\n\\nBoth timestamps represent the same instant in time;\\nthey differ only in the time zone used to print them.\\n\\nThe time zone of the session can be set on a per-query basis using the\\n`X-Presto-Time-Zone` HTTP header, or via the\\n`PrestoConnection.setTimeZoneId(String)` method in the JDBC driver.\", \"Localization\": \"In addition to time zones, the language of the user is important when\\nparsing and printing date/time types. This release adds localization\\nsupport to the Presto engine and functions that require it:\\n{func}`date_format` and {func}`date_parse`.\\nFor example, if we set the language to Spanish:\\n\\n```\\nSELECT date_format(TIMESTAMP '2001-01-09 09:04', '%M'); -- enero\\n```\\n\\nIf we set the language to Japanese:\\n\\n```\\nSELECT date_format(TIMESTAMP '2001-01-09 09:04', '%M'); -- 1\\u6708\\n```\\n\\nThe language of the session can be set on a per-query basis using the\\n`X-Presto-Language` HTTP header, or via the\\n`PrestoConnection.setLocale(Locale)` method in the JDBC driver.\"}, \"Optimizations\": [\"We have upgraded the Hive connector to Hive 0.12 which includes\\nperformance improvements for RCFile.\", \"`GROUP BY` and `JOIN` operators are now compiled to byte code\\nand are significantly faster.\", \"Reduced memory usage of `GROUP BY` and `SELECT DISTINCT`,\\nwhich previously required several megabytes of memory\\nper operator, even when the number of groups was small.\", \"The planner now optimizes function call arguments. This should improve\\nthe performance of queries that contain complex expressions.\", \"Fixed a performance regression in the HTTP client. The recent HTTP client\\nupgrade was using inadvertently GZIP compression and has a bug in the\\nbuffer management resulting in high CPU usage.\"], \"SPI\": \"In this release we have made a number of backward incompatible changes to the SPI:\\n\\n['Added `Type` and related interfaces', '`ConnectorType` in metadata has been replaced with `Type`', 'Renamed `TableHandle` to `ConnectorTableHandle`', 'Renamed `ColumnHandle` to `ConnectorColumnHandle`', 'Renamed `Partition` to `ConnectorPartition`', 'Renamed `PartitionResult` to `ConnectorPartitionResult`', 'Renamed `Split` to `ConnectorSplit`', 'Renamed `SplitSource` to `ConnectorSplitSource`', 'Added a `ConnectorSession` parameter to most `ConnectorMetadata` methods', 'Removed most `canHandle` methods']\", \"General bug fixes\": [\"Fixed CLI hang after using `USE CATALOG` or `USE SCHEMA`\", \"Implicit coercions in aggregations now work as expected\", \"Nulls in expressions work as expected\", \"Fixed memory leak in compiler\", \"Fixed accounting bug in task memory usage\", \"Fixed resource leak caused by abandoned queries\", \"Fail queries immediately on unrecoverable data transport errors\"], \"Hive bug fixes\": [\"Fixed parsing of timestamps in the Hive RCFile Text SerDe (`ColumnarSerDe`)\\nby adding configuration to set the time zone originally used when writing data\"], \"Cassandra bug fixes\": [\"Auto-reconnect if Cassandra session dies\", \"Format collection types as JSON\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 139]\"}, {\"title\": \"Release 0.67\", \"description\": null, \"content\": {\"SPI\": \"The `ConnectorSplitSource` interface now extends `Closeable`.\\n\\n:::{note}\\nThis is a backwards incompatible change to `ConnectorSplitSource` in the SPI,\\nso if you have written a connector, you will need to update your code before\\ndeploying this release.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 140]\"}, {\"title\": \"Release 0.68\", \"description\": null, \"content\": {\"Release 0.68\": [\"Fix a regression in the handling of Hive tables that are bucketed on a\\nstring column. This caused queries that could take advantage of bucketing\\non such tables to choose the wrong bucket and thus would not match any\\nrows for the table. This regression was introduced in 0.66.\", \"Fix double counting of bytes and rows when reading records\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 141]\"}, {\"title\": \"Release 0.69\", \"description\": null, \"content\": {\"Prevent scheduling work on coordinator\": \"We have a new config property, `node-scheduler.include-coordinator`,\\nthat allows or disallows scheduling work on the coordinator.\\nPreviously, tasks like final aggregations could be scheduled on the\\ncoordinator. For larger clusters, processing work on the coordinator\\ncan impact query performance because the machine's resources are not\\navailable for the critical task of scheduling, managing and monitoring\\nquery execution.\\n\\nWe recommend setting this property to `false` for the coordinator.\\nSee {ref}`config-properties` for an example.\\n\\n(rn-069-datasource-configuration)=\", \"Datasource configuration\": \"The `datasources` config property has been deprecated.\\nPlease remove it from your `etc/config.properties` file.\\nThe datasources configuration is now automatically generated based\\non the `node-scheduler.include-coordinator` property\\n(see [Prevent Scheduling Work on Coordinator]).\", \"Raptor connector\": \"Presto has an extremely experimental connector that was previously called\\nthe `native` connector and was intertwined with the main Presto code\\n(it was written before Presto had connectors). This connector is now\\nnamed `raptor` and lives in a separate plugin.\\n\\nAs part of this refactoring, the `presto-metastore.db.type` and\\n`presto-metastore.db.filename` config properties no longer exist\\nand must be removed from `etc/config.properties`.\\n\\nThe Raptor connector stores data on the Presto machines in a\\ncolumnar format using the same layout that Presto uses for in-memory\\ndata. Currently, it has major limitations: lack of replication,\\ndropping a table does not reclaim the storage, etc. It is only\\nsuitable for experimentation, temporary tables, caching of data from\\nslower connectors, etc. The metadata and data formats are subject to\\nchange in incompatible ways between releases.\\n\\nIf you would like to experiment with the connector, create a catalog\\nproperties file such as `etc/catalog/raptor.properties` on both the\\ncoordinator and workers that contains the following:\\n\\n```\\nconnector.name=raptor\\nmetadata.db.type=h2\\nmetadata.db.filename=var/data/db/MetaStore\\n```\", \"Machine learning functions\": \"Presto now has functions to train and use machine learning models\\n(classifiers and regressors). This is currently only a proof of concept\\nand is not ready for use in production. Example usage is as follows:\\n\\n```\\nSELECT evaluate_classifier_predictions(label, classify(features, model))\\nFROM (\\n SELECT learn_classifier(label, features) AS model\\n FROM training_data\\n)\\nCROSS JOIN validation_data\\n```\\n\\nIn the above example, the column `label` is a `bigint` and the column\\n`features` is a map of feature identifiers to feature values. The feature\\nidentifiers must be integers (encoded as strings because JSON only supports\\nstrings for map keys) and the feature values are numbers (floating point).\", \"Variable length binary type\": \"Presto now supports the `varbinary` type for variable length binary data.\\nCurrently, the only supported function is {func}`length`.\\nThe Hive connector now maps the Hive `BINARY` type to `varbinary`.\", \"General\": [\"Add missing operator: `timestamp with time zone` - `interval year to month`\", \"Support explaining sampled queries\", \"Add JMX stats for abandoned and canceled queries\", \"Add `javax.inject` to parent-first class list for plugins\", \"Improve error categorization in event logging\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 142]\"}, {\"title\": \"Release 0.70\", \"description\": null, \"content\": {\"Views\": \"We have added support for creating views within Presto.\\nViews are defined using Presto syntax but are stored (as blobs)\\nby connectors. Currently, views are supported by the\\nRaptor and Hive connectors. For the Hive connector, views are\\nstored within the Hive metastore as Hive views, but they cannot\\nbe queried by Hive, nor can Hive views be queried by Presto.\\n\\nSee {doc}`/sql/create-view` and {doc}`/sql/drop-view`\\nfor details and examples.\", \"DUAL table\": \"The synthetic `DUAL` table is no longer supported. As an alternative, please\\nwrite your queries without a `FROM` clause or use the `VALUES` syntax.\", \"Presto Verifier\": \"There is a new project, Presto Verifier, which can be used to verify a set of\\nqueries against two different clusters.\", \"Connector improvements\": [\"Connectors can now add hidden columns to a table. Hidden columns are not\\ndisplayed in `DESCRIBE` or `information_schema`, and are not\\nconsidered for `SELECT *`. As an example, we have added a hidden\\n`row_number` column to the `tpch` connector.\", \"Presto contains an extensive test suite to verify the correctness. This test\\nsuite has been extracted into the `presto-test` module for use during\\nconnector development. For an example, see `TestRaptorDistributedQueries`.\"], \"Machine learning functions\": \"We have added two new machine learning functions, which can be used\\nby advanced users familiar with LIBSVM. The functions are\\n`learn_libsvm_classifier` and `learn_libsvm_regressor`. Both take a\\nparameters string which has the form `key=value,key=value`\", \"General\": [\"New comparison functions: {func}`greatest` and {func}`least`\", \"New window functions: {func}`first_value`, {func}`last_value`, and {func}`nth_value`\", \"We have added a config option to disable falling back to the interpreter when\\nexpressions fail to be compiled to bytecode. To set this option, add\\n`compiler.interpreter-enabled=false` to `etc/config.properties`.\\nThis will force certain queries to fail rather than running slowly.\", \"`DATE` values are now implicitly coerced to `TIMESTAMP` and `TIMESTAMP WITH TIME ZONE`\\nby setting the hour/minute/seconds to `0` with respect to the session timezone.\", \"Minor performance optimization when planning queries over tables with tens of\\nthousands of partitions or more.\", \"Fixed a bug when planning `ORDER BY ... LIMIT` queries which could result in\\nduplicate and un-ordered results under rare conditions.\", \"Reduce the size of stats collected from tasks, which dramatically reduces\\ngarbage generation and improves coordinator stability.\", \"Fix compiler cache for expressions.\", \"Fix processing of empty or commented out statements in the CLI.\"], \"Hive\": [\"There are two new configuration options for the Hive connector,\\n`hive.max-initial-split-size`, which configures the size of the\\ninitial splits, and `hive.max-initial-splits`, which configures\\nthe number of initial splits. This can be useful for speeding up small\\nqueries, which would otherwise have low parallelism.\", \"The Hive connector will now consider all tables with a non-empty value\\nfor the table property `presto_offline` to be offline. The value of the\\nproperty will be used in the error message.\", \"We have added support for `DROP TABLE` in the hive connector.\\nBy default, this feature is not enabled. To enable it, set\\n`hive.allow-drop-table=true` in your Hive catalog properties file.\", \"Ignore subdirectories when generating splits\\n(this now matches the non-recursive behavior of Hive).\", \"Fix handling of maps with null keys.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 143]\"}, {\"title\": \"Release 0.71\", \"description\": null, \"content\": {\"Release 0.71\": [\"Fix packaging issue that resulted in an unusable server tarball\\nfor the 0.70 release\", \"Fix logging in Hive connector when using Amazon S3\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 144]\"}, {\"title\": \"Release 0.72\", \"description\": null, \"content\": {\"Release 0.72\": [\"Fix infinite loop bug in Hive RCFile reader when decoding a Map\\nwith a null key\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 145]\"}, {\"title\": \"Release 0.73\", \"description\": null, \"content\": {\"Cassandra plugin\": \"The Cassandra connector now supports CREATE TABLE and DROP TABLE. Additionally,\\nthe connector now takes into account Cassandra indexes when generating CQL.\\nThis release also includes several bug fixes and performance improvements.\", \"General\": [\"New window functions: {func}`lead`, and {func}`lag`\", \"New scalar function: {func}`json_size`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 146]\"}, {\"title\": \"Release 0.74\", \"description\": null, \"content\": {\"Bytecode compiler\": \"This version includes new infrastructure for bytecode compilation, and lays the groundwork for future improvements.\\nThere should be no impact in performance or correctness with the new code, but we have added a flag to revert to the\\nold implementation in case of issues. To do so, add `compiler.new-bytecode-generator-enabled=false` to\\n`etc/config.properties` in the coordinator and workers.\", \"Hive storage format\": \"The storage format to use when writing data to Hive can now be configured via the `hive.storage-format` option\\nin your Hive catalog properties file. Valid options are `RCBINARY`, `RCTEXT`, `SEQUENCEFILE` and `TEXTFILE`.\\nThe default format if the property is not set is `RCBINARY`.\", \"General\": [\"Show column comments in `DESCRIBE`\", \"Add {func}`try_cast` which works like {func}`cast` but returns `null` if the cast fails\", \"`nullif` now correctly returns a value with the type of the first argument\", \"Fix an issue with {func}`timezone_hour` returning results in milliseconds instead of hours\", \"Show a proper error message when analyzing queries with non-equijoin clauses\", \"Improve \\\"too many failures\\\" error message when coordinator can't talk to workers\", \"Minor optimization of {func}`json_size` function\", \"Improve feature normalization algorithm for machine learning functions\", \"Add exponential back-off to the S3 FileSystem retry logic\", \"Improve CPU efficiency of semi-joins\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 147]\"}, {\"title\": \"Release 0.75\", \"description\": null, \"content\": {\"Hive\": [\"The Hive S3 file system has a new configuration option,\\n`hive.s3.max-connections`, which sets the maximum number of\\nconnections to S3. The default has been increased from `50` to `500`.\", \"The Hive connector now supports renaming tables. By default, this feature\\nis not enabled. To enable it, set `hive.allow-rename-table=true` in\\nyour Hive catalog properties file.\"], \"General\": [\"Optimize {func}`count` with a constant to execute as the much faster `count(*)`\", \"Add support for binary types to the JDBC driver\", \"The legacy byte code compiler has been removed\", \"New aggregation framework (~10% faster)\", \"Added {func}`max_by` aggregation function\", \"The `approx_avg()` function has been removed. Use {func}`avg` instead.\", \"Fixed parsing of `UNION` queries that use both `DISTINCT` and `ALL`\", \"Fixed cross join planning error for certain query shapes\", \"Added hex and base64 conversion functions for varbinary\", \"Fix the `LIKE` operator to correctly match against values that contain\\nmultiple lines. Previously, it would stop matching at the first newline.\", \"Add support for renaming tables using the {doc}`/sql/alter-table` statement.\", \"Add basic support for inserting data using the {doc}`/sql/insert` statement.\\nThis is currently only supported for the Raptor connector.\"], \"JSON function\": \"The {func}`json_extract` and {func}`json_extract_scalar` functions now support\\nthe square bracket syntax:\\n\\n```\\nSELECT json_extract(json, '$.store[book]');\\nSELECT json_extract(json, '$.store[\\\"book name\\\"]');\\n```\\n\\nAs part of this change, the set of characters allowed in a non-bracketed\\npath segment has been restricted to alphanumeric, underscores and colons.\\nAdditionally, colons cannot be used in a un-quoted bracketed path segment.\\nUse the new bracket syntax with quotes to match elements that contain\\nspecial characters.\", \"Scheduler\": \"The scheduler now assigns splits to a node based on the current load on the node across all queries.\\nPreviously, the scheduler load balanced splits across nodes on a per query level. Every node can have\\n`node-scheduler.max-splits-per-node` splits scheduled on it. To avoid starvation of small queries,\\nwhen the node already has the maximum allowable splits, every task can schedule at most\\n`node-scheduler.max-pending-splits-per-node-per-task` splits on the node.\", \"Row number optimizations\": \"Queries that use the {func}`row_number` function are substantially faster\\nand can run on larger result sets for two types of queries.\\n\\nPerforming a partitioned limit that choses `N` arbitrary rows per\\npartition is a streaming operation. The following query selects\\nfive arbitrary rows from `orders` for each `orderstatus`:\\n\\n```\\nSELECT * FROM (\\n SELECT row_number() OVER (PARTITION BY orderstatus) AS rn,\\n custkey, orderdate, orderstatus\\n FROM orders\\n) WHERE rn <= 5;\\n```\\n\\nPerforming a partitioned top-N that chooses the maximum or minimum\\n`N` rows from each partition now uses significantly less memory.\\nThe following query selects the five oldest rows based on `orderdate`\\nfrom `orders` for each `orderstatus`:\\n\\n```\\nSELECT * FROM (\\n SELECT row_number() OVER (PARTITION BY orderstatus ORDER BY orderdate) AS rn,\\n custkey, orderdate, orderstatus\\n FROM orders\\n) WHERE rn <= 5;\\n```\\n\\nUse the {doc}`/sql/explain` statement to see if any of these optimizations\\nhave been applied to your query.\", \"SPI\": \"The core Presto engine no longer automatically adds a column for `count(*)`\\nqueries. Instead, the `RecordCursorProvider` will receive an empty list of\\ncolumn handles.\\n\\nThe `Type` and `Block` APIs have gone through a major refactoring in this\\nrelease. The main focus of the refactoring was to consolidate all type specific\\nencoding logic in the type itself, which makes types much easier to implement.\\nYou should consider `Type` and `Block` to be a beta API as we expect\\nfurther changes in the near future.\\n\\nTo simplify the API, `ConnectorOutputHandleResolver` has been merged into\\n`ConnectorHandleResolver`. Additionally, `ConnectorHandleResolver`,\\n`ConnectorRecordSinkProvider` and `ConnectorMetadata` were modified to\\nsupport inserts.\\n\\n:::{note}\\nThis is a backwards incompatible change with the previous connector and\\ntype SPI, so if you have written a connector or type, you will need to update\\nyour code before deploying this release. In particular, make sure your\\nconnector can handle an empty column handles list (this can be verified\\nby running `SELECT count(*)` on a table from your connector).\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 148]\"}, {\"title\": \"Release 0.76\", \"description\": null, \"content\": {\"Kafka connector\": \"This release adds a connector that allows querying of [Apache Kafka] topic data\\nfrom Presto. Topics can be live and repeated queries will pick up new data.\\n\\nApache Kafka 0.8+ is supported although Apache Kafka 0.8.1+ is recommended.\\nThere is extensive {doc}`documentation </connector/kafka>` about configuring\\nthe connector and a {doc}`tutorial </connector/kafka-tutorial>` to get started.\", \"MySQL and PostgreSQL connectors\": \"This release adds the {doc}`/connector/mysql` and {doc}`/connector/postgresql`\\nfor querying and creating tables in external relational databases. These can\\nbe used to join or copy data between different systems like MySQL and Hive,\\nor between two different MySQL or PostgreSQL instances, or any combination.\", \"Cassandra\": \"The {doc}`/connector/cassandra` configuration properties\\n`cassandra.client.read-timeout` and `cassandra.client.connect-timeout`\\nare now specified using a duration rather than milliseconds (this makes\\nthem consistent with all other such properties in Presto). If you were\\npreviously specifying a value such as `25`, change it to `25ms`.\\n\\nThe retry policy for the Cassandra client is now configurable via the\\n`cassandra.retry-policy` property. In particular, the custom `BACKOFF`\\nretry policy may be useful.\", \"Hive\": \"The new {doc}`/connector/hive` configuration property `hive.s3.socket-timeout`\\nallows changing the socket timeout for queries that read or write to Amazon S3.\\nAdditionally, the previously added `hive.s3.max-connections` property\\nwas not respected and always used the default of `500`.\\n\\nHive allows the partitions in a table to have a different schema than the\\ntable. In particular, it allows changing the type of a column without\\nchanging the column type of existing partitions. The Hive connector does\\nnot support this and could previously return garbage data for partitions\\nstored using the RCFile Text format if the column type was converted from\\na non-numeric type such as `STRING` to a numeric type such as `BIGINT`\\nand the actual data in existing partitions was not numeric. The Hive\\nconnector now detects this scenario and fails the query after the\\npartition metadata has been read.\\n\\nThe property `hive.storage-format` is broken and has been disabled. It\\nsets the storage format on the metadata but always writes the table using\\n`RCBINARY`. This will be implemented in a future release.\", \"General\": [\"Fix hang in verifier when an exception occurs.\", \"Fix {func}`chr` function to work with Unicode code points instead of ASCII code points.\", \"The JDBC driver no longer hangs the JVM on shutdown (all threads are daemon threads).\", \"Fix incorrect parsing of function arguments.\", \"The bytecode compiler now caches generated code for join and group byqueries,\\nwhich should improve performance and CPU efficiency for these types of queries.\", \"Improve planning performance for certain trivial queries over tables with lots of partitions.\", \"Avoid creating large output pages. This should mitigate some cases of\\n*\\\"Remote page is too large\\\"* errors.\", \"The coordinator/worker communication layer is now fully asynchronous.\\nSpecifically, long-poll requests no longer tie up a thread on the worker.\\nThis makes heavily loaded clusters more efficient.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 149]\"}, {\"title\": \"Release 0.77\", \"description\": null, \"content\": {\"Parametric types\": \"Presto now has a framework for implementing parametric types and functions.\\nSupport for {ref}`array-type` and {ref}`map-type` types has been added, including the element accessor\\noperator `[]`, and new {doc}`/functions/array`.\", \"Streaming index joins\": \"Index joins will now switch to use a key-by-key streaming join if index\\nresults fail to fit in the allocated index memory space.\", \"Distributed joins\": \"Joins where both tables are distributed are now supported. This allows larger tables to be joined,\\nand can be enabled with the `distributed-joins-enabled` flag. It may perform worse than the existing\\nbroadcast join implementation because it requires redistributing both tables.\\nThis feature is still experimental, and should be used with caution.\", \"Hive\": [\"Handle spurious `AbortedException` when closing S3 input streams\", \"Add support for ORC, DWRF and Parquet in Hive\", \"Add support for `DATE` type in Hive\", \"Fix performance regression in Hive when reading `VARCHAR` columns\"], \"Kafka\": [\"Fix Kafka handling of default port\", \"Add support for Kafka messages with a null key\"], \"General\": [\"Fix race condition in scheduler that could cause queries to hang\", \"Add ConnectorPageSource which is a more efficient interface for column-oriented sources\", \"Add support for string partition keys in Cassandra\", \"Add support for variable arity functions\", \"Add support for {func}`count` for all types\", \"Fix bug in HashAggregation that could cause the operator to go in an infinite loop\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 150]\"}, {\"title\": \"Release 0.78\", \"description\": null, \"content\": {\"ARRAY and MAP types in Hive connector\": \"The Hive connector now returns arrays and maps instead of json encoded strings,\\nfor columns whose underlying type is array or map. Please note that this is a backwards\\nincompatible change, and the {doc}`/functions/json` will no longer work on these columns,\\nunless you {func}`cast` them to the `json` type.\", \"Session properties\": \"The Presto session can now contain properties, which can be used by the Presto\\nengine or connectors to customize the query execution. There is a separate\\nnamespace for the Presto engine and each catalog. A property for a catalog is\\nsimplify prefixed with the catalog name followed by `.` (dot). A connector\\ncan retrieve the properties for the catalog using\\n`ConnectorSession.getProperties()`.\\n\\nSession properties can be set using the `--session` command line argument to\\nthe Presto CLI. For example:\\n\\n```\\npresto-cli --session color=red --session size=large\\n```\\n\\nFor JDBC, the properties can be set by unwrapping the `Connection` as follows:\\n\\n```\\nconnection.unwrap(PrestoConnection.class).setSessionProperty(\\\"name\\\", \\\"value\\\");\\n```\\n\\n:::{note}\\nThis feature is a work in progress and will change in a future release.\\nSpecifically, we are planning to require preregistration of properties so\\nthe user can list available session properties and so the engine can verify\\nproperty values. Additionally, the Presto grammar will be extended to\\nallow setting properties via a query.\\n:::\", \"Hive\": [\"Add `storage_format` session property to override format used for creating tables.\", \"Add write support for `VARBINARY`, `DATE` and `TIMESTAMP`.\", \"Add support for partition keys of type `TIMESTAMP`.\", \"Add support for partition keys with null values (`__HIVE_DEFAULT_PARTITION__`).\", \"Fix `hive.storage-format` option (see {doc}`release-0.76`).\"], \"General\": [\"Fix expression optimizer, so that it runs in linear time instead of exponential time.\", \"Add {func}`cardinality` for maps.\", \"Fix race condition in SqlTask creation which can cause queries to hang.\", \"Fix `node-scheduler.multiple-tasks-per-node-enabled` option.\", \"Fix an exception when planning a query with a UNION under a JOIN.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 151]\"}, {\"title\": \"Release 0.79\", \"description\": null, \"content\": {\"Hive\": [\"Add configuration option `hive.force-local-scheduling` and session property\\n`force_local_scheduling` to force local scheduling of splits.\", \"Add new experimental optimized RCFile reader. The reader can be enabled by\\nsetting the configuration option `hive.optimized-reader.enabled` or session\\nproperty `optimized_reader_enabled`.\"], \"General\": [\"Add support for {ref}`unnest`, which can be used as a replacement for the `explode()` function in Hive.\", \"Fix a bug in the scan operator that can cause data to be missed. It currently only affects queries\\nover `information_schema` or `sys` tables, metadata queries such as `SHOW PARTITIONS` and connectors\\nthat implement the `ConnectorPageSource` interface.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 152]\"}, {\"title\": \"Release 0.80\", \"description\": null, \"content\": {\"New Hive ORC reader\": \"We have added a new ORC reader implementation. The new reader supports vectorized\\nreads, lazy loading, and predicate push down, all of which make the reader more\\nefficient and typically reduces wall clock time for a query. Although the new\\nreader has been heavily tested, it is an extensive rewrite of the Apache Hive\\nORC reader, and may have some latent issues. If you are seeing issues, you can\\ndisable the new reader on a per-query basis by setting the\\n`<hive-catalog>.optimized_reader_enabled` session property, or you can disable\\nthe reader by default by setting the Hive catalog property\\n`hive.optimized-reader.enabled=false`.\", \"Hive\": [\"The maximum retry time for the Hive S3 file system can be configured\\nby setting `hive.s3.max-retry-time`.\", \"Fix Hive partition pruning for null keys (i.e. `__HIVE_DEFAULT_PARTITION__`).\"], \"Cassandra\": [\"Update Cassandra driver to 2.1.0.\", \"Map Cassandra `TIMESTAMP` type to Presto `TIMESTAMP` type.\"], \"\\\"Big Query\\\" support\": \"We've added experimental support for \\\"big\\\" queries. This provides a separate\\nqueue controlled by the following properties:\\n\\n['`experimental.max-concurrent-big-queries`', '`experimental.max-queued-big-queries`']\\n\\nThere are separate configuration options for queries that are submitted with\\nthe `experimental_big_query` session property:\\n\\n['`experimental.big-query-initial-hash-partitions`', '`experimental.big-query-max-task-memory`']\\n\\nQueries submitted with this property will use hash distribution for all joins.\", \"Metadata-only query optimization\": \"We now support an optimization that rewrites aggregation queries that are insensitive to the\\ncardinality of the input (e.g., {func}`max`, {func}`min`, `DISTINCT` aggregates) to execute\\nagainst table metadata.\\n\\nFor example, if `key`, `key1` and `key2` are partition keys, the following queries\\nwill benefit:\\n\\n```\\nSELECT min(key), max(key) FROM t;\\n\\nSELECT DISTINCT key FROM t;\\n\\nSELECT count(DISTINCT key) FROM t;\\n\\nSELECT count(DISTINCT key + 5) FROM t;\\n\\nSELECT count(DISTINCT key) FROM (SELECT key FROM t ORDER BY 1 LIMIT 10);\\n\\nSELECT key1, count(DISTINCT key2) FROM t GROUP BY 1;\\n```\\n\\nThis optimization is turned off by default. To turn it on, add `optimizer.optimize-metadata-queries=true`\\nto the coordinator config properties.\\n\\n:::{warning}\\nThis optimization will cause queries to produce incorrect results if\\nthe connector allows partitions to contain no data. For example, the\\nHive connector will produce incorrect results if your Hive warehouse\\ncontains partitions without data.\\n:::\", \"General\": [\"Add support implicit joins. The following syntax is now allowed:\", \"```\\nSELECT * FROM a, b WHERE a.id = b.id;\\n```\", \"Add property `task.verbose-stats` to enable verbose statistics collection for\\ntasks. The default is `false`.\", \"Format binary data in the CLI as a hex dump.\", \"Add approximate numeric histogram function {func}`numeric_histogram`.\", \"Add {func}`array_sort` function.\", \"Add {func}`map_keys` and {func}`map_values` functions.\", \"Make {func}`row_number` completely streaming.\", \"Add property `task.max-partial-aggregation-memory` to configure the memory limit\\nfor the partial step of aggregations.\", \"Fix exception when processing queries with an `UNNEST` operation where the output was not used.\", \"Only show query progress in UI after the query has been fully scheduled.\", \"Add query execution visualization to the coordinator UI. It can be accessed via the query details page.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 153]\"}, {\"title\": \"Release 0.81\", \"description\": null, \"content\": {\"Hive\": [\"Fix ORC predicate pushdown.\", \"Fix column selection in RCFile.\"], \"General\": [\"Fix handling of null and out-of-range offsets for\\n{func}`lead`, {func}`lag` and {func}`nth_value` functions.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 154]\"}, {\"title\": \"Release 0.82\", \"description\": null, \"content\": {\"Release 0.82\": [\"Presto now supports the {ref}`row-type` type, and all Hive structs are\\nconverted to ROWs, instead of JSON encoded VARCHARs.\", \"Add {func}`current_timezone` function.\", \"Improve planning performance for queries with thousands of columns.\", \"Fix a regression that was causing excessive memory allocation and GC pressure\\nin the coordinator.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 155]\"}, {\"title\": \"Release 0.83\", \"description\": null, \"content\": {\"Raptor\": [\"Raptor now enables specifying the backup storage location. This feature is highly experimental.\", \"Fix the handling of shards not assigned to any node.\"], \"General\": [\"Fix resource leak in query queues.\", \"Fix NPE when writing null `ARRAY/MAP` to Hive.\", \"Fix {func}`json_array_get` to handle nested structures.\", \"Fix `UNNEST` on null collections.\", \"Fix a regression where queries that fail during parsing or analysis do not expire.\", \"Make `JSON` type comparable.\", \"Added an optimization for hash aggregations. This optimization is turned off by default.\\nTo turn it on, add `optimizer.optimize-hash-generation=true` to the coordinator config properties.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 156]\"}, {\"title\": \"Release 0.84\", \"description\": null, \"content\": {\"Release 0.84\": [\"Fix handling of `NaN` and infinity in ARRAYs\", \"Fix approximate queries that use `JOIN`\", \"Reduce excessive memory allocation and GC pressure in the coordinator\", \"Fix an issue where setting `node-scheduler.location-aware-scheduling-enabled=false`\\nwould cause queries to fail for connectors whose splits were not remotely accessible\", \"Fix error when running `COUNT(*)` over tables in `information_schema` and `sys`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 157]\"}, {\"title\": \"Release 0.85\", \"description\": null, \"content\": {\"Release 0.85\": [\"Improve query planning performance for tables with large numbers of partitions.\", \"Fix issue when using `JSON` values in `GROUP BY` expressions.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 158]\"}, {\"title\": \"Release 0.86\", \"description\": null, \"content\": {\"General\": [\"Add support for inequality `INNER JOIN` when each term of the condition refers to only one side of the join.\", \"Add {func}`ntile` function.\", \"Add {func}`map` function to create a map from arrays of keys and values.\", \"Add {func}`min_by` aggregation function.\", \"Add support for concatenating arrays with the `||` operator.\", \"Add support for `=` and `!=` to `JSON` type.\", \"Improve error message when `DISTINCT` is applied to types that are not comparable.\", \"Perform type validation for `IN` expression where the right-hand side is a subquery expression.\", \"Improve error message when `ORDER BY ... LIMIT` query exceeds its maximum memory allocation.\", \"Improve error message when types that are not orderable are used in an `ORDER BY` clause.\", \"Improve error message when the types of the columns for subqueries of a `UNION` query don't match.\", \"Fix a regression where queries could be expired too soon on a highly loaded cluster.\", \"Fix scheduling issue for queries involving tables from information_schema, which could result in\\ninconsistent metadata.\", \"Fix an issue with {func}`min_by` and {func}`max_by` that could result in an error when used with\\na variable-length type (e.g., `VARCHAR`) in a `GROUP BY` query.\", \"Fix rendering of array attributes in JMX connector.\", \"Input rows/bytes are now tracked properly for `JOIN` queries.\", \"Fix case-sensitivity issue when resolving names of constant table expressions.\", \"Fix unnesting arrays and maps that contain the `ROW` type.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 159]\"}, {\"title\": \"Release 0.87\", \"description\": null, \"content\": {\"General\": [\"Fixed a bug where {ref}`row-type` types could have the wrong field names.\", \"Changed the minimum JDK version to 1.8.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 160]\"}, {\"title\": \"Release 0.88\", \"description\": null, \"content\": {\"General\": [\"Added {func}`arbitrary` aggregation function.\", \"Allow using all {doc}`/functions/aggregate` as {doc}`/functions/window`.\", \"Support specifying window frames and correctly implement frames for all {doc}`/functions/window`.\", \"Allow {func}`approx_distinct` aggregation function to accept a standard error parameter.\", \"Implement {func}`least` and {func}`greatest` with variable number of arguments.\", \"{ref}`array-type` is now comparable and can be used as `GROUP BY` keys or in `ORDER BY` expressions.\", \"Implement `=` and `<>` operators for {ref}`row-type`.\", \"Fix excessive garbage creation in the ORC reader.\", \"Fix an issue that could cause queries using {func}`row_number()` and `LIMIT` to never terminate.\", \"Fix an issue that could cause queries with {func}`row_number()` and specific filters to produce incorrect results.\", \"Fixed an issue that caused the Cassandra plugin to fail to load with a SecurityException.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 161]\"}, {\"title\": \"Release 0.89\", \"description\": null, \"content\": {\"DATE type\": \"The memory representation of dates is now the number of days since January 1, 1970\\nusing a 32-bit signed integer.\\n\\n:::{note}\\nThis is a backwards incompatible change with the previous date\\nrepresentation, so if you have written a connector, you will need to update\\nyour code before deploying this release.\\n:::\", \"General\": [\"`USE CATALOG` and `USE SCHEMA` have been replaced with {doc}`/sql/use`.\", \"Fix issue where `SELECT NULL` incorrectly returns 0 rows.\", \"Fix rare condition where `JOIN` queries could produce incorrect results.\", \"Fix issue where `UNION` queries involving complex types would fail during planning.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 162]\"}, {\"title\": \"Release 0.90\", \"description\": null, \"content\": {\"General\": [\"Initial support for partition and placement awareness in the query planner. This can\\nresult in better plans for queries involving `JOIN` and `GROUP BY` over the same\\nkey columns.\", \"Improve planning of UNION queries.\", \"Add presto version to query creation and completion events.\", \"Add property `task.writer-count` to configure the number of writers per task.\", \"Fix a bug when optimizing constant expressions involving binary types.\", \"Fix bug where a table writer commits partial results while cleaning up a failed query.\", \"Fix a bug when unnesting an array of doubles containing NaN or Infinity.\", \"Fix failure when accessing elements in an empty array.\", \"Fix *\\\"Remote page is too large\\\"* errors.\", \"Improve error message when attempting to cast a value to `UNKNOWN`.\", \"Update the {func}`approx_distinct` documentation with correct standard error bounds.\", \"Disable falling back to the interpreter when expressions fail to be compiled\\nto bytecode. To enable this option, add `compiler.interpreter-enabled=true`\\nto the coordinator and worker config properties. Enabling this option will\\nallow certain queries to run slowly rather than failing.\", \"Improve {doc}`/client/jdbc` conformance. In particular, all unimplemented\\nmethods now throw `SQLException` rather than `UnsupportedOperationException`.\"], \"Functions and language features\": [\"Add {func}`bool_and` and {func}`bool_or` aggregation functions.\", \"Add standard SQL function {func}`every` as an alias for {func}`bool_and`.\", \"Add {func}`year_of_week` function.\", \"Add {func}`regexp_extract_all` function.\", \"Add {func}`map_agg` aggregation function.\", \"Add support for casting `JSON` to `ARRAY` or `MAP` types.\", \"Add support for unparenthesized expressions in `VALUES` clause.\", \"Added {doc}`/sql/set-session`, {doc}`/sql/reset-session` and {doc}`/sql/show-session`.\", \"Improve formatting of `EXPLAIN (TYPE DISTRIBUTED)` output and include additional\\ninformation such as output layout, task placement policy and partitioning functions.\"], \"Hive\": [\"Disable optimized metastore partition fetching for non-string partition keys.\\nThis fixes an issue were Presto might silently ignore data with non-canonical\\npartition values. To enable this option, add `hive.assume-canonical-partition-keys=true`\\nto the coordinator and worker config properties.\", \"Don't retry operations against S3 that fail due to lack of permissions.\"], \"SPI\": [\"Add `getColumnTypes` to `RecordSink`.\", \"Use `Slice` for table writer fragments.\", \"Add `ConnectorPageSink` which is a more efficient interface for column-oriented sources.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 163]\"}, {\"title\": \"Release 0.91\", \"description\": null, \"content\": {\"General\": [\"Clear `LazyBlockLoader` reference after load to free memory earlier.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 164]\"}, {\"title\": \"Release 0.92\", \"description\": null, \"content\": {\"General\": [\"Fix buffer leak when a query fails.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 165]\"}, {\"title\": \"Release 0.93\", \"description\": null, \"content\": {\"ORC memory usage\": \"This release changes the Presto ORC reader to favor small buffers when reading\\nvarchar and varbinary data. Some ORC files contain columns of data that are\\nhundreds of megabytes when decompressed. In the previous Presto ORC reader, we\\nwould allocate a single large shared buffer for all values in the column. This\\nwould cause heap fragmentation in CMS and G1, and it would cause OOMs since\\neach value of the column retains a reference to the shared buffer. In this\\nrelease the ORC reader uses a separate buffer for each value in the column.\\nThis reduces heap fragmentation and excessive memory retention at the expense\\nof object creation.\", \"Verifier\": [\"Add support for setting username and password per query\"], \"General\": [\"Add optimizer for `LIMIT 0`\", \"Fix incorrect check to disable string statistics in ORC\", \"Ignore hidden columns in `INSERT` and `CREATE TABLE AS` queries\", \"Add SOCKS support to CLI\", \"Improve CLI output for update queries\", \"Disable pushdown for non-deterministic predicates\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 166]\"}, {\"title\": \"Release 0.94\", \"description\": null, \"content\": {\"ORC memory usage\": \"This release contains additional changes to the Presto ORC reader to favor\\nsmall buffers when reading varchar and varbinary data. Some ORC files contain\\ncolumns of data that are hundreds of megabytes compressed. When reading these\\ncolumns, Presto would allocate a single buffer for the compressed column data,\\nand this would cause heap fragmentation in CMS and G1 and eventually OOMs.\\nIn this release, the `hive.orc.max-buffer-size` sets the maximum size for a\\nsingle ORC buffer, and for larger columns we instead stream the data. This\\nreduces heap fragmentation and excessive buffers in ORC at the expense of\\nHDFS IOPS. The default value is `8MB`.\", \"General\": [\"Update Hive CDH 4 connector to CDH 4.7.1\", \"Fix `ORDER BY` with `LIMIT 0`\", \"Fix compilation of `try_cast`\", \"Group threads into Java thread groups to ease debugging\", \"Add `task.min-drivers` config to help limit number of concurrent readers\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 167]\"}, {\"title\": \"Release 0.95\", \"description\": null, \"content\": {\"General\": [\"Fix task and stage leak, caused when a stage finishes before its substages.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 168]\"}, {\"title\": \"Release 0.96\", \"description\": null, \"content\": {\"General\": [\"Fix {func}`try_cast` for `TIMESTAMP` and other types that\\nneed access to session information.\", \"Fix planner bug that could result in incorrect results for\\ntables containing columns with the same prefix, underscores and numbers.\", \"`MAP` type is now comparable.\", \"Fix output buffer leak in `StatementResource.Query`.\", \"Fix leak in `SqlTasks` caused by invalid heartbeats .\", \"Fix double logging of queries submitted while the queue is full.\", \"Fixed \\\"running queries\\\" JMX stat.\", \"Add `distributed_join` session property to enable/disable distributed joins.\"], \"Hive\": [\"Add support for tables partitioned by `DATE`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 169]\"}, {\"title\": \"Release 0.97\", \"description\": null, \"content\": {\"General\": [\"The queueing policy in Presto may now be injected.\", \"Speed up detection of ASCII strings in implementation of `LIKE` operator.\", \"Fix NullPointerException when metadata-based query optimization is enabled.\", \"Fix possible infinite loop when decompressing ORC data.\", \"Fix an issue where `NOT` clause was being ignored in `NOT BETWEEN` predicates.\", \"Fix a planning issue in queries that use `SELECT *`, window functions and implicit coercions.\", \"Fix scheduler deadlock for queries with a `UNION` between `VALUES` and `SELECT`.\"], \"Hive\": [\"Fix decoding of `STRUCT` type from Parquet files.\", \"Speed up decoding of ORC files with very small stripes.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 170]\"}, {\"title\": \"Release 0.98\", \"description\": null, \"content\": {\"Array, map, and row types\": \"The memory representation of these types is now `VariableWidthBlockEncoding`\\ninstead of `JSON`.\\n\\n:::{note}\\nThis is a backwards incompatible change with the previous representation,\\nso if you have written a connector or function, you will need to update\\nyour code before deploying this release.\\n:::\", \"Hive\": [\"Fix handling of ORC files with corrupt checkpoints.\"], \"SPI\": [\"Rename `Index` to `ConnectorIndex`.\"], \"General\": [\"Fix bug in `UNNEST` when output is unreferenced or partially referenced.\", \"Make {func}`max` and {func}`min` functions work on all orderable types.\", \"Optimize memory allocation in {func}`max_by` and other places that `Block` is used.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 171]\"}, {\"title\": \"Release 0.99\", \"description\": null, \"content\": {\"General\": [\"Reduce lock contention in `TaskExecutor`.\", \"Fix reading maps with null keys from ORC.\", \"Fix precomputed hash optimization for nulls values.\", \"Make {func}`contains()` work for all comparable types.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 172]\"}, {\"title\": \"Release 300 (22 Jan 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix {func}`array_intersect` and {func}`array_distinct`\\nskipping zeros when input also contains nulls.\", \"Fix `count(*)` aggregation returning null on empty relation\\nwhen `optimize_mixed_distinct_aggregation` is enabled.\", \"Improve table scan performance for structured types.\", \"Improve performance for {func}`array_intersect`.\", \"Improve performance of window functions by filtering partitions early.\", \"Add {func}`reduce_agg` aggregate function.\", \"Add {func}`millisecond` function.\", \"Remove `ON` keyword from {doc}`/sql/show-stats` (use `FOR` instead).\", \"Restrict `WHERE` clause in {doc}`/sql/show-stats`\\nto filters that can be pushed down to connectors.\", \"Return final results to clients immediately for failed queries.\"], \"JMX MBean naming\": [\"The base domain name for server MBeans is now `presto`. The old names can be\\nused by setting the configuration property `jmx.base-name` to `com.facebook.presto`.\", \"The base domain name for the Hive, Raptor, and Thrift connectors is `presto.plugin`.\\nThe old names can be used by setting the catalog configuration property\\n`jmx.base-name` to `com.facebook.presto.hive`, `com.facebook.presto.raptor`,\\nor `com.facebook.presto.thrift`, respectively.\"], \"Web UI\": [\"Fix rendering of live plan view for queries involving index joins.\"], \"JDBC driver\": [\"Change driver class name to `io.prestosql.jdbc.PrestoDriver`.\"], \"System connector\": [\"Remove `node_id` column from `system.runtime.queries` table.\"], \"Hive connector\": [\"Fix accounting of time spent reading Parquet data.\", \"Fix corner case where the ORC writer fails with integer overflow when writing\\nhighly compressible data using dictionary encoding ({issue}`x11930`).\", \"Fail queries reading Parquet files if statistics in those files are corrupt\\n(e.g., min > max). To disable this behavior, set the configuration\\nproperty `hive.parquet.fail-on-corrupted-statistics`\\nor session property `parquet_fail_with_corrupted_statistics` to false.\", \"Add support for S3 Select pushdown, which enables pushing down\\ncolumn selection and range filters into S3 for text files.\"], \"Kudu connector\": [\"Add `number_of_replicas` table property to `SHOW CREATE TABLE` output.\"], \"Cassandra connector\": [\"Add `cassandra.splits-per-node` and `cassandra.protocol-version` configuration\\nproperties to allow connecting to Cassandra servers older than 2.1.5.\"], \"MySQL connector\": [\"Add support for predicate pushdown for columns of `char(x)` type.\"], \"PostgreSQL connector\": [\"Add support for predicate pushdown for columns of `char(x)` type.\"], \"Redshift connector\": [\"Add support for predicate pushdown for columns of `char(x)` type.\"], \"SQL Server connector\": [\"Add support for predicate pushdown for columns of `char(x)` type.\"], \"Raptor Legacy connector\": [\"Change name of connector to `raptor-legacy`.\"], \"Verifier\": [\"Add `run-teardown-on-result-mismatch` configuration property to facilitate debugging.\\nWhen set to false, temporary tables will not be dropped after checksum failures.\"], \"SPI\": [\"Change base package to `io.prestosql.spi`.\", \"Move connector related classes to package `io.prestosql.spi.connector`.\", \"Make `ConnectorBucketNodeMap` a top level class.\", \"Use list instead of map for bucket-to-node mapping.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 173]\"}, {\"title\": \"Release 301 (31 Jan 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix reporting of aggregate input data size stats. ({issue}`100`)\", \"Add support for role management (see {doc}`/sql/create-role`). Note, using {doc}`/sql/set-role`\\nrequires an up-to-date client library. ({issue}`90`)\", \"Add `INVOKER` security mode for {doc}`/sql/create-view`. ({issue}`30`)\", \"Add `ANALYZE` SQL statement for collecting table statistics. ({issue}`99`)\", \"Add {func}`log` function with arbitrary base. ({issue}`36`)\", \"Remove the `deprecated.legacy-log-function` configuration option. The legacy behavior\\n(reverse argument order) for the {func}`log` function is no longer available. ({issue}`36`)\", \"Remove the `deprecated.legacy-array-agg` configuration option. The legacy behavior\\n(ignoring nulls) for {func}`array_agg` is no longer available. ({issue}`77`)\", \"Improve performance of `COALESCE` expressions. ({issue}`35`)\", \"Improve error message for unsupported {func}`reduce_agg` state type. ({issue}`55`)\", \"Improve performance of queries involving `SYSTEM` table sampling and computations over the\\ncolumns of the sampled table. ({issue}`29`)\"], \"Server RPM\": [\"Do not allow uninstalling RPM while server is still running. ({issue}`67`)\"], \"Security\": [\"Support LDAP with anonymous bind disabled. ({issue}`97`)\"], \"Hive connector\": [\"Add procedure for dumping metastore recording to a file. ({issue}`54`)\", \"Add Metastore recorder support for Glue. ({issue}`61`)\", \"Add `hive.temporary-staging-directory-enabled` configuration property and\\n`temporary_staging_directory_enabled` session property to control whether a temporary staging\\ndirectory should be used for write operations. ({issue}`70`)\", \"Add `hive.temporary-staging-directory-path` configuration property and\\n`temporary_staging_directory_path` session property to control the location of temporary\\nstaging directory that is used for write operations. The `${USER}` placeholder can be used to\\nuse a different location for each user (e.g., `/tmp/${USER}`). ({issue}`70`)\"], \"Kafka connector\": [\"The minimum supported Kafka broker version is now 0.10.0. ({issue}`53`)\"], \"Base-JDBC connector library\": [\"Add support for defining procedures. ({issue}`73`)\", \"Add support for providing table statistics. ({issue}`72`)\"], \"SPI\": [\"Include session trace token in `QueryCreatedEvent` and `QueryCompletedEvent`. ({issue}`24`)\", \"Fix regression in `NodeManager` where node list was not being refreshed on workers. ({issue}`27`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 174]\"}, {\"title\": \"Release 302 (6 Feb 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix cluster starvation when wait for minimum number of workers is enabled. ({issue}`155`)\", \"Fix backup of queries blocked waiting for minimum number of workers. ({issue}`155`)\", \"Fix failure when preparing statements that contain a quoted reserved word as a table name. ({issue}`80`)\", \"Fix query failure when spilling is triggered during certain phases of query execution. ({issue}`164`)\", \"Fix `SHOW CREATE VIEW` output to preserve table name quoting. ({issue}`80`)\", \"Add {doc}`/connector/elasticsearch`. ({issue}`118`)\", \"Add support for `boolean` type to {func}`approx_distinct`. ({issue}`82`)\", \"Add support for boolean columns to `EXPLAIN` with type `IO`. ({issue}`157`)\", \"Add `SphericalGeography` type and related {doc}`geospatial functions </functions/geospatial>`. ({issue}`166`)\", \"Remove deprecated system memory pool. ({issue}`168`)\", \"Improve query performance for certain queries involving `ROLLUP`. ({issue}`105`)\"], \"CLI\": [\"Add `--trace-token` option to set the trace token. ({issue}`117`)\", \"Display spilled data size as part of debug information. ({issue}`161`)\"], \"Web UI\": [\"Add spilled data size to query details page. ({issue}`161`)\"], \"Security\": [\"Add `http.server.authentication.krb5.principal-hostname` configuration option to set the hostname\\nfor the Kerberos service principal. ({issue}`146`, {issue}`153`)\", \"Add support for client-provided extra credentials that can be utilized by connectors. ({issue}`124`)\"], \"Hive connector\": [\"Fix Parquet predicate pushdown for `smallint`, `tinyint` types. ({issue}`131`)\", \"Add support for Google Cloud Storage (GCS). Credentials can be provided globally using the\\n`hive.gcs.json-key-file-path` configuration property, or as a client-provided extra credential\\nnamed `hive.gcs.oauth` if the `hive.gcs.use-access-token` configuration property is enabled. ({issue}`124`)\", \"Allow creating tables with the `external_location` property pointing to an empty S3 directory. ({issue}`75`)\", \"Reduce GC pressure from Parquet reader by constraining the maximum column read size. ({issue}`58`)\", \"Reduce network utilization and latency for S3 when reading ORC or Parquet. ({issue}`142`)\"], \"Kafka connector\": [\"Fix query failure when reading `information_schema.columns` without an equality condition on `table_name`. ({issue}`120`)\"], \"Redis connector\": [\"Fix query failure when reading `information_schema.columns` without an equality condition on `table_name`. ({issue}`120`)\"], \"SPI\": [\"Include query peak task user memory in `QueryCreatedEvent` and `QueryCompletedEvent`. ({issue}`163`)\", \"Include plan node cost and statistics estimates in `QueryCompletedEvent`. ({issue}`134`)\", \"Include physical and internal network input data size in `QueryCompletedEvent`. ({issue}`133`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 175]\"}, {\"title\": \"Release 303 (13 Feb 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect padding for `CHAR` values containing Unicode supplementary characters.\\nPreviously, such values would be incorrectly padded with too few spaces. ({issue}`195`)\", \"Fix an issue where a union of a table with a `VALUES` statement would execute on a\\nsingle node, which could lead to out of memory errors. ({issue}`207`)\", \"Fix `/v1/info` to report started status after all plugins have been registered and initialized. ({issue}`213`)\", \"Improve performance of window functions by avoiding unnecessary data exchanges over the network. ({issue}`177`)\", \"Choose the distribution type for semi joins based on cost when the\\n`join_distribution_type` session property is set to `AUTOMATIC`. ({issue}`160`)\", \"Expand grouped execution support to window functions, making it possible\\nto execute them with less peak memory usage. ({issue}`169`)\"], \"Web UI\": [\"Add additional details to and improve rendering of live plan. ({issue}`182`)\"], \"CLI\": [\"Add `--progress` option to show query progress in batch mode. ({issue}`34`)\"], \"Hive connector\": [\"Fix query failure when reading Parquet data with no columns selected.\\nThis affects queries such as `SELECT count(*)`. ({issue}`203`)\"], \"Mongo connector\": [\"Fix failure for queries involving joins or aggregations on `ObjectId` type. ({issue}`215`)\"], \"Base-JDBC connector library\": [\"Allow customizing how query predicates are pushed down to the underlying database. ({issue}`109`)\", \"Allow customizing how values are written to the underlying database. ({issue}`109`)\"], \"SPI\": [\"Remove deprecated methods `getSchemaName` and `getTableName` from the `SchemaTablePrefix`\\nclass. These were replaced by the `getSchema` and `getTable` methods. ({issue}`89`)\", \"Remove deprecated variants of methods `listTables` and `listViews`\\nfrom the `ConnectorMetadata` class. ({issue}`89`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 176]\"}, {\"title\": \"Release 304 (27 Feb 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix wrong results for queries involving `FULL OUTER JOIN` and `coalesce` expressions\\nover the join keys. ({issue}`288`)\", \"Fix failure when a column is referenced using its fully qualified form. ({issue}`250`)\", \"Correctly report physical and internal network position count for operators. ({issue}`271`)\", \"Improve plan stability for repeated executions of the same query. ({issue}`226`)\", \"Remove deprecated `datasources` configuration property. ({issue}`306`)\", \"Improve error message when a query contains zero-length delimited identifiers. ({issue}`249`)\", \"Avoid opening an unnecessary HTTP listener on an arbitrary port. ({issue}`239`)\", \"Add experimental support for spilling for queries involving `ORDER BY` or window functions. ({issue}`228`)\"], \"Server RPM\": [\"Preserve modified configuration files when the RPM is uninstalled. ({issue}`267`)\"], \"Web UI\": [\"Fix broken timeline view. ({issue}`283`)\", \"Show data size and position count reported by connectors and by worker-to-worker data transfers\\nin detailed query view. ({issue}`271`)\"], \"Hive connector\": [\"Fix authorization failure when using SQL Standard Based Authorization mode with user identifiers\\nthat contain capital letters. ({issue}`289`)\", \"Fix wrong results when filtering on the hidden `$bucket` column for tables containing\\npartitions with different bucket counts. Instead, queries will now fail in this case. ({issue}`286`)\", \"Record the configured Hive time zone when writing ORC files. ({issue}`212`)\", \"Use the time zone recorded in ORC files when reading timestamps.\\nThe configured Hive time zone, which was previously always used, is now\\nused only as a default when the writer did not record the time zone. ({issue}`212`)\", \"Support Parquet files written with Parquet 1.9+ that use `DELTA_BINARY_PACKED`\\nencoding with the Parquet `INT64` type. ({issue}`334`)\", \"Allow setting the retry policy for the Thrift metastore client using the\\n`hive.metastore.thrift.client.*` configuration properties. ({issue}`240`)\", \"Reduce file system read operations when reading Parquet file footers. ({issue}`296`)\", \"Allow ignoring Glacier objects in S3 rather than failing the query. This is\\ndisabled by default, as it may skip data that is expected to exist, but it can\\nbe enabled using the `hive.s3.skip-glacier-objects` configuration property. ({issue}`305`)\", \"Add procedure `system.sync_partition_metadata()` to synchronize the partitions\\nin the metastore with the partitions that are physically on the file system. ({issue}`223`)\", \"Improve performance of ORC reader for columns that only contain nulls. ({issue}`229`)\"], \"PostgreSQL connector\": [\"Map PostgreSQL `json` and `jsonb` types to Presto `json` type. ({issue}`81`)\"], \"Cassandra connector\": [\"Support queries over tables containing partitioning columns of any type. ({issue}`252`)\", \"Support `smallint`, `tinyint` and `date` Cassandra types. ({issue}`141`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 177]\"}, {\"title\": \"Release 305 (7 Mar 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix failure of {doc}`/functions/regexp` for certain patterns and inputs\\nwhen using the default `JONI` library. ({issue}`350`)\", \"Fix a rare `ClassLoader` related problem for plugins providing an `EventListenerFactory`. ({issue}`299`)\", \"Expose `join_max_broadcast_table_size` session property, which was previously hidden. ({issue}`346`)\", \"Improve performance of queries when spill is enabled but not triggered. ({issue}`315`)\", \"Consider estimated query peak memory when making cost based decisions. ({issue}`247`)\", \"Include revocable memory in total memory stats. ({issue}`273`)\", \"Add peak revocable memory to operator stats. ({issue}`273`)\", \"Add {func}`ST_Points` function to access vertices of a linestring. ({issue}`316`)\", \"Add a system table `system.metadata.analyze_properties`\\nto list all {doc}`/sql/analyze` properties. ({issue}`376`)\"], \"Resource groups\": [\"Fix resource group selection when selector uses regular expression variables. ({issue}`373`)\"], \"Web UI\": [\"Display peak revocable memory, current total memory,\\nand peak total memory in detailed query view. ({issue}`273`)\"], \"CLI\": [\"Add option to output CSV without quotes. ({issue}`319`)\"], \"Hive connector\": [\"Fix handling of updated credentials for Google Cloud Storage (GCS). ({issue}`398`)\", \"Fix calculation of bucket number for timestamps that contain a non-zero\\nmilliseconds value. Previously, data would be written into the wrong bucket,\\nor could be incorrectly skipped on read. ({issue}`366`)\", \"Allow writing ORC files compatible with Hive 2.0.0 to 2.2.0 by identifying\\nthe writer as an old version of Hive (rather than Presto) in the files.\\nThis can be enabled using the `hive.orc.writer.use-legacy-version-number`\\nconfiguration property. ({issue}`353`)\", \"Support dictionary filtering for Parquet v2 files using `RLE_DICTIONARY` encoding. ({issue}`251`)\", \"Remove legacy writers for ORC and RCFile. ({issue}`353`)\", \"Remove support for the DWRF file format. ({issue}`353`)\"], \"Base-JDBC connector library\": [\"Allow access to extra credentials when opening a JDBC connection. ({issue}`281`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 178]\"}, {\"title\": \"Release 306 (16 Mar 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure for queries containing a `LIMIT` after a global\\naggregation. ({issue}`437`)\", \"Fix missing column types in `EXPLAIN` output. ({issue}`328`)\", \"Fix accounting of peak revocable memory reservation. ({issue}`413`)\", \"Fix double memory accounting for aggregations when spilling is active. ({issue}`413`)\", \"Fix excessive CPU usage that can occur when spilling for window functions. ({issue}`468`)\", \"Fix incorrect view name displayed by `SHOW CREATE VIEW`. ({issue}`433`)\", \"Allow specifying `NOT NULL` when creating tables or adding columns. ({issue}`418`)\", \"Add a config option (`query.stage-count-warning-threshold`) to specify a\\nper-query threshold for the number of stages. When this threshold is exceeded,\\na `TOO_MANY_STAGES` warning is raised. ({issue}`330`)\", \"Support session property values with special characters (e.g., comma or equals sign). ({issue}`407`)\", \"Remove the `deprecated.legacy-unnest-array-rows` configuration option.\\nThe legacy behavior for `UNNEST` of arrays containing `ROW` values is no\\nlonger supported. ({issue}`430`)\", \"Remove the `deprecated.legacy-row-field-ordinal-access` configuration option.\\nThe legacy mechanism for accessing fields of anonymous `ROW` types is no longer\\nsupported. ({issue}`428`)\", \"Remove the `deprecated.group-by-uses-equal` configuration option. The legacy equality\\nsemantics for `GROUP BY` are not longer supported. ({issue}`432`)\", \"Remove the `deprecated.legacy-map-subscript`. The legacy behavior for the map subscript\\noperator on missing keys is no longer supported. ({issue}`429`)\", \"Remove the `deprecated.legacy-char-to-varchar-coercion` configuration option. The\\nlegacy coercion rules between `CHAR` and `VARCHAR` types are no longer\\nsupported. ({issue}`431`)\", \"Remove deprecated `distributed_join` system property. Use `join_distribution_type`\\ninstead. ({issue}`452`)\"], \"Hive connector\": [\"Fix calling procedures immediately after startup, before any other queries are run.\\nPreviously, the procedure call would fail and also cause all subsequent Hive queries\\nto fail. ({issue}`414`)\", \"Improve ORC reader performance for decoding `REAL` and `DOUBLE` types. ({issue}`465`)\"], \"MySQL connector\": [\"Allow creating or renaming tables, and adding, renaming, or dropping columns. ({issue}`418`)\"], \"PostgreSQL connector\": [\"Fix predicate pushdown for PostgreSQL `ENUM` type. ({issue}`408`)\", \"Allow creating or renaming tables, and adding, renaming, or dropping columns. ({issue}`418`)\"], \"Redshift connector\": [\"Allow creating or renaming tables, and adding, renaming, or dropping columns. ({issue}`418`)\"], \"SQL Server connector\": [\"Allow creating or renaming tables, and adding, renaming, or dropping columns. ({issue}`418`)\"], \"Base-JDBC connector library\": [\"Allow mapping column type to Presto type based on `Block`. ({issue}`454`)\"], \"SPI\": [\"Deprecate Table Layout APIs. Connectors can opt out of the legacy behavior by implementing\\n`ConnectorMetadata.usesLegacyTableLayouts()`. ({issue}`420`)\", \"Add support for limit pushdown into connectors via the `ConnectorMetadata.applyLimit()`\\nmethod. ({issue}`421`)\", \"Add time spent waiting for resources to `QueryCompletedEvent`. ({issue}`461`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 179]\"}, {\"title\": \"Release 307 (3 Apr 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix cleanup of spill files for queries using window functions or `ORDER BY`. ({issue}`543`)\", \"Optimize queries containing `ORDER BY` together with `LIMIT` over an `OUTER JOIN`\\nby pushing `ORDER BY` and `LIMIT` to the outer side of the join. ({issue}`419`)\", \"Improve performance of table scans for data sources that produce tiny pages. ({issue}`467`)\", \"Improve performance of `IN` subquery expressions that contain a `DISTINCT` clause. ({issue}`551`)\", \"Expand support of types handled in `EXPLAIN (TYPE IO)`. ({issue}`509`)\", \"Add support for outer joins involving lateral derived tables (i.e., `LATERAL`). ({issue}`390`)\", \"Add support for setting table comments via the {doc}`/sql/comment` syntax. ({issue}`200`)\"], \"Web UI\": [\"Allow UI to work when opened as `/ui` (no trailing slash). ({issue}`500`)\"], \"Security\": [\"Make query result and cancellation URIs secure. Previously, an authenticated\\nuser could potentially steal the result data of any running query. ({issue}`561`)\"], \"Server RPM\": [\"Prevent JVM from allocating large amounts of native memory. The new configuration is applied\\nautomatically when Presto is installed from RPM. When Presto is installed another way, or when\\nyou provide your own `jvm.config`, we recommend adding `-Djdk.nio.maxCachedBufferSize=2000000`\\nto your `jvm.config`. See {doc}`/installation/deployment` for details. ({issue}`542`)\"], \"CLI\": [\"Always abort query in batch mode when CLI is killed. ({issue}`508`, {issue}`580`)\"], \"JDBC driver\": [\"Abort query synchronously when the `ResultSet` is closed or when the\\n`Statement` is cancelled. Previously, the abort was sent in the background,\\nallowing the JVM to exit before the abort was received by the server. ({issue}`580`)\"], \"Hive connector\": [\"Add safety checks for Hive bucketing version. Hive 3.0 introduced a new\\nbucketing version that uses an incompatible hash function. The Hive connector\\nwill treat such tables as not bucketed when reading and disallows writing. ({issue}`512`)\", \"Add support for setting table comments via the {doc}`/sql/comment` syntax. ({issue}`200`)\"], \"Other connectors\": \"These changes apply to the MySQL, PostgreSQL, Redshift, and SQL Server connectors.\\n\\n['Fix reading and writing of `timestamp` values. Previously, an incorrect value\\\\ncould be read, depending on the Presto JVM time zone. ({issue}`495`)', 'Add support for using a client-provided username and password. The credential\\\\nnames can be configured using the `user-credential-name` and `password-credential-name`\\\\nconfiguration properties. ({issue}`482`)']\", \"SPI\": [\"`LongDecimalType` and `IpAddressType` now use `Int128ArrayBlock` instead\\nof `FixedWithBlock`. Any code that creates blocks directly, rather than using\\nthe `BlockBuilder` returned from the `Type`, will need to be updated. ({issue}`492`)\", \"Remove `FixedWidthBlock`. Use one of the `*ArrayBlock` classes instead. ({issue}`492`)\", \"Add support for simple constraint pushdown into connectors via the\\n`ConnectorMetadata.applyFilter()` method. ({issue}`541`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 180]\"}, {\"title\": \"Release 308 (11 Apr 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix a regression that prevented the server from starting on Java 9+. ({issue}`610`)\", \"Fix correctness issue for queries involving `FULL OUTER JOIN` and `coalesce`. ({issue}`622`)\"], \"Security\": [\"Add authorization for listing table columns. ({issue}`507`)\"], \"CLI\": [\"Add option for specifying Kerberos service principal pattern. ({issue}`597`)\"], \"JDBC driver\": [\"Correctly report precision and column display size in `ResultSetMetaData`\\nfor `char` and `varchar` columns. ({issue}`615`)\", \"Add option for specifying Kerberos service principal pattern. ({issue}`597`)\"], \"Hive connector\": [\"Fix regression that could cause queries to fail with `Query can potentially\\nread more than X partitions` error. ({issue}`619`)\", \"Improve ORC read performance significantly. For TPC-DS, this saves about 9.5% of\\ntotal CPU when running over gzip-compressed data. ({issue}`555`)\", \"Require access to a table (any privilege) in order to list the columns. ({issue}`507`)\", \"Add directory listing cache for specific tables. The list of tables is specified\\nusing the `hive.file-status-cache-tables` configuration property. ({issue}`343`)\"], \"MySQL connector\": [\"Fix `ALTER TABLE ... RENAME TO ...` statement. ({issue}`586`)\", \"Push simple `LIMIT` queries into the external database. ({issue}`589`)\"], \"PostgreSQL connector\": [\"Push simple `LIMIT` queries into the external database. ({issue}`589`)\"], \"Redshift connector\": [\"Push simple `LIMIT` queries into the external database. ({issue}`589`)\"], \"SQL Server connector\": [\"Fix writing `varchar` values with non-Latin characters in `CREATE TABLE AS`. ({issue}`573`)\", \"Support writing `varchar` and `char` values with length longer than 4000\\ncharacters in `CREATE TABLE AS`. ({issue}`573`)\", \"Support writing `boolean` values in `CREATE TABLE AS`. ({issue}`573`)\", \"Push simple `LIMIT` queries into the external database. ({issue}`589`)\"], \"Elasticsearch connector\": [\"Add support for Search Guard in Elasticsearch connector. Please refer to {doc}`/connector/elasticsearch`\\nfor the relevant configuration properties. ({issue}`438`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 181]\"}, {\"title\": \"Release 309 (25 Apr 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect match result for {doc}`/functions/regexp` when pattern ends\\nwith a word boundary matcher. This only affects the default `JONI` library.\\n({issue}`661`)\", \"Fix failures for queries involving spatial joins. ({issue}`652`)\", \"Add support for `SphericalGeography` to {func}`ST_Area()`. ({issue}`383`)\"], \"Security\": [\"Add option for specifying the Kerberos GSS name type. ({issue}`645`)\"], \"Server RPM\": [\"Update default JVM configuration to recommended settings (see {doc}`/installation/deployment`).\\n({issue}`642`)\"], \"Hive connector\": [\"Fix rare failure when reading `DECIMAL` values from ORC files. ({issue}`664`)\", \"Add a hidden `$properties` table for each table that describes its Hive table\\nproperties. For example, a table named `example` will have an associated\\nproperties table named `example$properties`. ({issue}`268`)\"], \"MySQL connector\": [\"Match schema and table names case insensitively. This behavior can be enabled by setting\\nthe `case-insensitive-name-matching` catalog configuration option to true. ({issue}`614`)\"], \"PostgreSQL connector\": [\"Add support for `ARRAY` type. ({issue}`317`)\", \"Add support writing `TINYINT` values. ({issue}`317`)\", \"Match schema and table names case insensitively. This behavior can be enabled by setting\\nthe `case-insensitive-name-matching` catalog configuration option to true. ({issue}`614`)\"], \"Redshift connector\": [\"Match schema and table names case insensitively. This behavior can be enabled by setting\\nthe `case-insensitive-name-matching` catalog configuration option to true. ({issue}`614`)\"], \"SQL Server connector\": [\"Match schema and table names case insensitively. This behavior can be enabled by setting\\nthe `case-insensitive-name-matching` catalog configuration option to true. ({issue}`614`)\"], \"Cassandra connector\": [\"Allow reading from tables which have Cassandra column types that are not supported by Presto.\\nThese columns will not be visible in Presto. ({issue}`592`)\"], \"SPI\": [\"Add session parameter to the `applyFilter()` and `applyLimit()` methods in\\n`ConnectorMetadata`. ({issue}`636`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 182]\"}, {\"title\": \"Release 310 (3 May 2019)\", \"description\": null, \"content\": {\"General\": [\"Reduce compilation failures for expressions over types containing an extremely\\nlarge number of nested types. ({issue}`537`)\", \"Fix error reporting when query fails with due to running out of memory. ({issue}`696`)\", \"Improve performance of `JOIN` queries involving join keys of different types.\\n({issue}`665`)\", \"Add initial and experimental support for late materialization.\\nThis feature can be enabled via `experimental.work-processor-pipelines`\\nfeature config or via `work_processor_pipelines` session config.\\nSimple select queries of type `SELECT ... FROM table ORDER BY cols LIMIT n` can\\nexperience significant CPU and performance improvement. ({issue}`602`)\", \"Add support for `FETCH FIRST` syntax. ({issue}`666`)\"], \"CLI\": [\"Make the final query time consistent with query stats. ({issue}`692`)\"], \"Hive connector\": [\"Ignore boolean column statistics when the count is `-1`. ({issue}`241`)\", \"Prevent failures for `information_schema` queries when a table has an invalid\\nstorage format. ({issue}`568`)\", \"Add support for assuming AWS role when accessing S3 or Glue. ({issue}`698`)\", \"Add support for coercions between `DECIMAL`, `DOUBLE`, and `REAL` for\\npartition and table schema mismatch. ({issue}`352`)\", \"Fix typo in Metastore recorder duration property name. ({issue}`711`)\"], \"PostgreSQL connector\": [\"Support for the `ARRAY` type has been disabled by default. ({issue}`687`)\"], \"Blackhole connector\": [\"Support having tables with same name in different Blackhole schemas. ({issue}`550`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 183]\"}, {\"title\": \"Release 311 (14 May 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for aggregation query that contains a `HAVING` clause but no\\n`GROUP BY` clause. ({issue}`733`)\", \"Fix rare error when moving already completed query to a new memory pool. ({issue}`725`)\", \"Fix leak in operator peak memory computations ({issue}`764`)\", \"Improve consistency of reported query statistics. ({issue}`773`)\", \"Add support for `OFFSET` syntax. ({issue}`732`)\", \"Print cost metrics using appropriate units in the output of `EXPLAIN`. ({issue}`68`)\", \"Add {func}`combinations` function. ({issue}`714`)\"], \"Hive connector\": [\"Add support for static AWS credentials for the Glue metastore. ({issue}`748`)\"], \"Cassandra connector\": [\"Support collections nested in other collections. ({issue}`657`)\", \"Automatically discover the Cassandra protocol version when the previously required\\n`cassandra.protocol-version` configuration property is not set. ({issue}`596`)\"], \"Black Hole connector\": [\"Fix rendering of tables and columns in plans. ({issue}`728`)\", \"Add table and column statistics. ({issue}`728`)\"], \"System connector\": [\"Add `system.metadata.table_comments` table that contains table comments. ({issue}`531`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 184]\"}, {\"title\": \"Release 312 (29 May 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for queries using `IS [NOT] DISTINCT FROM`. ({issue}`795`)\", \"Fix `array_distinct`, `array_intersect` semantics with respect to indeterminate\\nvalues (i.e., `NULL` or structural types containing `NULL`). ({issue}`559`)\", \"Fix failure when the largest negative `BIGINT` value (`-9223372036854775808`) is used\\nas a constant in a query. ({issue}`805`)\", \"Improve reliability for network errors when using Kerberos with\\n{doc}`/security/internal-communication`. ({issue}`838`)\", \"Improve performance of `JOIN` queries involving inline tables (`VALUES`). ({issue}`743`)\", \"Improve performance of queries containing duplicate expressions. ({issue}`730`)\", \"Improve performance of queries involving comparisons between values of different types. ({issue}`731`)\", \"Improve performance of queries containing redundant `ORDER BY` clauses in subqueries. This may\\naffect the semantics of queries that incorrectly rely on implementation-specific behavior. The\\nold behavior can be restored via the `skip_redundant_sort` session property or the\\n`optimizer.skip-redundant-sort` configuration property. ({issue}`818`)\", \"Improve performance of `IN` predicates that contain subqueries. ({issue}`767`)\", \"Improve support for correlated subqueries containing redundant `LIMIT` clauses. ({issue}`441`)\", \"Add a new {ref}`uuid-type` type to represent UUIDs. ({issue}`755`)\", \"Add {func}`uuid` function to generate random UUIDs. ({issue}`786`)\", \"Add Phoenix connector. ({issue}`672`)\", \"Make semantic error name available in client protocol. ({issue}`790`)\", \"Report operator statistics when `experimental.work-processor-pipelines`\\nis enabled. ({issue}`788`)\"], \"Server\": [\"Raise required Java version to 8u161. This version allows unlimited strength crypto. ({issue}`779`)\", \"Show JVM configuration hint when JMX agent fails to start on Java 9+. ({issue}`838`)\", \"Skip starting JMX agent on Java 9+ if it is already configured via JVM properties. ({issue}`838`)\", \"Support configuring TrustStore for {doc}`/security/internal-communication` using the\\n`internal-communication.https.truststore.path` and `internal-communication.https.truststore.key`\\nconfiguration properties. The path can point at a Java KeyStore or a PEM file. ({issue}`785`)\", \"Remove deprecated check for minimum number of workers before starting a coordinator. Use the\\n`query-manager.required-workers` and `query-manager.required-workers-max-wait` configuration\\nproperties instead. ({issue}`95`)\"], \"Hive connector\": [\"Fix `SHOW GRANTS` failure when metastore contains few tables. ({issue}`791`)\", \"Fix failure reading from `information_schema.table_privileges` table when metastore\\ncontains few tables. ({issue}`791`)\", \"Use Hive naming convention for file names when writing to bucketed tables. ({issue}`822`)\", \"Support new Hive bucketing conventions by allowing any number of files per bucket.\\nThis allows reading from partitions that were inserted into multiple times by Hive,\\nor were written to by Hive on Tez (which does not create files for empty buckets).\", \"Allow disabling the creation of files for empty buckets when writing data.\\nThis behavior is enabled by default for compatibility with previous versions of Presto,\\nbut can be disabled using the `hive.create-empty-bucket-files` configuration property\\nor the `create_empty_bucket_files` session property. ({issue}`822`)\"], \"MySQL connector\": [\"Map MySQL `json` type to Presto `json` type. ({issue}`824`)\"], \"PostgreSQL connector\": [\"Add support for PostgreSQL's `TIMESTAMP WITH TIME ZONE` data type. ({issue}`640`)\"], \"SPI\": [\"Add support for pushing `TABLESAMPLE` into connectors via the\\n`ConnectorMetadata.applySample()` method. ({issue}`753`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 185]\"}, {\"title\": \"Release 313 (31 May 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix leak in operator peak memory computations. ({issue}`843`)\", \"Fix incorrect results for queries involving `GROUPING SETS` and `LIMIT`. ({issue}`864`)\", \"Add compression and encryption support for {doc}`/admin/spill`. ({issue}`778`)\"], \"CLI\": [\"Fix failure when selecting a value of type {ref}`uuid-type`. ({issue}`854`)\"], \"JDBC driver\": [\"Fix failure when selecting a value of type {ref}`uuid-type`. ({issue}`854`)\"], \"Phoenix connector\": [\"Allow matching schema and table names case insensitively. This can be enabled by setting\\nthe `case-insensitive-name-matching` configuration property to true. ({issue}`872`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 186]\"}, {\"title\": \"Release 314 (7 Jun 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for `BETWEEN` involving `NULL` values. ({issue}`877`)\", \"Fix query history leak in coordinator. ({issue}`939`, {issue}`944`)\", \"Fix idle client timeout handling. ({issue}`947`)\", \"Improve performance of {func}`json_parse` function. ({issue}`904`)\", \"Visualize plan structure in `EXPLAIN` output. ({issue}`888`)\", \"Add support for positional access to `ROW` fields via the subscript\\noperator. ({issue}`860`)\"], \"CLI\": [\"Add JSON output format. ({issue}`878`)\"], \"Web UI\": [\"Fix queued queries counter in UI. ({issue}`894`)\"], \"Server RPM\": [\"Change default location of the `http-request.log` to `/var/log/presto`. Previously,\\nthe log would be located in `/var/lib/presto/data/var/log` by default. ({issue}`919`)\"], \"Hive connector\": [\"Fix listing tables and views from Hive 2.3+ Metastore on certain databases,\\nincluding Derby and Oracle. This fixes `SHOW TABLES`, `SHOW VIEWS` and\\nreading from `information_schema.tables` table. ({issue}`833`)\", \"Fix handling of Avro tables with `avro.schema.url` defined in Hive\\n`SERDEPROPERTIES`. ({issue}`898`)\", \"Fix regression that caused ORC bloom filters to be ignored. ({issue}`921`)\", \"Add support for reading LZ4 and ZSTD compressed Parquet data. ({issue}`910`)\", \"Add support for writing ZSTD compressed ORC data. ({issue}`910`)\", \"Add support for configuring ZSTD and LZ4 as default compression methods via the\\n`hive.compression-codec` configuration option. ({issue}`910`)\", \"Do not allow inserting into text format tables that have a header or footer. ({issue}`891`)\", \"Add `textfile_skip_header_line_count` and `textfile_skip_footer_line_count` table properties\\nfor text format tables that specify the number of header and footer lines. ({issue}`845`)\", \"Add `hive.max-splits-per-second` configuration property to allow throttling\\nthe split discovery rate, which can reduce load on the file system. ({issue}`534`)\", \"Support overwriting unpartitioned tables for insert queries. ({issue}`924`)\"], \"PostgreSQL connector\": [\"Support PostgreSQL arrays declared using internal type\\nname, for example `_int4` (rather than `int[]`). ({issue}`659`)\"], \"Elasticsearch connector\": [\"Add support for mixed-case field names. ({issue}`887`)\"], \"Base-JDBC connector library\": [\"Allow connectors to customize how they store `NULL` values. ({issue}`918`)\"], \"SPI\": [\"Expose the SQL text of the executed prepared statement to `EventListener`. ({issue}`908`)\", \"Deprecate table layouts for `ConnectorMetadata.makeCompatiblePartitioning()`. ({issue}`689`)\", \"Add support for delete pushdown into connectors via the `ConnectorMetadata.applyDelete()`\\nand `ConnectorMetadata.executeDelete()` methods. ({issue}`689`)\", \"Allow connectors without distributed tables. ({issue}`893`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 187]\"}, {\"title\": \"Release 315 (14 Jun 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results when dividing certain decimal numbers. ({issue}`958`)\", \"Add support for `FETCH FIRST ... WITH TIES` syntax. ({issue}`832`)\", \"Add locality awareness to default split scheduler. ({issue}`680`)\", \"Add {func}`format` function. ({issue}`548`)\"], \"Server RPM\": [\"Require JDK version 8u161+ during installation, which is the version the server requires. ({issue}`983`)\"], \"CLI\": [\"Fix alignment of nulls for numeric columns in aligned output format. ({issue}`871`)\"], \"Hive connector\": [\"Fix regression in partition pruning for certain query shapes. ({issue}`984`)\", \"Correctly identify EMRFS as S3 when deciding to use a temporary location for writes. ({issue}`935`)\", \"Allow creating external tables on S3 even if the location does not exist. ({issue}`935`)\", \"Add support for UTF-8 ORC bloom filters. ({issue}`914`)\", \"Add support for `DATE`, `TIMESTAMP` and `REAL` in ORC bloom filters. ({issue}`967`)\", \"Disable usage of old, non UTF-8, ORC bloom filters for `VARCHAR` and `CHAR`. ({issue}`914`)\", \"Allow logging all calls to Hive Thrift metastore service. This can be enabled\\nby turning on `DEBUG` logging for\\n`io.prestosql.plugin.hive.metastore.thrift.ThriftHiveMetastoreClient`. ({issue}`946`)\"], \"MongoDB connector\": [\"Fix query failure when `ROW` with an `ObjectId` field is used as a join key. ({issue}`933`)\", \"Add cast from `ObjectId` to `VARCHAR`. ({issue}`933`)\"], \"SPI\": [\"Allow connectors to provide view definitions. `ConnectorViewDefinition` now contains\\nthe real view definition rather than an opaque blob. Connectors that support view storage\\ncan use the JSON representation of that class as a stable storage format. The JSON\\nrepresentation is the same as the previous opaque blob, thus all existing view\\ndefinitions will continue to work. ({issue}`976`)\", \"Add `getView()` method to `ConnectorMetadata` as a replacement for `getViews()`.\\nThe `getViews()` method now exists only as an optional method for connectors that\\ncan efficiently support bulk retrieval of views and has a different signature. ({issue}`976`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 188]\"}, {\"title\": \"Release 316 (8 Jul 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix `date_format` function failure when format string contains non-ASCII\\ncharacters. ({issue}`1056`)\", \"Improve performance of queries using `UNNEST`. ({issue}`901`)\", \"Improve error message when statement parsing fails. ({issue}`1042`)\"], \"CLI\": [\"Fix refresh of completion cache when catalog or schema is changed. ({issue}`1016`)\", \"Allow reading password from console when stdout is a pipe. ({issue}`982`)\"], \"Hive connector\": [\"Acquire S3 credentials from the default AWS locations if not configured explicitly. ({issue}`741`)\", \"Only allow using roles and grants with SQL standard based authorization. ({issue}`972`)\", \"Add support for `CSV` file format. ({issue}`920`)\", \"Support reading from and writing to Hadoop encryption zones (Hadoop KMS). ({issue}`997`)\", \"Collect column statistics on write by default. This can be disabled using the\\n`hive.collect-column-statistics-on-write` configuration property or the\\n`collect_column_statistics_on_write` session property. ({issue}`981`)\", \"Eliminate unused idle threads when using the metastore cache. ({issue}`1061`)\"], \"PostgreSQL connector\": [\"Add support for columns of type `UUID`. ({issue}`1011`)\", \"Export JMX statistics for various JDBC and connector operations. ({issue}`906`).\"], \"MySQL connector\": [\"Export JMX statistics for various JDBC and connector operations. ({issue}`906`).\"], \"Redshift connector\": [\"Export JMX statistics for various JDBC and connector operations. ({issue}`906`).\"], \"SQL Server connector\": [\"Export JMX statistics for various JDBC and connector operations. ({issue}`906`).\"], \"TPC-H connector\": [\"Fix `SHOW TABLES` failure when used with a hidden schema. ({issue}`1005`)\"], \"TPC-DS connector\": [\"Fix `SHOW TABLES` failure when used with a hidden schema. ({issue}`1005`)\"], \"SPI\": [\"Add support for pushing simple column and row field reference expressions into\\nconnectors via the `ConnectorMetadata.applyProjection()` method. ({issue}`676`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 189]\"}, {\"title\": \"Release 317 (1 Aug 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix {func}`url_extract_parameter` when the query string contains an encoded `&` or `=` character.\", \"Export MBeans from the `db` resource group configuration manager. ({issue}`1151`)\", \"Add {func}`all_match`, {func}`any_match`, and {func}`none_match` functions. ({issue}`1045`)\", \"Add support for fractional weights in {func}`approx_percentile`. ({issue}`1168`)\", \"Add support for node dynamic filtering for semi-joins and filters when the experimental\\nWorkProcessor pipelines feature is enabled. ({issue}`1075`, {issue}`1155`, {issue}`1119`)\", \"Allow overriding session time zone for clients via the\\n`sql.forced-session-time-zone` configuration property. ({issue}`1164`)\"], \"Web UI\": [\"Fix tooltip visibility on stage performance details page. ({issue}`1113`)\", \"Add planning time to query details page. ({issue}`1115`)\"], \"Security\": [\"Allow schema owner to create, drop, and rename schema when using file-based\\nconnector access control. ({issue}`1139`)\", \"Allow respecting the `X-Forwarded-For` header when retrieving the IP address\\nof the client submitting the query. This information is available in the\\n`remoteClientAddress` field of the `QueryContext` class for query events.\\nThe behavior can be controlled via the `dispatcher.forwarded-header`\\nconfiguration property, as the header should only be used when the Presto\\ncoordinator is behind a proxy. ({issue}`1033`)\"], \"JDBC driver\": [\"Fix `DatabaseMetaData.getURL()` to include the `jdbc:` prefix. ({issue}`1211`)\"], \"Elasticsearch connector\": [\"Add support for nested fields. ({issue}`1001`)\"], \"Hive connector\": [\"Fix bucketing version safety check to correctly disallow writes\\nto tables that use an unsupported bucketing version. ({issue}`1199`)\", \"Fix metastore error handling when metastore debug logging is enabled. ({issue}`1152`)\", \"Improve performance of file listings in `system.sync_partition_metadata` procedure,\\nespecially for S3. ({issue}`1093`)\"], \"Kudu connector\": [\"Update Kudu client library version to `1.10.0`. ({issue}`1086`)\"], \"MongoDB connector\": [\"Allow passwords to contain the `:` or `@` characters. ({issue}`1094`)\"], \"PostgreSQL connector\": [\"Add support for reading `hstore` data type. ({issue}`1101`)\"], \"SPI\": [\"Allow delete to be implemented for non-legacy connectors. ({issue}`1015`)\", \"Remove deprecated method from `ConnectorPageSourceProvider`. ({issue}`1095`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 190]\"}, {\"title\": \"Release 318 (26 Aug 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix query failure when using `DISTINCT FROM` with the `UUID` or\\n`IPADDRESS` types. ({issue}`1180`)\", \"Improve query performance when `optimize_hash_generation` is enabled. ({issue}`1071`)\", \"Improve performance of information schema tables. ({issue}`999`, {issue}`1306`)\", \"Rename `http.server.authentication.*` configuration options to `http-server.authentication.*`. ({issue}`1270`)\", \"Change query CPU tracking for resource groups to update periodically while\\nthe query is running. Previously, CPU usage would only update at query\\ncompletion. This improves resource management fairness when using\\nCPU-limited resource groups. ({issue}`1128`)\", \"Remove `distributed_planning_time_ms` column from `system.runtime.queries`. ({issue}`1084`)\", \"Add support for `Asia/Qostanay` time zone. ({issue}`1221`)\", \"Add session properties that allow overriding the query per-node memory limits:\\n`query_max_memory_per_node` and `query_max_total_memory_per_node`. These properties\\ncan be used to decrease limits for a query, but not to increase them. ({issue}`1212`)\", \"Add {doc}`/connector/googlesheets`. ({issue}`1030`)\", \"Add `planning_time_ms` column to the `system.runtime.queries` table that shows\\nthe time spent on query planning. This is the same value that used to be in the\\n`analysis_time_ms` column, which was a misnomer. ({issue}`1084`)\", \"Add {func}`last_day_of_month` function. ({issue}`1295`)\", \"Add support for cancelling queries via the `system.runtime.kill_query` procedure when\\nthey are in the queue or in the semantic analysis stage. ({issue}`1079`)\", \"Add queries that are in the queue or in the semantic analysis stage to the\\n`system.runtime.queries` table. ({issue}`1079`)\"], \"Web UI\": [\"Display information about queries that are in the queue or in the semantic analysis\\nstage. ({issue}`1079`)\", \"Add support for cancelling queries that are in the queue or in the semantic analysis\\nstage. ({issue}`1079`)\"], \"Hive connector\": [\"Fix query failure due to missing credentials while writing empty bucket files. ({issue}`1298`)\", \"Fix bucketing of `NaN` values of `real` type. Previously `NaN` values\\ncould be assigned a wrong bucket. ({issue}`1336`)\", \"Fix reading `RCFile` collection delimiter set by Hive version earlier than 3.0. ({issue}`1321`)\", \"Return proper error when selecting `\\\"$bucket\\\"` column from a table using\\nHive bucketing v2. ({issue}`1336`)\", \"Improve performance of S3 object listing. ({issue}`1232`)\", \"Improve performance when reading data from GCS. ({issue}`1200`)\", \"Add support for reading data from S3 Requester Pays buckets. This can be enabled\\nusing the `hive.s3.requester-pays.enabled` configuration property. ({issue}`1241`)\", \"Allow inserting into bucketed, unpartitioned tables. ({issue}`1127`)\", \"Allow inserting into existing partitions of bucketed, partitioned tables. ({issue}`1347`)\"], \"PostgreSQL connector\": [\"Add support for providing JDBC credential in a separate file. This can be enabled by\\nsetting the `credential-provider.type=FILE` and `connection-credential-file`\\nconfig options in the catalog properties file. ({issue}`1124`)\", \"Allow logging all calls to `JdbcClient`. This can be enabled by turning\\non `DEBUG` logging for `io.prestosql.plugin.jdbc.JdbcClient`. ({issue}`1274`)\", \"Add possibility to force mapping of certain types to `varchar`. This can be enabled\\nby setting `jdbc-types-mapped-to-varchar` to comma-separated list of type names. ({issue}`186`)\", \"Add support for PostgreSQL `timestamp[]` type. ({issue}`1023`, {issue}`1262`, {issue}`1328`)\"], \"MySQL connector\": [\"Add support for providing JDBC credential in a separate file. This can be enabled by\\nsetting the `credential-provider.type=FILE` and `connection-credential-file`\\nconfig options in the catalog properties file. ({issue}`1124`)\", \"Allow logging all calls to `JdbcClient`. This can be enabled by turning\\non `DEBUG` logging for `io.prestosql.plugin.jdbc.JdbcClient`. ({issue}`1274`)\", \"Add possibility to force mapping of certain types to `varchar`. This can be enabled\\nby setting `jdbc-types-mapped-to-varchar` to comma-separated list of type names. ({issue}`186`)\"], \"Redshift connector\": [\"Add support for providing JDBC credential in a separate file. This can be enabled by\\nsetting the `credential-provider.type=FILE` and `connection-credential-file`\\nconfig options in the catalog properties file. ({issue}`1124`)\", \"Allow logging all calls to `JdbcClient`. This can be enabled by turning\\non `DEBUG` logging for `io.prestosql.plugin.jdbc.JdbcClient`. ({issue}`1274`)\", \"Add possibility to force mapping of certain types to `varchar`. This can be enabled\\nby setting `jdbc-types-mapped-to-varchar` to comma-separated list of type names. ({issue}`186`)\"], \"SQL Server connector\": [\"Add support for providing JDBC credential in a separate file. This can be enabled by\\nsetting the `credential-provider.type=FILE` and `connection-credential-file`\\nconfig options in the catalog properties file. ({issue}`1124`)\", \"Allow logging all calls to `JdbcClient`. This can be enabled by turning\\non `DEBUG` logging for `io.prestosql.plugin.jdbc.JdbcClient`. ({issue}`1274`)\", \"Add possibility to force mapping of certain types to `varchar`. This can be enabled\\nby setting `jdbc-types-mapped-to-varchar` to comma-separated list of type names. ({issue}`186`)\"], \"SPI\": [\"Add `Block.isLoaded()` method. ({issue}`1216`)\", \"Update security APIs to accept the new `ConnectorSecurityContext`\\nand `SystemSecurityContext` classes. ({issue}`171`)\", \"Allow connectors to override minimal schedule split batch size. ({issue}`1251`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 191]\"}, {\"title\": \"Release 319 (22 Sep 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure for queries involving `UNION` and `DISTINCT` aggregates. ({issue}`1510`)\", \"Fix excessive runtime when parsing expressions involving `CASE`. ({issue}`1407`)\", \"Fix fragment output size in `EXPLAIN ANALYZE` output. ({issue}`1345`)\", \"Fix a rare failure when running `EXPLAIN ANALYZE` on a query containing\\nwindow functions. ({issue}`1401`)\", \"Fix failure when querying `/v1/resourceGroupState` endpoint for non-existing resource\\ngroup. ({issue}`1368`)\", \"Fix incorrect results when reading `information_schema.table_privileges` with\\nan equality predicate on `table_name` but without a predicate on `table_schema`.\\n({issue}`1534`)\", \"Fix planning failure due to coercion handling for correlated subqueries. ({issue}`1453`)\", \"Improve performance of queries against `information_schema` tables. ({issue}`1329`)\", \"Reduce metadata querying during planning. ({issue}`1308`, {issue}`1455`)\", \"Improve performance of certain queries involving coercions and complex expressions in `JOIN`\\nconditions. ({issue}`1390`)\", \"Include cost estimates in output of `EXPLAIN (TYPE IO)`. ({issue}`806`)\", \"Improve support for correlated subqueries involving `ORDER BY` or `LIMIT`. ({issue}`1415`)\", \"Improve performance of certain `JOIN` queries when automatic join ordering is enabled. ({issue}`1431`)\", \"Allow setting the default session catalog and schema via the `sql.default-catalog`\\nand `sql.default-schema` configuration properties. ({issue}`1524`)\", \"Add support for `IGNORE NULLS` for window functions. ({issue}`1244`)\", \"Add support for `INNER` and `OUTER` joins involving `UNNEST`. ({issue}`1522`)\", \"Rename `legacy` and `flat` {doc}`scheduler policies </admin/properties-node-scheduler>` to\\n`uniform` and `topology` respectively. These can be configured via the `node-scheduler.policy`\\nconfiguration property. ({issue}`10491`)\", \"Add `file` {doc}`network topology provider </admin/properties-node-scheduler>` which can be configured\\nvia the `node-scheduler.network-topology.type` configuration property. ({issue}`1500`)\", \"Add support for `SphericalGeography` to {func}`ST_Length`. ({issue}`1551`)\"], \"Security\": [\"Allow configuring read-only access in {doc}`/security/built-in-system-access-control`. ({issue}`1153`)\", \"Add missing checks for schema create, rename, and drop in file-based `SystemAccessControl`. ({issue}`1153`)\", \"Allow authentication over HTTP for forwarded requests containing the\\n`X-Forwarded-Proto` header. This is disabled by default, but can be enabled using the\\n`http-server.authentication.allow-forwarded-https` configuration property. ({issue}`1442`)\"], \"Web UI\": [\"Fix rendering bug in Query Timeline resulting in inconsistency of presented information after\\nquery finishes. ({issue}`1371`)\", \"Show total memory in Query Timeline instead of user memory. ({issue}`1371`)\"], \"CLI\": [\"Add `--insecure` option to skip validation of server certificates for debugging. ({issue}`1484`)\"], \"Hive connector\": [\"Fix reading from `information_schema`, as well as `SHOW SCHEMAS`, `SHOW TABLES`, and\\n`SHOW COLUMNS` when connecting to a Hive 3.x metastore that contains an `information_schema`\\nschema. ({issue}`1192`)\", \"Improve performance when reading data from GCS. ({issue}`1443`)\", \"Allow accessing tables in Glue metastore that do not have a table type. ({issue}`1343`)\", \"Add support for Azure Data Lake (`adl`) file system. ({issue}`1499`)\", \"Allow using custom S3 file systems by relying on the default Hadoop configuration by specifying\\n`HADOOP_DEFAULT` for the `hive.s3-file-system-type` configuration property. ({issue}`1397`)\", \"Add support for instance credentials for the Glue metastore via the\\n`hive.metastore.glue.use-instance-credentials` configuration property. ({issue}`1363`)\", \"Add support for custom credentials providers for the Glue metastore via the\\n`hive.metastore.glue.aws-credentials-provider` configuration property. ({issue}`1363`)\", \"Do not require setting the `hive.metastore-refresh-interval` configuration property\\nwhen enabling metastore caching. ({issue}`1473`)\", \"Add `textfile_field_separator` and `textfile_field_separator_escape` table properties\\nto support custom field separators for `TEXTFILE` format tables. ({issue}`1439`)\", \"Add `$file_size` and `$file_modified_time` hidden columns. ({issue}`1428`)\", \"The `hive.metastore-timeout` configuration property is now accepted only when using the\\nThrift metastore. Previously, it was accepted for other metastore type, but was\\nignored. ({issue}`1346`)\", \"Disallow reads from transactional tables. Previously, reads would appear to work,\\nbut would not return any data. ({issue}`1218`)\", \"Disallow writes to transactional tables. Previously, writes would appear to work,\\nbut the data would be written incorrectly. ({issue}`1218`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 192]\"}, {\"title\": \"Release 320 (10 Oct 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect parameter binding order for prepared statement execution when\\nparameters appear inside a `WITH` clause. ({issue}`1191`)\", \"Fix planning failure for certain queries involving a mix of outer and\\ncross joins. ({issue}`1589`)\", \"Improve performance of queries containing complex predicates. ({issue}`1515`)\", \"Avoid unnecessary evaluation of redundant filters. ({issue}`1516`)\", \"Improve performance of certain window functions when using bounded window\\nframes (e.g., `ROWS BETWEEN ... PRECEDING AND ... FOLLOWING`). ({issue}`464`)\", \"Add Kinesis connector. ({issue}`476`)\", \"Add {func}`geometry_from_hadoop_shape`. ({issue}`1593`)\", \"Add {func}`at_timezone`. ({issue}`1612`)\", \"Add {func}`with_timezone`. ({issue}`1612`)\"], \"JDBC driver\": [\"Only report warnings on `Statement`, not `ResultSet`, as warnings\\nare not associated with reads of the `ResultSet`. ({issue}`1640`)\"], \"CLI\": [\"Add multi-line editing and syntax highlighting. ({issue}`1380`)\"], \"Hive connector\": [\"Add impersonation support for calls to the Hive metastore. This can be enabled using the\\n`hive.metastore.thrift.impersonation.enabled` configuration property. ({issue}`43`)\", \"Add caching support for Glue metastore. ({issue}`1625`)\", \"Add separate configuration property `hive.hdfs.socks-proxy` for accessing HDFS via a\\nSOCKS proxy. Previously, it was controlled with the `hive.metastore.thrift.client.socks-proxy`\\nconfiguration property. ({issue}`1469`)\"], \"MySQL connector\": [\"Add `mysql.jdbc.use-information-schema` configuration property to control whether\\nthe MySQL JDBC driver should use the MySQL `information_schema` to answer metadata\\nqueries. This may be helpful when diagnosing problems. ({issue}`1598`)\"], \"PostgreSQL connector\": [\"Add support for reading PostgreSQL system tables, e.g., `pg_catalog` relations.\\nThe functionality is disabled by default and can be enabled using the\\n`postgresql.include-system-tables` configuration property. ({issue}`1527`)\"], \"Elasticsearch connector\": [\"Add support for `VARBINARY`, `TIMESTAMP`, `TINYINT`, `SMALLINT`,\\nand `REAL` data types. ({issue}`1639`)\", \"Discover available tables and their schema dynamically. ({issue}`1639`)\", \"Add support for special `_id`, `_score` and `_source` columns. ({issue}`1639`)\", \"Add support for {ref}`full text queries <elasticsearch-full-text-queries>`. ({issue}`1662`)\"], \"SPI\": [\"Introduce a builder for `Identity` and deprecate its public constructors. ({issue}`1624`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 193]\"}, {\"title\": \"Release 321 (15 Oct 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect result of {func}`round` when applied to a `tinyint`, `smallint`,\\n`integer`, or `bigint` type with negative decimal places. ({issue}`42`)\", \"Improve performance of queries with `LIMIT` over `information_schema` tables. ({issue}`1543`)\", \"Improve performance for broadcast joins by using dynamic filtering. This can be enabled\\nvia the `experimental.enable-dynamic-filtering` configuration option or the\\n`enable_dynamic_filtering` session property. ({issue}`1686`)\"], \"Security\": [\"Improve the security of query results with one-time tokens. ({issue}`1654`)\"], \"Hive connector\": [\"Fix reading `TEXT` file collection delimiter set by Hive versions earlier\\nthan 3.0. ({issue}`1714`)\", \"Fix a regression that prevented Presto from using the AWS Glue metastore. ({issue}`1698`)\", \"Allow skipping header or footer lines for `CSV` format tables via the\\n`skip_header_line_count` and `skip_footer_line_count` table properties. ({issue}`1090`)\", \"Rename table property `textfile_skip_header_line_count` to `skip_header_line_count`\\nand `textfile_skip_footer_line_count` to `skip_footer_line_count`. ({issue}`1090`)\", \"Add support for LZOP compressed (`.lzo`) files. Previously, queries accessing LZOP compressed\\nfiles would fail, unless all files were small. ({issue}`1701`)\", \"Add support for bucket-aware read of tables using bucketing version 2. ({issue}`538`)\", \"Add support for writing to tables using bucketing version 2. ({issue}`538`)\", \"Allow caching directory listings for all tables or schemas. ({issue}`1668`)\", \"Add support for dynamic filtering for broadcast joins. ({issue}`1686`)\"], \"PostgreSQL connector\": [\"Support reading PostgreSQL arrays as the `JSON` data type. This can be enabled by\\nsetting the `postgresql.experimental.array-mapping` configuration property or the\\n`array_mapping` catalog session property to `AS_JSON`. ({issue}`682`)\"], \"Elasticsearch connector\": [\"Add support for Amazon Elasticsearch Service. ({issue}`1693`)\"], \"Cassandra connector\": [\"Add TLS support. ({issue}`1680`)\"], \"JMX connector\": [\"Add support for wildcards in configuration of history tables. ({issue}`1572`)\"], \"SPI\": [\"Fix `QueryStatistics.getWallTime()` to report elapsed time rather than total\\nscheduled time. ({issue}`1719`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 194]\"}, {\"title\": \"Release 322 (16 Oct 2019)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of certain join queries by reducing the amount of data\\nthat needs to be scanned. ({issue}`1673`)\"], \"Server RPM\": [\"Fix a regression that caused zero-length files in the RPM. ({issue}`1767`)\"], \"Other connectors\": \"These changes apply to MySQL, PostgreSQL, Redshift, and SQL Server.\\n\\n['Add support for providing credentials using a keystore file. This can be enabled\\\\nby setting the `credential-provider.type` configuration property to `KEYSTORE`\\\\nand by setting the `keystore-file-path`, `keystore-type`, `keystore-password`,\\\\n`keystore-user-credential-password`, `keystore-password-credential-password`,\\\\n`keystore-user-credential-name`, and `keystore-password-credential-name`\\\\nconfiguration properties. ({issue}`1521`)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 195]\"}, {\"title\": \"Release 323 (23 Oct 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix query failure when referencing columns from a table that contains\\nhidden columns. ({issue}`1796`)\", \"Fix a rare issue in which the server produces an extra row containing\\nthe boolean value `true` as the last row in the result set. For most queries,\\nthis will result in a client error, since this row does not match the result\\nschema, but is a correctness issue when the result schema is a single boolean\\ncolumn. ({issue}`1732`)\", \"Allow using `.*` on expressions of type `ROW` in the `SELECT` clause to\\nconvert the fields of a row into multiple columns. ({issue}`1017`)\"], \"JDBC driver\": [\"Fix a compatibility issue when connecting to pre-321 servers. ({issue}`1785`)\", \"Fix reporting of views in `DatabaseMetaData.getTables()`. ({issue}`1488`)\"], \"CLI\": [\"Fix a compatibility issue when connecting to pre-321 servers. ({issue}`1785`)\"], \"Hive\": [\"Fix the ORC writer to correctly write the file footers. Previously written files were\\nsometimes unreadable in Hive 3.1 when querying the table for a second (or subsequent)\\ntime. ({issue}`456`)\", \"Prevent writing to materialized views. ({issue}`1725`)\", \"Reduce metastore load when inserting data or analyzing tables. ({issue}`1783`, {issue}`1793`, {issue}`1794`)\", \"Allow using multiple Hive catalogs that use different Kerberos or other authentication\\nconfigurations. ({issue}`760`, {issue}`978`, {issue}`1820`)\"], \"PostgreSQL\": [\"Support for PostgreSQL arrays is no longer considered experimental, therefore\\nthe configuration property `postgresql.experimental.array-mapping` is now named\\nto `postgresql.array-mapping`. ({issue}`1740`)\"], \"SPI\": [\"Add support for unnesting dictionary blocks duration compaction. ({issue}`1761`)\", \"Change `LazyBlockLoader` to directly return the loaded block. ({issue}`1744`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 196]\"}, {\"title\": \"Release 324 (1 Nov 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix query failure when `CASE` operands have different types. ({issue}`1825`)\", \"Add support for `ESCAPE` clause in `SHOW CATALOGS LIKE ...`. ({issue}`1691`)\", \"Add {func}`line_interpolate_point` and {func}`line_interpolate_points`. ({issue}`1888`)\", \"Allow references to tables in the enclosing query when using `.*`. ({issue}`1867`)\", \"Configuration properties for optimizer and spill support no longer\\nhave `experimental.` prefix. ({issue}`1875`)\", \"Configuration property `experimental.reserved-pool-enabled` was renamed to\\n`experimental.reserved-pool-disabled` (with meaning reversed). ({issue}`1916`)\"], \"Security\": [\"Perform access control checks when displaying table or view definitions\\nwith `SHOW CREATE`. ({issue}`1517`)\"], \"Hive\": [\"Allow using `SHOW GRANTS` on a Hive view when using the `sql-standard`\\nsecurity mode. ({issue}`1842`)\", \"Improve performance when filtering dictionary-encoded Parquet columns. ({issue}`1846`)\"], \"PostgreSQL\": [\"Add support for inserting `MAP(VARCHAR, VARCHAR)` values into columns of\\n`hstore` type. ({issue}`1894`)\"], \"Elasticsearch\": [\"Fix failure when reading datetime columns in Elasticsearch 5.x. ({issue}`1844`)\", \"Add support for mixed-case field names. ({issue}`1914`)\"], \"SPI\": [\"Introduce a builder for `ColumnMetadata`. The various overloaded constructors\\nare now deprecated. ({issue}`1891`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 197]\"}, {\"title\": \"Release 325 (14 Nov 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for certain queries involving `FULL` or `RIGHT` joins and\\n`LATERAL`. ({issue}`1952`)\", \"Fix incorrect results when using `IS DISTINCT FROM` on columns of `DECIMAL` type\\nwith precision larger than 18. ({issue}`1985`)\", \"Fix query failure when row types contain a field named after a reserved SQL keyword. ({issue}`1963`)\", \"Add support for `LIKE` predicate to `SHOW SESSION` and `SHOW FUNCTIONS`. ({issue}`1688`, {issue}`1692`)\", \"Add support for late materialization to join operations. ({issue}`1256`)\", \"Reduce number of metadata queries during planning.\\nThis change disables stats collection for non-`EXPLAIN` queries. If you\\nwant to have access to such stats and cost in query completion events, you\\nneed to re-enable stats collection using the `collect-plan-statistics-for-all-queries`\\nconfiguration property. ({issue}`1866`)\", \"Add variant of {func}`strpos` that returns the Nth occurrence of a substring. ({issue}`1811`)\", \"Add {func}`to_encoded_polyline` and {func}`from_encoded_polyline` geospatial functions. ({issue}`1827`)\"], \"Web UI\": [\"Show actual query for an `EXECUTE` statement. ({issue}`1980`)\"], \"Hive\": [\"Fix incorrect behavior of `CREATE TABLE` when Hive metastore is configured\\nwith `metastore.create.as.acid` set to `true`. ({issue}`1958`)\", \"Fix query failure when reading Parquet files that contain character data without statistics. ({issue}`1955`)\", \"Allow analyzing a subset of table columns (rather than all columns). ({issue}`1907`)\", \"Support overwriting unpartitioned tables for insert queries when using AWS Glue. ({issue}`1243`)\", \"Add support for reading Parquet files where the declared precision of decimal columns does not match\\nthe precision in the table or partition schema. ({issue}`1949`)\", \"Improve performance when reading Parquet files with small row groups. ({issue}`1925`)\"], \"Other connectors\": \"These changes apply to the MySQL, PostgreSQL, Redshift, and SQL Server connectors.\\n\\n['Fix incorrect insertion of data when the target table has an unsupported type. ({issue}`1930`)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 198]\"}, {\"title\": \"Release 326 (27 Nov 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect query results when query contains `LEFT JOIN` over `UNNEST`. ({issue}`2097`)\", \"Fix performance regression in queries involving `JOIN`. ({issue}`2047`)\", \"Fix accounting of semantic analysis time when queued queries are cancelled. ({issue}`2055`)\", \"Add {doc}`/connector/singlestore`. ({issue}`1906`)\", \"Improve performance of `INSERT` and `CREATE TABLE ... AS` queries containing redundant\\n`ORDER BY` clauses. ({issue}`2044`)\", \"Improve performance when processing columns of `map` type. ({issue}`2015`)\"], \"Server RPM\": [\"Allow running Presto with {ref}`Java 11 or above <requirements-java>`. ({issue}`2057`)\"], \"Security\": [\"Deprecate Kerberos in favor of JWT for {doc}`/security/internal-communication`. ({issue}`2032`)\"], \"Hive\": [\"Fix table creation error for tables with S3 location when using `file` metastore. ({issue}`1664`)\", \"Fix a compatibility issue with the CDH 5.x metastore which results in stats\\nnot being recorded for {doc}`/sql/analyze`. ({issue}`973`)\", \"Improve performance for Glue metastore by fetching partitions in parallel. ({issue}`1465`)\", \"Improve performance of `sql-standard` security. ({issue}`1922`, {issue}`1929`)\"], \"Phoenix connector\": [\"Collect statistics on the count and duration of each call to Phoenix. ({issue}`2024`)\"], \"Other connectors\": \"These changes apply to the MySQL, PostgreSQL, Redshift, and SQL Server connectors.\\n\\n['Collect statistics on the count and duration of operations to create\\\\nand destroy `JDBC` connections. ({issue}`2024`)', 'Add support for showing column comments. ({issue}`1840`)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 199]\"}, {\"title\": \"Release 327 (20 Dec 2019)\", \"description\": null, \"content\": {\"General\": [\"Fix join query failure when late materialization is enabled. ({issue}`2144`)\", \"Fix failure of {func}`word_stem` for certain inputs. ({issue}`2145`)\", \"Fix query failure when using `transform_values()` inside `try()` and the transformation fails\\nfor one of the rows. ({issue}`2315`)\", \"Fix potential incorrect results for aggregations involving `FILTER (WHERE ...)`\\nwhen the condition is a reference to a table column. ({issue}`2267`)\", \"Allow renaming views with {doc}`/sql/alter-view`. ({issue}`1060`)\", \"Add `error_type` and `error_code` columns to `system.runtime.queries`. ({issue}`2249`)\", \"Rename `experimental.work-processor-pipelines` configuration property to `experimental.late-materialization.enabled`\\nand rename `work_processor_pipelines` session property to `late_materialization`. ({issue}`2275`)\"], \"Security\": [\"Allow using multiple system access controls. ({issue}`2178`)\", \"Add {doc}`/security/password-file`. ({issue}`797`)\"], \"Hive connector\": [\"Fix incorrect query results when reading `timestamp` values from ORC files written by\\nHive 3.1 or later. ({issue}`2099`)\", \"Fix a CDH 5.x metastore compatibility issue resulting in failure when analyzing or inserting\\ninto a table with `date` columns. ({issue}`556`)\", \"Reduce number of metastore calls when fetching partitions. ({issue}`1921`)\", \"Support reading from insert-only transactional tables. ({issue}`576`)\", \"Deprecate `parquet.fail-on-corrupted-statistics` (previously known as `hive.parquet.fail-on-corrupted-statistics`).\\nSetting this configuration property to `false` may hide correctness issues, leading to incorrect query results.\\nSession property `parquet_fail_with_corrupted_statistics` is deprecated as well.\\nBoth configuration and session properties will be removed in a future version. ({issue}`2129`)\", \"Improve concurrency when updating table or partition statistics. ({issue}`2154`)\", \"Add support for renaming views. ({issue}`2189`)\", \"Allow configuring the `hive.orc.use-column-names` config property on a per-session\\nbasis using the `orc_use_column_names` session property. ({issue}`2248`)\"], \"Kudu connector\": [\"Support predicate pushdown for the `decimal` type. ({issue}`2131`)\", \"Fix column position swap for delete operations that may result in deletion of the wrong records. ({issue}`2252`)\", \"Improve predicate pushdown for queries that match a column against\\nmultiple values (typically using the `IN` operator). ({issue}`2253`)\"], \"MongoDB connector\": [\"Add support for reading from views. ({issue}`2156`)\"], \"PostgreSQL connector\": [\"Allow converting unsupported types to `VARCHAR` by setting the session property\\n`unsupported_type_handling` or configuration property `unsupported-type-handling`\\nto `CONVERT_TO_VARCHAR`. ({issue}`1182`)\"], \"MySQL connector\": [\"Fix `INSERT` query failure when `GTID` mode is enabled. ({issue}`2251`)\"], \"Elasticsearch connector\": [\"Improve performance for queries involving equality and range filters\\nover table columns. ({issue}`2310`)\"], \"Google Sheets connector\": [\"Fix incorrect results when listing tables in `information_schema`. ({issue}`2118`)\"], \"SPI\": [\"Add `executionTime` to `QueryStatistics` for event listeners. ({issue}`2247`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 200]\"}, {\"title\": \"Release 328 (10 Jan 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix correctness issue for certain correlated join queries when the correlated subquery on\\nthe right produces no rows. ({issue}`1969`)\", \"Fix incorrect handling of multi-byte characters for {doc}`/functions/regexp` when\\nthe pattern is empty. ({issue}`2313`)\", \"Fix failure when join criteria contains columns of different types. ({issue}`2320`)\", \"Fix failure for complex outer join queries when dynamic filtering is enabled. ({issue}`2363`)\", \"Improve support for correlated queries. ({issue}`1969`)\", \"Allow inserting values of a larger type into as smaller type when the values fit. For example,\\n`BIGINT` into `SMALLINT`, or `VARCHAR(10)` into `VARCHAR(3)`. Values that don't fit will\\ncause an error at runtime. ({issue}`2061`)\", \"Add {func}`regexp_count` and {func}`regexp_position` functions. ({issue}`2136`)\", \"Add support for interpolating {doc}`/security/secrets` in server and catalog configuration\\nfiles. ({issue}`2370`)\"], \"Security\": [\"Fix a security issue allowing users to gain unauthorized access to Presto cluster\\nwhen using password authenticator with LDAP. ({issue}`2356`)\", \"Add support for LDAP referrals in LDAP password authenticator. ({issue}`2354`)\"], \"JDBC driver\": [\"Fix behavior of `java.sql.Connection#commit()` and `java.sql.Connection#rollback()`\\nmethods when no statements performed in a transaction. Previously, these methods\\nwould fail. ({issue}`2339`)\", \"Fix failure when restoring autocommit mode with\\n`java.sql.Connection#setAutocommit()` ({issue}`2338`)\"], \"Hive connector\": [\"Reduce query latency and Hive metastore load when using the\\n`AUTOMATIC` join reordering strategy. ({issue}`2184`)\", \"Allow configuring `hive.max-outstanding-splits-size` to values larger than 2GB. ({issue}`2395`)\", \"Avoid redundant file system stat call when writing Parquet files. ({issue}`1746`)\", \"Avoid retrying permanent errors for S3-related services such as STS. ({issue}`2331`)\"], \"Kafka connector\": [\"Remove internal columns: `_segment_start`, `_segment_end` and\\n`_segment_count`. ({issue}`2303`)\", \"Add new configuration property `kafka.messages-per-split` to control how many Kafka\\nmessages will be processed by a single Presto split. ({issue}`2303`)\"], \"Elasticsearch connector\": [\"Fix query failure when an object in an Elasticsearch document\\ndoes not have any fields. ({issue}`2217`)\", \"Add support for querying index aliases. ({issue}`2324`)\"], \"Phoenix connector\": [\"Add support for mapping unsupported data types to `VARCHAR`. This can be enabled by setting\\nthe `unsupported-type-handling` configuration property or the `unsupported_type_handling` session\\nproperty to `CONVERT_TO_VARCHAR`. ({issue}`2427`)\"], \"Other connectors\": \"These changes apply to the MySQL, PostgreSQL, Redshift and SQL Server connectors:\\n\\n['Add support for creating schemas. ({issue}`1874`)', 'Add support for caching metadata. The configuration property `metadata.cache-ttl`\\\\ncontrols how long to cache data (it defaults to `0ms` which disables caching),\\\\nand `metadata.cache-missing` controls whether or not missing tables are cached. ({issue}`2290`)']\\n\\nThis change applies to the MySQL and PostgreSQL connectors:\\n\\n['Add support for mapping `DECIMAL` types with precision larger than 38\\\\nto Presto `DECIMAL`. ({issue}`2088`)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 201]\"}, {\"title\": \"Release 329 (23 Jan 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect result for {func}`last_day_of_month` function for first day of month. ({issue}`2452`)\", \"Fix incorrect results when handling `DOUBLE` or `REAL` types with `NaN` values. ({issue}`2582`)\", \"Fix query failure when coordinator hostname contains underscores. ({issue}`2571`)\", \"Fix `SHOW CREATE TABLE` failure when row types contain a field named after a\\nreserved SQL keyword. ({issue}`2130`)\", \"Handle common disk failures during spill. When one disk fails but multiple\\nspill locations are configured, the healthy disks will be used for future queries.\\n({issue}`2444`)\", \"Improve performance and reduce load on external systems when\\nquerying `information_schema`. ({issue}`2488`)\", \"Improve performance of queries containing redundant scalar subqueries. ({issue}`2456`)\", \"Limit broadcasted table size to `100MB` by default when using the `AUTOMATIC`\\njoin type selection strategy. This avoids query failures or excessive memory usage when joining two or\\nmore very large tables. ({issue}`2527`)\", \"Enable {doc}`cost based </optimizer/cost-based-optimizations>` join reordering and join type selection\\noptimizations by default. The previous behavior can be restored by\\nsetting `optimizer.join-reordering-strategy` configuration property to `ELIMINATE_CROSS_JOINS`\\nand `join-distribution-type` to `PARTITIONED`. ({issue}`2528`)\", \"Hide non-standard columns `comment` and `extra_info` in the standard\\n`information_schema.columns` table. These columns can still be selected,\\nbut will no longer appear when describing the table. ({issue}`2306`)\"], \"Security\": [\"Add `ldap.bind-dn` and `ldap.bind-password` LDAP properties to allow LDAP authentication\\naccess LDAP server using service account. ({issue}`1917`)\"], \"Hive connector\": [\"Fix incorrect data returned when using S3 Select on uncompressed files. In our testing, S3 Select\\nwas apparently returning incorrect results when reading uncompressed files, so S3 Select is disabled\\nfor uncompressed files. ({issue}`2399`)\", \"Fix incorrect data returned when using S3 Select on a table with `skip.header.line.count` or\\n`skip.footer.line.count` property. S3 Select API does not support skipping footers or more than one\\nline of a header. In our testing, S3 Select was apparently sometimes returning incorrect results when\\nreading a compressed file with header skipping, so S3 Select is disabled when any of these table\\nproperties is set to non-zero value. ({issue}`2399`)\", \"Fix query failure for writes when one of the inserted `REAL` or `DOUBLE` values\\nis infinite or `NaN`. ({issue}`2471`)\", \"Fix performance degradation reading from S3 when the Kinesis connector is installed. ({issue}`2496`)\", \"Allow reading data from Parquet files when the column type is declared as `INTEGER`\\nin the table or partition, but is a `DECIMAL` type in the file. ({issue}`2451`)\", \"Validate the scale of decimal types when reading Parquet files. This prevents\\nincorrect results when the decimal scale in the file does not match the declared\\ntype for the table or partition. ({issue}`2451`)\", \"Delete storage location when dropping an empty schema. ({issue}`2463`)\", \"Improve performance when deleting multiple partitions by executing these actions concurrently. ({issue}`1812`)\", \"Improve performance for queries containing `IN` predicates over bucketing columns. ({issue}`2277`)\", \"Add procedure `system.drop_stats()` to remove the column statistics\\nfor a table or selected partitions. ({issue}`2538`)\"], \"Elasticsearch connector\": [\"Add support for {ref}`elasticsearch-array-types`. ({issue}`2441`)\", \"Reduce load on Elasticsearch cluster and improve query performance. ({issue}`2561`)\"], \"PostgreSQL connector\": [\"Fix mapping between PostgreSQL's `TIME` and Presto's `TIME` data types.\\nPreviously the mapping was incorrect, shifting it by the relative offset between the session\\ntime zone and the Presto server's JVM time zone. ({issue}`2549`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 202]\"}, {\"title\": \"Release 330 (18 Feb 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect behavior of {func}`format` for `char` values. Previously, the function\\ndid not preserve trailing whitespace of the value being formatted. ({issue}`2629`)\", \"Fix query failure in some cases when aggregation uses inputs from both sides of a join. ({issue}`2560`)\", \"Fix query failure when dynamic filtering is enabled and the query contains complex\\nmulti-level joins. ({issue}`2659`)\", \"Fix query failure for certain co-located joins when dynamic filtering is enabled. ({issue}`2685`)\", \"Fix failure of `SHOW` statements or queries that access `information_schema` schema tables\\nwith an empty value used in a predicate. ({issue}`2575`)\", \"Fix query failure when {doc}`/sql/execute` is used with an expression containing a function call. ({issue}`2675`)\", \"Fix failure in `SHOW CATALOGS` when the user does not have permissions to see any catalogs. ({issue}`2593`)\", \"Improve query performance for some join queries when {doc}`/optimizer/cost-based-optimizations`\\nare enabled. ({issue}`2722`)\", \"Prevent uneven distribution of data that can occur when writing data with redistribution or writer\\nscaling enabled. ({issue}`2788`)\", \"Add support for `CREATE VIEW` with comment ({issue}`2557`)\", \"Add support for all major geometry types to {func}`ST_Points`. ({issue}`2535`)\", \"Add `required_workers_count` and `required_workers_max_wait_time` session properties\\nto control the number of workers that must be present in the cluster before query\\nprocessing starts. ({issue}`2484`)\", \"Add `physical_input_bytes` column to `system.runtime.tasks` table. ({issue}`2803`)\", \"Verify that the target schema exists for the {doc}`/sql/use` statement. ({issue}`2764`)\", \"Verify that the session catalog exists when executing {doc}`/sql/set-role`. ({issue}`2768`)\"], \"Server\": [\"Require running on {ref}`Java 11 or above <requirements-java>`. This requirement may be temporarily relaxed by adding\\n`-Dpresto-temporarily-allow-java8=true` to the Presto {ref}`jvm-config`.\\nThis fallback will be removed in future versions of Presto after March 2020. ({issue}`2751`)\", \"Add experimental support for running on Linux aarch64 (ARM64). ({issue}`2809`)\"], \"Security\": [\"{ref}`system-file-auth-principal-rules` are deprecated and will be removed in a future release.\\nThese rules have been replaced with {doc}`/security/user-mapping`, which\\nspecifies how a complex authentication user name is mapped to a simple\\nuser name for Presto, and {ref}`system-file-auth-impersonation-rules` which\\ncontrol the ability of a user to impersonate another user. ({issue}`2215`)\", \"A shared secret is now required when using {doc}`/security/internal-communication`. ({issue}`2202`)\", \"Kerberos for {doc}`/security/internal-communication` has been replaced with the new shared secret mechanism.\\nThe `internal-communication.kerberos.enabled` and `internal-communication.kerberos.use-canonical-hostname`\\nconfiguration properties must be removed. ({issue}`2202`)\", \"When authentication is disabled, the Presto user may now be set using standard\\nHTTP basic authentication with an empty password. ({issue}`2653`)\"], \"Web UI\": [\"Display physical read time in detailed query view. ({issue}`2805`)\"], \"JDBC driver\": [\"Fix a performance issue on JDK 11+ when connecting using HTTP/2. ({issue}`2633`)\", \"Implement `PreparedStatement.setTimestamp()` variant that takes a `Calendar`. ({issue}`2732`)\", \"Add `roles` property for catalog authorization roles. ({issue}`2780`)\", \"Add `sessionProperties` property for setting system and catalog session properties. ({issue}`2780`)\", \"Add `clientTags` property to set client tags for selecting resource groups. ({issue}`2468`)\", \"Allow using the `:` character within an extra credential value specified via the\\n`extraCredentials` property. ({issue}`2780`)\"], \"CLI\": [\"Fix a performance issue on JDK 11+ when connecting using HTTP/2. ({issue}`2633`)\"], \"Cassandra connector\": [\"Fix query failure when identifiers should be quoted. ({issue}`2455`)\"], \"Hive connector\": [\"Fix reading symlinks from HDFS when using Kerberos. ({issue}`2720`)\", \"Reduce Hive metastore load when updating partition statistics. ({issue}`2734`)\", \"Allow redistributing writes for un-bucketed partitioned tables on the\\npartition keys, which results in a single writer per partition. This reduces\\nmemory usage, results in a single file per partition, and allows writing a\\nlarge number of partitions (without hitting the open writer limit). However,\\nwriting large partitions with a single writer can take substantially longer, so\\nthis feature should only be enabled when required. To enable this feature, set the\\n`use-preferred-write-partitioning` system configuration property or the\\n`use_preferred_write_partitioning` system session property to `true`. ({issue}`2358`)\", \"Remove extra file status call after writing text-based, SequenceFile, or Avro file types. ({issue}`1748`)\", \"Allow using writer scaling with all file formats. Previously, it was not supported for\\ntext-based, SequenceFile, or Avro formats. ({issue}`2657`)\", \"Add support for symlink-based tables with Avro files. ({issue}`2720`)\", \"Add support for ignoring partitions with a non-existent data directory. This can be configured\\nusing the `hive.ignore-absent-partitions=true` configuration property or the\\n`ignore_absent_partitions` session property. ({issue}`2555`)\", \"Allow creation of external tables with data via `CREATE TABLE AS` when\\nboth `hive.non-managed-table-creates-enabled` and `hive.non-managed-table-writes-enabled`\\nare set to `true`. Previously this required executing `CREATE TABLE` and `INSERT`\\nas separate statement ({issue}`2669`)\", \"Add support for Azure WASB, ADLS Gen1 (ADL) and ADLS Gen2 (ABFS) file systems. ({issue}`2494`)\", \"Add experimental support for executing basic Hive views. To enable this feature, the\\n`hive.views-execution.enabled` configuration property must be set to `true`. ({issue}`2715`)\", \"Add {ref}`register_partition <register-partition>` and {ref}`unregister_partition <unregister-partition>`\\nprocedures for adding partitions to and removing partitions from a partitioned table. ({issue}`2692`)\", \"Allow running {doc}`/sql/analyze` collecting only basic table statistics. ({issue}`2762`)\"], \"Elasticsearch connector\": [\"Improve performance of queries containing a `LIMIT` clause. ({issue}`2781`)\", \"Add support for `nested` data type. ({issue}`754`)\"], \"PostgreSQL connector\": [\"Add read support for PostgreSQL `money` data type. The type is mapped to `varchar` in Presto.\\n({issue}`2601`)\"], \"Other connectors\": \"These changes apply to the MySQL, PostgreSQL, Redshift, Phoenix and SQL Server connectors.\\n\\n['Respect `DEFAULT` column clause when writing to a table. ({issue}`1185`)']\", \"SPI\": [\"Allow procedures to have optional arguments with default values. ({issue}`2706`)\", \"`SystemAccessControl.checkCanSetUser()` is deprecated and has been replaced\\nwith {doc}`/security/user-mapping` and `SystemAccessControl.checkCanImpersonateUser()`. ({issue}`2215`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 203]\"}, {\"title\": \"Release 331 (16 Mar 2020)\", \"description\": null, \"content\": {\"General\": [\"Prevent query failures when worker is shut down gracefully. ({issue}`2648`)\", \"Fix join failures for queries involving `OR` predicate with non-comparable functions. ({issue}`2861`)\", \"Ensure query completed event is fired when there is an error during analysis or planning. ({issue}`2842`)\", \"Fix memory accounting for `ORDER BY` queries. ({issue}`2612`)\", \"Fix {func}`last_day_of_month` for `timestamp with time zone` values. ({issue}`2851`)\", \"Fix excessive runtime when parsing deeply nested expressions with unmatched parenthesis. ({issue}`2968`)\", \"Correctly reject `date` literals that cannot be represented in Presto. ({issue}`2888`)\", \"Improve query performance by removing redundant data reshuffling. ({issue}`2853`)\", \"Improve performance of inequality joins involving `BETWEEN`. ({issue}`2859`)\", \"Improve join performance for dictionary encoded data. ({issue}`2862`)\", \"Enable dynamic filtering by default. ({issue}`2793`)\", \"Show reorder join cost in `EXPLAIN ANALYZE VERBOSE` ({issue}`2725`)\", \"Allow configuring resource groups selection based on user's groups. ({issue}`3023`)\", \"Add `SET AUTHORIZATION` action to {doc}`/sql/alter-schema`. ({issue}`2673`)\", \"Add {doc}`/connector/bigquery`. ({issue}`2532`)\", \"Add support for large prepared statements. ({issue}`2719`)\"], \"Security\": [\"Remove unused `internal-communication.jwt.enabled` configuration property. ({issue}`2709`)\", \"Rename JWT configuration properties from `http.authentication.jwt.*` to `http-server.authentication.jwt.*`. ({issue}`2712`)\", \"Add access control checks for query execution, view query, and kill query. This can be\\nconfigured using {ref}`query-rules` in {doc}`/security/file-system-access-control`. ({issue}`2213`)\", \"Hide columns of tables for which the user has no privileges in {doc}`/security/file-system-access-control`. ({issue}`2925`)\"], \"JDBC driver\": [\"Implement `PreparedStatement.getMetaData()`. ({issue}`2770`)\"], \"Web UI\": [\"Fix copying worker address to clipboard. ({issue}`2865`)\", \"Fix copying query ID to clipboard. ({issue}`2872`)\", \"Fix display of data size values. ({issue}`2810`)\", \"Fix redirect from `/` to `/ui/` when Presto is behind a proxy. ({issue}`2908`)\", \"Fix display of prepared queries. ({issue}`2784`)\", \"Display physical input read rate. ({issue}`2873`)\", \"Add simple form based authentication that utilizes the configured password authenticator. ({issue}`2755`)\", \"Allow disabling the UI via the `web-ui.enabled` configuration property. ({issue}`2755`)\"], \"CLI\": [\"Fix formatting of `varbinary` in nested data types. ({issue}`2858`)\", \"Add `--timezone` parameter. ({issue}`2961`)\"], \"Hive connector\": [\"Fix incorrect results for reads from `information_schema` tables and\\nmetadata queries when using a Hive 3.x metastore. ({issue}`3008`)\", \"Fix query failure when using Glue metastore and the table storage descriptor has no properties. ({issue}`2905`)\", \"Fix deadlock when Hive caching is enabled and has a refresh interval configured. ({issue}`2984`)\", \"Respect `bucketing_version` table property when using Glue metastore. ({issue}`2905`)\", \"Improve performance of partition fetching from Glue. ({issue}`3024`)\", \"Add support for bucket sort order in Glue when creating or updating a table or partition. ({issue}`1870`)\", \"Add support for Hive full ACID tables. ({issue}`2068`, {issue}`1591`, {issue}`2790`)\", \"Allow data conversion when reading decimal data from Parquet files and precision or scale in the file schema\\nis different from the precision or scale in partition schema. ({issue}`2823`)\", \"Add option to enforce that a filter on a partition key be present in the query. This can be enabled by setting the\\n`hive.query-partition-filter-required` configuration property or the `query_partition_filter_required` session property\\nto `true`. ({issue}`2334`)\", \"Allow selecting the `Intelligent-Tiering` S3 storage class when writing data to S3. This can be enabled by\\nsetting the `hive.s3.storage-class` configuration property to `INTELLIGENT_TIERING`. ({issue}`3032`)\", \"Hide the Hive system schema `sys` for security reasons. ({issue}`3008`)\", \"Add support for changing the owner of a schema. ({issue}`2673`)\"], \"MongoDB connector\": [\"Fix incorrect results when queries contain filters on certain data types, such\\nas `real` or `decimal`. ({issue}`1781`)\"], \"Other connectors\": \"These changes apply to the MemSQL, MySQL, PostgreSQL, Redshift, Phoenix, and SQL Server connectors.\\n\\n['Add support for dropping schemas. ({issue}`2956`)']\", \"SPI\": [\"Remove deprecated `Identity` constructors. ({issue}`2877`)\", \"Introduce a builder for `ConnectorIdentity` and deprecate its public constructors. ({issue}`2877`)\", \"Add support for row filtering and column masking via the `getRowFilter()` and `getColumnMask()` APIs in\\n`SystemAccessControl` and `ConnectorAccessControl`. ({issue}`1480`)\", \"Add access control check for executing procedures. ({issue}`2924`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 204]\"}, {\"title\": \"Release 332 (08 Apr 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix query failure during planning phase for certain queries involving multiple joins. ({issue}`3149`)\", \"Fix execution failure for queries involving large `IN` predicates on decimal values with precision larger than 18. ({issue}`3191`)\", \"Fix prepared statements or view creation for queries containing certain nested aliases or `TABLESAMPLE` clauses. ({issue}`3250`)\", \"Fix rare query failure. ({issue}`2981`)\", \"Ignore trailing whitespace when loading configuration files such as\\n`etc/event-listener.properties` or `etc/group-provider.properties`.\\nTrailing whitespace in `etc/config.properties` and catalog properties\\nfiles was already ignored. ({issue}`3231`)\", \"Reduce overhead for internal communication requests. ({issue}`3215`)\", \"Include filters over all table columns in output of `EXPLAIN (TYPE IO)`. ({issue}`2743`)\", \"Support configuring multiple event listeners. The properties files for all the event listeners\\ncan be specified using the `event-listener.config-files` configuration property. ({issue}`3128`)\", \"Add `CREATE SCHEMA ... AUTHORIZATION` syntax to create a schema with specified owner. ({issue}`3066`).\", \"Add `optimizer.push-partial-aggregation-through-join` configuration property to control\\npushing partial aggregations through inner joins. Previously, this was only available\\nvia the `push_partial_aggregation_through_join` session property. ({issue}`3205`)\", \"Rename configuration property `optimizer.push-aggregation-through-join`\\nto `optimizer.push-aggregation-through-outer-join`. ({issue}`3205`)\", \"Add operator statistics for the number of splits processed with a dynamic filter applied. ({issue}`3217`)\"], \"Security\": [\"Fix LDAP authentication when user belongs to multiple groups. ({issue}`3206`)\", \"Verify access to table columns when running `SHOW STATS`. ({issue}`2665`)\", \"Only return views accessible to the user from `information_schema.views`. ({issue}`3290`)\"], \"JDBC driver\": [\"Add `clientInfo` property to set extra information about the client. ({issue}`3188`)\", \"Add `traceToken` property to set a trace token for correlating requests across systems. ({issue}`3188`)\"], \"BigQuery connector\": [\"Extract parent project ID from service account before looking at the environment. ({issue}`3131`)\"], \"Elasticsearch connector\": [\"Add support for `ip` type. ({issue}`3347`)\", \"Add support for `keyword` fields with numeric values. ({issue}`3381`)\", \"Remove unnecessary `elasticsearch.aws.use-instance-credentials` configuration property. ({issue}`3265`)\"], \"Hive connector\": [\"Fix failure reading certain Parquet files larger than 2GB. ({issue}`2730`)\", \"Improve performance when reading gzip-compressed Parquet data. ({issue}`3175`)\", \"Explicitly disallow reading from Delta Lake tables. Previously, reading\\nfrom partitioned tables would return zero rows, and reading from\\nunpartitioned tables would fail with a cryptic error. ({issue}`3366`)\", \"Add `hive.fs.new-directory-permissions` configuration property for setting the permissions of new directories\\ncreated by Presto. Default value is `0777`, which corresponds to previous behavior. ({issue}`3126`)\", \"Add `hive.partition-use-column-names` configuration property and matching `partition_use_column_names` catalog\\nsession property that allows to match columns between table and partition schemas by names. By default they are mapped\\nby index. ({issue}`2933`)\", \"Add support for `CREATE SCHEMA ... AUTHORIZATION` to create a schema with specified owner. ({issue}`3066`).\", \"Allow specifying the Glue metastore endpoint URL using the\\n`hive.metastore.glue.endpoint-url` configuration property. ({issue}`3239`)\", \"Add experimental file system caching. This can be enabled with the `hive.cache.enabled` configuration property. ({issue}`2679`)\", \"Support reading files compressed with newer versions of LZO. ({issue}`3209`)\", \"Add support for Alluxio Catalog Service. ({issue}`2116`)\", \"Remove unnecessary `hive.metastore.glue.use-instance-credentials` configuration property. ({issue}`3265`)\", \"Remove unnecessary `hive.s3.use-instance-credentials` configuration property. ({issue}`3265`)\", \"Add flexible S3 security mapping, allowing for separate credentials\\nor IAM roles for specific users or buckets/paths. ({issue}`3265`)\", \"Add support for specifying an External ID for an IAM role trust policy using\\nthe `hive.metastore.glue.external-id` configuration property ({issue}`3144`)\", \"Allow using configured S3 credentials with IAM role. Previously,\\nthe configured IAM role was silently ignored. ({issue}`3351`)\"], \"Kudu connector\": [\"Fix incorrect column mapping in Kudu connector. ({issue}`3170`, {issue}`2963`)\", \"Fix incorrect query result for certain queries involving `IS NULL` predicates with `OR`. ({issue}`3274`)\"], \"Memory connector\": [\"Include views in the list of tables returned to the JDBC driver. ({issue}`3208`)\"], \"MongoDB connector\": [\"Add `objectid_timestamp` for extracting the timestamp from `ObjectId`. ({issue}`3089`)\", \"Delete document from `_schema` collection when `DROP TABLE`\\nis executed for a table that exists only in `_schema`. ({issue}`3234`)\"], \"SQL Server connector\": [\"Disallow renaming tables between schemas. Previously, such renames were allowed\\nbut the schema name was ignored when performing the rename. ({issue}`3284`)\"], \"SPI\": [\"Expose row filters and column masks in `QueryCompletedEvent`. ({issue}`3183`)\", \"Expose referenced functions and procedures in `QueryCompletedEvent`. ({issue}`3246`)\", \"Allow `Connector` to provide `EventListener` instances. ({issue}`3166`)\", \"Deprecate the `ConnectorPageSourceProvider.createPageSource()` variant without the\\n`dynamicFilter` parameter. The method will be removed in a future release. ({issue}`3255`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 205]\"}, {\"title\": \"Release 333 (04 May 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix planning failure when lambda expressions are repeated in a query. ({issue}`3218`)\", \"Fix failure when input to `TRY` is a constant `NULL`. ({issue}`3408`)\", \"Fix failure for {doc}`/sql/show-create-table` for tables with\\nrow types that contain special characters. ({issue}`3380`)\", \"Fix failure when using {func}`max_by` or {func}`min_by`\\nwhere the second argument is of type `varchar`. ({issue}`3424`)\", \"Fix rare failure due to an invalid size estimation for T-Digests. ({issue}`3625`)\", \"Do not require coordinator to have spill paths setup when spill is enabled. ({issue}`3407`)\", \"Improve performance when dynamic filtering is enabled. ({issue}`3413`)\", \"Improve performance of queries involving constant scalar subqueries ({issue}`3432`)\", \"Allow overriding the count of available workers used for query cost\\nestimation via the `cost_estimation_worker_count` session property. ({issue}`2705`)\", \"Add data integrity verification for Presto internal communication. This can be configured\\nwith the `exchange.data-integrity-verification` configuration property. ({issue}`3438`)\", \"Add support for `LIKE` predicate to {doc}`/sql/show-columns`. ({issue}`2997`)\", \"Add {doc}`/sql/show-create-schema`. ({issue}`3099`)\", \"Add {func}`starts_with` function. ({issue}`3392`)\"], \"Server\": [\"Require running on {ref}`Java 11 or above <requirements-java>`. ({issue}`2799`)\"], \"Server RPM\": [\"Reduce size of RPM and disk usage after installation. ({issue}`3595`)\"], \"Security\": [\"Allow configuring trust certificate for LDAP password authenticator. ({issue}`3523`)\"], \"JDBC driver\": [\"Fix hangs on JDK 8u252 when using secure connections. ({issue}`3444`)\"], \"BigQuery connector\": [\"Improve performance for queries that contain filters on table columns. ({issue}`3376`)\", \"Add support for partitioned tables. ({issue}`3376`)\"], \"Cassandra connector\": [\"Allow {doc}`/sql/insert` statement for table having hidden `id` column. ({issue}`3499`)\", \"Add support for {doc}`/sql/create-table` statement. ({issue}`3478`)\"], \"Elasticsearch connector\": [\"Fix failure when querying Elasticsearch 7.x clusters. ({issue}`3447`)\"], \"Hive connector\": [\"Fix incorrect query results when reading Parquet data with a `varchar` column predicate\\nwhich is a comparison with a value containing non-ASCII characters. ({issue}`3517`)\", \"Ensure cleanup of resources (file descriptors, sockets, temporary files, etc.)\\nwhen an error occurs while writing an ORC file. ({issue}`3390`)\", \"Generate multiple splits for files in bucketed tables. ({issue}`3455`)\", \"Make file system caching honor Hadoop properties from `hive.config.resources`. ({issue}`3557`)\", \"Disallow enabling file system caching together with S3 security mapping or GCS access tokens. ({issue}`3571`)\", \"Disable file system caching parallel warmup by default.\\nIt is currently broken and should not be enabled. ({issue}`3591`)\", \"Include metrics from S3 Select in the S3 JMX metrics. ({issue}`3429`)\", \"Report timings for request retries in S3 JMX metrics.\\nPreviously, only the first request was reported. ({issue}`3429`)\", \"Add S3 JMX metric for client retry pause time (how long the thread was asleep\\nbetween request retries in the client itself). ({issue}`3429`)\", \"Add support for {doc}`/sql/show-create-schema`. ({issue}`3099`)\", \"Add `hive.projection-pushdown-enabled` configuration property and\\n`projection_pushdown_enabled` session property. ({issue}`3490`)\", \"Add support for connecting to the Thrift metastore using TLS. ({issue}`3440`)\"], \"MongoDB connector\": [\"Skip unknown types in nested BSON object. ({issue}`2935`)\", \"Fix query failure when the user does not have access privileges for `system.views`. ({issue}`3355`)\"], \"Other connectors\": \"These changes apply to the MemSQL, MySQL, PostgreSQL, Redshift, and SQL Server connectors.\\n\\n['Export JMX statistics for various connector operations. ({issue}`3479`).']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 206]\"}, {\"title\": \"Release 334 (29 May 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect query results for certain queries involving comparisons of `real` and `double` types\\nwhen values include negative zero. ({issue}`3745`)\", \"Fix failure when querying an empty table with late materialization enabled. ({issue}`3577`)\", \"Fix failure when the inputs to `UNNEST` are repeated. ({issue}`3587`)\", \"Fix failure when an aggregation is used in the arguments to {func}`format`. ({issue}`3829`)\", \"Fix {func}`localtime` and {func}`current_time` for session zones with DST or with historical offset changes\\nin legacy (default) timestamp semantics. ({issue}`3846`, {issue}`3850`)\", \"Fix dynamic filter failures in complex spatial join queries. ({issue}`3694`)\", \"Improve performance of queries involving {func}`row_number`. ({issue}`3614`)\", \"Improve performance of queries containing `LIKE` predicate. ({issue}`3618`)\", \"Improve query performance when dynamic filtering is enabled. ({issue}`3632`)\", \"Improve performance for queries that read fields from nested structures. ({issue}`2672`)\", \"Add variant of {func}`random` function that produces a number in the provided range. ({issue}`1848`)\", \"Show distributed plan by default in {doc}`/sql/explain`. ({issue}`3724`)\", \"Add {doc}`/connector/oracle`. ({issue}`1959`)\", \"Add {doc}`/connector/pinot`. ({issue}`2028`)\", \"Add {doc}`/connector/prometheus`. ({issue}`2321`)\", \"Add support for standards compliant ({rfc}`7239`) HTTP forwarded headers. Processing of HTTP forwarded headers is now controlled by the\\n`http-server.process-forwarded` configuration property, and the old `http-server.authentication.allow-forwarded-https` and\\n`dispatcher.forwarded-header` configuration properties are no longer supported. ({issue}`3714`)\", \"Add pluggable {doc}`/develop/certificate-authenticator`. ({issue}`3804`)\"], \"JDBC driver\": [\"Improve performance of `DatabaseMetaData.getColumns()` when the\\nparameters contain unescaped `%` or `_`. ({issue}`1620`)\"], \"CLI\": [\"Improve rendering of elapsed time for short queries. ({issue}`3311`)\"], \"Web UI\": [\"Add `fixed`, `certificate`, `JWT`, and `Kerberos` to UI authentication. ({issue}`3433`)\", \"Show join distribution type in Live Plan. ({issue}`1323`)\"], \"Elasticsearch connector\": [\"Fix failure when executing `SHOW CREATE TABLE`. ({issue}`3718`)\", \"Improve performance for `count(*)` queries. ({issue}`3512`)\", \"Add support for raw Elasticsearch queries. ({issue}`3735`)\"], \"Hive connector\": [\"Fix matching bucket filenames without leading zeros. ({issue}`3702`)\", \"Fix creation of external tables using `CREATE TABLE AS`. Previously, the\\ntables were created as managed and with the default location. ({issue}`3755`)\", \"Fix incorrect table statistics for newly created external tables. ({issue}`3819`)\", \"Prevent Presto from starting when cache fails to initialize. ({issue}`3749`)\", \"Fix race condition that could cause caching to be permanently disabled. ({issue}`3729`, {issue}`3810`)\", \"Fix malformed reads when asynchronous read mode for caching is enabled. ({issue}`3772`)\", \"Fix eviction of cached data while still under size eviction threshold. ({issue}`3772`)\", \"Improve performance when creating unpartitioned external tables over large data sets. ({issue}`3624`)\", \"Leverage Parquet file statistics when reading decimal columns. ({issue}`3581`)\", \"Change type of `$file_modified_time` hidden column from `bigint` to `timestamp with timezone type`. ({issue}`3611`)\", \"Add caching support for HDFS and Azure file systems. ({issue}`3772`)\", \"Fix S3 connection pool depletion when asynchronous read mode for caching is enabled. ({issue}`3772`)\", \"Disable caching on coordinator by default. ({issue}`3820`)\", \"Use asynchronous read mode for caching by default. ({issue}`3799`)\", \"Cache delegation token for Hive thrift metastore. This can be configured with\\nthe `hive.metastore.thrift.delegation-token.cache-ttl` and `hive.metastore.thrift.delegation-token.cache-maximum-size`\\nconfiguration properties. ({issue}`3771`)\"], \"MemSQL connector\": [\"Include {doc}`/connector/singlestore` in the server tarball and RPM. ({issue}`3743`)\"], \"MongoDB connector\": [\"Support case insensitive database and collection names. This can be enabled with the\\n`mongodb.case-insensitive-name-matching` configuration property. ({issue}`3453`)\"], \"SPI\": [\"Allow a `SystemAccessControl` to provide an `EventListener`. ({issue}`3629`).\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 207]\"}, {\"title\": \"Release 335 (14 Jun 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix failure when {func}`reduce_agg` is used as a window function. ({issue}`3883`)\", \"Fix incorrect cast from `TIMESTAMP` (without time zone) to `TIME` type. ({issue}`3848`)\", \"Fix incorrect query results when converting very large `TIMESTAMP` values into\\n`TIMESTAMP WITH TIME ZONE`, or when parsing very large\\n`TIMESTAMP WITH TIME ZONE` values. ({issue}`3956`)\", \"Return `VARCHAR` type when {func}`substr` argument is `CHAR` type. ({issue}`3599`, {issue}`3456`)\", \"Improve optimized local scheduling with regard to non-uniform data distribution. ({issue}`3922`)\", \"Add support for variable-precision `TIMESTAMP` (without time zone) type. ({issue}`3783`)\", \"Add a variant of {func}`substring` that takes a `CHAR` argument. ({issue}`3949`)\", \"Add `information_schema.role_authorization_descriptors` table that returns information about the roles\\ngranted to principals. ({issue}`3535`)\"], \"Security\": [\"Add schema access rules to {doc}`/security/file-system-access-control`. ({issue}`3766`)\"], \"Web UI\": [\"Fix the value displayed in the worker memory pools bar. ({issue}`3920`)\"], \"Accumulo connector\": [\"The server-side iterators are now in a JAR file named `presto-accumulo-iterators`. ({issue}`3673`)\"], \"Hive connector\": [\"Collect column statistics for inserts into empty tables. ({issue}`2469`)\", \"Add support for `information_schema.role_authorization_descriptors` table when using the `sql-standard`\\nsecurity mode. ({issue}`3535`)\", \"Allow non-lowercase column names in {ref}`system.sync_partition_metadata<hive-procedures>` procedure. This can be enabled\\nby passing `case_sensitive=false` when invoking the procedure. ({issue}`3431`)\", \"Support caching with secured coordinator. ({issue}`3874`)\", \"Prevent caching from becoming disabled due to intermittent network failures. ({issue}`3874`)\", \"Ensure HDFS impersonation is not enabled when caching is enabled. ({issue}`3913`)\", \"Add `hive.cache.ttl` and `hive.cache.disk-usage-percentage` cache properties. ({issue}`3840`)\", \"Improve query performance when caching is enabled by scheduling work on nodes with cached data. ({issue}`3922`)\", \"Add support for `UNIONTYPE`. This is mapped to `ROW` containing a `tag` field and a field for each data type in the union. For\\nexample, `UNIONTYPE<INT, DOUBLE>` is mapped to `ROW(tag INTEGER, field0 INTEGER, field1 DOUBLE)`. ({issue}`3483`)\", \"Make `partition_values` argument to `drop_stats` procedure optional. ({issue}`3937`)\", \"Add support for dynamic partition pruning to improve performance of complex queries\\nover partitioned data. ({issue}`1072`)\"], \"Phoenix connector\": [\"Allow configuring whether `DROP TABLE` is allowed. This is controlled by the new `allow-drop-table`\\ncatalog configuration property and defaults to `true`, compatible with the previous behavior. ({issue}`3953`)\"], \"SPI\": [\"Add support for aggregation pushdown into connectors via the\\n`ConnectorMetadata.applyAggregation()` method. ({issue}`3697`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 208]\"}, {\"title\": \"Release 336 (16 Jun 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix failure when querying timestamp columns from older clients. ({issue}`4036`)\", \"Improve reporting of configuration errors. ({issue}`4050`)\", \"Fix rare failure when recording server stats in T-Digests. ({issue}`3965`)\"], \"Security\": [\"Add table access rules to {doc}`/security/file-system-access-control`. ({issue}`3951`)\", \"Add new `default` system access control that allows all operations except user impersonation. ({issue}`4040`)\"], \"Hive connector\": [\"Fix incorrect query results when reading Parquet files with predicates\\nwhen `hive.parquet.use-column-names` is set to `false` (the default). ({issue}`3574`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 209]\"}, {\"title\": \"Release 337 (25 Jun 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results for inequality join involving `NaN`. ({issue}`4120`)\", \"Fix peak non-revocable memory metric in event listener. ({issue}`4096`)\", \"Fix queued query JMX stats. ({issue}`4129`)\", \"Fix rendering of types in the output of `DESCRIBE INPUT`. ({issue}`4023`)\", \"Improve performance of queries involving comparisons between `DOUBLE` or `REAL` values and integer values. ({issue}`3533`)\", \"Reduce idle CPU consumption in coordinator. ({issue}`3990`)\", \"Add peak non-revocable memory metric to query stats. ({issue}`4096`)\", \"Add support for variable-precision `TIMESTAMP WITH TIME ZONE` type ({issue}`3947`)\", \"Add support for `IN` predicate with subqueries in outer join condition. ({issue}`4151`)\", \"Add support for quantified comparisons (e.g., `> ALL (...)`) in aggregation queries. ({issue}`4128`)\", \"Add {doc}`/connector/druid`. ({issue}`3522`)\", \"Add {func}`translate` function. ({issue}`4080`)\", \"Reduce worker graceful shutdown duration. ({issue}`4192`)\"], \"Security\": [\"Disable insecure authentication over HTTP by default when HTTPS with authentication is enabled. This\\ncan be overridden via the `http-server.authentication.allow-insecure-over-http` configuration property. ({issue}`4199`)\", \"Add support for insecure authentication over HTTPS to the Web UI. ({issue}`4199`)\", \"Add {ref}`system-file-auth-system-information` which control the ability of a\\nuser to access to read and write system management information.\\n({issue}`4199`)\", \"Disable user impersonation in default system security. ({issue}`4082`)\"], \"Elasticsearch connector\": [\"Add support for password authentication. ({issue}`4165`)\"], \"Hive connector\": [\"Fix reading CSV tables with `separatorChar`, `quoteChar` or `escapeChar` table property\\ncontaining more than one character. For compatibility with Hive, only first character is considered\\nand remaining are ignored. ({issue}`3891`)\", \"Improve performance of `INSERT` queries writing to bucketed tables when some buckets do not contain any data. ({issue}`1375`)\", \"Improve performance of queries reading Parquet data with predicates on `timestamp` columns. ({issue}`4104`)\", \"Improve performance for join queries over partitioned tables. ({issue}`4156`)\", \"Add support for `null_format` table property for tables using TextFile storage format ({issue}`4056`)\", \"Add support for `null_format` table property for tables using RCText and SequenceFile\\nstorage formats ({issue}`4143`)\", \"Add optimized Parquet writer. The new writer is disabled by default, and can be enabled with the\\n`parquet_optimized_writer_enabled` session property or the `hive.parquet.optimized-writer.enabled` configuration\\nproperty. ({issue}`3400`)\", \"Add support caching data in Azure Data Lake and AliyunOSS storage. ({issue}`4213`)\", \"Fix failures when caching data from Google Cloud Storage. ({issue}`4213`)\", \"Support ACID data files naming used when direct inserts are enabled in Hive (HIVE-21164).\\nDirect inserts is an upcoming feature in Hive 4. ({issue}`4049`)\"], \"PostgreSQL connector\": [\"Improve performance of aggregation queries by computing aggregations within PostgreSQL database.\\nCurrently, the following aggregate functions are eligible for pushdown:\\n`count`, `min`, `max`, `sum` and `avg`. ({issue}`3881`)\"], \"Base-JDBC connector library\": [\"Implement framework for aggregation pushdown. ({issue}`3881`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 210]\"}, {\"title\": \"Release 338 (07 Jul 2020)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results when joining tables on a masked column. ({issue}`4251`)\", \"Fix planning failure when multiple columns have a mask. ({issue}`4322`)\", \"Fix incorrect comparison for `TIMESTAMP WITH TIME ZONE` values with precision larger than 3. ({issue}`4305`)\", \"Fix incorrect rounding for timestamps before 1970-01-01. ({issue}`4370`)\", \"Fix query failure when using `VALUES` with a floating point `NaN` value. ({issue}`4119`)\", \"Fix query failure when joining tables on a `real` or `double` column and one of the joined tables\\ncontains `NaN` value. ({issue}`4272`)\", \"Fix unauthorized error for internal requests to management endpoints. ({issue}`4304`)\", \"Fix memory leak while using dynamic filtering. ({issue}`4228`)\", \"Improve dynamic partition pruning for broadcast joins. ({issue}`4262`)\", \"Add support for setting column comments via the `COMMENT ON COLUMN` syntax. ({issue}`2516`)\", \"Add compatibility mode for legacy clients when rendering datetime type names with default precision\\nin `information_schema` tables. This can be enabled via the `deprecated.omit-datetime-type-precision`\\nconfiguration property or `omit_datetime_type_precision` session property. ({issue}`4349`, {issue}`4377`)\", \"Enforce `NOT NULL` column declarations when writing data. ({issue}`4144`)\"], \"JDBC driver\": [\"Fix excessive CPU usage when reading query results. ({issue}`3928`)\", \"Implement `DatabaseMetaData.getClientInfoProperties()`. ({issue}`4318`)\"], \"Elasticsearch connector\": [\"Add support for reading numeric values encoded as strings. ({issue}`4341`)\"], \"Hive connector\": [\"Fix incorrect query results when Parquet file has no min/max statistics for an integral column. ({issue}`4200`)\", \"Fix query failure when reading from a table partitioned on a `real` or `double` column containing\\na `NaN` value. ({issue}`4266`)\", \"Fix sporadic failure when writing to bucketed sorted tables on S3. ({issue}`2296`)\", \"Fix handling of strings when translating Hive views. ({issue}`3266`)\", \"Do not require cache directories to be configured on coordinator. ({issue}`3987`, {issue}`4280`)\", \"Fix Azure ADL caching support. ({issue}`4240`)\", \"Add support for setting column comments. ({issue}`2516`)\", \"Add hidden `$partition` column for partitioned tables that contains the partition name. ({issue}`3582`)\"], \"Kafka connector\": [\"Fix query failure when a column is projected and also referenced in a query predicate\\nwhen reading from Kafka topic using `RAW` decoder. ({issue}`4183`)\"], \"MySQL connector\": [\"Fix type mapping for unsigned integer types. ({issue}`4187`)\"], \"Oracle connector\": [\"Exclude internal schemas (e.g., sys) from schema listings. ({issue}`3784`)\", \"Add support for connection pooling. ({issue}`3770`)\"], \"Base-JDBC connector library\": [\"Exclude the underlying database's `information_schema` from schema listings. ({issue}`3834`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 211]\"}, {\"title\": \"Release 339 (21 Jul 2020)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`approx_most_frequent`. ({issue}`3425`)\", \"Physical bytes scan limit for queries can be configured via `query.max-scan-physical-bytes` configuration property\\nand `query_max_scan_physical_bytes` session property. ({issue}`4075`)\", \"Remove support for addition and subtraction between `TIME` and `INTERVAL YEAR TO MONTH` types. ({issue}`4308`)\", \"Fix planning failure when join criteria contains subqueries. ({issue}`4380`)\", \"Fix failure when subquery appear in window function arguments. ({issue}`4127`)\", \"Fix failure when subquery in `WITH` clause contains hidden columns. ({issue}`4423`)\", \"Fix failure when referring to type names with different case in a `GROUP BY` clause. ({issue}`2960`)\", \"Fix failure for queries involving `DISTINCT` when expressions in `ORDER BY` clause differ by case from expressions in `SELECT` clause. ({issue}`4233`)\", \"Fix incorrect type reporting for `TIMESTAMP` and `TIMESTAMP WITH TIME ZONE` for legacy clients. ({issue}`4408`)\", \"Fix failure when querying nested `TIMESTAMP` or `TIMESTAMP WITH TIME ZONE` for legacy clients. ({issue}`4475`, {issue}`4425`)\", \"Fix failure when parsing timestamps with time zone with an offset of the form `+NNNN`. ({issue}`4490`)\"], \"JDBC driver\": [\"Fix reading `TIMESTAMP` and `TIMESTAMP WITH TIME ZONE` values with a negative year\\nor a year higher than 9999. ({issue}`4364`)\", \"Fix incorrect column size metadata for `TIMESTAMP` and `TIMESTAMP WITH TIME ZONE` types. ({issue}`4411`)\", \"Return correct value from `ResultSet.getDate()`, `ResultSet.getTime()` and `ResultSet.getTimestamp()` methods\\nwhen session zone is set to a different zone than the default zone of the JVM the JDBC is run in.\\nThe previous behavior can temporarily be restored using `useSessionTimeZone` JDBC connection\\nparameter. ({issue}`4017`)\"], \"Druid connector\": [\"Fix handling of table and column names containing non-ASCII characters. ({issue}`4312`)\"], \"Hive connector\": [\"Make `location` parameter optional for the `system.register_partition` procedure. ({issue}`4443`)\", \"Avoid creating tiny splits at the end of block boundaries. ({issue}`4485`)\", \"Remove requirement to configure `metastore.storage.schema.reader.impl` in Hive 3.x metastore\\nto let Presto access CSV tables. ({issue}`4457`)\", \"Fail query if there are bucket files outside of the bucket range.\\nPreviously, these extra files were skipped. ({issue}`4378`)\", \"Fix a query failure when reading from Parquet file containing `real` or `double` `NaN` values,\\nif the file was written by a non-conforming writer. ({issue}`4267`)\"], \"Kafka connector\": [\"Add insert support for Avro. ({issue}`4418`)\", \"Add insert support for CSV. ({issue}`4287`)\"], \"Kudu connector\": [\"Add support for grouped execution. It can be enabled with the `kudu.grouped-execution.enabled`\\nconfiguration property or the `grouped_execution` session property. ({issue}`3715`)\"], \"MongoDB connector\": [\"Allow querying Azure Cosmos DB. ({issue}`4415`)\"], \"Oracle connector\": [\"Allow providing credentials via the `connection-user` and `connection-password`\\nconfiguration properties. These properties were previously ignored if connection pooling\\nwas enabled. ({issue}`4430`)\"], \"Phoenix connector\": [\"Fix handling of row key definition with white space. ({issue}`3251`)\"], \"SPI\": [\"Allow connectors to wait for dynamic filters before splits are generated via the new\\n`DynamicFilter` object passed to `ConnectorSplitManager.getSplits()`. ({issue}`4224`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 212]\"}, {\"title\": \"Release 340 (8 Aug 2020)\", \"description\": null, \"content\": {\"General\": [\"Add support for query parameters in `LIMIT`, `OFFSET` and `FETCH FIRST` clauses. ({issue}`4529`, {issue}`4601`)\", \"Add experimental support for recursive queries. ({issue}`4250`)\", \"Add {func}`bitwise_left_shift`, {func}`bitwise_right_shift` and {func}`bitwise_right_shift_arithmetic`. ({issue}`740`)\", \"Add {func}`luhn_check`. ({issue}`4011`)\", \"Add `IF EXISTS `and `IF NOT EXISTS` syntax to `ALTER TABLE`. ({issue}`4651`)\", \"Include remote host in error info for page transport errors. ({issue}`4511`)\", \"Improve minimum latency for dynamic partition pruning. ({issue}`4388`)\", \"Reduce cluster load by cancelling query stages from which data is no longer required. ({issue}`4290`)\", \"Reduce query memory usage by improving retained size estimation for `VARCHAR` and `CHAR` types. ({issue}`4123`)\", \"Improve query performance for queries containing {func}`starts_with`. ({issue}`4669`)\", \"Improve performance of queries that use `DECIMAL` data type. ({issue}`4730`)\", \"Fix failure when `GROUP BY` clause contains duplicate expressions. ({issue}`4609`)\", \"Fix potential hang during query planning ({issue}`4635`).\"], \"Security\": [\"Fix unprivileged access to table's schema via `CREATE TABLE LIKE`. ({issue}`4472`)\"], \"JDBC driver\": [\"Fix handling of dates before 1582-10-15. ({issue}`4563`)\", \"Fix handling of timestamps before 1900-01-01. ({issue}`4563`)\"], \"Elasticsearch connector\": [\"Fix failure when index mapping is missing. ({issue}`4535`)\"], \"Hive connector\": [\"Allow creating a table with `external_location` when schema's location is not valid. ({issue}`4069`)\", \"Add read support for tables that were created as non-transactional and converted to be\\ntransactional later. ({issue}`2293`)\", \"Allow creation of transactional tables. Note that writing to transactional tables\\nis not yet supported. ({issue}`4516`)\", \"Add `hive.metastore.glue.max-error-retries` configuration property for the\\nnumber of retries performed when accessing the Glue metastore. ({issue}`4611`)\", \"Support using Java KeyStore files for Thrift metastore TLS configuration. ({issue}`4432`)\", \"Expose hit rate statistics for Hive metastore cache via JMX. ({issue}`4458`)\", \"Improve performance when querying a table with large files and with `skip.header.line.count` property set to 1. ({issue}`4513`)\", \"Improve performance of reading JSON tables. ({issue}`4705`)\", \"Fix query failure when S3 data location contains a `_$folder$` marker object. ({issue}`4552`)\", \"Fix failure when referencing nested fields of a `ROW` type when table and partition metadata differs. ({issue}`3967`)\"], \"Kafka connector\": [\"Add insert support for Raw data format. ({issue}`4417`)\", \"Add insert support for JSON. ({issue}`4477`)\", \"Remove unused `kafka.connect-timeout` configuration properties. ({issue}`4664`)\"], \"MongoDB connector\": [\"Add `mongodb.max-connection-idle-time` properties to limit the maximum idle time of a pooled connection. ({issue}`4483`)\"], \"Phoenix connector\": [\"Add table level property to specify data block encoding when creating tables. ({issue}`4617`)\", \"Fix query failure when listing schemas. ({issue}`4560`)\"], \"PostgreSQL connector\": [\"Push down {func}`count` aggregations over constant expressions.\\nFor example, `SELECT count(1)`. ({issue}`4362`)\"], \"SPI\": [\"Expose information about query type in query Event Listener. ({issue}`4592`)\", \"Add support for TopN pushdown via the `ConnectorMetadata.applyLimit()` method. ({issue}`4249`)\", \"Deprecate the older variants of `ConnectorSplitManager.getSplits()`. ({issue}`4508`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 213]\"}, {\"title\": \"Release 341 (8 Sep 2020)\", \"description\": null, \"content\": {\"General\": [\"Add support for variable-precision `TIME` type. ({issue}`4381`)\", \"Add support for variable precision `TIME WITH TIME ZONE` type. ({issue}`4905`)\", \"Add {doc}`/connector/iceberg`.\", \"Add {func}`human_readable_seconds` function. ({issue}`4344`)\", \"Add [`reverse()`](function-reverse-varbinary) function for `VARBINARY`. ({issue}`4741`)\", \"Add support for {func}`extract` for `timestamp(p) with time zone` with values of `p` other than 3. ({issue}`4867`)\", \"Add support for correlated subqueries in recursive queries. ({issue}`4877`)\", \"Add [](optimizer-rule-stats) system table. ({issue}`4659`)\", \"Report dynamic filters statistics. ({issue}`4440`)\", \"Improve query scalability when new nodes are added to cluster. ({issue}`4294`)\", \"Improve error message when JSON parsing fails. ({issue}`4616`)\", \"Reduce latency when dynamic filtering is in use. ({issue}`4924`)\", \"Remove support for political time zones in `TIME WITH TIME ZONE` type. ({issue}`191`)\", \"Remove deprecated `reorder_joins` session property. ({issue}`5027`)\", \"Remove the `deprecated.legacy-timestamp` configuration property and the `legacy_timestamp` session property. ({issue}`4799`)\", \"Change timestamp operations to match the SQL specification. The value of a `TIMESTAMP`\\ntype is not affected by the session time zone. ({issue}`37`)\", \"Preserve precision when applying `AT TIME ZONE` to values of type `TIMESTAMP`. ({issue}`4866`)\", \"Fix serialization of `NULL` values in `ROW`, `MAP` and `ARRAY` types for old Presto clients. ({issue}`4778`)\", \"Fix failure when aggregation query contains duplicate expressions. ({issue}`4872`)\", \"Fix compiler failure when querying timestamps with a precision greater than 6. ({issue}`4824`)\", \"Fix parsing failure of timestamps due to daylight saving changes. ({issue}`37`)\", \"Fix failure when calling {func}`extract` with `TIMEZONE_HOUR` and `TIMEZONE_MINUTE` for\\n`TIMESTAMP WITH TIME ZONE` type. ({issue}`4867`)\", \"Fix query deadlock for connectors that wait for dynamic filters. ({issue}`4946`)\", \"Fix failure when `TIME` or `TIMESTAMP` subtraction returns a negative value. ({issue}`4847`)\", \"Fix failure when duplicate expressions appear in `DISTINCT` clause. ({issue}`4787`)\", \"Fix failure for certain join queries during spilling or when available memory is low. ({issue}`4994`)\", \"Fix issue where the `query_max_scan_physical_bytes` session property was ignored if\\nthe `query.max-scan-physical-bytes` configuration property was not defined. ({issue}`5009`)\", \"Correctly compute sample ratio when `TABLESAMPLE` is used with a fractional percentage. ({issue}`5074`)\", \"Fail queries with a proper error message when `TABLESAMPLE` is used with a non-numeric sample ratio. ({issue}`5074`)\", \"Fail with an explicit error rather than `OutOfMemoryError` for certain operations. ({issue}`4890`)\"], \"Security\": [\"Add [Salesforce password authentication](/security/salesforce). ({issue}`4372`)\", \"Add support for interpolating [secrets](/security/secrets) into `access-control.properties`. ({issue}`4854`)\", \"Only request HTTPS client certificate when certificate authentication is enabled. ({issue}`4804`)\", \"Add {doc}`/security/user-mapping` support for uppercasing or lowercasing usernames. ({issue}`4736`)\"], \"Web UI\": [\"Fix display of physical input read time in detailed query view. ({issue}`4962`)\"], \"JDBC driver\": [\"Implement `ResultSet.getStatement()`. ({issue}`4957`)\"], \"BigQuery connector\": [\"Add support for hourly partitioned tables. ({issue}`4968`)\", \"Redact the value of `bigquery.credentials-key` in the server log. ({issue}`4968`)\"], \"Cassandra connector\": [\"Map Cassandra `TIMESTAMP` type to Presto `TIMESTAMP(3) WITH TIME ZONE` type. ({issue}`2269`)\"], \"Hive connector\": [\"Skip stripes and row groups based on timestamp statistics for ORC files. ({issue}`1147`)\", \"Skip S3 objects with the `DeepArchive` storage class (in addition to the `Glacier`\\nstorage class) when `hive.s3.skip-glacier-objects` is enabled. ({issue}`5002`)\", \"Use a temporary staging directory for temporary files when writing to sorted bucketed tables.\\nThis allows using a more efficient file system for temporary files. ({issue}`3434`)\", \"Fix metastore cache invalidation for `GRANT` and `REVOKE`. ({issue}`4768`)\", \"Add Parquet and RCBinary [configuration properties](hive-configuration-properties) `hive.parquet.time-zone`\\nand `hive.rcfile.time-zone` to adjust binary timestamp values to a specific time zone. For Hive 3.1+, this\\nshould be set to UTC. The default value is the JVM default time zone, for backwards compatibility with\\nearlier versions of Hive. ({issue}`4799`)\", \"Add ORC [configuration property](hive-configuration-properties) `hive.orc.time-zone` to set the default\\ntime zone for legacy ORC files that did not declare a time zone. ({issue}`4799`)\", \"Replace the `hive.time-zone` configuration property with format specific properties: `hive.orc.time-zone`,\\n`hive.parquet.time-zone`, `hive.rcfile.time-zone`. ({issue}`4799`)\", \"Allow using the cluster default role with S3 security mapping. ({issue}`4931`)\", \"Remove support for bucketing on timestamp. The definition of the hash function for timestamp\\nincorrectly depends on the storage time zone and can result in incorrect results. ({issue}`4759`)\", \"Decrease the number of requests to the Glue metastore when fetching partitions.\\nThis helps avoid hitting rate limits and decreases service costs. ({issue}`4938`)\", \"Match the existing user and group of the table or partition when creating new files on HDFS. ({issue}`4414`)\", \"Fix invalid timestamp values for nested data in Text, Avro, SequenceFile, JSON and CSV formats. ({issue}`4799`)\", \"Fix query failure when reading an ORC ACID table with a filter after the table\\nunderwent a minor table compaction. ({issue}`4622`)\", \"Fix incorrect query results when reading an ORC ACID table that has deleted rows\\nand underwent a minor compaction. ({issue}`4623`)\", \"Fix query failure when storage caching is enabled and cached data is evicted during query execution. ({issue}`3580`)\"], \"JMX connector\": [\"Change `timestamp` column type in history tables to `TIMESTAMP WITH TIME ZONE`. ({issue}`4753`)\"], \"Kafka connector\": [\"Preserve time zone when parsing `TIMESTAMP WITH TIME ZONE` values. ({issue}`4799`)\"], \"Kinesis connector\": [\"Preserve time zone when parsing `TIMESTAMP WITH TIME ZONE` values. ({issue}`4799`)\"], \"Kudu connector\": [\"Fix delete when applied on table having primary key of decimal type. ({issue}`4683`)\"], \"Local File connector\": [\"Change `timestamp` column type to `TIMESTAMP WITH TIME ZONE`. ({issue}`4752`)\"], \"MySQL connector\": [\"Improve performance of aggregation queries by pushing the aggregation computation into the MySQL database.\\nCurrently, the following aggregate functions are eligible for pushdown: `count`, `min`, `max`,\\n`sum` and `avg`. ({issue}`4138`)\"], \"Oracle connector\": [\"Add `oracle.connection-pool.inactive-timeout` configuration property to specify how long\\npooled connection can be inactive before it is closed. It defaults to 20 minutes. ({issue}`4779`)\", \"Add support for database internationalization. ({issue}`4775`)\", \"Add resilience to momentary connection authentication issues. ({issue}`4947`)\", \"Allowing forcing the mapping of certain types to `VARCHAR`. This can be enabled by\\nsetting the `jdbc-types-mapped-to-varchar` configuration property to a comma-separated\\nlist of type names. ({issue}`4955`)\", \"Prevent query failure for pushdown of predicates involving a large number of conjuncts. ({issue}`4918`)\"], \"Phoenix connector\": [\"Fix overwriting of former value when insert is applied without specifying that column. ({issue}`4670`)\"], \"Pinot connector\": [\"Add support for `REAL` and `INTEGER` types. ({issue}`4725`)\", \"Add support for functions in pass-through queries. ({issue}`4801`)\", \"Enforce a limit on the number of rows fetched from Pinot. This can be configured via the\\n`pinot.max-rows-per-split-for-segment-queries` configuration property. ({issue}`4723`)\", \"Fix incorrect results for `count(*)` queries. ({issue}`4802`)\", \"Fix incorrect results for queries involving {func}`avg` over columns of type `long`, `int`, or `float`. ({issue}`4802`)\", \"Fix incorrect results when columns in pass-through query do not match selected columns. ({issue}`4802`)\"], \"Prometheus connector\": [\"Change the type of the `timestamp` column to `TIMESTAMP(3) WITH TIME ZONE` type. ({issue}`4799`)\"], \"PostgreSQL connector\": [\"Improve performance of aggregation queries with predicates by pushing the computation\\nof both the filtering and aggregations into the PostgreSQL server where possible. ({issue}`4111`)\", \"Fix handling of PostgreSQL arrays when `unsupported-type-handling` is set to `CONVERT_TO_VARCHAR`. ({issue}`4981`)\"], \"Raptor connector\": [\"Remove the `storage.shard-day-boundary-time-zone` configuration property, which was used to work\\naround legacy timestamp semantics in Presto. ({issue}`4799`)\"], \"Redis connector\": [\"Preserve time zone when parsing `TIMESTAMP WITH TIME ZONE` values. ({issue}`4799`)\"], \"SPI\": [\"The `TIMESTAMP` type is encoded as a number of fractional seconds from `1970-01-01 00:00:00` in the proleptic\\nGregorian calendar. This value is no longer adjusted to the session time zone. Timestamps with precision less\\nthan or equal to 3 are now represented in microseconds. ({issue}`4799`)\", \"Remove `isLegacyTimestamp()` from `ConnectorSession`. ({issue}`4799`)\", \"Enable connectors to wait for dynamic filters before producing data on worker nodes. ({issue}`3414`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 214]\"}, {\"title\": \"Release 342 (24 Sep 2020)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`from_iso8601_timestamp_nanos` function. ({issue}`5048`)\", \"Improve performance of queries that use the `DECIMAL` type. ({issue}`4886`)\", \"Improve performance of queries involving `IN` with subqueries by extending support for dynamic filtering. ({issue}`5017`)\", \"Improve performance and latency of queries leveraging dynamic filters. ({issue}`4988`)\", \"Improve performance of queries joining tables with missing or incomplete column statistics when\\ncost based optimization is enabled (which is the default). ({issue}`5141`)\", \"Reduce latency for queries that perform a broadcast join of a large table. ({issue}`5237`)\", \"Allow collection of dynamic filters for joins with large build side using the\\n`enable-large-dynamic-filters` configuration property or the `enable_large_dynamic_filters`\\nsession property. ({issue}`5262`)\", \"Fix query failure when lambda expression references a table column containing a dot. ({issue}`5087`)\"], \"Atop connector\": [\"Fix incorrect query results when query contains predicates on `start_time` or `end_time` column. ({issue}`5125`)\"], \"Elasticsearch connector\": [\"Allow reading boolean values stored as strings. ({issue}`5269`)\"], \"Hive connector\": [\"Add support for S3 encrypted files. ({issue}`2536`)\", \"Add support for ABFS OAuth authentication. ({issue}`5052`)\", \"Support reading timestamp with microsecond or nanosecond precision. This can be enabled with the\\n`hive.timestamp-precision` configuration property. ({issue}`4953`)\", \"Allow overwrite on insert by default using the `hive.insert-existing-partitions-behavior` configuration property. ({issue}`4999`)\", \"Allow delaying table scans until dynamic filtering can be performed more efficiently. This can be enabled\\nusing the `hive.dynamic-filtering-probe-blocking-timeout` configuration property or the\\n`dynamic_filtering_probe_blocking_timeout` session property. ({issue}`4991`)\", \"Disable matching the existing user and group of the table or partition when creating new files on HDFS.\\nThe functionality was added in 341 and is now disabled by default. It can be enabled using the\\n`hive.fs.new-file-inherit-ownership` configuration property. ({issue}`5187`)\", \"Improve performance when reading small files in `RCTEXT` or `RCBINARY` format. ({issue}`2536`)\", \"Improve planning time for queries with non-equality filters on partition columns when using the Glue metastore. ({issue}`5060`)\", \"Improve performance when reading `JSON` and `CSV` file formats. ({issue}`5142`)\"], \"Iceberg connector\": [\"Fix partition transforms for temporal columns for dates before 1970. ({issue}`5273`)\"], \"Kafka connector\": [\"Expose message headers as a `_headers` column of `MAP(VARCHAR, ARRAY(VARBINARY))` type. ({issue}`4462`)\", \"Add write support for `TIME`, `TIME WITH TIME ZONE`, `TIMESTAMP` and `TIMESTAMP WITH TIME ZONE`\\nfor Kafka connector when using the JSON encoder. ({issue}`4743`)\", \"Remove JSON decoder support for nonsensical combinations of input-format-type / data-type. The following\\ncombinations are no longer supported: ({issue}`4743`)\", [\"`rfc2822`: `DATE`, `TIME`, `TIME WITH TIME ZONE`\", \"`milliseconds-since-epoch`: `TIME WITH TIME ZONE`, `TIMESTAMP WITH TIME ZONE`\", \"`seconds-since-epoch`: `TIME WITH TIME ZONE`, `TIMESTAMP WITH TIME ZONE`\"]], \"MySQL connector\": [\"Improve performance of `INSERT` queries when GTID mode is disabled in MySQL. ({issue}`4995`)\"], \"PostgreSQL connector\": [\"Add support for variable-precision TIMESTAMP and TIMESTAMP WITH TIME ZONE types. ({issue}`5124`, {issue}`5105`)\"], \"SQL Server connector\": [\"Fix failure when inserting `NULL` into a `VARBINARY` column. ({issue}`4846`)\", \"Improve performance of aggregation queries by computing aggregations within SQL Server database.\\nCurrently, the following aggregate functions are eligible for pushdown:\\n`count`, `min`, `max`, `sum` and `avg`. ({issue}`4139`)\"], \"SPI\": [\"Add `DynamicFilter.isAwaitable()` method that returns whether or not the dynamic filter is complete\\nand can be awaited for using the `isBlocked()` method. ({issue}`5043`)\", \"Enable connectors to wait for dynamic filters derived from replicated joins before generating splits. ({issue}`4685`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 215]\"}, {\"title\": \"Release 343 (25 Sep 2020)\", \"description\": null, \"content\": {\"BigQuery connector\": [\"Add support for yearly partitioned tables. ({issue}`5298`)\"], \"Hive connector\": [\"Fix query failure when read from or writing to a bucketed table containing a column of `timestamp` type. ({issue}`5295`)\"], \"SQL Server connector\": [\"Improve performance of aggregation queries with `stddev`, `stddev_samp`, `stddev_pop`, `variance`, `var_samp`, `var_pop`\\naggregate functions by computing aggregations within SQL Server database. ({issue}`5299`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 216]\"}, {\"title\": \"Release 344 (9 Oct 2020)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`murmur3` function. ({issue}`5054`)\", \"Add {func}`from_unixtime_nanos` function. ({issue}`5046`)\", \"Add [T-Digest](/functions/tdigest) type and functions. ({issue}`5158`)\", \"Improve performance and latency of queries leveraging dynamic filters. ({issue}`5081`, {issue}`5340`)\", \"Add `dynamic-filtering.service-thread-count` config property to specify number of\\nthreads used for processing dynamic filters on coordinator. ({issue}`5341`)\", \"Extend {doc}`/security/secrets` environment variable substitution to allow\\nmultiple replacements in a single configuration property. ({issue}`4345`)\", \"Remove the `fast-inequality-joins` configuration property. This feature is always enabled. ({issue}`5375`)\", \"Use `timestamp(3) with time zone` rather than `timestamp(3)` for the `queries`,\\n`transactions`, and `tasks` tables in `system.runtime`. ({issue}`5464`)\", \"Improve performance and accuracy of {func}`approx_percentile`. ({issue}`5158`)\", \"Improve performance of certain cross join queries. ({issue}`5276`)\", \"Prevent potential query deadlock when query runs out of memory. ({issue}`5289`)\", \"Fix failure due to rounding error when casting between two `timestamp` types with precision\\nhigher than 6. ({issue}`5310`)\", \"Fix failure due to rounding error when casting between two `timestamp with time zone` types\\nwith precision higher than 3. ({issue}`5371`)\", \"Fix column pruning for `EXPLAIN ANALYZE`. ({issue}`4760`)\", \"Fix incorrect timestamp values returned by the `queries`, `transactions`,\\nand `tasks` tables in `system.runtime`. ({issue}`5462`)\"], \"Security\": \"```\\nThe file-based system and catalog access controls have changed in ways that reduce or increase permissions.\\nPlease, read these release notes carefully.\\n```\\n\\n['Change file-based catalog access control from deny to allow when table, schema, or session\\\\nproperty rules are not defined. ({issue}`5039`)', 'Add missing table rule checks for table and view DDL in file-based system access control. ({issue}`5039`)', 'Add missing schema rule checks for create schema in file-based system access control. ({issue}`5039`)', 'Add session property rules to file-based system access control. ({issue}`5039`)', 'Add catalog regex to table and schema rules in file-based system access control. ({issue}`5039`)', 'Change create, rename, alter, and drop table in file-based system controls to only check for\\\\ntable ownership. ({issue}`5039`)', 'Change file-based system access control to support files without catalog rules defined. In this case,\\\\nall access to catalogs is allowed. ({issue}`5039`)', 'Change file-based system and catalog access controls to only show catalogs, schemas, and tables a user\\\\nhas permissions on. ({issue}`5039`)', 'Change file-based catalog access control to deny permissions inspection and manipulation. ({issue}`5039`)', 'Add [file-based group provider](/security/group-file). ({issue}`5028`)']\", \"Hive connector\": [\"Add support for `hive.security=allow-all`, which allows to skip all authorization checks. ({issue}`5416`)\", \"Support Kerberos authentication for Hudi tables. ({issue}`5472`)\", \"Allow hiding Delta Lake tables from table listings such as `SHOW TABLES` or `information_schema.tables`,\\nas these tables cannot be queried by the Hive connector. This be enabled using the `hive.hide-delta-lake-tables`\\nconfiguration property. ({issue}`5430`)\", \"Improve query concurrency by listing data files more efficiently. ({issue}`5260`)\", \"Fix Parquet encoding for timestamps before 1970-01-01. ({issue}`5364`)\"], \"Kafka connector\": [\"Expose message timestamp via `_timestamp` internal column. ({issue}`4805`)\", \"Add predicate pushdown for `_timestamp`, `_partition_offset` and `_partition_id` columns. ({issue}`4805`)\"], \"Phoenix connector\": [\"Fix query failure when a column name in `CREATE TABLE` requires quoting. ({issue}`3601`)\"], \"PostgreSQL connector\": [\"Add support for setting a column comment. ({issue}`5307`)\", \"Add support for variable-precision `time` type. ({issue}`5342`)\", \"Allow `CREATE TABLE` and `CREATE TABLE AS` with `timestamp` and `timestamp with time zone` with precision higher than 6.\\nThe resulting column will be declared with precision of 6, maximal supported by PostgreSQL. ({issue}`5342`)\"], \"SQL Server connector\": [\"Improve performance of queries with aggregations and `WHERE` clause. ({issue}`5327`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 217]\"}, {\"title\": \"Release 345 (23 Oct 2020)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`concat_ws` function. ({issue}`4680`)\", \"Add support for {func}`extract` for `time with time zone` values with precision other than 3. ({issue}`5539`)\", \"Add dynamic filtering support for right joins. ({issue}`5555`)\", \"Add support for catalog session properties to the file and database backed session property managers. ({issue}`5330`)\", \"Improve query scalability by increasing the default broadcast join buffer size to 200MB.\\nBroadcast join buffer size can be set using the `sink.max-broadcast-buffer-size` configuration property. ({issue}`5551`)\", \"Improve query performance by allowing larger dynamic filters. ({issue}`5529`)\", \"Improve performance for join queries where join keys are not of the same type. ({issue}`5461`)\", \"Improve performance of encrypted spilling. ({issue}`5557`)\", \"Improve performance of queries that use the `decimal` type. ({issue}`5181`)\"], \"Security\": [\"Add support for JSON Web Key (JWK) to the existing JSON Web Token (JWT) authenticator. This is enabled by\\nsetting the `jwt.key-file` configuration property to a `http` or `https` url. ({issue}`5419`)\", \"Add column security, column mask and row filter to file-based access controls. ({issue}`5460`)\", \"Enforce access control for column references in `USING` clause. ({issue}`5620`)\"], \"JDBC driver\": [\"Add `source` parameter for directly setting the source name for a query. ({issue}`4739`)\"], \"Hive connector\": [\"Add support for `INSERT` and `DELETE` for ACID tables. ({issue}`5402`)\", \"Apply `hive.domain-compaction-threshold` to dynamic filters. ({issue}`5365`)\", \"Add support for reading Parquet timestamps encoded as microseconds. ({issue}`5483`)\", \"Improve translation of Hive views. ({issue}`4661`)\", \"Improve storage caching by better distributing files across workers. ({issue}`5621`)\", \"Fix disk space accounting for storage caching. ({issue}`5621`)\", \"Fix failure when reading Parquet `timestamp` columns encoded as `int64`. ({issue}`5443`)\"], \"MongoDB connector\": [\"Add support for adding columns. ({issue}`5512`)\", \"Fix incorrect result for `IS NULL` predicates on fields that do not exist in the document. ({issue}`5615`)\"], \"MemSQL connector\": [\"Fix representation for many MemSQL types. ({issue}`5495`)\", \"Prevent a query failure when table column name contains a semicolon by explicitly forbidding such names. ({issue}`5495`)\", \"Add support for case-insensitive table name matching. ({issue}`5495`)\"], \"MySQL connector\": [\"Improve performance of queries with aggregations and `LIMIT` clause (but without `ORDER BY`). ({issue}`5261`)\"], \"PostgreSQL connector\": [\"Improve performance of queries with aggregations and `LIMIT` clause (but without `ORDER BY`). ({issue}`5261`)\"], \"Redshift connector\": [\"Add support for setting column comments. ({issue}`5397`)\"], \"SQL Server connector\": [\"Improve performance of queries with aggregations and `LIMIT` clause (but without `ORDER BY`). ({issue}`5261`)\"], \"Thrift connector\": [\"Fix handling of timestamp values. ({issue}`5596`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 218]\"}, {\"title\": \"Release 346 (10 Nov 2020)\", \"description\": null, \"content\": {\"General\": [\"Add support for `RANGE BETWEEN <value> PRECEDING AND <value> FOLLOWING` window frames. ({issue}`609`)\", \"Add support for window frames based on `GROUPS`. ({issue}`5713`)\", \"Add support for {func}`extract` with `TIMEZONE_HOUR` and `TIMEZONE_MINUTE` for `time with time zone` values. ({issue}`5668`)\", \"Add SQL syntax for `GRANT` and `REVOKE` on schema. This is not yet used by any connector. ({issue}`4396`)\", \"Add `ALTER TABLE ... SET AUTHORIZATION` syntax to allow changing the table owner. ({issue}`5717`)\", \"Make `EXPLAIN` more readable for queries containing `timestamp` or `timestamp with time zone` constants. ({issue}`5683`)\", \"Improve performance for queries with inequality conditions. ({issue}`2674`)\", \"Improve performance of queries with uncorrelated `IN` clauses. ({issue}`5582`)\", \"Use consistent NaN behavior for {func}`least`, {func}`greatest`,\\n{func}`array_min`, {func}`array_max`, {func}`min`, {func}`max`,\\n{func}`min_by`, and {func}`max_by`.\\nNaN is only returned when it is the only value (except for null\\nwhich are ignored for aggregation functions). ({issue}`5851`)\", \"Restore previous null handling for {func}`least` and {func}`greatest`. ({issue}`5787`)\", \"Restore previous null handling for {func}`array_min` and {func}`array_max`. ({issue}`5787`)\", \"Remove configuration properties `arrayagg.implementation`,\\n`multimapagg.implementation`, and `histogram.implementation`. ({issue}`4581`)\", \"Fix incorrect handling of negative offsets for the `time with time zone` type. ({issue}`5696`)\", \"Fix incorrect result when casting `time(p)` to `timestamp(p)` for precisions higher than 6. ({issue}`5736`)\", \"Fix incorrect query results when comparing a `timestamp` column with a `timestamp with time zone` constant. ({issue}`5685`)\", \"Fix improper table alias visibility for queries that select all fields. ({issue}`5660`)\", \"Fix failure when query parameter appears in a lambda expression. ({issue}`5640`)\", \"Fix failure for queries containing `DISTINCT *` and fully-qualified column names in the `ORDER BY` clause. ({issue}`5647`)\", \"Fix planning failure for certain queries involving `INNER JOIN`, `GROUP BY` and correlated subqueries. ({issue}`5846`)\", \"Fix recording of query completion event when query is aborted early. ({issue}`5815`)\", \"Fix exported JMX name for `QueryManager`. ({issue}`5702`)\", \"Fix failure when {func}`approx_distinct` is used with high precision `timestamp(p)`/`timestamp(p) with time zone`/`time(p) with time zone`\\ndata types. ({issue}`5392`)\"], \"Web UI\": [\"Fix \\\"Capture Snapshot\\\" button on the Worker page. ({issue}`5759`)\"], \"JDBC driver\": [\"Support number accessor methods like `ResultSet.getLong()` or `ResultSet.getDouble()`\\non `decimal` values, as well as `char` or `varchar` values that can be unambiguously interpreted as numbers. ({issue}`5509`)\", \"Add `SSLVerification` JDBC connection parameter that allows configuring SSL verification. ({issue}`5610`)\", \"Remove legacy `useSessionTimeZone` JDBC connection parameter. ({issue}`4521`)\", \"Implement `ResultSet.getRow()`. ({issue}`5769`)\"], \"Server RPM\": [\"Remove leftover empty directories after RPM uninstall. ({issue}`5782`)\"], \"BigQuery connector\": [\"Fix issue when query could return invalid results if some column references were pruned out during query optimization. ({issue}`5618`)\"], \"Cassandra connector\": [\"Improve performance of `INSERT` queries with batch statement. The batch size can be configured via the `cassandra.batch-size`\\nconfiguration property. ({issue}`5047`)\"], \"Elasticsearch connector\": [\"Fix failure when index mappings do not contain a `properties` section. ({issue}`5807`)\"], \"Hive connector\": [\"Add support for `ALTER TABLE ... SET AUTHORIZATION` SQL syntax to change the table owner. ({issue}`5717`)\", \"Add support for writing timestamps with microsecond or nanosecond precision, in addition to milliseconds. ({issue}`5283`)\", \"Export JMX statistics for Glue metastore client request metrics. ({issue}`5693`)\", \"Collect column statistics during `ANALYZE` and when data is inserted to table for columns of `timestamp(p)`\\nwhen precision is greater than 3. ({issue}`5392`)\", \"Improve query performance by adding support for dynamic bucket pruning. ({issue}`5634`)\", \"Remove deprecated `parquet.fail-on-corrupted-statistics` (previously known as `hive.parquet.fail-on-corrupted-statistics`).\\nA new configuration property, `parquet.ignore-statistics`, can be used to deal with Parquet files with incorrect metadata. ({issue}`3077`)\", \"Do not write min/max statistics for `timestamp` columns. ({issue}`5858`)\", \"If multiple metastore URIs are defined via `hive.metastore.uri`, prefer connecting to one which was seen operational most recently.\\nThis prevents query failures when one or more metastores are misbehaving. ({issue}`5795`)\", \"Fix Hive view access when catalog name is other than `hive`. ({issue}`5785`)\", \"Fix failure when the declared length of a `varchar(n)` column in the partition schema differs from the table schema. ({issue}`5484`)\", \"Fix Glue metastore pushdown for complex expressions. ({issue}`5698`)\"], \"Iceberg connector\": [\"Add support for materialized views. ({issue}`4832`)\", \"Remove deprecated `parquet.fail-on-corrupted-statistics` (previously known as `hive.parquet.fail-on-corrupted-statistics`).\\nA new configuration property, `parquet.ignore-statistics`, can be used to deal with Parquet files with incorrect metadata. ({issue}`3077`)\"], \"Kafka connector\": [\"Fix incorrect column comment. ({issue}`5751`)\"], \"Kudu connector\": [\"Improve performance of queries having only `LIMIT` clause. ({issue}`3691`)\"], \"MySQL connector\": [\"Improve performance for queries containing a predicate on a `varbinary` column. ({issue}`5672`)\"], \"Oracle connector\": [\"Add support for setting column comments. ({issue}`5399`)\", \"Allow enabling remarks reporting via `oracle.remarks-reporting.enabled` configuration property. ({issue}`5720`)\"], \"PostgreSQL connector\": [\"Improve performance of queries comparing a `timestamp` column with a `timestamp with time zone` constants\\nfor `timestamp with time zone` precision higher than 3. ({issue}`5543`)\"], \"Other connectors\": [\"Improve performance of queries with `DISTINCT` or `LIMIT`, or with `GROUP BY` and no aggregate functions and `LIMIT`,\\nwhen the computation can be pushed down to the underlying database for the PostgreSQL, MySQL, Oracle, Redshift and\\nSQL Server connectors. ({issue}`5522`)\"], \"SPI\": [\"Fix propagation of connector session properties to `ConnectorNodePartitioningProvider`. ({issue}`5690`)\", \"Add user groups to query events. ({issue}`5643`)\", \"Add planning time to query completed event. ({issue}`5643`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 219]\"}, {\"title\": \"Release 347 (25 Nov 2020)\", \"description\": null, \"content\": {\"General\": [\"Add `ALTER VIEW ... SET AUTHORIZATION` syntax for changing owner of the view. ({issue}`5789`)\", \"Add support for `INTERSECT ALL` and `EXCEPT ALL`. ({issue}`2152`)\", \"Add {func}`contains_sequence` function. ({issue}`5593`)\", \"Support defining cluster topology (used for query scheduling) using network subnets. ({issue}`4862`)\", \"Improve query performance by reducing worker to worker communication overhead. ({issue}`5905`, {issue}`5949`)\", \"Allow disabling client HTTP response compression, which can improve throughput over fast network links.\\nCompression can be disabled globally via the `query-results.compression-enabled` config property, for CLI via\\nthe `--disable-compression` flag, and for the JDBC driver via the `disableCompression` driver property. ({issue}`5818`)\", \"Rename ``rewrite-filtering-semi-join-to-inner-join`` session property to ``rewrite_filtering_semi_join_to_inner_join``. ({issue}`5954`)\", \"Throw a user error when session property value cannot be decoded. ({issue}`5731`)\", \"Fix query failure when expressions that produce values of type `row` are used in a `VALUES` clause. ({issue}`3398`)\"], \"Server\": [\"A minimum Java version of 11.0.7 is now required for Presto to start. This is to mitigate JDK-8206955. ({issue}`5957`)\"], \"Security\": [\"Add support for multiple LDAP bind patterns. ({issue}`5874`)\", \"Include groups for view owner when checking permissions for views. ({issue}`5945`)\"], \"JDBC driver\": [\"Implement `addBatch()`, `clearBatch()` and `executeBatch()` methods in `PreparedStatement`. ({issue}`5507`)\"], \"CLI\": [\"Add support for providing queries to presto-cli via shell redirection. ({issue}`5881`)\"], \"Docker image\": [\"Update Presto docker image to use CentOS 8 as the base image. ({issue}`5920`)\"], \"Hive connector\": [\"Add support for `ALTER VIEW ... SET AUTHORIZATION` SQL syntax to change the view owner. This supports Presto and Hive views. ({issue}`5789`)\", \"Allow configuring HDFS replication factor via the `hive.dfs.replication` config property. ({issue}`1829`)\", \"Add access checks for tables in Hive Procedures. ({issue}`1489`)\", \"Decrease latency of `INSERT` and `CREATE TABLE AS ...` queries by updating table and column statistics in parallel. ({issue}`3638`)\", \"Fix leaking S3 connections when querying Avro tables. ({issue}`5562`)\"], \"Kudu connector\": [\"Add dynamic filtering support. It can be enabled by setting a non-zero duration value for ``kudu.dynamic-filtering.wait-timeout`` config property\\nor ``dynamic_filtering_wait_timeout`` session property. ({issue}`5594`)\"], \"MongoDB connector\": [\"Improve performance of queries containing a `LIMIT` clause. ({issue}`5870`)\"], \"Other connectors\": [\"Improve query performance by compacting large pushed down predicates for the PostgreSQL, MySQL, Oracle,\\nRedshift and SQL Server connectors. Compaction threshold can be changed using the ``domain-compaction-threshold``\\nconfig property or ``domain_compaction_threshold`` session property. ({issue}`6057`)\", \"Improve performance for the PostgreSQL, MySQL, SQL Server connectors for certain complex queries involving\\naggregation and predicates by pushing the aggregation and predicates computation into the remote database. ({issue}`4112`)\"], \"SPI\": [\"Add support for connectors to redirect table scan operations to another connector. ({issue}`5792`)\", \"Add physical input bytes and rows for table scan operation to query completion event. ({issue}`5872`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 220]\"}, {\"title\": \"Release 348 (14 Dec 2020)\", \"description\": null, \"content\": {\"General\": [\"Add support for `DISTINCT` clause in aggregations within correlated subqueries. ({issue}`5904`)\", \"Support `SHOW STATS` for arbitrary queries. ({issue}`3109`)\", \"Improve query performance by reducing worker to worker communication overhead. ({issue}`6126`)\", \"Improve performance of `ORDER BY ... LIMIT` queries. ({issue}`6072`)\", \"Reduce memory pressure and improve performance of queries involving joins. ({issue}`6176`)\", \"Fix ``EXPLAIN ANALYZE`` for certain queries that contain broadcast join. ({issue}`6115`)\", \"Fix planning failures for queries that contain outer joins and aggregations using `FILTER (WHERE <condition>)` syntax. ({issue}`6141`)\", \"Fix incorrect results when correlated subquery in join contains aggregation functions such as `array_agg` or `checksum`. ({issue}`6145`)\", \"Fix incorrect query results when using `timestamp with time zone` constants with precision higher than 3\\ndescribing same point in time but in different zones. ({issue}`6318`)\", \"Fix duplicate query completion events if query fails early. ({issue}`6103`)\", \"Fix query failure when views are accessed and current session does not\\nspecify default schema and catalog. ({issue}`6294`)\"], \"Web UI\": [\"Add support for OAuth2 authorization. ({issue}`5355`)\", \"Fix invalid operator stats in Stage Performance view. ({issue}`6114`)\"], \"JDBC driver\": [\"Allow reading `timestamp with time zone` value as `ZonedDateTime` using `ResultSet.getObject(int column, Class<?> type)` method. ({issue}`307`)\", \"Accept `java.time.LocalDate` in `PreparedStatement.setObject(int, Object)`. ({issue}`6301`)\", \"Extend `PreparedStatement.setObject(int, Object, int)` to allow setting `time` and `timestamp` values with precision higher than nanoseconds. ({issue}`6300`)\\nThis can be done via providing a `String` value representing a valid SQL literal.\", \"Change representation of a `row` value. `ResultSet.getObject` now returns an instance of `io.prestosql.jdbc.Row` class, which better represents\\nthe returned value. Previously a `row` value was represented as a `Map` instance, with unnamed fields being named like `field0`, `field1`, etc.\\nYou can access the previous behavior by invoking `getObject(column, Map.class)` on the `ResultSet` object. ({issue}`4588`)\", \"Represent `varbinary` value using hex string representation in `ResultSet.getString`. Previously the return value was useless, similar to `\\\"B@2de82bf8\\\"`. ({issue}`6247`)\", \"Report precision of the `time(p)`, `time(p) with time zone`, `timestamp(p)` and `timestamp(p) with time zone` in the `DECIMAL_DIGITS` column\\nin the result set returned from `DatabaseMetaData#getColumns`. ({issue}`6307`)\", \"Fix the value of the `DATA_TYPE` column for `time(p)` and `time(p) with time zone` in the result set returned from `DatabaseMetaData#getColumns`. ({issue}`6307`)\", \"Fix failure when reading a `timestamp` or `timestamp with time zone` value with seconds fraction greater than or equal to 999999999500 picoseconds. ({issue}`6147`)\", \"Fix failure when reading a `time` value with seconds fraction greater than or equal to 999999999500 picoseconds. ({issue}`6204`)\", \"Fix element representation in arrays returned from `ResultSet.getArray`, making it consistent with `ResultSet.getObject`.\\nPreviously the elements were represented using internal client representation (e.g. `String`). ({issue}`6048`)\", \"Fix `ResultSetMetaData.getColumnType` for `timestamp with time zone`. Previously the type was miscategorized as `java.sql.Types.TIMESTAMP`. ({issue}`6251`)\", \"Fix `ResultSetMetaData.getColumnType` for `time with time zone`. Previously the type was miscategorized as `java.sql.Types.TIME`. ({issue}`6251`)\", \"Fix failure when an instance of `SphericalGeography` geospatial type is returned in the `ResultSet`. ({issue}`6240`)\"], \"CLI\": [\"Fix rendering of `row` values with unnamed fields. Previously they were printed using fake field names like `field0`, `field1`, etc. ({issue}`4587`)\", \"Fix query progress reporting. ({issue}`6119`)\", \"Fix failure when an instance of `SphericalGeography` geospatial type is returned to the client. ({issue}`6238`)\"], \"Hive connector\": [\"Allow configuring S3 endpoint in security mapping. ({issue}`3869`)\", \"Add support for S3 streaming uploads. Data is uploaded to S3 as it is written, rather\\nthan staged to a local temporary file. This feature is disabled by default, and can be enabled\\nusing the `hive.s3.streaming.enabled` configuration property. ({issue}`3712`, {issue}`6201`)\", \"Reduce load on metastore when background cache refresh is enabled. ({issue}`6101`, {issue}`6156`)\", \"Verify that data is in the correct bucket file when reading bucketed tables.\\nThis is enabled by default, as incorrect bucketing can cause incorrect query results,\\nbut can be disabled using the `hive.validate-bucketing` configuration property\\nor the `validate_bucketing` session property. ({issue}`6012`)\", \"Allow fallback to legacy Hive view translation logic via `hive.legacy-hive-view-translation` config property or\\n`legacy_hive_view_translation` session property. ({issue}`6195 `)\", \"Add deserializer class name to split information exposed to the event listener. ({issue}`6006`)\", \"Improve performance when querying tables that contain symlinks. ({issue}`6158`, {issue}`6213`)\"], \"Iceberg connector\": [\"Improve performance of queries containing filters on non-partition columns. Such filters are now used\\nfor optimizing split generation and table scan. ({issue}`4932`)\", \"Add support for Google Cloud Storage and Azure Storage. ({issue}`6186`)\"], \"Kafka connector\": [\"Allow writing `timestamp with time zone` values into columns using `milliseconds-since-epoch` or\\n`seconds-since-epoch` JSON encoders. ({issue}`6074`)\"], \"Other connectors\": [\"Fix ineffective table metadata caching for PostgreSQL, MySQL, SQL Server, Redshift, MemSQL and Phoenix connectors. ({issue}`6081`, {issue}`6167`)\"], \"SPI\": [\"Change `SystemAccessControl#filterColumns` and `ConnectorAccessControl#filterColumns` methods to accept a set of\\ncolumn names, and return a set of visible column names. ({issue}`6084`)\", \"Expose catalog names corresponding to the splits through the split completion event of the event listener. ({issue}`6006`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 221]\"}, {\"title\": \"Release 349\", \"description\": null, \"content\": {\"Release 349 (28 Dec 2020)\": \"```\\nThis release is broken and should not be used.\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 222]\"}, {\"title\": \"Release 350 (28 Dec 2020)\", \"description\": null, \"content\": {\"General\": [\"Add HTTP client JMX metrics. ({issue}`6453`)\", \"Improve query performance by reducing worker to worker communication overhead. ({issue}`6283`, {issue}`6349`)\", \"Improve performance of queries that contain `IS NOT DISTINCT FROM` join predicates. ({issue}`6404`)\", \"Fix failure when restricted columns have column masks. ({issue}`6017`)\", \"Fix failure when `try` expressions reference columns that contain `@` or `:` in their names. ({issue}`6380`)\", \"Fix memory management config handling to use `query.max-total-memory-per-node`\\nrather than only using `query.max-memory-per-node` for both values. ({issue}`6349`)\"], \"Web UI\": [\"Fix truncation of query text in cluster overview page. ({issue}`6216`)\"], \"JDBC driver\": [\"Accept `java.time.OffsetTime` in `PreparedStatement.setObject(int, Object)`. ({issue}`6352`)\", \"Extend `PreparedStatement.setObject(int, Object, int)` to allow setting `time with time zone` and `timestamp with time zone`\\nvalues with precision higher than nanoseconds. This can be done via providing a `String` value representing a valid SQL literal. ({issue}`6352`)\"], \"BigQuery connector\": [\"Fix incorrect results for `count(*)` queries with views. ({issue}`5635`)\"], \"Cassandra connector\": [\"Support `DELETE` statement with primary key or partition key. ({issue}`4059`)\"], \"Elasticsearch connector\": [\"Improve query analysis performance when Elasticsearch contains many index mappings. ({issue}`6368`)\"], \"Kafka connector\": [\"Support Kafka Schema Registry for Avro topics. ({issue}`6137`)\"], \"SQL Server connector\": [\"Add `data_compression` table property to control the target compression in SQL Server.\\nThe allowed values are `NONE`, `ROW` or `PAGE`. ({issue}`4693`)\"], \"Other connectors\": \"This change applies to the MySQL, Oracle, PostgreSQL, Redshift, and SQL Server connectors.\\n\\n['Send shorter and potentially more performant queries to remote database when a Presto query has a `NOT IN`\\\\npredicate eligible for pushdown into the connector. ({issue}`6075`)']\", \"SPI\": [\"Rename `LongTimeWithTimeZone.getPicoSeconds()` to `LongTimeWithTimeZone.getPicoseconds()`. ({issue}`6354`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 223]\"}, {\"title\": \"Release 351 (3 Jan 2021)\", \"description\": null, \"content\": {\"General\": [\"Rename client protocol headers to start with `X-Trino-`.\\nLegacy clients can be supported by setting the configuration property\\n`protocol.v1.alternate-header-name` to `Presto`. This configuration\\nproperty is deprecated and will be removed in a future release.\"], \"JMX MBean naming\": [\"Rename base domain name for server MBeans to `trino`. The name can\\nbe changed using the configuration property `jmx.base-name`.\", \"Rename base domain name for the Elasticsearch, Hive, Iceberg, Raptor,\\nand Thrift connectors to `trino.plugin`. The name can be changed\\nusing the catalog configuration property `jmx.base-name`.\"], \"Server RPM\": [\"Rename installation directories from `presto` to `trino`.\"], \"Docker image\": [\"Publish image as [`trinodb/trino`](https://hub.docker.com/r/trinodb/trino).\", \"Change base image to `azul/zulu-openjdk-centos`.\", \"Change configuration directory to `/etc/trino`.\", \"Rename CLI in image to `trino`.\"], \"CLI\": [\"Use new client protocol header names. The CLI is not compatible with older servers.\"], \"JDBC driver\": [\"Use new client protocol header names. The driver is not compatible with older servers.\", \"Change driver URL prefix to `jdbc:trino:`.\\nThe old prefix is deprecated and will be removed in a future release.\", \"Change driver class to `io.trino.jdbc.TrinoDriver`.\\nThe old class name is deprecated and will be removed in a future release.\", \"Rename Java package for all driver classes to `io.trino.jdbc` and rename\\nvarious driver classes such as `TrinoConnection` to start with `Trino`.\"], \"Hive connector\": [\"Rename JMX name for `PrestoS3FileSystem` to `TrinoS3FileSystem`.\", \"Change configuration properties\\n`hive.hdfs.presto.principal` to `hive.hdfs.trino.principal` and\\n`hive.hdfs.presto.keytab` to `hive.hdfs.trino.keytab`.\\nThe old names are deprecated and will be removed in a future release.\"], \"Local file connector\": [\"Change configuration properties\\n`presto-logs.http-request-log.location` to `trino-logs.http-request-log.location` and\\n`presto-logs.http-request-log.pattern` to `trino-logs.http-request-log.pattern`.\\nThe old names are deprecated and will be removed in a future release.\"], \"Thrift connector\": [\"Rename Thrift service method names starting with `presto` to `trino`.\", \"Rename all classes in the Thrift IDL starting with `Presto` to `Trino`.\", \"Rename configuration properties starting with `presto` to `trino`.\"], \"SPI\": [\"Rename Java package to `io.trino.spi`.\", \"Rename `PrestoException` to `TrinoException`.\", \"Rename `PrestoPrincipal` to `TrinoPrincipal`.\", \"Rename `PrestoWarning` to `TrinoWarning`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 224]\"}, {\"title\": \"Release 352 (9 Feb 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for [`WINDOW` clause](window-clause). ({issue}`651`)\", \"Add support for {doc}`/sql/update`. ({issue}`5861`)\", \"Add {func}`version` function. ({issue}`4627`)\", \"Allow prepared statement parameters for `SHOW STATS`. ({issue}`6582`)\", \"Update tzdata version to 2020d. As a result, queries can no longer reference the \\n`US/Pacific-New` zone, as it has been removed. ({issue}`6660`)\", \"Add `plan-with-table-node-partitioning` feature config that corresponds to\\nexisting `plan_with_table_node_partitioning` session property. ({issue}`6811`)\", \"Improve performance of queries using {func}`rank()` window function. ({issue}`6333`)\", \"Improve performance of {func}`sum` and {func}`avg` for `decimal` types. ({issue}`6951`)\", \"Improve join performance. ({issue}`5981`)\", \"Improve query planning time for queries using range predicates or large `IN` lists. ({issue}`6544`)\", \"Fix window and streaming aggregation semantics regarding peer rows. Now peer rows are\\ngrouped using `IS NOT DISTINCT FROM` instead of the `=` operator. ({issue}`6472`) \", \"Fix query failure when using an element of `array(timestamp(p))` in a complex expression \\nfor `p` greater than 6. ({issue}`6350`)\", \"Fix failure when using geospatial functions in a join clause and `spatial_partitioning_table_name` is set. ({issue}`6587`)\", \"Fix `CREATE TABLE AS` failure when source table has hidden columns. ({issue}`6835`)\"], \"Security\": [\"Allow configuring HTTP client used for OAuth2 authentication. ({issue}`6600`)\", \"Add token polling client API for OAuth2 authentication. ({issue}`6625`)\", \"Support JWK with certificate chain for OAuth2 authorization. ({issue}`6428`)\", \"Add scopes to OAuth2 configuration. ({issue}`6580`)\", \"Optionally verify JWT audience (`aud`) field for OAuth2 authentication. ({issue}`6501`)\", \"Guard against replay attacks in OAuth2 by using `nonce` cookie when `openid` scope is requested. ({issue}`6580`)\"], \"JDBC driver\": [\"Add OAuth2 authentication. ({issue}`6576`)\", \"Support user impersonation when using password-based authentication\\nusing the new `sessionUser` parameter. ({issue}`6549`)\"], \"Docker image\": [\"Remove support for configuration directory `/usr/lib/trino/etc`. The configuration \\nshould be provided in `/etc/trino`. ({issue}`6497`)\"], \"CLI\": [\"Support user impersonation when using password-based authentication using the\\n`--session-user` command line option. ({issue}`6567`)\"], \"BigQuery connector\": [\"Add a `view_definition` system table which exposes BigQuery view definitions. ({issue}`3687`)\", \"Fix query failure when calculating `count(*)` aggregation on a view more than once, \\nwithout any filter. ({issue}`6706`).\"], \"Hive connector\": [\"Add `UPDATE` support for ACID tables. ({issue}`5861`)\", \"Match columns by index rather than by name by default for ORC ACID tables. ({issue}`6479`)\", \"Match columns by name rather than by index by default for Parquet files.\\nThis can be changed using `hive.parquet.use-column-names` configuration property and `parquet_use_column_names`\\nsession property. ({issue}`6479`)\", \"Remove the `hive.partition-use-column-names` configuration property and the\\n`partition_use_column_names ` session property. This is now determined automatically. ({issue}`6479`)\", \"Support timestamps with microsecond or nanosecond precision (as configured with\\n`hive.timestamp-precision` property) nested within `array`, `map` or `struct` data types. ({issue}`5195`)\", \"Support reading from table in Sequencefile format that uses LZO compression. ({issue}`6452`)\", \"Expose AWS HTTP Client stats via JMX. ({issue}`6503`)\", \"Allow specifying S3 KMS Key ID used for client side encryption via security mapping \\nconfig and extra credentials. ({issue}`6802`)\", \"Fix writing incorrect `timestamp` values within `row`, `array` or `map` when using Parquet file format. ({issue}`6760`)\", \"Fix possible S3 connection leak on query failure. ({issue}`6849`)\"], \"Iceberg connector\": [\"Add `iceberg.max-partitions-per-writer` config property to allow configuring the limit on partitions per writer. ({issue}`6650`)\", \"Optimize cardinality-insensitive aggregations ({func}`max`, {func}`min`, {func}`distinct`, {func}`approx_distinct`) \\nover identity partition columns with `optimizer.optimize-metadata-queries` config property \\nor `optimize_metadata_queries` session property. ({issue}`5199`)\", \"Provide `use_file_size_from_metadata` catalog session property and `iceberg.use-file-size-from-metadata` \\nconfig property to fix query failures on tables with wrong file sizes stored in the metadata. ({issue}`6369`)\", \"Fix the mapping of nested fields between table metadata and ORC file metadata. This \\nenables evolution of `row` typed columns for Iceberg tables stored in ORC. ({issue}`6520`)\"], \"Kinesis connector\": [\"Support GZIP message compression. ({issue}`6442`)\"], \"MySQL connector\": [\"Improve performance for certain complex queries involving aggregation and predicates (e.g. `HAVING` clause)\\nby pushing the aggregation and predicates computation into the remote database. ({issue}`6667`)\", \"Improve performance for certain queries using `stddev_pop`, `stddev_samp`, `var_pop`, `var_samp` aggregation \\nfunctions by pushing the aggregation and predicates computation into the remote database. ({issue}`6673`)\"], \"PostgreSQL connector\": [\"Improve performance for certain complex queries involving aggregation and predicates (e.g. `HAVING` clause)\\nby pushing the aggregation and predicates computation into the remote database. ({issue}`6667`)\", \"Improve performance for certain queries using `stddev_pop`, `stddev_samp`, `var_pop`, `var_samp`,\\n`covar_pop`, `covar_samp`, `corr`, `regr_intercept`, `regr_slope` aggregation functions\\nby pushing the aggregation and predicates computation into the remote database. ({issue}`6731`)\"], \"Redshift connector\": [\"Use the Redshift JDBC driver to access Redshift. As a result, `connection-url` in catalog \\nconfiguration files needs to be updated from `jdbc:postgresql:...` to `jdbc:redshift:...`. ({issue}`6465`)\"], \"SQL Server connector\": [\"Avoid query failures due to transaction deadlocks in SQL Server by using transaction snapshot isolation. ({issue}`6274`)\", \"Honor precision of SQL Server's `datetime2` type . ({issue}`6654`)\", \"Add support for Trino `timestamp` type in `CREATE TABLE` statement, by mapping it to SQL Server's `datetime2` type.\\nPreviously, it was incorrectly mapped to SQL Server's `timestamp` type. ({issue}`6654`)\", \"Add support for the `time` type. ({issue}`6654`)\", \"Improve performance for certain complex queries involving aggregation and predicates (e.g. `HAVING` clause)\\nby pushing the aggregation and predicates computation into the remote database. ({issue}`6667`)\", \"Fix failure when querying tables having indexes and constraints. ({issue}`6464`)\"], \"SPI\": [\"Add support for join pushdown via the `ConnectorMetadata.applyJoin()` method. ({issue}`6752`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 225]\"}, {\"title\": \"Release 353 (5 Mar 2021)\", \"description\": null, \"content\": {\"General\": [\"Add {doc}`/connector/clickhouse`. ({issue}`4500`)\", \"Extend support for correlated subqueries including `UNNEST`. ({issue}`6326`, {issue}`6925`, {issue}`6951`)\", \"Add {func}`to_geojson_geometry` and {func}`from_geojson_geometry` functions. ({issue}`6355`)\", \"Add support for values of any integral type (`tinyint`, `smallint`, `integer`, `bigint`, `decimal(p, 0)`)\\nin window frame bound specification. ({issue}`6897`)\", \"Improve query planning time for queries containing `IN` predicates with many elements. ({issue}`7015`)\", \"Fix potential incorrect results when columns from `WITH` clause are exposed with aliases. ({issue}`6839`)\", \"Fix potential incorrect results for queries containing multiple `<` predicates. ({issue}`6896`)\", \"Always show `SECURITY` clause in `SHOW CREATE VIEW`. ({issue}`6913`)\", \"Fix reporting of column references for aliased tables in `QueryCompletionEvent`. ({issue}`6972`)\", \"Fix potential compiler failure when constructing an array with more than 128 elements. ({issue}`7014`)\", \"Fail `SHOW COLUMNS` when column metadata cannot be retrieved. ({issue}`6958`)\", \"Fix rendering of function references in `EXPLAIN` output. ({issue}`6703`)\", \"Fix planning failure when `WITH` clause contains hidden columns. ({issue}`6838`)\", \"Prevent client hangs when OAuth2 authentication fails. ({issue}`6659`)\"], \"Server RPM\": [\"Allow configuring process environment variables through `/etc/trino/env.sh`. ({issue}`6635`)\"], \"BigQuery connector\": [\"Add support for `CREATE TABLE` and `DROP TABLE` statements. ({issue}`3767`)\", \"Allow for case-insensitive identifiers matching via `bigquery.case-insensitive-name-matching` config property. ({issue}`6748`)\"], \"Hive connector\": [\"Add support for `current_user()` in Hive defined views. ({issue}`6720`)\", \"Add support for reading and writing column statistics from Glue metastore. ({issue}`6178`)\", \"Improve parallelism of bucketed tables inserts. Inserts into bucketed tables can now be parallelized\\nwithin task using `task.writer-count` feature config. ({issue}`6924`, {issue}`6866`)\", \"Fix a failure when `INSERT` writes to a partition created by an earlier `INSERT` statement. ({issue}`6853`)\", \"Fix handling of folders created using the AWS S3 Console. ({issue}`6992`)\", \"Fix query failures on ``information_schema.views`` table when there are failures \\ntranslating hive view definitions. ({issue}`6370`)\"], \"Iceberg connector\": [\"Fix handling of folders created using the AWS S3 Console. ({issue}`6992`)\", \"Fix query failure when reading nested columns with field names that may \\ncontain upper case characters. ({issue}`7180`)\"], \"Kafka connector\": [\"Fix failure when querying Schema Registry tables. ({issue}`6902`)\", \"Fix querying of Schema Registry tables with References in their schema. ({issue}`6907`)\", \"Fix listing of schema registry tables having ambiguous subject name in lower case. ({issue}`7048`)\"], \"MySQL connector\": [\"Fix failure when reading a `timestamp` or `datetime` value with more than 3 decimal digits \\nin the fractional seconds part. ({issue}`6852`)\", \"Fix incorrect predicate pushdown for `char` and `varchar` column with operators \\nlike `<>`, `<`, `<=`, `>` and `>=` due different case sensitivity between Trino \\nand MySQL. ({issue}`6746`, {issue}`6671`)\"], \"MemSQL connector\": [\"Fix failure when reading a `timestamp` or `datetime` value with more than 3 decimal digits \\nof the second fraction. ({issue}`6852`)\", \"Fix incorrect predicate pushdown for `char` and `varchar` column with operators \\nlike `<>`, `<`, `<=`, `>` and `>=` due different case sensitivity between Trino \\nand MemSQL. ({issue}`6746`, {issue}`6671`)\"], \"Phoenix connector\": [\"Add support for Phoenix 5.1. This can be used by setting `connector.name=phoenix5` in catalog\\nconfiguration properties. ({issue}`6865`)\", \"Fix failure when query contains a `LIMIT` exceeding 2147483647. ({issue}`7169`)\"], \"PostgreSQL connector\": [\"Improve performance of queries with `ORDER BY ... LIMIT` clause, when the computation \\ncan be pushed down to the underlying database. This can be enabled by setting `topn-pushdown.enabled`.\\nEnabling this feature can currently result in incorrect query results when sorting\\non `char` or `varchar` columns. ({issue}`6847`)\", \"Fix incorrect predicate pushdown for `char` and `varchar` column with operators \\nlike `<>`, `<`, `<=`, `>` and `>=` due different case collation between Trino \\nand PostgreSQL. ({issue}`3645`)\"], \"Redshift connector\": [\"Fix failure when reading a `timestamp` value with more than 3 decimal digits of\\nthe second fraction. ({issue}`6893`)\"], \"SQL Server connector\": [\"Abort queries on the SQL Server side when the Trino query is finished. ({issue}`6637`)\", \"Fix incorrect predicate pushdown for `char` and `varchar` column with operators \\nlike `<>`, `<`, `<=`, `>` and `>=` due different case sensitivity between Trino \\nand SQL Server. ({issue}`6753`)\"], \"Other connectors\": [\"Reduce number of opened JDBC connections during planning for ClickHouse, Druid, MemSQL, MySQL,\\nOracle, Phoenix, Redshift, and SQL Server connectors. ({issue}`7069`)\", \"Add experimental support for join pushdown in PostgreSQL, MySQL, MemSQL, Oracle, and SQL Server connectors.\\nIt can be enabled with the `experimental.join-pushdown.enabled=true` catalog configuration property. ({issue}`6874`)\"], \"SPI\": [\"Fix lazy blocks to call listeners that are registered after the top level block is already loaded.\\nPreviously, such registered listeners were not called when the nested blocks were later loaded. ({issue}`6783`)\", \"Fix case where LazyBlock.getFullyLoadedBlock() would not load nested blocks \\nwhen the top level block was already loaded. ({issue}`6783`)\", \"Do not include coordinator node in the result of `ConnectorAwareNodeManager.getWorkerNodes()` \\nwhen `node-scheduler.include-coordinator` is false. ({issue}`7007`)\", \"The function name passed to `ConnectorMetadata.applyAggregation()` \\nis now the canonical function name. Previously, if query used function alias, the alias \\nname was passed. ({issue}`6189`)\", \"Add support for redirecting table scans to multiple tables that are unioned together. ({issue}`6679`)\", \"Change return type of `Range.intersect(Range)`. The method now \\nreturns `Optional.empty()` instead of throwing when ranges do not overlap. ({issue}`6976`)\", \"Change signature of `ConnectorMetadata.applyJoin()` to have an additional `JoinStatistics` argument. ({issue}`7000`)\", \"Deprecate `io.trino.spi.predicate.Marker`.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 226]\"}, {\"title\": \"Release 354 (19 Mar 2021)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of certain queries involving `LEFT`, `RIGHT` and `FULL JOIN`\\nwhen one side of the join is known to produce a single row. ({issue}`7090`)\", \"Preferred write partitioning is now triggered automatically when the estimated number\\nof written partitions exceeds or is equal to `preferred-write-partitioning-min-number-of-partitions`.\\nThis estimation requires that the input tables of the query have statistics. To enable\\npreferred partitioning unconditionally, set `preferred-write-partitioning-min-number-of-partitions` to `1`.\\nTo disable preferred write partitioning, set `use-preferred-write-partitioning` to `false`.\\n({issue}`6920`)\", \"Fix incorrect results when multiple similar subqueries contain `UNION` clauses that differ\\nonly in the `ALL` vs `DISTINCT` qualifier. ({issue}`7345`)\", \"Fix `DELETE` and `UPDATE` for connectors that subsume filters. ({issue}`7302`)\", \"Fix failure when subqueries contain `EXCEPT` or `INTERSECT`. ({issue}`7342`)\", \"Fix failure of queries that contain `RIGHT JOIN` when late materialization is enabled. ({issue}`6784`)\"], \"Security\": [\"Fix retries for OAuth 2.0 authentication in case of token expiry. ({issue}`7172`)\"], \"CLI\": [\"Support OAuth 2.0 authentication. ({issue}`7054`)\"], \"ClickHouse connector\": [\"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\"], \"Elasticsearch connector\": [\"Fix failure when reading single-valued fields for array types. ({issue}`7012`)\"], \"Hive connector\": [\"Respect partition filter for `DELETE` and `UPDATE` of ACID tables. Previously, the partition\\nfilter was ignored, resulting in the deletion or update of too many rows. ({issue}`7302`)\", \"Fix allocation of statement IDs for ACID tables, which could result in query failure or\\ndata loss due to creating multiple delta files with the same name. ({issue}`7302`)\", \"Fix incorrect query results when reading from an incorrectly bucketed table created and registered\\nwith the metastore by Spark. ({issue}`6848`)\", \"Avoid leaking file system connections or other resources when using the Avro file format. ({issue}`7178`)\", \"Fix query failure when columns of a CSV table are declared as a type other than `varchar` (`string`) in Glue\\nmetastore. Columns are now interpreted as `varchar` values, instead. ({issue}`7059`)\", \"Rename `hive.parallel-partitioned-bucketed-inserts` configuration property to `hive.parallel-partitioned-bucketed-writes`. ({issue}`7259`)\"], \"Iceberg connector\": [\"Fix queries on empty tables without a snapshot ID that were created by Spark. ({issue}`7233`)\", \"Update to Iceberg 0.11.0 behavior for transforms of dates and timestamps\\nbefore 1970. Data written by older versions of Trino and Iceberg will be\\nread correctly. New data will be written correctly, but may be read\\nincorrectly by older versions of Trino and Iceberg. ({issue}`7049`)\"], \"MemSQL connector\": [\"Add support for MemSQL 3.2. ({issue}`7179`)\", \"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\", \"Improve performance of queries with `ORDER BY ... LIMIT` clause when the computation\\ncan be pushed down to the underlying database. ({issue}`7326`)\"], \"MySQL connector\": [\"Use proper column type (`datetime(3)`) in MySQL when creating a table with `timestamp(3)` column.\\nPreviously, the second fraction was being truncated. ({issue}`6909`)\", \"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\", \"Improve performance of queries with `ORDER BY ... LIMIT` clause when the computation\\ncan be pushed down to the underlying database. ({issue}`7326`)\"], \"PostgreSQL connector\": [\"Fix incorrect query results for `ORDER BY ... LIMIT` clause when sorting on `char` or `varchar` columns\\nand `topn-pushdown.enabled` configuration property is enabled. The optimization is now enabled by default.\\n({issue}`7170`, {issue}`7314`)\", \"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\"], \"Redshift connector\": [\"Fix failure when query contains a `LIMIT` exceeding 2147483647. ({issue}`7236`)\", \"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\"], \"SQL Server connector\": [\"Add support for parametric `time` type. ({issue}`7122`)\", \"Use correct case for name of the schema in `CREATE SCHEMA`. ({issue}`7239`)\", \"Improve performance of queries with `ORDER BY ... LIMIT` clause when the computation\\ncan be pushed down to the underlying database. ({issue}`7324`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 227]\"}, {\"title\": \"Release 355 (8 Apr 2021)\", \"description\": null, \"content\": {\"General\": [\"Report tables that are directly referenced by a query in `QueryCompletedEvent`. ({issue}`7330`)\", \"Report columns that are the target of `INSERT` or `UPDATE` queries in `QueryCompletedEvent`. This includes\\ninformation about which input columns they are derived from. ({issue}`7425`, {issue}`7465`) \", \"Rename `optimizer.plan-with-table-node-partitioning` config property to `optimizer.use-table-scan-node-partitioning`. ({issue}`7257`)\", \"Improve query parallelism when table bucket count is small compared to number of nodes. \\nThis optimization is now triggered automatically when the ratio between table buckets and \\npossible table scan tasks exceeds or is equal to `optimizer.table-scan-node-partitioning-min-bucket-to-task-ratio`. ({issue}`7257`)\", \"Include information about {doc}`/admin/spill` in {doc}`/sql/explain-analyze`. ({issue}`7427`)\", \"Disallow inserting data into tables that have row filters. ({issue}`7346`)\", \"Improve performance of queries that can benefit from both {doc}`/optimizer/cost-based-optimizations` and join pushdown\\nby giving precedence to cost-based optimizations. ({issue}`7331`)\", \"Fix inconsistent behavior for {func}`to_unixtime` with values of type `timestamp(p)`. ({issue}`7450`)\", \"Change return type of {func}`from_unixtime` and {func}`from_unixtime_nanos` to `timestamp(p) with time zone`. ({issue}`7460`)\"], \"Security\": [\"Add support for configuring multiple password authentication plugins. ({issue}`7151`)\"], \"JDBC driver\": [\"Add `assumeLiteralNamesInMetadataCallsForNonConformingClients` parameter for use as a workaround when\\napplications do not properly escape schema or table names in calls to `DatabaseMetaData` methods. ({issue}`7438`)\"], \"ClickHouse connector\": [\"Support creating tables with MergeTree storage engine. ({issue}`7135`)\"], \"Hive connector\": [\"Support Hive views containing `LATERAL VIEW json_tuple(...) AS ...` syntax. ({issue}`7242`)\", \"Fix incorrect results when reading from a Hive view that uses array subscript operators. ({issue}`7271`)\", \"Fix incorrect results when querying the `$file_modified_time` hidden column. ({issue}`7511`)\"], \"Phoenix connector\": [\"Improve performance when fetching table metadata during query analysis. ({issue}`6975`)\", \"Improve performance of queries with `ORDER BY ... LIMIT` clause when the computation\\ncan be pushed down to the underlying database. ({issue}`7490`)\"], \"SQL Server connector\": [\"Improve performance when fetching table metadata during query analysis. ({issue}`6975`)\"], \"SPI\": [\"Engine now uses `ConnectorMaterializedViewDefinition#storageTable`\\nto determine materialized view storage table. ({issue}`7319`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 228]\"}, {\"title\": \"Release 356 (30 Apr 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for {doc}`/sql/match-recognize`. ({issue}`6111`)\", \"Add {func}`soundex` function. ({issue}`4022`) \", \"Introduce `system.metadata.materialized_view_properties` table for listing available materialized view properties. ({issue}`7615`)\", \"Add support for limiting the maximum planning time via the `query.max-planning-time` configuration property. ({issue}`7213`)\", \"Allow redirecting clients to an alternative location to fetch query information. This can be configured \\nvia the `query.info-url-template` configuration property. ({issue}`7678`)\", \"Allow cancellation of queries during planning phase. ({issue}`7213`)\", \"Improve performance of `ORDER BY ... LIMIT` queries over a `LEFT JOIN`. ({issue}`7028`)\", \"Improve performance of queries with predicates on boolean columns. ({issue}`7263`)\", \"Improve planning time for queries with large `IN` predicates. ({issue}`7556`)\", \"Improve performance of queries that contain joins on `varchar` keys of different length. ({issue}`7644`)\", \"Improve performance of queries when late materialization is enabled. ({issue}`7695`)\", \"Reduce coordinator network overhead when scheduling queries. ({issue}`7351`)\", \"Fix possible deadlock for `JOIN` queries when spilling is enabled. ({issue}`7455`)\", \"Fix incorrect results for queries containing full outer join with an input that is known to produce one row. ({issue}`7629`)\", \"Fix failure when quantified comparison expressions contain scalar subqueries. ({issue}`7792`)\"], \"Security\": [\"Materialized views require `UPDATE` privilege to be refreshed. ({issue}`7707`)\", \"Add dedicated access control for creating and dropping materialized views. ({issue}`7645`)\", \"Add dedicated access control for refreshing materialized views. Insert privilege on storage table is no\\nlonger required. ({issue}`7707`)\", \"Fix authentication failure when providing multiple scope values for `http-server.authentication.oauth2.scopes`. ({issue}`7706`)\"], \"JDBC driver\": [\"Add support for caching OAuth2 credentials in memory to avoid unnecessary authentication flows. ({issue}`7309`)\"], \"BigQuery connector\": [\"Add support for `CREATE SCHEMA` and `DROP SCHEMA` statements. ({issue}`7543`)\", \"Improve table listing performance when case insensitive matching is enabled. ({issue}`7628`)\"], \"Cassandra connector\": [\"Fix `NullPointerException` when reading an empty timestamp value. ({issue}`7433`)\"], \"Hive connector\": [\"Improve performance when reading dictionary-encoded Parquet files. ({issue}`7754`)\", \"Fix incorrect results when referencing nested fields with non-lowercase names from ORC files. ({issue}`7350`)\", \"Always use row-by-row deletes for ACID tables rather than dropping partitions. ({issue}`7621`)\", \"Allow reading from ORC ACID transactional tables when `_orc_acid_version` metadata files are missing. ({issue}`7579`)\", \"Add `UPDATE` support for ACID tables that were originally created as non-transactional. ({issue}`7622`)\", \"Add support for connection proxying for Azure ADLS endpoints. ({issue}`7509`)\"], \"Iceberg connector\": [\"Show Iceberg tables created by other engines in `SHOW TABLES` output. ({issue}`1592`)\", \"Improve performance when reading dictionary-encoded Parquet files. ({issue}`7754`)\", \"Improve query planning through table metadata caching. ({issue}`7336`)\", \"Fix failure querying materialized views that were created using the session catalog and schema. ({issue}`7711`)\", \"Fix listing of materialized views when using `SHOW TABLES` query. ({issue}`7790`)\"], \"Kafka connector\": [\"Add support for TLS security protocol. ({issue}`6929`)\"], \"MemSQL connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\"], \"MongoDB connector\": [\"Fix handling of non-lowercase MongoDB views. ({issue}`7491`)\"], \"MySQL connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\", \"Exclude an internal `sys` schema from schema listings. ({issue}`6337`)\"], \"Oracle connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\"], \"Phoenix connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\"], \"PostgreSQL connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\", \"Cancel query on PostgreSQL when the Trino query is cancelled. ({issue}`7306`)\", \"Discontinue support for PostgreSQL 9.5, which has reached end of life. ({issue}`7676`)\"], \"Redshift connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\"], \"SQL Server connector\": [\"Improve metadata caching hit rate. ({issue}`7039`)\", \"Fix query failure when snapshot isolation is disabled in target SQL Server database,\\nbut `READ_COMMITTED_SNAPSHOT` is still enabled. ({issue}`7548`)\", \"Fix reading `date` values before 1583-10-14. ({issue}`7634`)\"], \"SPI\": [\"Require that `ConnectorMaterializedViewDefinition` provides a view owner. ({issue}`7489`)\", \"Add `Connector#getMaterializedViewPropertyManager` for specifying materialized view properties. ({issue}`7615`)\", \"Add `ConnectorAccessControl.checkCanCreateMaterializedView()` and\\n`ConnectorAccessControl.checkCanDropMaterializedView()` for authorizing\\ncreation and removal of materialized views. ({issue}`7645`)\", \"Allow a materialized view to return a storage table in a different catalog or schema. ({issue}`7638`)\", \"Add `ConnectorAccessControl.checkCanRefreshMaterializedView()` for authorizing\\nrefresh of materialized views. ({issue}`7707`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 229]\"}, {\"title\": \"Release 357 (21 May 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for subquery expressions that return multiple columns.\\nExample: `SELECT x = (VALUES (1, 'a'))` ({issue}`7773`, {issue}`7863`)\", \"Allow aggregation pushdown when `COUNT(1)` is used with `GROUP BY`. ({issue}`7251`)\", \"Add support for `CURRENT_CATALOG` and `CURRENT_SCHEMA`. ({issue}`7824`)\", \"Add {func}`format_number` function. ({issue}`1878`)\", \"Change `row` to `json` cast to produce JSON objects instead of JSON arrays. This behavior can be restored \\nwith the `deprecated.legacy-row-to-json-cast` configuration option. ({issue}`3536`)\", \"Print dynamic filters summary in `EXPLAIN ANALYZE`. ({issue}`7874`)\", \"Improve performance for queries using `IN` predicate with a short list of constants. ({issue}`7840`)\", \"Release memory immediately when queries involving window functions fail. ({issue}`7947`)\", \"Fix incorrect handling of row expressions for `IN` predicates, quantified comparisons and scalar subqueries. Previously,\\nthe queries would succeed where they should have failed with a type mismatch error. ({issue}`7797`)\", \"Fix failure when using `PREPARE` with a `GRANT` statement that contains quoted SQL keywords. ({issue}`7941`)\", \"Fix cluster instability after executing certain large `EXPLAIN` queries. ({issue}`8017`)\"], \"Security\": [\"Enforce materialized view creator security policies when view is fresh. ({issue}`7618`)\", \"Use system truststore for OAuth2 and JWK for JWT authentication. Previously, the truststore \\nconfigured for internal communication was used. This means that globally trusted certificates \\nwill work by default. ({issue}`7936`)\", \"Fix handling of SNI for multiple TLS certificates. ({issue}`8007`)\"], \"Web UI\": [\"Make the UI aware of principal-field (configured with `http-server.authentication.oauth2.principal-field`) when \\n`web-ui.authentication.type` is set to `oauth2`. ({issue}`7526`)\"], \"JDBC driver\": [\"Cancel Trino query execution when JDBC statement is closed. ({issue}` 7819`) \", \"Close statement when connection is closed. ({issue}` 7819`)\"], \"CLI\": [\"Add `clear` command to clear the screen. ({issue}`7632`)\"], \"BigQuery connector\": [\"Fix failures for queries accessing `information_schema.columns` when `case-insensitive-name-matching` is disabled. ({issue}`7830`)\", \"Fix query failure when a predicate on a BigQuery `string` column contains a value with a single quote (`'`). ({issue}`7784`)\"], \"ClickHouse connector\": [\"Improve performance of aggregation queries by computing aggregations within ClickHouse. Currently, the following aggregate functions \\nare eligible for pushdown: `count`, `min`, `max`, `sum` and `avg`. ({issue}`7434`)\", \"Map ClickHouse `UUID` columns as `UUID` type in Trino instead of `VARCHAR`. ({issue}`7097`)\"], \"Elasticsearch connector\": [\"Support decoding `timestamp` columns encoded as strings containing milliseconds since epoch values. ({issue}`7838`)\", \"Retry requests with backoff when Elasticsearch is overloaded. ({issue}`7423`)\"], \"Kinesis connector\": [\"Add `kinesis.table-description-refresh-interval` configuration property to set the\\nrefresh interval for fetching table descriptions from S3. ({issue}`1609`)\"], \"Kudu connector\": [\"Fix query failures for grouped execution on range partitioned tables. ({issue}`7738`)\"], \"MongoDB connector\": [\"Redact the value of `mongodb.credentials` in the server log. ({issue}`7862`)\", \"Add support for dropping columns. ({issue}`7853`)\"], \"Pinot connector\": [\"Add support for complex filter expressions in passthrough queries. ({issue}`7161`)\"], \"Other connectors\": \"This change applies to the Druid, MemSQL, MySQL, Oracle, Phoenix, PosgreSQL, Redshift, and SQL Server connectors.\\n\\n['Add rule support for identifier mapping. The rules can be configured via the\\\\n`case-insensitive-name-matching.config-file` configuration property. ({issue}`7841`)']\", \"SPI\": [\"Make `ConnectorMaterializedViewDefinition` non-serializable. It is the responsibility of the connector to serialize \\nand store the materialized view definitions in an appropriate format. ({issue}`7762`)\", \"Deprecate `TupleDomain.transform`. ({issue}`7980`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 230]\"}, {\"title\": \"Release 358 (1 Jun 2021)\", \"description\": null, \"content\": {\"General\": [\"Support arbitrary queries in {doc}`/sql/show-stats`. ({issue}`8026`)\", \"Improve performance of complex queries involving joins and `TABLESAMPLE`. ({issue}`8094`)\", \"Improve performance of `ORDER BY ... LIMIT` queries on sorted data. ({issue}`6634`)\", \"Reduce graceful shutdown time for worker nodes. ({issue}`8149`)\", \"Fix query failure columns of non-orderable types (e.g. `HyperLogLog`, `tdigest`, etc.), are involved in a join. ({issue}`7723`)\", \"Fix failure for queries containing repeated ordinals in a `GROUP BY` clause.\\nExample: `SELECT x FROM t GROUP BY 1, 1`. ({issue}`8023`)\", \"Fix failure for queries containing repeated expressions in the `ORDER BY` clause of an aggregate function.\\nExample: `SELECT array_agg(x ORDER BY y, y) FROM (VALUES ('a', 2)) t(x, y)`. ({issue}`8080`)\"], \"JDBC Driver\": [\"Remove legacy JDBC URL prefix `jdbc:presto:`. ({issue}`8042`)\", \"Remove legacy driver classes `io.prestosql.jdbc.PrestoDriver`\\nand `com.facebook.presto.jdbc.PrestoDriver`. ({issue}`8042`)\"], \"Hive connector\": [\"Add support for reading from Hive views that use `LATERAL VIEW EXPLODE`\\nor `LATERAL VIEW OUTER EXPLODE` over array of `STRUCT`. ({issue}`8120`)\", \"Improve performance of `ORDER BY ... LIMIT` queries on sorted data. ({issue}`6634`)\"], \"Iceberg connector\": [\"Fix failure when listing materialized views in `information_schema.tables` or via the \\n`java.sql.DatabaseMetaData.getTables()` JDBC API. ({issue}`8151`)\"], \"Memory connector\": [\"Improve performance of certain complex queries involving joins. ({issue}`8095`)\"], \"SPI\": [\"Remove deprecated `ConnectorPageSourceProvider.createPageSource()` method overrides. ({issue}`8077`)\", \"Add support for casting the columns of a redirected table scan when source column types don't match. ({issue}`6066`)\", \"Add `ConnectorMetadata.redirectTable()` to allow connectors to redirect table reads and metadata listings. ({issue}`7606`)\", \"Add `ConnectorMetadata.streamTableColumns()` for streaming column metadata in a redirection-aware manner. The\\nalternate method for column listing `ConnectorMetadata.listTableColumns()` is now deprecated. ({issue}`7606`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 231]\"}, {\"title\": \"Release 359 (1 Jul 2021)\", \"description\": null, \"content\": {\"General\": [\"Raise minimum required Java version for running Trino server to 11.0.11. ({issue}`8103`)\", \"Add support for row pattern recognition in window specification. ({issue}`8141`)\", \"Add support for {doc}`/sql/set-time-zone`. ({issue}`8112`)\", \"Add {func}`geometry_nearest_points`. ({issue}`8280`)\", \"Add {func}`current_groups`. ({issue}`8446`)\", \"Add support for `varchar`, `varbinary` and `date` types to {func}`make_set_digest`. ({issue}`8295`)\", \"Add support for granting `UPDATE` privileges. ({issue}`8279`)\", \"List materialized view columns in the `information_schema.columns` table. ({issue}`8113`)\", \"Expose comments in views and materialized views in `system.metadata.table_comments` correctly. ({issue}`8327`)\", \"Fix query failure for certain queries with `ORDER BY ... LIMIT` on sorted data. ({issue}`8184`)\", \"Fix incorrect query results for certain queries using `LIKE` with pattern against\\n`char` columns in the `WHERE` clause. ({issue}`8311`)\", \"Fix planning failure when using {func}`hash_counts`. ({issue}`8248`)\", \"Fix error message when grouping expressions in `GROUP BY` queries contain aggregations, window functions or grouping operations. ({issue}`8247`)\"], \"Security\": [\"Fix spurious impersonation check when applying user mapping for password authentication. ({issue}`7027`)\", \"Fix handling of multiple LDAP user bind patterns. ({issue}`8134`)\"], \"Web UI\": [\"Show session timezone in query details page. ({issue}`4196`)\"], \"Docker image\": [\"Add support for ARM64. ({issue}`8397`)\"], \"CLI\": [\"Add support for logging of network traffic via the `--network-logging` command line option. ({issue}`8329`)\"], \"BigQuery connector\": [\"Add `bigquery.views-cache-ttl` config property to allow configuring the cache expiration for BigQuery views. ({issue}`8236`)\", \"Fix incorrect results when accessing BigQuery records with wrong index. ({issue}`8183`)\"], \"Elasticsearch connector\": [\"Fix potential incorrect results when queries contain an `IS NULL` predicate. ({issue}`3605`)\", \"Fix failure when multiple indexes share the same alias. ({issue}`8158`)\"], \"Hive connector\": [\"Rename `hive-hadoop2` connector to `hive`. ({issue}`8166`)\", \"Add support for Hive views which use `GROUP BY` over a subquery that also uses `GROUP BY` on matching columns. ({issue}`7635`)\", \"Add support for granting `UPDATE` privileges when `hive.security=sql-standard` is used. ({issue}`8279`)\", \"Add support for inserting data into CSV and TEXT tables with `skip_header_line_count` table property set to 1.\\nThe same applies to creating tables with data using `CREATE TABLE ... AS SELECT` syntax. ({issue}`8390`)\", \"Disallow creating CSV and TEXT tables with data if `skip_header_line_count` is set to a value\\ngreater than 0. ({issue}`8373`)\", \"Fix query failure when reading from a non-ORC insert-only transactional table. ({issue}`8259`)\", \"Fix incorrect results when reading ORC ACID tables containing deleted rows. ({issue}`8208`)\", \"Respect `hive.metastore.glue.get-partition-threads` configuration property. ({issue}`8320`)\"], \"Iceberg connector\": [\"Do not include Hive views in `SHOW TABLES` query results. ({issue}`8153`)\"], \"MongoDB connector\": [\"Skip creating an index for the `_schema` collection if it already exists. ({issue}`8264`)\"], \"MySQL connector\": [\"Support reading and writing `timestamp` values with precision higher than 3. ({issue}`6910`)\", \"Support predicate pushdown on `timestamp` columns. ({issue}`7413`)\", \"Handle `timestamp` values during forward offset changes ('gaps' in DST) correctly. ({issue}`5449`)\"], \"SPI\": [\"Introduce `ConnectorMetadata#listMaterializedViews` for listing materialized view names. ({issue}`8113`)\", \"Introduce `ConnectorMetadata#getMaterializedViews` for getting materialized view definitions. ({issue}`8113`)\", \"Enable connector to delegate materialized view refresh to itself. ({issue}`7960`)\", \"Allow computing HyperLogLog based approximate set summary as a column statistic during `ConnectorMetadata`\\ndriven statistics collection flow. ({issue}`8355`)\", \"Report output column types through `EventListener`. ({issue}`8405`)\", \"Report input column information for queries involving set operations (`UNION`, `INTERSECT` and `EXCEPT`). ({issue}`8371`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 232]\"}, {\"title\": \"Release 360 (30 Jul 2021)\", \"description\": null, \"content\": {\"General\": [\"Improve support for correlated subqueries with `GROUP BY` or `LIMIT` and\\ncomplex correlated filter conditions. ({issue}`8554`)\", \"Report cumulative query system memory usage. ({issue}`8615`)\", \"Fix `DROP SCHEMA` and `DROP SCHEMA RESTRICT` not to drop then schema if it is not empty. ({issue}`8660`)\", \"Fix query failure when there is a constant predicate on some\\ncolumn `col` (e.g `col=1`), followed by `ORDER BY col` and `LIMIT`. ({issue}`8535`)\", \"Fix `SHOW CREATE SCHEMA` failure. ({issue}`8598`)\", \"Fix query failure when running `SHOW CREATE SCHEMA information_schema`. ({issue}`8600`)\", \"Improve performance of `WHERE` clause evaluation. ({issue}`8624`)\", \"Reduce coordinator network load. ({issue}`8460`)\", \"Improve query performance by sending collected dynamic filters from coordinator to workers. ({issue}`5183`)\", \"Improve performance of inequality joins where join condition sides have different type. ({issue}`8500`)\", \"Improve performance of `IN (<subquery>)` expressions. ({issue}`8639`)\"], \"Security\": [\"Add support for automatic configuration of TLS for {doc}`/security/internal-communication`. This removes\\nthe need to provision per-worker TLS certificates. ({issue}`7954`)\"], \"CLI\": [\"Fix auto completion when pressing the tab button. ({issue}`8529`)\"], \"ClickHouse connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\"], \"Elasticsearch connector\": [\"Add support for assuming an IAM role. ({issue}`8714`)\"], \"Hive connector\": [\"Fix data corruption when performing `UPDATE` or `INSERT` on ORC ACID transactional table. ({issue}`8268`, {issue}`8452`) \"], \"Iceberg connector\": [\"Add support for Trino views. ({issue}`8540`)\", \"Prevent incorrect query results by failing a query when Iceberg table has row-level deletes. ({issue}`8450`)\", \"Fix query failure when joining with a bucketed Iceberg table. ({issue}`7502`)\", \"Fix query failure when showing stats for a bucketed Iceberg table. ({issue}`8616`)\", \"Fix query failure when joining with a partitioned table that has structural columns (`array`, `map` or `row`). ({issue}`8647`)\", \"Fix failures for queries that write tables in Parquet format. ({issue}`5201`)\", \"Improve query planning time by reducing calls to the metastore. ({issue}`8676`, {issue}`8689`)\"], \"MemSQL connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\", \"Fix performance regression of writes. ({issue}`8559`)\"], \"MongoDB connector\": [\"Add support for `json` type. ({issue}`8352`)\", \"Support reading MongoDB `DBRef` type. ({issue}`3134`)\"], \"MySQL connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\", \"Fix performance regression of writes. ({issue}`8559`)\"], \"Oracle connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\"], \"Phoenix connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Improve performance of `ORDER BY ... LIMIT` queries on sorted data for Phoenix 5. ({issue}`8171`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\", \"Fix performance regression of writes. ({issue}`8559`)\"], \"PostgreSQL connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\"], \"Redshift connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\"], \"SQL Server connector\": [\"Add `write.batch-size` connector configuration property to control JDBC batch size used during writes.\\nIt can also be controlled using the `write_batch_size` session property. ({issue}`8434`)\", \"Add new configuration property `insert.non-transactional-insert.enabled` to allow INSERT queries to write directly\\nto the target table. This can improve performance in some cases by sacrificing transactional behaviour. It can also\\nbe controlled using `non_transactional_insert` session property. ({issue}`8496`)\", \"Partial support for `DELETE` statement where predicate can be fully pushed down to the remote datasource. ({issue}`6287`)\", \"Fix performance regression of writes. ({issue}`8559`)\"], \"SPI\": [\"Cast materialized view storage table columns to match view column types. ({issue}`8408`)\", \"Remove deprecated `ConnectorSplitManager#getSplits` method overrides. ({issue}`8569`)\", \"Introduce `ConnectorPageSource#getCompletedPositions` for tracing physically read positions. ({issue}`8524`)\", \"Remove deprecated `TupleDomain.transform`. ({issue}`8056`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 233]\"}, {\"title\": \"Release 361 (27 Aug 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for subqueries in `MATCH_RECOGNIZE` and `WINDOW` clause. ({issue}`8736`)\", \"Add `system.metadata.materialized_views` table that contains detailed information about materialized views. ({issue}`8796`)\", \"Support table redirection for `INSERT`, `UPDATE` and `DELETE` operations. ({issue}`8683`)\", \"Improve performance of {func}`sum` and {func}`avg` aggregations on `decimal` values. ({issue}`8878`)\", \"Improve performance for queries using `IN` predicate with moderate to large number of constants. ({issue}`8833`)\", \"Fix failures of specific queries accessing `row` columns with\\nwith field names that would require quoting when used as an identifier. ({issue}`8845`)\", \"Fix incorrect results for queries with a comparison between a `varchar` column and a `char` constant. ({issue}`8984`)\", \"Fix invalid result when two decimals are added together. This happened in certain \\nqueries where decimals had different precision. ({issue}`8973`)\", \"Prevent dropping or renaming objects with an incompatible SQL command. For example, `DROP TABLE` no longer allows dropping a view. ({issue}`8869`)\"], \"Security\": [\"Add support for OAuth2/OIDC opaque access tokens. The property\\n`http-server.authentication.oauth2.audience` has been removed in favor of\\nusing `http-server.authentication.oauth2.client-id`, as expected by OIDC.\\nThe new property `http-server.authentication.oauth2.additional-audiences`\\nsupports audiences which are not the `client-id`. Additionally, the new\\nproperty `http-server.authentication.oauth2.issuer` is now required;\\ntokens which are not issued by this URL will be rejected. ({issue}`8641`)\"], \"JDBC driver\": [\"Implement the `PreparedStatement.getParameterMetaData()` method. ({issue}`2978`)\", \"Fix listing columns where table or schema name pattern contains an upper case value.\\nNote that this fix is on the server, not in the JDBC driver. ({issue}`8978`)\"], \"BigQuery connector\": [\"Fix incorrect result when using BigQuery `time` type. ({issue}`8999`)\"], \"Cassandra connector\": [\"Add support for predicate pushdown of `smallint`, `tinyint` and `date` types on partition columns. ({issue}`3763`)\", \"Fix incorrect results for queries containing inequality predicates on a clustering key in the `WHERE` clause. ({issue}`401`) \"], \"ClickHouse connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\", \"Fix incorrect results for aggregation functions applied to columns of type `varchar` and `char`. ({issue}`7320`)\"], \"Druid connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\"], \"Elasticsearch connector\": [\"Add support for reading fields as `json` values. ({issue}`7308`)\"], \"Hive connector\": [\"Expose `<view>$properties` system table for Trino and Hive views. ({issue}`8805`)\", \"Add support for translating Hive views which contain common table expressions. ({issue}`5977`)\", \"Add support for translating Hive views which contain outer parentheses. ({issue}`8789`)\", \"Add support for translating Hive views which use the `from_utc_timestamp` function. ({issue}`8502`)\", \"Add support for translating Hive views which use the `date` function. ({issue}`8789`)\", \"Add support for translating Hive views which use the `pmod` function. ({issue}`8935`)\", \"Prevent creating of tables that have column names containing commas, or leading or trailing spaces. ({issue}`8954`)\", \"Improve performance of updating Glue table statistics for partitioned tables. ({issue}`8839`)\", \"Change default Glue statistics read/write parallelism from 1 to 5. ({issue}`8839`)\", \"Improve performance of querying Parquet data for files containing column indexes. ({issue}`7349`)\", \"Fix query failure when inserting data into a Hive ACID table which is not explicitly bucketed. ({issue}`8899`)\"], \"Iceberg connector\": [\"Fix reading or writing Iceberg tables that previously contained a\\npartition field that was later dropped. ({issue}`8730`)\", \"Allow reading from Iceberg tables which specify the Iceberg\\n`write.object-storage.path` table property. ({issue}`8573`)\", \"Allow using randomized location when creating a table, so that future table\\nrenames or drops do not interfere with new tables created with the same name.\\nThis can be enabled using the `iceberg.unique-table-location` configuration\\nproperty. ({issue}`6063`)\", \"Return proper query results for queries accessing multiple snapshots of single Iceberg table. ({issue}`8868`)\"], \"MemSQL connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\"], \"MongoDB connector\": [\"Add {func}`timestamp_objectid` function. ({issue}`8824`)\", \"Enable `mongodb.socket-keep-alive` config property by default. ({issue}`8832`)\"], \"MySQL connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\", \"Fix incorrect results for aggregation functions applied to columns of type `varchar` and `char`. ({issue}`7320`)\"], \"Oracle connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\"], \"Phoenix connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\"], \"Pinot connector\": [\"Implement aggregation pushdown for `count`, `avg`, `min`, `max`, `sum`, `count(DISTINCT)` and `approx_distinct`.\\nIt is enabled by default and can be disabled using the configuration property `pinot.aggregation-pushdown.enabled`\\nor the catalog session property `aggregation_pushdown_enabled`. ({issue}`4140`)\", \"Allow `https` URLs in `pinot.controller-urls`. ({issue}`8617`)\", \"Fix failures when querying `information_schema.columns` with a filter on the table name. ({issue}`8307`)\"], \"PostgreSQL connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\", \"Fix incorrect results for aggregation functions applied to columns of type `varchar` and `char`. ({issue}`7320`)\"], \"Redshift connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\"], \"SQL Server connector\": [\"Allow limiting the size of the metadata cache via the `metadata.cache-maximum-size` configuration property. ({issue}`8652`)\", \"Fix incorrect results for aggregation functions applied to columns of type `varchar` and `char`. ({issue}`7320`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 234]\"}, {\"title\": \"Release 362 (20 Sep 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for {func}`listagg`. ({issue}`4835`)\", \"Improve join performance. ({issue}`8974`)\", \"Improve performance of queries that contain a `DISTINCT` clause. ({issue}`8967`, {issue}`9194`)\", \"Improve query performance by reducing CPU overhead of repartitioning data across worker nodes. ({issue}`9102`)\", \"Split metrics that are reported in operator stats into `connectorMetrics` and `metrics`. ({issue}`9156`)\", \"Prevent failure when querying `system.materialized_views` and a materialized view is dropped concurrently. ({issue}`9050`) \", \"Fix incorrect results for aggregations that contain `DISTINCT` and `FILTER` clauses. ({issue}`9265`)\", \"Fix incorrect query results when row pattern contains back references. ({issue}`9109`)\", \"Fix `ALTER SCHEMA ... SET AUTHORIZATION` to resolve roles using the catalog of the schema instead of the session catalog. ({issue}`9066`)\", \"Fix query failure when query contains a cast from `varchar` to a shorter `char`. ({issue}`9036`)\", \"Fix planning failure of `INSERT` statement when source table has hidden columns. ({issue}`9150`)\", \"Fix planning of recursive queries when the recursion, the base plan, or the recursion step plan produce duplicate outputs. ({issue}`9153`)\", \"Fix failure when querying the [optimizer_rule_stats](optimizer-rule-stats) system table. ({issue}`8700`)\", \"Fix failure for queries that push projections into connectors. ({issue}`6200`)\", \"Fix planning timeout for queries containing `IS NULL`, `AND`, and `OR` predicates in the `WHERE` clause. ({issue}`9250`)\", \"Fix failure for queries containing `ORDER BY ... LIMIT` when columns in the subquery are known to be constant. ({issue}`9171`)\"], \"Security\": [\"Add `IN catalog` clause to `CREATE ROLE`, `DROP ROLE`, `GRANT ROLE`, `REVOKE ROLE`, and `SET ROLE` to specify \\nthe target catalog of the statement instead of using the current session catalog. This change is necessary to \\nsupport system roles in the future. The old behavior of these statements can be restored by setting the \\n`deprecated.legacy-catalog-roles` config property. ({issue}`9087`)\"], \"Web UI\": [\"Add query error info to cluster overview page. ({issue}`8762`)\"], \"JDBC driver\": [\"Improve performance of listing table columns via `java.sql.DatabaseMetaData` API when filtering on schema name. ({issue}`9214`)\"], \"Server RPM\": [\"Change RPM architecture to `noarch` to allow installing on any machine type. ({issue}`9187`)\"], \"BigQuery connector\": [\"Support case insensitive name matching for BigQuery views. ({issue}`9164`)\", \"Change type mapping of BigQuery `datetime` from `timestamp(3)` to `timestamp(6)` in Trino. ({issue}`9052`)\", \"Change type mapping of BigQuery `time` from `time with time zone` to `time(6)` in Trino. ({issue}`9052`)\", \"Change type mapping of BigQuery `timestamp` from `timestamp(3) with time zone` to `timestamp(6) with time zone` in Trino. ({issue}`9052`)\", \"Fix failure for queries where predicate on `datetime` column is pushed down to BigQuery. ({issue}`9005`)\", \"Fix incorrect results when using parameterized `numeric` type with non-default precision and scale. ({issue}`9060`)\", \"Fix query failure when accessing tables with unsupported data type columns. ({issue}`9086`)\", \"Fix failure for queries where predicate on `float64` column involving `+infinity` or \\n`-infinity` values is pushed down to BigQuery. ({issue}`9122`)\"], \"Cassandra connector\": [\"Change minimum number of speculative executions from 2 to 1. ({issue}`9096`)\"], \"Hive connector\": [\"Support reading Parquet timestamp stored with millisecond or microsecond precision as `INT64` with \\nlogical type annotations when Hive timestamp precision is `NANOSECONDS`. ({issue}`9139`)\", \"Support reading Parquet timestamp stored as `INT64` with nanosecond precision. ({issue}`9188`)\", \"Support writing Parquet timestamp stored as `INT64` with nanosecond precision when experimental Parquet writer is enabled.\\nTo use this, the Hive timestamp precision should be set to `NANOSECONDS`. ({issue}`9188`)\", \"Support loading of S3 mappings via HTTP(S) url. The `hive.s3.security-mapping.config-file property` can now \\neither point to a local file or a URL. ({issue}`6210`) \", \"Allow reading from tables bucketed on a column that uses type for which bucketing is not natively \\nsupported by Trino. Writing to such tables is still not allowed. ({issue}`8986`)\", \"Extend set of statistics reported by JMX to include metrics for calls made to the Glue statistics API. ({issue}`9100`) \", \"Limit maximum file size generated by write operations to 1 GB by default. The limit is not exact and is applied on a best-effort basis. \\nThe limit can be set with the `hive.target-max-file-size` configuration property or the `target_max_file_size` session property. ({issue}`7991`) \", \"Allow specifying the list of schemas for which Trino will enforce that queries use a filter on partition keys for source tables.\\nThe list can be specified using the `hive.query-partition-filter-required-schemas`, or the `query_partition_filter_required_schemas` session property.\\nThe list is taken into consideration only if the `hive.query-partition-filter-required` configuration property or the `query_partition_filter_required` \\nsession property is set to `true`. ({issue}`9106`)\", \"Fix failure when writing Parquet files with Snappy compression on ARM64. ({issue}`9148`)\", \"Fix performance regression when reading Parquet files that contain dictionaries. ({issue}`9161`)\", \"Fix incorrect table locking in Hive metastore when querying unpartitioned non-transactional tables. ({issue}`9070`)\", \"Fix `ArrayIndexOutOfBoundsException` when using the experimental Parquet writer. ({issue}`5518`)\", \"Fix reading Avro tables written with older Avro versions that had certain semi-invalid schemas. ({issue}`9114`)\", \"Fix possible `INSERT`/`UPDATE`/`ANALYZE` query failure when Glue metastore is in use and table statistics collection is enabled. ({issue}`9297`)\"], \"Iceberg connector\": [\"Add support for Iceberg `uuid` type. ({issue}`6663`)\", \"Fix the mapping of nested fields between table metadata and Parquet file metadata. This\\nenables evolution of `row` typed columns for Iceberg tables stored in Parquet. ({issue}`9124`)\", \"Fix failure for queries filtering on columns with array, map, or row type. ({issue}`8822`)\", \"Fix `ArrayIndexOutOfBoundsException` when using the experimental Parquet writer. ({issue}`5518`)\", \"Fix query failures caused by errors reading certain Avro metadata files. ({issue}`9114`)\"], \"Pinot connector\": [\"Support pushdown of filters on `varbinary` columns to Pinot. ({issue}`9180`)\", \"Fix incorrect results for queries that contain aggregations and `IN` and `NOT IN` filters over `varchar` columns. ({issue}`9133`)\", \"Fix failure for queries with filters on `real` or `double` columns having `+Infinity` or `-Infinity` values. ({issue}`9180`)\"], \"TPC-H connector\": [\"Add support for switching the mapping of floating point values between SQL `double` and `decimal` types. The mapping \\ncan be set via the `tpch.double-type-mapping` configuration property. ({issue}`7990`)\"], \"SPI\": [\"Change `Connector.isSingleStatementWritesOnly()` to return `true` by default. ({issue}`8872`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 235]\"}, {\"title\": \"Release 363 (6 Oct 2021)\", \"description\": null, \"content\": {\"General\": [\"Add {doc}`/admin/event-listeners-http` implementation which sends JSON serialized events to a remote HTTP endpoint. ({issue}`8821`)\", \"Improve performance of queries that group by `bigint` columns. ({issue}`9510`)\", \"Improve performance of queries that process row or array data. ({issue}`9402`)\", \"Improve query planning performance. ({issue}`9462`)\", \"Reduce query memory usage when spilling occurs. ({issue}`9270`, {issue}`9275`)\", \"Reduce memory usage for processing `JOIN` clauses. ({issue}`9327`)\", \"Fix potential data loss in query results when clients retry requests to the coordinator. ({issue}`9453`)\", \"Fix incorrect result for comparisons between zero-valued decimals. ({issue}`8985`)\", \"Fix `SHOW ROLES` failure when there are no roles to display. ({issue}`9319`)\", \"Fix `EXPLAIN ANALYZE` to show estimates. ({issue}`9396`)\", \"Fix incorrect result for {func}`round` with precision set to 0. ({issue}`9371`) \", \"Respect `deprecated.legacy-catalog-roles=true` configuration property in `SHOW ROLES`, \\n`SHOW CURRENT ROLES` and `SHOW ROLE GRANTS` statements. ({issue}`9496`)\"], \"Python client\": [\"Fix column type reported in `cursor.description` for `time with time zone` column. ({issue}`9460`)\"], \"BigQuery connector\": [\"Fix failure for queries where predicates on `geography`, `array` or `struct` column are pushed down to BigQuery. ({issue}`9391`)\"], \"Cassandra connector\": [\"Add support for Cassandra `tuple` type. ({issue}`8570`)\"], \"Elasticsearch connector\": [\"Add support for `scaled_float` type. ({issue}`9358`)\"], \"Hive connector\": [\"Support usage of `avro_schema_url` table property in partitioned tables. ({issue}`9370`}\", \"Add support for insert overwrite operations on S3-backed tables. ({issue}`9234`)\", \"Improve query performance when reading Parquet data with predicate on a `decimal` column. ({issue}`9338`)\", \"Fix `Failed reading parquet data: Socket is closed by peer` query failure when reading from Parquet table with a predicate. ({issue}`9097`)\", \"Fix query failure when updating or deleting from an ORC ACID transactional table that has some rows deleted since the last major compaction. ({issue}`9354`)\", \"Fix failure when reading large Parquet files. ({issue}`9469`)\", \"Fix failures for some `UPDATE` queries, such as those where the `SET` clause contains the same constant more than once. ({issue}`9295`)\", \"Fix incorrect results when filtering on Parquet columns containing a dot in their name. ({issue}`9516`)\"], \"Iceberg connector\": [\"Improve query performance when reading Parquet data with predicate on a `decimal` column. ({issue}`9338`)\", \"Fix support for comments when adding a new column. Previously, they were silently ignored. ({issue}`9123`)\", \"Fix page and block sizing when writing Parquet data. ({issue}`9326`)\", \"Fix failure when reading large Parquet files. ({issue}`9469`)\"], \"MySQL connector\": [\"Add support for variable precision `time` type. ({issue}`9339`)\", \"Support `CREATE TABLE` and `CREATE TABLE AS` statements for `time` type. ({issue}`9339`)\"], \"Phoenix connector\": [\"Allowing forcing the mapping of certain types to `varchar`. This can be enabled by\\nsetting the `jdbc-types-mapped-to-varchar` configuration property to a comma-separated\\nlist of type names. ({issue}`2084`)\"], \"Pinot connector\": [\"Fix failure when a column name is a reserved keyword. ({issue}`9373`)\"], \"SQL Server connector\": [\"Add support for SQL Server `datetimeoffset` type. ({issue}`9329`)\", \"Fix failure for queries where predicates on `text` or `ntext` typed columns are pushed down to SQL Server. ({issue}`9387`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 236]\"}, {\"title\": \"Release 364 (1 Nov 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for [`ALTER MATERIALIZED VIEW ... RENAME TO ...`](/sql/alter-materialized-view). ({issue}`9492`)\", \"Improve performance of `GROUP BY` with single grouping column. ({issue}`9514`)\", \"Improve performance of decimal aggregations. ({issue}`9640`)\", \"Improve performance when evaluating the `WHERE` and `SELECT` clause. ({issue}`9610`)\", \"Improve performance when computing the product of `decimal` values with precision larger than 19. ({issue}`9744`)\", \"Improve CPU coordinator utilization. ({issue}`8650`)\", \"Remove support for the `unwrap_casts` session property and `optimizer.unwrap-casts` configuration option. ({issue}`9550`)\", \"Fix incorrect results for queries with nested joins and ``IS NOT DISTINCT FROM`` join clauses. ({issue}`9805`)\", \"Fix displaying character type dynamic filter values in ``EXPLAIN ANALYZE``. ({issue}`9673`)\", \"Fix query failure for update operation if it has a correlated subquery. ({issue}`8286`)\", \"Fix decimal division when result is between `-1` and `0`. ({issue}`9696`)\", \"Fix [`SHOW STATS`](/sql/show-stats) failure for a query projecting a boolean column. ({issue}`9710`)\"], \"Web UI\": [\"Improve responsiveness of Web UI when query history contains queries with long query text. ({issue}`8892`)\"], \"JDBC driver\": [\"Allow using token from existing Kerberos context. This allows the client to perform Kerberos authentication without\\npassing the Keytab or credential cache to the driver. ({issue}`4826`)\"], \"Cassandra connector\": [\"Map Cassandra `uuid` type to Trino `uuid`. ({issue}`5231`)\"], \"Elasticsearch connector\": [\"Fix failure when documents contain fields of unsupported types. ({issue}`9552`)\"], \"Hive connector\": [\"Allow to skip setting permissions on new directories by setting `hive.fs.new-directory-permissions=skip` in connector properties file. ({issue}`9539`)\", \"Allow translating Hive views which cast `timestamp` columns to `decimal`. ({issue}`9530`)\", \"Add `optimize` table procedure for merging small files in non-transactional Hive table.\\nProcedure can be executed using `ALTER TABLE <table> EXECUTE optimize(file_size_threshold => ...)` syntax. ({issue}`9665`)\", \"Restrict partition overwrite on insert to auto-commit context only. ({issue}`9559`)\", \"Reject execution of `CREATE TABLE` when bucketing is requested on columns with unsupported column types. \\nPreviously `CREATE` was allowed but it was not possible to insert data to such a table. ({issue}`9793`)\", \"Improve performance of querying Parquet data for files containing column indexes. ({issue}`9633`)\", \"Fix Hive 1 and Hive 3 incompatibility with Parquet files containing `char` or `varchar` data produced by the experimental Parquet writer. \\nHive 2 or newer should now read such files correctly, while Hive 1.x is still known not to read them. ({issue}`9515`, ({issue}`6377`))\", \"Fix `ArrayIndexOutOfBoundsException` when inserting into a partitioned table with `hive.target-max-file-size` set. ({issue}`9557`)\", \"Fix reading Avro schema written by Avro 1.8.2 with non-spec-compliant default values. ({issue}`9243`)\", \"Fix failure when querying nested Parquet data if column indexes are enabled. ({issue}`9587`)\", \"Fix incorrect results when querying Parquet data. ({issue}`9587`)\", \"Fix query failure when writing to a partitioned table with target max file size set. ({issue}`9557`)\"], \"Iceberg connector\": [\"Add support for renaming materialized views. ({issue}`9492`)\", \"Create Parquet files that can be read more efficiently. ({issue}`9569`)\", \"Improve query performance when dynamic filtering can be leveraged. ({issue}`4115`)\", \"Return value with UTC zone for table partitioned on `timestamp with time zone`. ({issue}`9704`)\", \"Fix data loss in case of concurrent inserts to a table. ({issue}`9583`)\", \"Fix query failure when reading from `$partitions` table for a table partitioned on `timestamp with time zone` or `uuid` ({issue}`9703`, {issue}`9757`)\", \"Fix query failure when reading Iceberg table statistics. ({issue}`9714`)\"], \"MemSQL connector\": [\"Support reading and writing MemSQL `datetime(6)` and `timestamp(6)` types as Trino `timestamp(6)`. ({issue}`9725`)\"], \"SQL Server connector\": [\"Fix query failure when `count(*)` aggregation is pushed down to SQL Server database and the table has more than 2147483647 rows. ({issue}`9549`)\"], \"SPI\": [\"Expose which columns are covered by dynamic filters. ({issue}`9644`)\", \"Add SPI for table procedures that can process table data in a distributed manner. Table procedures can be run via `ALTER TABLE ... EXECUTE ...` syntax. ({issue}`9665`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 237]\"}, {\"title\": \"Release 365 (3 Dec 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for [`TRUNCATE TABLE`](/sql/truncate). ({issue}`8921`)\", \"Add support for aggregate functions in row pattern recognition context. ({issue}`8738`)\", \"Add support for time travel queries. ({issue}`8773`)\", \"Add support for spilling aggregations containing `ORDER BY` or `DISTINCT` clauses. ({issue}`9723`)\", \"Add [`contains`](ip-address-contains) function to check whether a CIDR contains an IP address. ({issue}`9654`)\", \"Report connector metrics in `EXPLAIN ANALYZE VERBOSE`. ({issue}`9858`)\", \"Report operator input row count distribution in `EXPLAIN ANALYZE VERBOSE`. ({issue}`10133`)\", \"Allow executing `INSERT` or `DELETE` statements on tables restricted with a row filter. ({issue}`8856`)\", \"Remove `owner` column from the `system.metadata.materialized_views` table. ({issue}`9961`)\", \"Remove the `optimizer.iterative-rule-based-column-pruning` config property. The legacy column pruning optimizer is no longer available. ({issue}`9564`)\", \"Improve performance of inequality joins. ({issue}`9307`)\", \"Improve performance of joins involving a small table on one side. ({issue}`9851`)\", \"Improve CPU utilization by adjusting `task.concurrency` automatically based on the number of physical cores. ({issue}`10088`)\", \"Make query final query statistics more accurate. ({issue}`9888`, {issue}`9913`)\", \"Improve query planning performance for queries containing large `IN` predicates. ({issue}`9874`)\", \"Reduce peak memory usage for queries involving the `rank`, `dense_rank`, or `row_number` window functions. ({issue}`10056`)\", \"Fix incorrect results when casting `bigint` values to `varchar(n)` type. ({issue}`552`)\", \"Fix query failure when the `PREPARE` statement is used with `DROP` or `INSERT`\\nand the table or schema name contains special characters. ({issue}`9822`)\", \"Fix minor memory leak when queries are abandoned during the initial query submission phase. ({issue}`9962`)\", \"Collect connector metrics after `ConnectorPageSource` is closed. ({issue}`9615`)\"], \"Security\": [\"Allow configuring HTTP proxy for OAuth2 authentication. ({issue}`9920`, {issue}`10069`)\", \"Add group-based and owner-based query access rules to file based system access control. ({issue}`9811`)\", \"Use internal names for discovery client when automatic TLS is enabled for internal communications. This allows `discovery.uri` \\nto be configured using a normal DNS name like `https://coordinator.trino` and still use automatic TLS certificates. ({issue}`9821`)\", \"Use Kerberos operating system ticket cache if keytab file is not provided to JDBC and CLI for Kerberos authentication. ({issue}`8987`)\", \"Fix internal communication automatic TLS on Java 17. ({issue}`9821`)\"], \"CLI\": [\"Automatically use HTTPS when port is set to 443. ({issue}`8798`)\"], \"BigQuery connector\": [\"Support reading `bignumeric` type whose precision is less than or equal to 38. ({issue}`9882`)\", \"Fix failure when a schema is dropped while listing tables. ({issue}`9954`)\"], \"Cassandra connector\": [\"Support reading user defined types in Cassandra. ({issue}`147`)\"], \"ClickHouse connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\", \"Fix incorrect query results when query contains predicates on `real` type columns. ({issue}`9998`)\"], \"Druid connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\"], \"Elasticsearch connector\": [\"Add support for additional Elastic Cloud node roles. ({issue}`9892`)\", \"Fix failure when empty values exist in numeric fields. ({issue}`9939`)\"], \"Hive connector\": [\"Allow reading empty files of type Parquet, RCFile, SequenceFile. ({issue}`9929`)\", \"Enable `hive.s3.streaming` by default. ({issue}`9715`)\", \"Improve performance by not generating splits for empty files. ({issue}`9929`)\", \"Improve performance of decimal `avg` aggregation. ({issue}`9738`)\", \"Improve performance when reading Parquet files with timestamps encoded using `int64` representation. ({issue}`9414`)\", \"Improve dynamic partition pruning efficiency. ({issue}`9866`, {issue}`9869`)\", \"Improve query performance on partitioned tables or tables with small files\\nby increasing `hive.split-loader-concurrency` from `4` to `64`. ({issue}`9979`)\", \"Fix reporting of number of read bytes for tables using `ORC` file format. ({issue}`10048`)\", \"Account for memory used for deleted row information when reading from ACID tables. ({issue}`9914`, {issue}`10070`)\", \"Fix `REVOKE GRANT OPTION` to revoke only the grant option instead of revoking the entire privilege. ({issue}`10094`)\", \"Fix bug where incorrect rows were deleted when deleting from a transactional table that has original files (before the first major compaction). ({issue}`10095`)\", \"Fix delete and update failure when changing a table after a major compaction. ({issue}`10120`)\", \"Fix incorrect results when decoding decimal values in Parquet reader. ({issue}`9971`)\", \"Fix `hive.dynamic-filtering.wait-timeout` not having any effect. ({issue}`10106`)\", \"Fix failure when reading Parquet data if column indexes are enabled. ({issue}`9890`, {issue}`10076`)\"], \"Iceberg connector\": [\"Add support for storing and reading UUID nested in `row`, `array` or `map` type. ({issue}`9918`)\", \"Use Iceberg's `schema.name-mapping.default` table property for scanning files\\nwith missing Iceberg IDs. This aligns Trino behavior on migrated files with the\\nIceberg spec. ({issue}`9959`)\", \"Use ZSTD compression by default. ({issue}`10058`)\", \"Add read-only security option which can be enabled by setting the configuration `iceberg.security=read-only`. ({issue}`9974`)\", \"Change schema of `$partitions` system table to avoid conflicts when table name contains a column named `row_count`, `file_count`\\nor `total_size`, or when a column is used for partitioning for part of table data, and it not used for partitioning in some other\\npart of the table data. ({issue}`9519`, {issue}`8729`).\", \"Improve performance when reading timestamps from Parquet files. ({issue}`9414`)\", \"Improve query performance for certain queries with complex predicates. ({issue}`9309`)\", \"Reduce resource consumption and create bigger files when writing to an Iceberg table with partitioning. Bigger files are more efficient to query later. ({issue}`9826`)\", \"Improve performance for queries on nested data through dereference pushdown. ({issue}`8129`)\", \"Write correct `file_size_in_bytes` in manifest when creating new ORC files. ({issue}`9810`)\", \"Fix query failures that could appear when reading Parquet files which contained ROW columns that were subject to schema evolution. ({issue}`9264`)\", \"Fix failure caused by stale metadata in the `rollback_to_snapshot` procedure. ({issue}`9921`)\"], \"Kudu connector\": [\"Avoid scanner time-out issues when reading Kudu tables. ({issue}`7250`)\"], \"MemSQL connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\", \"Fix incorrect query results when query contains predicates on `real` type columns. ({issue}`9998`)\"], \"MongoDB connector\": [\"Support connecting to MongoDB clusters via `mongodb.connection-url` config property. `mongodb.seeds` and `mongodb.credentials` properties are now deprecated. ({issue}`9819`)\"], \"MySQL connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\", \"Fix incorrect query results when query contains predicates on `real` type columns. ({issue}`9998`)\"], \"Oracle connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\"], \"Phoenix connector\": [\"Support reading `decimal` columns from Phoenix with unspecified precision or scale. ({issue}`9795`)\", \"Fix query failures when reading Phoenix tables. ({issue}`9151`)\"], \"Pinot connector\": [\"Update Pinot connector to be compatible with versions >= 0.8.0 and drop support for older versions. ({issue}`9098`)\"], \"PostgreSQL connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\", \"Add experimental support for range predicate pushdown on string columns. It can be enabled\\nby setting the `postgresql.experimental.enable-string-pushdown-with-collate` catalog configuration\\nproperty or the corresponding `enable_string_pushdown_with_collate` session property to `true`. ({issue}`9746`)\"], \"Redshift connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\"], \"SQL Server connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`8921`)\"], \"SPI\": [\"Allow split manager to filter splits based on a predicate not expressible as a `TupleDomain`. ({issue}`7608`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 238]\"}, {\"title\": \"Release 366 (14 Dec 2021)\", \"description\": null, \"content\": {\"General\": [\"Add support for automatic query retries. This feature can be turned on by setting the `retry-policy` \\nconfig property or the `retry_policy` session property to `retry`. ({issue}`9361`)\", \"Add CREATE privilege kind to SQL grammar. Note that this permission is not used by any\\nexisting security systems, but is available for plugins. ({issue}`10206`)\", \"Add support for `DENY` statement in the engine. Note that this statement is not supported by any\\nexisting security systems, but is available for plugins. ({issue}`10205`)\", \"Reduce lock contention during query execution. ({issue}`10246`, {issue}`10239`)\", \"Improve query performance through optimizations to in-memory representations. ({issue}`10225`)\", \"Reduce query latency for contended clusters or complex queries with multiple stages. ({issue}`10249`)\", \"Fix incorrect results or failure when casting numeric values to `varchar(n)` type. ({issue}`552`)\", \"Remove support for spilling aggregations containing `ORDER BY` or `DISTINCT` clauses and associated\\nconfiguration properties `spill-distincting-aggregations-enabled`, `spill-ordering-aggregations-enabled`.\\n({issue}`10183`)\"], \"Elasticsearch connector\": [\"Read extended metadata from the `_meta.trino` index mapping attribute. `_meta.presto` is still\\nsupported for backward compatibility. ({issue}`8383`)\"], \"Hive connector\": [\"Add support for redirects from Hive to Iceberg. This can be configured with `hive.iceberg-catalog-name`\\ncatalog configuration property. ({issue}`10173`)\", \"Improve performance of uploading data into tables that use S3 filesystem. ({issue}`10180`)\"], \"Iceberg connector\": [\"Fix incorrect query results for tables partitioned on columns of type `binary`. ({issue}`9755`)\"], \"MemSQL connector\": [\"Fix incorrect result when a `date` value is older than or equal to `1582-10-14`. ({issue}`10054`)\"], \"MySQL connector\": [\"Fix incorrect result when a `date` value is older than or equal to `1582-10-14`. ({issue}`10054`)\"], \"Phoenix connector\": [\"Avoid running into out of memory errors with certain types of queries. ({issue}`10143`)\"], \"Prometheus connector\": [\"Support configuring a read timeout via the `prometheus.read-timeout` config property. ({issue}`10101`)\"], \"PostgreSQL connector\": [\"Fix incorrect result when a `date` value is older than or equal to `1582-10-14`. ({issue}`10054`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 239]\"}, {\"title\": \"Release 367 (22 Dec 2021)\", \"description\": null, \"content\": {\"General\": [\"Capture lineage details for columns from `WITH` clauses and subqueries. ({issue}`10272`)\", \"Improve `CREATE VIEW` error message when table or materialized view already exists. ({issue}`10186`)\", \"Disallow query retries when connectors cannot perform them safely. ({issue}`10064`)\", \"Improve performance when query retries are enabled by adding support for dynamic filtering. ({issue}`10274`)\", \"Fix failure in `min_by` and `max_by` aggregation execution. ({issue}`10347`)\", \"Fix planning failure for queries that access fields of `row` types by index (`ROW(...)[n]`) or that \\nselect all row fields (`ROW(..).*`). ({issue}`10321`)\", \"Fix bug where certain queries which use broadcast joins could hang and never complete. ({issue}`10344`)\", \"Fix failure when row or array in `VALUES` clause contains nulls. ({issue}`10141`)\"], \"Security\": [\"Hide inaccessible columns from `SELECT *` statement when \\nthe `hide-inaccessible-columns` configuration property is set to true. ({issue}`9991`)\", \"Disable `SET AUTHORIZATION` when `VIEW` runs as `DEFINER`. ({issue}`10351`)\"], \"Web UI\": [\"Improve user experience by introducing a new landing page for logout flow when \\nOauth2 authentication is used. ({issue}`10299`)\"], \"Hive connector\": [\"Add procedure `system.flush_metadata_cache()` to flush metadata caches. ({issue}`10251`)\", \"Prevent data loss during `DROP SCHEMA` when schema location contains files but not tables. ({issue}`10146`)\", \"Ensure no duplicate rows are created if query which writes data to Hive table is retried. ({issue}`10252`, {issue}`10064`)\"], \"Iceberg connector\": [\"Prevent data loss during `DROP SCHEMA` when schema location contains files but not tables. ({issue}`9767`)\"], \"SPI\": [\"Fix `ClassNotFoundException` when using aggregation with a custom state type. ({issue}`10341`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 240]\"}, {\"title\": \"Release 368 (11 Jan 2022)\", \"description\": null, \"content\": {\"General\": [\"Allow setting per task memory limits via `query.max-total-memory-per-task`\\nconfig property or via `query_max_total_memory_per_task` session property.\\n({issue}`10308`)\", \"Improve wall time for query processing with the `phased` scheduling policy.\\nThe previous behavior can be restored by setting the `query.execution-policy`\\nconfiguration property to `legacy-phased`. ({issue}`10350`)\", \"Enable `phased` scheduling policy by default. The previous behavior can be\\nrestored by setting the `query.execution-policy` configuration property to\\n`all-at-once`. ({issue}`10455`)\", \"Improve performance of arithmetic operations involving decimals with precision\\nlarger than 18. ({issue}`10051`)\", \"Reduce risk of out-of-memory failure on congested clusters with high memory\\nusage. ({issue}`10475`)\", \"Fix queries not being unblocked when placed in reserved memory pool.\\n({issue}`10475`)\", \"Prevent execution of `REFRESH MATERIALIZED VIEW` from getting stuck.\\n({issue}`10360`)\", \"Fix double reporting of scheduled time for scan operators in\\n`EXPLAIN ANALYZE`. ({issue}`10472`)\", \"Fix issue where the length of log file names grow indefinitely upon log\\nrotation. ({issue}`10394`)\"], \"Hive connector\": [\"Improve performance of decoding decimal values with precision larger than 18\\nin ORC, Parquet and RCFile data. ({issue}`10051`)\", \"Disallow querying the properties system table for Delta Lake tables, since\\nDelta Lake tables are not supported. This fixes the previous behavior of\\nsilently returning incorrect values. ({issue}`10447`)\", \"Reduce risk of worker out-of-memory exception when scanning ORC files.\\n({issue}`9949`)\"], \"Iceberg connector\": [\"Fix Iceberg table creation with location when schema location inaccessible.\\n({issue}`9732`)\", \"Support file based access control. ({issue}`10493`)\", \"Display the Iceberg table location in `SHOW CREATE TABLE` output.\\n({issue}`10459`)\"], \"SingleStore (MemSQL) connector\": [\"Add support for `time` type. ({issue}`10332`)\"], \"Oracle connector\": [\"Fix incorrect result when a `date` value is older than or equal to\\n`1582-10-14`. ({issue}`10380`)\"], \"Phoenix connector\": [\"Add support for reading `binary` type. ({issue}`10539`)\"], \"PostgreSQL connector\": [\"Add support for accessing tables created with declarative partitioning in\\nPostgreSQL. ({issue}`10400`)\"], \"SPI\": [\"Encode long decimal values using two's complement representation and change\\ntheir carrier type to `io.trino.type.Int128` instead of\\n`io.airlift.slice.Slice`. ({issue}`10051`)\", \"Fix `ClassNotFoundException` when using aggregation with a custom state type.\\n({issue}`10408`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 241]\"}, {\"title\": \"Release 369 (24 Jan 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for `Pacific/Kanton` time zone. ({issue}`10679`)\", \"Display `Physical input read time` using most succinct time unit in `EXPLAIN\\nANALYZE VERBOSE`. ({issue}`10576`)\", \"Fine tune request retry mechanism in HTTP event listener. ({issue}`10566`)\", \"Add support for using PostgreSQL and Oracle as backend database for resource\\ngroups. ({issue}`9812`)\", \"Remove unnecessary spilling configuration properties `spill-order-by` and\\n`spill-window-operator`. ({issue}`10591`)\", \"Remove distinction between system and user memory to simplify\\ncluster configuration. The configuration property\\n`query.max-total-memory-per-node` is removed. Use `query.max-memory-per-node`\\ninstead. ({issue}`10574`)\", \"Use formatting specified in the SQL standard when casting `double` and `real`\\nvalues to `varchar` type. ({issue}`552`)\", \"Add support for `ALTER MATERIALIZED VIEW ... SET PROPERTIES`. ({issue}`9613`)\", \"Add experimental implementation of task level retries. This can be enabled by\\nsetting the `retry-policy` configuration property or the `retry_policy`\\nsession property to `task`. ({issue}`9818`)\", \"Improve query wall time by splitting workload between nodes in a more balanced\\nway. Previous workload balancing policy can be restored via\\n`node-scheduler.splits-balancing-policy=node`. ({issue}`10660`)\", \"Prevent hanging query execution on failures with `phased` execution policy.\\n({issue}`10656`)\", \"Catch overflow in decimal multiplication. ({issue}`10732`)\", \"Fix `UnsupportedOperationException` in `max_by` and `min_by` aggregation.\\n({issue}`10599`)\", \"Fix incorrect results or failure when casting date to `varchar(n)` type.\\n({issue}`552`)\", \"Fix issue where the length of log file names grow indefinitely upon log\\nrotation. ({issue}`10738`)\"], \"Security\": [\"Allow extracting groups from OAuth2 claims from\\n``http-server.authentication.oauth2.groups-field``. ({issue}`10262`)\"], \"JDBC driver\": [\"Fix memory leak when using `DatabaseMetaData`. ({issue}`10584`,\\n{issue}`10632`)\"], \"BigQuery connector\": [\"Remove ``bigquery.case-insensitive-name-matching.cache-ttl`` configuration\\noption. It was previously ignored. ({issue}`10697`)\", \"Fix query failure when reading columns with `numeric` or `bignumeric` type.\\n({issue}`10564`)\"], \"ClickHouse connector\": [\"Upgrade minimum required version to 21.3. ({issue}`10703`)\", \"Add support for [renaming schemas](/sql/alter-schema). ({issue}`10558`)\", \"Add support for setting [column comments](/sql/comment). ({issue}`10641`)\", \"Map ClickHouse `ipv4` and `ipv6` types to Trino `ipaddress` type.\\n({issue}`7098`)\", \"Allow mapping ClickHouse `fixedstring` or `string` as Trino `varchar` via the\\n`map_string_as_varchar` session property. ({issue}`10601`)\", \"Disable `avg` pushdown on `decimal` types to avoid incorrect results.\\n({issue}`10650`)\", \"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Druid connector\": [\"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Hive connector\": [\"Add support for writing Bloom filters in ORC files. ({issue}`3939`)\", \"Allow flushing the metadata cache for specific schemas, tables, or partitions\\nwith the [flush_metadata_cache](hive-flush-metadata-cache) system procedure.\\n({issue}`10385`)\", \"Add support for long lived AWS Security Token Service (STS) credentials for\\nauthentication with Glue catalog. ({issue}`10735`)\", \"Ensure transaction locks in the Hive Metastore are released in case of query\\nfailure when querying Hive ACID tables. ({issue}`10401`)\", \"Disallow reading from Iceberg tables when redirects from Hive to Iceberg are\\nnot enabled. ({issue}`8693`, {issue}`10441`)\", \"Improve performance of queries using range predicates when reading ORC files\\nwith Bloom filters. ({issue}`4108`)\", \"Support writing Parquet files greater than 2GB. ({issue}`10722`)\", \"Fix spurious errors when metadata cache is enabled. ({issue}`10646`,\\n{issue}`10512`)\", \"Prevent data loss during `DROP SCHEMA` when the schema location contains files\\nthat are not part of existing tables. ({issue}`10485`)\", \"Fix inserting into transactional table when `task_writer_count` > 1.\\n({issue}`9149`)\", \"Fix possible data corruption when writing data to S3 with streaming enabled.\\n({issue}`10710 `)\"], \"Iceberg connector\": [\"Add `$properties` system table which can be queried to inspect Iceberg table\\nproperties. ({issue}`10480`)\", \"Add support for `ALTER TABLE .. EXECUTE OPTIMIZE` statement. ({issue}`10497`)\", \"Respect Iceberg column metrics mode when writing. ({issue}`9938`)\", \"Add support for long lived AWS Security Token Service (STS) credentials for\\nauthentication with Glue catalog. ({issue}`10735`)\", \"Improve performance of queries using range predicates when reading ORC files\\nwith Bloom filters. ({issue}`4108`)\", \"Improve select query planning performance after write operations from Trino.\\n({issue}`9340`)\", \"Ensure table statistics are accumulated in a deterministic way from Iceberg\\ncolumn metrics. ({issue}`9716`)\", \"Prevent data loss during `DROP SCHEMA` when the schema location contains files\\nthat are not part of existing tables. ({issue}`10485`)\", \"Support writing Parquet files greater than 2GB. ({issue}`10722`)\", \"Fix materialized view refresh when view a query references the same table\\nmultiple times. ({issue}`10570`)\", \"Fix possible data corruption when writing data to S3 with streaming enabled.\\n({issue}`10710 `)\"], \"MySQL connector\": [\"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Oracle connector\": [\"Map Oracle `date` to Trino `timestamp(0)` type. ({issue}`10626`)\", \"Fix performance regression of predicate pushdown on indexed `date` columns.\\n({issue}`10626`)\", \"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Phoenix connector\": [\"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Pinot connector\": [\"Add support for basic authentication. ({issue}`9531`)\"], \"PostgreSQL connector\": [\"Add support for [renaming schemas](/sql/alter-schema). ({issue}`8939`)\", \"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"Redshift connector\": [\"Add support for [renaming schemas](/sql/alter-schema). ({issue}`8939`)\", \"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"SingleStore (MemSQL) connector\": [\"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"SQL Server connector\": [\"Fix spurious errors when metadata cache is enabled. ({issue}`10544`,\\n{issue}`10512`)\"], \"SPI\": [\"Remove support for the `ConnectorMetadata.getTableLayout()` API.\\n({issue}`781`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 242]\"}, {\"title\": \"Release 370 (3 Feb 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for `DEFAULT` keyword in `ALTER TABLE...SET PROPERTIES...`.\\n({issue}`10331`)\", \"Improve performance of map and row types. ({issue}`10469`)\", \"Improve performance when evaluating expressions in `WHERE` and `SELECT`\\nclauses. ({issue}`10322`)\", \"Prevent queries deadlock when using `phased` execution policy with dynamic\\nfilters in multi-join queries. ({issue}`10868`)\", \"Fix query scheduling regression introduced in Trino 360 that caused\\ncoordinator slowness in assigning splits to workers. ({issue}`10839`)\", \"Fix `information_schema` query failure when an `IS NOT NULL` predicate is\\nused. ({issue}`10861`)\", \"Fix failure when nested subquery contains a `TABLESAMPLE` clause.\\n({issue}`10764`)\"], \"Security\": [\"Reduced the latency of successful OAuth 2.0 authentication. ({issue}`10929`)\", \"Fix server start failure when using JWT and OAuth 2.0 authentication together\\n(`http-server.authentication.type=jwt,oauth2`). ({issue}`10811`)\"], \"CLI\": [\"Add support for ARM64 processors. ({issue}`10177`)\", \"Allow to choose the way how external authentication is handled with the\\n`--external-authentication-redirect-handler` parameter. ({issue}`10248`)\"], \"RPM package\": [\"Fix failure when operating system open file count is set too low.\\n({issue}`8819`)\"], \"Docker image\": [\"Change base image to `registry.access.redhat.com/ubi8/ubi`, since CentOS 8 has\\nreached end-of-life. ({issue}`10866`)\"], \"Cassandra connector\": [\"Fix query failure when pushing predicates on `uuid` partitioned columns.\\n({issue}`10799`)\"], \"ClickHouse connector\": [\"Support creating tables with Trino `timestamp(0)` type columns.\", \"Drop support for ClickHouse servers older than version 20.7 to avoid using a\\ndeprecated driver. You can continue to use the deprecated driver with the\\n`clickhouse.legacy-driver` flag when connecting to old servers.\\n({issue}`10541`)\", \"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"Druid connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"Hive connector\": [\"Improve query performance when reading ORC data. ({issue}`10575`)\", \"Add configuration property `hive.single-statement-writes` to require\\nauto-commit for writes. This can be used to disallow multi-statement write\\ntransactions. ({issue}`10820`)\", \"Fix sporadic query failure `Partition no longer exists` when working with wide\\ntables using a AWS Glue catalog as metastore. ({issue}`10696`)\", \"Fix `SHOW TABLES` failure when `hive.hide-delta-lake-tables` is enabled, and\\nGlue metastore references the table with no properties. ({issue}`10864`)\"], \"Iceberg connector\": [\"Fix query failure when reading from a table that underwent partitioning\\nevolution. ({issue}`10770`)\", \"Fix data corruption when writing Parquet files. ({issue}`9749`)\"], \"MySQL connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"Oracle connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"Phoenix connector\": [\"Fix incorrect result when a `date` value is older than or equal to\\n`1899-12-31`. ({issue}`10749`)\"], \"PostgreSQL connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"Redshift connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"SingleStore (MemSQL) connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"SQL Server connector\": [\"Remove the legacy `allow-drop-table` configuration property. This defaulted to\\n`false`, which disallowed dropping tables, but other modifications were still\\nallowed. Use {doc}`/security/built-in-system-access-control` instead, if\\ndesired. ({issue}`588`)\"], \"SPI\": [\"Allow null property names in `ConnetorMetadata#setTableProperties`.\\n({issue}`10331`)\", \"Rename `ConnectorNewTableLayout` to `ConnectorTableLayout`. ({issue}`10587`)\", \"Connectors no longer need to explicitly declare handle classes. The\\n`ConnectorFactory.getHandleResolver` and `Connector.getHandleResolver` methods\\nare removed. ({issue}`10858`, {issue}`10872`)\", \"Remove unnecessary `Block.writePositionTo` and `BlockBuilder.appendStructure`\\nmethods. Use of these methods can be replaced with the existing\\n`Type.appendTo` or `writeObject` methods. ({issue}`10602`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 243]\"}, {\"title\": \"Release 371 (16 Feb 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for using secrets in database backed resource group manager\\nconfiguration. ({issue}`10996`)\", \"Add support for the user group selector rule in database backed resource group\\nmanager. ({issue}`10914`)\", \"Remove `deprecated.disable-set-properties-security-check-for-create-ddl`\\nconfiguration toggle. ({issue}`10923`)\", \"Prevent infinite planning loop by removing redundant predicates above table\\nscan. ({issue}`10532`)\", \"Prevent time outs for planning of certain queries. ({issue}`10985`)\", \"Fix performance regression in internal communication authentication\\nprocessing. ({issue}`10954`)\", \"Fix failure when casting values to `decimal(38, 38)`. ({issue}`10946`)\", \"Enforce timeout for idle transactions. ({issue}`10923`)\", \"Ensure removal of all catalog session properties when using session property\\ndefaults with transactions. ({issue}`10923`)\"], \"Security\": [\"Invoke correct authorization check when table is created via `CREATE TABLE\\nAS`. ({issue}`10939`)\"], \"ClickHouse connector\": [\"Remove support for ClickHouse connector in Altinity distribution 20.3.\\n({issue}`10975`)\", \"Add missing output of table properties for `SHOW CREATE TABLE` statements.\\n({issue}`11027`)\"], \"Hive connector\": [\"Allow specifying AWS role session name via S3 security mapping config.\\n({issue}`10714`)\", \"Disallow writes to bucketed tables recognized as created by Spark to prevent\\ndata corruption. Spark uses a custom bucketing hash function that is not\\ncompatible with Hive and Trino. ({issue}`10815`)\", \"Fix failure when reading Hive tables that contain symlinks that are text\\nfiles. ({issue}`10910`)\", \"Fix metastore impersonation for Avro tables. ({issue}`11035`)\"], \"Iceberg connector\": [\"Allow running queries performing DML on Iceberg tables with fault-tolerant\\nexecution. ({issue}`10622`)\", \"Create files of up to approximately 1GB of size when writing. This can be\\nconfigured using `hive.target-max-file-size` catalog property or\\n`target_max_file_size` session property. ({issue}`10957`)\"], \"Kudu connector\": [\"Drop support for Kudu versions older than 1.13.0. ({issue}`10940`)\"], \"SQL Server connector\": [\"Fix incorrect results when negative dates are specified in predicates.\\n({issue}`10263`)\", \"Fix incorrect results when writing negative dates. ({issue}`10263`)\"], \"SPI\": [\"Add `ConnectorSession` to the `Connector` `getMetadata` method. The former\\nsignature is deprecated and should be updated. ({issue}`9482`)\", \"Remove deprecated `checkCanCreateTable` and `checkCanCreateMaterializedView`\\nmethods not taking parameters. ({issue}`10939`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 244]\"}, {\"title\": \"Release 372 (2 Mar 2022)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`trim_array` function. ({issue}`11238`)\", \"Improve handling of prepared statements with long query text by compressing\\nthem within HTTP headers. This can be configured or disabled using the\\n``protocol.v1.prepared-statement-compression.length-threshold`` configuration\\nproperty. ({issue}`11098`)\", \"Improve performance of specific queries which compare table columns of type\\n`timestamp` with `date` literals. ({issue}`11170`)\", \"Add redirection awareness for `ADD COLUMN`, `DROP TABLE`, `COMMENT` tasks. ({issue}`11072`)\", \"Remove support for reserved memory pool. Configuration property\\n`experimental.reserved-pool-disabled` can no longer be used. ({issue}`6677`)\", \"Ensure memory is released completely after query completion. ({issue}`11030`)\", \"Fix certain queries failing due to dictionary compacting error. ({issue}`11080`)\", \"Fix `SET SESSION` and `RESET SESSION` not working for catalogs which include\\nspecial characters in their name. ({issue}`11171`)\", \"Fix bug where queries were not transitioned to `RUNNING` state when task-level\\nretries were enabled. ({issue}`11198`)\"], \"Security\": [\"Allow configuration of connect and read timeouts for LDAP authentication. ({issue}`10925`)\"], \"Docker image\": [\"Add a health check to the Docker container image. ({issue}`10413`)\"], \"JDBC driver\": [\"Fix `DatabaseMetaData#getTables` and `DatabaseMetaData#getColumns` to include\\nviews for Iceberg, Raptor, Accumulo and Blackhole connectors. ({issue}`11063`, {issue}`11060`)\"], \"Base-JDBC connector library\": [\"Fix spurious query failures when metadata cache is not enabled and data\\naccess depends on the session state. ({issue}`11068`)\"], \"Accumulo connector\": [\"Fix incorrect results when querying `date` type columns. ({issue}`11055`)\"], \"Cassandra connector\": [\"Fix incorrect results when filtering partition keys without projections.\\n({issue}`11001`)\"], \"ClickHouse connector\": [\"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"Druid connector\": [\"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"Hive connector\": [\"Allow redirects of Iceberg or Delta tables which have no ``StorageDescriptor``\\nin the Glue metastore. ({issue}`11092`)\", \"Stop logging spurious failures when storage caching\\nis used. ({issue}`11101`)\", \"Allow reading Zstandard compressed Avro files. ({issue}`11090`)\", \"Fix incorrect query results after writes to a table when directory caching is\\nenabled enabled with the `hive.file-status-cache-tables` configuration\\nproperty. ({issue}`10621`)\", \"Fix potential query failures for queries writing data to tables backed by S3.\\n({issue}`11089`)\"], \"Iceberg connector\": [\"Add support for ``COMMENT ON COLUMN`` statement. ({issue}`11143`)\", \"Improve query performance after table schema evolved, by fixing the connector\\nto support table stats in such case. ({issue}`11091`)\", \"Fix potential query failures for queries writing data to tables backed by S3. ({issue}`11089`)\", \"Prevent query failure from dereference pushdown when a column has a comment. ({issue}`11104`)\"], \"Kudu connector\": [\"Add support for Kerberos authentication. ({issue}`10953`)\"], \"MongoDB connector\": [\"Map MongoDB `bindata` type to Trino `varbinary` type if explicit schema does\\nnot exist. ({issue}`11122`)\"], \"MySQL connector\": [\"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"Oracle connector\": [\"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"Phoenix connector\": [\"Fix query failures when applying predicates on `array(char)` type columns. ({issue}`10451`)\", \"Fix metadata listing failure in case of concurrent table deletion. ({issue}`10904`)\"], \"PostgreSQL connector\": [\"Add support for pushing down joins on character string type columns. ({issue}`10059`)\", \"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"Redshift connector\": [\"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"SingleStore (MemSQL) connector\": [\"Fix spurious query failures when metadata cache is not enabled, and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"SQL Server connector\": [\"Update JDBC driver to 10.2.0. The new version automatically enables TLS and\\ncertificate verification. Update the [TLS configuration](sqlserver-tls) to\\nkeep the old behavior. ({issue}`10898`)\", \"Fix spurious query failures when metadata cache is not enabled and extra\\ncredentials with `user-credential-name` or `password-credential-name` are used\\nto access data. ({issue}`11068`)\"], \"SPI\": [\"Pass more information about predicates in `ConnectorMetadata#applyFilter`\\ninvocation. The predicates that cannot be represented with a `TupleDomain` are\\navailable via `Constraint.getExpression()`. ({issue}`7994`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 245]\"}, {\"title\": \"Release 373 (9 Mar 2022)\", \"description\": null, \"content\": {\"General\": [\"Add {doc}`/connector/delta-lake`. ({issue}`11296`, {issue}`10897`)\", \"Improve query performance by reducing overhead of cluster internal\\ncommunication. ({issue}`11146`)\", \"Handle `varchar` to `timestamp` conversion errors in {func}`try`. ({issue}`11259`)\", \"Add redirection awareness for `DROP COLUMN` task. ({issue}`11304`)\", \"Add redirection awareness for `RENAME COLUMN` task. ({issue}`11226`)\", \"Disallow table redirections in `SHOW GRANTS` statement. ({issue}`11270`)\", \"Allow low memory killer to abort individual tasks when `retry-mode` is set to\\n`TASK`. This requires `query.low-memory-killer.policy` set to\\n`total-reservation-on-blocked-nodes`. ({issue}`11129`)\", \"Fix incorrect results when distinct or ordered aggregation are used and\\nspilling is enabled. ({issue}`11353`)\"], \"Web UI\": [\"Add CPU time, scheduled time, and cumulative memory statistics regarding\\nfailed tasks in a query. ({issue}`10754`)\"], \"BigQuery connector\": [\"Allow configuring view expiration time via the `bigquery.view-expire-duration`\\nconfig property. ({issue}`11272`)\"], \"Elasticsearch connector\": [\"Improve performance of queries involving `LIKE` by pushing predicate\\ncomputation to the Elasticsearch cluster. ({issue}`7994`, {issue}`11308`)\"], \"Hive connector\": [\"Support access to S3 via a HTTP proxy. ({issue}`11255`)\", \"Improve query performance by better estimating partitioned tables statistics. ({issue}`11333`)\", \"Prevent failure for queries with the final number of partitions\\nbelow `HIVE_EXCEEDED_PARTITION_LIMIT`. ({issue}`10215`)\", \"Fix issue where duplicate rows could be inserted into a partition when\\n`insert_existing_partitions_behavior` was set to `OVERWRITE` and\\n`retry-policy` was `TASK`. ({issue}`11196`)\", \"Fix failure when querying Hive views containing column aliases that differ in\\ncase only. ({issue}`11159`)\"], \"Iceberg connector\": [\"Support access to S3 via a HTTP proxy. ({issue}`11255`)\", \"Delete table data when dropping table. ({issue}`11062`)\", \"Fix `SHOW TABLES` failure when a materialized view is removed during query\\nexecution. ({issue}`10976`)\", \"Fix query failure when reading from `information_schema.tables` or\\n`information_schema.columns` and a materialized view is removed during\\nquery execution. ({issue}`10976`)\"], \"Oracle connector\": [\"Fix query failure when performing concurrent write operations. ({issue}`11318`)\"], \"Phoenix connector\": [\"Prevent writing incorrect results when arrays contain `null` values. ({issue}`11351`)\"], \"PostgreSQL connector\": [\"Improve performance of queries involving `LIKE` by pushing predicate\\ncomputation to the underlying database. ({issue}`11045`)\"], \"SQL Server connector\": [\"Fix incorrect results when querying SQL Server `tinyint` columns by mapping\\nthem to Trino `smallint`. ({issue}`11209`)\"], \"SPI\": [\"Add CPU time, scheduled time, and cumulative memory statistics regarding\\nfailed tasks in a query to query-completion events. ({issue}`10734`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 246]\"}, {\"title\": \"Release 374 (17 Mar 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for query parameters in `CREATE SCHEMA`. ({issue}`11485`)\", \"Improve performance when reading from S3-based spool for\\n[fault-tolerant execution](/admin/fault-tolerant-execution). ({issue}`11050`)\", \"Improve performance of queries with `GROUP BY` clauses. ({issue}`11392`)\", \"Improve performance of `GROUP BY` with a large number of groups. ({issue}`11011`)\", \"Improve handling of queries where individual tasks require lots of memory when\\n`retry-policy` is set to `TASK`. ({issue}`10432`)\", \"Produce better query plans by improving cost-based-optimizer estimates in the\\npresence of correlated columns. ({issue}`11324`)\", \"Fix memory accounting and improve performance for queries involving certain\\nvariable-width data types such as `varchar` or `varbinary`. ({issue}`11315`)\", \"Fix performance regression for `GROUP BY` queries. ({issue}`11234`)\", \"Fix `trim`, `ltrim` and `rtim` function results when the argument is `char`\\ntype. Previously, it returned padded results as `char` type. It returns\\n`varchar` type without padding now. ({issue}`11440`)\"], \"JDBC driver\": [\"Add support for `DatabaseMetaData.getImportedKeys`. ({issue}`8708`)\", \"Fix `Driver.getPropertyInfo()`, and validate allowed properties. ({issue}`10624`)\"], \"CLI\": [\"Add support for selecting Vim or Emacs editing modes with the `--editing-mode`\\ncommand line argument. ({issue}`3377`)\"], \"Cassandra connector\": [\"Add support for [TRUNCATE TABLE](/sql/truncate). ({issue}`11425`)\", \"Fix incorrect query results for certain complex queries. ({issue}`11083`)\"], \"ClickHouse connector\": [\"Add support for `uint8`, `uint16`, `uint32` and `uint64` types. ({issue}`11490`)\"], \"Delta Lake connector\": [\"Allow specifying STS endpoint to be used when connecting to S3. ({issue}`10169`)\", \"Fix query failures due to exhausted file system resources after `DELETE` or\\n`UPDATE`. ({issue}`11418`)\"], \"Hive connector\": [\"Allow specifying STS endpoint to be used when connecting to S3. ({issue}`10169`)\", \"Fix shared metadata caching with Hive ACID tables. ({issue}`11443`)\"], \"Iceberg connector\": [\"Allow specifying STS endpoint to be used when connecting to S3. ({issue}`10169`)\", \"Add support for using Glue metastore as Iceberg catalog. ({issue}`10845`)\"], \"MongoDB connector\": [\"Add support for [`CREATE SCHEMA`](/sql/create-schema) and\\n[`DROP SCHEMA`](/sql/drop-schema). ({issue}`11409`)\", \"Add support for [`COMMENT ON TABLE`](/sql/comment). ({issue}`11424`)\", \"Add support for [`COMMENT ON COLUMN`](/sql/comment). ({issue}`11457`)\", \"Support storing a comment when adding new columns. ({issue}`11487`)\"], \"PostgreSQL connector\": [\"Improve performance of queries involving `OR` with simple comparisons and\\n`LIKE` predicates by pushing predicate computation to the PostgreSQL database.\\n({issue}`11086`)\", \"Improve performance of aggregation queries with certain complex predicates by\\ncomputing predicates and aggregations within PostgreSQL. ({issue}`11083`)\", \"Fix possible connection leak when connecting to PostgreSQL failed. ({issue}`11449`)\"], \"SingleStore (MemSQL) connector\": [\"The connector now uses the official Single Store JDBC Driver. As a result,\\n`connection-url` in catalog configuration files needs to be updated from\\n`jdbc:mariadb:...` to `jdbc:singlestore:...`. ({issue}`10669`)\", \"Deprecate `memsql` as the connector name. We recommend using `singlestore` in\\nthe `connector.name` configuration property. ({issue}`11459`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 247]\"}, {\"title\": \"Release 375 (28 Mar 2022)\", \"description\": null, \"content\": {\"General\": [\"Change behavior of `ALTER TABLE qualified_name TO unqualified_name` to leave\\nthe table in the schema. This is backwards-incompatible behavioral change. ({issue}`11282`)\", \"Disallow table redirections for the `GRANT`, `REVOKE`, and\\n`SET TABLE AUTHORIZATION` table tasks. ({issue}`11302`)\", \"Improve performance of queries that contain filter predicates on aggregation\\nresults. ({issue}`11469`)\", \"Improve performance of queries that contain `array_distinct(array_sort(\\u2026))`\\nexpressions. ({issue}`8777`)\", \"Fix `SHOW CREATE TABLE` to show actual table name in case of table\\nredirections, so that the statement can be used to recreate the table. ({issue}`11604`)\", \"Fix scheduling for non-remotely accessible splits in fault-tolerant execution. ({issue}`11581`)\", \"Fix incorrect `is_nullable` value in `information_schema.columns` table. ({issue}`11613`)\"], \"JDBC driver\": [\"Allow `PreparedStatement.close()` to be called multiple times. ({issue}`11620`)\", \"Fix incorrect `is_nullable` value in `DatabaseMetaData.getColumns()` method. ({issue}`11613`)\"], \"Cassandra connector\": [\"Return `0` instead of row count in completed bytes. ({issue}`11644`)\"], \"Delta Lake connector\": [\"Add access control to `drop_extended_stats` and `vacuum` procedures. ({issue}`11633`)\", \"Fix incorrect query results when query executes concurrent with `DROP TABLE`. ({issue}`11562`)\"], \"Hive connector\": [\"Fix infinite loop in the query optimizer when query contains predicates on a\\nstruct field. ({issue}`11559`)\", \"Fix query failure when reading a partitioned table with a predicate on a\\npartition column with a specific name such as `table`, `key`, `order`, and\\nothers. ({issue}`11512`)\"], \"Iceberg connector\": [\"Fix failure when query contains predicates on a struct field. ({issue}`11560`)\", \"Fix query failure when reading from `$files` system table after a table column\\nhas been dropped. ({issue}`11576`)\"], \"Kudu connector\": [\"Improve write performance by flushing operations in batches. ({issue}`11264`)\", \"Fix failure when multiple queries run concurrently and schema emulation is enabled. ({issue}`11264`)\"], \"MongoDB connector\": [\"Support predicate pushdown on `boolean` columns. ({issue}`11536`)\", \"Return `0` instead of row count in completed bytes. ({issue}`11679`)\"], \"MySQL connector\": [\"Add support for table comments. ({issue}`11211`)\"], \"Pinot connector\": [\"Fix handling of passthrough queries that contain aggregation functions. ({issue}`9137`)\", \"Fix incorrect results when aggregation functions on columns having\\nnon-lowercase names are pushed down to Pinot. ({issue}`9137`, {issue}`10148`)\", \"Fix possible incorrect results when grouping on columns of array types. ({issue}`9781`)\"], \"PostgreSQL connector\": [\"Improve performance of queries involving `OR` with `IS NULL`, `IS NOT NULL`\\npredicates, or involving `NOT` expression by pushing predicate computation to\\nthe PostgreSQL database. ({issue}`11514`)\", \"Improve performance of queries with predicates involving `nullif` function by\\npushing predicate computation to the PostgreSQL database. ({issue}`11532`)\", \"Improve performance of queries involving joins by pushing computation to the\\nPostgreSQL database. ({issue}`11635`)\", \"Improve performance of queries involving predicates with arithmetic\\nexpressions by pushing predicate computation to the PostgreSQL database. ({issue}`11510`)\", \"Fix deletion of too much data when delete query involves a `LIKE` predicate. ({issue}`11615`)\"], \"SPI\": [\"Add processed input bytes and rows to query events in event listener. ({issue}`11623`)\", \"Remove deprecated constructors from `ColumnMetadata`. ({issue}`11621`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 248]\"}, {\"title\": \"Release 376 (7 Apr 2022)\", \"description\": null, \"content\": {\"General\": [\"Add table redirection awareness for `RENAME table` operations. ({issue}`11277`)\", \"Deny adding column with comment if the connector does not support this feature. ({issue}`11486`)\", \"Improve performance for queries that contain inequality expressions. ({issue}`11518`)\", \"Consider null values as identical values in `array_except`, `array_union`,\\n`map_concat`, `map_from_entries`, `multimap_from_entries`, and `multimap_agg`\\nfunctions. ({issue}`560`)\", \"Fix failure of `DISTINCT .. LIMIT` operator when input data is dictionary\\nencoded. ({issue}`11776`)\", \"Fix returning of invalid results for distinct aggregation when input data is\\ndictionary encoded. ({issue}`11776`)\", \"Fix query failure when performing joins with connectors that support index lookups. ({issue}`11758`)\", \"Fix incorrect stage memory statistics reporting for queries running with\\n`retry-policy` set to `TASK`. ({issue}`11801`)\"], \"Security\": [\"Add support to use two-way TLS/SSL certificate validation with LDAP authentication. \\nAdditionally `ldap.ssl-trust-certificate` config is replaced by `ldap.ssl.truststore.path`. ({issue}`11070`).\", \"Fix failures in information schema role tables for catalogs using system roles. ({issue}`11694`)\"], \"Web UI\": [\"Add new page to display the runtime information of all workers in the cluster. ({issue}`11653`)\"], \"JDBC driver\": [\"Add support for using the system truststore with the `SSLUseSystemTrustStore` parameter. ({issue}`10482`)\", \"Add support for `ResultSet.getAsciiStream()` and `ResultSet.getBinaryStream()`. ({issue}`11753`)\", \"Remove `user` property requirement. ({issue}`11350`)\"], \"CLI\": [\"Add support for using the system truststore with the `--use-system-truststore` option. ({issue}`10482`)\"], \"Accumulo connector\": [\"Add support for adding and dropping schemas. ({issue}`11808`)\", \"Disallow creating tables in a schema that doesn't exist. ({issue}`11808`)\"], \"ClickHouse connector\": [\"Add support for column comments when creating new tables. ({issue}`11606`)\", \"Add support for column comments when adding new columns. ({issue}`11606`)\"], \"Delta Lake connector\": [\"Add support for `INSERT`, `UPDATE`, and `DELETE` queries on Delta Lake tables\\nwith fault-tolerant execution. ({issue}`11591`)\", \"Allow setting duration for completion of [dynamic filtering](/admin/dynamic-filtering)\\nwith the `delta.dynamic-filtering.wait-timeout` configuration property. ({issue}`11600`)\", \"Improve query planning time after `ALTER TABLE ... EXECUTE optimize` by always\\ncreating a transaction log checkpoint. ({issue}`11721`)\", \"Add support for reading Delta Lake tables in with auto-commit mode disabled. ({issue}`11792`)\"], \"Hive connector\": [\"Store file min/max ORC statistics for string columns even when actual min or\\nmax value exceeds 64 bytes. This improves query performance when filtering on\\nsuch column. ({issue}`11652`)\", \"Improve performance when reading Parquet data. ({issue}`11675`)\", \"Improve query performance when the same table is referenced multiple times\\nwithin a query. ({issue}`11650`)\"], \"Iceberg connector\": [\"Add support for views when using Iceberg Glue catalog. ({issue}`11499`)\", \"Add support for reading Iceberg v2 tables containing deletion files. ({issue}`11642`)\", \"Add support for table redirections to the Hive connector. ({issue}`11356`)\", \"Include non-Iceberg tables when listing tables from Hive catalogs. ({issue}`11617`)\", \"Expose `nan_count` in the `$partitions` metadata table. ({issue}`10709`)\", \"Store file min/max ORC statistics for string columns even when actual min or\\nmax value exceeds 64 bytes. This improves query performance when filtering on\\nsuch column. ({issue}`11652`)\", \"Improve performance when reading Parquet data. ({issue}`11675`)\", \"Fix NPE when an Iceberg data file is missing null count statistics. ({issue}`11832`)\"], \"Kudu connector\": [\"Add support for adding columns with comment. ({issue}`11486`)\"], \"MySQL connector\": [\"Improve performance of queries involving joins by pushing computation to the\\nMySQL database. ({issue}`11638`)\"], \"Oracle connector\": [\"Improve query performance of queries involving aggregation by pushing\\naggregation computation to the Oracle database. ({issue}`11657`)\"], \"SPI\": [\"Add support for table procedures that execute on the coordinator only. ({issue}`11750`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 249]\"}, {\"title\": \"Release 377 (13 Apr 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for standard SQL `trim` syntax. ({issue}`11236`)\", \"Fix incorrect results when queries execute in fault-tolerant mode. ({issue}`11870`)\"], \"Hive connector\": [\"Add support for `date` type partition names with timestamp formatting. ({issue}`11873`)\", \"Improve performance of queries that use Glue metadata. ({issue}`11869`)\", \"Fix failure of the `sync_partition_metadata` procedure when partition names\\ndiffer from partition paths on the file system. ({issue}`11864`)\"], \"Iceberg connector\": [\"Support setting Glue metastore catalog identifier with the\\n`hive.metastore.glue.catalogid` catalog configuration property. ({issue}`11520`)\", \"Add support for materialized views when using Glue metastore. ({issue}`11780`)\"], \"Kafka connector\": [\"Add support for additional Kafka client properties specified with the\\n`kafka.config.resources` catalog configuration property. ({issue}`8743`)\"], \"SQL Server connector\": [\"Improve performance of queries involving joins by pushing computation to the\\nSQL Server database. ({issue}`11637`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 250]\"}, {\"title\": \"Release 378 (21 Apr 2022)\", \"description\": null, \"content\": {\"General\": [\"Add {func}`to_base32` and {func}`from_base32` functions. ({issue}`11439`)\", \"Improve planning performance of queries with large `IN` lists.\\n({issue}`11902`, {issue}`11918`, {issue}`11956`)\", \"Improve performance of queries involving correlated `IN` or `EXISTS`\\npredicates. ({issue}`12047`)\", \"Fix reporting of total spilled bytes in JMX metrics. ({issue}`11983`)\"], \"Security\": [\"Require value for [the shared secret configuration for internal\\ncommunication](/security/internal-communication) when any authentication is\\nenabled. ({issue}`11944`)\"], \"CLI\": [\"Allow disabling progress reporting during query executing in the CLI client by\\nspecifying `--no-progress` ({issue}`11894`)\", \"Reduce latency for very short queries. ({issue}`11768`)\"], \"Delta Lake connector\": [\"Improve query planning performance. ({issue}`11858`)\", \"Fix failure when reading from `information_schema.columns` when metastore\\ncontains views. ({issue}`11946`)\", \"Add support for dropping tables with invalid metadata. ({issue}`11924`)\", \"Fix query failure when partition column has a `null` value and query has a\\ncomplex predicate on that partition column. ({issue}`12056`)\"], \"Hive connector\": [\"Improve query planning performance. ({issue}`11858`)\"], \"Iceberg connector\": [\"Add support for hidden `$path` columns. ({issue}`8769`)\", \"Add support for creating tables with either Iceberg format version 1, or 2. ({issue}`11880`)\", \"Add the `expire_snapshots` table procedure. ({issue}`10810`)\", \"Add the `delete_orphan_files` table procedure. ({issue}`10810`)\", \"Allow reading Iceberg tables written by Glue that have locations containing\\ndouble slashes. ({issue}`11964`)\", \"Improve query planning performance. ({issue}`11858`)\", \"Fix query failure with a dynamic filter prunes a split on a worker node. ({issue}`11976`)\", \"Include missing `format_version` property in `SHOW CREATE TABLE` output. ({issue}`11980`)\"], \"MySQL connector\": [\"Improve query planning performance. ({issue}`11858`)\"], \"Pinot connector\": [\"Support querying tables having non-lowercase names in Pinot. ({issue}`6789`)\", \"Fix handling of hybrid tables in Pinot and stop returning duplicate data. ({issue}`10125`)\"], \"PostgreSQL connector\": [\"Improve query planning performance. ({issue}`11858`)\"], \"SQL Server connector\": [\"Improve query planning performance. ({issue}`11858`)\"], \"SPI\": [\"Deprecate passing constraints to `ConnectorMetadata.getTableStatistics()`.\\nConstraints can be associated with the table handle in\\n`ConnectorMetadata.applyFilter()`. ({issue}`11877`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 251]\"}, {\"title\": \"Release 379 (28 Apr 2022)\", \"description\": null, \"content\": {\"General\": [\"Add {doc}`/connector/mariadb`. ({issue}`10046`)\", \"Improve performance of queries that contain `JOIN` and `UNION` clauses. ({issue}`11935`)\", \"Improve performance of queries that contain `GROUP BY` clauses. ({issue}`12095`)\", \"Fail `DROP TABLE IF EXISTS` when deleted entity is not a table. Previously the\\nstatement did not delete anything. ({issue}`11555`)\", \"Fail `DROP VIEW IF EXISTS` when deleted entity is not a view. Previously the\\nstatement did not delete anything. ({issue}`11555`)\", \"Fail `DROP MATERIALIZED VIEW IF EXISTS` when deleted entity is not a\\nmaterialized view. Previously the statement did not delete anything.\\n({issue}`11555`)\"], \"Web UI\": [\"Group information about tasks by stage. ({issue}`12099`)\", \"Show aggregated statistics for failed tasks of queries that are executed with\\n`retry-policy` set to `TASK`. ({issue}`12099`)\", \"Fix reporting of `physical input read time`. ({issue}`12135`)\"], \"Delta Lake connector\": [\"Add support for Google Cloud Storage. ({issue}`12144`)\", \"Fix failure when reading from `information_schema.columns` when non-Delta\\ntables are present in the metastore. ({issue}`12122`)\"], \"Iceberg connector\": [\"Add support for {doc}`/sql/delete` with arbitrary predicates. ({issue}`11886`)\", \"Improve compatibility when Glue storage properties are used. ({issue}`12164`)\", \"Prevent data loss when queries modify a table concurrently when Glue catalog\\nis used. ({issue}`11713`)\", \"Enable commit retries when conflicts occur writing a transaction to a Hive Metastore. ({issue}`12419`)\", \"Always return the number of deleted rows for {doc}`/sql/delete` statements. ({issue}`12055`)\"], \"Pinot connector\": [\"Add support for Pinot 0.10. ({issue}`11475`)\"], \"Redis connector\": [\"Improve performance when reading data from Redis. ({issue}`12108`)\"], \"SQL Server connector\": [\"Properly apply snapshot isolation to all connections when it is enabled. ({issue}`11662`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 252]\"}, {\"title\": \"Release 380 (6 May 2022)\", \"description\": null, \"content\": {\"General\": [\"Enable automatic [writer scaling](/admin/properties-writer-scaling) by default. ({issue}`10614`)\", \"Improve performance of joins involving comparisons with the `<`,`<=`, `>`,`>=` operators. ({issue}`12236`)\"], \"Cassandra connector\": [\"Add support for the v5 and v6 protocols. ({issue}`7729`)\", \"Removes support for v2 protocol. ({issue}`7729`)\", \"Make the `cassandra.load-policy.use-dc-aware` and `cassandra.load-policy.dc-aware.local-dc`\\ncatalog configuration properties mandatory. ({issue}`7729`)\"], \"Hive connector\": [\"Support table redirections from Hive to Delta Lake. ({issue}`11550`)\", \"Allow configuring a default value for the `auto_purge` table property with the\\n`hive.auto-purge` catalog property. ({issue}`11749`)\", \"Allow configuration of the Hive views translation security semantics with the\\n`hive.hive-views.run-as-invoker` catalog configuration property. ({issue}`9227`)\", \"Rename catalog configuration property `hive.translate-hive-views` to\\n`hive.hive-views.enabled`. The former name is still accepted. ({issue}`12238`)\", \"Rename catalog configuration property `hive.legacy-hive-view-translation`\\nto `hive.hive-views.legacy-translation`. The former name is still accepted. ({issue}`12238`)\", \"Rename session property `legacy_hive_view_translation` to\\n`hive_views_legacy_translation`. ({issue}`12238`)\"], \"Iceberg connector\": [\"Allow updating tables from the Iceberg v1 table format to v2 with\\n`ALTER TABLE ... SET PROPERTIES`. ({issue}`12161`)\", \"Allow changing the default [file format](iceberg-table-properties) for a table\\nwith `ALTER TABLE ... SET PROPERTIES`. ({issue}`12161`)\", \"Prevent potential corruption when a table change is interrupted by networking\\nor timeout failures. ({issue}`10462`)\"], \"MongoDB connector\": [\"Add support for [`ALTER TABLE ... RENAME TO ...`](/sql/alter-table). ({issue}`11423`)\", \"Fix failure when reading decimal values with precision larger than 18. ({issue}`12205`)\"], \"SQL Server connector\": [\"Add support for bulk data insertion. ({issue}`12176`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 253]\"}, {\"title\": \"Release 381 (16 May 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for fault-tolerant execution with exchange spooling on Azure Blob Storage. ({issue}`12211`)\", \"Add experimental support for {doc}`/functions/table`. ({issue}`1839`)\", \"Increase the default number of stages allowed for a query from 100 to 150,\\nspecified with `query.max-stage-count`. ({issue}`12292`)\", \"Allow configuring the number of partitions for distributed joins and\\naggregations when task-based fault-tolerant execution is enabled. This can be\\nset with the `fault-tolerant-execution-partition-count` configuration property\\nor the `fault_tolerant_execution_partition_count` session property. ({issue}`12263`)\", \"Introduce the `least-waste` low memory task killer policy. This policy avoids\\nkilling tasks that are already executing for a long time, so the amount of\\nwasted work is minimized. It can be enabled with the\\n`task.low-memory-killer.policy` configuration property. ({issue}`12393`)\", \"Fix potential planning failure of queries with multiple subqueries. ({issue}`12199`)\"], \"Security\": [\"Add support for automatic discovery of OpenID Connect metadata with OAuth 2.0\\nauthentication. ({issue}`9788`)\", \"Re-introduce `ldap.ssl-trust-certificate` as legacy configuration to avoid\\nfailures when updating Trino version. ({issue}`12187`)\", \"Fix potential query failure when a table has multiple column masks defined. ({issue}`12262`)\", \"Fix incorrect masking of columns when multiple rules in file-based system and\\nconnector access controls match. ({issue}`12203`)\", \"Fix authentication failure when using the LDAP password authenticator with\\nActiveDirectory. ({issue}`12321`)\"], \"Web UI\": [\"Ensure consistent sort order in the list of workers. ({issue}`12290`)\"], \"Docker image\": [\"Improve Advanced Encryption Standard (AES) processing performance on ARM64\\nprocessors. This is used for operations such as accessing object storage\\nsystems via TLS/SSL. ({issue}`12251`)\"], \"CLI\": [\"Add automatic suggestions from command history. This can be disabled with the\\n`--disable-auto-suggestion` option. ({issue}`11671`)\"], \"BigQuery connector\": [\"Support reading materialized views. ({issue}`12352`)\", \"Allow skipping view materialization via `bigquery.skip-view-materialization`\\nconfiguration property. ({issue}`12210`)\", \"Support reading snapshot tables. ({issue}`12380`)\"], \"ClickHouse connector\": [\"Add support for [`COMMENT ON TABLE`](/sql/comment). ({issue}`11216`)\", \"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"Druid connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"Elasticsearch connector\": [\"Improve query performance by simplifying filters sent to Elasticsearch. ({issue}`10717`)\", \"Fix failure when reading nested timestamp values that are not ISO 8601 formatted. ({issue}`12250`)\"], \"Hive connector\": [\"Fix query failure when the table and partition bucket counts do not match. ({issue}`11885`)\"], \"Iceberg connector\": [\"Add support for {doc}`/sql/update`. ({issue}`12026`)\", \"Fix potential query failure or incorrect results when reading data from an\\nIceberg table that contains\\n[equality delete files](https://iceberg.apache.org/spec/#equality-delete-files). ({issue}`12026`)\"], \"MariaDB connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"MySQL connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"Oracle connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"PostgreSQL connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12225`)\"], \"Redis connector\": [\"Allow specifying the refresh interval for fetching the table description with\\nthe `redis.table-description-cache-ttl` configuration property. ({issue}`12240`)\", \"Support setting username for the connection with the `redis.user`\\nconfiguration property. ({issue}`12279`)\"], \"Redshift connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"SingleStore (MemSQL) connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"SQL Server connector\": [\"Prevent data loss when non-transactional insert fails. ({issue}`12229`)\"], \"SPI\": [\"Remove deprecated `ConnectorMetadata` methods without the retry mode parameter. ({issue}`12342`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 254]\"}, {\"title\": \"Release 382 (25 May 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for fault-tolerant execution with [exchange spooling on Google Cloud Storage](fte-exchange-gcs). ({issue}`12360`)\", \"Drop support for exchange spooling on S3 with for the legacy schemes `s3n://` and `s3a://`. ({issue}`12360`)\", \"Improve join performance when one side of the join is small. ({issue}`12257`)\", \"Fix potential query failures due to `EXCEEDED_TASK_DESCRIPTOR_STORAGE_CAPACITY`\\nerrors with task-based fault-tolerant execution. ({issue}`12478`)\"], \"BigQuery connector\": [\"Add support for [using BigQuery's cached query results](https://cloud.google.com/bigquery/docs/cached-results).\\nThis can be enabled using the `bigquery.query-results-cache.enabled` configuration property. ({issue}`12408`)\", \"Support reading wildcard tables. ({issue}`4124`)\"], \"Delta Lake connector\": [\"Improve performance of queries that include filters on columns of `timestamp with time zone` type. ({issue}`12007`)\", \"Add support for adding columns with `ALTER TABLE`. ({issue}`12371`)\"], \"Hive connector\": [\"Add support for disabling partition caching in the Hive metastore with the\\n`hive.metastore-cache.cache-partitions` catalog configuration property. ({issue}`12343`)\", \"Fix potential query failure when metastore caching is enabled. ({issue}`12513`)\", \"Fix query failure when a transactional table contains a column named\\n`operation`, `originalTransaction`, `bucket`, `rowId`, `row`, or\\n`currentTransaction`. ({issue}`12401`)\", \"Fix `sync_partition_metadata` procedure failure when table has a large number of partitions. ({issue}`12525`)\"], \"Iceberg connector\": [\"Support updating Iceberg table partitioning using `ALTER TABLE ... SET PROPERTIES`. ({issue}`12174`)\", \"Improves the performance of queries using equality and `IN` predicates when\\nreading ORC data that contains Bloom filters. ({issue}`11732`)\", \"Rename the `delete_orphan_files` table procedure to `remove_orphan_files`. ({issue}`12468`)\", \"Improve query performance of reads after `DELETE` removes all rows from a file. ({issue}`12197`)\"], \"MySQL connector\": [\"Improve `INSERT` performance. ({issue}`12411`)\"], \"Oracle connector\": [\"Improve `INSERT` performance when data includes `NULL` values. ({issue}`12400`)\"], \"PostgreSQL connector\": [\"Improve `INSERT` performance. ({issue}`12417`)\"], \"Prometheus connector\": [\"Add support for Basic authentication. ({issue}`12302`)\"], \"SPI\": [\"Change `ConnectorTableFunction` into an interface and add\\n`AbstractConnectorTableFunction` class as the base implementation of table\\nfunctions. ({issue}`12531`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 255]\"}, {\"title\": \"Release 383 (1 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Introduce `json_exists`, `json_query`, and `json_value` [JSON functions](/functions/json). ({issue}`9081`)\", \"Add AWS IAM role support for exchange spooling on S3. ({issue}`12444`)\", \"Improve query performance by reducing worker-to-worker communication overhead. ({issue}`11289`)\", \"Improve performance and reduce memory usage of queries that contain aggregations. ({issue}`12336`)\", \"Improve performance of correlated queries involving distinct aggregations. ({issue}`12564`)\"], \"Web UI\": [\"Clarify format of cumulative user memory on query details page. ({issue}`12596`)\"], \"Accumulo connector\": [\"Fail creating a new table if a table comment is specified. Previously, the\\ncomment was ignored. ({issue}`12452`)\"], \"BigQuery connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"Cassandra connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"ClickHouse connector\": [\"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\"], \"Delta Lake connector\": [\"Add support for table comments during table creation.. ({issue}`12452`)\", \"Fix incorrect `table already exists` error caused by a client timeout when\\ncreating a new table. ({issue}`12300`)\", \"Fail creating a new table if a column comment is specified. Previously, the\\ncomment was ignored. ({issue}`12574`)\"], \"Iceberg connector\": [\"Add support for v2 tables for the `optimize` table procedure. ({issue}`12351`)\", \"Rename `hive.target-max-file-size` to `iceberg.target-max-file-size` and\\n`hive.delete-schema-locations-fallback` to `iceberg.delete-schema-locations-fallback`. ({issue}`12330`)\"], \"Kudu connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"MariaDB connector\": [\"Fix incorrect results for certain queries involving aggregations that are\\npushed down to the underlying database. ({issue}`12598`)\", \"Fail creating a new table if a column comment is specified. Previously, the\\ncomment was ignored. ({issue}`12574`)\"], \"Memory connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"MySQL connector\": [\"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\", \"Fail creating a new table if a column comment is specified. Previously, the\\ncomment was ignored. ({issue}`12574`)\"], \"Oracle connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\", \"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\"], \"Phoenix connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"PostgreSQL connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\", \"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\"], \"Raptor connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"Redshift connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\"], \"SingleStore (MemSQL) connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\", \"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\"], \"SQL Server connector\": [\"Fail creating a new table if a table comment or a column comment is specified.\\nPreviously, the comment was ignored. ({issue}`12452`, {issue}`12574`)\", \"Fix incorrect results for certain aggregation queries when aggregations are\\npushed down to the underlying database. ({issue}`12598`)\"], \"SPI\": [\"Allow limiting access to functions based on whether they are scalar,\\naggregation, window, or table functions. ({issue}`12544`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 256]\"}, {\"title\": \"Release 384 (3 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Fix potential query failure due to a regression introduced in version 383. ({issue}`12667`)\", \"Fix potential failure or incorrect result of the `json_query` [JSON function](/functions/json). ({issue}`12681`)\"], \"Druid connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"MariaDB connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"MySQL connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"Oracle connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"PostgreSQL connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"Redshift connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"SingleStore (MemSQL) connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"], \"SQL Server connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`9163`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 257]\"}, {\"title\": \"Release 385 (8 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Add the `json_array` and `json_object` [JSON functions](/functions/json). ({issue}`9081`)\", \"Support all types that can be cast to `varchar` as parameters for the [JSON\\npath](json-path-language). ({issue}`12682`)\", \"Allow `CREATE TABLE LIKE` clause on a table from a different catalog if\\nexplicitly excluding table properties. ({issue}`3171`)\", \"Reduce `Exceeded limit of N open writers for partitions` errors when\\nfault-tolerant execution is enabled. ({issue}`12721`)\"], \"Delta Lake connector\": [\"Add support for the [appendOnly field](https://docs.delta.io/latest/delta-batch.html#-table-properties). ({issue}`12635`)\", \"Add support for column comments when creating a table or a column. ({issue}`12455`, {issue}`12715`)\"], \"Hive connector\": [\"Allow cancelling a query on a transactional table if it is waiting for a lock. ({issue}`11798`)\", \"Add support for selecting a compression scheme when writing Avro files via the\\n`hive.compression-codec` config property or the `compression_codec` session\\nproperty. ({issue}`12639`)\"], \"Iceberg connector\": [\"Improve query performance when a table consists of many small files. ({issue}`12579`)\", \"Improve query performance when performing a delete or update. ({issue}`12671`)\", \"Add support for the `[VERSION | TIMESTAMP] AS OF` clause. ({issue}`10258`)\", \"Show Iceberg location and `format_version` in `SHOW CREATE MATERIALIZED VIEW`. ({issue}`12504`)\"], \"MariaDB connector\": [\"Add support for `timestamp(p)` type. ({issue}`12200`)\"], \"TPC-H connector\": [\"Fix query failure when reading the `dbgen_version` table. ({issue}`12673`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 258]\"}, {\"title\": \"Release 386 (15 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Improve out-of-the-box performance of queries when `task` retry policy is\\nenabled. ({issue}`12646`)\", \"Improve query latency when `task` retry policy is enabled. ({issue}`12615`)\"], \"JDBC driver\": [\"Add configuration property\\n`assumeLiteralUnderscoreInMetadataCallsForNonConformingClients` for situations\\nwhere applications do not properly escape schema or table names in calls to\\n`DatabaseMetaData`. ({issue}`12672`)\"], \"Accumulo connector\": [\"Disallow creating a view in a non-existent schema. ({issue}`12475`)\"], \"Delta Lake connector\": [\"Improve query performance on tables with many small files. ({issue}`12755`)\", \"Disallow reading tables if `delta.columnMapping.mode` table property is\\nspecified. ({issue}`12621`)\", \"Set a target maximum file size during table writes. The default is 1 GB and\\ncan be configured with the `target_max_file_size` session property or the\\n`target-max-file-size` configuration property. ({issue}`12820`)\"], \"Hive connector\": [\"Fix incompatibility with Apache Hive when writing decimal values with\\nprecision of 18 or less with the experimental Parquet writer. ({issue}`12658`)\", \"Fix potential query failure when using schema evolution with union-typed\\ncolumns. ({issue}`12520`)\", \"Fix potential query failure when reading `timestamp(6) with time zone` values. ({issue}`12804`)\"], \"Iceberg connector\": [\"Disallow creating a table with a pre-existing destination location. ({issue}`12573`)\", \"Fix `NoClassDefFoundError` query failure when using Google Cloud Storage. ({issue}`12674`)\", \"Fix `ClassNotFoundException: Class io.trino.plugin.hive.s3.TrinoS3FileSystem`\\nerror when querying `information_schema.columns`. ({issue}`12676`)\", \"Avoid creating a table snapshot when a write statement does not change the\\ntable state. ({issue}`12319`)\", \"Fix incorrect query results when filtering on `$path` synthetic column and on\\nat least one other column. ({issue}`12790`)\", \"Fix potential query failure when reading `timestamp(6) with time zone` values. ({issue}`12804`)\", \"Fix query failure when using the `[VERSION | TIMESTAMP] AS OF` clause on a\\ntable with redirection. ({issue}`12542`)\", \"Fix query failure when reading a `timestamp(p) with time zone` value before\\n1970 from a Parquet file. ({issue}`12852`)\"], \"Kafka connector\": [\"Fix failure when decoding a `float` value to `real` type. ({issue}`12784`)\"], \"Phoenix connector\": [\"Remove support for Phoenix 4. ({issue}`12772`)\"], \"SPI\": [\"Add new version of `getStatisticsCollectionMetadata()` to `ConnectorMetadata`\\nwhich returns `ConnectorAnalyzeMetadata`. Deprecate the existing method and\\n`getTableHandleForStatisticsCollection()`. ({issue}`12388`)\", \"Remove deprecated `ConnectorMetadata.getTableStatistics` method. ({issue}`12489`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 259]\"}, {\"title\": \"Release 387 (22 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for query parameters in table function arguments. ({issue}`12910`)\", \"Update minimum required Java version to 11.0.15. ({issue}`12841`)\", \"Fix incorrect result for {func}`to_iso8601` when the timestamp is in the\\ndaylight savings transition region. ({issue}`11619`)\"], \"CLI\": [\"Fix query history not being stored when a query starts with whitespace. ({issue}`12847`)\"], \"Delta Lake connector\": [\"Record table size when analyzing a table. ({issue}`12814`)\", \"Enable the optimized Parquet writer by default. This can be disabled via the\\n`parquet.experimental-optimized-writer.enabled` configuration property. ({issue}`12757`)\", \"Disallow adding a new column to a table that has been written with an\\nunsupported writer. ({issue}`12883`)\"], \"Hive connector\": [\"Add support for ORC bloom filters on `varchar` columns. ({issue}`11757`)\"], \"Iceberg connector\": [\"Allow `OPTIMIZE` on a table partitioned on a `timestamp with time zone` column\\nwhen using `CAST(timestamp_col AS date) >= DATE '...'` syntax. ({issue}`12362`)\", \"Allow `OPTIMIZE` with a predicate on a table that does not have identity\\npartitioning. ({issue}`12795`)\", \"Improve performance of `DELETE` when deleting whole partitions from a table\\nthat does not have identity partitioning. ({issue}`7905`)\", \"Fix incorrect results when a query contains a filter on a `UUID` column. ({issue}`12834`)\", \"Fail queries that attempt to modify old snapshots. ({issue}`12860`)\", \"Deprecate using synthetic `@`-based syntax for Iceberg snapshot access in\\nfavor of the `AS OF` syntax. The old behavior can be restored by setting the\\n`allow_legacy_snapshot_syntax` session property or\\n`iceberg.allow-legacy-snapshot-syntax` configuration property. ({issue}`10768`)\"], \"Kudu connector\": [\"Fix failure when inserting into a table with a `row_uuid` column. ({issue}`12915`)\"], \"Pinot connector\": [\"Add support for querying Pinot via the gRPC endpoint. ({issue}`9296 `)\"], \"Redis connector\": [\"Add support for predicate pushdown on columns of type `string`. ({issue}`12218`)\"], \"SPI\": [\"Add information about query retry policy to `QueryCompletedEvent` and\\n`QueryCreatedEvent`. ({issue}`12898`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 260]\"}, {\"title\": \"Release 388 (29 Jun 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for `EXPLAIN (TYPE LOGICAL, FORMAT JSON)`. ({issue}`12694`)\", \"Add `use_exact_partitioning` session property to re-partition data when the\\nupstream stage's partitioning does not exactly match what the downstream stage\\nexpects. ({issue}`12495`)\", \"Improve read performance for `row` data types. ({issue}`12926`)\", \"Remove the grouped execution mechanism, including the\\n`grouped-execution-enabled`, `dynamic-schedule-for-grouped-execution`,\\nand `concurrent-lifespans-per-task` configuration properties and the\\n`grouped_execution`, `dynamic_schedule_for_grouped_execution`, and\\n`concurrent_lifespans_per_task` session properties. ({issue}`12916`)\"], \"Security\": [\"Add [refresh token](https://oauth.net/2/refresh-tokens/) support in OAuth 2.0. ({issue}`12664`)\"], \"Delta Lake connector\": [\"Add support for setting table and column comments with the `COMMENT`\\nstatement. ({issue}`12971`)\", \"Support reading tables with the property `delta.columnMapping.mode=name`. ({issue}`12675`)\", \"Allow renaming tables with an explicitly set location. ({issue}`11400`)\"], \"Elasticsearch connector\": [\"Remove support for Elasticsearch versions below 6.6.0. ({issue}`11263`)\"], \"Hive connector\": [\"Improve performance of listing files and generating splits when recursive\\ndirectory listings are enabled and tables are stored in S3. ({issue}`12443`)\", \"Fix incompatibility that prevents Apache Hive 3 and older from reading \\ntimestamp columns in files produced by Trino's optimized Parquet\\nwriter. ({issue}`12857 `)\", \"Prevent reading from a table that was modified within the same Trino \\ntransaction. Previously, this returned incorrect query results. ({issue}`11769`)\"], \"Iceberg connector\": [\"Add support for reading `tinyint` columns from ORC files. ({issue}`8919`)\", \"Add the ability to configure the schema for materialized view storage tables. ({issue}`12591`)\", \"Remove old deletion-tracking files when running `optimize`. ({issue}`12617`)\", \"Fix failure when invoking the `rollback_to_snapshot` procedure. ({issue}`12887`)\", \"Fix query failure when reading the `$partitions` table after table\\npartitioning changed. ({issue}`12874`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 261]\"}, {\"title\": \"Release 389 (7 Jul 2022)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of queries involving `row` type or certain aggregations\\nsuch as `sum`, `avg`, etc. ({issue}`12762`)\", \"Improve performance when spilling to disk is disabled. ({issue}`12618`)\", \"Fix potential incorrect results for queries involving non-equality filters on\\ntop of an outer join. ({issue}`13109`)\", \"Fix query failure when no arguments are passed to a table function. ({issue}`12951`)\", \"Fix potential failure when using `EXPLAIN` with queries involving table \\nfunctions. ({issue}`13106`)\", \"Fix potential resource leaks when calling long-running regular expression\\nfunctions. ({issue}`13064`)\"], \"Delta Lake connector\": [\"Improve optimized Parquet writer performance for\\n[non-structural data types](structural-data-types). ({issue}`13030`)\", \"Prevent failure when starting the server if the internal table snapshots cache\\nis disabled. ({issue}`13086`)\"], \"Elasticsearch connector\": [\"Add `raw_query` table function for full query pass-through to the connector. ({issue}`12324`)\"], \"Hive connector\": [\"Improve optimized Parquet writer performance for\\n[non-structural data types](structural-data-types). ({issue}`13030`)\"], \"Iceberg connector\": [\"Improve performance when writing Parquet files with\\n[non-structural data types](structural-data-types). ({issue}`13030`)\"], \"MongoDB connector\": [\"Create a collection when creating a new table. Previously, it was created when\\nthe data was written to the table for the first time. ({issue}`12892`)\"], \"Phoenix connector\": [\"Add support for Java 17. ({issue}`13108`)\"], \"PostgreSQL connector\": [\"Prevent creating a new table with a name longer than the max length.\\nPreviously, the name was truncated to the max length. ({issue}`12892`)\"], \"SPI\": [\"Remove deprecated version of `ConnectorRecordSetProvider#getRecordSet`. ({issue}`13084`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 262]\"}, {\"title\": \"Release 390 (13 Jul 2022)\", \"description\": null, \"content\": {\"General\": [\"Update minimum required Java version to 17.0.3. ({issue}`13014`)\", \"Add support for [setting comments on views](/sql/comment). ({issue}`8349`)\", \"Improve performance of queries with an `UNNEST` clause. ({issue}`10506`)\", \"Fix potential query failure when spilling to disk is enabled by the\\n`force-spilling-join-operator` configuration property or the\\n`force_spilling_join` session property. ({issue}`13123`)\", \"Fix incorrect results for certain join queries containing filters involving\\nexplicit or implicit casts. ({issue}`13145 `)\"], \"Cassandra connector\": [\"Change mapping for Cassandra `inet` type to Trino `ipaddress` type.\\nPreviously, `inet` was mapped to `varchar`. ({issue}`851`)\", \"Remove support for the\\n`cassandra.load-policy.use-token-aware`,\\n`cassandra.load-policy.shuffle-replicas`, and\\n`cassandra.load-policy.allowed-addresses` configuration properties. ({issue}`12223`)\"], \"Delta Lake connector\": [\"Add support for filtering splits based on `$path` column predicates. ({issue}`13169`)\", \"Add support for Databricks runtime 10.4 LTS. ({issue}`13081`)\", \"Expose AWS Glue metastore statistics via JMX. ({issue}`13087`)\", \"Fix failure when using the Glue metastore and queries contain `IS NULL` or\\n`IS NOT NULL` filters on numeric partition columns. ({issue}`13124`)\"], \"Hive connector\": [\"Expose AWS Glue metastore statistics via JMX. ({issue}`13087`)\", \"Add support for [setting comments on views](/sql/comment). ({issue}`13147`)\", \"Fix failure when using the Glue metastore and queries contain `IS NULL` or\\n`IS NOT NULL` filters on numeric partition columns. ({issue}`13124`)\", \"Fix and re-enable usage of Amazon S3 Select for uncompressed files. ({issue}`12633`)\"], \"Iceberg connector\": [\"Add `added_rows_count`, `existing_rows_count`, and `deleted_rows_count`\\ncolumns to the `$manifests` table. ({issue}`10809`)\", \"Add support for [setting comments on views](/sql/comment). ({issue}`13147`)\", \"Expose AWS Glue metastore statistics via JMX. ({issue}`13087`)\", \"Fix failure when using the Glue metastore and queries contain `IS NULL` or\\n`IS NOT NULL` filters on numeric partition columns. ({issue}`13124`)\"], \"Memory connector\": [\"Add support for [setting comments on views](/sql/comment). ({issue}`8349`)\"], \"Prometheus connector\": [\"Fix failure when reading a table without specifying a `labels` column. ({issue}`12510`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 263]\"}, {\"title\": \"Release 391 (22 Jul 2022)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of repeated aggregations with ``CASE`` expressions. ({issue}`12548`)\", \"Improve query latency when there is high concurrency. ({issue}`13213`)\", \"Improve planning performance for join queries when tables have statistics. ({issue}`13047`)\", \"Fail queries that get stuck in long-running regular expression functions. ({issue}`12392`)\", \"Fix potential query failure when the ``UUID`` type is used. ({issue}`13265`)\", \"Set the default value of the ``optimizer.force-single-node-output``\\nconfiguration property to false. ({issue}`13217`)\"], \"BigQuery connector\": [\"Add support for reading external tables. ({issue}`13164`)\", \"Add support for specifying table and column comments when creating a table. ({issue}`13105`)\"], \"Delta Lake connector\": [\"Improve optimized Parquet writer performance. ({issue}`13203`, {issue}`13208`)\", \"Store query ID when creating a new schema. ({issue}`13242`)\", \"Fix incorrect `schema already exists` error caused by a client timeout when\\ncreating a new schema. ({issue}`13242`)\", \"Fix incorrect query results when reading a table with an outdated cached\\nrepresentation of its active data files. ({issue}`13181`)\"], \"Druid connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"Hive connector\": [\"Add support for [AWS Athena partition projection](partition-projection). ({issue}`11305`)\", \"Improve optimized Parquet writer performance. ({issue}`13203`, {issue}`13208`)\", \"Fix potential failure when creating empty ORC bucket files while using ZSTD\\ncompression. ({issue}`9775`)\", \"Fix query failure or potentially incorrect statistics when running concurrent\\n`CREATE TABLE AS` queries with the `IF NOT EXISTS` clause for the same\\nnon-existent table. ({issue}`12895`)\", \"Fix incorrect results when using the Glue metastore with queries that contain\\n`IS NULL` and additional filters. ({issue}`13122`)\"], \"Iceberg connector\": [\"Improve performance when writing Parquet writer data. ({issue}`13203`, {issue}`13208`)\", \"Fix query failure when reading an Iceberg table with deletion-tracking files. ({issue}`13035`)\"], \"MariaDB connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"MySQL connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"Oracle connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"PostgreSQL connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"Redshift connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"SQL Server connector\": [\"Fix potential query failure when using the ``query`` table function with\\nmetadata caching and the underlying table schema is changed via Trino. ({issue}`12526`)\"], \"SPI\": [\"Removed deprecated methods and classes related to the grouped execution\\nfeature. ({issue}`13125`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 264]\"}, {\"title\": \"Release 392 (3 Aug 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for dynamic filtering when task-based fault-tolerant execution is enabled. ({issue}`9935`)\", \"Add support for correlated sub-queries in `DELETE` queries. ({issue}`9447`)\", \"Fix potential query failure in certain complex queries with multiple joins and\\naggregations. ({issue}`13315`)\"], \"JDBC driver\": [\"Add the `assumeLiteralUnderscoreInMetadataCallsForNonConformingClients`\\nconfiguration property as a replacement for\\n`assumeLiteralNamesInMetadataCallsForNonConformingClients`, which is\\ndeprecated and planned to be removed in a future release. ({issue}`12761`)\"], \"ClickHouse connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"Delta Lake connector\": [\"Add support for using a randomized location when creating a table, so that\\nfuture table renames or drops do not interfere with new tables created with\\nthe same name. This can be disabled by setting the\\n`delta.unique-table-location` configuration property to false. ({issue}`12980`)\", \"Add `delta.metadata.live-files.cache-ttl` configuration property for the\\ncaching duration of active data files. ({issue}`13316`)\", \"Retain metadata properties and column metadata after schema changes. ({issue}`13368`, {issue}`13418`)\", \"Prevent writing to a table with `NOT NULL` or\\n[column invariants](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#column-invariants)\\ncolumns. ({issue}`13353`)\", \"Fix incorrect min and max column statistics when writing `NULL` values. ({issue}`13389`)\"], \"Druid connector\": [\"Add support for `timestamp(p)` predicate pushdown. ({issue}`8404`)\", \"Report the total time spent reading data from the data source. ({issue}`13132`)\", \"Change mapping for the Druid `float` type to the Trino `real` type instead of\\nthe `double` type. ({issue}`13412`)\"], \"Hive connector\": [\"Add support for short timezone IDs when translating Hive views. For example,\\n`JST` now works as an alias for `Asia/Tokyo`. ({issue}`13179`)\", \"Add support for Amazon S3 Select pushdown for JSON files. ({issue}`13354`)\"], \"Iceberg connector\": [\"Add support for hidden `$file_modified_time` columns. ({issue}`13082`)\", \"Add support for the Avro file format. ({issue}`12125`)\", \"Add support for filtering splits based on `$path` column predicates. ({issue}`12785`)\", \"Improve query performance for tables with updated or deleted rows. ({issue}`13092`)\", \"Improve performance of the `expire_snapshots` command for tables with many\\nsnapshots. ({issue}`13399`)\", \"Use unique table locations by default. This can be disabled by setting the\\n`iceberg.unique-table-location` configuration property to false. ({issue}`12941`)\", \"Use the correct table schema when reading a past version of a table. ({issue}`12786`)\", \"Return the `$path` column without encoding when the path contains double\\nslashes on S3. ({issue}`13012`)\", \"Fix failure when inserting into a Parquet table with columns that have\\nquotation marks in their names. ({issue}`13074`)\"], \"MariaDB connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"MySQL connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\", \"Change mapping for the MySQL `enum` type to the Trino `varchar` type instead\\nof the `char` type. ({issue}`13303`)\", \"Fix failure when reading table statistics while the\\n`information_schema.column_statistics` table doesn't exist. ({issue}`13323`)\"], \"Oracle connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"Phoenix connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"Pinot connector\": [\"Redact the values of `pinot.grpc.tls.keystore-password` and\\n`pinot.grpc.tls.truststore-password` in the server log. ({issue}`13422`)\"], \"PostgreSQL connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\", \"Improve performance of queries with an `IN` expression within a complex\\nexpression. ({issue}`13136`)\"], \"Redshift connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"SingleStore (MemSQL) connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"], \"SQL Server connector\": [\"Report the total time spent reading data from the data source. ({issue}`13132`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 265]\"}, {\"title\": \"Release 393 (17 Aug 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\", \"Add query state and error code to the timeline log message. ({issue}`13698`)\", \"Improve performance of highly selective `LIMIT` queries by making them finish\\nas soon as the required number of rows is produced. ({issue}`13616`)\", \"Disallow inserting `NULL` into non-nullable columns.. ({issue}`13462`)\", \"Fix queries over bucketed tables never completing. ({issue}`13655`)\", \"Fix potential query failure for `GROUP BY` queries involving aggregations with\\n`ORDER BY` and `FILTER` clauses. ({issue}`13627`)\"], \"Security\": [\"Fix potential incorrect rejection of OAuth 2.0 refresh tokens. ({issue}`13168`)\", \"Fix incorrectly showing outdated OAuth 2.0 refresh tokens in the web UI. ({issue}`13168`)\"], \"Docker image\": [\"Add experimental image for `ppc64le`. ({issue}`13522`)\"], \"ClickHouse connector\": [\"Add support for the `unsupported-type-handling` catalog configuration\\nproperty. ({issue}`13542`)\", \"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"Delta Lake connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\", \"Add support for the `NOT NULL` column constraint. ({issue}`13436`)\", \"Fix writing incorrect results when the order of partition columns is different\\nfrom the order in the table definition. ({issue}`13505`)\", \"Fix failure when reading a table which has partition columns renamed by \\nanother engine. ({issue}`13521`)\"], \"Druid connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"Hive connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\", \"Add support for bucket filtering on bucketed columns of `float`, `double`,\\n`date`, `list`, `map` and `bounded varchar` data types. ({issue}`13553`)\", \"Add `exchange.azure.max-error-retries` configuration property for the number\\nof retries performed when accessing Azure blob storage. ({issue}`13663`)\", \"Improve performance of queries with S3 Select pushdown by not utilizing\\npushdown when it is unnecessary. ({issue}`13477`)\", \"Reduce Thrift metastore communication overhead when impersonation is enabled. ({issue}`13606`)\", \"Improve performance when retrieving table statistics from the metastore. ({issue}`13488`)\", \"Fix error when writing to a table with only `date` columns while using the\\nHive metastore. ({issue}`13502`)\", \"Fix error when reading a Hive view which has a column names with a reserved\\nkeyword. ({issue}`13450`)\"], \"Iceberg connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\", \"Improve performance when filtering on `$file_modified_time` column. ({issue}`13504`)\", \"Improve performance of read queries on Iceberg v2 tables with\\ndeletion-tracking files. ({issue}`13395`)\", \"Allow partitioning over columns which use whitespace in their names. ({issue}`12226`)\", \"Disallow specifying a `NOT NULL` constraint when adding a new column.\\nPreviously, the option was ignored. ({issue}`13673`)\", \"Fix error when querying tables which are empty and contain no table history. ({issue}`13576`)\", \"Prevent truncation of the table history in the `$snapshots` system table by\\ncertain `DELETE` queries. ({issue}`12843`)\", \"Prevent errors when optimizing an Iceberg table which is empty and contains\\nno table history. ({issue}`13582`)\", \"Fix incorrect query results when reading from a materialized view that was\\ncreated on a table which was empty and contained no history. ({issue}`13574`)\"], \"Kafka connector\": [\"Fix query failure when applying a negative timestamp predicate on the\\n`_timestamp` column. ({issue}`13167`)\"], \"Kudu connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\"], \"MariaDB connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"MongoDB connector\": [\"Prevent renaming a table with a name longer than the max length supported by\\nMongoDB. Previously, the name was truncated to the max length. ({issue}`13073`)\"], \"MySQL connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"Oracle connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"Phoenix connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"Pinot connector\": [\"Add support for the Pinot `bytes` type. ({issue}`13427`)\", \"Add support for the `json` type. ({issue}`13428`)\"], \"PostgreSQL connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\", \"Prevent using schema names or renaming a table with a name which is longer\\nthan the max length supported by PostgreSQL. Previously, long names were\\ntruncated to the max length. ({issue}`13307`, {issue}`13073`)\"], \"Raptor connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`7933`)\"], \"Redshift connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"SingleStore (MemSQL) connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\"], \"SQL Server connector\": [\"Improve performance for queries with selective joins. ({issue}`13334`)\", \"Prevent renaming a table with a name longer than the max length supported by\\nSQL Server. Previously, the name was truncated to the max length. ({issue}`13073`)\"], \"SPI\": [\"Add `@Experimental` annotation to designate SPIs that are still under active\\ndevelopment. ({issue}`13302`)\", \"Deprecate `io.trino.spi.block.MethodHandleUtil`. ({issue}`13245`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 266]\"}, {\"title\": \"Release 394 (29 Aug 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for JSON as an output format of `EXPLAIN`. ({issue}`12968`)\", \"Improve performance of queries involving joins on a single `bigint` column. ({issue}`13432`)\", \"Improve performance of `LIKE` expressions. ({issue}`13479`)\", \"Ensure `UPDATE` queries cannot insert null values into columns with a\\n`NOT NULL` constraint. ({issue}`13435`)\", \"Fix failure when an `UPDATE` query contains a `WHERE` clause which always\\nevaluates to false. ({issue}`12422`)\", \"Fix potential failure for queries involving joins and implicit or explicit\\ncasts of `null` to a concrete type. ({issue}`13565`)\"], \"Docker image\": [\"Ensure Trino stops running with insufficient resources to avoid partial\\nfailures. ({issue}`13736`)\"], \"BigQuery connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`12502`)\", \"Add support for the `INSERT` statement. ({issue}`6868`)\", \"Add support for the `CREATE TABLE ... AS SELECT ...` statement. ({issue}`6869`)\"], \"Delta Lake connector\": [\"Disallow adding a column with a `NOT NULL` constraint to a table which is not\\nempty. ({issue}`13785`)\", \"Fix failure when reading Parquet data that contains only null values. ({issue}`9424`)\", \"Fix potential failure of unrelated queries after dropping a schema. ({issue}`13810`)\"], \"Druid connector\": [\"Improve performance of queries that perform filtering on `varchar` columns that\\ncontain temporal data with the format `YYYY-MM-DD`. ({issue}`12925`)\"], \"Elasticsearch connector\": [\"Add support for multiple hosts in the `elasticsearch.host` configuration\\nproperty. ({issue}`12530`)\"], \"Hive connector\": [\"Add support for a Kerberos credential cache. ({issue}`13482`)\", \"Fix failure when reading Parquet data that contains only null values. ({issue}`9424`)\", \"Fix failure when the metastore returns duplicated column statistics. ({issue}`13787`)\", \"Fix potential failure of unrelated queries after dropping a schema. ({issue}`13810`)\"], \"Iceberg connector\": [\"Improve query planning performance when a `varchar` partitioning column\\ncontains date values in the `YYYY-MM-DD` format. ({issue}`12925`)\", \"Fix query failure when using the `[VERSION | TIMESTAMP] AS OF` clause on a\\ntable created with Iceberg versions older than 0.12. ({issue}`13613`)\", \"Fix failure when reading Parquet data that contains only null values. ({issue}`9424`)\"], \"Oracle connector\": [\"Improve performance of queries that perform filtering on `varchar` columns that\\ncontain temporal data with the format `YYYY-MM-DD`. ({issue}`12925`)\"], \"Phoenix connector\": [\"Improve performance of queries that perform filtering on `varchar` columns that\\ncontain temporal data with the format `YYYY-MM-DD`. ({issue}`12925`)\"], \"Pinot connector\": [\"Add support for TLS when connecting to the Pinot controllers and brokers. ({issue}`13410`)\", \"Fix query failure when using the `HAVING` clause. ({issue}`13429`)\"], \"PostgreSQL connector\": [\"Improve performance of queries that perform filtering on `varchar` columns\\nthat contain temporal data with the format `YYYY-MM-DD`. ({issue}`12925`)\", \"Prevent using a column name which is longer than the maximum length supported\\nby PostgreSQL. Previously, long names were truncated. ({issue}`13742`)\"], \"SQL Server connector\": [\"Prevent renaming a column to a name which is longer than the maximum length\\nsupported by SQL Server. Previously, long names were truncated. ({issue}`13742`)\"], \"SPI\": [\"Add the query plan in JSON format to `QueryCompletedEvent`, and allow\\nconnectors to request anonymized query plans in the `QueryCompletedEvent`. ({issue}`12968`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 267]\"}, {\"title\": \"Release 395 (7 Sep 2022)\", \"description\": null, \"content\": {\"General\": [\"Reduce memory consumption when fault-tolerant execution is enabled. ({issue}`13855`)\", \"Reduce memory consumption of aggregations. ({issue}`12512`)\", \"Improve performance of aggregations with decimals. ({issue}`13573`)\", \"Improve concurrency for large clusters. ({issue}`13934`, `13986`)\", \"Remove `information_schema.role_authorization_descriptors` table. ({issue}`11341`)\", \"Fix `SHOW CREATE TABLE` or `SHOW COLUMNS` showing an invalid type for columns\\nthat use a reserved keyword as column name. ({issue}`13483`)\"], \"ClickHouse connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"Delta Lake connector\": [\"Add support for the `ALTER TABLE ... RENAME TO` statement with a Glue\\nmetastore. ({issue}`12985`)\", \"Improve performance of inserts by automatically scaling the number of writers\\nwithin a worker node. ({issue}`13111`)\", \"Enforce `delta.checkpoint.writeStatsAsJson` and\\n`delta.checkpoint.writeStatsAsStruct` table properties to ensure table\\nstatistics are written in the correct format. ({issue}`12031`)\"], \"Hive connector\": [\"Improve performance of inserts by automatically scaling the number of writers\\nwithin a worker node. ({issue}`13111`)\", \"Improve performance of S3 Select when using CSV files as an input. ({issue}`13754`)\", \"Fix error where the S3 KMS key is not searched in the proper AWS region when\\nS3 client-side encryption is used. ({issue}`13715`)\"], \"Iceberg connector\": [\"Improve performance of inserts by automatically scaling the number of writers\\nwithin a worker node. ({issue}`13111`)\", \"Fix creating metadata and manifest files with a URL-encoded name on S3 when\\nthe metadata location has trailing slashes. ({issue}`13759`)\"], \"MariaDB connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"Memory connector\": [\"Add support for table and column comments. ({issue}`13936`)\"], \"MongoDB connector\": [\"Fix query failure when filtering on columns of `json` type. ({issue}`13536`)\"], \"MySQL connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"Oracle connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"Phoenix connector\": [\"Fix query failure when adding, renaming, or dropping a column with a name\\nwhich matches a reserved keyword or has special characters which require it to\\nbe quoted. ({issue}`13839`)\"], \"PostgreSQL connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"Prometheus connector\": [\"Add support for case-insensitive table name matching with the\\n`prometheus.case-insensitive-name-matching` configuration property. ({issue}`8740`)\"], \"Redshift connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"SingleStore (MemSQL) connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"SQL Server connector\": [\"Fix query failure when renaming or dropping a column with a name which matches\\na reserved keyword or has special characters which require it to be quoted. ({issue}`13839`)\"], \"SPI\": [\"Add support for dynamic function resolution. ({issue}`8`)\", \"Rename `LIKE_PATTERN_FUNCTION_NAME` to `LIKE_FUNCTION_NAME` in\\n`StandardFunctions`. ({issue}`13965`)\", \"Remove the `listAllRoleGrants` method from `ConnectorMetadata`. ({issue}`11341`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 268]\"}, {\"title\": \"Release 396 (15 Sep 2022)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of queries that process string data. ({issue}`12798`)\", \"Fix failure when querying views that use table functions. ({issue}`13944`)\"], \"BigQuery connector\": [\"Add support for [column and table comments](/sql/comment). ({issue}`13882`)\"], \"ClickHouse connector\": [\"Improve performance when pushing down large lists of predicates by raising\\nthe default threshold before the predicate is compacted. ({issue}`14029`)\", \"Fix mapping to the ClickHouse `Date` and `DateTime` types to include the full\\nrange of possible values. ({issue}`11116`)\", \"Fix failure when specifying a table or column comment that contains special\\ncharacters. ({issue}`14058`)\"], \"Delta Lake connector\": [\"Add support for writing to tables using [version 3 of the\\nwriter](https://docs.delta.io/latest/versioning.html#features-by-protocol-version).\\nThis does not yet include support for `CHECK` constraints. ({issue}`14068`)\", \"Add support for reading tables with the table property\\n`delta.columnMapping.mode` set to `id`. ({issue}`13629`)\", \"Improve performance when writing\\n[structural data types](structural-data-types) to Parquet files. ({issue}`13714`)\", \"Attempt to undo the operation when writing a checkpoint file fails. ({issue}`14108`)\", \"Fix performance regression when reading Parquet data. ({issue}`14094`)\"], \"Hive connector\": [\"Add verification for files written by the optimized Parquet writer. This can\\nbe configured with the [`parquet.optimized-writer.validation-percentage`\\nconfiguration property](parquet-format-configuration) or the\\n`parquet_optimized_writer_validation_percentage` session property.\\n({issue}`13246`)\", \"Improve optimized Parquet writer performance for\\n[structural data types](structural-data-types). ({issue}`13714`)\", \"Fix performance regression in reading Parquet files. ({issue}`14094`)\"], \"Iceberg connector\": [\"Improve performance when writing\\n[structural data types](structural-data-types) to Parquet files. ({issue}`13714`)\", \"Improve performance of queries that contain predicates involving `date_trunc`\\non `date`, `timestamp` or `timestamp with time zone` partition columns. ({issue}`14011`)\", \"Fix incorrect results from using the `[VERSION | TIMESTAMP] AS OF` clause when\\nthe snapshot's schema differs from the current schema of the table. ({issue}`14064`)\", \"Prevent `No bucket node map` failures when inserting data. ({issue}`13960`)\", \"Fix performance regression when reading Parquet data introduced in\\n[Trino version 394](release-394.md). ({issue}`14094`)\"], \"MariaDB connector\": [\"Fix failure when using special characters in a table or column comment when\\ncreating a table. ({issue}`14058`)\"], \"MySQL connector\": [\"Fix failure when using special characters in a table or column comment when\\ncreating a table. ({issue}`14058`)\"], \"Oracle connector\": [\"Fix failure when setting a column comment with special characters. ({issue}`14058`)\"], \"Phoenix connector\": [\"Improve performance when pushing down large lists of predicates by raising\\nthe default threshold before the predicate is compacted. ({issue}`14029`)\"], \"PostgreSQL connector\": [\"Fix failure when setting a column comment with special characters. ({issue}`14058`)\"], \"Redshift connector\": [\"Fix failure when setting a column comment with special characters. ({issue}`14058`)\"], \"SPI\": [\"Add the `SystemAccessControl.checkCanGrantExecuteFunctionPrivilege` overload,\\nwhich needs to be implemented to allow views that use table functions. ({issue}`13944`)\", \"Add the `ConnectorMetadata.applyJoin` overload. It provides the connector\\nwith a join condition that is as complete as possible to represent using\\n`ConnectorExpression`. Deprecate the previous version of \\n`ConnectorMetadata.applyJoin`. ({issue}`13943`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 269]\"}, {\"title\": \"Release 397 (21 Sep 2022)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect parsing of invalid values in cast from `varchar` to `timestamp`. ({issue}`14164`)\", \"Fix potential incorrect results for queries with a partitioned output which\\ndoesn't depend on any column data. ({issue}`14168`)\", \"Fix `EXPLAIN (TYPE IO)` query failure for certain queries on empty tables. ({issue}`10398`)\"], \"Security\": [\"Add support for multiple recipients with JWT authentication. ({issue}`13442 `)\", \"Fix OAuth 2.0 token refresh causing JWT authentication failure. ({issue}`13575`)\"], \"JDBC driver\": [\"Fix potential memory leak when cancelling statements. ({issue}`14176`)\"], \"Delta Lake connector\": [\"Rename the `parquet.experimental-optimized-writer.enabled` configuration\\nproperty and `experimental_parquet_optimized_writer_enabled` session property\\nto `parquet.optimized-writer.enabled` and `parquet_optimized_writer_enabled`,\\nrespectively. ({issue}`14137`)\"], \"Hive connector\": [\"Rename the `parquet.experimental-optimized-writer.enabled` configuration\\nproperty and `experimental_parquet_optimized_writer_enabled` session property\\nto `parquet.optimized-writer.enabled` and `parquet_optimized_writer_enabled`,\\nrespectively. ({issue}`14137`)\", \"Improve performance when querying JSON data and Hive S3 Select pushdown is\\nenabled. ({issue}`14040`)\", \"Improve planning performance when querying tables in the Glue catalog that\\ncontain a large number of columns. ({issue}`14206`)\", \"Allow reading from a partitioned table after a column's data type was changed\\nfrom `decimal` to `varchar` or `string`. ({issue}`2817`)\", \"Fix query failure when reading from a Hive view and\\n`hive.hive-views.run-as-invoker` and `hive.hive-views.legacy-translation` are\\nboth enabled. ({issue}`14077`)\"], \"Iceberg connector\": [\"Improve performance of queries that contain predicates involving `date_trunc`\\nwith an `hour` unit on `date`, `timestamp`, or `timestamp with time zone`\\npartition columns. ({issue}`14161`)\", \"Improve performance of reads after a `DELETE` removes all rows from a file. ({issue}`14198`)\", \"Reduce query latency when using a Glue catalog for metadata. ({issue}`13875`)\", \"Fix materialized views temporarily appearing empty when a refresh is about to\\ncomplete. ({issue}`14145`)\", \"Fix potential table corruption when changing a table before it is known if\\ncommitting to the Hive metastore has failed or succeeded. ({issue}`14174`)\"], \"SPI\": [\"Replace `DictionaryBlock` constructors with a factory method. ({issue}`14092`)\", \"Replace `RunLengthEncodedBlock` constructors with a factory method. ({issue}`14092`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 270]\"}, {\"title\": \"Release 398 (28 Sep 2022)\", \"description\": null, \"content\": {\"General\": [\"Add Hudi connector. ({issue}`10228`)\", \"Add metrics for the execution time of filters and projections to `EXPLAIN\\nANALYZE VERBOSE`. ({issue}`14135`)\", \"Show local cost estimates when using `EXPLAIN`. ({issue}`14268`)\", \"Fix timeouts happening too early because of improper handling of the\\n`node-scheduler.allowed-no-matching-node-period` configuration property. ({issue}`14256`)\", \"Fix query failure for `MERGE` queries when `task_writer_count` is greater\\nthan one. ({issue}`14306`)\"], \"Accumulo connector\": [\"Add support for column comments when creating a new table. ({issue}`14114`)\", \"Move column mapping and index information into the output of `DESCRIBE`\\ninstead of a comment. ({issue}`14095`)\"], \"BigQuery connector\": [\"Fix improper escaping of backslash and newline characters. ({issue}`14254`)\", \"Fix query failure when the predicate involves a `varchar` value with a\\nbackslash. ({issue}`14254`)\"], \"ClickHouse connector\": [\"Upgrade minimum required Clickhouse version to 21.8. ({issue}`14112`)\"], \"Delta Lake connector\": [\"Improve performance when reading Parquet files for queries with predicates. ({issue}`14247`)\"], \"Elasticsearch connector\": [\"Deprecate support for query pass-through using the special\\n`<index>$query:<es-query>` dynamic tables in favor of the `raw_query` table\\nfunction. Legacy behavior can be re-enabled with the\\n`elasticsearch.legacy-pass-through-query.enabled` configuration property. ({issue}`14015`)\"], \"Hive connector\": [\"Add support for partitioned views when legacy mode for view translation is\\nenabled. ({issue}`14028`)\", \"Extend the `flush_metadata_cache` procedure to be able to flush table-related\\ncaches instead of only partition-related caches. ({issue}`14219`)\", \"Improve performance when reading Parquet files for queries with predicates. ({issue}`14247`)\"], \"Iceberg connector\": [\"Improve performance when reading Parquet files for queries with predicates. ({issue}`14247`)\", \"Fix potential table corruption when changing a table before it is known if\\ncommitting to the Glue metastore has failed or succeeded. ({issue}`14174`)\"], \"Pinot connector\": [\"Add support for the `timestamp` type. ({issue}`10199`)\"], \"SPI\": [\"Extend `ConnectorMetadata.getStatisticsCollectionMetadata` to allow the\\nconnector to request the computation of any aggregation function during stats\\ncollection. ({issue}`14233`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 271]\"}, {\"title\": \"Release 399 (6 Oct 2022)\", \"description\": null, \"content\": {\"General\": [\"Add operator CPU and wall time distribution to `EXPLAIN ANALYZE VERBOSE`. ({issue}`14370`)\", \"Improve performance of joins. ({issue}`13352`)\", \"Remove support for the deprecated `row` to `json` cast behavior, and remove the\\n`deprecated.legacy-row-to-json-cast` configuration property. ({issue}`14388`)\", \"Fix error when using `PREPARE` with `DROP VIEW` when the view name is quoted. ({issue}`14196`)\", \"Fix potential planning failure for queries involving `UNION`. ({issue}`14472`)\", \"Fix error when using aggregations in window expressions when the function\\nloaded from a plugin. ({issue}`14486`)\"], \"Accumulo connector\": [\"Change the default value of the `accumulo.zookeeper.metadata.root`\\nconfiguration property to `/trino-accumulo` from `/presto-accumulo`. ({issue}`14326`)\"], \"BigQuery connector\": [\"Add support for writing `array`, `row`, and `timestamp` columns. ({issue}`14418`, {issue}`14473`)\"], \"ClickHouse connector\": [\"Fix bug where the intended default value of the `domain-compaction-threshold`\\nconfiguration property was incorrectly used as a maximum limit. ({issue}`14350`)\"], \"Delta Lake connector\": [\"Improve performance of reading decimal columns from Parquet files. ({issue}`14260`)\", \"Allow setting the AWS Security Token Service endpoint and region when using a\\nGlue metastore. ({issue}`14412`)\"], \"Hive connector\": [\"Add `max-partition-drops-per-query` configuration property to limit the number\\nof partition drops. ({issue}`12386`)\", \"Add `hive.s3.region` configuration property to force S3 to connect to a\\nspecific region. ({issue}`14398`)\", \"Improve performance of reading decimal columns from Parquet files. ({issue}`14260`)\", \"Reduce memory usage on the coordinator. ({issue}`14408`)\", \"Reduce query memory usage during inserts to S3. ({issue}`14212`)\", \"Change the name of the `partition_column` and `partition_value` arguments for\\nthe `flush_metadata_cache` procedure to `partition_columns` and\\n`partition_values`, respectively, for parity with other procedures. ({issue}`13566`)\", \"Change field name matching to be case insensitive. ({issue}`13423`)\", \"Allow setting the AWS STS endpoint and region when using a Glue metastore. ({issue}`14412`)\"], \"Hudi connector\": [\"Fix failure when reading hidden columns. ({issue}`14341`)\"], \"Iceberg connector\": [\"Improve performance of reading decimal columns from Parquet files. ({issue}`14260`)\", \"Reduce planning time for complex queries. ({issue}`14443`)\", \"Store metastore `table_type` property value in uppercase for compatibility\\nwith other Iceberg catalog implementations. ({issue}`14384`)\", \"Allow setting the AWS STS endpoint and region when using a Glue metastore. ({issue}`14412`)\"], \"Phoenix connector\": [\"Fix bug where the intended default value of the `domain-compaction-threshold`\\nconfiguration property was incorrectly used as a maximum limit. ({issue}`14350`)\"], \"SQL Server connector\": [\"Fix error when querying or listing tables with names that contain special\\ncharacters. ({issue}`14286`)\"], \"SPI\": [\"Add stage output buffer distribution to `EventListener`. ({issue}`14400`)\", \"Remove deprecated `TimeType.TIME`, `TimestampType.TIMESTAMP` and\\n`TimestampWithTimeZoneType.TIMESTAMP_WITH_TIME_ZONE` constants. ({issue}`14414`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 272]\"}, {\"title\": \"Release 400 (13 Oct 2022)\", \"description\": null, \"content\": {\"General\": [\"Add output buffer utilization to `EXPLAIN ANALYZE VERBOSE`. ({issue}`14396`)\", \"Increase concurrency for large clusters. ({issue}`14395`)\", \"Fix JSON serialization failure for `QueryCompletedEvent` in event listener.\\n({issue}`14604`)\", \"Fix occasional `maximum pending connection acquisitions exceeded` failure\\nwhen fault-tolerant execution is enabled. ({issue}`14580`)\", \"Fix incorrect results when calling the `round` function on large `real` and\\n`double` values. ({issue}`14613`)\", \"Fix query failure when using the `merge(qdigest)` function. ({issue}`14616`)\"], \"BigQuery connector\": [\"Add support for [truncating tables](/sql/truncate). ({issue}`14494`)\"], \"Delta Lake connector\": [\"Prevent coordinator out-of-memory failure when querying a large number of\\ntables in a short period of time. ({issue}`14571`)\"], \"Hive connector\": [\"Reduce memory usage when scanning a large number of partitions, and add the\\n`hive.max-partitions-for-eager-load` configuration property to manage the\\nnumber of partitions that can be loaded into memory. ({issue}`14225`)\", \"Increase the default value of the `hive.max-partitions-per-scan`\\nconfiguration property to `1000000` from `100000`. ({issue}`14225`)\", \"Utilize the `hive.metastore.thrift.delete-files-on-drop` configuration\\nproperty when dropping partitions and tables. Previously, it was only used\\nwhen dropping tables. ({issue}`13545`)\"], \"Hudi connector\": [\"Hide Hive system schemas. ({issue}`14510`)\"], \"Iceberg connector\": [\"Reduce query latency when querying tables with a large number of files. ({issue}`14504`)\", \"Prevent table corruption when changing a table fails due to an inability to\\nrelease the table lock from the Hive metastore. ({issue}`14386`)\", \"Fix query failure when reading from a table with a leading double slash in the\\nmetadata location. ({issue}`14299`)\"], \"Pinot connector\": [\"Add support for the Pinot proxy for controller/broker and server gRPC\\nrequests. ({issue}`13015`)\", \"Update minimum required version to 0.10.0. ({issue}`14090`)\"], \"SQL Server connector\": [\"Allow renaming column names containing special characters. ({issue}`14272`)\"], \"SPI\": [\"Add `ConnectorAccessControl.checkCanGrantExecuteFunctionPrivilege` overload\\nwhich must be implemented to allow views that use table functions. ({issue}`13944`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 273]\"}, {\"title\": \"Release 401 (26 Oct 2022)\", \"description\": null, \"content\": {\"General\": [\"Add support for using path-style access for all requests to S3 when using\\nfault-tolerant execution with exchange spooling. This can be enabled with the\\n`exchange.s3.path-style-access` configuration property. ({issue}`14655`)\", \"Add support for table functions in file-based access control. ({issue}`13713`)\", \"Add output buffer utilization distribution to `EXPLAIN ANALYZE VERBOSE`. ({issue}`14596`)\", \"Add operator blocked time distribution to `EXPLAIN ANALYZE VERBOSE`. ({issue}`14640`)\", \"Improve performance and reliability of `INSERT` and `MERGE`. ({issue}`14553`)\", \"Fix query failure caused by a\\n`com.google.common.base.VerifyException: cannot unset noMoreSplits` error. ({issue}`14668`)\", \"Fix underestimation of CPU usage and scheduled time statistics for joins in\\n`EXPLAIN ANALYZE`. ({issue}`14572`)\"], \"Cassandra connector\": [\"Upgrade minimum required Cassandra version to 3.0. ({issue}`14562`)\"], \"Delta Lake connector\": [\"Add support for writing to tables with [Delta Lake writer protocol version 4](https://docs.delta.io/latest/versioning.html#features-by-protocol-version).\\nThis does not yet include support for [change data feeds](https://docs.delta.io/2.0.0/delta-change-data-feed.html)\\nor generated columns. ({issue}`14573 `)\", \"Add support for writes on Google Cloud Storage. ({issue}`12264`)\", \"Avoid overwriting the reader and writer versions when executing a `COMMENT` or\\n`ALTER TABLE ... ADD COLUMN` statement. ({issue}`14611`)\", \"Fix failure when listing tables from the Glue metastore and one of the tables\\nhas no properties. ({issue}`14577`)\"], \"Hive connector\": [\"Add support for IBM Cloud Object Storage. ({issue}`14625`)\", \"Allow creating tables with an Avro schema literal using the new table property\\n`avro_schema_literal`. ({issue}`14426`)\", \"Fix potential query failure or incorrect results when reading from a table\\nwith the `avro.schema.literal` Hive table property set. ({issue}`14426`)\", \"Fix failure when listing tables from the Glue metastore and one of the tables\\nhas no properties. ({issue}`14577`)\"], \"Iceberg connector\": [\"Improve performance of the `remove_orphan_files` table procedure. ({issue}`13691`)\", \"Fix query failure when analyzing a table that contains a column with a\\nnon-lowercase name. ({issue}`14583`)\", \"Fix failure when listing tables from the Glue metastore and one of the tables\\nhas no properties. ({issue}`14577`)\"], \"Kafka connector\": [\"Add support for configuring the prefix for internal column names with the\\n`kafka.internal-column-prefix` catalog configuration property. The default\\nvalue is `_` to maintain current behavior. ({issue}`14224`)\"], \"MongoDB connector\": [\"Add `query` table function for query pass-through to the connector. ({issue}`14535`)\"], \"MySQL connector\": [\"Add support for writes when [fault-tolerant\\nexecution](/admin/fault-tolerant-execution) is enabled. ({issue}`14445`)\"], \"Pinot connector\": [\"Fix failure when executing `SHOW CREATE TABLE`. ({issue}`14071`)\"], \"PostgreSQL connector\": [\"Add support for writes when [fault-tolerant\\nexecution](/admin/fault-tolerant-execution) is enabled. ({issue}`14445`)\"], \"SQL Server connector\": [\"Add support for writes when [fault-tolerant\\nexecution](/admin/fault-tolerant-execution) is enabled. ({issue}`14730`)\"], \"SPI\": [\"Add stage output buffer distribution to `EventListener`. ({issue}`14638`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 274]\"}, {\"title\": \"Release 402 (2 Nov 2022)\", \"description\": null, \"content\": {\"General\": [\"Fix query processing when [fault-tolerant execution](/admin/fault-tolerant-execution)\\nis enabled and a [stage](trino-concept-stage) of the query produces no data. ({issue}`14794`)\"], \"Blackhole connector\": [\"Add support for column comments on view columns. ({issue}`10705`)\"], \"Clickhouse connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"Delta Lake connector\": [\"Remove the deprecated `hive.parquet.fail-on-corrupted-statistics` and\\n`parquet.fail-on-corrupted-statistics` configuration properties. The\\n`parquet.ignore-statistics` property can be used to allow querying Parquet\\nfiles with corrupted or incorrect statistics. ({issue}`14777`)\", \"Fix memory leak and improve memory tracking during large `INSERT` queries. ({issue}`14823`)\"], \"Druid connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"Hive connector\": [\"Add support for column comments on view columns. ({issue}`10705`)\", \"Remove the deprecated `hive.parquet.fail-on-corrupted-statistics` and\\n`parquet.fail-on-corrupted-statistics` configuration properties. The\\n`parquet.ignore-statistics` property can be used to allow querying Parquet\\nfiles with corrupted or incorrect statistics. ({issue}`14777`)\", \"Fix memory leak and improve memory tracking during large `INSERT` queries. ({issue}`14823`)\"], \"Hudi connector\": [\"Remove the deprecated `hive.parquet.fail-on-corrupted-statistics` and\\n`parquet.fail-on-corrupted-statistics` configuration properties. The\\n`parquet.ignore-statistics` property can be used to allow querying Parquet\\nfiles with corrupted or incorrect statistics. ({issue}`14777`)\"], \"Iceberg connector\": [\"Add support to skip archiving when committing to a table in the Glue\\nmetastore and the `iceberg.glue.skip-archive` configuration property is set\\nto true. ({issue}`13413`)\", \"Add support for column comments on view columns. ({issue}`10705`)\", \"Remove the deprecated `hive.parquet.fail-on-corrupted-statistics` and\\n`parquet.fail-on-corrupted-statistics` configuration properties. The\\n`parquet.ignore-statistics` property can be used to allow querying Parquet\\nfiles with corrupted or incorrect statistics. ({issue}`14777`)\", \"Fix incorrect results when the column order in the equality delete filter is\\ndifferent from the table definition. ({issue}`14693`)\", \"Fix memory leak and improve memory tracking during large `INSERT` queries. ({issue}`14823`)\"], \"MariaDB connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"Memory connector\": [\"Add support for column comments on view columns. ({issue}`10705`)\"], \"MySQL connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"MongoDB connector\": [\"Support predicate pushdown on `date`, `time(3)`, `timestamp(3)` and\\n`timestamp(3) with time zone` columns. ({issue}`14795`)\"], \"Oracle connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"Phoenix connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"PostgreSQL connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"Redshift connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"SingleStore (MemSQL) connector\": [\"Reuse JDBC connections for metadata queries. This can be disabled with the\\n`query.reuse-connection` configuration property. ({issue}`14653`)\"], \"SQL Server connector\": [\"Improve performance of certain queries which use the `OR` operator. ({issue}`14570`)\", \"Improve performance of queries with predicates involving the `nullif` function\\nor arithmetic expressions. ({issue}`14570`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 275]\"}, {\"title\": \"Release 403 (15 Nov 2022)\", \"description\": null, \"content\": {\"General\": [\"Include the amount of data read from external sources in the output of\\n`EXPLAIN ANALYZE`. ({issue}`14907`)\", \"Improve performance of worker-to-worker data transfer encryption when\\nfault-tolerant execution is enabled. ({issue}`14941`)\", \"Improve performance of aggregations when input data does not contain nulls. ({issue}`14567`)\", \"Fix potential failure when clients do not support variable precision temporal\\ntypes. ({issue}`14950`)\", \"Fix query deadlock in multi-join queries where broadcast join size is\\nunderestimated. ({issue}`14948`)\", \"Fix incorrect results when `min(x, n)` or `max(x, n)` is used as a window\\nfunction. ({issue}`14886`)\", \"Fix failure for certain queries involving joins over partitioned tables. ({issue}`14317`)\", \"Fix incorrect order of parameters in `DESCRIBE INPUT` when they appear in a\\n`WITH` clause. ({issue}`14738`)\", \"Fix failure for queries involving `BETWEEN` predicates over `varchar` columns\\nthat contain temporal data. ({issue}`14954`)\"], \"Security\": [\"Allow access token passthrough when using OAuth 2.0 authentication with\\nrefresh tokens enabled. ({issue}`14949`)\"], \"BigQuery connector\": [\"Improve performance of `SHOW SCHEMAS` by adding a metadata cache. This can be\\nconfigured with the `bigquery.metadata.cache-ttl` catalog property, which is\\ndisabled by default. ({issue}`14729`)\", \"Fix failure when a [row access policy](https://cloud.google.com/bigquery/docs/row-level-security-intro)\\nreturns an empty result. ({issue}`14760`)\"], \"ClickHouse connector\": [\"Add mapping for the ClickHouse `DateTime(timezone)` type to the Trino\\n`timestamp(0) with time zone` type for read-only operations. ({issue}`13541`)\"], \"Delta Lake connector\": [\"Fix statistics for `DATE` columns. ({issue}`15005`)\"], \"Hive connector\": [\"Avoid showing the unsupported `AUTHORIZATION ROLE` property in the result of\\n`SHOW CREATE SCHEMA` when the access control doesn't support roles. ({issue}`8817`)\"], \"Iceberg connector\": [\"Improve performance and storage requirements when running the\\n`expire_snapshots` table procedure on S3-compatible storage. ({issue}`14434`)\", \"Allow registering existing table files in the metastore with the new\\n[`register_table` procedure](iceberg-register-table). ({issue}`13552`)\"], \"MongoDB connector\": [\"Add support for {doc}`/sql/delete`. ({issue}`14864`)\", \"Fix incorrect results when predicates over `varchar` and `char` columns are\\npushed into the connector and MongoDB collections have a collation specified. ({issue}`14900`)\"], \"SQL Server connector\": [\"Fix incorrect results when non-transactional `INSERT` is disabled and bulk\\n`INSERT` is enabled. ({issue}`14856`)\"], \"SPI\": [\"Enhance `ConnectorTableLayout` to allow the connector to specify that multiple\\nwriters per partition are allowed. ({issue}`14956`)\", \"Remove deprecated methods from `ConnectorPageSinkProvider`. ({issue}`14959`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 276]\"}, {\"title\": \"Release 404\", \"description\": null, \"content\": {\"Release 404 (???)\": \"```\\nWhere's release 404? Not found. (We skipped it on purpose because we think we're\\nfunny.)\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 277]\"}, {\"title\": \"Release 405 (28 Dec 2022)\", \"description\": null, \"content\": {\"General\": [\"Add Trino version to the output of `EXPLAIN`. ({issue}`15317`)\", \"Add task input/output size distribution to the output of\\n`EXPLAIN ANALYZE VERBOSE`. ({issue}`15286`)\", \"Add stage skewness warnings to the output of `EXPLAIN ANALYZE`. ({issue}`15286`)\", \"Add support for `ALTER COLUMN ... SET DATA TYPE` statement. ({issue}`11608`)\", \"Allow configuring a refresh interval for the database resource group manager\\nwith the `resource-groups.refresh-interval` configuration property. ({issue}`14514`)\", \"Improve performance of queries that compare `date` columns with\\n`timestamp(n) with time zone` literals. ({issue}`5798`)\", \"Improve performance and resource utilization when inserting into tables. ({issue}`14718`, {issue}`14874`)\", \"Improve performance for `INSERT` queries when fault-tolerant execution is\\nenabled. ({issue}`14735`)\", \"Improve planning performance for queries with many `GROUP BY` clauses. ({issue}`15292`)\", \"Improve query performance for large clusters and skewed queries. ({issue}`15369`)\", \"Rename the `node-scheduler.max-pending-splits-per-task` configuration property\\nto `node-scheduler.min-pending-splits-per-task`. ({issue}`15168`)\", \"Ensure that the configured number of task retries is not larger than 126. ({issue}`14459`)\", \"Fix incorrect rounding of `time(n)` and `time(n) with time zone` values near\\nthe top of the range of allowed values. ({issue}`15138`)\", \"Fix incorrect results for queries involving window functions without a\\n`PARTITION BY` clause followed by the evaluation of window functions with a\\n`PARTITION BY` and `ORDER BY` clause. ({issue}`15203`)\", \"Fix incorrect results when adding or subtracting an `interval` from a\\n`timestamp with time zone`. ({issue}`15103`)\", \"Fix potential incorrect results when joining tables on indexed and non-indexed\\ncolumns at the same time. ({issue}`15334`)\", \"Fix potential failure of queries involving `MATCH_RECOGNIZE`. ({issue}`15343`)\", \"Fix incorrect reporting of `Projection CPU time` in the output of `EXPLAIN\\nANALYZE VERBOSE`. ({issue}`15364`)\", \"Fix `SET TIME ZONE LOCAL` to correctly reset to the initial time zone of the\\nclient session. ({issue}`15314`)\"], \"Security\": [\"Add support for string replacement as part of\\n[impersonation rules](system-file-auth-impersonation-rules). ({issue}`14962`)\", \"Add support for fetching access control rules via HTTPS. ({issue}`14008`)\", \"Fix some `system.metadata` tables improperly showing the names of catalogs\\nwhich the user cannot access. ({issue}`14000`)\", \"Fix `USE` statement improperly disclosing the names of catalogs and schemas\\nwhich the user cannot access. ({issue}`14208`)\", \"Fix improper HTTP redirect after OAuth 2.0 token refresh. ({issue}`15336`)\"], \"Web UI\": [\"Display operator CPU time in the \\\"Stage Performance\\\" tab. ({issue}`15339`)\"], \"JDBC driver\": [\"Return correct values in `NULLABLE` columns of the\\n`DatabaseMetaData.getColumns` result. ({issue}`15214`)\"], \"BigQuery connector\": [\"Improve read performance with experimental support for [Apache Arrow](https://arrow.apache.org/docs/)\\nserialization when reading from BigQuery. This can be enabled with the\\n`bigquery.experimental.arrow-serialization.enabled` catalog configuration\\nproperty. ({issue}`14972`)\", \"Fix queries incorrectly executing with the project ID specified in the\\ncredentials instead of the project ID specified in the `bigquery.project-id`\\ncatalog property. ({issue}`14083`)\"], \"Delta Lake connector\": [\"Add support for views. ({issue}`11609`)\", \"Add support for configuring batch size for reads on Parquet files using the\\n`parquet.max-read-block-row-count` configuration property or the\\n`parquet_max_read_block_row_count` session property. ({issue}`15474`)\", \"Improve performance and reduce storage requirements when running the `vacuum`\\nprocedure on S3-compatible storage. ({issue}`15072`)\", \"Improve memory accounting for `INSERT`, `MERGE`, and\\n`CREATE TABLE ... AS SELECT` queries. ({issue}`14407`)\", \"Improve performance of reading Parquet files for `boolean`, `tinyint`,\\n`short`, `int`, `long`, `float`, `double`, `short decimal`, `UUID`, `time`,\\n`decimal`, `varchar`, and `char` data types. This optimization can be disabled\\nwith the `parquet.optimized-reader.enabled` catalog configuration property. ({issue}`14423`, {issue}`14667`)\", \"Improve query performance when the `nulls fraction` statistic is not available\\nfor some columns. ({issue}`15132`)\", \"Improve performance when reading Parquet files. ({issue}`15257`, {issue}`15474`)\", \"Improve performance of reading Parquet files for queries with filters. ({issue}`15268`)\", \"Improve `DROP TABLE` performance for tables stored on AWS S3. ({issue}`13974`)\", \"Improve performance of reading Parquet files for `timestamp` and\\n`timestamp with timezone` data types. ({issue}`15204`)\", \"Improve performance of queries that read a small number of columns and queries\\nthat process tables with large Parquet row groups or ORC stripes. ({issue}`15168`)\", \"Improve stability and reduce peak memory requirements when reading from\\nParquet files. ({issue}`15374`)\", \"Allow registering existing table files in the metastore with the new\\n[`register_table` procedure](delta-lake-register-table). ({issue}`13568`)\", \"Deprecate creating a new table with existing table content. This can be\\nre-enabled using the `delta.legacy-create-table-with-existing-location.enabled`\\nconfiguration property or the\\n`legacy_create_table_with_existing_location_enabled` session property. ({issue}`13568`)\", \"Fix query failure when reading Parquet files with large row groups. ({issue}`5729`)\", \"Fix `DROP TABLE` leaving files behind when using managed tables stored on S3\\nand created by the Databricks runtime. ({issue}`13017`)\", \"Fix query failure when the path contains special characters. ({issue}`15183`)\", \"Fix potential `INSERT` failure for tables stored on S3. ({issue}`15476`)\"], \"Google Sheets connector\": [\"Add support for setting a read timeout with the `gsheets.read-timeout`\\nconfiguration property. ({issue}`15322`)\", \"Add support for `base64`-encoded credentials using the\\n`gsheets.credentials-key` configuration property. ({issue}`15477`)\", \"Rename the `credentials-path` configuration property to\\n`gsheets.credentials-path`, `metadata-sheet-id` to\\n`gsheets.metadata-sheet-id`, `sheets-data-max-cache-size` to\\n`gsheets.max-data-cache-size`, and `sheets-data-expire-after-write` to\\n`gsheets.data-cache-ttl`. ({issue}`15042`)\"], \"Hive connector\": [\"Add support for referencing nested fields in columns with the `UNIONTYPE` Hive\\ntype. ({issue}`15278`)\", \"Add support for configuring batch size for reads on Parquet files using the\\n`parquet.max-read-block-row-count` configuration property or the\\n`parquet_max_read_block_row_count` session property. ({issue}`15474`)\", \"Improve memory accounting for `INSERT`, `MERGE`, and `CREATE TABLE AS SELECT`\\nqueries. ({issue}`14407`)\", \"Improve performance of reading Parquet files for `boolean`, `tinyint`,\\n`short`, `int`, `long`, `float`, `double`, `short decimal`, `UUID`, `time`,\\n`decimal`, `varchar`, and `char` data types. This optimization can be disabled\\nwith the `parquet.optimized-reader.enabled` catalog configuration property. ({issue}`14423`, {issue}`14667`)\", \"Improve performance for queries which write data into multiple partitions. ({issue}`15241`, {issue}`15066`)\", \"Improve performance when reading Parquet files. ({issue}`15257`, {issue}`15474`)\", \"Improve performance of reading Parquet files for queries with filters. ({issue}`15268`)\", \"Improve `DROP TABLE` performance for tables stored on AWS S3. ({issue}`13974`)\", \"Improve performance of reading Parquet files for `timestamp` and\\n`timestamp with timezone` data types. ({issue}`15204`)\", \"Improve performance of queries that read a small number of columns and queries\\nthat process tables with large Parquet row groups or ORC stripes. ({issue}`15168`)\", \"Improve stability and reduce peak memory requirements when reading from\\nParquet files. ({issue}`15374`)\", \"Disallow creating transactional tables when not using the Hive metastore. ({issue}`14673`)\", \"Fix query failure when reading Parquet files with large row groups. ({issue}`5729`)\", \"Fix incorrect `schema already exists` error caused by a client timeout when\\ncreating a new schema. ({issue}`15174`)\", \"Fix failure when an access denied exception happens while listing tables or\\nviews in a Glue metastore. ({issue}`14746`)\", \"Fix `INSERT` failure on ORC ACID tables when Apache Hive 3.1.2 is used as a\\nmetastore. ({issue}`7310`)\", \"Fix failure when reading Hive views with `char` types. ({issue}`15470`)\", \"Fix potential `INSERT` failure for tables stored on S3. ({issue}`15476`)\"], \"Hudi connector\": [\"Improve performance of reading Parquet files for `boolean`, `tinyint`,\\n`short`, `int`, `long`, `float`, `double`, `short decimal`, `UUID`, `time`,\\n`decimal`, `varchar`, and `char` data types. This optimization can be disabled\\nwith the `parquet.optimized-reader.enabled` catalog configuration property. ({issue}`14423`, {issue}`14667`)\", \"Improve performance of reading Parquet files for queries with filters. ({issue}`15268`)\", \"Improve performance of reading Parquet files for `timestamp` and\\n`timestamp with timezone` data types. ({issue}`15204`)\", \"Improve performance of queries that read a small number of columns and queries\\nthat process tables with large Parquet row groups or ORC stripes. ({issue}`15168`)\", \"Improve stability and reduce peak memory requirements when reading from\\nParquet files. ({issue}`15374`)\", \"Fix query failure when reading Parquet files with large row groups. ({issue}`5729`)\"], \"Iceberg connector\": [\"Add support for configuring batch size for reads on Parquet files using the\\n`parquet.max-read-block-row-count` configuration property or the\\n`parquet_max_read_block_row_count` session property. ({issue}`15474`)\", \"Add support for the Iceberg REST catalog. ({issue}`13294`)\", \"Improve memory accounting for `INSERT`, `MERGE`, and `CREATE TABLE AS SELECT`\\nqueries. ({issue}`14407`)\", \"Improve performance of reading Parquet files for `boolean`, `tinyint`,\\n`short`, `int`, `long`, `float`, `double`, `short decimal`, `UUID`, `time`,\\n`decimal`, `varchar`, and `char` data types. This optimization can be disabled\\nwith the `parquet.optimized-reader.enabled` catalog configuration property. ({issue}`14423`, {issue}`14667`)\", \"Improve performance when reading Parquet files. ({issue}`15257`, {issue}`15474`)\", \"Improve performance of reading Parquet files for queries with filters. ({issue}`15268`)\", \"Improve `DROP TABLE` performance for tables stored on AWS S3. ({issue}`13974`)\", \"Improve performance of reading Parquet files for `timestamp` and\\n`timestamp with timezone` data types. ({issue}`15204`)\", \"Improve performance of queries that read a small number of columns and queries\\nthat process tables with large Parquet row groups or ORC stripes. ({issue}`15168`)\", \"Improve stability and reduce peak memory requirements when reading from\\nParquet files. ({issue}`15374`)\", \"Fix incorrect results when predicates over `row` columns on Parquet files are\\npushed into the connector. ({issue}`15408`)\", \"Fix query failure when reading Parquet files with large row groups. ({issue}`5729`)\", \"Fix `REFRESH MATERIALIZED VIEW` failure when the materialized view is based on\\nnon-Iceberg tables. ({issue}`13131`)\", \"Fix failure when an access denied exception happens while listing tables or\\nviews in a Glue metastore. ({issue}`14971`)\", \"Fix potential `INSERT` failure for tables stored on S3. ({issue}`15476`)\"], \"Kafka connector\": [\"Add support for [Protobuf encoding](kafka-protobuf-encoding). ({issue}`14734`)\"], \"MongoDB connector\": [\"Add support for [fault-tolerant execution](/admin/fault-tolerant-execution). ({issue}`15062`)\", \"Add support for setting a file path and password for the truststore and\\nkeystore. ({issue}`15240`)\", \"Add support for case-insensitive name-matching in the `query` table function. ({issue}`15329`)\", \"Rename the `mongodb.ssl.enabled` configuration property to\\n`mongodb.tls.enabled`. ({issue}`15240`)\", \"Upgrade minimum required MongoDB version to\\n[4.2](https://www.mongodb.com/docs/manual/release-notes/4.2/). ({issue}`15062`)\", \"Delete a MongoDB field from collections when dropping a column.\\nPreviously, the connector deleted only metadata. ({issue}`15226`)\", \"Remove deprecated `mongodb.seeds` and `mongodb.credentials` configuration\\nproperties. ({issue}`15263`)\", \"Fix failure when an unauthorized exception happens while listing schemas or\\ntables. ({issue}`1398`)\", \"Fix `NullPointerException` when a column name contains uppercase characters in\\nthe `query` table function. ({issue}`15294`)\", \"Fix potential incorrect results when the `objectid` function is used more than\\nonce within a single query. ({issue}`15426`)\"], \"MySQL connector\": [\"Fix failure when the `query` table function contains a `WITH` clause. ({issue}`15332`)\"], \"PostgreSQL connector\": [\"Fix query failure when a `FULL JOIN` is pushed down. ({issue}`14841`)\"], \"Redshift connector\": [\"Add support for aggregation, join, and `ORDER BY ... LIMIT` pushdown. ({issue}`15365`)\", \"Add support for `DELETE`. ({issue}`15365`)\", \"Add schema, table, and column name length checks. ({issue}`15365`)\", \"Add full type mapping for Redshift types. The previous behavior can be\\nrestored via the `redshift.use-legacy-type-mapping` configuration property. ({issue}`15365`)\"], \"SPI\": [\"Remove deprecated `ConnectorNodePartitioningProvider.getBucketNodeMap()`\\nmethod. ({issue}`14067`)\", \"Use the `MERGE` APIs in the engine to execute `DELETE` and `UPDATE`.\\nRequire connectors to implement `beginMerge()` and related APIs.\\nDeprecate `beginDelete()`, `beginUpdate()` and `UpdatablePageSource`, which\\nare unused and do not need to be implemented. ({issue}`13926`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 278]\"}, {\"title\": \"Release 406 (25 Jan 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for [exchange spooling on HDFS](fte-exchange-hdfs) when\\nfault-tolerant execution is enabled. ({issue}`15160`)\", \"Add support for `CHECK` constraints in an `INSERT` statement. ({issue}`14964`)\", \"Improve planner estimates for queries containing outer joins over a subquery\\ninvolving `ORDER BY` and `LIMIT`. ({issue}`15428`)\", \"Improve accuracy of memory usage reporting for table scans. ({issue}`15711`)\", \"Improve performance of queries parsing date values in ISO 8601 format. ({issue}`15548`)\", \"Improve performance of queries with selective joins. ({issue}`15569`)\", \"Remove `legacy-phased` execution scheduler as an option for the\\n`query.execution-policy` configuration property. ({issue}`15657`)\", \"Fix failure when `WHERE` or `JOIN` clauses contain a `LIKE` expression with a\\nnon-constant pattern or escape. ({issue}`15629`)\", \"Fix inaccurate planner estimates for queries with filters on columns without\\nstatistics. ({issue}`15642`)\", \"Fix queries with outer joins failing when fault-tolerant execution is\\nenabled. ({issue}`15608`)\", \"Fix potential query failure when using `MATCH_RECOGNIZE`. ({issue}`15461`)\", \"Fix query failure when using group-based access control with column masks or\\nrow filters. ({issue}`15583`)\", \"Fix potential hang during shutdown. ({issue}`15675`)\", \"Fix incorrect results when referencing a field resulting from the application\\nof a column mask expression that produces a `row` type. ({issue}`15659`)\", \"Fix incorrect application of column masks when a mask expression references a\\ndifferent column in the underlying table. ({issue}`15680`)\"], \"BigQuery connector\": [\"Add support for [fault-tolerant execution](/admin/fault-tolerant-execution). ({issue}`15620`)\", \"Fix possible incorrect results for certain queries like `count(*)` when a\\ntable has recently been written to. ({issue}`14981`)\"], \"Cassandra connector\": [\"Fix incorrect results when the Cassandra `list`, `map`, or `set` types contain\\nuser-defined types. ({issue}`15771`)\"], \"Delta Lake connector\": [\"Reduce latency for `INSERT` queries on unpartitioned tables. ({issue}`15708`)\", \"Improve performance of reading Parquet files. ({issue}`15498`)\", \"Improve memory accounting of the Parquet reader. ({issue}`15554`)\", \"Improve performance of queries with filters or projections on low-cardinality\\nstring columns stored in Parquet files. ({issue}`15269`)\", \"Fix reading more data than necessary from Parquet files for queries with\\nfilters. ({issue}`15552`)\", \"Fix potential query failure when writing to Parquet from a table with an\\n`INTEGER` range on a `BIGINT` column. ({issue}`15496`)\", \"Fix query failure due to missing null counts in Parquet column indexes. ({issue}`15706`)\"], \"Hive connector\": [\"Add support for table redirections to catalogs using the Hudi connector. ({issue}`14750`)\", \"Reduce latency for `INSERT` queries on unpartitioned tables. ({issue}`15708`)\", \"Improve performance of caching. ({issue}`13243 `)\", \"Improve performance of reading Parquet files. ({issue}`15498`)\", \"Improve memory accounting of the Parquet reader. ({issue}`15554`)\", \"Improve performance of queries with filters or projections on low-cardinality\\nstring columns stored in Parquet files. ({issue}`15269`)\", \"Improve performance of queries with filters when Bloom filter indexes are\\npresent in Parquet files. Use of Bloom filters from Parquet files can be\\ndisabled with the `parquet.use-bloom-filter` configuration property or the\\n`parquet_use_bloom_filter` session property. ({issue}`14428`)\", \"Allow coercion between Hive `UNIONTYPE` and Hive `STRUCT`-typed columns. ({issue}`15017`)\", \"Fix reading more data than necessary from Parquet files for queries with\\nfilters. ({issue}`15552`)\", \"Fix query failure due to missing null counts in Parquet column indexes. ({issue}`15706`)\", \"Fix incorrect `schema already exists` error caused by a client timeout when\\ncreating a new schema. ({issue}`15174`)\"], \"Hudi connector\": [\"Improve performance of reading Parquet files. ({issue}`15498`)\", \"Improve memory accounting of the Parquet reader. ({issue}`15554`)\", \"Improve performance of queries with filters or projections on low-cardinality\\nstring columns stored in Parquet files. ({issue}`15269`)\", \"Fix reading more data than necessary from Parquet files for queries with\\nfilters. ({issue}`15552`)\", \"Fix query failure due to missing null counts in Parquet column indexes. ({issue}`15706`)\"], \"Iceberg connector\": [\"Add support for changing column types. ({issue}`15515`)\", \"Add [support for the JDBC catalog](iceberg-jdbc-catalog). ({issue}`9968`)\", \"Reduce latency for `INSERT` queries on unpartitioned tables. ({issue}`15708`)\", \"Improve performance of reading Parquet files. ({issue}`15498`)\", \"Improve memory accounting of the Parquet reader. ({issue}`15554`)\", \"Improve performance of queries with filters or projections on low-cardinality\\nstring columns stored in Parquet files. ({issue}`15269`)\", \"Fix reading more data than necessary from Parquet files for queries with\\nfilters. ({issue}`15552`)\", \"Fix query failure due to missing null counts in Parquet column indexes. ({issue}`15706`)\", \"Fix query failure when a subquery contains [time travel](iceberg-time-travel). ({issue}`15607`)\", \"Fix failure when reading columns that had their type changed from `float` to\\n`double` by other query engines. ({issue}`15650`)\", \"Fix incorrect results when reading or writing `NaN` with `real` or `double`\\ntypes on partitioned columns. ({issue}`15723`)\"], \"MongoDB connector\": [\"Fix schemas not being dropped when trying to drop schemas with the\\n`mongodb.case-insensitive-name-matching` configuration property enabled. ({issue}`15716`)\"], \"PostgreSQL connector\": [\"Add support for changing column types. ({issue}`15515`)\"], \"SPI\": [\"Remove the `getDeleteRowIdColumnHandle()`, `beginDelete()`, `finishDelete()`,\\n`getUpdateRowIdColumnHandle()`, `beginUpdate()`, and `finishUpdate()` methods\\nfrom `ConnectorMetadata`. ({issue}`15161`)\", \"Remove the `UpdatablePageSource` interface. ({issue}`15161`)\", \"Remove support for multiple masks on a single column. ({issue}`15680`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 279]\"}, {\"title\": \"Release 407 (16 Feb 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for correlated queries involving a `VALUES` clause with a single\\nrow. ({issue}`15989`)\", \"Reduce memory usage for large schemas. This behavior can be enabled with the\\n`query.remote-task.enable-adaptive-request-size` configuration property and\\nconfigured with the `query.remote-task.max-request-size`,\\n`query.remote-task.request-size-headroom`, and\\n`query.remote-task.guaranteed-splits-per-task` configuration properties or\\ntheir respective session properties. ({issue}`15721`)\", \"Improve concurrency when small, concurrent queries are run on a large cluster\\nby automatically determining how many nodes to use for distributed joins\\nand aggregations. This can be managed with the `query.max-hash-partition-count`\\n(renamed from `query.hash-partition-count`) and `query.min-hash-partition-count`\\nconfiguration properties. ({issue}`15489`)\", \"Improve query memory tracking. ({issue}`15983`)\", \"Improve memory usage accounting for queries with dynamic filters. ({issue}`16110`)\", \"Improve query performance when a predicate evaluates to a null value. ({issue}`15744`)\", \"Improve performance of queries with joins on the output of global\\naggregations. ({issue}`15858`)\", \"Improve performance of selective queries, queries that read a small number of\\ncolumns, and queries that process tables with large Parquet row groups or ORC\\nstripes. ({issue}`15579`)\", \"Improve performance of queries with window functions. ({issue}`15994`)\", \"Return an exit code of `100` when Trino crashes during startup. ({issue}`16113`)\", \"Fix precision loss when converting `time` values with a precision higher than\\nthree and `time with time zone` values with lower precision. ({issue}`15861`)\", \"Fix potential incorrect results due to a query reporting normal completion\\ninstead of failing. ({issue}`15917`)\", \"Fix connection errors caused by a reusable connection being closed. ({issue}`16121`)\", \"Fix incorrect results for queries involving an equality predicate in a `WHERE`\\nclause that is equal to a term of a `SELECT` clause in one of the branches of\\na `JOIN`. ({issue}`16101`)\"], \"Cassandra connector\": [\"Add `query` table function for full query pass-through to the connector. ({issue}`15973`)\"], \"Delta Lake connector\": [\"Add support for the `unregister_table` procedure. ({issue}`15784`)\", \"Add support for inserting into tables that have `CHECK` constraints. ({issue}`15396`)\", \"Add support for writing to the [change data feed](https://docs.delta.io/2.0.0/delta-change-data-feed.html).\\nThis can be enabled with the `delta.enableChangeDataFeed` table property. ({issue}`15453`)\", \"Add a `$history` system table which can be queried to inspect Delta Lake table\\nhistory. ({issue}`15683`)\", \"Improve performance of reading decimal types from Parquet files. ({issue}`15713`)\", \"Improve performance of reading numeric types from Parquet files. ({issue}`15850`)\", \"Improve performance of reading string types from Parquet files. ({issue}`15897`, {issue}`15923`)\", \"Improve performance of reading timestamp and boolean types from Parquet files. ({issue}`15954`)\", \"Improve query performance on tables created by Trino with `CREATE TABLE AS`. ({issue}`15878`)\", \"Remove support for the legacy Parquet writer. ({issue}`15436`)\", \"Fix query failure when reading Parquet files written by Apache Impala. ({issue}`15942`)\", \"Fix listing relations failure when a Glue table has no table type set. ({issue}`15909`)\"], \"Hive connector\": [\"Reduce query latency. ({issue}`15811`)\", \"Improve performance of reading decimal types from Parquet files. ({issue}`15713`)\", \"Improve performance of reading numeric types from Parquet files. ({issue}`15850`)\", \"Improve performance of reading string types from Parquet files. ({issue}`15897`, {issue}`15923`)\", \"Improve performance of reading timestamp and boolean types from Parquet files. ({issue}`15954`)\", \"Improve performance of predicate pushdown to partitioned columns in tables\\nwith a high number of partitions. ({issue}`16113`)\", \"Reduce server errors in high-load scenarios. This can be enabled with the\\n`hive.s3.connect-ttl` configuration property. ({issue}`16005`)\", \"Allow setting the `hive.max-partitions-per-scan` configuration property to a\\nvalue lower than the value set in `hive.max-partitions-for-eager-load`. ({issue}`16111`)\", \"Fix query failure when reading Parquet files written by Apache Impala. ({issue}`15942`)\", \"Fix listing relations failure when a Glue table has no table type set. ({issue}`15909`)\"], \"Hudi connector\": [\"Improve performance of reading decimal types from Parquet files. ({issue}`15713`)\", \"Improve performance of reading numeric types from Parquet files. ({issue}`15850`)\", \"Improve performance of reading string types from Parquet files. ({issue}`15897`, {issue}`15923`)\", \"Improve performance of reading timestamp and boolean types from Parquet files. ({issue}`15954`)\", \"Fix query failure when reading Parquet files written by Apache Impala. ({issue}`15942`)\"], \"Iceberg connector\": [\"Add support for the `unregister_table` procedure. ({issue}`15784`)\", \"Add support for `register_table` procedures in the JDBC catalog. ({issue}`15853`)\", \"Add support for specifying a user and password when connecting to the JDBC\\ncatalog via the `iceberg.jdbc-catalog.connection-user` and\\n`iceberg.jdbc-catalog.connection-password` configuration properties. ({issue}`16040`)\", \"Add support for compacting manifests asynchronously, which can be enabled by\\nsetting the `iceberg.merge_manifests_on_write` session property to `false`. ({issue}`14822`)\", \"Improve performance of `DROP TABLE`. ({issue}`15981`)\", \"Improve performance of reading [position delete files](https://iceberg.apache.org/spec/#position-delete-files)\\nwith ORC data ({issue}`15969`).\", \"Improve performance of reading decimal columns from Parquet files. ({issue}`15713`)\", \"Improve performance of reading numeric types from Parquet files. ({issue}`15850`)\", \"Improve performance of reading string types from Parquet files. ({issue}`15897`, {issue}`15923`)\", \"Improve performance of reading timestamp and boolean types from Parquet files. ({issue}`15954`)\", \"Prevent creating a table when the specified schema does not exist. ({issue}`15779`)\", \"Fix query failure when reading Parquet files written by Apache Impala. ({issue}`15942`)\", \"Fix listing relations failure when a Glue table has no table type set. ({issue}`15909`)\", \"Fix failure when encountering access denied exceptions while listing\\nmaterialized views in the Glue metastore. ({issue}`15893`)\"], \"Kudu connector\": [\"Fix authentication failure when Kerberos tickets expire. ({issue}`14372`)\"], \"Memory connector\": [\"Fix potential failure when reading table column metadata with concurrent\\n`CREATE TABLE` or `DROP TABLE` operations. ({issue}`16062`)\"], \"MongoDB connector\": [\"Add support for changing column types. ({issue}`15515`)\"], \"MySQL connector\": [\"Fix potential failure when `zeroDateTimeBehavior` is set to `convertToNull`. ({issue}`16027`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 280]\"}, {\"title\": \"Release 408 (23 Feb 2023)\", \"description\": null, \"content\": {\"General\": [\"Add physical input read time to query statistics and the output of `EXPLAIN\\nANALYZE`. ({issue}`16190`)\", \"Fix query failure for queries involving joins or aggregations with a\\n[structural type](structural-data-types) that contains `NULL` elements. ({issue}`16140`)\"], \"Security\": [\"Deprecate using groups with OAuth 2.0 authentication, and rename the\\n`http-server.authentication.oauth2.groups-field` configuration property to\\n`deprecated.http-server.authentication.oauth2.groups-field`. ({issue}`15669`)\"], \"CLI\": [\"Add `AUTO` output format which switches from `ALIGNED` to `VERTICAL` if\\nthe output doesn't fit the current terminal. ({issue}`12208`)\", \"Add `--pager` and `--history-file` options to match the existing `TRINO_PAGER`\\nand `TRINO_HISTORY_FILE` environmental variables. Also allow setting these\\noptions in a configuration file. ({issue}`16151`)\"], \"BigQuery connector\": [\"Add support for writing `decimal` types to BigQuery. ({issue}`16145`)\"], \"Delta Lake connector\": [\"Rename the connector to `delta_lake`. The old name `delta-lake` is now\\ndeprecated and will be removed in a future release. ({issue}`13931`)\", \"Add support for creating tables with the Trino `change_data_feed_enabled`\\ntable property. ({issue}`16129`)\", \"Improve query performance on tables that Trino has written to with `INSERT`. ({issue}`16026`)\", \"Improve performance of reading [structural types](structural-data-types) from\\nParquet files. This optimization can be disabled with the\\n`parquet_optimized_nested_reader_enabled` catalog session property or the\\n`parquet.optimized-nested-reader.enabled` catalog configuration property. ({issue}`16177`)\", \"Retry dropping Delta tables registered in the Glue catalog to avoid failures\\ndue to concurrent modifications. ({issue}`13199`)\", \"Allow updating the `reader_version` and `writer_version` table properties. ({issue}`15932`)\", \"Fix inaccurate change data feed entries for `MERGE` queries. ({issue}`16127`)\", \"Fix performance regression when writing to partitioned tables if table\\nstatistics are absent. ({issue}`16152`)\"], \"Hive connector\": [\"Remove support for the deprecated `hive-hadoop2` connector name, requiring the\\n`connector.name` property to be set to `hive`. ({issue}`16166`)\", \"Retry dropping Delta tables registered in the Glue catalog to avoid failures\\ndue to concurrent modifications. ({issue}`13199`)\", \"Fix performance regression when writing to partitioned tables if table\\nstatistics are absent. ({issue}`16152`)\"], \"Iceberg connector\": [\"Reduce memory usage when reading `$files` system tables. ({issue}`15991`)\", \"Require the `iceberg.jdbc-catalog.driver-class` configuration property to be\\nset to prevent a \\\"driver not found\\\" error after initialization. ({issue}`16196`)\", \"Fix performance regression when writing to partitioned tables if table\\nstatistics are absent. ({issue}`16152`)\"], \"Ignite connector\": [\"Add [Ignite connector](/connector/ignite). ({issue}`8098`)\"], \"SingleStore connector\": [\"Remove support for the deprecated `memsql` connector name, requiring the\\n`connector.name` property to be set to `singlestore`. ({issue}`16180`)\"], \"SQL Server connector\": [\"Add support for pushing down `=`, `<>` and `IN` predicates over text columns\\nif the column uses a case-sensitive collation within SQL Server. ({issue}`15714`)\"], \"Thrift connector\": [\"Rename the connector to `trino_thrift`. The old name `trino-thrift` is now\\ndeprecated and will be removed in a future release. ({issue}`13931`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 281]\"}, {\"title\": \"Release 409 (3 Mar 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for dropping nested fields with a `DROP COLUMN` statement. ({issue}`15975`)\", \"Add queue, analysis, planning, and execution time to the output of\\n`EXPLAIN ANALYZE`. ({issue}`16329`)\", \"Add support for executing table functions with any number of table arguments. ({issue}`1839`)\", \"Improve output of `EXPLAIN` queries to show statistics when a query contains\\naggregations. ({issue}`16201`)\", \"Improve performance of queries with aggregations containing a `DISTINCT`\\nclause using table statistics. This can be configured with the\\n`optimizer.mark-distinct-strategy`configuration property, and the\\n`optimizer.use-mark-distinct` configuration property is now deprecated in\\nfavor of it. ({issue}`15927`)\", \"Improve performance of LIKE expressions with patterns constructed dynamically. ({issue}`15999`)\", \"Remove the `distributed-index-joins-enabled` configuration property and\\nrelated functionality. ({issue}`15375`)\", \"Fix failure when using non-comparable and non-sortable values as part of a\\n`VALUES` expression. ({issue}`16242`)\"], \"BigQuery connector\": [\"Add support for using default values when inserting data. ({issue}`16327`)\", \"Fix failure when non-lowercase column names exist in the `query` table\\nfunction. ({issue}`16075`)\"], \"Cassandra connector\": [\"Add support for `TIME` type. ({issue}`13063`)\"], \"ClickHouse connector\": [\"Remove support for the `ru.yandex.clickhouse.ClickHouseDriver` legacy JDBC\\ndriver in the `clickhouse.legacy-driver` configuration property. ({issue}`16188`)\", \"Remove support for specifying expressions in the `sample_by` table property to\\nprevent SQL injection. ({issue}`16261`)\"], \"Delta Lake connector\": [\"Avoid query failure by inferring required Delta Lake version when creating new\\ntables or configuring table features. ({issue}`16310`)\", \"Fix query failure when reading Parquet files generated by Kafka Connect. ({issue}`16264`)\"], \"Hive connector\": [\"Add support for the Hadoop `DefaultCodec` to Hive formats. ({issue}`16250`)\", \"Add a native CSV file format reader and writer. These can be disabled with the\\n`csv_native_reader_enabled` and `csv_native_writer_enabled` session properties\\nor the `csv.native-reader.enabled` and `csv.native-writer.enabled`\\nconfiguration properties. ({issue}`15918`)\", \"Add a native JSON file format reader and writer. These can be disabled with\\nthe `json_native_reader_enabled` and `json_native_writer_enabled` session\\nproperties or the `json.native-reader.enabled` and\\n`json.native-writer.enabled` configuration properties. ({issue}`15918`)\", \"Add a native text file format reader and writer. These can be disabled with\\nthe `text_file_native_reader_enabled` and `text_file_native_writer_enabled`\\nsession properties or the `text-file.native-reader.enabled` and\\n`text-file.native-writer.enabled` configuration properties. ({issue}`15918`)\", \"Add a native sequence file format reader and writer. These can be disabled\\nwith the `sequence_file_native_reader_enabled` and\\n`sequence_file_native_writer_enabled` session properties or the\\n`sequence-file.native-reader.enabled` and\\n`sequence-file.native-writer.enabled` configuration properties. ({issue}`15918`)\", \"Add a native regex file format reader. The reader can be disabled with the\\n`regex_native_reader_enabled` session property or the\\n`regex.native-reader.enabled` configuration property. ({issue}`15918`)\", \"Add `regex` and `regex_case_insensitive` table properties for the `REGEX`\\nformat. ({issue}`16271`)\", \"Improve performance of queries which read from partitioned Hive tables and\\nwrite to partitioned tables when statistics are not available for the source\\ntables. ({issue}`16229`)\", \"Improve query performance when only table statistics generated by Apache Spark\\nare available. This can be disabled via the\\n`hive.metastore.thrift.use-spark-table-statistics-fallback` configuration\\nproperty. ({issue}`16120`)\", \"Fix incorrectly ignoring computed table statistics in `ANALYZE`. ({issue}`15995`)\", \"Fix query failure when reading Parquet files generated by Kafka Connect. ({issue}`16264`)\"], \"Hudi connector\": [\"Fix query failure when reading Parquet files generated by Kafka Connect. ({issue}`16264`)\"], \"Iceberg connector\": [\"Add support for dropping nested fields with a `DROP COLUMN` statement. ({issue}`15975`)\", \"Add support for Iceberg table sort orders. Tables can have a list of\\n`sorted_by` columns which are used to order files written to the table. ({issue}`14891`)\", \"Fix query failure when reading nested columns on a table with\\n[equality delete files](https://iceberg.apache.org/spec/#equality-delete-files). ({issue}`14836`)\", \"Fix query failure when reading Parquet files generated by Kafka Connect. ({issue}`16264`)\"], \"SQL Server connector\": [\"Add support for pushing down joins using `=` and `!=` predicates over text\\ncolumns if the column uses a case-sensitive collation within SQL Server. ({issue}`16185`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 282]\"}, {\"title\": \"Release 410 (8 Mar 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of certain queries with unions. ({issue}`16019`)\", \"Fix potential query failure when using an `ORDER BY` clause while spilling to\\ndisk is enabled. ({issue}`16406`)\", \"Fix potential query failure when performing a `JOIN` with a comparison between\\ntwo different types. ({issue}`16444`)\"], \"Delta Lake connector\": [\"Fix query failure when reading Parquet files generated by Airbyte. ({issue}`16362`)\"], \"Google Sheets connector\": [\"Add support for the [`sheet` table function](google-sheets-sheet-function). ({issue}`12502`)\"], \"Hive connector\": [\"Add support for AWS Security Token Support with S3 Select. ({issue}`5947`)\", \"Fix incorrectly ignoring the `hive.timestamp-precision` configuration property\\nin Hive views. ({issue}`6295`)\", \"Fix query failure when reading Parquet files generated by Airbyte. ({issue}`16362`)\", \"Fix incorrect results when using a value with uppercase characters for the\\n`partition_projection_location_template` table property. ({issue}`16349`)\"], \"Hudi connector\": [\"Fix query failure when reading Parquet files generated by Airbyte. ({issue}`16362`)\"], \"Iceberg connector\": [\"Improve file pruning when generating Iceberg table statistics. ({issue}`16244`)\", \"Fix query failure when reading Parquet files generated by Airbyte. ({issue}`16362`)\"], \"Ignite connector\": [\"Add support for [aggregation pushdown](aggregation-pushdown) of the\\n`count(distinct)` function. ({issue}`16342`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 283]\"}, {\"title\": \"Release 411 (29 Mar 2023)\", \"description\": null, \"content\": {\"General\": [\"Add spilled data size to query statistics. ({issue}`16442`)\", \"Add {func}`sinh` function. ({issue}`16494`)\", \"Add {func}`quantile_at_value` function. ({issue}`16736`)\", \"Add support for a `GRACE PERIOD` clause in the `CREATE MATERIALIZED VIEW`\\ntask. For backwards compatibility, the existing materialized views are\\ninterpreted as having a `GRACE PERIOD` of zero, however, new materialized\\nviews have an unlimited grace period by default. This is a backwards\\nincompatible change, and the previous behavior can be restored with the\\n`legacy.materialized-view-grace-period` configuration property or the\\n`legacy_materialized_view_grace_period` session property. ({issue}`15842`)\", \"Fix potential incorrect query stats when tasks are waiting on running drivers\\nto fully terminate. ({issue}`15478`)\", \"Add support for specifying the number of nodes that will write data during\\n`INSERT`, `CREATE TABLE ... AS SELECT`, or `EXECUTE` queries with the\\n`query.max-writer-tasks-count` configuration property. ({issue}`16238`)\", \"Improve performance of queries that contain predicates involving the `year`\\nfunction. ({issue}`14078`)\", \"Improve performance of queries that contain a `sum` aggregation. ({issue}`16624`)\", \"Improve performance of `filter` function on arrays. ({issue}`16681`)\", \"Reduce coordinator memory usage. ({issue}`16668`, {issue}`16669`)\", \"Reduce redundant data exchanges for queries with multiple aggregations. ({issue}`16328`)\", \"Fix incorrect query results when using `keyvalue()` methods in the\\n[JSON path](json-path-language). ({issue}`16482`)\", \"Fix potential incorrect results in queries involving joins and a\\nnon-deterministic value. ({issue}`16512`)\", \"Fix potential query failure when exchange compression is enabled. ({issue}`16541`)\", \"Fix query failure when calling a function with a large number of parameters. ({issue}`15979`)\"], \"BigQuery connector\": [\"Fix failure of aggregation queries when executed against a materialized view,\\nexternal table, or snapshot table. ({issue}`15546`)\"], \"Delta Lake connector\": [\"Add support for inserting into tables that have\\n[simple invariants](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#column-invariants). ({issue}`16136`)\", \"Add [generated column expressions](https://docs.delta.io/latest/delta-batch.html#use-generated-columns)\\nto the `Extra` column in the results of `DESCRIBE` and `SHOW COLUMNS`. ({issue}`16631`)\", \"Expand the `flush_metadata_cache` table procedure to also flush the internal\\ncaches of table snapshots and active data files. ({issue}`16466`)\", \"Collect statistics for newly-created columns. ({issue}`16109`)\", \"Remove the `$data` system table. ({issue}`16650`)\", \"Fix query failure when evaluating a `WHERE` clause on a partition column. ({issue}`16388`)\"], \"Druid connector\": [\"Fix failure when the query passed to the `query` table function contains a\\ncolumn alias. ({issue}`16225`)\"], \"Elasticsearch connector\": [\"Remove the deprecated pass-through query, which has been replaced with the\\n`raw_query` table function. ({issue}`13050`)\"], \"Hive connector\": [\"Add a native OpenX JSON file format reader and writer. These can be disabled\\nwith the `openx_json_native_reader_enabled` and\\n`openx_json_native_writer_enabled` session properties or the\\n`openx-json.native-reader.enabled` and `openx-json.native-writer.enabled`\\nconfiguration properties. ({issue}`16073`)\", \"Add support for implicit coercions between `char` types of different lengths. ({issue}`16402`)\", \"Improve performance of queries with joins where both sides of a join have keys\\nwith the same table bucketing definition. ({issue}`16381`)\", \"Improve query planning performance for queries scanning tables with a large\\nnumber of columns. ({issue}`16203`)\", \"Improve scan performance for `COUNT(*)` queries on row-oriented formats. ({issue}`16595`)\", \"Ensure the value of the `hive.metastore-stats-cache-ttl` configuration\\nproperty always is greater than or equal to the value specified in the\\n`hive.metastore-cache-ttl` configuration property. ({issue}`16625`)\", \"Skip listing Glue metastore tables with invalid column types. ({issue}`16677`)\", \"Fix query failure when a file that is using a text file format with a\\nsingle header row that is large enough to be split into multiple files. ({issue}`16492`)\", \"Fix potential query failure when Kerberos is enabled and the query execution\\ntakes longer than a Kerberos ticket's lifetime. ({issue}`16680`)\"], \"Hudi connector\": [\"Add a `$timeline` system table which can be queried to inspect the Hudi table\\ntimeline. ({issue}`16149`)\"], \"Iceberg connector\": [\"Add a `migrate` procedure that converts a Hive table to an Iceberg table. ({issue}`13196`)\", \"Add support for materialized views with a freshness grace period. ({issue}`15842`)\", \"Add a `$refs` system table which can be queried to inspect snapshot\\nreferences. ({issue}`15649`)\", \"Add support for creation of materialized views partitioned with a temporal\\npartitioning function on a `timestamp with time zone` column. ({issue}`16637`)\", \"Improve performance of queries run after data was written by Trino. ({issue}`15441`)\", \"Remove the `$data` system table. ({issue}`16650`)\", \"Fix failure when the `$files` system table contains non-null values in the\\n`key_metadata`, `split_offsets`, and `equality_ids` columns. ({issue}`16473`)\", \"Fix failure when partitioned column names contain uppercase characters. ({issue}`16622`)\"], \"Ignite connector\": [\"Add support for predicate pushdown with a `LIKE` clause. ({issue}`16396`)\", \"Add support for pushdown of joins. ({issue}`16428`)\", \"Add support for {doc}`/sql/delete`. ({issue}`16720`)\"], \"MariaDB connector\": [\"Fix failure when the query passed to the `query` table function contains a\\ncolumn alias. ({issue}`16225`)\"], \"MongoDB connector\": [\"Fix incorrect results when the query passed to the MongoDB `query` table\\nfunction contains helper functions such as `ISODate`. ({issue}`16626`)\"], \"MySQL connector\": [\"Fix failure when the query passed to the `query` table function contains a\\ncolumn alias. ({issue}`16225`)\"], \"Oracle connector\": [\"Improve performance of queries when the network latency between Trino and\\nOracle is high, or when selecting a small number of columns. ({issue}`16644`)\"], \"PostgreSQL connector\": [\"Improve performance of queries when the network latency between Trino and\\nPostgreSQL is high, or when selecting a small number of columns. ({issue}`16644`)\"], \"Redshift connector\": [\"Improve performance of queries when the network latency between Trino and\\nRedshift is high, or when selecting a small number of columns. ({issue}`16644`)\"], \"SingleStore connector\": [\"Fix failure when the query passed to the `query` table function contains a\\ncolumn alias. ({issue}`16225`)\"], \"SQL Server connector\": [\"Add support for executing stored procedures using the `procedure` table\\nfunction. ({issue}`16696`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 284]\"}, {\"title\": \"Release 412 (5 Apr 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for aggregate functions and parameters as arguments for the\\n[`json_object()`](json-object) and [`json_array()`](json-array)\\nfunctions. ({issue}`16489`, {issue}`16523`, {issue}`16525`)\", \"Expose optimizer rule execution statistics in query statistics. The number of\\nrules for which statistics are collected can be limited with the\\n`query.reported-rule-stats-limit` configuration property. ({issue}`2578`)\", \"Add the {func}`exclude_columns` table function. ({issue}`16584`)\", \"Allow disabling the use of the cost-based optimizer to determine partitioning\\nof a stage with the `optimizer.use-cost-based-partitioning`configuration\\nproperty or the `use_cost_based_partitioning` session property. ({issue}`16781`)\", \"Improve performance of queries involving table functions with table arguments. ({issue}`16012`)\", \"Improve latency for small queries when fault-tolerant execution is enabled. ({issue}`16103`)\", \"Fix failure when querying a nested field of a `row` type in queries involving\\n`ORDER BY ... LIMIT`. ({issue}`16768`)\"], \"JDBC driver\": [\"Allow configuring a custom DNS resolver. ({issue}`16647`)\"], \"ClickHouse connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to ClickHouse. ({issue}`16452`)\"], \"Delta Lake connector\": [\"Add support for arithmetic binary expressions in table check constraints. ({issue}`16721`)\", \"Improve performance of queries that only read partition columns. ({issue}`16788`)\"], \"Hive connector\": [\"Fix query failure when bucketing or sorting column names are registered in\\na metastore in uppercase. ({issue}`16796`)\", \"Fix query failure when reading transactional tables with locations containing\\nhidden directories. ({issue}`16773`)\"], \"Iceberg connector\": [\"Fix incorrect results for the `migrate` procedure when the table location\\ncontains a hidden directory. ({issue}`16779`)\"], \"Ignite connector\": [\"Add support for `ALTER TABLE ... ADD COLUMN`. ({issue}`16755`)\", \"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation to Ignite. ({issue}`16452`)\"], \"MariaDB connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to MariaDB. ({issue}`16452`)\"], \"MySQL connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to MySQL. ({issue}`16452`)\"], \"Oracle connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to Oracle. ({issue}`16452`)\"], \"PostgreSQL connector\": [\"Add support for [table comments](/sql/comment). ({issue}`16135`)\", \"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to PostgreSQL. ({issue}`16452`)\"], \"Redshift connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to Redshift. ({issue}`16452`)\"], \"SQL Server connector\": [\"Improve performance of queries involving `sum(DISTINCT ...)` by pushing\\ncomputation down to SQL Server. ({issue}`16452`)\"], \"SPI\": [\"Allow table functions to return anonymous columns. ({issue}`16584`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 285]\"}, {\"title\": \"Release 413 (12 Apr 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of queries involving window operations or\\n[row pattern recognition](/sql/pattern-recognition-in-window) on small\\npartitions. ({issue}`16748`)\", \"Improve performance of queries with the {func}`row_number` and {func}`rank`\\nwindow functions. ({issue}`16753`)\", \"Fix potential failure when cancelling a query. ({issue}`16960`)\"], \"Delta Lake connector\": [\"Add support for nested `timestamp with time zone` values in\\n[structural data types](structural-data-types). ({issue}`16826`)\", \"Disallow using `_change_type`, `_commit_version`, and `_commit_timestamp` as\\ncolumn names when creating a table or adding a column with\\n[change data feed](https://docs.delta.io/2.0.0/delta-change-data-feed.html). ({issue}`16913`)\", \"Disallow enabling change data feed when the table contains\\n`_change_type`, `_commit_version` and `_commit_timestamp` columns. ({issue}`16913`)\", \"Fix incorrect results when reading `INT32` values without a decimal logical\\nannotation in Parquet files. ({issue}`16938`)\"], \"Hive connector\": [\"Fix incorrect results when reading `INT32` values without a decimal logical\\nannotation in Parquet files. ({issue}`16938`)\", \"Fix incorrect results when the file path contains hidden characters. ({issue}`16386`)\"], \"Hudi connector\": [\"Fix incorrect results when reading `INT32` values without a decimal logical\\nannotation in Parquet files. ({issue}`16938`)\"], \"Iceberg connector\": [\"Fix incorrect results when reading `INT32` values without a decimal logical\\nannotation in Parquet files. ({issue}`16938`)\", \"Fix failure when creating a schema with a username containing uppercase\\ncharacters in the Iceberg Glue catalog. ({issue}`16116`)\"], \"Oracle connector\": [\"Add support for [table comments](/sql/comment) and creating tables with\\ncomments. ({issue}`16898`)\"], \"Phoenix connector\": [\"Add support for {doc}`/sql/merge`. ({issue}`16661`)\"], \"SPI\": [\"Deprecate the `getSchemaProperties()` and `getSchemaOwner()` methods in\\n`ConnectorMetadata` in favor of versions that accept a `String` for the schema\\nname rather than `CatalogSchemaName`. ({issue}`16862`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 286]\"}, {\"title\": \"Release 414 (19 Apr 2023)\", \"description\": null, \"content\": {\"General\": [\"Add [recursive member access](json-descendant-member-accessor) to the\\n[JSON path language](json-path-language). ({issue}`16854`)\", \"Add the [`sequence()`](built-in-table-functions) table function. ({issue}`16716`)\", \"Add support for progress estimates when\\n[fault-tolerant execution](/admin/fault-tolerant-execution) is enabled. ({issue}`13072`)\", \"Add support for `CUBE` and `ROLLUP` with composite sets. ({issue}`16981`)\", \"Add experimental support for tracing using [OpenTelemetry](https://opentelemetry.io/).\\nThis can be enabled by setting the `tracing.enabled` configuration property to\\n`true` and optionally configuring the\\n[OLTP/gRPC endpoint](https://opentelemetry.io/docs/reference/specification/protocol/otlp/)\\nby setting the `tracing.exporter.endpoint` configuration property. ({issue}`16950`)\", \"Improve performance for certain queries that produce no values. ({issue}`15555`, {issue}`16515`)\", \"Fix query failure for recursive queries involving lambda expressions. ({issue}`16989`)\", \"Fix incorrect results when using the {func}`sequence` function with values\\ngreater than 2<sup>31</sup> (about 2.1 billion). ({issue}`16742`)\"], \"Security\": [\"Disallow [graceful shutdown](/admin/graceful-shutdown) with the `default`\\n[system access control](/security/built-in-system-access-control). Shutdowns\\ncan be re-enabled by using the `allow-all` system access control, or by\\nconfiguring [system information rules](system-file-auth-system-information)\\nwith the `file` system access control. ({issue}`17105`)\"], \"Delta Lake connector\": [\"Add support for `INSERT`, `UPDATE`, and `DELETE` operations on\\ntables with a `name` column mapping. ({issue}`12638`)\", \"Add support for [Databricks 12.2 LTS](https://docs.databricks.com/release-notes/runtime/12.2.html). ({issue}`16905`)\", \"Disallow reading tables with [deletion vectors](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#deletion-vectors).\\nPreviously, this returned incorrect results. ({issue}`16884`)\"], \"Iceberg connector\": [\"Add support for Hive external tables in the `migrate` table procedure. ({issue}`16704`)\"], \"Kafka connector\": [\"Fix query failure when a Kafka topic contains tombstones (messages with a\\n``NULL`` value). ({issue}`16962`)\"], \"Kudu connector\": [\"Fix query failure when merging two tables that were created by\\n`CREATE TABLE ... AS SELECT ...`. ({issue}`16848`)\"], \"Pinot connector\": [\"Fix incorrect results due to incorrect pushdown of aggregations. ({issue}`12655`)\"], \"PostgreSQL connector\": [\"Fix failure when fetching table statistics for PostgreSQL 14.0 and later. ({issue}`17061`)\"], \"Redshift connector\": [\"Add support for [fault-tolerant execution](/admin/fault-tolerant-execution). ({issue}`16860`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 287]\"}, {\"title\": \"Release 415 (28 Apr 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of aggregations with variable file sizes. ({issue}`11361`)\", \"Perform missing permission checks for table arguments to table functions. ({issue}`17279`)\"], \"Web UI\": [\"Add CPU planning time to the query details page. ({issue}`15318`)\"], \"Delta Lake connector\": [\"Add support for commenting on tables and columns with an `id` and `name`\\ncolumn mapping mode. ({issue}`17139`)\", \"Add support for `BETWEEN` predicates in table check constraints. ({issue}`17120`)\"], \"Hive connector\": [\"Improve performance of queries with selective filters on primitive fields in\\n`row` columns. ({issue}`15163`)\"], \"Iceberg connector\": [\"Improve performance of queries with filters when Bloom filter indexes are\\npresent in Parquet files. ({issue}`17192`)\", \"Fix failure when trying to use `DROP TABLE` on a corrupted table. ({issue}`12318`)\"], \"Kafka connector\": [\"Add support for Protobuf `oneof` types when using the Confluent table\\ndescription provider. ({issue}`16836`)\"], \"SPI\": [\"Expose ``planningCpuTime`` in ``QueryStatistics``. ({issue}`15318`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 288]\"}, {\"title\": \"Release 416 (3 May 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of partitioned `INSERT`, `CREATE TABLE AS .. SELECT`, and\\n`EXECUTE` statements when the source table statistics are missing or \\ninaccurate. ({issue}`16802`)\", \"Improve performance of `LIKE` expressions that contain `%`. ({issue}`16167`)\", \"Remove the deprecated `preferred-write-partitioning-min-number-of-partitions`\\nconfiguration property. ({issue}`16802`)\"], \"Hive connector\": [\"Reduce coordinator memory usage when file metadata caching is enabled. ({issue}`17270`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 289]\"}, {\"title\": \"Release 417 (10 May 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of `UNION ALL` queries. ({issue}`17265`)\"], \"Delta Lake connector\": [\"Add support for [`COMMENT ON VIEW`](/sql/comment). ({issue}`17089`)\", \"Improve performance when reading Parquet data written by Trino. ({issue}`17373`, {issue}`17404`)\", \"Improve read performance for tables with `row` columns when only a subset of\\nfields is needed for a query. ({issue}`17085`)\"], \"Hive connector\": [\"Add support for specifying arbitrary table properties via the\\n`extra_properties` table property. ({issue}`954`)\", \"Improve performance when reading Parquet data written by Trino. ({issue}`17373`, {issue}`17404`)\", \"Improve performance when reading text files that contain more columns in the\\nfile than are mapped in the schema. ({issue}`17364`)\", \"Limit file listing cache based on in-memory size instead of number of entries.\\nThis is configured via the `hive.file-status-cache.max-retained-size` and\\n`hive.per-transaction-file-status-cache.max-retained-size` configuration\\nproperties. The `hive.per-transaction-file-status-cache-maximum-size` and\\n`hive.file-status-cache-size` configuration properties are deprecated. ({issue}`17285`)\"], \"Hudi connector\": [\"Improve performance when reading Parquet data written by Trino. ({issue}`17373`, {issue}`17404`)\"], \"Iceberg connector\": [\"Improve performance when reading Parquet data written by Trino. ({issue}`17373`, {issue}`17404`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 290]\"}, {\"title\": \"Release 418 (17 May 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for [EXECUTE IMMEDIATE](/sql/execute-immediate). ({issue}`17341`)\", \"Fix failure when invoking `current_timestamp`. ({issue}`17455`)\"], \"BigQuery connector\": [\"Add support for adding labels to BigQuery jobs started by Trino as part of\\nquery processing. The name and value of the label can be configured via the\\n`bigquery.job.label-name` and `bigquery.job.label-format` catalog\\nconfiguration properties, respectively. ({issue}`16187`)\"], \"Delta Lake connector\": [\"Add support for `INSERT`, `UPDATE`, `DELETE`, and `MERGE` statements for\\ntables with an `id` column mapping. ({issue}`16600`)\", \"Add the `table_changes` table function. ({issue}`16205`)\", \"Improve performance of joins on partition columns. ({issue}`14493`)\"], \"Hive connector\": [\"Improve performance of querying `information_schema.tables` when using the\\nHive metastore. ({issue}`17127`)\", \"Improve performance of joins on partition columns. ({issue}`14493`)\", \"Improve performance of writing Parquet files by enabling the optimized Parquet \\nwriter by default. ({issue}`17393`)\", \"Remove the `temporary_staging_directory_enabled` and\\n`temporary_staging_directory_path` session properties. ({issue}`17390`)\", \"Fix failure when querying text files in S3 if the native reader is enabled. ({issue}`16546`)\"], \"Hudi connector\": [\"Improve performance of joins on partition columns. ({issue}`14493`)\"], \"Iceberg connector\": [\"Improve planning time for `SELECT` queries. ({issue}`17347`)\", \"Improve performance of joins on partition columns. ({issue}`14493`)\", \"Fix incorrect results when querying the `$history` table if the REST catalog\\nis used. ({issue}`17470`)\"], \"Kafka connector\": [\"Fix query failure when a Kafka key or message cannot be de-serialized, and\\ninstead correctly set the `_key_corrupt` and `_message_corrupt` columns. ({issue}`17479`)\"], \"Kinesis connector\": [\"Fix query failure when a Kinesis message cannot be de-serialized, and\\ninstead correctly set the `_message_valid` column. ({issue}`17479`)\"], \"Oracle connector\": [\"Add support for writes when [fault-tolerant\\nexecution](/admin/fault-tolerant-execution) is enabled. ({issue}`17200`)\"], \"Redis connector\": [\"Fix query failure when a Redis key or value cannot be de-serialized, and\\ninstead correctly set the `_key_corrupt` and `_value_corrupt` columns. ({issue}`17479`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 291]\"}, {\"title\": \"Release 419 (5 Jun 2023)\", \"description\": null, \"content\": {\"General\": [\"Add the {func}`array_histogram` function to find the number of occurrences of\\nthe unique elements in an array. ({issue}`14725 `)\", \"Improve planning performance for queries involving joins. ({issue}`17458`)\", \"Fix query failure when the server JSON response exceeds the 5MB limit for\\nstring values. ({issue}`17557`)\"], \"Web UI\": [\"Allow uppercase or mixed case values for the `web-ui.authentication.type`\\nconfiguration property. ({issue}`17334`)\"], \"BigQuery connector\": [\"Add support for proxying BigQuery APIs via an HTTP(S) proxy. ({issue}`17508`)\", \"Improve performance of retrieving metadata from BigQuery. ({issue}`16064`)\"], \"Delta Lake connector\": [\"Support the `id` and `name` mapping modes when adding new columns. ({issue}`17236`)\", \"Improve performance of reading Parquet files. ({issue}`17612`)\", \"Improve performance when writing Parquet files with\\n[structural data types](structural-data-types). ({issue}`17665`)\", \"Properly display the schema, table name, and location of tables being inserted\\ninto in the output of `EXPLAIN` queries. ({issue}`17590`)\", \"Fix query failure when writing to a file location with a trailing `/` in its\\nname. ({issue}`17552`)\"], \"Hive connector\": [\"Add support for reading ORC files with shorthand timezone ids in the Stripe\\nfooter metadata. You can set the `hive.orc.read-legacy-short-zone-id`\\nconfiguration property to `true` to enable this behavior. ({issue}`12303`)\", \"Improve performance of reading ORC files with Bloom filter indexes. ({issue}`17530`)\", \"Improve performance of reading Parquet files. ({issue}`17612`)\", \"Improve optimized Parquet writer performance for\\n[structural data types](structural-data-types). ({issue}`17665`)\", \"Fix query failure for tables with file paths that contain non-alphanumeric\\ncharacters. ({issue}`17621`)\"], \"Hudi connector\": [\"Improve performance of reading Parquet files. ({issue}`17612`)\", \"Improve performance when writing Parquet files with\\n[structural data types](structural-data-types). ({issue}`17665`)\"], \"Iceberg connector\": [\"Add support for the [Nessie catalog](iceberg-nessie-catalog). ({issue}`11701`)\", \"Disallow use of the `migrate` table procedure on Hive tables with `array`,\\n`map` and `row` types. Previously, this returned incorrect results after the\\nmigration. ({issue}`17587`)\", \"Improve performance of reading ORC files with Bloom filter indexes. ({issue}`17530`)\", \"Improve performance of reading Parquet files. ({issue}`17612`)\", \"Improve performance when writing Parquet files with\\n[structural data types](structural-data-types). ({issue}`17665`)\", \"Improve performance of reading table statistics. ({issue}`16745`)\"], \"SPI\": [\"Remove unused `NullAdaptationPolicy` from `ScalarFunctionAdapter`. ({issue}`17706`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 292]\"}, {\"title\": \"Release 420 (22 Jun 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for the {func}`any_value` aggregation function. ({issue}`17777`)\", \"Add support for underscores in numeric literals. ({issue}`17776`)\", \"Add support for hexadecimal, binary, and octal numeric literals. ({issue}`17776`)\", \"Deprecate the `dynamic-filtering.small-broadcast.*` and\\n`dynamic-filtering.large-broadcast.*` configuration properties in favor of\\n`dynamic-filtering.small.*` and `dynamic-filtering.large.*`. ({issue}`17831`)\"], \"Security\": [\"Add support for configuring authorization rules for\\n`ALTER ... SET AUTHORIZATION...` statements in file-based access control. ({issue}`16691`)\", \"Remove the deprecated `legacy.allow-set-view-authorization` configuration\\nproperty. ({issue}`16691`)\"], \"BigQuery connector\": [\"Fix direct download of access tokens, and correctly use the proxy when it\\nis enabled with the `bigquery.rpc-proxy.enabled` configuration property. ({issue}`17783`)\"], \"Delta Lake connector\": [\"Add support for [comments](/sql/comment) on view columns. ({issue}`17773`)\", \"Add support for recalculating all statistics with an `ANALYZE` statement. ({issue}`15968`)\", \"Disallow using the root directory of a bucket (`scheme://authority`) as a\\ntable location without a trailing slash in the location name. ({issue}`17921`)\", \"Fix Parquet writer incompatibility with Apache Spark and Databricks Runtime. ({issue}`17978`)\"], \"Druid connector\": [\"Add support for tables with uppercase characters in their names. ({issue}`7197`)\"], \"Hive connector\": [\"Add a native Avro file format reader. This can be disabled with the\\n`avro.native-reader.enabled` configuration property or the\\n`avro_native_reader_enabled` session property. ({issue}`17221`)\", \"Require admin role privileges to perform `ALTER ... SET AUTHORIZATION...`\\nstatements when the `hive-security` configuration property is set to\\n`sql-standard`. ({issue}`16691`)\", \"Improve query performance on partitioned Hive tables when table statistics are \\nnot available. ({issue}`17677`)\", \"Disallow using the root directory of a bucket (`scheme://authority`) as a\\ntable location without a trailing slash in the location name. ({issue}`17921`)\", \"Fix Parquet writer incompatibility with Apache Spark and Databricks Runtime. ({issue}`17978`)\", \"Fix reading from a Hive table when its location is the root directory of an S3\\nbucket. ({issue}`17848`)\"], \"Hudi connector\": [\"Disallow using the root directory of a bucket (`scheme://authority`) as a\\ntable location without a trailing slash in the location name. ({issue}`17921`)\", \"Fix Parquet writer incompatibility with Apache Spark and Databricks Runtime. ({issue}`17978`)\", \"Fix failure when fetching table metadata for views. ({issue}`17901`)\"], \"Iceberg connector\": [\"Disallow using the root directory of a bucket (`scheme://authority`) as a\\ntable location without a trailing slash in the location name. ({issue}`17921`)\", \"Fix Parquet writer incompatibility with Apache Spark and Databricks Runtime. ({issue}`17978`)\", \"Fix scheduling failure when dynamic filtering is enabled. ({issue}`17871`)\"], \"Kafka connector\": [\"Fix server startup failure when a Kafka catalog is present. ({issue}`17299`)\"], \"MongoDB connector\": [\"Add support for `ALTER TABLE ... RENAME COLUMN`. ({issue}`17874`)\", \"Fix incorrect results when the order of the\\n[dbref type](https://www.mongodb.com/docs/manual/reference/database-references/#dbrefs)\\nfields is different from `databaseName`, `collectionName`, and `id`. ({issue}`17883`)\"], \"SPI\": [\"Move table function infrastructure to the `io.trino.spi.function.table`\\npackage. ({issue}`17774`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 293]\"}, {\"title\": \"Release 421 (6 Jul 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for check constraints in an `UPDATE` statement. ({issue}`17195`)\", \"Improve performance for queries involving a `year` function within an `IN`\\npredicate. ({issue}`18092`)\", \"Fix failure when cancelling a query with a window function. ({issue}`18061`)\", \"Fix failure for queries involving the `concat_ws` function on arrays with more\\nthan 254 values. ({issue}`17816`)\", \"Fix query failure or incorrect results when coercing a\\n[structural data type](structural-data-types) that contains a timestamp. ({issue}`17900`)\"], \"JDBC driver\": [\"Add support for using an alternative hostname with the `hostnameInCertificate`\\nproperty when SSL verification is set to `FULL`. ({issue}`17939`)\"], \"Delta Lake connector\": [\"Add support for check constraints and column invariants in `UPDATE`\\nstatements. ({issue}`17195`)\", \"Add support for creating tables with the `column` mapping mode. ({issue}`12638`)\", \"Add support for using the `OPTIMIZE` procedure on column mapping tables. ({issue}`17527`)\", \"Add support for `DROP COLUMN`. ({issue}`15792`)\"], \"Google Sheets connector\": [\"Add support for {doc}`/sql/insert` statements. ({issue}`3866`)\"], \"Hive connector\": [\"Add Hive partition projection column properties to the output of\\n`SHOW CREATE TABLE`. ({issue}`18076`)\", \"Fix incorrect query results when using S3 Select with `IS NULL` or\\n`IS NOT NULL` predicates. ({issue}`17563`)\", \"Fix incorrect query results when using S3 Select and a table's `null_format`\\nfield is set. ({issue}`17563`)\"], \"Iceberg connector\": [\"Add support for migrating a bucketed Hive table into a non-bucketed Iceberg\\ntable. ({issue}`18103`)\"], \"Kafka connector\": [\"Add support for reading Protobuf messages containing the `Any` Protobuf type.\\nThis is disabled by default and can be enabled by setting the \\n`kafka.protobuf-any-support-enabled` configuration property to `true`. ({issue}`17394`)\"], \"MongoDB connector\": [\"Improve query performance on tables with `row` columns when only a subset of\\nfields is needed for the query. ({issue}`17710`)\"], \"Redshift connector\": [\"Add support for [table comments](/sql/comment). ({issue}`16900`)\"], \"SPI\": [\"Add the `BLOCK_AND_POSITION_NOT_NULL` argument convention. ({issue}`18035`)\", \"Add the `BLOCK_BUILDER` return convention that writes function results\\ndirectly to a `BlockBuilder`. ({issue}`18094`)\", \"Add the `READ_VALUE` operator that can read a value from any argument\\nconvention to any return convention. ({issue}`18094`)\", \"Remove write methods from the BlockBuilder interface. ({issue}`17342`)\", \"Change array, map, and row build to use a single `writeEntry`. ({issue}`17342`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 294]\"}, {\"title\": \"Release 422 (13 Jul 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for adding nested fields with an `ADD COLUMN` statement. ({issue}`16248`)\", \"Improve performance of `INSERT` and `CREATE TABLE AS ... SELECT` queries. ({issue}`18005`)\", \"Prevent queries from hanging when worker nodes fail and the\\n`task.retry-policy` configuration property is set to `TASK`. ({issue}`18175 `)\"], \"Security\": [\"Add support for validating JWT types with OAuth 2.0 authentication. ({issue}`17640`)\", \"Fix error when the `http-server.authentication.type` configuration property\\nis set to `oauth2` or `jwt` and the `principal-field` property's value\\ndiffers. ({issue}`18210`)\"], \"BigQuery connector\": [\"Add support for writing to columns with a `timestamp(p) with time zone` type. ({issue}`17793`)\"], \"Delta Lake connector\": [\"Add support for renaming columns. ({issue}`15821`)\", \"Improve performance of reading from tables with a large number of\\n[checkpoints](https://docs.delta.io/latest/delta-batch.html#-data-retention). ({issue}`17405`)\", \"Disallow using the `vacuum` procedure when the max\\n[writer version](https://docs.delta.io/latest/versioning.html#features-by-protocol-version)\\nis above 5. ({issue}`18095`)\"], \"Hive connector\": [\"Add support for reading the `timestamp with local time zone` Hive type. ({issue}`1240`)\", \"Add a native Avro file format writer. This can be disabled with the\\n`avro.native-writer.enabled` configuration property or the\\n`avro_native_writer_enabled` session property. ({issue}`18064`)\", \"Fix query failure when the `hive.recursive-directories` configuration property\\nis set to true and partition names contain non-alphanumeric characters. ({issue}`18167`)\", \"Fix incorrect results when reading text and `RCTEXT` files with a value that\\ncontains the character that separates fields. ({issue}`18215`)\", \"Fix incorrect results when reading concatenated `GZIP` compressed text files. ({issue}`18223`)\", \"Fix incorrect results when reading large text and sequence files with a single\\nheader row. ({issue}`18255`)\", \"Fix incorrect reporting of bytes read for compressed text files. ({issue}`1828`)\"], \"Iceberg connector\": [\"Add support for adding nested fields with an `ADD COLUMN` statement. ({issue}`16248`)\", \"Add support for the `register_table` procedure to register Hadoop tables. ({issue}`16363`)\", \"Change the default file format to Parquet. The `iceberg.file-format`\\ncatalog configuration property can be used to specify a different default file\\nformat. ({issue}`18170`)\", \"Improve performance of reading `row` types from Parquet files. ({issue}`17387`)\", \"Fix failure when writing to tables sorted on `UUID` or `TIME` types. ({issue}`18136`)\"], \"Kudu connector\": [\"Add support for table comments when creating tables. ({issue}`17945`)\"], \"Redshift connector\": [\"Prevent returning incorrect results by throwing an error when encountering\\nunsupported types. Previously, the query would fall back to the legacy type\\nmapping. ({issue}`18209`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 295]\"}, {\"title\": \"Release 423 (10 Aug 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for renaming nested fields in a column via `RENAME COLUMN`. ({issue}`16757`)\", \"Add support for setting the type of a nested field in a column via `SET DATA TYPE`. ({issue}`16959`)\", \"Add support for comments on materialized view columns. ({issue}`18016`)\", \"Add support for displaying all Unicode characters in string literals. ({issue}`5061`)\", \"Improve performance of `INSERT` and `CREATE TABLE AS ... SELECT` queries. ({issue}`18212`)\", \"Improve performance when planning queries involving multiple window functions. ({issue}`18491`)\", \"Improve performance of queries involving `BETWEEN` clauses. ({issue}`18501`)\", \"Improve performance of queries containing redundant `ORDER BY` clauses in\\nviews or `WITH` clauses. This may affect the semantics of queries that\\nincorrectly rely on implementation-specific behavior. The old behavior can be\\nrestored via the `skip_redundant_sort` session property or the\\n`optimizer.skip-redundant-sort` configuration property. ({issue}`18159`)\", \"Reduce default values for the `task.partitioned-writer-count` and\\n`task.scale-writers.max-writer-count` configuration properties to reduce the\\nmemory requirements of queries that write data. ({issue}`18488`)\", \"Remove the deprecated `optimizer.use-mark-distinct` configuration property,\\nwhich has been replaced with `optimizer.mark-distinct-strategy`. ({issue}`18540`)\", \"Fix query planning failure due to dynamic filters in\\n[fault tolerant execution mode](/admin/fault-tolerant-execution). ({issue}`18383`)\", \"Fix `EXPLAIN` failure when a query contains `WHERE ... IN (NULL)`. ({issue}`18328`)\"], \"JDBC driver\": [\"Add support for\\n[constrained delegation](https://web.mit.edu/kerberos/krb5-latest/doc/appdev/gssapi.html#constrained-delegation-s4u)\\nwith Kerberos. ({issue}`17853`)\"], \"CLI\": [\"Add support for accepting a single Trino JDBC URL with parameters as an\\nalternative to passing command line arguments. ({issue}`12587`)\"], \"ClickHouse connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18305`)\"], \"Blackhole connector\": [\"Add support for the `COMMENT ON VIEW` statement. ({issue}`18516`)\"], \"Delta Lake connector\": [\"Add `$properties` system table which can be queried to inspect Delta Lake\\ntable properties. ({issue}`17294`)\", \"Add support for reading the `timestamp_ntz` type. ({issue}`17502`)\", \"Add support for writing the `timestamp with time zone` type on partitioned\\ncolumns. ({issue}`16822`)\", \"Add option to enforce that a filter on a partition key is present for\\nquery processing. This can be enabled by setting the\\n``delta.query-partition-filter-required`` configuration property or the\\n``query_partition_filter_required`` session property to ``true``.\\n({issue}`18345`)\", \"Improve performance of the `$history` system table. ({issue}`18427`)\", \"Improve memory accounting of the Parquet writer. ({issue}`18564`)\", \"Allow metadata changes on Delta Lake tables with\\n[identity columns](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#identity-columns). ({issue}`18200`)\", \"Fix incorrectly creating files smaller than the configured\\n`file_size_threshold` as part of `OPTIMIZE`. ({issue}`18388`)\", \"Fix query failure when a table has a file with a location ending with\\nwhitespace. ({issue}`18206`)\"], \"Hive connector\": [\"Add support for changing a column's type from `varchar` to `timestamp`. ({issue}`18014`)\", \"Improve memory accounting of the Parquet writer. ({issue}`18564`)\", \"Remove the legacy Parquet writer, along with the\\n`parquet.optimized-writer.enabled` configuration property and the\\n`parquet_optimized_writer_enabled ` session property. Replace the\\n`parquet.optimized-writer.validation-percentage` configuration property with\\n`parquet.writer.validation-percentage`. ({issue}`18420`)\", \"Disallow coercing Hive `timestamp` types to `varchar` for dates before 1900. ({issue}`18004`)\", \"Fix loss of data precision when coercing Hive `timestamp` values. ({issue}`18003`)\", \"Fix incorrectly creating files smaller than the configured\\n`file_size_threshold` as part of `OPTIMIZE`. ({issue}`18388`)\", \"Fix query failure when a table has a file with a location ending with\\nwhitespace. ({issue}`18206`)\", \"Fix incorrect results when using S3 Select and a query predicate includes a\\nquote character (`\\\"`) or a decimal column. ({issue}`17775`)\", \"Add the `hive.s3select-pushdown.experimental-textfile-pushdown-enabled`\\nconfiguration property to enable S3 Select pushdown for `TEXTFILE` tables. ({issue}`17775`)\"], \"Hudi connector\": [\"Fix query failure when a table has a file with a location ending with\\nwhitespace. ({issue}`18206`)\"], \"Iceberg connector\": [\"Add support for renaming nested fields in a column via `RENAME COLUMN`. ({issue}`16757`)\", \"Add support for setting the type of a nested field in a column via\\n`SET DATA TYPE`. ({issue}`16959`)\", \"Add support for comments on materialized view columns. ({issue}`18016`)\", \"Add support for `tinyint` and `smallint` types in the `migrate` procedure. ({issue}`17946`)\", \"Add support for reading Parquet files with time stored in millisecond precision. ({issue}`18535`)\", \"Improve performance of `information_schema.columns` queries for tables managed\\nby Trino with AWS Glue as metastore. ({issue}`18315`)\", \"Improve performance of `system.metadata.table_comments` when querying Iceberg\\ntables backed by AWS Glue as metastore. ({issue}`18517`)\", \"Improve performance of `information_schema.columns` when using the Glue\\ncatalog. ({issue}`18586`)\", \"Improve memory accounting of the Parquet writer. ({issue}`18564`)\", \"Fix incorrectly creating files smaller than the configured\\n`file_size_threshold` as part of `OPTIMIZE`. ({issue}`18388`)\", \"Fix query failure when a table has a file with a location ending with\\nwhitespace. ({issue}`18206`)\", \"Fix failure when creating a materialized view on a table which has been\\nrolled back. ({issue}`18205`)\", \"Fix query failure when reading ORC files with nullable `time` columns. ({issue}`15606`)\", \"Fix failure to calculate query statistics when referring to `$path` as part of\\na `WHERE` clause. ({issue}`18330`)\", \"Fix write conflict detection for `UPDATE`, `DELETE`, and `MERGE` operations.\\nIn rare situations this issue may have resulted in duplicate rows when\\nmultiple operations were run at the same time, or at the same time as an\\n`optimize` procedure. ({issue}`18533`)\"], \"Kafka connector\": [\"Rename the `ADD_DUMMY` value for the `kafka.empty-field-strategy`\\nconfiguration property and the `empty_field_strategy` session property to\\n`MARK` ({issue}`18485`).\"], \"Kudu connector\": [\"Add support for optimized local scheduling of splits. ({issue}`18121`)\"], \"MariaDB connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18305`)\"], \"MongoDB connector\": [\"Add support for predicate pushdown on `char` and `decimal` type. ({issue}`18382`)\"], \"MySQL connector\": [\"Add support for predicate pushdown for `=`, `<>`, `IN`, `NOT IN`, and `LIKE`\\noperators on case-sensitive `varchar` and `nvarchar` columns. ({issue}`18140`, {issue}`18441`)\", \"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18305`)\"], \"Oracle connector\": [\"Add support for Oracle `timestamp` types with non-millisecond precision. ({issue}`17934`)\", \"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18305`)\"], \"SingleStore connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18305`)\"], \"SPI\": [\"Deprecate the `ConnectorMetadata.getTableHandle(ConnectorSession, SchemaTableName)`\\nmethod signature. Connectors should implement\\n`ConnectorMetadata.getTableHandle(ConnectorSession, SchemaTableName, Optional, Optional)`\\ninstead. ({issue}`18596`)\", \"Remove the deprecated `supportsReportingWrittenBytes` method from\\nConnectorMetadata. ({issue}`18617`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 296]\"}, {\"title\": \"Release 424 (17 Aug 2023)\", \"description\": null, \"content\": {\"General\": [\"Reduce coordinator overhead on large clusters. ({issue}`18542`)\", \"Require the JVM default charset to be UTF-8. This can be set with the JVM\\ncommand line option `-Dfile.encoding=UTF-8`. ({issue}`18657`)\"], \"JDBC driver\": [\"Add the number of bytes that have been written to the query results response. ({issue}`18651`)\"], \"Delta Lake connector\": [\"Remove the legacy Parquet reader, along with the\\n`parquet.optimized-reader.enabled` and\\n`parquet.optimized-nested-reader.enabled` configuration properties. ({issue}`18639`)\"], \"Hive connector\": [\"Improve performance for line-oriented Hive formats. ({issue}`18703`)\", \"Improve performance of reading JSON files. ({issue}`18709`)\", \"Remove the legacy Parquet reader, along with the\\n`parquet.optimized-reader.enabled` and\\n`parquet.optimized-nested-reader.enabled` configuration properties. ({issue}`18639`)\", \"Fix incorrect reporting of written bytes for uncompressed text files, which\\nprevented the `target_max_file_size` session property from working. ({issue}`18701`)\"], \"Hudi connector\": [\"Remove the legacy Parquet reader, along with the\\n`parquet.optimized-reader.enabled` and\\n`parquet.optimized-nested-reader.enabled` configuration properties. ({issue}`18639`)\"], \"Iceberg connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18689`)\", \"Remove the legacy Parquet reader, along with the\\n`parquet.optimized-reader.enabled` and\\n`parquet.optimized-nested-reader.enabled` configuration properties. ({issue}`18639`)\", \"Fix potential incorrect query results when a query involves a predicate on a\\n`timestamp with time zone` column. ({issue}`18588`)\"], \"Memory connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18668`)\"], \"PostgreSQL connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18663`)\", \"Remove support for Postgres versions older than\\n[version 11](https://www.postgresql.org/support/versioning/). ({issue}`18696`)\"], \"SPI\": [\"Introduce the `getNewTableWriterScalingOptions` and\\n`getInsertWriterScalingOptions` methods to `ConnectorMetadata`, which enable\\nconnectors to limit writer scaling. ({issue}`18561`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 297]\"}, {\"title\": \"Release 425 (24 Aug 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of `GROUP BY`. ({issue}`18106`)\", \"Fix incorrect reporting of cumulative memory usage. ({issue}`18714`)\"], \"BlackHole connector\": [\"Remove support for materialized views. ({issue}`18628`)\"], \"Delta Lake connector\": [\"Add support for check constraints in `MERGE` statements. ({issue}`15411`)\", \"Improve performance when statistics are missing from the transaction log. ({issue}`16743`)\", \"Improve memory usage accounting of the Parquet writer. ({issue}`18756`)\", \"Improve performance of `DELETE` statements when they delete the whole table or \\nwhen the filters only apply to partition columns. ({issue}`18332 `)\"], \"Hive connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18320`)\", \"Create a new directory if the specified external location for a new table does\\nnot exist. ({issue}`17920`)\", \"Improve memory usage accounting of the Parquet writer. ({issue}`18756`)\", \"Improve performance of writing to JSON files. ({issue}`18683`)\"], \"Iceberg connector\": [\"Improve memory usage accounting of the Parquet writer. ({issue}`18756`)\"], \"Kudu connector\": [\"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18629`)\"], \"MongoDB connector\": [\"Add support for the `Decimal128` MongoDB type. ({issue}`18722`)\", \"Add support for `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18629`)\", \"Fix query failure when reading the value of `-0` as a `decimal` type. ({issue}`18777`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 298]\"}, {\"title\": \"Release 426 (5 Sep 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for `SET SESSION AUTHORIZATION` and `RESET SESSION AUTHORIZATION`. ({issue}`16067`)\", \"Add support for automatic type coercion when creating tables. ({issue}`13994`)\", \"Improve performance of aggregations over decimal values. ({issue}`18868`)\", \"Fix event listener incorrectly reporting output columns for `UPDATE`\\nstatements with subqueries. ({issue}`18815`)\", \"Fix failure when performing an outer join involving geospatial functions in\\nthe join clause. ({issue}`18860`)\", \"Fix failure when querying partitioned tables with a `WHERE` clause that\\ncontains lambda expressions. ({issue}`18865`)\", \"Fix failure for `GROUP BY` queries over `map` and `array` types. ({issue}`18863`)\"], \"Security\": [\"Fix authentication failure with OAuth 2.0 when authentication tokens are\\nlarger than 4 KB. ({issue}`18836`)\"], \"Delta Lake connector\": [\"Add support for the `TRUNCATE TABLE` statement. ({issue}`18786`)\", \"Add support for the `CASCADE` option in `DROP SCHEMA` statements. ({issue}`18333`)\", \"Add support for\\n[Databricks 13.3 LTS](https://docs.databricks.com/en/release-notes/runtime/13.3lts.html). ({issue}`18888`)\", \"Fix writing an incorrect transaction log for partitioned tables with an `id`\\nor `name` column mapping mode. ({issue}`18661`)\"], \"Hive connector\": [\"Add the `hive.metastore.thrift.batch-fetch.enabled` configuration property,\\nwhich can be set to `false` to disable batch metadata fetching from the Hive\\nmetastore. ({issue}`18111`)\", \"Fix `ANALYZE` failure when row count stats are missing. ({issue}`18798`)\", \"Fix the `hive.target-max-file-size` configuration property being ignored\\nwhen writing to sorted tables. ({issue}`18653`)\", \"Fix query failure when reading large SequenceFile, RCFile, or Avro files. ({issue}`18837`)\"], \"Iceberg connector\": [\"Fix the `iceberg.target-max-file-size` configuration property being ignored\\nwhen writing to sorted tables. ({issue}`18653`)\"], \"SPI\": [\"Remove the deprecated\\n`ConnectorMetadata#dropSchema(ConnectorSession session, String schemaName)`\\nmethod. ({issue}`18839`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 299]\"}, {\"title\": \"Release 427 (26 Sep 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for comparing IPv4 and IPv6 addresses and CIDRs with [contains](ip-address-contains). ({issue}`18497`)\", \"Improve performance of `GROUP BY` and `DISTINCT`. ({issue}`19059`)\", \"Reduce coordinator memory footprint when scannning tables. ({issue}`19009`)\", \"Fix failure due to exceeding node memory limits with `INSERT` statements. ({issue}`18771`)\", \"Fix query hang for certain `LIKE` patterns involving a mix of `%` and `_`. ({issue}`19146`)\"], \"Security\": [\"Ensure authorization is checked when accessing table comments with table redirections. ({issue}`18514`)\"], \"Delta Lake connector\": [\"Add support for reading tables with\\n[Deletion Vectors](https://docs.delta.io/latest/delta-deletion-vectors.html). ({issue}`16903`)\", \"Add support for Delta Lake writer\\n[version 7](https://docs.delta.io/latest/versioning.html#features-by-protocol-version). ({issue}`15873`)\", \"Add support for writing columns with the `timestamp(p)` type. ({issue}`16927`)\", \"Reduce data read from Parquet files for queries with filters. ({issue}`19032`)\", \"Improve performance of writing to Parquet files. ({issue}`19122`)\", \"Fix error reading Delta Lake table history when the initial transaction logs\\nhave been removed. ({issue}`18845`)\"], \"Elasticsearch connector\": [\"Fix query failure when a `LIKE` clause contains multi-byte characters. ({issue}`18966`)\"], \"Hive connector\": [\"Add support for changing column comments when using the Glue catalog. ({issue}`19076`)\", \"Reduce data read from Parquet files for queries with filters. ({issue}`19032`)\", \"Improve performance of reading text files. ({issue}`18959`)\", \"Allow changing a column's type from `double` to `varchar` in Hive tables. ({issue}`18930`)\", \"Remove legacy Hive readers and writers. The `*_native_reader_enabled` and\\n`*_native_writer_enabled` session properties and `*.native-reader.enabled` and\\n`*.native-writer.enabled` configuration properties are removed. ({issue}`18241`)\", \"Remove support for S3 Select. The `s3_select_pushdown_enabled` session\\nproperty and the `hive.s3select*` configuration properties are removed. ({issue}`18241`)\", \"Remove support for disabling optimized symlink listing. The\\n`optimize_symlink_listing` session property and\\n`hive.optimize-symlink-listing` configuration property are removed. ({issue}`18241`)\", \"Fix incompatibility with Hive OpenCSV deserialization. As a result, when the\\nescape character is explicitly set to `\\\"`, a `\\\\` (backslash) must be used\\ninstead. ({issue}`18918`)\", \"Fix performance regression when reading CSV files on AWS S3. ({issue}`18976`)\", \"Fix failure when creating a table with a `varchar(0)` column. ({issue}`18811`)\"], \"Hudi connector\": [\"Fix query failure when reading from Hudi tables with\\n[`instants`](https://hudi.apache.org/docs/concepts/#timeline) that have been\\nreplaced. ({issue}`18213`)\"], \"Iceberg connector\": [\"Add support for usage of `date` and `timestamp` arguments in `FOR TIMESTAMP AS\\nOF` expressions. ({issue}`14214`)\", \"Add support for using tags with `AS OF VERSION` queries. ({issue}`19111`)\", \"Reduce data read from Parquet files for queries with filters. ({issue}`19032`)\", \"Improve performance of writing to Parquet files. ({issue}`19090`)\", \"Improve performance of reading tables with many equality delete files. ({issue}`17114`)\"], \"Ignite connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"MariaDB connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"MongoDB connector\": [\"Fix query failure when mapping MongoDB `Decimal128` values with leading zeros. ({issue}`19068`)\"], \"MySQL connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\", \"Change mapping for MySQL `TIMESTAMP` types from `timestamp(n)` to\\n`timestamp(n) with time zone`. ({issue}`18470`)\"], \"Oracle connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\", \"Fix potential query failure when joins are pushed down to Oracle. ({issue}`18924`)\"], \"PostgreSQL connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"Redshift connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"SingleStore connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"SQL Server connector\": [\"Add support for `UPDATE`. ({issue}`16445`)\"], \"SPI\": [\"Change `BlockBuilder` to no longer extend `Block`. ({issue}`18738`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 300]\"}, {\"title\": \"Release 428 (4 Oct 2023)\", \"description\": null, \"content\": {\"General\": [\"Reduce memory usage for queries involving `GROUP BY` clauses. ({issue}`19187`)\", \"Simplify writer count configuration. Add the new `task.min-writer-count`\\nand `task.max-writer-count` configuration properties along with the\\n`task_min_writer_count` and `task_max_writer_count` session properties, which\\ncontrol the number of writers depending on scenario. Deprecate the\\n`task.writer-count`, `task.scale-writers.max-writer-count`, and\\n`task.partitioned-writer-count` configuration properties, which will be\\nremoved in the future. Remove the `task_writer_count`,\\n`task_partitioned_writer_count`, and `task_scale_writers_max_writer_count`\\nsession properties. ({issue}`19135`)\", \"Remove support for the `parse-decimal-literals-as-double` legacy configuration\\nproperty. ({issue}`19166`)\", \"Fix out of memory error when running queries with `GROUP BY` clauses. ({issue}`19119`)\"], \"Delta Lake connector\": [\"Reduce the number of read requests for scanning small Parquet files. Add the\\n`parquet.small-file-threshold` configuration property and the\\n`parquet_small_file_threshold` session property to change the default size of\\n`3MB`, below which, files will be read in their entirety. Setting this\\nconfiguration to `0B` disables the feature. ({issue}`19127`)\", \"Fix potential data duplication when running `OPTIMIZE` coincides with\\nupdates to a table. ({issue}`19128`)\", \"Fix error when deleting rows in tables that have partitions with certain\\nnon-alphanumeric characters in their names. ({issue}`18922`)\"], \"Hive connector\": [\"Reduce the number of read requests for scanning small Parquet files. Add the\\n`parquet.small-file-threshold` configuration property and the\\n`parquet_small_file_threshold` session property to change the default size of\\n`3MB`, below which, files will be read in their entirety. Setting this\\nconfiguration to `0B` disables the feature. ({issue}`19127`)\"], \"Hudi connector\": [\"Reduce the number of read requests for scanning small Parquet files. Add the\\n`parquet.small-file-threshold` configuration property and the\\n`parquet_small_file_threshold` session property to change the default size of\\n`3MB`, below which, files will be read in their entirety. Setting this\\nconfiguration to `0B` disables the feature. ({issue}`19127`)\"], \"Iceberg connector\": [\"Reduce the number of read requests for scanning small Parquet files. Add the\\n`parquet.small-file-threshold` configuration property and the\\n`parquet_small_file_threshold` session property to change the default size of\\n`3MB`, below which, files will be read in their entirety. Setting this\\nconfiguration to `0B` disables the feature. ({issue}`19127`)\", \"Fix incorrect column statistics for the Parquet file format in manifest files. ({issue}`19052`)\"], \"Pinot connector\": [\"Add support for [query options](https://docs.pinot.apache.org/users/user-guide-query/query-options)\\nin dynamic tables. ({issue}`19078`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 301]\"}, {\"title\": \"Release 429 (11 Oct 2023)\", \"description\": null, \"content\": {\"General\": [\"Allow {doc}`/sql/show-functions` for a specific schema. ({issue}`19243`)\", \"Add security for function listing. ({issue}`19243`)\"], \"Security\": [\"Stop performing security checks for functions in the `system.builtin` schema. ({issue}`19160`)\", \"Remove support for using function kind as a rule in file-based access control. ({issue}`19160`)\"], \"Web UI\": [\"Log out from a Trino OAuth session when logging out from the Web UI. ({issue}`13060`)\"], \"Delta Lake connector\": [\"Allow using the `#` and `?` characters in S3 location paths or URLs. ({issue}`19296`)\"], \"Hive connector\": [\"Add support for changing a column's type from `varchar` to `date`. ({issue}`19201`)\", \"Add support for changing a column's type from `decimal` to `tinyint`,\\n`smallint`, `integer`, or `bigint` in partitioned Hive tables. ({issue}`19201`)\", \"Improve performance of reading ORC files. ({issue}`19295`)\", \"Allow using the `#` and `?` characters in S3 location paths or URLs. ({issue}`19296`)\", \"Fix error reading Avro files when a schema has uppercase characters in its\\nname. ({issue}`19249`)\"], \"Hudi connector\": [\"Allow using the `#` and `?` characters in S3 location paths or URLs. ({issue}`19296`)\"], \"Iceberg connector\": [\"Add support for specifying timestamp precision as part of\\n`CREATE TABLE AS .. SELECT` statements. ({issue}`13981`)\", \"Improve performance of reading ORC files. ({issue}`19295`)\", \"Allow using the `#` and `?` characters in S3 location paths or URLs. ({issue}`19296`)\"], \"MongoDB connector\": [\"Fix mixed case schema names being inaccessible when using custom roles and\\nthe `case-insensitive-name-matching` configuration property is enabled. ({issue}`19218`)\"], \"SPI\": [\"Change function security checks to return a boolean instead of throwing an\\nexception. ({issue}`19160`)\", \"Add SQL path field to `ConnectorViewDefinition`,\\n`ConnectorMaterializedViewDefinition`, and `ViewExpression`. ({issue}`19160`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 302]\"}, {\"title\": \"Release 430 (20 Oct 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of queries with `GROUP BY`. ({issue}`19302`)\", \"Fix incorrect results for queries involving `ORDER BY` and window functions\\nwith ordered frames. ({issue}`19399`)\", \"Fix incorrect results for query involving an aggregation in a correlated\\nsubquery. ({issue}`19002`)\"], \"Security\": [\"Enforce authorization capability of client when receiving commands `RESET` and\\n`SET` for `SESSION AUTHORIZATION`. ({issue}`19217`)\"], \"JDBC driver\": [\"Add support for a `timezone` parameter to set the session timezone. ({issue}`19102`)\"], \"Iceberg connector\": [\"Add an option to require filters on partition columns. This can be enabled by\\nsetting the ``iceberg.query-partition-filter-required`` configuration property\\nor the ``query_partition_filter_required`` session property. ({issue}`17263`)\", \"Improve performance when reading partition columns. ({issue}`19303`)\"], \"Ignite connector\": [\"Fix failure when a query contains `LIKE` with `ESCAPE`. ({issue}`19464`)\"], \"MariaDB connector\": [\"Add support for table statistics. ({issue}`19408`)\"], \"MongoDB connector\": [\"Fix incorrect results when a query contains several `<>` or `NOT IN`\\npredicates. ({issue}`19404`)\"], \"SPI\": [\"Change the Java stack type for a `map` value to `SqlMap` and a `row` value to\\n`SqlRow`, which do not implement `Block`. ({issue}`18948`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 303]\"}, {\"title\": \"Release 431 (27 Oct 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for [](/udf/sql). ({issue}`19308`)\", \"Add support for [](/sql/create-function) and [](/sql/drop-function) statements. ({issue}`19308`)\", \"Add support for the `REPLACE` modifier to the `CREATE TABLE` statement. ({issue}`13180`)\", \"Disallow a `null` offset for the {func}`lead` and {func}`lag` functions. ({issue}`19003`)\", \"Improve performance of queries with short running splits. ({issue}`19487`)\"], \"Security\": [\"Support defining rules for procedures in file-based access control. ({issue}`19416`)\", \"Mask additional sensitive values in log files. ({issue}`19519`)\"], \"JDBC driver\": [\"Improve latency for prepared statements for Trino versions that support\\n`EXECUTE IMMEDIATE` when the `explicitPrepare` parameter to is set to `false`.\\n({issue}`19541`)\"], \"Delta Lake connector\": [\"Replace the `hive.metastore-timeout` Hive metastore configuration property\\nwith the `hive.metastore.thrift.client.connect-timeout` and\\n`hive.metastore.thrift.client.read-timeout` properties. ({issue}`19390`)\"], \"Hive connector\": [\"Add support for [](udf-management). ({issue}`19308`)\", \"Replace the `hive.metastore-timeout` Hive metastore configuration property\\nwith the `hive.metastore.thrift.client.connect-timeout` and\\n`hive.metastore.thrift.client.read-timeout` properties. ({issue}`19390`)\", \"Improve support for concurrent updates of table statistics in Glue. ({issue}`19463`)\", \"Fix Hive view translation failures involving comparisons between char and\\nvarchar fields. ({issue}`18337`)\"], \"Hudi connector\": [\"Replace the `hive.metastore-timeout` Hive metastore configuration property\\nwith the `hive.metastore.thrift.client.connect-timeout` and\\n`hive.metastore.thrift.client.read-timeout` properties. ({issue}`19390`)\"], \"Iceberg connector\": [\"Add support for the `REPLACE` modifier to the `CREATE TABLE` statement. ({issue}`13180`)\", \"Replace the `hive.metastore-timeout` Hive metastore configuration property\\nwith the `hive.metastore.thrift.client.connect-timeout` and\\n`hive.metastore.thrift.client.read-timeout` properties. ({issue}`19390`)\"], \"Memory connector\": [\"Add support for [](udf-management). ({issue}`19308`)\"], \"SPI\": [\"Add `ValueBlock` abstraction along with `VALUE_BLOCK_POSITION` and\\n`VALUE_BLOCK_POSITION_NOT_NULL` calling conventions. ({issue}`19385`)\", \"Require a separate block position for each argument of aggregation functions.\\n({issue}`19385`)\", \"Require implementations of `Block` to implement `ValueBlock`. ({issue}`19480`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 304]\"}, {\"title\": \"Release 432 (2 Nov 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of `CREATE TABLE AS ... SELECT` queries that contain a redundant\\n`ORDER BY` clause. ({issue}`19547`)\", \"{{breaking}} Remove support for late materialization, including the\\n`experimental.late-materialization.enabled` and\\n`experimental.work-processor-pipelines` configuration properties. ({issue}`19611`)\", \"Fix potential query failure when using inline functions. ({issue}`19561`)\"], \"Docker image\": [\"Update Java runtime to Java 21. ({issue}`19553`)\"], \"CLI\": [\"Fix crashes when using Homebrew's version of the `stty` command. ({issue}`19549`)\"], \"Delta Lake connector\": [\"Improve performance of filtering on columns with long strings stored in\\nParquet files. ({issue}`19038`)\"], \"Hive connector\": [\"Improve performance of filtering on columns with long strings stored in\\nParquet files. ({issue}`19038`)\"], \"Iceberg connector\": [\"Add support for the `register_table` and `unregister_table` procedures with \\nthe REST catalog. ({issue}`15512`)\", \"Add support for the [`BEARER` authentication type](https://projectnessie.org/tools/client_config/)\\nfor connecting to the Nessie catalog. ({issue}`17725`)\", \"Improve performance of filtering on columns with long strings stored in\\nParquet files. ({issue}`19038`)\"], \"MongoDB connector\": [\"Add support for predicate pushdown on `real` and `double` types. ({issue}`19575`)\"], \"SPI\": [\"Add Trino version to SystemAccessControlContext. ({issue}`19585`)\", \"{{breaking}} Remove null-suppression from RowBlock fields. Add new factory methods to\\ncreate a `RowBlock`, and remove the old factory methods. ({issue}`19479`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 305]\"}, {\"title\": \"Release 433 (10 Nov 2023)\", \"description\": null, \"content\": {\"General\": [\"Improve planning time and resulting plan efficiency for queries involving\\n`UNION ALL` with `LIMIT`. ({issue}`19471`)\", \"Fix long query planning times for queries with multiple window functions. ({issue}`18491`)\", \"Fix resource groups not noticing updates to the `softMemoryLimit` if it is\\nchanged from a percent-based value to an absolute value. ({issue}`19626`)\", \"Fix potential query failure for queries involving arrays, `GROUP BY`,\\nor `DISTINCT`. ({issue}`19596`)\"], \"BigQuery connector\": [\"Fix incorrect results for queries involving projections and the `query` table\\nfunction. ({issue}`19570`)\"], \"Delta Lake connector\": [\"Fix query failure when reading ORC files with a `DECIMAL` column that\\ncontains only null values. ({issue}`19636`)\", \"Fix possible JVM crash when reading short decimal columns in Parquet files\\ncreated by Impala. ({issue}`19697`)\"], \"Hive connector\": [\"Add support for reading tables where a column's type has been changed from\\n`boolean` to `varchar`. ({issue}`19571`)\", \"Add support for reading tables where a column's type has been changed from\\n`varchar` to `double`. ({issue}`19517`)\", \"Add support for reading tables where a column's type has been changed from\\n`tinyint`, `smallint`, `integer`, or `bigint` to `double`. ({issue}`19520`)\", \"Add support for altering table comments in the Glue catalog. ({issue}`19073`)\", \"Fix query failure when reading ORC files with a `DECIMAL` column that\\ncontains only null values. ({issue}`19636`)\", \"Fix possible JVM crash when reading short decimal columns in Parquet files\\ncreated by Impala. ({issue}`19697`)\"], \"Hudi connector\": [\"Fix query failure when reading ORC files with a `DECIMAL` column that\\ncontains only null values. ({issue}`19636`)\", \"Fix possible JVM crash when reading short decimal columns in Parquet files\\ncreated by Impala. ({issue}`19697`)\"], \"Iceberg connector\": [\"Fix incorrect query results when querying Parquet files with dynamic filtering\\non `UUID` columns. ({issue}`19670`)\", \"Fix query failure when reading ORC files with a `DECIMAL` column that\\ncontains only null values. ({issue}`19636`)\", \"Fix possible JVM crash when reading short decimal columns in Parquet files\\ncreated by Impala. ({issue}`19697`)\", \"Prevent creation of separate entries for storage tables of materialized views.\\n({issue}`18853`)\"], \"SPI\": [\"Add JMX metrics for event listeners through\\n`trino.eventlistener:name=EventListenerManager`. ({issue}`19623`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 306]\"}, {\"title\": \"Release 434 (29 Nov 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for a `FILTER` clause to the `LISTAGG` function. ({issue}`19869`)\", \"{{breaking}} Rename the `query.max-writer-tasks-count` configuration property\\nand the related `max_writer_tasks_count` session property to\\n`query.max-writer-task-count` and `max_writer_task_count`. ({issue}`19793`)\", \"Improve performance of `INSERT ... SELECT` queries that contain a redundant\\n`ORDER BY` clause. ({issue}`19916`)\", \"Fix incorrect results for queries involving comparisons between `double` and\\n`real` zero and negative zero. ({issue}`19828`)\", \"Fix performance regression caused by suboptimal scalar subqueries planning. ({issue}`19922`)\", \"Fix failure when queries on data stored on HDFS involve table functions. ({issue}`19849`)\", \"Prevent sudden increases in memory consumption in some queries with\\njoins involving `UNNEST`. ({issue}`19762`)\"], \"BigQuery connector\": [\"Add support for reading `json` columns. ({issue}`19790`)\", \"Add support for `DELETE` statement. ({issue}`6870`)\", \"Improve performance when writing rows. ({issue}`18897`)\"], \"ClickHouse connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"Delta Lake connector\": [\"{{breaking}} Disallow invalid configuration options. Previously, they were\\nsilently ignored. ({issue}`19735`)\", \"Improve performance when reading large checkpoint files on partitioned tables.\\n({issue}`19588`, {issue}`19848`)\", \"Push down filters involving columns of type `timestamp(p) with time zone`. ({issue}`18664`)\", \"Fix query failure when reading Parquet column index for timestamp columns. ({issue}`16801`)\"], \"Druid connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"Hive connector\": [\"Add support for columns that changed from `timestamp` to `date` type. ({issue}`19513`)\", \"Fix query failure when reading Parquet column index for timestamp columns. ({issue}`16801`)\"], \"Hudi connector\": [\"Fix query failure when reading Parquet column index for timestamp columns. ({issue}`16801`)\"], \"Iceberg connector\": [\"{{breaking}} Remove support for legacy table statistics tracking. ({issue}`19803`)\", \"{{breaking}} Disallow invalid configuration options. Previously, they were\\nsilently ignored. ({issue}`19735`)\", \"Fix query failure when reading Parquet column index for timestamp columns. ({issue}`16801`)\", \"Don't set owner for Glue materialized views when system security is enabled. ({issue}`19681`)\"], \"Ignite connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"MariaDB connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"MySQL connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"Oracle connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"Phoenix connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"PostgreSQL connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\", \"Prevent possible query failures when join is pushed down. ({issue}`18984`)\"], \"Redshift connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\", \"Prevent possible query failures when join is pushed down. ({issue}`18984`)\"], \"SingleStore connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\"], \"SQL Server connector\": [\"Add support for separate metadata caching configuration for schemas, tables,\\nand metadata. ({issue}`19859`)\", \"Prevent possible query failures when join is pushed down. ({issue}`18984`)\"], \"SPI\": [\"Add bulk append methods to `BlockBuilder`. ({issue}`19577`)\", \"{{breaking}} Remove the `VariableWidthBlockBuilder.buildEntry` method. ({issue}`19577`)\", \"{{breaking}} Add required `ConnectorSession` parameter to the method\\n`TableFunctionProcessorProvider.getDataProcessor`. ({issue}`19778`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 307]\"}, {\"title\": \"Release 435 (13 Dec 2023)\", \"description\": null, \"content\": {\"General\": [\"Add support for the `json_table` table function. ({issue}`18017`)\", \"Reduce coordinator memory usage. ({issue}`20018`, {issue}`20022`)\", \"Increase reliability and memory consumption of inserts. ({issue}`20040`)\", \"Fix incorrect results for `LIKE` with some strings containing repeated\\nsubstrings. ({issue}`20089`)\", \"Fix coordinator memory leak. ({issue}`20023`)\", \"Fix possible query failure for `MERGE` queries when `retry-policy` set to\\n`TASK` and `query.determine-partition-count-for-write-enabled` set to `true`.\\n({issue}`19979`)\", \"Prevent hanging query processing with `retry.policy` set to `TASK` when a\\nworker node died. ({issue}`18603 `)\", \"Fix query failure when reading array columns. ({issue}`20065`)\"], \"Delta Lake connector\": [\"{{breaking}} Remove support for registering external tables with\\n`CREATE TABLE` and the `location` table property. Use the\\n`register_table` procedure as replacement. The property\\n`delta.legacy-create-table-with-existing-location.enabled` is\\nalso removed. ({issue}`17016`)\", \"Improve query planning performance on Delta Lake tables. ({issue}`19795`)\", \"Ensure AWS access keys are used for connections to the AWS Security Token\\nService. ({issue}`19982`)\", \"Reduce memory usage for inserts into partitioned tables. ({issue}`19649`)\", \"Improve reliability when reading from GCS. ({issue}`20003`)\", \"Fix failure when reading ORC data. ({issue}`19935`)\"], \"Elasticsearch connector\": [\"Ensure certificate validation is skipped when\\n`elasticsearch.tls.verify-hostnames` is `false`. ({issue}`20076`)\"], \"Hive connector\": [\"Add support for columns that changed from integer types to `decimal` type. ({issue}`19931`)\", \"Add support for columns that changed from `date` to `varchar` type. ({issue}`19500`)\", \"Rename `presto_version` table property to `trino_version`. ({issue}`19967`)\", \"Rename `presto_query_id` table property to `trino_query_id`. ({issue}`19967`)\", \"Ensure AWS access keys are used for connections to the AWS Security Token\\nService. ({issue}`19982`)\", \"Improve query planning time on Hive tables without statistics. ({issue}`20034`)\", \"Reduce memory usage for inserts into partitioned tables. ({issue}`19649`)\", \"Improve reliability when reading from GCS. ({issue}`20003`)\", \"Fix failure when reading ORC data. ({issue}`19935`)\"], \"Hudi connector\": [\"Ensure AWS access keys are used for connections to the AWS Security Token\\nService. ({issue}`19982`)\", \"Improve reliability when reading from GCS. ({issue}`20003`)\", \"Fix failure when reading ORC data. ({issue}`19935`)\"], \"Iceberg connector\": [\"Fix incorrect removal of statistics files when executing\\n`remove_orphan_files`. ({issue}`19965`)\", \"Ensure AWS access keys are used for connections to the AWS Security Token\\nService. ({issue}`19982`)\", \"Improve performance of metadata queries involving materialized views. ({issue}`19939`)\", \"Reduce memory usage for inserts into partitioned tables. ({issue}`19649`)\", \"Improve reliability when reading from GCS. ({issue}`20003`)\", \"Fix failure when reading ORC data. ({issue}`19935`)\"], \"Ignite connector\": [\"Improve performance of queries involving `OR` with `IS NULL`, `IS NOT NULL`\\npredicates, or involving `NOT` expression by pushing predicate computation to\\nthe Ignite database. ({issue}`19453`)\"], \"MongoDB connector\": [\"Allow configuration to use local scheduling of MongoDB splits with\\n`mongodb.allow-local-scheduling`. ({issue}`20078`)\"], \"SQL Server connector\": [\"Fix incorrect results when reading dates between `1582-10-05` and\\n`1582-10-14`. ({issue}`20005`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 308]\"}, {\"title\": \"Release 436 (11 Jan 2024)\", \"description\": null, \"content\": {\"General\": [\"{{breaking}} Require JDK 21.0.1 to run Trino, including updated\\n[](jvm-config). ({issue}`20010`)\", \"Improve performance by not generating redundant predicates. ({issue}`16520`)\", \"Fix query failure when invoking the `json_table` function. ({issue}`20122`)\", \"Fix query hang when a [](/udf/sql) dereferences a row field. ({issue}`19997`).\", \"Fix potential incorrect results when using the {func}`ST_Centroid` and\\n{func}`ST_Buffer` functions for tiny geometries. ({issue}`20237`)\"], \"Delta Lake connector\": [\"Add support for querying files with corrupt or incorrect statistics, which can\\nbe enabled with the `parquet_ignore_statistics` catalog session property. ({issue}`20228`)\", \"Improve performance of queries with selective joins on partition columns. ({issue}`20261`)\", \"Reduce the number of requests made to AWS Glue when listing tables, schemas,\\nor functions. ({issue}`20189`)\", \"Fix incorrect results when querying Parquet files containing column indexes\\nwhen the query has filters on multiple columns. ({issue}`20267`)\"], \"ElasticSearch connector\": [\"{{breaking}} Add support for ElasticSearch\\n[version 8](https://www.elastic.co/guide/en/elasticsearch/reference/current/es-release-notes.html),\\nand remove support for ElasticSearch version 6. ({issue}`20258`)\", \"Add [OpenSearch connector](/connector/opensearch). ({issue}`11377`)\"], \"Hive connector\": [\"Reduce the number of requests made to AWS Glue when listing tables, schemas,\\nor functions. ({issue}`20189`)\", \"Fix failure when reading certain Avro data with Union data types. ({issue}`20233`)\", \"Fix incorrect results when querying Parquet files containing column indexes\\nwhen the query has filters on multiple columns. ({issue}`20267`)\"], \"Hudi connector\": [\"Add support for enforcing that a filter on a partition key must be present in\\nthe query. This can be enabled by with the\\n``hudi.query-partition-filter-required`` configuration property or the\\n``query_partition_filter_required`` catalog session property. ({issue}`19906`)\", \"Fix incorrect results when querying Parquet files containing column indexes\\nwhen the query has filters on multiple columns. ({issue}`20267`)\"], \"Iceberg connector\": [\"Add support for querying files with corrupt or incorrect statistics, which can\\nbe enabled with the `parquet_ignore_statistics` catalog session property. ({issue}`20228`)\", \"Improve performance of queries with selective joins on partition columns. ({issue}`20212`)\", \"Reduce the number of requests made to AWS Glue when listing tables, schemas,\\nor functions. ({issue}`20189`)\", \"Fix potential loss of data when running multiple `INSERT` queries at the same\\ntime. ({issue}`20092`)\", \"Fix incorrect results when providing a nonexistent namespace while listing\\nnamespaces. ({issue}`19980`)\", \"Fix predicate pushdown not running for Parquet files when columns have been\\nrenamed. ({issue}`18855`)\"], \"SQL Server connector\": [\"Fix incorrect results for `DATETIMEOFFSET` values before the year 1400. ({issue}`16559`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 309]\"}, {\"title\": \"Release 437 (24 Jan 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for `char(n)` values in {func}`to_utf8`. ({issue}`20158`)\", \"Add support for `char(n)` values in {func}`lpad`. ({issue}`16907`)\", \"{{breaking}} Replace the `exchange.compression-enabled` configuration property\\nand `exchange_compression` session property with\\n[the `exchange.compression-codec`and `exchange_compression_codec` properties](prop-exchange-compression-codec),\\nrespectively. ({issue}`20274`)\", \"{{breaking}} Replace the `spill-compression-enabled` configuration property \\nwith [the `spill-compression-codec` property](prop-spill-compression-codec). ({issue}`20274`)\", \"{{breaking}} Remove the deprecated `experimental.spill-compression-enabled`\\nconfiguration property. ({issue}`20274`)\", \"Fix failure when invoking functions that may return null values. ({issue}`18456`)\", \"Fix `ArrayIndexOutOfBoundsException` with RowBlockBuilder during output\\noperations. ({issue}`20426`)\"], \"Delta Lake connector\": [\"Improve query performance for queries that don't use table statistics. ({issue}`20054`)\"], \"Hive connector\": [\"Fix error when coercing union-typed data to a single type when reading Avro\\nfiles. ({issue}`20310`)\"], \"Iceberg connector\": [\"Fix materialized views being permanently stale when they reference\\n[table functions](/functions/table). ({issue}`19904`)\", \"Improve performance of queries with filters on `ROW` columns stored in Parquet\\nfiles. ({issue}`17133`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 310]\"}, {\"title\": \"Release 438 (1 Feb 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for using types such as `char`, `varchar`, `uuid`, `ip_address`,\\n`geometry`, and others with the {func}`reduce_agg` function. ({issue}`20452`)\", \"Fix query failure when using `char` types with the {func}`reverse` function. ({issue}`20387`)\", \"Fix potential query failure when using the {func}`max_by` function on large\\ndatasets. ({issue}`20524`)\", \"Fix query failure when querying data with deeply nested rows. ({issue}`20529`)\"], \"Security\": [\"Add support for access control with\\n[Open Policy Agent](/security/opa-access-control). ({issue}`19532`)\"], \"Delta Lake connector\": [\"Add support for configuring the maximum number of values per page when writing\\nto Parquet files with the `parquet.writer.page-value-count` configuration\\nproperty or the `parquet_writer_page_value_count` session property. ({issue}`20171`)\", \"Add support for `ALTER COLUMN ... DROP NOT NULL` statements. ({issue}`20448`)\"], \"Hive connector\": [\"Add support for configuring the maximum number of values per page when writing\\nto Parquet files with the `parquet.writer.page-value-count` configuration\\nproperty or the `parquet_writer_page_value_count` session property. ({issue}`20171`)\"], \"Iceberg connector\": [\"Add support for `ALTER COLUMN ... DROP NOT NULL` statements. ({issue}`20315`)\", \"Add support for configuring the maximum number of values per page when writing\\nto Parquet files with the `parquet.writer.page-value-count` configuration\\nproperty or the `parquet_writer_page_value_count` session property. ({issue}`20171`)\", \"Add support for `array`, `map` and `row` types in the `migrate` table\\nprocedure. ({issue}`17583`)\"], \"Pinot connector\": [\"Add support for the `date` type. ({issue}`13059`)\"], \"PostgreSQL connector\": [\"Add support for `ALTER COLUMN ... DROP NOT NULL` statements. ({issue}`20315`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 311]\"}, {\"title\": \"Release 439 (15 Feb 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix failure when setting session properties for a catalog with a `.` in its\\nname. ({issue}`20474`)\", \"Fix potential out-of-memory query failures when using the experimental scheduler. ({issue}`20694`)\", \"Fix potential performance regression when dynamic filters are not applied. ({issue}`20709`)\"], \"BigQuery connector\": [\"Fix failure when pushing down predicates into BigQuery views. ({issue}`20627`)\"], \"Delta Lake connector\": [\"Improve performance when reading data by adding support for\\n[caching data on local storage](/object-storage/file-system-cache). ({issue}`18719`)\", \"Fix potential crash when reading corrupted Snappy data. ({issue}`20631`)\"], \"Hive connector\": [\"{{breaking}} Improve performance of caching data on local storage. Deprecate\\nthe `hive.cache.enabled` configuration property in favor of \\n[`fs.cache.enabled`](/object-storage/file-system-cache). ({issue}`20658`, {issue}`20102`)\", \"Fix query failure when a value has not been specified for the\\n`orc_bloom_filter_fpp` table property. ({issue}`16589`)\", \"Fix potential query failure when writing ORC files. ({issue}`20587`)\", \"Fix potential crash when reading corrupted Snappy data. ({issue}`20631`)\"], \"Hudi connector\": [\"Fix potential crash when reading corrupted Snappy data. ({issue}`20631`)\"], \"Iceberg connector\": [\"Improve performance when reading data by adding support for\\n[caching data on local storage](/object-storage/file-system-cache). ({issue}`20602`)\", \"Fix query failure when a value has not been specified for the\\n`orc_bloom_filter_fpp` table property. ({issue}`16589`)\", \"Fix potential query failure when writing ORC files. ({issue}`20587`)\", \"Fix potential crash when reading corrupted Snappy data. ({issue}`20631`)\"], \"Redshift connector\": [\"Fix potential crash when reading corrupted Snappy data. ({issue}`20631`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 312]\"}, {\"title\": \"Release 440 (8 Mar 2024)\", \"description\": null, \"content\": {\"General\": [\"Add [Snowflake connector](/connector/snowflake). ({issue}`17909`)\", \"Add support for sub-queries inside `UNNEST` clauses. ({issue}`17953`)\", \"Improve performance of {func}`arrays_overlap`. ({issue}`20900`)\", \"Export JMX statistics for resource groups by default. This can be disabled\\nwith the `jmxExport` resource group property. ({issue}`20810`)\", \"{{breaking}} Remove the defunct `*.http-client.max-connections` properties.\\n({issue}`20966`)\", \"Fix query failure when a check constraint is null. ({issue}`20906`)\", \"Fix query failure for aggregations over `CASE` expressions when the input\\nevaluation could throw an error. ({issue}`20652`)\", \"Fix incorrect behavior of the else clause in a SQL UDFs with a single\\nif/end condition. ({issue}`20926`)\", \"Fix the `ALTER TABLE EXECUTE optimize` queries failing due to exceeding the\\nopen writer limit. ({issue}`20871`)\", \"Fix certain `INSERT` and `CREATE TABLE AS .. SELECT` queries failing due to\\nexceeding the of open writer limit on partitioned tables. ({issue}`20871`)\", \"Fix \\\"multiple entries with same key\\\" query failure for queries with joins on\\npartitioned tables. ({issue}`20917`)\", \"Fix incorrect results when using `GRANT`, `DENY`, and `REVOKE` clauses on\\nviews and materialized views. ({issue}`20812`)\"], \"Security\": [\"Add support for row filtering and column masking in Open Policy Agent access\\ncontrol. ({issue}`20921`)\"], \"Web UI\": [\"Fix error when using authentication tokens larger than 4 kB. ({issue}`20787`)\"], \"Delta Lake connector\": [\"Add support for concurrent `INSERT` queries. ({issue}`18506`)\", \"Improve latency for queries with file system caching enabled. ({issue}`20851`)\", \"Improve latency for queries on tables with checkpoints. ({issue}`20901`)\", \"Fix query failure due to \\\"corrupted statistics\\\" when reading Parquet files\\nwith a predicate on a long decimal column. ({issue}`20981`)\"], \"Hive connector\": [\"Add support for bearer token authentication for a Thrift metastore connection. ({issue}`20371`)\", \"Add support for commenting on partitioned columns in the Thrift metastore. ({issue}`20264`)\", \"Add support for changing a column's type from `varchar` to `float`. ({issue}`20719`)\", \"Add support for changing a column's type from `varchar` to `char`. ({issue}`20723`)\", \"Add support for changing a column's type from `varchar` to `boolean`. ({issue}`20741`)\", \"Add support for configuring a `region` and `endpoint` for S3 security mapping. ({issue}`18838`)\", \"Improve performance when reading JSON files. ({issue}`19396`)\", \"Fix incorrect truncation when decoding `varchar(n)` and `char(n)` in\\n`TEXTFILE` and `SEQUENCEFILE` formats. ({issue}`20731`)\", \"Fix query failure when `hive.file-status-cache-tables` is enabled for a table\\nand new manifest files have been added but not cached yet. ({issue}`20344`)\", \"Fix error when trying to `INSERT` into a transactional table that does not\\nhave partitions. ({issue}`19407`)\", \"Fix query failure due to \\\"corrupted statistics\\\" when reading Parquet files\\nwith a predicate on a long decimal column. ({issue}`20981`)\"], \"Hudi connector\": [\"Fix query failure due to \\\"corrupted statistics\\\" when reading Parquet files\\nwith a predicate on a long decimal column. ({issue}`20981`)\"], \"Iceberg connector\": \"```\\nThis release has a major regression which is fixed in Trino 442.\\n```\\n\\n['Improve latency of queries when file system caching is enabled. ({issue}`20803`)', 'Disallow setting the materialized view owner when using system security with\\\\nthe Glue catalog. ({issue}`20647`)', 'Rename the `orc.bloom.filter.columns` and `orc.bloom.filter.fpp` table\\\\nproperties to `write.orc.bloom.filter.columns` and\\\\n`write.orc.bloom.filter.fpp`, respectively. ({issue}`20432`)', 'Fix query failure due to \\\"corrupted statistics\\\" when reading Parquet files\\\\nwith a predicate on a long decimal column. ({issue}`20981`)']\", \"SPI\": [\"Add reset to position method to `BlockBuilder`. ({issue}`19577`)\", \"Remove the `getChildren` method from `Block`. ({issue}`19577`)\", \"Remove the `get{Type}` methods from `Block`. Callers must unwrap a `Block`\\nand downcast the `ValueBlock` to `Type.getValueBlockType()` implementation. ({issue}`19577`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 313]\"}, {\"title\": \"Release 441 (13 Mar 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix incorrect results of window aggregations when any input data includes \\n`NaN` or infinity. ({issue}`20946`)\", \"Fix `NoSuchMethodError` in filtered aggregations. ({issue}`21002`)\"], \"Cassandra connector\": [\"Fix incorrect results when a query contains predicates on clustering columns. ({issue}`20963`)\"], \"Hive connector\": [\"{{breaking}} Remove the default `legacy` mode for the `hive.security`\\nconfiguration property, and change the default value to `allow-all`.\\nAdditionally, remove the legacy properties `hive.allow-drop-table`,\\n`hive.allow-rename-table`, `hive.allow-add-column`, `hive.allow-drop-column`,\\n`hive.allow-rename-column`, `hive.allow-comment-table`, and\\n`hive.allow-comment-column`. ({issue}`21013`)\", \"Fix query failure when reading array types from Parquet files produced by some\\nlegacy writers. ({issue}`20943`)\"], \"Hudi connector\": [\"Disallow creating files on non-existent partitions. ({issue}`20133`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 314]\"}, {\"title\": \"Release 442 (14 Mar 2024)\", \"description\": null, \"content\": {\"Delta Lake connector\": [\"Fix query failure when a partition value contains forward slash characters. ({issue}`21030`)\"], \"Hive connector\": [\"Restore support for `SymlinkTextInputFormat` for text formats. ({issue}`21092`)\"], \"Iceberg connector\": [\"Fix large queries failing with a `NullPointerException`. ({issue}`21074`)\"], \"OpenSearch connector\": [\"Add support for configuring AWS deployment type with the\\n`opensearch.aws.deployment-type` configuration property. ({issue}`21059`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 315]\"}, {\"title\": \"Release 443 (21 Mar 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix formatting of casts from double or real to varchar when running with\\nnon-US locales. ({issue}`21136`)\", \"Prevent query failure when partial aggregation over decimals with precision\\nlarger than 18 below joins. ({issue}`21099`)\"], \"Delta Lake connector\": [\"Automatically use `timestamp(6)` as type during table creation when other\\ntimestamp precision is specified. ({issue}`19336`)\", \"Ensure all files are deleted when native S3 file system support is enabled. ({issue}`21111`)\"], \"Hive connector\": [\"Reduce coordinator CPU and memory usage. ({issue}`21075`)\", \"Prevent failures when listing columms of a table that is concurrently dropped\\nand `sql-standard` authorization is used. ({issue}`21109`)\", \"Ensure all files are deleted when native S3 file system support is enabled. ({issue}`21111`)\"], \"Hudi connector\": [\"Ensure all files are deleted when native S3 file system support is enabled. ({issue}`21111`)\"], \"Iceberg connector\": [\"Improve storage table cleanup when creating a materialized view fails. ({issue}`20837`)\", \"Fix dropping materialized views created before Trino 433 when using a Hive\\nmetastore. ({issue}`20837`)\", \"Fix support for trailing slashes for the `table_location` specified with the\\n`register_table` procedure. ({issue}`19143`)\", \"Ensure all files are deleted when native S3 file system support is enabled. ({issue}`21111`)\"], \"Prometheus connector\": [\"Add support for a custom authorization header name. ({issue}`21187`)\"], \"SPI\": [\"Add catalog store support for dynamic catalog storage implementation in\\nconnector plugins. ({issue}`21114`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 316]\"}, {\"title\": \"Release 444 (3 Apr 2024)\", \"description\": null, \"content\": {\"General\": [\"Improve planning time for queries with a large number of joins. ({issue}`21360`)\", \"Fix failure for queries containing large numbers of `LIKE` terms in boolean\\nexpressions. ({issue}`21235`)\", \"Fix potential failure when queries contain filtered aggregations. ({issue}`21272`)\"], \"Docker image\": [\"Update Java runtime to Java 22. ({issue}`21161`)\"], \"BigQuery connector\": [\"Fix failure when reading BigQuery views with [Apache\\nArrow](https://arrow.apache.org/docs/). ({issue}`21337`)\"], \"ClickHouse connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"Delta Lake connector\": [\"Add support for reading `BYTE_STREAM_SPLIT` encoding in Parquet files. ({issue}`8357`)\", \"Add support for [Canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)\\nwith the native S3 file system. ({issue}`21176`)\", \"Add support for concurrent, non-conflicting writes when a table is read and\\nwritten to in the same query. ({issue}`20983`)\", \"Add support for reading tables with [v2\\ncheckpoints](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#v2-spec).\\n({issue}`19345`)\", \"Add support for reading [shallow cloned tables](delta-lake-shallow-clone).\\n({issue}`17011`)\", \"{{breaking}} Remove support for split size configuration with the catalog\\nproperties `delta.max-initial-splits` and `delta.max-initial-split-size`, and\\nthe catalog session property `max_initial_split_size`. ({issue}`21320`)\", \"Fix incorrect results when querying a table that's being modified\\nconcurrently. ({issue}`21324`)\"], \"Druid connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"Hive connector\": [\"Add support for reading `BYTE_STREAM_SPLIT` encoding in Parquet files. ({issue}`8357`)\", \"Add support for [Canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)\\nwith the native S3 file system. ({issue}`21176`)\"], \"Hudi connector\": [\"Add support for reading `BYTE_STREAM_SPLIT` encoding in Parquet files. ({issue}`8357`)\", \"Add support for [Canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)\\nwith the native S3 file system. ({issue}`21176`)\"], \"Iceberg connector\": [\"Add support for the `metadata_log_entries` system table. ({issue}`20410`)\", \"Add support for reading `BYTE_STREAM_SPLIT` encoding in Parquet files. ({issue}`8357`)\", \"Add support for [Canned ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/acl-overview.html#canned-acl)\\nwith the native S3 file system. ({issue}`21176`)\"], \"Ignite connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"MariaDB connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"MySQL connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"Oracle connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"PostgreSQL connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"Redshift connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"SingleStore connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"Snowflake connector\": [\"Add support for table comments. ({issue}`21305`)\", \"Improve performance of queries with `ORDER BY ... LIMIT` clause, or `avg`,\\n`count(distinct)`, `stddev`, or `stddev_pop` aggregation functions when the\\ncomputation can be pushed down to the underlying database. ({issue}`21219`,\\n{issue}`21148`, {issue}`21130`, {issue}`21338`)\", \"Improve performance of reading table comments. ({issue}`21161`)\"], \"SQLServer connector\": [\"Improve performance of reading table comments. ({issue}`21238`)\"], \"SPI\": [\"Change group id and capacity of `GroupedAccumulatorState` to `int` type. ({issue}`21333`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 317]\"}, {\"title\": \"Release 445 (17 Apr 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for large constant arrays. ({issue}`21566`)\", \"Add the `query.dispatcher-query-pool-size` configuration property to prevent\\nthe coordinator from hanging when too many queries are being executed at once. ({issue}`20817`)\", \"Improve performance of queries selecting only catalog, schema, and name from\\nthe `system.metadata.materialized_views` table. ({issue}`21448`)\", \"{{breaking}} Remove the deprecated `legacy.materialized-view-grace-period`\\nconfiguration property. ({issue}`21474`)\", \"Increase the number of columns supported by `MERGE` queries before failing\\nwith a `MethodTooLargeException` error. ({issue}`21299`)\", \"Fix potential query hang when there is an error processing data. ({issue}`21397`)\", \"Fix possible worker crashes when running aggregation queries due to\\nout-of-memory error. ({issue}`21425`)\", \"Fix incorrect results when performing aggregations over null values. ({issue}`21457`)\", \"Fix failure for queries containing expressions involving types that do\\nnot support the `=` operator (e.g., `HyperLogLog`, `Geometry`, etc.). ({issue}`21508`)\", \"Fix incorrect results for distinct count aggregations over a constant value. ({issue}`18562`)\", \"Fix sporadic query failure when filesystem caching is enabled. ({issue}`21342`)\", \"Fix unexpected failure for join queries containing predicates that might raise\\nan error for some inputs. ({issue}`21521`)\"], \"BigQuery connector\": [\"Add support for reading materialized views. ({issue}`21487`)\", \"Add support for using filters when materializing BigQuery views. ({issue}`21488`)\"], \"Delta Lake connector\": [\"Add support for [time travel](delta-time-travel) queries. ({issue}`21052`)\", \"Add support for the `REPLACE` modifier as part of a `CREATE TABLE` statement. ({issue}`13180`) ({issue}`19991`)\"], \"Hive connector\": [\"Add support for creating views with custom properties. ({issue}`21401`)\", \"Add support for writing Bloom filters in Parquet files. ({issue}`20662`)\", \"{{breaking}} Remove the deprecated `PARTITION_COLUMN` and `PARTITION_VALUE`\\narguments from the `flush_metadata_cache` procedure in favor of\\n`PARTITION_COLUMNS` and `PARTITION_VALUES`. ({issue}`21410`)\"], \"Iceberg connector\": [\"Deprecate the `iceberg.materialized-views.hide-storage-table` configuration\\nproperty. ({issue}`21485`)\"], \"MongoDB connector\": [\"Add support for [dynamic filtering](/admin/dynamic-filtering). ({issue}`21355`)\"], \"MySQL connector\": [\"Improve performance of queries with `timestamp(n)` values. ({issue}`21244`)\"], \"PostgreSQL connector\": [\"Improve performance of queries with `timestamp(n)` values. ({issue}`21244`)\"], \"Redis connector\": [\"Upgrade minimum required Redis version to 5.0.14 or later. ({issue}`21455`)\"], \"Snowflake connector\": [\"Add support for pushing down execution of the `variance`, `var_pop`,\\n`var_samp`,`covar_pop`, `covar_samp`, `corr`, `regr_intercept`, and\\n`regr_slope` functions to the underlying database. ({issue}`21384`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 318]\"}, {\"title\": \"Release 446 (1 May 2024)\", \"description\": null, \"content\": {\"General\": [\"Improve performance of `INSERT` statements into partitioned tables when the\\n`retry_policy` configuration property is set to `TASK`. ({issue}`21661 `)\", \"Improve performance of queries with complex grouping operations. ({issue}`21726`)\", \"Reduce delay before killing queries when the cluster runs out of memory. ({issue}`21719`)\", \"Prevent assigning null values to non-null columns as part of a `MERGE`\\nstatement. ({issue}`21619`)\", \"Fix `CREATE CATALOG` statements including quotes in catalog names. ({issue}`21399`)\", \"Fix potential query failure when a column name ends with a `:`. ({issue}`21676`)\", \"Fix potential query failure when a [](/udf/sql) contains a label\\nreference in a `LEAVE`, `ITERATE`, `REPEAT`, or `WHILE` statement. ({issue}`21682`)\", \"Fix query failure when [](/udf/sql) use the `NULLIF` or `BETWEEN`\\nfunctions. ({issue}`19820`)\", \"Fix potential query failure due to worker nodes running out of memory in\\nconcurrent scenarios. ({issue}`21706`)\"], \"BigQuery connector\": [\"Improve performance when listing table comments. ({issue}`21581`)\", \"{{breaking}} Enable `bigquery.arrow-serialization.enabled` by default. This\\nrequires `--add-opens=java.base/java.nio=ALL-UNNAMED` in\\n`jvm-config`. ({issue}`21580`)\"], \"Delta Lake connector\": [\"Fix failure when reading from Azure file storage and the schema, table, or\\ncolumn name contains non-alphanumeric characters. ({issue}`21586`)\", \"Fix incorrect results when reading a partitioned table with a\\n[deletion vector](https://docs.delta.io/latest/delta-deletion-vectors.html). ({issue}`21737`)\"], \"Hive connector\": [\"Add support for reading S3 objects restored from Glacier storage. ({issue}`21164`)\", \"Fix failure when reading from Azure file storage and the schema, table, or\\ncolumn name contains non-alphanumeric characters. ({issue}`21586`)\", \"Fix failure when listing Hive views with unsupported syntax. ({issue}`21748`)\"], \"Iceberg connector\": [\"Add support for the [Snowflake catalog](iceberg-snowflake-catalog). ({issue}`19362`)\", \"Automatically use `varchar` as a type during table creation when `char` is\\nspecified. ({issue}`19336`, {issue}`21515`)\", \"Deprecate the `schema` and `table` arguments for the `table_changes` function\\nin favor of `schema_name` and `table_name`, respectively. ({issue}`21698`)\", \"Fix failure when executing the `migrate` procedure with partitioned Hive\\ntables on Glue. ({issue}`21391`)\", \"Fix failure when reading from Azure file storage and the schema, table, or\\ncolumn name contains non-alphanumeric characters. ({issue}`21586`)\"], \"Pinot connector\": [\"Fix query failure when a predicate contains a `'`. ({issue}`21681`)\"], \"Snowflake connector\": [\"Add support for the `unsupported-type-handling` and\\n`jdbc-types-mapped-to-varchar` type mapping configuration properties. ({issue}`21528`)\"], \"SPI\": [\"Remove support for `@RemoveInput` as an annotation for aggregation functions.\\nA `WindowAggregation` can be declared in `@AggregationFunction` instead, which\\nsupports input removal. ({issue}`21349`)\", \"Extend `QueryCompletionEvent` with various aggregated, per-stage, per-task\\ndistribution statistics. New information is available in\\n`QueryCompletedEvent.statistics.taskStatistics`. ({issue}`21694`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 319]\"}, {\"title\": \"Release 447 (8 May 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for [](/sql/show-create-function). ({issue}`21809`)\", \"Add support for the {func}`bitwise_xor_agg` aggregation function. ({issue}`21436`)\", \"{{breaking}} Require JDK 22 to run Trino, including updated [](jvm-config).({issue}`20980`)\", \"Improve performance of `ORDER BY` queries with `LIMIT` on large data sets. ({issue}`21761`)\", \"Improve performance of queries containing the {func}`rank` or\\n{func}`row_number` window functions. ({issue}`21639`)\", \"Improve performance of correlated queries with `EXISTS`. ({issue}`21422`)\", \"Fix potential failure for expressions involving `try_cast(parse_json(...))`. ({issue}`21877`)\"], \"CLI\": [\"Fix incorrect error location markers for SQL UDFs causing the CLI to print\\nexceptions. ({issue}`21357`)\"], \"Delta Lake connector\": [\"Add support for concurrent `DELETE` and `TRUNCATE` queries. ({issue}`18521`)\", \"Fix under-accounting of memory usage when writing strings to Parquet files. ({issue}`21745`)\"], \"Hive connector\": [\"Add support for metastore caching on tables that have not been analyzed, which\\ncan be enabled with the `hive.metastore-cache.cache-missing-stats` and\\n`hive.metastore-cache.cache-missing-partitions` configuration properties. ({issue}`21822`)\", \"Fix under-accounting of memory usage when writing strings to Parquet files. ({issue}`21745`)\", \"Fix failure when translating Hive views that contain `EXISTS` clauses. ({issue}`21829`)\"], \"Hudi connector\": [\"Fix under-accounting of memory usage when writing strings to Parquet files. ({issue}`21745`)\"], \"Iceberg connector\": [\"Fix under-accounting of memory usage when writing strings to Parquet files. ({issue}`21745`)\"], \"Phoenix connector\": [\"{{breaking}} Remove support for Phoenix versions 5.1.x and earlier. ({issue}`21569`)\"], \"Pinot connector\": [\"Add support for specifying an explicit broker URL with the `pinot.broker-url`\\nconfiguration property. ({issue}`17791`)\"], \"Redshift connector\": [\"{{breaking}} Remove deprecated legacy type mapping and the associated\\n`redshift.use-legacy-type-mapping` configuration property. ({issue}`21855`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 320]\"}, {\"title\": \"Release 448 (15 May 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix query failure when reading columns with names that contain only\\nnon-alphanumeric characters. ({issue}`21833`)\", \"Fix potential incorrect results for queries with complex predicates. ({issue}`21887`)\", \"Fix potential loss of a query completion event when multiple queries fail at\\nthe same time. ({issue}`21896`)\", \"Fix startup failure when fault-tolerant execution is enabled with Google\\nCloud Storage exchange. ({issue}`21951`)\", \"Fix potential failure when queries contain `try_cast`. ({issue}`21952`)\", \"Fix graceful shutdown potentially hanging indefinitely when a worker node has\\ncrashed. ({issue}`18329`)\"], \"Delta Lake connector\": [\"Add support for caching Glue metadata. ({issue}`20657`)\", \"Update Glue to V2 REST interface. The old implementation can be temporarily\\nrestored by setting the `hive.metastore` configuration property to `glue-v1`. ({issue}`20657`)\", [\"{{breaking}} The new implementation does not support and ignores the following\\nconfiguration properties: `hive.metastore-refresh-interval`,\\n`hive.metastore-refresh-max-threads`, `hive.metastore-cache.cache-partitions`,\\n`hive.metastore-cache.cache-missing`, `hive.metastore-cache.cache-missing-partitions`,\\n`hive.metastore-cache.cache-missing-stats`.\"], \"Improve performance of reading from Parquet files. ({issue}`21465`)\"], \"Hive connector\": [\"Add support for reading integers and timestamps in Parquet files as `DOUBLE`\\nand `VARCHAR` columns, respectively, in Trino. ({issue}`21509`)\", \"Add support for caching Glue metadata. ({issue}`20657`)\", \"Update Glue to V2 REST interface. The old implementation can be temporarily\\nrestored by setting the `hive.metastore` configuration property to `glue-v1`. ({issue}`20657`)\", [\"{{breaking}} The new implementation does not support and ignores the following\\nconfiguration properties: `hive.metastore-refresh-interval`,\\n`hive.metastore-refresh-max-threads`, `hive.metastore-cache.cache-partitions`,\\n`hive.metastore-cache.cache-missing`, `hive.metastore-cache.cache-missing-partitions`,\\n`hive.metastore-cache.cache-missing-stats`.\"], \"Improve performance of reading from Parquet files. ({issue}`21465`)\", \"Fix potential failure when reading ORC files larger than 2GB. ({issue}`21587`)\"], \"Hudi connector\": [\"Improve performance of reading from Parquet files. ({issue}`21465`)\", \"Fix potential failure when reading ORC files larger than 2GB. ({issue}`21587`)\", \"Update Glue to V2 REST interface. The old implementation can be temporarily\\nrestored by setting the `hive.metastore` configuration property to `glue-v1`. ({issue}`20657`)\", [\"{{breaking}} The new implementation does not support and ignores the following\\nconfiguration properties: `hive.metastore-refresh-interval`,\\n`hive.metastore-refresh-max-threads`, `hive.metastore-cache.cache-partitions`,\\n`hive.metastore-cache.cache-missing`, `hive.metastore-cache.cache-missing-partitions`,\\n`hive.metastore-cache.cache-missing-stats`.\"]], \"Iceberg connector\": [\"Improve performance of reading from Parquet files. ({issue}`21465`)\", \"Fix potential failure when reading ORC files larger than 2GB. ({issue}`21587`)\"], \"Phoenix connector\": [\"Remove incorrect type mapping for `TIME` values. ({issue}`21879`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 321]\"}, {\"title\": \"Release 449 (31 May 2024)\", \"description\": null, \"content\": {\"General\": [\"Add [OpenLineage event listener](/admin/event-listeners-openlineage). ({issue}`21265`)\", \"Fix rare query failure or incorrect results for array types when the data is\\ndictionary encoded. ({issue}`21911`)\", \"Fix JMX metrics not exporting for resource groups. ({issue}`21343`)\"], \"BigQuery connector\": [\"Improve performance when listing schemas while the\\n`bigquery.case-insensitive-name-matching` configuration property is enabled. ({issue}`22033`)\"], \"ClickHouse connector\": [\"Add support for pushing down execution of the `count(distinct)`, `corr`,\\n`covar_samp`, and `covar_pop` functions to the underlying database. ({issue}`7100`)\", \"Improve performance when pushing down equality predicates on textual types. ({issue}`7100`)\"], \"Delta Lake connector\": [\"Add support for [the `$partitions` system table](delta-lake-partitions-table). ({issue}`18590`)\", \"Add support for reading from and writing to tables with\\n[VACUUM Protocol Check](https://github.com/delta-io/delta/blob/master/PROTOCOL.md#vacuum-protocol-check). ({issue}`21398`)\", \"Add support for configuring the request retry policy on the native S3\\nfilesystem with the `s3.retry-mode` and `s3.max-error-retries` configuration\\nproperties. ({issue}`21900`)\", \"Automatically use `timestamp(6)` in struct types as a type during table creation\\nwhen `timestamp` is specified. ({issue}`21511`)\", \"Improve performance of writing data files. ({issue}`22089`)\", \"Fix query failure when the `hive.metastore.glue.catalogid` configuration\\nproperty is set. ({issue}`22048`)\"], \"Hive connector\": [\"Add support for specifying a catalog name in the Thrift metastore with the\\n`hive.metastore.thrift.catalog-name` configuration property. ({issue}`10287`)\", \"Add support for configuring the request retry policy on the native S3\\nfilesystem with the `s3.retry-mode` and `s3.max-error-retries` configuration\\nproperties. ({issue}`21900`)\", \"Improve performance of writing to Parquet files. ({issue}`22089`)\", \"Allow usage of filesystem caching on the Trino coordinator when\\n`node-scheduler.include-coordinator` is enabled. ({issue}`21987`)\", \"Fix failure when listing Hive tables with unsupported syntax. ({issue}`21981`)\", \"Fix query failure when the `hive.metastore.glue.catalogid` configuration\\nproperty is set. ({issue}`22048`)\", \"Fix failure when running the `flush_metadata_cache` table procedure with the\\nGlue v2 metastore. ({issue}`22075`)\"], \"Hudi connector\": [\"Add support for configuring the request retry policy on the native S3\\nfilesystem with the `s3.retry-mode` and `s3.max-error-retries` configuration\\nproperties. ({issue}`21900`)\"], \"Iceberg connector\": [\"Add support for views when using the Iceberg REST catalog. ({issue}`19818`)\", \"Add support for configuring the request retry policy on the native S3\\nfilesystem with the `s3.retry-mode` and `s3.max-error-retries` configuration\\nproperties. ({issue}`21900`)\", \"Automatically use `varchar` in struct types as a type during table creation\\nwhen `char` is specified. ({issue}`21511`)\", \"Automatically use microsecond precision for temporal types in struct types\\nduring table creation. ({issue}`21511`)\", \"Improve performance and memory usage when\\n[equality delete](https://iceberg.apache.org/spec/#equality-delete-files)\\nfiles are used. ({issue}`18396`)\", \"Improve performance of writing to Parquet files. ({issue}`22089`)\", \"Fix failure when writing to tables with Iceberg `VARBINARY` values. ({issue}`22072`)\"], \"Pinot connector\": [\"{{breaking}} Remove support for non-gRPC clients and the `pinot.grpc.enabled`\\nand `pinot.estimated-size-in-bytes-for-non-numeric-column` configuration\\nproperties. ({issue}`22213`)\"], \"Snowflake connector\": [\"Fix incorrect type mapping for numeric values. ({issue}`20977`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 322]\"}, {\"title\": \"Release 450 (19 Jun 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for specifying an Azure blob endpoint for accessing spooling in\\nfault-tolerant execution with the `exchange.azure.endpoint` configuration\\nproperty. ({issue}`22218`)\", \"Expose driver execution statistics via JMX. ({issue}`22427`)\", \"Improve performance of the {func}`first_value` and {func}`last_value`\\nfunctions. ({issue}`22092`)\", \"Improve performance for large clusters under heavy workloads. ({issue}`22039`)\", \"Improve performance of queries with simple predicates. This optimization can\\nbe disabled using the `experimental.columnar-filter-evaluation.enabled`\\nconfiguration property or the `columnar_filter_evaluation_enabled` session\\nproperty. ({issue}`21375`)\", \"{{breaking}} Improve performance of aggregations containing a `DISTINCT`\\nclause, and replace the `optimizer.mark-distinct-strategy` and\\n`optimizer.optimize-mixed-distinct-aggregations` configuration properties with\\nthe new `optimizer.distinct-aggregations-strategy` property. ({issue}`21907`)\", \"Improve performance of reading JSON files. ({issue}`22348`)\", \"Improve performance for the {func}`date_trunc`, {func}`date_add`, and\\n{func}`date_diff` functions. ({issue}`22192`)\", \"Fix failure when loading the [](/admin/event-listeners-openlineage). ({issue}`22228`)\", \"Fix potential incorrect results when metadata or table data in certain\\nconnectors is updated or deleted. ({issue}`22285`)\"], \"Security\": [\"Add support for using web identity exclusively for authentication when running\\non Amazon EKS with the legacy S3 file system enabled. This can be configured\\nvia the `trino.s3.use-web-identity-token-credentials-provider` property. ({issue}`22162`)\", \"Add support for exclusively using web identity for authentication when using\\nAmazon EKS with\\n[IAM roles](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)\\nby setting the\\n`s3.use-web-identity-token-credentials-provider` configuration property. ({issue}`22163`)\"], \"JDBC driver\": [\"Add support for the `assumeNullCatalogMeansCurrent` connection property. When\\nenabled, a `null` value for the `catalog` parameter in `DatabaseMetaData`\\nmethods is assumed to mean the current catalog. If no current catalog is\\nset, the behaviour is unmodified. ({issue}`20866`)\"], \"BigQuery connector\": [\"Add support for metadata caching when the\\n`bigquery.case-insensitive-name-matching` configuration property is enabled. ({issue}`10740`)\", \"{{breaking}} Automatically configure BigQuery scan parallelism, and remove the\\n`bigquery.parallelism` configuration property. ({issue}`22279`)\"], \"Cassandra connector\": [\"Fix incorrect results when specifying a value for the\\n`cassandra.partition-size-for-batch-select` configuration property. ({issue}`21940`)\"], \"ClickHouse connector\": [\"Improve performance of `ORDER BY ... LIMIT` on non-textual types by pushing\\nexecution down to the underlying database. ({issue}`22174`)\"], \"Delta Lake connector\": [\"Add support for concurrent `UPDATE`, `MERGE`, and `DELETE` queries. ({issue}`21727`)\", \"Add support for using table statistics with `TIMESTAMP` types. ({issue}`21878`)\", \"Add support for reading tables with\\n[type widening](https://docs.delta.io/latest/delta-type-widening.html). ({issue}`21756`)\", \"Set the default value for the `s3.max-connections` configuration property\\nto 500. ({issue}`22209`)\", \"Fix failure when reading a `TIMESTAMP` value after the year 9999. ({issue}`22184`)\", \"Fix failure when reading tables with the unsupported `variant` type. ({issue}`22310`)\", \"Add support for reading\\n[UniForm](https://docs.delta.io/latest/delta-uniform.html) tables. ({issue}`22106`)\"], \"Hive connector\": [\"Add support for changing a column's type from `integer` to `varchar` and\\n`decimal` to `varchar`, respectively, in unpartitioned tables. ({issue}`22246`, {issue}`22293`)\", \"Add support for changing a column's type from `double` to `varchar` in\\nunpartitioned tables\\nusing Parquet files. ({issue}`22277`)\", \"Add support for changing a column's type from `float` to `varchar`. ({issue}`22291`)\", \"Set the default value for the `s3.max-connections` configuration property\\nto 500. ({issue}`22209`)\"], \"Hudi connector\": [\"Set the default value for the `s3.max-connections` configuration property\\nto 500. ({issue}`22209`)\"], \"Iceberg connector\": [\"Add support for the `TRUNCATE` statement. ({issue}`22340`)\", \"{{breaking}} Add support for V2 of the Nessie REST API. Previous behavior can\\nbe restored by setting the `iceberg.nessie-catalog.client-api-version`\\nconfiguration property to `V1`. ({issue}`22215`)\", \"Improve performance when reading by populating `split_offsets` in file\\nmetadata. ({issue}`9018`)\", \"Set the default value for the `s3.max-connections` configuration property\\nto 500. ({issue}`22209`)\", \"Fix failure when reading Parquet files that don't have `field-id` on\\nstructured types. ({issue}`22347`)\"], \"MariaDB connector\": [\"Add support for [fault-tolerant execution](/admin/fault-tolerant-execution). ({issue}`22328`)\", \"Improve performance of listing table columns. ({issue}`22241`)\"], \"Memory connector\": [\"Add support for the `TRUNCATE` statement. ({issue}`22337`)\"], \"MySQL connector\": [\"Improve performance of listing table columns. ({issue}`22241`)\"], \"Pinot connector\": [\"Add support for the\\n[`enableNullHandling` query option](https://docs.pinot.apache.org/developers/advanced/null-value-support#advanced-null-handling-support). ({issue}`22214`)\", \"Fix failure when using [dynamic tables](pinot-dynamic-tables). ({issue}`22301`)\"], \"Redshift connector\": [\"Improve performance of listing table columns. ({issue}`22241`)\"], \"SingleStore connector\": [\"Improve performance of listing table columns. ({issue}`22241`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 323]\"}, {\"title\": \"Release 451 (27 Jun 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for configuring a proxy for the S3 native filesystem with the\\n`s3.http-proxy.username`, `s3.http-proxy.password`,\\n`s3.http-proxy.non-proxy-hosts`, and `s3.http-proxy.preemptive-basic-auth`\\nconfiguration properties. ({issue}`22207`)\", \"Add support for the {func}`t_pdf` and {func}`t_cdf` functions. ({issue}`22507`)\", \"Improve performance of reading JSON array data. ({issue}`22379`)\", \"Improve performance of certain queries involving the {func}`row_number`,\\n{func}`rank`, or {func}`dense_rank` window functions with partitioning and\\nfilters. ({issue}`22509`)\", \"Fix error when reading empty files with the native S3 file system. ({issue}`22469`)\", \"Fix rare error where query execution could hang when fault-tolerant execution\\nis enabled. ({issue}`22472`)\", \"Fix incorrect results for CASE expressions of the form\\n`CASE WHEN ... THEN true ELSE false END`. ({issue}`22530`)\"], \"Delta Lake connector\": [\"Improve performance of reading from Parquet files with large schemas. ({issue}`22451`)\"], \"Hive connector\": [\"Improve performance of reading from Parquet files with large schemas. ({issue}`22451`)\"], \"Hudi connector\": [\"Improve performance of reading from Parquet files with large schemas. ({issue}`22451`)\"], \"Iceberg connector\": [\"Add support for incremental refresh for basic materialized views. ({issue}`20959`)\", \"Add support for adding and dropping fields inside an array. ({issue}`22232`)\", \"Add support for specifying a resource\\n[prefix](https://github.com/apache/iceberg/blob/a47937c0c1fcafe57d7dc83551d8c9a3ce0ab1b9/open-api/rest-catalog-open-api.yaml#L1449-L1455)\\nin the Iceberg REST catalog. ({issue}`22441`)\", \"Add support for partitioning on nested `ROW` fields. ({issue}`15712`)\", \"Add support for writing Parquet Bloom filters. ({issue}`21570`)\", \"Add support for uppercase characters in the `partitioning` table property. ({issue}`12668`)\", \"Improve performance of reading from Parquet files with large schemas. ({issue}`22451`)\"], \"Kudu connector\": [\"Add support for the Kudu `DATE` type. ({issue}`22497`)\", \"Fix query failure when a filter is applied on a `varbinary` column. ({issue}`22496`)\"], \"SPI\": [\"Add a `Connector.getInitialMemoryRequirement()` API for pre-allocating memory\\nduring catalog initialization. ({issue}`22197`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 324]\"}, {\"title\": \"Release 452 (11 Jul 2024)\", \"description\": null, \"content\": {\"General\": [\"Add [](/connector/exasol). ({issue}`16083`)\", \"Add support for processing the `X-Forwarded-Prefix` header when the\\n`http-server.process-forwarded` property is enabled. ({issue}`22227`)\", \"Add support for the {func}`euclidean_distance`, {func}`dot_product`, and\\n{func}`cosine_distance` functions. ({issue}`22397`)\", \"Improve performance of queries with selective joins by performing fine-grained\\nfiltering of rows using dynamic filters. This behavior is enabled by default\\nand can be disabled using the `enable-dynamic-row-filtering` configuration\\nproperty or the `enable_dynamic_row_filtering` session property. ({issue}`22411`)\", \"Fix sporadic query failure when the `retry_policy` property is set to `TASK`. ({issue}`22617`)\"], \"Web UI\": [\"Fix query plans occasionally not rendering the stage details page. ({issue}`22542`)\"], \"BigQuery connector\": [\"Add support for using the\\n[BigQuery Storage Read API](https://cloud.google.com/bigquery/docs/reference/storage)\\nwhen using the [`query` table function](bigquery-query-function). ({issue}`22432`)\"], \"Black Hole connector\": [\"Add support for adding, dropping and renaming columns. ({issue}`22620`)\"], \"ClickHouse connector\": [\"Add [`query` table function](clickhouse-query-function) for full query\\npass-through to ClickHouse. ({issue}`16182`)\"], \"Delta Lake connector\": [\"Add support for type coercion when adding new columns. ({issue}`19708`)\", \"Improve performance of reading from Parquet files with large schemas. ({issue}`22434`)\", \"Fix incorrect results when reading `INT32` values in Parquet files as\\n`varchar` or `decimal` types in Trino. ({issue}`21556`)\", \"Fix a performance regression when using the native filesystem for Azure. ({issue}`22561`)\"], \"Hive connector\": [\"Add support for changing column types for structural data types for\\nnon-partitioned tables using ORC files. ({issue}`22326`)\", \"Add support for type coercion when adding new columns. ({issue}`19708`)\", \"Add support for changing a column's type from `varbinary` to `varchar`. ({issue}`22322`)\", \"Improve performance of reading from Parquet files with large schemas. ({issue}`22434`)\", \"Fix incorrect results when reading `INT32` values in Parquet files as\\n`varchar` or `decimal` types in Trino. ({issue}`21556`)\", \"Fix `sync_partition_metadata` ignoring case-sensitive variations of partition\\nnames in storage. ({issue}`22484`)\", \"Fix a performance regression when using the native filesystem for Azure. ({issue}`22561`)\"], \"Hudi connector\": [\"Improve performance of reading from Parquet files with large schemas. ({issue}`22434`)\", \"Fix incorrect results when reading `INT32` values in Parquet files as\\n`varchar` or `decimal` types in Trino. ({issue}`21556`)\", \"Fix a performance regression when using the native filesystem for Azure. ({issue}`22561`)\"], \"Iceberg connector\": [\"Add support for type coercion when adding new columns. ({issue}`19708`)\", \"Improve performance of reading from Parquet files with a large number of\\ncolumns. ({issue}`22434`)\", \"Fix files being deleted when dropping tables with the Nessie catalog. ({issue}`22392`)\", \"Fix incorrect results when reading `INT32` values in Parquet files as\\n`varchar` or `decimal` types in Trino. ({issue}`21556`)\", \"Fix failure when hidden partition names conflict with other columns. ({issue}`22351`)\", \"Fix failure when reading tables with `null` on partition columns while the\\n`optimize_metadata_queries` session property is enabled. ({issue}`21844`)\", \"Fix failure when listing views with an unsupported dialect in the REST\\ncatalog. ({issue}`22598`)\", \"Fix a performance regression when using the native filesystem for Azure. ({issue}`22561`)\"], \"Kudu connector\": [\"Fix failure when adding new columns with a `decimal` type. ({issue}`22558`)\"], \"Memory connector\": [\"Add support for adding new columns. ({issue}`22610`)\", \"Add support for renaming columns. ({issue}`22607`)\", \"Add support for the `NOT NULL` constraint. ({issue}`22601`)\"], \"PostgreSQL connector\": [\"Improve performance of the {func}`reverse` function by pushing down execution\\nto the underlying database. ({issue}`22203`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 325]\"}, {\"title\": \"Release 453 (25 Jul 2024)\", \"description\": null, \"content\": {\"General\": [\"Improve accuracy of the {func}`cosine_distance` function. ({issue}`22761`)\", \"Improve performance of non-equality joins. ({issue}`22521`)\", \"Improve performance for column masking with [](/security/opa-access-control). ({issue}`21359`)\", \"Fix incorrect evaluation of repeated non-deterministic functions. ({issue}`22683`)\", \"Fix potential failure for queries involving `GROUP BY`, `UNNEST`, and filters\\nover expressions that may produce an error for certain inputs. ({issue}`22731`)\", \"Fix planning failure for queries with a filter on an aggregation. ({issue}`22716`)\", \"Fix planning failure for queries involving multiple aggregations and `CASE`\\nexpressions. ({issue}`22806`)\", \"Fix optimizer timeout for certain queries involving aggregations and `CASE`\\nexpressions. ({issue}`22813`)\"], \"Security\": [\"Add support for `IF EXISTS` to `DROP ROLE`. ({issue}`21985`)\"], \"JDBC driver\": [\"Add support for using certificates from the operating system keystore. ({issue}`22341`)\", \"Add support for setting the default [SQL PATH](/sql/set-path). ({issue}`22703`)\", \"Allow Trino host URI specification without port for the default ports 80 for\\nHTTP and 443 for HTTPS. ({issue}`22724`)\"], \"CLI\": [\"Add support for using certificates from the operating system keystore. ({issue}`22341`)\", \"Add support for setting the default [SQL PATH](/sql/set-path). ({issue}`22703`)\", \"Allow Trino host URI specification without port for the default ports 80 for\\nHTTP and 443 for HTTPS. ({issue}`22724`)\"], \"BigQuery connector\": [\"Improve performance when querying information schema. ({issue}`22770`)\"], \"Cassandra connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"ClickHouse connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Delta Lake connector\": [\"Add support for reading partition columns whose type changed via [type\\nwidening](https://docs.delta.io/latest/delta-type-widening.html). ({issue}`22433`)\", \"Add support for authenticating with Glue with a Kubernetes service account.\\nThis can be enabled via the\\n`hive.metastore.glue.use-web-identity-token-credentials-provider`\\nconfiguration property. ({issue}`15267`)\", \"Fix failure when executing the [VACUUM](delta-lake-vacuum) procedure on tables\\nwithout old transaction logs. ({issue}`22816`)\"], \"Druid connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Exasol connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Hive connector\": [\"Add support for authenticating with Glue with a Kubernetes service account.\\nThis can be enabled via the\\n`hive.metastore.glue.use-web-identity-token-credentials-provider`\\nconfiguration property. ({issue}`15267`)\", \"Fix failure to read Hive tables migrated to Iceberg with Apache Spark. ({issue}`11338`)\", \"Fix failure for `CREATE FUNCTION` with SQL UDF storage in Glue when\\n`hive.metastore.glue.catalogid` is set. ({issue}`22717`)\"], \"Hudi connector\": [\"Add support for authenticating with Glue with a Kubernetes service account.\\nThis can be enabled via the\\n`hive.metastore.glue.use-web-identity-token-credentials-provider`\\nconfiguration property. ({issue}`15267`)\"], \"Iceberg connector\": [\"{{breaking}} Change the schema version for the JDBC catalog database to `V1`.\\nThe previous value can be restored by setting the\\n`iceberg.jdbc-catalog.schema-version` configuration property to `V0`. ({issue}`22576`)\", \"Add support for views with the JDBC catalog. Requires an upgrade\\nof the schema for the JDBC catalog database to `V1`. ({issue}`22576`)\", \"Add support for specifying on which schemas to enforce the presence of a\\npartition filter in queries. This can be configured\\n`query-partition-filter-required-schemas` property. ({issue}`22540`)\", \"Add support for authenticating with Glue with a Kubernetes service account.\\nThis can be enabled via the\\n`hive.metastore.glue.use-web-identity-token-credentials-provider`\\nconfiguration property. ({issue}`15267`)\", \"Fix failure when executing `DROP SCHEMA ... CASCADE` using the REST catalog\\nwith Iceberg views. ({issue}`22758`)\"], \"Ignite connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"MariaDB connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"MySQL connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Oracle connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Phoenix connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"PostgreSQL connector\": [\"Add support for reading the `vector` type on\\n[pgvector](https://github.com/pgvector/pgvector/). ({issue}`22630`)\", \"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Redshift connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"SingleStore connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"Snowflake connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"SQL Server connector\": [\"Add support for the `execute` procedure. ({issue}`22556`)\"], \"SPI\": [\"Add `SystemAccessControl.getColumnMasks` as replacement for the deprecated\\n`SystemAccessControl.getColumnMask`. ({issue}`21997`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 326]\"}, {\"title\": \"Release 454 (15 Aug 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for retrieving lightweight query information from the `/v1/query`\\nendpoint with the `pruned` query parameter. ({issue}`20843`)\", \"Add support for providing configuration for a secrets provider in a\\n`secrets.toml` file in the main Trino configuration directory. ({issue}`22633`)\", \"Add support for an event listener plugin that publishes events to Kafka. ({issue}`22426`)\", \"Add temporary support for restoring unsafe pushdown behavior removed in\\nversion 445. This can be enabled with the `optimizer.allow-unsafe-pushdown`\\nconfiguration property. When this mode is enabled, certain queries containing\\nexpressions that may fail for some inputs may fail at runtime. ({issue}`22987`)\", \"Improve performance of queries with multiple aggregations involving\\n`DISTINCT`. ({issue}`22355`)\", \"{{breaking}} Improve query concurrency when memory is low by removing the\\n`query.low-memory-killer.delay` configuration property. ({issue}`22936`)\", \"Avoid retrying failed filesystem operations when they will always fail. ({issue}`22678`)\", \"Fix failure for queries involving {func}`json_parse` and a cast to `array`,\\n`map`, or `row`. ({issue}`22840`)\", \"Fix query failure when file-based network topology is configured with the\\n`node-scheduler.network-topology.file` configuration property. ({issue}`18793`)\"], \"Web UI\": [\"Add information about which tables and UDFs have been referenced by a\\nquery. ({issue}`20843`)\"], \"JDBC driver\": [\"Add support for the `NO_GENERATED_KEYS` option in the\\n`Connection.prepareStatement` method. ({issue}`22100`)\", \"Fix the Trino username incorrectly defaulting to the name of the user running\\nthe Trino process when no username is specified. ({issue}`22901`)\"], \"BigQuery connector\": [\"Add support for the `execute` procedure. ({issue}`22692`)\"], \"Delta Lake connector\": [\"Add S3 security mapping for the native S3 filesystem. ({issue}`22559`)\", \"Add support for writing\\n[deletion vectors](https://docs.delta.io/latest/delta-deletion-vectors.html). ({issue}`17063`)\", \"Improve performance by caching table metadata to the metastore. ({issue}`21463`)\", \"{{breaking}} Rename metastore OpenTelemetry attributes from `trino.hive.*` to\\n`trino.metastore.*`. ({issue}`22866`)\"], \"Hive connector\": [\"Add support for using the `hive.metastore-refresh-interval` configuration\\nproperty when using Glue v2 Hive metastore. ({issue}`22706`)\", \"Add S3 security mapping for the native S3 filesystem. ({issue}`22559`)\", \"{{breaking}} Rename metastore OpenTelemetry attributes from `trino.hive.*` to\\n`trino.metastore.*`. ({issue}`22866`)\", \"Add support for adjusting UTC-adjusted `INT64` timestamps to the timezone\\nspecified in the `hive.parquet.time-zone` property when reading Parquet files. ({issue}`22577`)\", \"Fix potential query failure caused by incorrect bucket column validation. ({issue}`22261`)\", \"Fix error when reading `INT96` timestamps in Parquet files generated by AWS\\nWrangler. ({issue}`22854`)\"], \"Hudi connector\": [\"Add S3 security mapping for the native S3 filesystem. ({issue}`22559`)\", \"{{breaking}} Rename metastore OpenTelemetry attributes from `trino.hive.*` to\\n`trino.metastore.*`. ({issue}`22866`)\"], \"Iceberg connector\": [\"Add S3 security mapping for the native S3 filesystem. ({issue}`22559`)\", \"Add support for changing a column's type from `tinyint` or `smallint` to\\n`integer`. ({issue}`19971`)\", \"Improve query planning performance by caching Iceberg metadata files on the\\ncoordinator. This behavior can be disabled by setting the new\\n`iceberg.metadata-cache.enabled` configuration property to `false`. ({issue}`22739`)\", \"{{breaking}} Rename metastore OpenTelemetry attributes from `trino.hive.*` to\\n`trino.metastore.*`. ({issue}`22866`)\"], \"Memory connector\": [\"Fix incorrect results after truncating tables. ({issue}`22665`)\"], \"Oracle connector\": [\"Add support for specifying the JDBC fetch size with the `oracle.fetch-size`\\nconfiguration property. ({issue}`22670`)\"], \"PostgreSQL connector\": [\"Add support for specifying the JDBC fetch size with the\\n`postgresql.fetch-size` configuration property. ({issue}`22670`)\", \"Improve performance when using the `euclidean_distance` and `cosine_distance`\\nfunctions on `vector` types. ({issue}`22618`)\", \"Improve performance when a query contains `-dot_product` projections. ({issue}`23015`)\", \"Fix failure when a user-defined type name contains uppercase characters. ({issue}`22848`)\"], \"Redshift connector\": [\"Add support for specifying the JDBC fetch size with the `redshift.fetch-size`\\nconfiguration property. ({issue}`22670`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 327]\"}, {\"title\": \"Release 455 (29 Aug 2024)\", \"description\": null, \"content\": {\"General\": [\"Add query starting time in `QueryStatistics` in all [](admin-event-listeners).\\n({issue}`23113`)\", \"Add JMX metrics for the bean\\n`trino.execution.executor.timesharing:name=TimeSharingTaskExecutor` replacing\\nmetrics previously found in `trino.execution.executor:name=TaskExecutor`.\\n({issue}`22914`)\", \"Add support S3 file system encryption with fault-tolerant execution mode. ({issue}`22529`)\", \"Fix memory tracking issue for aggregations that could cause worker crashes\\nwith out-of-memory errors. ({issue}`23098`)\"], \"Delta Lake connector\": [\"Allow configuring endpoint for the native Azure filesystem. ({issue}`23071`)\", \"Improve stability for concurrent Glue connections. ({issue}`23039`)\"], \"ClickHouse connector\": [\"Add support for creating tables with the `MergeTree` engine without the\\n`order_by` table property. ({issue}`23048`)\"], \"Hive connector\": [\"Allow configuring endpoint for the native Azure filesystem. ({issue}`23071`)\", \"Improve stability for concurrent Glue connections. ({issue}`23039`)\", \"Fix query failures when Parquet files contain column names that only differ in\\ncase. ({issue}`23050`)\"], \"Hudi connector\": [\"Allow configuring endpoint for the native Azure filesystem. ({issue}`23071`)\"], \"Iceberg connector\": [\"Allow configuring endpoint for the native Azure filesystem. ({issue}`23071`)\", \"Improve stability for concurrent Glue connections. ({issue}`23039`)\", \"Fix `$files` table not showing delete files with the Iceberg v2 format. ({issue}`16233`)\"], \"OpenSearch connector\": [\"Improve performance of queries that reference nested fields from OpenSearch\\ndocuments. ({issue}`22646`)\"], \"PostgreSQL\": [\"Fix potential failure for pushdown of `euclidean_distance`, `cosine_distance`\\nand `dot_product` functions. ({issue}`23152`)\"], \"Prometheus connector\": [\"Add support for the catalog session properties `query_chunk_size_duration` and\\n`max_query_range_duration`. ({issue}`22319`)\"], \"Redshift connector\": [\"Release resources in Redshift promptly when a query is cancelled. ({issue}`22774`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 328]\"}, {\"title\": \"Release 456\", \"description\": null, \"content\": {\"Release 456 (6 Sep 2024)\": \"Invalid - release process errors resulted in invalid artifacts.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 329]\"}, {\"title\": \"Release 457 (6 Sep 2024)\", \"description\": null, \"content\": {\"General\": [\"Expose additional JMX metrics about resource groups, including CPU and memory\\nusage, limits, and scheduling policy. ({issue}`22957`)\", \"Improve performance of queries involving joins when fault tolerant execution\\nis enabled. This [adaptive plan\\noptimization](/optimizer/adaptive-plan-optimizations) can be disabled with the\\n`fault-tolerant-execution-adaptive-join-reordering-enabled` configuration\\nproperty or the `fault_tolerant_execution_adaptive_join_reordering_enabled`\\nsession property. ({issue}`23046`)\", \"Improve performance for [LZ4, Snappy and ZSTD compression and\\ndecompression](file-compression) used for [exchange spooling with\\nfault-tolerant execution](fte-exchange-manager). ({issue}`22532`)\", \"{{breaking}} Shorten the name for the Kafka event listener to `kafka`. ({issue}`23308`)\", \"Extend the Kafka event listener to send split completion events. ({issue}`23065`)\"], \"JDBC driver\": [\"Publish a [JDBC driver JAR](jdbc-installation) without bundled, third-party\\ndependencies. ({issue}`22098`)\"], \"BigQuery connector\": [\"Fix failures with queries using table functions when `parent-project-id` is\\ndefined. ({issue}`23041`)\"], \"Blackhole connector\": [\"Add support for the `REPLACE` modifier as part of a `CREATE TABLE` statement. ({issue}`23004`)\"], \"Delta Lake connector\": [\"Add support for creating tables with\\n[deletion vector](https://docs.delta.io/latest/delta-deletion-vectors.html).\\n({issue}`22104`)\", \"Improve performance for concurrent write operations on S3 by using lock-less\\nDelta Lake write reconciliation. ({issue}`23145`)\", \"Improve performance for [LZ4, Snappy, and ZSTD compression and\\ndecompression](file-compression). ({issue}`22532`)\", \"Fix SSE configuration when using S3SecurityMapping with kmsKeyId configured. ({issue}`23299`)\"], \"Hive connector\": [\"Improve performance of queries that scan a large number of partitions. ({issue}`23194`)\", \"Improve performance for [LZ4, Snappy, and ZSTD compression and\\ndecompression](file-compression). ({issue}`22532`)\", \"Fix OpenX JSON decoding a JSON array line that resulted in data being written\\nto the wrong output column. ({issue}`23120`)\"], \"Hudi connector\": [\"Improve performance for [LZ4, Snappy, and ZSTD compression and\\ndecompression](file-compression). ({issue}`22532`)\"], \"Iceberg connector\": [\"Improve performance for [LZ4, Snappy, and ZSTD compression and\\ndecompression](file-compression). ({issue}`22532`)\"], \"Memory connector\": [\"Add support for renaming schemas with `ALTER SCHEMA ... RENAME`. ({issue}`22659`)\"], \"Prometheus connector\": [\"Fix reading large Prometheus responses. ({issue}`23025`)\"], \"SPI\": [\"Remove the deprecated `ConnectorMetadata.createView` method. ({issue}`23208`)\", \"Remove the deprecated `ConnectorMetadata.beginRefreshMaterializedView` method.\\n({issue}`23212`)\", \"Remove the deprecated `ConnectorMetadata.finishInsert` method. ({issue}`23213`)\", \"Remove the deprecated `ConnectorMetadata.createTable(ConnectorSession session,\\nConnectorTableMetadata tableMetadata, boolean ignoreExisting)` method.\\n({issue}`23209`)\", \"Remove the deprecated `ConnectorMetadata.beginCreateTable` method. ({issue}`23211`)\", \"Remove the deprecated `ConnectorSplit.getInfo` method. ({issue}`23271`)\", \"Remove the deprecated `DecimalConversions.realToShortDecimal(long value, long\\nprecision, long scale)` method. ( {issue}`23275`)\", \"Remove the deprecated constructor from the `ConstraintApplicationResult`\\nclass. ({issue}`23272`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 330]\"}, {\"title\": \"Release 458 (17 Sep 2024)\", \"description\": null, \"content\": {\"General\": [\"Improve performance for queries with a redundant `DISTINCT` clause. ({issue}`23087`)\"], \"JDBC\": [\"Add support for tracing with OpenTelemetry. ({issue}`23458`)\", \"Remove publishing a JDBC driver JAR without bundled, third-party dependencies. ({issue}`23452`)\"], \"Druid connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"Delta Lake connector\": [\"{{breaking}} Deactivate [legacy file system support](file-system-legacy) for\\nall catalogs. You must activate the desired [file system\\nsupport](file-system-configuration) with\\n`fs.native-azure.enabled`,`fs.native-gcs.enabled`, `fs.native-s3.enabled`, or\\n`fs.hadoop.enabled` in each catalog. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`23343`)\", \"Add JMX monitoring to the [](/object-storage/file-system-s3). ({issue}`23177`)\", \"Reduce the number of file system operations when reading from Delta Lake\\ntables. ({issue}`23329`)\", \"Fix rare, long planning times when Hive metastore caching is enabled. ({issue}`23401`)\"], \"Exasol connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"Hive connector\": [\"{{breaking}} Deactivate [legacy file system support](file-system-legacy) for\\nall catalogs. You must activate the desired [file system\\nsupport](file-system-configuration) with\\n`fs.native-azure.enabled`,`fs.native-gcs.enabled`, `fs.native-s3.enabled`, or\\n`fs.hadoop.enabled` in each catalog. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`23343`)\", \"Add JMX monitoring to the native S3 file system support. ({issue}`23177`)\", \"Reduce the number of file system operations when reading tables with file system\\ncaching enabled. ({issue}`23327`)\", \"Improve the `flush_metadata_cache` procedure to include flushing the file\\nstatus cache. ({issue}`22412`)\", \"Fix listing failure when Glue contains Hive unsupported tables. ({issue}`23253`)\", \"Fix rare, long planning times when Hive metastore caching is enabled. ({issue}`23401`)\"], \"Hudi connector\": [\"{{breaking}} Deactivate [legacy file system support](file-system-legacy) for\\nall catalogs. You must activate the desired [file system\\nsupport](file-system-configuration) with\\n`fs.native-azure.enabled`,`fs.native-gcs.enabled`, `fs.native-s3.enabled`, or\\n`fs.hadoop.enabled` in each catalog. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`23343`)\", \"Add JMX monitoring to the native S3 file system support. ({issue}`23177`)\", \"Fix rare, long planning times when Hive metastore caching is enabled. ({issue}`23401`)\"], \"Iceberg connector\": [\"{{breaking}} Deactivate [legacy file system support](file-system-legacy) for\\nall catalogs. You must activate the desired [file system\\nsupport](file-system-configuration) with\\n`fs.native-azure.enabled`,`fs.native-gcs.enabled`, `fs.native-s3.enabled`, or\\n`fs.hadoop.enabled` in each catalog. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`23343`)\", \"Add JMX monitoring to the native S3 file system support. ({issue}`23177`)\", \"Fix rare, long planning times when Hive metastore caching is enabled. ({issue}`23401`)\"], \"MariaDB connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"MySQL connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"Oracle connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"PostgreSQL connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"Redshift connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"SingleStore connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"Snowflake connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"SQL Server connector\": [\"Reduce data transfer from remote systems for queries with large `IN` lists. ({issue}`23381`)\"], \"SPI\": [\"Add `@Constraint` annotation for functions. ({issue}`23449`)\", \"Remove the deprecated constructor from the `ConnectorTableLayout` class. ({issue}`23395`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 331]\"}, {\"title\": \"Release 459 (25 Sep 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix possible query failure when `retry_policy` is set to `TASK` and when\\nadaptive join reordering is enabled. ({issue}`23407`)\"], \"Docker image\": [\"Update Java runtime to Java 23. ({issue}`23482`)\"], \"CLI\": [\"Display data sizes and rates with binary (1024-based) abbreviations such as\\n`KiB` and `MiB`. Add flag `--decimal-data-size` to use decimal (1000-based)\\nvalues and abbreviations such as `KB` and `MB`. ({issue}`13054`)\"], \"BigQuery connector\": [\"Improve performance of queries that access only a subset of fields from nested\\ndata. ({issue}`23443`)\", \"Fix query failure when the `bigquery.service-cache-ttl` property isn't `0ms`\\nand case insensitive name matching is enabled. ({issue}`23481`)\"], \"ClickHouse connector\": [\"Improve performance for queries involving conditions with `varchar` data. ({issue}`23516`)\"], \"Delta Lake connector\": [\"Allow configuring maximum concurrent HTTP requests to Azure on every node in\\n[](/object-storage/file-system-azure) with `azure.max-http-requests`.\\n({issue}`22915`)\", \"Add support for WASB to [](/object-storage/file-system-azure). ({issue}`23511`)\", \"Allow disabling caching of Delta Lake transaction logs when file system caching\\nis enabled with the `delta.fs.cache.disable-transaction-log-caching` property. ({issue}`21451`)\", \"Improve cache hit ratio for the [](/object-storage/file-system-cache). ({issue}`23172`)\", \"Fix incorrect results when writing [deletion\\nvectors](https://docs.delta.io/latest/delta-deletion-vectors.html). ({issue}`23229`)\", \"Fix failures for queries with containing aggregations with a `DISTINCT`\\nclause on metadata tables. ({issue}`23529`)\"], \"Elasticsearch connector\": [\"Fix failures for `count(*)` queries with predicates containing non-ASCII\\nstrings. ({issue}`23425`)\"], \"Hive connector\": [\"Allow configuring maximum concurrent HTTP requests to Azure on every node in\\n[](/object-storage/file-system-azure) with `azure.max-http-requests`.\\n({issue}`22915`)\", \"Add support for WASB to [](/object-storage/file-system-azure). ({issue}`23511`)\", \"Improve cache hit ratio for the [](/object-storage/file-system-cache). ({issue}`23172`)\", \"Fix failures for queries with containing aggregations with a `DISTINCT`\\nclause on metadata tables. ({issue}`23529`)\"], \"Hudi connector\": [\"Allow configuring maximum concurrent HTTP requests to Azure on every node in\\n[](/object-storage/file-system-azure) with `azure.max-http-requests`.\\n({issue}`22915`)\", \"Add support for WASB to [](/object-storage/file-system-azure). ({issue}`23511`)\", \"Fix failures for queries with containing aggregations with a `DISTINCT`\\nclause on metadata tables. ({issue}`23529`)\"], \"Iceberg connector\": [\"Allow configuring maximum concurrent HTTP requests to Azure on every node in\\n[](/object-storage/file-system-azure) with `azure.max-http-requests`.\\n({issue}`22915`)\", \"Add support for WASB to [](/object-storage/file-system-azure). ({issue}`23511`)\", \"Improve cache hit ratio for the [](/object-storage/file-system-cache). ({issue}`23172`)\", \"Fix failures for queries with containing aggregations with a `DISTINCT`\\nclause on metadata tables. ({issue}`23529`)\"], \"Local file connector\": [\"{{breaking}} Remove the local file connector. ({issue}`23556`)\"], \"OpenSearch connector\": [\"Fix failures for `count(*)` queries with predicates containing non-ASCII\\nstrings. ({issue}`23425`)\"], \"SPI\": [\"Add `ConnectorAccessControl` argument to the\\n`ConnectorMetadata.getTableHandleForExecute` method. ({issue}`23524`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 332]\"}, {\"title\": \"Release 460 (3 Oct 2024)\", \"description\": null, \"content\": {\"General\": [\"Fix failure for certain queries involving lambda expressions. ({issue}`23649`)\"], \"Atop connector\": [\"{{breaking}} Remove the Atop connector. ({issue}`23550`)\"], \"ClickHouse connector\": [\"Improve performance of listing columns. ({issue}`23429`)\", \"Improve performance for queries comparing `varchar` columns. ({issue}`23558`) \", \"Improve performance for queries using `varchar` columns for `IN` comparisons. ({issue}`23581`)\", \"Improve performance for queries with complex expressions involving `LIKE`. ({issue}`23591`)\"], \"Delta Lake connector\": [\"Add support for using an [Alluxio cluster as file system\\ncache](/object-storage/file-system-alluxio). ({issue}`21603`)\", \"Add support for WASBS to [](/object-storage/file-system-azure). ({issue}`23548`)\", \"Disallow writing to tables that both change data feed and [deletion\\nvectors](https://docs.delta.io/latest/delta-deletion-vectors.html) are\\nenabled. ({issue}`23653`)\", \"Fix query failures when writing bloom filters in Parquet files. ({issue}`22701`)\"], \"Hive connector\": [\"Add support for using an [Alluxio cluster as file system\\ncache](/object-storage/file-system-alluxio). ({issue}`21603`)\", \"Add support for WASBS to [](/object-storage/file-system-azure). ({issue}`23548`)\", \"Fix query failures when writing bloom filters in Parquet files. ({issue}`22701`)\"], \"Hudi connector\": [\"Add support for WASBS to [](/object-storage/file-system-azure). ({issue}`23548`)\"], \"Iceberg connector\": [\"Add support for using an [Alluxio cluster as file system\\ncache](/object-storage/file-system-alluxio). ({issue}`21603`)\", \"Add support for WASBS to [](/object-storage/file-system-azure). ({issue}`23548`)\", \"Ensure table columns are cached in Glue even when table comment is too long. ({issue}`23483`)\", \"Reduce planning time for queries on columns containing a large number of\\nnested fields. ({issue}`23451`)\", \"Fix query failures when writing bloom filters in Parquet files. ({issue}`22701`)\"], \"Oracle connector\": [\"Improve performance for queries casting columns to `char` or to `varchar`. ({issue}`22728`)\"], \"Raptor connector\": [\"{{breaking}} Remove the Raptor connector. ({issue}`23588`)\"], \"SQL Server connector\": [\"Improve performance of listing columns. ({issue}`23429`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 333]\"}, {\"title\": \"Release 461 (10 Oct 2024)\", \"description\": null, \"content\": {\"General\": [\"Rename the configuration property `max-tasks-waiting-for-execution-per-stage`\\nto `max-tasks-waiting-for-execution-per-query` and the session property\\n`max_tasks_waiting_for_node_per_stage` to\\n`max_tasks_waiting_for_node_per_query` to match implemented semantics. ({issue}`23585`)\", \"Fix failure when joining tables with large numbers of columns. ({issue}`23720`)\", \"Fix failure for `MERGE` queries on tables with large numbers of columns. ({issue}`15848`)\"], \"Security\": [\"Add support for BCrypt versions 2A, 2B, and 2X usage in password database files\\nused with file-based authentication. ({issue}`23648`)\"], \"Web UI\": [\"Add buttons on the query list to access query details. ({issue}`22831`)\", \"Add syntax highlighting to query display on query list. ({issue}`22831`)\"], \"BigQuery connector\": [\"Fix failure when `bigquery.case-insensitive-name-matching` is enabled and\\n`bigquery.case-insensitive-name-matching.cache-ttl` is `0m`. ({issue}`23698`)\"], \"Delta Lake connector\": [\"Enforce access control for new tables in the `register_table` procedure. ({issue}`23728`)\"], \"Hive connector\": [\"Add support for reading Hive tables that use `CombineTextInputFormat`. ({issue}`21842`)\", \"Improve performance of queries with selective joins. ({issue}`23687`)\"], \"Iceberg connector\": [\"Add support for the `add_files` and `add_files_from_table` procedures. ({issue}`11744`)\", \"Support `timestamp` type columns with the `migrate` procedure. ({issue}`17006`)\", \"Enforce access control for new tables in the `register_table` procedure. ({issue}`23728`)\"], \"Redshift connector\": [\"Improve performance of queries with range filters on integers. ({issue}`23417`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 334]\"}, {\"title\": \"Release 462 (16 Oct 2024)\", \"description\": null, \"content\": {\"General\": [\"Allow adding subgroups to groups during query processing when using the\\n[](db-resource-group-manager). ({issue}`23727`)\", \"Fix query failures for queries routed to a group whose subgroup is deleted\\nwhen using the [](db-resource-group-manager). ({issue}`23727`)\", \"Fix wrong resource group configuration being applied if the group is changed\\nfrom a variable to fixed name or vice-versa when using the\\n[](db-resource-group-manager). ({issue}`23727`)\", \"Fix resource group updates not being observed immediately for groups that use\\nvariables when using the [](db-resource-group-manager). ({issue}`23727`)\", \"Fix incorrect results for certain `CASE` expressions that return boolean\\nresults. ({issue}`23787`)\"], \"JDBC driver\": [\"Improve performance and memory usage when decoding data. ({issue}`23754`)\"], \"CLI\": [\"Improve performance and memory usage when decoding data. ({issue}`23754`)\"], \"Iceberg connector\": [\"Add support for read operations when using the Unity catalog as Iceberg REST\\ncatalog. ({issue}`22609`)\", \"Improve planning time for insert operations. ({issue}`23757`)\"], \"Redshift connector\": [\"Improve performance for queries casting columns to smallint, integer, or\\nbigint. ({issue}`22951`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 335]\"}, {\"title\": \"Release 463 (23 Oct 2024)\", \"description\": null, \"content\": {\"General\": [\"Enable HTTP/2 for internal communication by default. The previous behavior can\\nbe restored by setting `internal-communication.http2.enabled` to `false`. ({issue}`21793`)\", \"Support connecting over HTTP/2 for client drivers and client applications. ({issue}`21793`)\", \"Add {func}`timezone` functions to extract the timezone identifier from from a\\n`timestamp(p) with time zone` or `time(p) with time zone`. ({issue}`20893`)\", \"Include table functions with `SHOW FUNCTIONS` output. ({issue}`12550`)\", \"Print peak memory usage in `EXPLAIN ANALYZE` output. ({issue}`23874`)\", \"Disallow the window framing clause for {func}`ntile`, {func}`rank`,\\n{func}`dense_rank`, {func}`percent_rank`, {func}`cume_dist`, and\\n{func}`row_number`. ({issue}`23742`)\"], \"JDBC driver\": [\"Support connecting over HTTP/2. ({issue}`21793`)\"], \"CLI\": [\"Support connecting over HTTP/2. ({issue}`21793`)\"], \"ClickHouse connector\": [\"Improve performance for queries with `IS NULL` expressions. ({issue}`23459`)\"], \"Delta Lake connector\": [\"Add support for writing change data feed when [deletion vector](https://docs.delta.io/latest/delta-deletion-vectors.html) \\nis enabled. ({issue}`23620`)\"], \"Iceberg connector\": [\"Add support for nested namespaces with the REST catalog. ({issue}`22916`)\", \"Add support for configuring the maximum number of rows per row-group in the\\nORC writer with the `orc_writer_max_row_group_rows` catalog session property. ({issue}`23722`)\", \"Clean up position delete files when `OPTIMIZE` is run on a subset of the\\ntable's partitions. ({issue}`23801`)\", \"Rename `iceberg.add_files-procedure.enabled` catalog configuration property to\\n`iceberg.add-files-procedure.enabled`. ({issue}`23873`)\"], \"SingleStore connector\": [\"Fix incorrect column length of `varchar` type in SingleStore version 8. ({issue}`23780`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 336]\"}, {\"title\": \"Release 464 (30 Oct 2024)\", \"description\": null, \"content\": {\"General\": [\"{{breaking}} Require JDK 23 to run Trino, including updated [](jvm-config). ({issue}`21316`)\", \"Add the [](/connector/faker) for easy generation of data. ({issue}`23691`)\", \"Add the [](/connector/vertica). ({issue}`23948`)\", \"Rename the\\n`fault-tolerant-execution-eager-speculative-tasks-node_memory-overcommit`\\nconfiguration property to\\n`fault-tolerant-execution-eager-speculative-tasks-node-memory-overcommit`.\\n({issue}`23876`) \"], \"Accumulo connector\": [\"{{breaking}} Remove the Accumulo connector. ({issue}`23792`) \"], \"BigQuery connector\": [\"Fix incorrect results when reading array columns and\\n`bigquery.arrow-serialization.enabled` is set to true. ({issue}`23982`)\"], \"Delta Lake connector\": [\"Fix failure of S3 file listing of buckets that enforce [requester\\npays](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html).\\n({issue}`23906`)\"], \"Hive connector\": [\"Use the `hive.metastore.partition-batch-size.max` catalog configuration\\nproperty value in the `sync_partition_metadata` procedure. Change the default\\nbatch size from 1000 to 100. ({issue}`23895`)\", \"Fix failure of S3 file listing of buckets that enforce [requester\\npays](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html).\\n({issue}`23906`)\"], \"Hudi connector\": [\"Fix failure of S3 file listing of buckets that enforce [requester\\npays](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html).\\n({issue}`23906`)\"], \"Iceberg connector\": [\"Improve performance of `OPTIMIZE` on large partitioned tables. ({issue}`10785`)\", \"Rename the `iceberg.expire_snapshots.min-retention` configuration property to\\n`iceberg.expire-snapshots.min-retention`. ({issue}`23876`)\", \"Rename the `iceberg.remove_orphan_files.min-retention` configuration property\\nto `iceberg.remove-orphan-files.min-retention`. ({issue}`23876`)\", \"Fix failure of S3 file listing of buckets that enforce [requester\\npays](https://docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html).\\n({issue}`23906`)\", \"Fix incorrect column constraints when using the `migrate` procedure on tables\\nthat contain `NULL` values. ({issue}`23928`)\"], \"Phoenix connector\": [\"{{breaking}} Require JVM configuration to allow the Java security manager. ({issue}`24207`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 337]\"}, {\"title\": \"Release 465 (20 Nov 2024)\", \"description\": null, \"content\": {\"General\": [\"Add the {func}`cosine_similarity` function for dense vectors. ({issue}`23964`)\", \"Add support for reading geometries in [EWKB\\nformat](https://en.wikipedia.org/wiki/Well-known_text_representation_of_geometry)\\nwith the {func}`ST_GeomFromBinary` function. ({issue}`23824`)\", \"Add support for parameter of `bigint` type for the {func}`repeat` function. ({issue}`22867`)\", \"Add support for the `ORDER BY` clause in a windowed aggregate function. ({issue}`23929`)\", \"{{breaking}} Change the data type for `client_info` in the MySQL event\\nlistener to `MEDIUMTEXT`. ({issue}`22362`)\", \"Improve performance of queries with selective joins. ({issue}`22824`)\", \"Improve performance when using various string functions in queries involving\\njoins. ({issue}`24182`)\", \"Reduce chance of out of memory query failure when `retry-policy` is set to\\n`task`. ({issue}`24114`)\", \"Prevent some query failures when `retry-policy` is set to `task`. ({issue}`24165`)\"], \"JDBC driver\": [\"Add support for `LocalDateTime` and `Instant` in `getObject` and `setObject`. ({issue}`22906`)\"], \"CLI\": [\"Fix incorrect quoting of output values when the `CSV_UNQUOTED` or the \\n`CSV_HEADER_UNQUOTED` format is used. ({issue}`24113`)\"], \"BigQuery connector \": [\"Fix failure when reading views with `timestamp` columns. ({issue}`24004`)\"], \"Cassandra connector\": [\"{{breaking}} Require setting the `cassandra.security` configuration property\\nto `PASSWORD` along with `cassandra.username` and `cassandra.password` for\\npassword-based authentication. ({issue}`23899`)\"], \"Clickhouse connector\": [\"Fix insert of invalid time zone data for tables using the timestamp with time\\nzone type. ({issue}`23785`)\", \"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Delta Lake connector\": [\"Add support for customer-provided SSE key in [S3 file\\nsystem](/object-storage/file-system-s3). ({issue}`22992`)\", \"Fix incorrect results for queries filtering on a partition columns and the\\n`NAME` column mapping mode is used. ({issue}`24104`)\"], \"Druid connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Exasol connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Faker connector\": [\"Add the {func}`random_string` catalog function. ({issue}`23990`)\", \"Make generated data deterministic for repeated queries. ({issue}`24008`)\", \"Allow configuring locale with the `faker.locale` configuration property. ({issue}`24152`)\"], \"Hive connector\": [\"Add support for skipping archiving when committing to a table in the Glue metastore\\nand the `hive.metastore.glue.skip-archive` configuration property is set to\\n`true`. ({issue}`23817`)\", \"Add support for customer-provided SSE key in [S3 file\\nsystem](/object-storage/file-system-s3). ({issue}`22992`)\"], \"Hudi connector\": [\"Add support for customer-provided SSE key in [S3 file\\nsystem](/object-storage/file-system-s3). ({issue}`22992`)\"], \"Iceberg connector\": [\"Add support for reading and writing arbitrary table properties with the\\n`extra_properties` table property. ({issue}`17427`, {issue}`24031`)\", \"Add the `spec_id`, `partition`, `sort_order_id`, and `readable_metrics`\\ncolumns to the `$files` metadata table. ({issue}`24102`)\", \"Add support for configuring an OAuth2 server URI with the\\n`iceberg.rest-catalog.oauth2.server-uri` configuration property. ({issue}`23086`)\", \"Add support for retrying requests to a JDBC catalog with the\\n`iceberg.jdbc-catalog.retryable-status-codes` configuration property.\\n({issue}`23095`)\", \"Add support for case-insensitive name matching in the REST catalog. ({issue}`23715`)\", \"Add support for customer-provided SSE key in [S3 file\\nsystem](/object-storage/file-system-s3). ({issue}`22992`)\", \"Disallow adding duplicate files in the `add_files` and `add_files_from_table`\\nprocedures. ({issue}`24188`)\", \"Improve performance of Iceberg queries involving multiple table scans. ({issue}`23945`)\", \"Prevent `MERGE`, `UPDATE`, and `DELETE` query failures for tables with\\nequality deletes. ({issue}`15952`)\"], \"Ignite connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"MariaDB connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"MySQL connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Oracle connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"PostgreSQL connector\": [\"Add support for the `geometry` type. ({issue}`5580`)\", \"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Redshift connector\": [\"Add support pushing down casts from varchar to varchar and char to char into\\nRedshift. ({issue}`23808`)\", \"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"SingleStore connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Snowflake connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"SQL Server connector\": [\"Update required SQL Server version to SQL Server 2019 or higher. ({issue}`24173`)\", \"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"Vertica connector\": [\"Fix connector initialization issue when multiple catalogs with the connector\\nare configured. ({issue}`24058`)\"], \"SPI\": [\"{{breaking}} Remove deprecated variants of `checkCanExecuteQuery` and\\n`checkCanSetSystemSessionProperty` without a `QueryId` parameter from\\n`SystemAccessControl`. ({issue}`23244`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 338]\"}, {\"title\": \"Release 466 (27 Nov 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for changing the type of row fields when they are in a columns of\\ntype `map`. ({issue}`24248`)\", \"Remove the requirement for a Python runtime on Trino cluster nodes. ({issue}`24271`)\", \"Improve performance of queries involving `GROUP BY` and joins. ({issue}`23812`)\", \"Improve client protocol throughput by introducing the [spooling\\nprotocol](protocol-spooling). ({issue}`24214`)\"], \"Security\": [\"Add support for [data access control with Apache\\nRanger](/security/ranger-access-control), including support for\\ncolumn masking, row filtering, and audit logging. ({issue}`22675`)\"], \"JDBC driver\": [\"Improve throughput by automatically using the [spooling\\nprotocol](jdbc-spooling-protocol) when it is configured on the Trino cluster,\\nand add the parameter `encoding` to optionally set the preferred encoding from\\nthe JDBC driver. ({issue}`24214`)\", \"Improve decompression performance when running the client with Java 22 or\\nnewer. ({issue}`24263`)\", \"Improve performance `java.sql.DatabaseMetaData.getTables()`. ({issue}`24159`,\\n{issue}`24110`)\"], \"Server RPM\": [\"Remove Python requirement. ({issue}`24271`)\"], \"Docker image\": [\"Remove Python runtime and libraries. ({issue}`24271`)\"], \"CLI\": [\"Improve throughput by automatically use the [spooling\\nprotocol](cli-spooling-protocol) when it is configured on the Trino cluster,\\nand add the option `--encoding` to optionally set the preferred encoding from\\nthe CLI. ({issue}`24214`)\", \"Improve decompression performance when running the CLI with Java 22 or newer. ({issue}`24263`)\"], \"BigQuery connector\": [\"Add support for `LIMIT` pushdown. ({issue}`23937`)\"], \"Iceberg connector\": [\"Add support for the [object store file\\nlayout](https://iceberg.apache.org/docs/latest/aws/#object-store-file-layout).\\n({issue}`8861`)\", \"Add support for changing field types inside a map. ({issue}`24248`)\", \"Improve performance of queries with selective joins. ({issue}`24277`)\", \"Fix failure when reading columns containing nested row types that differ from\\nthe schema of the underlying Parquet data. ({issue}`22922`)\"], \"Phoenix connector\": [\"Improve performance for `MERGE` statements. ({issue}`24075`)\"], \"SQL Server connector\": [\"Rename the `sqlserver.experimental.stored-procedure-table-function-enabled`\\nconfiguration property to `sqlserver.stored-procedure-table-function-enabled`.\\n({issue}`24239`)\"], \"SPI\": [\"Add `ConnectorSplit` argument to the `SystemTable.cursor()` method. ({issue}`24159`)\", \"Add support for partial row updates to the `ConnectorMetadata.beginMerge()`\\nmethod. ({issue}`24075`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 339]\"}, {\"title\": \"Release 467 (6 Dec 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for the `DISTINCT` clause in windowed aggregate functions. ({issue}`24352`)\", \"Allow using `LISTAGG` as a windowed aggregate function. ({issue}`24366`)\", \"Change default protocol for internal communication to HTTP/1.1 to address\\nissues with HTTP/2. ({issue}`24299`)\", \"Return compressed results to clients by default when using the spooling\\nprotocol. ({issue}`24332`)\", \"Add application identifier `azure.application-id`, `gcs.application-id`, or\\n`s3.application-id` to the storage when using the spooling protocol. ({issue}`24361`)\", \"Add support for OpenTelemetry tracing to the HTTP, Kafka, and MySQL event\\nlistener. ({issue}`24389`)\", \"Fix incorrect handling of SIGTERM signal, which prevented the server from\\nshutting down. ({issue}`24380`)\", \"Fix query failures or missing statistics in `SHOW STATS` when a connector\\nreturns `NaN` values for table statistics. ({issue}`24315`)\"], \"Docker image\": [\"Remove the `microdnf` package manager. ({issue}`24281`)\"], \"Iceberg connector\": [\"Add the `$all_manifests` metadata tables. ({issue}`24330`)\", \"{{breaking}} Remove the deprecated `schema` and `table` arguments from the\\n`table_changes` table function. Use `schema_name` and `table_name` instead. ({issue}`24324`)\", \"{{breaking}} Use the `iceberg.rest-catalog.warehouse` configuration property\\ninstead of `iceberg.rest-catalog.parent-namespace` with Unity catalogs. ({issue}`24269`)\", \"Fix failure when writing concurrently with [transformed\\npartition](https://iceberg.apache.org/spec/#partition-transforms) columns.\\n({issue}`24160`)\", \"Clean up table transaction files when `CREATE TABLE` fails. ({issue}`24279`)\"], \"Delta Lake\": [\"Add the `$transactions` metadata table. ({issue}`24330`)\", \"Add the `operation_metrics` column to the `$history` metadata table. ({issue}`24379`)\"], \"SPI\": [\"{{breaking}} Remove the deprecated `SystemAccessControlFactory#create` method. ({issue}`24382`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 340]\"}, {\"title\": \"Release 468 (17 Dec 2024)\", \"description\": null, \"content\": {\"General\": [\"Add support for [](/udf/python). ({issue}`24378`)\", \"Add cluster overview to the [](/admin/preview-web-interface). ({issue}`23600`)\", \"Add new node states `DRAINING` and `DRAINED` to make it possible to reactivate\\na draining worker node. ({issue}`24444 `)\"], \"BigQuery connector\": [\"Improve performance when reading external\\n[BigLake](https://cloud.google.com/bigquery/docs/biglake-intro) tables. ({issue}`21016`)\"], \"Delta Lake connector\": [\"{{breaking}} Reduce coordinator memory usage for the Delta table metadata\\ncache and enable configuration `delta.metadata.cache-max-retained-size` to\\ncontrol memory usage. Remove the configuration property\\n`delta.metadata.cache-size` and increase the default for\\n`delta.metadata.cache-ttl` to `30m`. ({issue}`24432`)\"], \"Hive connector\": [\"Enable mismatched bucket execution optimization by default. This can be\\ndisabled with `hive.optimize-mismatched-bucket-count` configuration property\\nand the `optimize_mismatched_bucket_count` session property. ({issue}`23432`)\", \"Improve performance by deactivating bucket execution when not useful in query\\nprocessing. ({issue}`23432`)\"], \"Iceberg connector\": [\"Improve performance when running a join or aggregation on a bucketed table\\nwith bucketed execution. This can be deactivated with the\\n`iceberg.bucket-execution` configuration property and the\\n`bucket_execution_enabled` session property. ({issue}`23432`)\", \"Deprecate the `iceberg.materialized-views.storage-schema` configuration\\nproperty. ({issue}`24398`) \", \"{{breaking}} Rename the `partitions` column in the `$manifests` metadata table\\nto `partition_summaries`. ({issue}`24103`)\", \"Avoid excessive resource usage on coordinator when reading Iceberg system\\ntables. ({issue}`24396`)\"], \"PostgreSQL connector\": [\"Add support for non-transactional [MERGE statements](/sql/merge). ({issue}`23034`)\"], \"SPI\": [\"Add partitioning push down, which a connector can use to activate optional\\npartitioning or choose between multiple partitioning strategies. ({issue}`23432`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 341]\"}, {\"title\": \"Release 469 (27 Jan 2025)\", \"description\": null, \"content\": {\"General\": [\"Add support for the `FIRST`, `AFTER`, and `LAST` clauses to `ALTER TABLE ...\\nADD COLUMN`. ({issue}`20091`)\", \"Add the {func}`ST_GeomFromKML` function. ({issue}`24297`)\", \"Allow configuring the spooling client protocol behaviour with session\\nproperties. ({issue}`24655`, {issue}`24757`)\", \"Improve stability of the cluster under load. ({issue}`24572`)\", \"Prevent planning failures resulting from join pushdown for modified tables. ({issue}`24447`)\", \"Fix parsing of negative hexadecimal, octal, and binary numeric literals. ({issue}`24601`)\", \"Fix failures with recursive delete operations on S3Express preventing usage\\nfor fault-tolerant execution. ({issue}`24763`)\"], \"Web UI\": [\"Add support for filtering queries by client tags. ({issue}`24494`)\"], \"JDBC driver\": [\"Add `planningTimeMillis`, `analysisTimeMillis`, `finishingTimeMillis`,\\n`physicalInputBytes`, `physicalWrittenBytes`, `internalNetworkInputBytes` and\\n`physicalInputTimeMillis` to `io.trino.jdbc.QueryStats`. ({issue}`24571`,\\n{issue}`24604`)\", \"Improve the `Connection.isValid(int)` method so it validates the connection\\nand credentials, and add the `validateConnection` connection property.\\n({issue}`24127`, {issue}`22684`)\", \"Prevent failures when using the spooling protocol with a cluster using its own\\ncertificate chain. ({issue}`24595`)\", \"Fix deserialization failures with `SetDigest`, `BingTile`, and `Color` types. ({issue}`24612`)\"], \"CLI\": [\"Prevent failures when using the spooling protocol with a cluster using its own\\ncertificate chain. ({issue}`24595`)\", \"Fix deserialization of `SetDigest`, `BingTile`, and `Color` types. ({issue}`24612`)\"], \"BigQuery connector\": [\"Allow configuration of the channel pool for gRPC communication with BigQuery. ({issue}`24638`)\"], \"ClickHouse connector\": [\"{{breaking}} Raise minimum required versions to ClickHouse 24.3 and Altinity\\n22.3. ({issue}`24515`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Delta Lake connector\": [\"Add support for SSE-C in S3 security mapping. ({issue}`24566`)\", \"Allow configuring the endpoint for the Google Storage file system with the\\n`gcs.endpoint` property. ({issue}`24626`)\", \"Improve performance of reading from new Delta Lake table data by compressing\\nfiles with `ZSTD` by default, instead of the previous `SNAPPY`.\\n({issue}`17426`)\", \"Improve performance of queries on tables with large transaction log JSON\\nfiles. ({issue}`24491`)\", \"Improve performance of reading from Parquet files with a large number of row\\ngroups. ({issue}`24618`)\", \"Improve performance for the `OPTIMIZE` statement by enabling concurrent\\nexecution. ({issue}`16985`)\", \"Improve performance of reading from large files on S3. ({issue}`24521`)\", \"Correct catalog information in JMX metrics when using file system caching with\\nmultiple catalogs. ({issue}`24510`)\", \"Fix table read failures when using the Alluxio file system. ({issue}`23815`)\", \"Fix incorrect results when updating tables with deletion vectors enabled. ({issue}`24648`)\", \"Fix incorrect results when reading from tables with deletion vectors enabled. ({issue}`22972`)\"], \"Elasticsearch connector\": [\"Improve performance of queries that reference nested fields from Elasticsearch\\ndocuments. ({issue}`23069`)\"], \"Faker connector\": [\"Add support for views. ({issue}`24242`)\", \"Support generating sequences. ({issue}`24590`)\", \"{{breaking}} Replace specifying constraints using `WHERE` clauses with the\\n`min`, `max`, and `options` column properties. ({issue}`24147`)\"], \"Hive connector\": [\"Add support for SSE-C in S3 security mapping. ({issue}`24566`)\", \"Allow configuring the endpoint for the Google Storage file system with the\\n`gcs.endpoint` property. ({issue}`24626`)\", \"Split AWS SDK client retry count metrics into separate client-level, logical\\nretries and lower-level HTTP client retries. ({issue}`24606`)\", \"Improve performance of reading from Parquet files with a large number of row\\ngroups. ({issue}`24618`)\", \"Improve performance of reading from large files on S3. ({issue}`24521`)\", \"Correct catalog information in JMX metrics when using file system caching with\\nmultiple catalogs. ({issue}`24510`)\", \"Fix table read failures when using the Alluxio file system. ({issue}`23815`)\", \"Prevent writing of invalid data for NaN, Infinity, -Infinity values to JSON\\nfiles. ({issue}`24558`)\"], \"Hudi connector\": [\"Add support for SSE-C in S3 security mapping. ({issue}`24566`)\", \"Allow configuring the endpoint for the Google Storage file system with the\\n`gcs.endpoint` property. ({issue}`24626`)\", \"Improve performance of reading from Parquet files with a large number of row\\ngroups. ({issue}`24618`)\", \"Improve performance of reading from large files on S3. ({issue}`24521`)\"], \"Iceberg connector\": [\"Add support for the `FIRST`, `AFTER`, and `LAST` clauses to `ALTER TABLE ...\\nADD COLUMN`. ({issue}`20091`)\", \"Add support for SSE-C in S3 security mapping. ({issue}`24566`)\", \"Allow configuring the endpoint for the Google Storage file system with the\\n`gcs.endpoint` property. ({issue}`24626`)\", \"Add `$entries` metadata table. ({issue}`24172`)\", \"Add `$all_entries` metadata table. ({issue}`24543`)\", \"Allow configuring the `parquet_bloom_filter_columns` table property. ({issue}`24573`)\", \"Allow configuring the `orc_bloom_filter_columns` table property. ({issue}`24584`)\", \"Add the `rollback_to_snapshot` table procedure. The existing\\n`system.rollback_to_snapshot` procedure is deprecated. ({issue}`24580`)\", \"Improve performance when listing columns. ({issue}`23909`)\", \"Improve performance of reading from Parquet files with a large number of row\\ngroups. ({issue}`24618`)\", \"Improve performance of reading from large files on S3. ({issue}`24521`)\", \"Remove the oldest tracked version metadata files when\\n`write.metadata.delete-after-commit.enabled` is set to `true`. ({issue}`19582`)\", \"Correct catalog information in JMX metrics when using file system caching with\\nmultiple catalogs. ({issue}`24510`)\", \"Fix table read failures when using the Alluxio file system. ({issue}`23815`)\", \"Prevent return of incomplete results by the `table_changes` table function. ({issue}`24709`) \", \"Prevent failures on queries accessing tables with multiple nested partition\\ncolumns. ({issue}`24628`)\"], \"Ignite connector\": [\"Add support for `MERGE` statements. ({issue}`24443`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Kudu connector\": [\"Add support for unpartitioned tables. ({issue}`24661`)\"], \"MariaDB connector\": [\"Add support for the `FIRST`, `AFTER`, and `LAST` clauses to `ALTER TABLE ...\\nADD COLUMN`. ({issue}`24735`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"MySQL connector\": [\"Add support for the `FIRST`, `AFTER`, and `LAST` clauses to `ALTER TABLE ...\\nADD COLUMN`. ({issue}`24735`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Oracle connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Phoenix connector\": [\"Allow configuring scan page timeout with the\\n`phoenix.server-scan-page-timeout` configuration property. ({issue}`24689`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"PostgreSQL connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Redshift connector\": [\"Improve performance of reading from Redshift tables. ({issue}`24117`)\", \"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"SingleStore connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Snowflake connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"SQL Server connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"Vertica connector\": [\"Fix failure when updating values to `NULL`. ({issue}`24204`)\"], \"SPI\": [\"Remove support for connector-level event listeners and the related\\n`Connector.getEventListeners()` method. ({issue}`24609`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 342]\"}, {\"title\": \"Release 470 (5 Feb 2025)\", \"description\": null, \"content\": {\"General\": [\"Add [](/connector/duckdb). ({issue}`18031`)\", \"Add [](/connector/loki). ({issue}`23053`)\", \"Add support for the [](select-with-session) to set per-query session\\nproperties with `SELECT` queries. ({issue}`24889`)\", \"Improve compatibility of fault-tolerant exchange storage with S3-compliant\\nobject stores. ({issue}`24822`)\", \"Allow skipping directory schema validation to improve compatibility of\\nfault-tolerant exchange storage with HDFS-like file systems. This can be\\nconfigured with the `exchange.hdfs.skip-directory-scheme-validation` property. ({issue}`24627`)\", \"Export JMX metric for `blockedQueries`. ({issue}`24907`)\", \"{{breaking}} Remove support for the `optimize_hash_generation` session\\nproperty and the `optimizer.optimize-hash-generation` configuration option.\\n({issue}`24792`)\", \"Fix failure when using upper-case variable names in SQL user-defined\\nfunctions. ({issue}`24460`)\", \"Prevent failures of the {func}`array_histogram` function when the input\\ncontains null values. ({issue}`24765`)\"], \"JDBC driver\": [\"{{breaking}} Raise minimum runtime requirement to Java 11. ({issue}`23639`)\"], \"CLI\": [\"{{breaking}} Raise minimum runtime requirement to Java 11. ({issue}`23639`)\"], \"Delta Lake connector\": [\"Prevent connection leakage when using the Azure Storage file system. ({issue}`24116`)\", \"Deprecate use of the legacy file system support for Azure Storage, Google\\nCloud Storage, IBM Cloud Object Storage, S3 and S3-compatible object storage\\nsystems. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`24878`)\", \"Fix potential table corruption when using the `vacuum` procedure. ({issue}`24872`)\"], \"Faker connector\": [\"[Derive constraints](faker-statistics) from source data when using `CREATE TABLE ... AS SELECT`. ({issue}`24585`)\"], \"Hive connector\": [\"Deprecate use of the legacy file system support for Azure Storage, Google\\nCloud Storage, IBM Cloud Object Storage, S3 and S3-compatible object storage\\nsystems. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`24878`)\", \"Prevent connection leakage when using the Azure Storage file system. ({issue}`24116`)\", \"Fix NullPointerException when listing tables on Glue. ({issue}`24834`)\"], \"Hudi connector\": [\"Deprecate use of the legacy file system support for Azure Storage, Google\\nCloud Storage, IBM Cloud Object Storage, S3 and S3-compatible object storage\\nsystems. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`24878`)\", \"Prevent connection leakage when using the Azure Storage file system. ({issue}`24116`)\"], \"Iceberg connector\": [\"Add the [optimize_manifests](iceberg-optimize-manifests) table procedure. ({issue}`14821`)\", \"Allow configuration of the number of commit retries with the\\n`max_commit_retry` table property. ({issue}`22672`)\", \"Allow caching of table metadata when using the Hive metastore. ({issue}`13115`)\", \"Deprecate use of the legacy file system support for Azure Storage, Google\\nCloud Storage, IBM Cloud Object Storage, S3 and S3-compatible object storage\\nsystems. Use the migration guides for [Azure\\nStorage](fs-legacy-azure-migration), [Google Cloud\\nStorage](fs-legacy-gcs-migration), and [S3](fs-legacy-s3-migration) to assist\\nif you have not switched from legacy support. ({issue}`24878`)\", \"Prevent connection leakage when using the Azure Storage file system. ({issue}`24116`)\", \"Fix failure when adding a new column with a name containing a dot. ({issue}`24813`)\", \"Fix failure when reading from tables with [equality\\ndeletes](https://iceberg.apache.org/spec/#equality-delete-files) with nested\\nfields. ({issue}`18625`)\", \"Fix failure when reading `$entries` and `$all_entries` tables using [equality\\ndeletes](https://iceberg.apache.org/spec/#equality-delete-files). ({issue}`24775`)\"], \"JMX connector\": [\"Prevent missing metrics values when MBeans in coordinator and workers do not\\nmatch. ({issue}`24908`)\"], \"Kinesis connector\": [\"{{breaking}} Remove the Kinesis connector. ({issue}`23923`) \"], \"MySQL connector\": [\"Add support for `MERGE` statement. ({issue}`24428`)\", \"Prevent writing of invalid, negative date values. ({issue}`24809`)\"], \"PostgreSQL connector\": [\"Raise minimum required version to PostgreSQL 12. ({issue}`24836`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 343]\"}, {\"title\": \"Release 471 (19 Feb 2025)\", \"description\": null, \"content\": {\"General\": [\"Add [](/functions/ai) for textual tasks on data using OpenAI, Anthropic, or\\nother LLMs using Ollama as backend. ({issue}`24963`)\", \"Include split count and total split distribution time in the `EXPLAIN ANALYZE`\\noutput. ({issue}`25028`)\", \"Add support for JSON logging format to console with `log.console-format=JSON`. ({issue}`25081`)\", \"Support additional Python libraries for use with Python user-defined\\nfunctions. ({issue}`25058`)\", \"Improve performance for Python user-defined functions. ({issue}`25058`)\", \"Improve performance for queries involving `ORDER BY ... LIMIT`. ({issue}`24937`)\", \"Prevent failures when fault-tolerant execution is configured with an exchange\\nmanager that uses Azure storage with workload identity. ({issue}`25063`)\"], \"Server RPM\": [\"Remove RPM package. Use the tarball or container image instead, or build an\\nRPM with the setup in the [trino-packages\\nrepository](https://github.com/trinodb/trino-packages). ({issue}`24997`)\"], \"Security\": [\"Ensure that custom XML configuration files specified in the\\n`access-control.properties` file are used during Ranger access control plugin\\ninitialization. ({issue}`24887`)\"], \"Delta Lake connector\": [\"Add support for reading `variant` type. ({issue}`22309`)\", \"Add [](/object-storage/file-system-local). ({issue}`25006`)\", \"Support reading cloned tables. ({issue}`24946`)\", \"Add support for configuring `s3.storage-class` when writing objects to S3. ({issue}`24698`)\", \"Fix failures when writing large checkpoint files. ({issue}`25011`)\"], \"Hive connector\": [\"Add [](/object-storage/file-system-local). ({issue}`25006`)\", \"Add support for configuring `s3.storage-class` when writing objects to S3. ({issue}`24698`)\", \"Fix reading restored S3 glacier objects when the configuration property\\n`hive.s3.storage-class-filter` is set to `READ_NON_GLACIER_AND_RESTORED`. ({issue}`24947`)\"], \"Hudi connector\": [\"Add [](/object-storage/file-system-local). ({issue}`25006`)\", \"Add support for configuring `s3.storage-class` when writing objects to S3. ({issue}`24698`)\"], \"Iceberg connector\": [\"Add [](/object-storage/file-system-local). ({issue}`25006`)\", \"Add support for [S3 Tables](https://aws.amazon.com/s3/features/tables/). ({issue}`24815`)\", \"Add support for configuring `s3.storage-class` when writing objects to S3. ({issue}`24698`)\", \"Improve conflict detection to avoid failures from concurrent `MERGE` queries\\non Iceberg tables. ({issue}`24470`)\", \"Ensure that the `task.max-writer-count` configuration is respected for write\\noperations on partitioned tables. ({issue}`25068`)\"], \"MongoDB connector\": [\"Fix failures caused by tables with case-sensitive name conflicts. ({issue}`24998`)\"], \"SPI\": [\"Remove `Connector.getInitialMemoryRequirement()`. ({issue}`25055`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 344]\"}, {\"title\": \"Release 472 (5 Mar 2025)\", \"description\": null, \"content\": {\"General\": [\"Color the server console output for improved readability. ({issue}`25090`)\", \"{{breaking}} Rename HTTP client property prefixes from `workerInfo` and\\n`memoryManager` to `worker-info` and `memory-manager`. ({issue}`25099`)\", \"Fix failure for queries with large numbers of expressions in the `SELECT` clause. ({issue}`25040`)\", \"Improve performance of certain queries involving `ORDER BY ... LIMIT` with subqueries. ({issue}`25138`)\", \"Fix incorrect results when passing an array that contains nulls to\\n`cosine_distance` and `cosine_similarity`. ({issue}`25195`)\", \"Prevent improper use of `WITH SESSION` with non-`SELECT` queries. ({issue}`25112`)\"], \"JDBC driver\": [\"Provide a `javax.sql.DataSource` implementation. ({issue}`24985`)\", \"Fix roles being cleared after invoking `SET SESSION AUTHORIZATION` or \\n`RESET SESSION AUTHORIZATION`. ({issue}`25191`)\"], \"Docker image\": [\"Improve performance when using Snappy compression. ({issue}`25143`)\", \"Fix initialization failure for the DuckDB connector. ({issue}`25143`)\"], \"BigQuery connector\": [\"Improve performance of listing tables when\\n`bigquery.case-insensitive-name-matching` is enabled. ({issue}`25222`)\"], \"Delta Lake connector\": [\"Improve support for highly concurrent table modifications. ({issue}`25141`)\"], \"Faker connector\": [\"Add support for the `row` type and generate empty values for `array`, `map`,\\nand `json` types. ({issue}`25120`)\"], \"Iceberg connector\": [\"Add the `$partition` hidden column. ({issue}`24301`)\", \"Fix incorrect results when reading Iceberg tables after deletes were\\nperformed. ({issue}`25151`)\"], \"Loki connector\": [\"Fix connection failures with Loki version higher than 3.2.0. ({issue}`25156`)\"], \"PostgreSQL connector\": [\"Improve performance for queries involving cast of\\n[integer types](integer-data-types). ({issue}`24950`)\"], \"SPI\": [\"Remove the deprecated `ConnectorMetadata.addColumn(ConnectorSession session,\\nConnectorTableHandle tableHandle, ColumnMetadata column)` method. Use the\\n`ConnectorMetadata.addColumn(ConnectorSession session, ConnectorTableHandle\\ntableHandle, ColumnMetadata column, ColumnPosition position)` instead.\\n({issue}`25163`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 345]\"}, {\"title\": \"Release 473 (19 Mar 2025)\", \"description\": null, \"content\": {\"General\": [\"Add support for array literals. ({issue}`25301`)\", \"Reduce the amount of memory required for `DISTINCT` and `GROUP BY` operations. ({issue}`25127`)\", \"Improve performance of `GROUP BY` and `DISTINCT` aggregations when spilling to disk is enabled \\nor grouping by `row`, `array`, or `map` columns ({issue}`25294`)\", \"Fix failure when setting comments on columns with upper case letters. ({issue}`25297`)\", \"Fix potential query failure when `retry_policy` set to `TASK` ({issue}`25217`)\"], \"Security\": [\"Add LDAP-based group provider. ({issue}`23900`)\", \"Fix column masks not being applied on view columns with upper case. ({issue}`24054`)\"], \"BigQuery connector\": [\"Fix failure when initializing the connector on a machine with more than 32 CPU cores. ({issue}`25228`)\"], \"Delta Lake connector\": [\"Remove the deprecated `glue-v1` metastore type. ({issue}`25201`)\", \"Remove deprecated Databricks Unity catalog integration. ({issue}`25250`)\", \"Fix Glue endpoint URL override. ({issue}`25324`)\"], \"Hive connector\": [\"Remove the deprecated `glue-v1` metastore type. ({issue}`25201`)\", \"Remove deprecated Databricks Unity catalog integration. ({issue}`25250`)\", \"Fix Glue endpoint URL override. ({issue}`25324`)\"], \"Hudi connector\": [\"Fix queries getting stuck when reading empty partitions. ({issue}`19506 `)\", \"Remove the deprecated `glue-v1` metastore type. ({issue}`25201`)\", \"Fix Glue endpoint URL override. ({issue}`25324`)\"], \"Iceberg connector\": [\"Set the `write.<filetype>.compression-codec` table property when creating new tables. ({issue}`24851`)\", \"Expose additional properties in `$properties` tables. ({issue}`24812`)\", \"Fix Glue endpoint URL override. ({issue}`25324`)\"], \"Kudu connector\": [\"Remove the Kudu connector. ({issue}`24417`)\"], \"Phoenix connector\": [\"Remove the Phoenix connector. ({issue}`24135`)\"], \"SPI\": [\"Add `SourcePage` interface and `ConnectorPageSource.getNextSourcePage()`. ({issue}`24011`)\", \"Deprecate `ConnectorPageSource.getNextPage()` for removal. ({issue}`24011`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 346]\"}, {\"title\": \"Release 474 (21 Mar 2025)\", \"description\": null, \"content\": {\"General\": [\"Add `originalUser` and `authenticatedUser` as resource group selectors. ({issue}`24662`)\", \"Fix a correctness bug in `GROUP BY` or `DISTINCT` queries with a large number\\nof unique groups. ({issue}`25381`)\"], \"Docker image\": [\"Use JDK 24 in the runtime. ({issue}`23501`)\"], \"Delta Lake connector\": [\"Fix failure for `MERGE` queries on\\n[cloned](https://delta.io/blog/delta-lake-clone/) tables. ({issue}`24756`)\"], \"Iceberg connector\": [\"Add support for setting session timeout on iceberg REST catalog instances with\\nthe Iceberg catalog configuration property\\n`iceberg.rest-catalog.session-timeout`. Defaults to `1h`. ({issue}`25160`)\", \"Add support for configuring whether OAuth token refreshes are enabled for\\nIceberg REST catalogs with theIceberg catalog configugration property\\n`iceberg.rest-catalog.oauth2.token-refresh-enabled`. Defaults to `true`. ({issue}`25160`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 347]\"}, {\"title\": \"Release 475 (23 Apr 2025)\", \"description\": null, \"content\": {\"General\": [\"Add support for the `CORRESPONDING` clause in set operations. ({issue}`25260`)\", \"Add support for the `AUTO` grouping set that includes all non-aggregated columns \\nin the `SELECT` clause. ({issue}`18390`)\", \"Publish additional metrics for input tables in event listener. ({issue}`25475`)\", \"Expose dynamic filter statistics in the `QueryCompletedEvent`. ({issue}`25575`)\", \"Improve scalability of inline data encoding in the spooling client protocol. ({issue}`25439`)\", \"Improve performance of queries involving the `exclude_columns` table function. ({issue}`25117`)\", \"Disallow dropping the `system` catalog. ({issue}`24745`)\", \"Fix occasional query failures when [adaptive planning](/optimizer/adaptive-plan-optimizations) is enabled. ({issue}`25411`)\", \"Fix incorrect results when using window functions with `DISTINCT`. ({issue}`25434`)\", \"Fix query failures with `EXCEEDED_LOCAL_MEMORY_LIMIT` errors due to incorrect memory accounting. ({issue}`25600`)\", \"Properly handle inline session properties for `EXPLAIN` queries. ({issue}`25496`)\", \"Add support for exporting OpenTelemetry traces using the HTTP protocol with the `tracing.exporter.protocol` \\nconfiguration property set to `http/protobuf`. ({issue}`25573`)\"], \"Security\": [\"Fix incorrect access denial for access control with impersonation when access is granted via the role. ({issue}`25166`)\"], \"JDBC driver\": [\"Avoid query cancellation when the client is fetching results. ({issue}`25267`)\"], \"CLI\": [\"Avoid query cancellation when the client is fetching results. ({issue}`25267`)\"], \"Clickhouse connector\": [\"Add support for Clickhouse's `bool` type. ({issue}`25130`)\"], \"BigQuery connector\": [\"Add support for limiting the max parallelism with the `bigquery.max-parallelism` configuration property. ({issue}`25422`)\", \"Fix queries getting stuck when reading large tables. ({issue}`25423`)\"], \"Delta Lake connector\": [\"Allow cross-region data retrieval when using the S3 native filesystem. ({issue}`25200`)\", \"Add support for all storage classes when using the S3 native filesystem for writes. ({issue}`25435`)\", \"Improve performance when filtering on `$path`, `$file_modified_time` or `$file_size` columns. ({issue}`25369`)\", \"Improve performance of scans on Delta Lake tables with v2 checkpoints. ({issue}`25469`)\"], \"Hive connector\": [\"Allow cross-region data retrieval when using the S3 native filesystem. ({issue}`25200`)\", \"Add support for all storage classes when using the S3 native filesystem for writes. ({issue}`25435`)\", \"Add support for showing column comments on Hive views. ({issue}`23845`)\", \"Add support for multiple predicates on partition projection columns with [injected types](https://docs.aws.amazon.com/athena/latest/ug/partition-projection-supported-types.html#partition-projection-injected-type). ({issue}`17641`)\", \"Fix potential failures or incorrect results when querying partitioned tables using the OpenX JSON SerDe. ({issue}`25444`)\", \"Ensure Hive metastore locks are released if a failure occurs during lock acquisition. ({issue}`25380`)\", \"Rename `hive.s3.storage-class-filter` to `hive.s3-glacier-filter` to better reflect its purpose. ({issue}`25633`)\", \"Fix incorrect results when reading timestamp values with leading or trailing spaces using the Regex and \\nOpenX JSON table deserializers. ({issue}`25442`)\", \"Fix potential performance regression when reading ORC data. ({issue}`25617`)\"], \"Iceberg connector\": [\"Allow cross-region data retrieval when using the S3 native filesystem. ({issue}`25200`)\", \"Add support for all storage classes when using the S3 native filesystem for writes. ({issue}`25435`)\", \"Add `system.iceberg_tables` system table to allow listing only Iceberg tables. ({issue}`25136`)\", \"Add support for IAM role authentication with the REST catalog. ({issue}`25002`)\", \"Fix potential failure when queries modify a table concurrently. ({issue}`25445`)\", \"Add support for returning column statistics for new columns in `$partitions` system table. ({issue}`25532`)\", \"Improve the `optimize_manifests` procedure to produce better organized manifests. ({issue}`25378`)\", \"Clean up old snapshots when refreshing a materialized view. ({issue}`25343`)\", \"Set Glue catalog ID when `hive.metastore.glue.catalogid` is configured. ({issue}`25511`)\", \"Fix failure when executing `migrate` on tables partitioned on columns with special characters. ({issue}`25106`)\", \"Fix `OPTIMIZE` failures due to commit conflicts with certain `DELETE` queries. ({issue}`25584`)\", \"Fix failure when analyzing a table without any snapshots. ({issue}`25563`)\"], \"Memory connector\": [\"Fix incorrect memory usage accounting for truncated tables. ({issue}`25564`)\"], \"MySQL connector\": [\"Add support for creating tables with a primary key. ({issue}`24930`)\"], \"PostgreSQL connector\": [\"Add support for MERGE when `retry_policy` is set to `TASK`. ({issue}`24467`)\", \"Add support for `array(uuid)` type. ({issue}`25557`)\"], \"SQL Server connector\": [\"Fix incorrect results for queries involving `LIKE` on columns with case-insensitive collations. ({issue}`25488`)\"], \"SPI\": [\"Remove the `LazyBlock` class. ({issue}`25255`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 348]\"}, {\"title\": \"Release 476 (5 Jun 2025)\", \"description\": null, \"content\": {\"General\": [\"Add support for comparing values of `geometry` type. ({issue}`25225`)\", \"{{breaking}} Require JDK 24 to run Trino. ({issue}`23498`)\", \"Allow configuring `query.max-memory-per-node` and `memory.heap-headroom-per-node` \\nrelative to maximum heap size. ({issue}`25843`)\", \"Add feature to deactivate the automated database schema migration for the database \\nbackend for resource groups with the property `resource-groups.db-migrations-enabled`. ({issue)`25451`)\", \"Make soft memory limit optional in resource groups. ({issue}`25916`)\", \"Remove the [](/develop/example-http) from the tar.gz archive and the Docker container. ({issue}`25128`)\", \"Fix rare bug when server can hang under load. ({issue}`25816`)\", \"Fix regression introduce in Trino 474 that prevented graceful shutdown from working. ({issue}`25690`)\", \"Fix potential query failure when the `fault_tolerant_execution_runtime_adaptive_partitioning_enabled` \\nsession property is set to `true`. ({issue}`25870`)\", \"Fix failure for queries involving casts with `row` types. ({issue}`25864`)\", \"Fix query failures when dynamic catalog names contain mixed case letters. ({issue}`25701`)\", \"Improve retry logic for S3 operations in file system exchange. ({issue}`25908`)\", \"Fix query failures when the session catalog or schema names provided by clients contain \\ncapital letters. ({issue}`25903`)\"], \"BigQuery connector\": [\"{{breaking}} Require the `--sun-misc-unsafe-memory-access=allow` JVM configuration \\noption to run Trino with the connector. ({issue}`25669`)\"], \"ClickHouse connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Delta Lake connector\": [\"Add support for the `FOR TIMESTAMP AS OF` clause. ({issue}`21024`)\", \"Add support for user-assigned managed identity authentication for AzureFS. ({issue}`23447`)\", \"Add signer type support to the native S3 filesystem. ({issue}`25820`)\", \"Improve compatibility with S3-compliant storage systems. ({issue}`25791`)\", \"Improve query planning performance. ({issue}`24570`)\", \"Improve performance when reading tables. ({issue}`25826`)\", \"Reduce S3 throttling failures. ({issue}`25781`)\", \"Fix failure when reading `variant` type column after executing `optimize` \\nprocedure. ({issue}`25666`)\", \"Fix query failures when attempting to read `date` columns stored as integer\\nvalues in Parquet files. ({issue}`25667`)\", \"Fix failure when querying views without [StorageDescriptor](https://docs.aws.amazon.com/glue/latest/webapi/API_StorageDescriptor.html)\\non Glue. ({issue}`25894`)\", \"Fix skipping statistics computation on all columns when only some column types\\ndon't support statistics. ({issue}`24487`)\"], \"Druid connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"DuckDB connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Exasol connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Google Sheets connector\": [\"Add support for authentication using delegated user credentials with the \\n`gsheets.delegated-user-email` configuration property. ({issue}`25746`)\"], \"Hive connector\": [\"Add support for excluding certain tables from the directory listing cache \\nwith the `hive.file-status-cache.excluded-tables` configuration property. ({issue}`25715`)\", \"Allow selecting the AWS signing protocol to use when authenticating S3 requests. ({issue}`25820`)\", \"Improve compatibility with S3-compliant storage systems. ({issue}`25791`)\", \"Add support for user-assigned managed identity authentication for AzureFS. ({issue}`23447`)\", \"Improve robustness of the OpenX JSON reader when parsing timestamp values. Previously,\\nonly timestamps with a space separator between date and time were supported. ({issue}`25792`)\", \"Improve metadata reading performance by optimizing directory listing cache behavior. ({issue}`25749`)\", \"Fix query failures with `HIVE_CANNOT_OPEN_SPLIT` error when reading ORC files with a large row count. ({issue}`25634`)\", \"Reduce S3 throttling failures. ({issue}`25781`)\", \"Fix query failures when attempting to read `date` columns stored as integer\\nvalues in Parquet files. ({issue}`25667`)\", \"Fix failure when querying views without [StorageDescriptor](https://docs.aws.amazon.com/glue/latest/webapi/API_StorageDescriptor.html) \\non Glue. ({issue}`25894`)\"], \"Hudi connector\": [\"Add support for user-assigned managed identity authentication for AzureFS. ({issue}`23447`)\", \"Fix query failures when attempting to read `date` columns stored as integer\\nvalues in Parquet files. ({issue}`25667`)\"], \"Iceberg connector\": [\"Add support for user-assigned managed identity authentication for AzureFS. ({issue}`23447`)\", \"Add signer type support to the native S3 filesystem. ({issue}`25820`)\", \"Add the `added_delete_files_count`, `existing_delete_files_count`, `deleted_delete_files_count`, and\\n`reference_snapshot_id` columns to `$all_manifests` metadata tables. ({issue}`25867`)\", \"Improve compatibility with S3-compliant storage systems. ({issue}`25791`)\", \"Show detailed metrics from splits generation in output of `EXPLAIN ANALYZE VERBOSE`. ({issue}`25770`)\", \"Add the `max_partitions_per_writer` catalog session property, which corresponds to the \\n`iceberg.max-partitions-per-writer` configuration property. ({issue}`25662`)\", \"Improve query planning performance when reading from materialized views. ({issue}`24734`)\", \"Prevent rare failure when `iceberg.bucket-execution` is enabled. ({issue}`25125`)\", \"Fix query failures with `HIVE_CANNOT_OPEN_SPLIT` error when reading ORC files with a large row count. ({issue}`25634`)\", \"Reduce S3 throttling failures. ({issue}`25781`)\", \"Fix query timeout errors due to concurrent writes on tables with large number of \\nmanifest files. ({issue}`24751`)\", \"Fix query failures when attempting to read `date` columns stored as integer\\nvalues in Parquet files. ({issue}`25667`)\", \"Fix failure when querying views without [StorageDescriptor](https://docs.aws.amazon.com/glue/latest/webapi/API_StorageDescriptor.html)\\non Glue. ({issue}`25894`)\"], \"Ignite connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Kafka event Listener\": [\"{{breaking}} Remove the `kafka-event-listener.client-config-overrides` configuration\\nproperty. To configure the Kafka client for the event listener, specify the configuration\\nin a separate file and set `kafka-event-listener.config.resources` to the path to the file. ({issue}`25553`)\"], \"MariaDB connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Memory connector\": [\"Fix failures when deleting rows from a table. ({issue}`25670`)\"], \"MySQL connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Oracle connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\", \"Improve performance of listing table columns. ({issue}`25231`)\"], \"PostgreSQL connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Redshift connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"SingleStore connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Snowflake connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\", \"{{breaking}} Require the `--sun-misc-unsafe-memory-access=allow` JVM configuration\\noption to run Trino with the connector. ({issue}`25669`)\"], \"SQL Server connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"Vertica connector\": [\"Improve performance of selective joins for federated queries. ({issue}`25123`)\"], \"SPI\": [\"Return an estimate of the full data size of the block with `getSizeInBytes()`. ({issue}`25256`)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28, \\\"subpages\\\", 349]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 28]\"}, {\"title\": \"Security\", \"description\": \"Documentation section: security\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/security\"}, \"subpages\": [{\"title\": \"Authentication types\", \"description\": null, \"content\": {\"Multiple authentication types\": \"You can use multiple authentication types, separated with commas in the\\nconfiguration:\\n\\n```\\nhttp-server.authentication.type=PASSWORD,CERTIFICATE\\n```\\n\\nAuthentication is performed in order of the entries, and first successful\\nauthentication results in access, using the {doc}`mapped user <user-mapping>`\\nfrom that authentication method.\", \"Multiple password authenticators\": \"You can use multiple password authenticator types by referencing multiple\\nconfiguration files:\\n\\n```\\nhttp-server.authentication.type=PASSWORD\\npassword-authenticator.config-files=etc/ldap1.properties,etc/ldap2.properties,etc/password.properties\\n```\\n\\nIn the preceding example, the configuration files `ldap1.properties` and\\n`ldap2.properties` are regular {doc}`LDAP authenticator configuration files\\n<ldap>`. The `password.properties` is a {doc}`password file authenticator\\nconfiguration file <password-file>`.\\n\\nRelative paths to the installation directory or absolute paths can be used.\\n\\nUser authentication credentials are first validated against the LDAP server from\\n`ldap1`, then the separate server from `ldap2`, and finally the password\\nfile. First successful authentication results in access, and no further\\nauthenticators are called.\", \"Multiple header authenticators\": \"You can use multiple header authenticator types by referencing multiple\\nconfiguration files:\\n\\n```\\nhttp-server.authentication.type=HEADER\\nheader-authenticator.config-files=etc/xfcc.properties,etc/azureAD.properties\\n```\\n\\nRelative paths to the installation directory or absolute paths can be used.\\n\\nThe pre-configured headers are first validated against the `xfcc` authenticator,\\nthen the `azureAD` authenticator. First successful authentication results in access,\\nand no further authenticators are called.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 0]\"}, {\"title\": \"System access control\", \"description\": null, \"content\": {\"Multiple access control systems\": \"Multiple system access control implementations may be configured at once using\\nthe `access-control.config-files` configuration property. It must contain a\\ncomma-separated list of the access control property files to use, rather than\\nthe default `etc/access-control.properties`. Relative paths from the Trino\\n`INSTALL_PATH` or absolute paths are supported. Each system is configured in a\\nseparate configuration file.\\n\\nThe configured access control systems are checked until access rights are denied\\nby a system. If no denies are issued by any system, the request is granted.\\nTherefore all configured access control systems are used and evaluated for each\\nrequest that is granted.\\n\\nFor example, you can combine `file` access control and `ranger` access control\\nwith the two separate configuration files `file-based.properties` and\\n`ranger.properties`.\\n\\n```\\naccess-control.config-files=etc/file-based.properties,etc/ranger.properties\\n```\\n\\n:::{warning}\\n\\nUsing multiple access control systems can be very complex to configure and\\nmaintain. In addition, each system and policy within each system is\\nevaluated for each query, which can have a considerable, negative performance\\nimpact.\\n\\n:::\", \"Available access control systems\": \"Trino offers the following built-in system access control implementations:\\n\\n:::{list-table}\\n:widths: 20, 80\\n:header-rows: 1\\n\\n[['Name', 'Description'], ['`default`', 'All operations are permitted, except for user impersonation and triggering\\\\n[](/admin/graceful-shutdown).', 'This is the default access control if none are configured.'], ['`allow-all`', 'All operations are permitted.'], ['`read-only`', 'Operations that read data or metadata are permitted, but none of the\\\\noperations that write data or metadata are allowed.'], ['`file`', 'Authorization rules are specified in a config file. See\\\\n[](/security/file-system-access-control).'], ['`opa`', 'Use Open Policy Agent (OPA) for authorization. See\\\\n[](/security/opa-access-control).'], ['`ranger`', 'Use Apache Ranger policies for authorization. See\\\\n[](/security/ranger-access-control).\\\\n:::']]\\n\\nIf you want to limit access on a system level in any other way than the ones\\nlisted above, you must implement a custom {doc}`/develop/system-access-control`.\\n\\nAccess control must be configured on the coordinator. Authorization for\\noperations on specific worker nodes, such a triggering\\n{doc}`/admin/graceful-shutdown`, must also be configured on all workers.\", \"Read only system access control\": \"This access control allows any operation that reads data or\\nmetadata, such as `SELECT` or `SHOW`. Setting system level or catalog level\\nsession properties is also permitted. However, any operation that writes data or\\nmetadata, such as `CREATE`, `INSERT` or `DELETE`, is prohibited.\\nTo use this access control, add an `etc/access-control.properties`\\nfile with the following contents:\\n\\n```\\naccess-control.name=read-only\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 1]\"}, {\"title\": \"Certificate authentication\", \"description\": null, \"content\": {\"Using certificate authentication\": \"All clients connecting with TLS/HTTPS go through the following initial steps:\\n\\n['The client attempts to contact the coordinator.', 'The coordinator returns its certificate to the client.', \\\"The client validates the server's certificate using the client's trust store.\\\"]\\n\\nA cluster with certificate authentication enabled goes through the following\\nadditional steps:\\n\\n['The coordinator asks the client for its certificate.', 'The client responds with its certificate.', \\\"The coordinator verifies the client's certificate, using the coordinator's\\\\ntrust store.\\\"]\\n\\nSeveral rules emerge from these steps:\\n\\n[\\\"Trust stores used by clients must include the certificate of the signer of\\\\nthe coordinator's certificate.\\\", 'Trust stores used by coordinators must include the certificate of the signer\\\\nof client certificates.', 'The trust stores used by the coordinator and clients do not need to be the\\\\nsame.', 'The certificate that verifies the coordinator does not need to be the same as\\\\nthe certificate verifying clients.']\\n\\nTrino validates certificates based on the distinguished name (DN) from the\\nX.509 `Subject` field. You can use {doc}`user mapping\\n</security/user-mapping>` to map the subject DN to a Trino username.\\n\\nThere are three levels of client certificate support possible. From the point of\\nview of the server:\\n\\n['The server does not require a certificate from clients.', 'The server asks for a certificate from clients, but allows connection without one.', 'The server must have a certificate from clients to allow connection.']\\n\\nTrino's client certificate support is the middle type. It asks for a certificate\\nbut allows connection if another authentication method passes.\", \"Certificate authentication configuration\": \"Enable certificate authentication by setting the {doc}`Certificate\\nauthentication type <authentication-types>` in {ref}`etc/config.properties\\n<config-properties>`:\\n\\n```\\nhttp-server.authentication.type=CERTIFICATE\\n```\\n\\nYou can specify certificate authentication along with another authentication\\nmethod, such as `PASSWORD`. In this case, authentication is performed in the\\norder of entries, and the first successful authentication results in access.\\nFor example, the following setting shows the use of two authentication types:\\n\\n```\\nhttp-server.authentication.type=CERTIFICATE,PASSWORD\\n```\\n\\nThe following configuration properties are also available:\\n\\n:::{list-table} Configuration properties\\n:widths: 50 50\\n:header-rows: 1\\n\\n[['Property name', 'Description'], ['`http-server.authentication.certificate.user-mapping.pattern`', 'A regular expression pattern to [map all user\\\\nnames](/security/user-mapping) for this authentication type to the format\\\\nexpected by Trino.'], ['`http-server.authentication.certificate.user-mapping.file`', 'The path to a JSON file that contains a set of [user mapping\\\\nrules](/security/user-mapping) for this authentication type.\\\\n:::']]\", \"Use certificate authentication with clients\": \"When using the Trino {doc}`CLI </client/cli>`, specify the\\n`--keystore-path` and `--keystore-password` options as described\\nin {ref}`cli-certificate-auth`.\\n\\nWhen using the Trino {doc}`JDBC driver </client/jdbc>` to connect to a\\ncluster with certificate authentication enabled, use the `SSLKeyStoreType` and\\n`SSLKeyStorePassword` {ref}`parameters <jdbc-parameter-reference>` to specify\\nthe path to the client's certificate and its password, if any.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 2]\"}, {\"title\": \"File-based access control\", \"description\": null, \"content\": {\"System-level access control files\": {\"Configuration\": \"To use the access control plugin, add an `etc/access-control.properties` file\\ncontaining two required properties: `access-control.name`, which must be set\\nto `file`, and `security.config-file`, which must be set to the location\\nof the config file. The configuration file location can either point to the local\\ndisc or to a http endpoint. For example, if a config file named `rules.json` resides\\nin `etc`, add an `etc/access-control.properties` with the following\\ncontents:\\n\\n```\\naccess-control.name=file\\nsecurity.config-file=etc/rules.json\\n```\\n\\nIf the config should be loaded via the http endpoint `http://trino-test/config` and\\nis wrapped into a JSON object and available via the `data` key `etc/access-control.properties`\\nshould look like this:\\n\\n```\\naccess-control.name=file\\nsecurity.config-file=http://trino-test/config\\nsecurity.json-pointer=/data\\n```\\n\\nThe config file is specified in JSON format. It contains rules that define which\\nusers have access to which resources. The rules are read from top to bottom and\\nthe first matching rule is applied. If no rule matches, access is denied. A JSON\\npointer (RFC 6901) can be specified using the `security.json-pointer` property\\nto specify a nested object inside the JSON content containing the rules. Per default,\\nthe file is assumed to contain a single object defining the rules rendering\\nthe specification of `security.json-pointer` unnecessary in that case.\", \"Refresh\": \"By default, when a change is made to the JSON rules file, Trino must be\\nrestarted to load the changes. There is an optional property to refresh the\\nproperties without requiring a Trino restart. The refresh period is specified in\\nthe `etc/access-control.properties`:\\n\\n```\\nsecurity.refresh-period=1s\\n```\", \"Catalog, schema, and table access\": {\"Visibility\": \"For a catalog, schema, or table to be visible in a `SHOW` command, the user\\nmust have at least one permission on the item or any nested item. The nested\\nitems do not need to already exist as any potential permission makes the item\\nvisible. Specifically:\\n\\n['`catalog`: Visible if user is the owner of any nested schema, has\\\\npermissions on any nested table or function, or has permissions to\\\\nset session properties in the catalog.', '`schema`: Visible if the user is the owner of the schema, or has permissions\\\\non any nested table or function.', '`table`: Visible if the user has any permissions on the table.']\", \"Catalog rules\": \"Each catalog rule is composed of the following fields:\\n\\n['`user` (optional): regex to match against username. Defaults to `.*`.', '`role` (optional): regex to match against role names. Defaults to `.*`.', '`group` (optional): regex to match against group names. Defaults to `.*`.', '`catalog` (optional): regex to match against catalog name. Defaults to\\\\n`.*`.', '`allow` (required): string indicating whether a user has access to the\\\\ncatalog. This value can be `all`, `read-only` or `none`, and defaults to\\\\n`none`. Setting this value to `read-only` has the same behavior as the\\\\n`read-only` system access control plugin.']\\n\\nIn order for a rule to apply the username must match the regular expression\\nspecified in `user` attribute.\\n\\nFor role names, a rule can be applied if at least one of the currently enabled\\nroles matches the `role` regular expression.\\n\\nFor group names, a rule can be applied if at least one group name of this user\\nmatches the `group` regular expression.\\n\\nThe `all` value for `allow` means these rules do not restrict access in any\\nway, but the schema and table rules can restrict access.\\n\\n:::{note}\\nBy default, all users have access to the `system` catalog. You can\\noverride this behavior by adding a rule.\\n\\nBoolean `true` and `false` are also supported as legacy values for\\n`allow`, to support backwards compatibility. `true` maps to `all`,\\nand `false` maps to `none`.\\n:::\\n\\nFor example, if you want to allow only the role `admin` to access the\\n`mysql` and the `system` catalog, allow users from the `finance` and\\n`human_resources` groups access to `postgres` catalog, allow all users to\\naccess the `hive` catalog, and deny all other access, you can use the\\nfollowing rules:\\n\\n```\\n{\\n \\\"catalogs\\\": [\\n {\\n \\\"role\\\": \\\"admin\\\",\\n \\\"catalog\\\": \\\"(mysql|system)\\\",\\n \\\"allow\\\": \\\"all\\\"\\n },\\n {\\n \\\"group\\\": \\\"finance|human_resources\\\",\\n \\\"catalog\\\": \\\"postgres\\\",\\n \\\"allow\\\": true\\n },\\n {\\n \\\"catalog\\\": \\\"hive\\\",\\n \\\"allow\\\": \\\"all\\\"\\n },\\n {\\n \\\"user\\\": \\\"alice\\\",\\n \\\"catalog\\\": \\\"postgresql\\\",\\n \\\"allow\\\": \\\"read-only\\\"\\n },\\n {\\n \\\"catalog\\\": \\\"system\\\",\\n \\\"allow\\\": \\\"none\\\"\\n }\\n ]\\n}\\n```\\n\\nFor group-based rules to match, users need to be assigned to groups by a\\n{doc}`/develop/group-provider`.\", \"Schema rules\": \"Each schema rule is composed of the following fields:\\n\\n['`user` (optional): regex to match against username. Defaults to `.*`.', '`role` (optional): regex to match against role names. Defaults to `.*`.', '`group` (optional): regex to match against group names. Defaults to `.*`.', '`catalog` (optional): regex to match against catalog name. Defaults to\\\\n`.*`.', '`schema` (optional): regex to match against schema name. Defaults to\\\\n`.*`.', '`owner` (required): boolean indicating whether the user is to be considered\\\\nan owner of the schema. Defaults to `false`.']\\n\\nFor example, to provide ownership of all schemas to role `admin`, treat all\\nusers as owners of the `default.default` schema and prevent user `guest`\\nfrom ownership of any schema, you can use the following rules:\\n\\n```\\n{\\n \\\"schemas\\\": [\\n {\\n \\\"role\\\": \\\"admin\\\",\\n \\\"schema\\\": \\\".*\\\",\\n \\\"owner\\\": true\\n },\\n {\\n \\\"user\\\": \\\"guest\\\",\\n \\\"owner\\\": false\\n },\\n {\\n \\\"catalog\\\": \\\"default\\\",\\n \\\"schema\\\": \\\"default\\\",\\n \\\"owner\\\": true\\n }\\n ]\\n}\\n```\", \"Table rules\": \"Each table rule is composed of the following fields:\\n\\n['`user` (optional): regex to match against username. Defaults to `.*`.', '`role` (optional): regex to match against role names. Defaults to `.*`.', '`group` (optional): regex to match against group names. Defaults to `.*`.', '`catalog` (optional): regex to match against catalog name. Defaults to\\\\n`.*`.', '`schema` (optional): regex to match against schema name. Defaults to `.*`.', '`table` (optional): regex to match against table names. Defaults to `.*`.', '`privileges` (required): zero or more of `SELECT`, `INSERT`,\\\\n`DELETE`, `UPDATE`, `OWNERSHIP`, `GRANT_SELECT`', '`columns` (optional): list of column constraints.', '`filter` (optional): boolean filter expression for the table.', '`filter_environment` (optional): environment use during filter evaluation.']\", \"Column constraint\": \"These constraints can be used to restrict access to column data.\\n\\n['`name`: name of the column.', '`allow` (optional): if false, column can not be accessed.', '`mask` (optional): mask expression applied to column.', '`mask_environment` (optional): environment use during mask evaluation.']\", \"Filter and mask environment\": [\"`user` (optional): username for checking permission of subqueries in mask.\"], \"Function rules\": \"These rules control the ability of a user to create, drop, and execute functions.\\n\\nWhen these rules are present, the authorization is based on the first matching\\nrule, processed from top to bottom. If no rules match, the authorization is\\ndenied. If function rules are not present, only functions in`system.builtin` can\\nbe executed.\\n\\n:::{note}\\nUsers always have access to functions in the `system.builtin` schema, and\\nyou cannot override this behavior by adding a rule.\\n:::\\n\\nEach function rule is composed of the following fields:\\n\\n['`user` (optional): regular expression to match against username.\\\\nDefaults to `.*`.', '`role` (optional): regular expression to match against role names.\\\\nDefaults to `.*`.', '`group` (optional): regular expression to match against group names.\\\\nDefaults to `.*`.', '`catalog` (optional): regular expression to match against catalog name.\\\\nDefaults to `.*`.', '`schema` (optional): regular expression to match against schema name.\\\\nDefaults to `.*`.', '`function` (optional): regular expression to match against function names.\\\\nDefaults to `.*`.', '`privileges` (required): zero or more of `EXECUTE`, `GRANT_EXECUTE`, `OWNERSHIP`.']\\n\\nCare should be taken when granting permission to the `system` schema of a\\ncatalog, as this is the schema Trino uses for table function such as `query`.\\nThese table functions can be used to access or modify the underlying data of\\nthe catalog.\\n\\nThe following example allows the `admin` user to execute `system.query` table function in\\nany catalog, and allows all users to create, drop, and execute functions (including\\n`SECURITY DEFINER` views) in the `hive.function` schema:\\n\\n```\\n{\\n \\\"functions\\\": [\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"schema\\\": \\\"system\\\",\\n \\\"function\\\": \\\"query\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\"\\n ]\\n },\\n {\\n \\\"catalog\\\": \\\"hive\\\",\\n \\\"schema\\\": \\\"function\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\", \\\"GRANT_EXECUTE\\\", \\\"OWNERSHIP\\\"\\n ]\\n }\\n ]\\n}\\n```\\n\\n(system-file-procedure-rules)=\", \"Procedure rules\": \"These rules control the ability of a user to execute procedures using the\\n[CALL](/sql/call) statement.\\n\\nProcedures are used for administrative operations on a specific catalog, such as\\nregistering external tables or flushing the connector's cache. Available\\nprocedures are detailed in the connector documentation pages.\\n\\nWhen procedure rules are present, the authorization is based on the first\\nmatching rule, processed from top to bottom. If no rules match, the\\nauthorization is denied. If procedure rules are not present, only procedures in\\n`system.builtin` can be executed.\\n\\nEach procedure rule is composed of the following fields:\\n\\n['`user` (optional): regular expression to match against username.\\\\nDefaults to `.*`.', '`role` (optional): regular expression to match against role names.\\\\nDefaults to `.*`.', '`group` (optional): regular expression to match against group names.\\\\nDefaults to `.*`.', '`catalog` (optional): regular expression to match against catalog name.\\\\nDefaults to `.*`.', '`schema` (optional): regular expression to match against schema name.\\\\nDefaults to `.*`.', '`procedure` (optional): regular expression to match against procedure names.\\\\nDefaults to `.*`.', '`privileges` (required): zero or more of `EXECUTE`, `GRANT_EXECUTE`.']\\n\\nThe following example allows the `admin` user to execute and grant execution\\nrights to call `register_table` and `unregister_table` in the `system` schema of\\na catalog called `delta`, that uses the [Delta Lake\\nconnector](/connector/delta-lake). It allows all users to execute the\\n`delta.sytem.vacuum` procedure.\\n\\n```\\n{\\n \\\"procedures\\\": [\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"catalog\\\": \\\"delta\\\",\\n \\\"schema\\\": \\\"system\\\",\\n \\\"procedure\\\": \\\"register_table|unregister_table\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\",\\n \\\"GRANT_EXECUTE\\\"\\n ]\\n },\\n {\\n \\\"catalog\\\": \\\"delta\\\",\\n \\\"schema\\\": \\\"system\\\",\\n \\\"procedure\\\": \\\"vacuum\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\"\\n ]\\n }\\n ]\\n}\\n```\\n\\n(system-file-table-procedure-rules)=\", \"Table procedure rules\": \"Table procedures are executed using the\\n[ALTER TABLE ... EXECUTE](alter-table-execute) syntax.\\n\\nFile-based access control does not support privileges for table procedures and\\ntherefore all are effectively allowed.\\n\\n(verify-rules)=\", \"Verify configuration\": \"To verify the system-access control file is configured properly, set the\\nrules to completely block access to all users of the system:\\n\\n```\\n{\\n \\\"catalogs\\\": [\\n {\\n \\\"catalog\\\": \\\"system\\\",\\n \\\"allow\\\": \\\"none\\\"\\n }\\n ]\\n}\\n```\\n\\nRestart your cluster to activate the rules for your cluster. With the\\nTrino {doc}`CLI </client/cli>` run a query to test authorization:\\n\\n```\\ntrino> SELECT * FROM system.runtime.nodes;\\nQuery 20200824_183358_00000_c62aw failed: Access Denied: Cannot access catalog system\\n```\\n\\nRemove these rules and restart the Trino cluster.\\n\\n(system-file-auth-session-property)=\"}, \"Session property rules\": \"These rules control the ability of a user to set system and catalog session\\nproperties. The user is granted or denied access, based on the first matching\\nrule, read from top to bottom. If no rules are specified, all users are allowed\\nset any session property. If no rule matches, setting the session property is\\ndenied. System session property rules are composed of the following fields:\\n\\n['`user` (optional): regex to match against username. Defaults to `.*`.', '`role` (optional): regex to match against role names. Defaults to `.*`.', '`group` (optional): regex to match against group names. Defaults to `.*`.', '`property` (optional): regex to match against the property name. Defaults to\\\\n`.*`.', '`allow` (required): boolean indicating if the setting the session\\\\nproperty should be allowed.']\\n\\nThe catalog session property rules have the additional field:\\n\\n['`catalog` (optional): regex to match against catalog name. Defaults to\\\\n`.*`.']\\n\\nThe example below defines the following table access policy:\\n\\n['Role `admin` can set all session property', 'User `banned_user` can not set any session properties', 'All users can set the `resource_overcommit` system session property, and the\\\\n`bucket_execution_enabled` session property in the `hive` catalog.']\\n\\n```\\n:language: json\\n```\\n\\n(query-rules)=\", \"Query rules\": \"These rules control the ability of a user to execute, view, or kill a query. The\\nuser is granted or denied access, based on the first matching rule read from top\\nto bottom. If no rules are specified, all users are allowed to execute queries,\\nand to view or kill queries owned by any user. If no rule matches, query\\nmanagement is denied. Each rule is composed of the following fields:\\n\\n['`user` (optional): regex to match against username. Defaults to `.*`.', '`role` (optional): regex to match against role names. Defaults to `.*`.', '`group` (optional): regex to match against group names. Defaults to `.*`.', '`queryOwner` (optional): regex to match against the query owner name.\\\\nDefaults to `.*`.', '`allow` (required): set of query permissions granted to user. Values:\\\\n`execute`, `view`, `kill`']\\n\\n:::{note}\\nUsers always have permission to view or kill their own queries.\\n\\nA rule that includes `queryOwner` may not include the `execute` access mode.\\nQueries are only owned by a user once their execution has begun.\\n:::\\n\\nFor example, if you want to allow the role `admin` full query access, allow\\nthe user `alice` to execute and kill queries, allow members of the group\\n`contractors` to view queries owned by users `alice` or `dave`, allow any\\nuser to execute queries, and deny all other access, you can use the following\\nrules:\\n\\n```\\n:language: json\\n```\\n\\n(system-file-auth-impersonation-rules)=\", \"Impersonation rules\": \"These rules control the ability of a user to impersonate another user. In\\nsome environments it is desirable for an administrator (or managed system) to\\nrun queries on behalf of other users. In these cases, the administrator\\nauthenticates using their credentials, and then submits a query as a different\\nuser. When the user context is changed, Trino verifies that the administrator\\nis authorized to run queries as the target user.\\n\\nWhen these rules are present, the authorization is based on the first matching\\nrule, processed from top to bottom. If no rules match, the authorization is\\ndenied. If impersonation rules are not present but the legacy principal rules\\nare specified, it is assumed impersonation access control is being handled by\\nthe principal rules, so impersonation is allowed. If neither impersonation nor\\nprincipal rules are defined, impersonation is not allowed.\\n\\nEach impersonation rule is composed of the following fields:\\n\\n['`original_user` (optional): regex to match against the user requesting the\\\\nimpersonation. Defaults to `.*`.', '`original_role` (optional): regex to match against role names of the\\\\nrequesting impersonation. Defaults to `.*`.', '`new_user` (required): regex to match against the user to impersonate. Can\\\\ncontain references to subsequences captured during the match against\\\\n*original_user*, and each reference is replaced by the result of evaluating\\\\nthe corresponding group respectively.', '`allow` (optional): boolean indicating if the authentication should be\\\\nallowed. Defaults to `true`.']\\n\\nThe impersonation rules are a bit different from the other rules: The attribute\\n`new_user` is required to not accidentally prevent more access than intended.\\nDoing so it was possible to make the attribute `allow` optional.\\n\\nThe following example allows the `admin` role, to impersonate any user, except\\nfor `bob`. It also allows any user to impersonate the `test` user. It also\\nallows a user in the form `team_backend` to impersonate the\\n`team_backend_sandbox` user, but not arbitrary users:\\n\\n```\\n:language: json\\n```\\n\\n(system-file-auth-principal-rules)=\", \"Principal rules\": \":::{warning}\\nPrincipal rules are deprecated. Instead, use {doc}`/security/user-mapping`\\nwhich specifies how a complex authentication username is mapped to a simple\\nusername for Trino, and impersonation rules defined above.\\n:::\\n\\nThese rules serve to enforce a specific matching between a principal and a\\nspecified username. The principal is granted authorization as a user, based\\non the first matching rule read from top to bottom. If no rules are specified,\\nno checks are performed. If no rule matches, user authorization is denied.\\nEach rule is composed of the following fields:\\n\\n['`principal` (required): regex to match and group against principal.', '`user` (optional): regex to match against username. If matched, it\\\\ngrants or denies the authorization based on the value of `allow`.', '`principal_to_user` (optional): replacement string to substitute against\\\\nprincipal. If the result of the substitution is same as the username, it\\\\ngrants or denies the authorization based on the value of `allow`.', '`allow` (required): boolean indicating whether a principal can be authorized\\\\nas a user.']\\n\\n:::{note}\\nYou would at least specify one criterion in a principal rule. If you specify\\nboth criteria in a principal rule, it returns the desired conclusion when\\neither of criteria is satisfied.\\n:::\\n\\nThe following implements an exact matching of the full principal name for LDAP\\nand Kerberos authentication:\\n\\n```\\n{\\n \\\"principals\\\": [\\n {\\n \\\"principal\\\": \\\"(.*)\\\",\\n \\\"principal_to_user\\\": \\\"$1\\\",\\n \\\"allow\\\": true\\n },\\n {\\n \\\"principal\\\": \\\"([^/]+)(/.*)?@.*\\\",\\n \\\"principal_to_user\\\": \\\"$1\\\",\\n \\\"allow\\\": true\\n }\\n ]\\n}\\n```\\n\\nIf you want to allow users to use the exact same name as their Kerberos\\nprincipal name, and allow `alice` and `bob` to use a group principal named\\nas `group@example.net`, you can use the following rules.\\n\\n```\\n{\\n \\\"principals\\\": [\\n {\\n \\\"principal\\\": \\\"([^/]+)/?.*@example.net\\\",\\n \\\"principal_to_user\\\": \\\"$1\\\",\\n \\\"allow\\\": true\\n },\\n {\\n \\\"principal\\\": \\\"group@example.net\\\",\\n \\\"user\\\": \\\"alice|bob\\\",\\n \\\"allow\\\": true\\n }\\n ]\\n}\\n```\\n\\n(system-file-auth-system-information)=\", \"System information rules\": \"These rules specify which users can access the system information management\\ninterface. System information access includes the following aspects:\\n\\n['Read access to sensitive information from REST endpoints, such as `/v1/node`\\\\nand `/v1/thread`.', 'Read access with the {doc}`system information functions </functions/system>`.', 'Read access with the {doc}`/connector/system`.', 'Write access to trigger {doc}`/admin/graceful-shutdown`.']\\n\\nThe following REST endpoints are always public and not affected by these rules:\\n\\n['`GET /v1/info`', '`GET /v1/info/state`', '`GET /v1/status`']\\n\\nThe user is granted or denied access based on the first matching\\nrule read from top to bottom. If no rules are specified, all access to system\\ninformation is denied. If no rule matches, system access is denied. Each rule is\\ncomposed of the following fields:\\n\\n['`role` (optional): regex to match against role. If matched, it\\\\ngrants or denies the authorization based on the value of `allow`.', '`user` (optional): regex to match against username. If matched, it\\\\ngrants or denies the authorization based on the value of `allow`.', '`allow` (required): set of access permissions granted to user. Values:\\\\n`read`, `write`']\\n\\nThe following configuration provides and example:\\n\\n```\\n:language: json\\n```\\n\\n['All users with the `admin` role have read and write access to system\\\\ninformation. This includes the ability to trigger\\\\n{doc}`/admin/graceful-shutdown`.', 'The user `alice` can read system information.', 'All other users and roles are denied access to system information.']\\n\\nA fixed user can be set for management interfaces using the `management.user`\\nconfiguration property. When this is configured, system information rules must\\nstill be set to authorize this user to read or write to management information.\\nThe fixed management user only applies to HTTP by default. To enable the fixed\\nuser over HTTPS, set the `management.user.https-enabled` configuration\\nproperty.\\n\\n(system-file-auth-authorization)=\", \"Authorization rules\": \"These rules control the ability of how owner of schema, table or view can\\nbe altered. These rules are applicable to commands like:\\n\\n```\\nALTER SCHEMA name SET AUTHORIZATION ( user | USER user | ROLE role )\\nALTER TABLE name SET AUTHORIZATION ( user | USER user | ROLE role )\\nALTER VIEW name SET AUTHORIZATION ( user | USER user | ROLE role )\\n```\\n\\nWhen these rules are present, the authorization is based on the first matching\\nrule, processed from top to bottom. If no rules match, the authorization is\\ndenied.\\n\\nNotice that in order to execute `ALTER` command on schema, table or view user requires `OWNERSHIP`\\nprivilege.\\n\\nEach authorization rule is composed of the following fields:\\n\\n['`original_user` (optional): regex to match against the user requesting the\\\\nauthorization. Defaults to `.*`.', '`original_group` (optional): regex to match against group names of the\\\\nrequesting authorization. Defaults to `.*`.', '`original_role` (optional): regex to match against role names of the\\\\nrequesting authorization. Defaults to `.*`.', '`new_user` (optional): regex to match against the new owner user of the schema, table or view.\\\\nBy default it does not match.', '`new_role` (optional): regex to match against the new owner role of the schema, table or view.\\\\nBy default it does not match.', '`allow` (optional): boolean indicating if the authentication should be\\\\nallowed. Defaults to `true`.']\\n\\nNotice that `new_user` and `new_role` are optional, however it is required to provide at least one of them.\\n\\nThe following example allows the `admin` role, to change owner of any schema, table or view\\nto any user, except to\\\\`\\\\`bob\\\\`\\\\`.\\n\\n```\\n:language: json\\n```\\n\\n(catalog-file-based-access-control)=\"}, \"Catalog-level access control files\": {\"Configure a catalog rules file\": {\"Schema rules\": \"These rules govern who is considered an owner of a schema.\\n\\n['`user` (optional): regex to match against username.', '`group` (optional): regex to match against every user group the user belongs\\\\nto.', '`schema` (optional): regex to match against schema name.', '`owner` (required): boolean indicating ownership.']\", \"Table rules\": {\"Column constraints\": \"These constraints can be used to restrict access to column data.\\n\\n['`name`: name of the column.', '`allow` (optional): if false, column can not be accessed.', '`mask` (optional): mask expression applied to column.', '`mask_environment` (optional): environment use during mask evaluation.']\", \"Filter environment and mask environment\": \"These rules apply to `filter_environment` and `mask_environment`.\\n\\n['`user` (optional): username for checking permission of subqueries in a mask.']\\n\\n:::{note}\\n`mask` can contain conditional expressions such as `IF` or `CASE`, which achieves conditional masking.\\n:::\"}, \"Function rules\": \"These rules control the ability of a user to create, drop, and execute functions.\\n\\nWhen these rules are present, the authorization is based on the first matching\\nrule, processed from top to bottom. If no rules match, the authorization is\\ndenied. If function rules are not present, access is not allowed.\\n\\n['`user` (optional): regular expression to match against username.\\\\nDefaults to `.*`.', '`group` (optional): regular expression to match against group names.\\\\nDefaults to `.*`.', '`schema` (optional): regular expression to match against schema name.\\\\nDefaults to `.*`.', '`function` (optional): regular expression to match against function names.\\\\nDefaults to `.*`.', '`privileges` (required): zero or more of `EXECUTE`, `GRANT_EXECUTE`, `OWNERSHIP`.']\\n\\nCare should be taken when granting permission to the `system` schema of a\\ncatalog, as this is the schema Trino uses for table function such as `query`.\\nThese table functions can be used to access or modify the underlying data of\\nthe catalog.\\n\\nThe following example allows the `admin` user to execute `system.query` table function from\\nany catalog, and all users to create, drop, and execute functions (including from views)\\nin the `function` schema of this catalog:\\n\\n```\\n{\\n \\\"functions\\\": [\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"schema\\\": \\\"system\\\",\\n \\\"function\\\": \\\"query\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\"\\n ]\\n },\\n {\\n \\\"schema\\\": \\\"function\\\",\\n \\\"privileges\\\": [\\n \\\"EXECUTE\\\", \\\"GRANT_EXECUTE\\\", \\\"OWNERSHIP\\\"\\n ]\\n }\\n ]\\n}\\n```\", \"Session property rules\": \"These rules govern who may set session properties.\\n\\n['`user` (optional): regex to match against username.', '`group` (optional): regex to match against every user group the user belongs\\\\nto.', '`property` (optional): regex to match against session property name.', '`allow` (required): boolean indicating whether this session property may be\\\\nset.']\"}, \"Example\": \"```\\n{\\n \\\"schemas\\\": [\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"schema\\\": \\\".*\\\",\\n \\\"owner\\\": true\\n },\\n {\\n \\\"group\\\": \\\"finance|human_resources\\\",\\n \\\"schema\\\": \\\"employees\\\",\\n \\\"owner\\\": true\\n },\\n {\\n \\\"user\\\": \\\"guest\\\",\\n \\\"owner\\\": false\\n },\\n {\\n \\\"schema\\\": \\\"default\\\",\\n \\\"owner\\\": true\\n }\\n ],\\n \\\"tables\\\": [\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"privileges\\\": [\\\"SELECT\\\", \\\"INSERT\\\", \\\"DELETE\\\", \\\"UPDATE\\\", \\\"OWNERSHIP\\\"]\\n },\\n {\\n \\\"user\\\": \\\"banned_user\\\",\\n \\\"privileges\\\": []\\n },\\n {\\n \\\"schema\\\": \\\"hr\\\",\\n \\\"table\\\": \\\"employee\\\",\\n \\\"privileges\\\": [\\\"SELECT\\\"],\\n \\\"filter\\\": \\\"user = current_user\\\"\\n },\\n {\\n \\\"schema\\\": \\\"default\\\",\\n \\\"table\\\": \\\".*\\\",\\n \\\"privileges\\\": [\\\"SELECT\\\"],\\n \\\"columns\\\" : [\\n {\\n \\\"name\\\": \\\"address\\\",\\n \\\"allow\\\": false\\n },\\n {\\n \\\"name\\\": \\\"ssn\\\",\\n \\\"mask\\\": \\\"'XXX-XX-' + substring(credit_card, -4)\\\",\\n \\\"mask_environment\\\": {\\n \\\"user\\\": \\\"admin\\\"\\n }\\n }\\n ]\\n }\\n ],\\n \\\"session_properties\\\": [\\n {\\n \\\"property\\\": \\\"force_local_scheduling\\\",\\n \\\"allow\\\": true\\n },\\n {\\n \\\"user\\\": \\\"admin\\\",\\n \\\"property\\\": \\\"max_split_size\\\",\\n \\\"allow\\\": true\\n }\\n ]\\n}\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 3]\"}, {\"title\": \"File group provider\", \"description\": null, \"content\": {\"Group file configuration\": \"Enable group file by creating an `etc/group-provider.properties`\\nfile on the coordinator:\\n\\n```\\ngroup-provider.name=file\\nfile.group-file=/path/to/group.txt\\n```\\n\\nThe following configuration properties are available:\\n\\n| Property | Description |\\n| --------------------- | ----------------------------------------------------- |\\n| `file.group-file` | Path of the group file. |\\n| `file.refresh-period` | How often to reload the group file. Defaults to `5s`. |\", \"Group files\": {\"File format\": \"The group file contains a list of groups and members, one per line,\\nseparated by a colon. Users are separated by a comma.\\n\\n```\\ngroup_name:user_1,user_2,user_3\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 4]\"}, {\"title\": \"JKS files\", \"description\": null, \"content\": {\"Inspect and validate keystore\": \"Inspect the keystore file to make sure it contains the correct information for\\nyour Trino server. Use the `keytool` command, which is installed as part of\\nyour Java installation, to retrieve information from your keystore file:\\n\\n```\\nkeytool -list -v -keystore yourKeystore.jks\\n```\\n\\nKeystores always require a password. If not provided on the `keytool` command\\nline, `keytool` prompts for the password.\\n\\nIndependent of the keystore's password, it is possible that an individual key\\nhas its own password. It is easiest to make sure these passwords are the same.\\nIf the JKS key inside the keystore has a different password, you are prompted\\ntwice.\\n\\nIn the output of the `keytool -list` command, look for:\\n\\n['The keystore may contain either a private key (`Entry type:\\\\nPrivateKeyEntry`) or certificate (`Entry type: trustedCertEntry`) or both.', 'Modern browsers now enforce 398 days as the maximum validity period for a\\\\ncertificate. Look for the `Valid from ... until` entry, and make sure the\\\\ntime span does not exceed 398 days.', 'Modern browsers and clients require the **SubjectAlternativeName** (SAN)\\\\nfield. Make sure this shows the DNS name of your server, such as\\\\n`DNS:cluster.example.com`. Certificates without SANs are not\\\\nsupported.', 'Example:']\\n\\n```\\nSubjectAlternativeName [\\n DNSName: cluster.example.com\\n]\\n```\\n\\nIf your keystore shows valid information for your cluster, proceed to configure\\nthe Trino server, as described in {ref}`cert-placement` and\\n{ref}`configure-https`.\\n\\nThe rest of this page describes additional steps that may apply in certain\\ncircumstances.\\n\\n(import-to-keystore)=\", \"Extra: add PEM to keystore\": \"Your site may have standardized on using JKS semantics for all servers. If a\\nvendor sends you a PEM-encoded certificate file for your Trino server, you can\\nimport it into a keystore with a command like the following. Consult `keytool`\\nreferences for different options.\\n\\n```\\nkeytool -trustcacerts -import -alias cluster -file localhost.pem -keystore localkeys.jks\\n```\\n\\nIf the specified keystore file exists, `keytool` prompts for its password. If\\nyou are creating a new keystore, `keytool` prompts for a new password, then\\nprompts you to confirm the same password. `keytool` shows you the\\ncontents of the key being added, similar to the `keytool -list` format, then\\nprompts:\\n\\n```\\nTrust this certificate? [no]:\\n```\\n\\nType `yes` to add the PEM certificate to the keystore.\\n\\nThe `alias` name is an arbitrary string used as a handle for the certificate\\nyou are adding. A keystore can contain multiple keys and certs, so `keytool`\\nuses the alias to address individual entries.\\n\\n(cli-java-truststore)=\", \"Extra: Java truststores\": \":::{note}\\nRemember that there may be no need to identify a local truststore when\\ndirectly using a signed PEM-encoded certificate, independent of a keystore.\\nPEM certs can contain the server's private key and the certificate chain all\\nthe way back to a recognized CA.\\n:::\\n\\nTruststore files contain a list of {ref}`Certificate Authorities <glossCA>`\\ntrusted by Java to validate the private keys of servers, plus a list of the\\ncertificates of trusted TLS servers. The standard Java-provided truststore file,\\n`cacerts`, is part of your Java installation in a standard location.\\n\\nKeystores normally rely on the default location of the system truststore, which\\ntherefore does not need to be configured.\\n\\nHowever, there are cases in which you need to use an alternate truststore. For\\nexample, if your site relies on the JKS system, your network managers may have\\nappended site-specific, local CAs to the standard list, to validate locally\\nsigned keys.\\n\\nIf your server must use a custom truststore, identify its location in the\\nserver's config properties file. For example:\\n\\n```\\nhttp-server.https.truststore.path=/mnt/shared/certs/localcacerts\\nhttp-server.https.truststore.key=<truststore-password>\\n```\\n\\nIf connecting clients such as browsers or the Trino CLI must be separately\\nconfigured, contact your site's network administrators for assistance.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 5]\"}, {\"title\": \"PEM files\", \"description\": null, \"content\": {\"Inspect PEM file\": \"The file name extensions shown on this page are examples only; there is no\\nextension naming standard.\\n\\nYou may receive a single file that includes a private key and its certificate,\\nor separate files. If you received separate files, concatenate them into one,\\ntypically in order from key to certificate. For example:\\n\\n```\\ncat clustercoord.key clustercoord.cert > clustercoord.pem\\n```\\n\\nNext, use the `cat` command to view this plain text file. For example:\\n\\n```\\ncat clustercoord.pem | less\\n```\\n\\nMake sure the PEM file shows at least one `KEY` and one `CERTIFICATE`\\nsection. A key section looks something like the following:\\n\\n```\\n-----BEGIN PRIVATE KEY-----\\nMIIEowIBAAKCAQEAwJL8CLeDFAHhZe3QOOF1vWt4Vuk9vyO38Y1y9SgBfB02b2jW\\n....\\n-----END PRIVATE KEY-----\\n```\\n\\nIf your key section reports `BEGIN ENCRYPTED PRIVATE KEY` instead, this means\\nthe key is encrypted and you must use the password to open or inspect the key.\\nYou may have specified the password when requesting the key, or the password\\ncould be assigned by your site's network managers. Note that password protected\\nPEM files are not supported by Trino.\\n\\nIf your key section reports `BEGIN EC PRIVATE KEY` or `BEGIN DSA PRIVATE\\nKEY`, this designates a key using Elliptical Curve or DSA alternatives to RSA.\\n\\nThe certificate section looks like the following example:\\n\\n```\\n-----BEGIN CERTIFICATE-----\\nMIIDujCCAqICAQEwDQYJKoZIhvcNAQEFBQAwgaIxCzAJBgNVBAYTAlVTMRYwFAYD\\n....\\n-----END CERTIFICATE-----\\n-----BEGIN CERTIFICATE-----\\nMIIDwjCCAqoCCQCxyqwZ9GK50jANBgkqhkiG9w0BAQsFADCBojELMAkGA1UEBhMC\\n....\\n-----END CERTIFICATE-----\\n```\\n\\nThe file can show a single certificate section, or more than one to express a\\nchain of authorities, each certifying the previous.\\n\\n(validate-pems)=\", \"Validate PEM key section\": \"This page presumes your system provides the `openssl` command from OpenSSL 1.1\\nor later.\\n\\nTest an RSA private key's validity with the following command:\\n\\n```\\nopenssl rsa -in clustercoord.pem -check -noout\\n```\\n\\nLook for the following confirmation message:\\n\\n```\\nRSA key ok\\n```\\n\\n:::{note}\\nConsult `openssl` references for the appropriate versions of the\\nverification commands for EC or DSA keys.\\n:::\", \"Validate PEM certificate section\": \"Analyze the certificate section of your PEM file with the following `openssl`\\ncommand:\\n\\n```\\nopenssl x509 -in clustercoord.pem -text -noout\\n```\\n\\nIf your certificate was generated with a password, `openssl` prompts for it.\\nNote that password protected PEM files are not supported by Trino.\\n\\nIn the output of the `openssl` command, look for the following\\ncharacteristics:\\n\\n['Modern browsers now enforce 398 days as the maximum validity period for a\\\\ncertificate. Look for `Not Before` and `Not After` dates in the\\\\n`Validity` section of the output, and make sure the time span does not\\\\nexceed 398 days.', 'Modern browsers and clients require the **Subject Alternative Name** (SAN)\\\\nfield. Make sure this shows the DNS name of your server, such as\\\\n`DNS:clustercoord.example.com`. Certificates without SANs are not\\\\nsupported.']\\n\\nIf your PEM file shows valid information for your cluster, proceed to configure\\nthe server, as described in {ref}`cert-placement` and {ref}`configure-https`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 6]\"}, {\"title\": \"Secure internal communication\", \"description\": null, \"content\": {\"Configure shared secret\": {\"Verify configuration\": \"To verify shared secret configuration:\\n\\n['Start your Trino cluster with two or more nodes configured with a shared\\\\nsecret.', 'Connect to the {doc}`Web UI </admin/web-interface>`.', 'Confirm the number of `ACTIVE WORKERS` equals the number of nodes\\\\nconfigured with your shared secret.', 'Change the value of the shared secret on one worker, and restart the worker.', 'Log in to the Web UI and confirm the number of `ACTIVE WORKERS` is one\\\\nless. The worker with the invalid secret is not authenticated, and therefore\\\\nnot registered with the coordinator.', 'Stop your Trino cluster, revert the value change on the worker, and restart\\\\nyour cluster.', 'Confirm the number of `ACTIVE WORKERS` equals the number of nodes\\\\nconfigured with your shared secret.']\\n\\n(internal-tls)=\"}, \"Configure internal TLS\": {\"Performance with SSL/TLS enabled\": \"Enabling encryption impacts performance. The performance degradation can vary\\nbased on the environment, queries, and concurrency.\\n\\nFor queries that do not require transferring too much data between the Trino\\nnodes e.g. `SELECT count(*) FROM table`, the performance impact is negligible.\\n\\nHowever, for CPU intensive queries which require a considerable amount of data\\nto be transferred between the nodes (for example, distributed joins, aggregations and\\nwindow functions, which require repartitioning), the performance impact can be\\nconsiderable. The slowdown may vary from 10% to even 100%+, depending on the network\\ntraffic and the CPU utilization.\\n\\n:::{note}\\nBy default, internal communication with SSL/TLS enabled uses HTTP/2 for\\nincreased scalability. You can turn off this feature with\\n`internal-communication.http2.enabled=false`.\\n:::\\n\\n(internal-performance)=\", \"Advanced performance tuning\": \"In some cases, changing the source of random numbers improves performance\\nsignificantly.\\n\\nBy default, TLS encryption uses the `/dev/urandom` system device as a source of entropy.\\nThis device has limited throughput, so on environments with high network bandwidth\\n(e.g. InfiniBand), it may become a bottleneck. In such situations, it is recommended to try\\nto switch the random number generator algorithm to `SHA1PRNG`, by setting it via\\n`http-server.https.secure-random-algorithm` property in `config.properties` on the coordinator\\nand all the workers:\\n\\n```\\nhttp-server.https.secure-random-algorithm=SHA1PRNG\\n```\\n\\nBe aware that this algorithm takes the initial seed from\\nthe blocking `/dev/random` device. For environments that do not have enough entropy to seed\\nthe `SHAPRNG` algorithm, the source can be changed to `/dev/urandom`\\nby adding the `java.security.egd` property to `jvm.config`:\\n\\n```\\n-Djava.security.egd=file:/dev/urandom\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 7]\"}, {\"title\": \"JWT authentication\", \"description\": null, \"content\": {\"Using JWT authentication\": \"Trino supports Base64 encoded JWTs, but not encrypted JWTs.\\n\\nThere are two ways to get the encryption key necessary to validate the JWT\\nsignature:\\n\\n['Load the key from a JSON web key set (JWKS) endpoint service (the\\\\ntypical case)', 'Load the key from the local file system on the Trino coordinator']\\n\\nA JWKS endpoint is a read-only service that contains public key information in\\n[JWK](https://datatracker.ietf.org/doc/html/rfc7517) format. These public\\nkeys are the counterpart of the private keys that sign JSON web tokens.\", \"JWT authentication configuration\": \"Enable JWT authentication by setting the {doc}`JWT authentication type\\n<authentication-types>` in {ref}`etc/config.properties <config-properties>`, and\\nspecifying a URL or path to a key file:\\n\\n```\\nhttp-server.authentication.type=JWT\\nhttp-server.authentication.jwt.key-file=https://cluster.example.net/.well-known/jwks.json\\n```\\n\\nJWT authentication is typically used in addition to other authentication\\nmethods:\\n\\n```\\nhttp-server.authentication.type=PASSWORD,JWT\\nhttp-server.authentication.jwt.key-file=https://cluster.example.net/.well-known/jwks.json\\n```\\n\\nThe following configuration properties are available:\\n\\n:::{list-table} Configuration properties for JWT authentication\\n:widths: 50 50\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`http-server.authentication.jwt.key-file`', 'Required. Specifies either the URL to a JWKS service or the path to a PEM or\\\\nHMAC file, as described below this table.'], ['`http-server.authentication.jwt.required-issuer`', \\\"Specifies a string that must match the value of the JWT's issuer (`iss`)\\\\nfield in order to consider this JWT valid. The `iss` field in the JWT\\\\nidentifies the principal that issued the JWT.\\\"], ['`http-server.authentication.jwt.required-audience`', \\\"Specifies a string that must match the value of the JWT's Audience (`aud`)\\\\nfield in order to consider this JWT valid. The `aud` field in the JWT\\\\nidentifies the recipients that the JWT is intended for.\\\"], ['`http-server.authentication.jwt.principal-field`', 'String to identify the field in the JWT that identifies the subject of the\\\\nJWT. The default value is `sub`. This field is used to create the Trino\\\\nprincipal.'], ['`http-server.authentication.jwt.user-mapping.pattern`', 'A regular expression pattern to [map all user names](/security/user-mapping)\\\\nfor this authentication system to the format expected by the Trino server.'], ['`http-server.authentication.jwt.user-mapping.file`', 'The path to a JSON file that contains a set of [user mapping\\\\nrules](/security/user-mapping) for this authentication system.\\\\n:::']]\\n\\nUse the `http-server.authentication.jwt.key-file` property to specify\\neither:\\n\\n['The URL to a JWKS endpoint service, where the URL begins with `https://`.\\\\nThe JWKS service must be reachable from the coordinator. If the coordinator\\\\nis running in a secured or firewalled network, the administrator *may* have\\\\nto open access to the JWKS server host.', ':::{caution}\\\\nThe Trino server also accepts JWKS URLs that begin with `http://`, but\\\\nusing this protocol results in a severe security risk. Only use this\\\\nprotocol for short-term testing during development of your cluster.\\\\n:::', 'The path to a local file in {doc}`PEM </security/inspect-pem>` or [HMAC](https://wikipedia.org/wiki/HMAC) format that contains a single key.\\\\nIf the file path contains `${KID}`, then Trino interpolates the `kid`\\\\nfrom the JWT header into the file path before loading this key. This enables support\\\\nfor setups with multiple keys.']\", \"Using JWTs with clients\": \"When using the Trino {doc}`CLI </client/cli>`, specify a JWT as described\\nin {ref}`cli-jwt-auth`.\\n\\nWhen using the Trino JDBC driver, specify a JWT with the `accessToken`\\n{ref}`parameter <jdbc-parameter-reference>`.\", \"Resources\": \"The following resources may prove useful in your work with JWTs and JWKs.\\n\\n['[jwt.io](https://jwt.io) helps you decode and verify a JWT.', '[An article on using RS256](https://auth0.com/blog/navigating-rs256-and-jwks/)\\\\nto sign and verify your JWTs.', 'An [online JSON web key](https://mkjwk.org) generator.', 'A [command line JSON web key](https://connect2id.com/products/nimbus-jose-jwt/generator) generator.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 8]\"}, {\"title\": \"Kerberos authentication\", \"description\": null, \"content\": {\"Environment configuration\": {\"Kerberos services\": \"You will need a Kerberos {abbr}`KDC (Key Distribution Center)` running on a\\nnode that the Trino coordinator can reach over the network. The KDC is\\nresponsible for authenticating principals and issuing session keys that can be\\nused with Kerberos-enabled services. KDCs typically run on port 88, which is\\nthe IANA-assigned port for Kerberos.\\n\\n(server-kerberos-configuration)=\", \"MIT Kerberos configuration\": \"Kerberos needs to be configured on the Trino coordinator. At a minimum, there needs\\nto be a `kdc` entry in the `[realms]` section of the `/etc/krb5.conf`\\nfile. You may also want to include an `admin_server` entry and ensure that\\nthe Trino coordinator can reach the Kerberos admin server on port 749.\\n\\n```\\n[realms]\\n TRINO.EXAMPLE.COM = {\\n kdc = kdc.example.com\\n admin_server = kdc.example.com\\n }\\n\\n[domain_realm]\\n .trino.example.com = TRINO.EXAMPLE.COM\\n trino.example.com = TRINO.EXAMPLE.COM\\n```\\n\\nThe complete [documentation](http://web.mit.edu/kerberos/krb5-latest/doc/admin/conf_files/kdc_conf.html)\\nfor `krb5.conf` is hosted by the MIT Kerberos Project. If you are using a\\ndifferent implementation of the Kerberos protocol, you will need to adapt the\\nconfiguration to your environment.\\n\\n(server-kerberos-principals)=\", \"Kerberos principals and keytab files\": \"The Trino coordinator needs a Kerberos principal, as do users who are going to\\nconnect to the Trino coordinator. You need to create these users in Kerberos\\nusing [kadmin](http://web.mit.edu/kerberos/krb5-latest/doc/admin/admin_commands/kadmin_local.html).\\n\\nIn addition, the Trino coordinator needs a [keytab file](http://web.mit.edu/kerberos/krb5-devel/doc/basic/keytab_def.html). After you\\ncreate the principal, you can create the keytab file using {command}`kadmin`\\n\\n```\\nkadmin\\n> addprinc -randkey trino@EXAMPLE.COM\\n> addprinc -randkey trino/trino-coordinator.example.com@EXAMPLE.COM\\n> ktadd -k /etc/trino/trino.keytab trino@EXAMPLE.COM\\n> ktadd -k /etc/trino/trino.keytab trino/trino-coordinator.example.com@EXAMPLE.COM\\n```\\n\\n:::{note}\\nRunning {command}`ktadd` randomizes the principal's keys. If you have just\\ncreated the principal, this does not matter. If the principal already exists,\\nand if existing users or services rely on being able to authenticate using a\\npassword or a keytab, use the `-norandkey` option to {command}`ktadd`.\\n:::\", \"Configuration for TLS\": \"When using Kerberos authentication, access to the Trino coordinator must be\\nthrough {doc}`TLS and HTTPS </security/tls>`.\"}, \"System access control plugin\": \"A Trino coordinator with Kerberos enabled probably needs a\\n{doc}`/develop/system-access-control` plugin to achieve the desired level of\\nsecurity.\", \"Trino coordinator node configuration\": {\"config.properties\": \"Kerberos authentication is configured in the coordinator node's\\n{file}`config.properties` file. The entries that need to be added are listed\\nbelow.\\n\\n```\\nhttp-server.authentication.type=KERBEROS\\n\\nhttp-server.authentication.krb5.service-name=trino\\nhttp-server.authentication.krb5.principal-hostname=trino.example.com\\nhttp-server.authentication.krb5.keytab=/etc/trino/trino.keytab\\nhttp.authentication.krb5.config=/etc/krb5.conf\\n\\nhttp-server.https.enabled=true\\nhttp-server.https.port=7778\\n\\nhttp-server.https.keystore.path=/etc/trino/keystore.jks\\nhttp-server.https.keystore.key=keystore_password\\n\\nnode.internal-address-source=FQDN\\n```\\n\\n| Property | Description |\\n| ------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `http-server.authentication.type` | Authentication type for the Trino coordinator. Must be set to `KERBEROS`. |\\n| `http-server.authentication.krb5.service-name` | The Kerberos service name for the Trino coordinator. Must match the Kerberos principal. |\\n| `http-server.authentication.krb5.principal-hostname` | The Kerberos hostname for the Trino coordinator. Must match the Kerberos principal. This parameter is optional. If included, Trino uses this value in the host part of the Kerberos principal instead of the machine's hostname. |\\n| `http-server.authentication.krb5.keytab` | The location of the keytab that can be used to authenticate the Kerberos principal. |\\n| `http.authentication.krb5.config` | The location of the Kerberos configuration file. |\\n| `http-server.https.enabled` | Enables HTTPS access for the Trino coordinator. Should be set to `true`. |\\n| `http-server.https.port` | HTTPS server port. |\\n| `http-server.https.keystore.path` | The location of the Java Keystore file that is used to secure TLS. |\\n| `http-server.https.keystore.key` | The password for the keystore. This must match the password you specified when creating the keystore. |\\n| `http-server.authentication.krb5.user-mapping.pattern` | Regex to match against user. If matched, user will be replaced with first regex group. If not matched, authentication is denied. Default is `(.*)`. |\\n| `http-server.authentication.krb5.user-mapping.file` | File containing rules for mapping user. See {doc}`/security/user-mapping` for more information. |\\n| `node.internal-address-source` | Kerberos is typically sensitive to DNS names. Setting this property to use `FQDN` ensures correct operation and usage of valid DNS host names. |\\n\\nSee {ref}`Standards supported <tls-version-and-ciphers>` for a discussion of the\\nsupported TLS versions and cipher suites.\", \"access-control.properties\": \"At a minimum, an {file}`access-control.properties` file must contain an\\n`access-control.name` property. All other configuration is specific for the\\nimplementation being configured. See {doc}`/develop/system-access-control` for\\ndetails.\\n\\n(coordinator-troubleshooting)=\"}, \"User mapping\": \"After authenticating with Kerberos, the Trino server receives the user's\\nprincipal which is typically similar to an email address. For example, when\\n`alice` logs in Trino might receive `alice@example.com`. By default, Trino\\nuses the full Kerberos principal name, but this can be mapped to a shorter\\nname using a user-mapping pattern. For simple mapping rules, the\\n`http-server.authentication.krb5.user-mapping.pattern` configuration property\\ncan be set to a Java regular expression, and Trino uses the value of the\\nfirst matcher group. If the regular expression does not match, the\\nauthentication is denied. For more complex user-mapping rules, see\\n{doc}`/security/user-mapping`.\", \"Troubleshooting\": {\"Kerberos verification\": \"Ensure that you can connect to the KDC from the Trino coordinator using\\n{command}`telnet`:\\n\\n```\\n$ telnet kdc.example.com 88\\n```\\n\\nVerify that the keytab file can be used to successfully obtain a ticket using\\n[kinit](http://web.mit.edu/kerberos/krb5-1.12/doc/user/user_commands/kinit.html) and\\n[klist](http://web.mit.edu/kerberos/krb5-1.12/doc/user/user_commands/klist.html)\\n\\n```\\n$ kinit -kt /etc/trino/trino.keytab trino@EXAMPLE.COM\\n$ klist\\n```\", \"Java keystore file verification\": \"Verify the password for a keystore file and view its contents using\\n{ref}`troubleshooting-keystore`.\\n\\n(kerberos-debug)=\", \"Additional Kerberos debugging information\": \"You can enable additional Kerberos debugging information for the Trino\\ncoordinator process by adding the following lines to the Trino `jvm.config`\\nfile:\\n\\n```\\n-Dsun.security.krb5.debug=true\\n-Dlog.enable-console=true\\n```\\n\\n`-Dsun.security.krb5.debug=true` enables Kerberos debugging output from the\\nJRE Kerberos libraries. The debugging output goes to `stdout`, which Trino\\nredirects to the logging system. `-Dlog.enable-console=true` enables output\\nto `stdout` to appear in the logs.\\n\\nThe amount and usefulness of the information the Kerberos debugging output\\nsends to the logs varies depending on where the authentication is failing.\\nException messages and stack traces can provide useful clues about the\\nnature of the problem.\\n\\nSee [Troubleshooting Security](https://docs.oracle.com/en/java/javase/11/security/troubleshooting-security.html)\\nin the Java documentation for more details about the `-Djava.security.debug`\\nflag, and [Troubleshooting](https://docs.oracle.com/en/java/javase/11/security/troubleshooting.html) for\\nmore details about the Java GSS-API and Kerberos issues.\\n\\n(server-additional-resources)=\", \"Additional resources\": \"[Common Kerberos Error Messages (A-M)](http://docs.oracle.com/cd/E19253-01/816-4557/trouble-6/index.html)\\n\\n[Common Kerberos Error Messages (N-Z)](http://docs.oracle.com/cd/E19253-01/816-4557/trouble-27/index.html)\\n\\n[MIT Kerberos Documentation: Troubleshooting](http://web.mit.edu/kerberos/krb5-latest/doc/admin/troubleshoot.html)\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 9]\"}, {\"title\": \"LDAP authentication\", \"description\": null, \"content\": {\"Trino server configuration\": {\"Trino coordinator node configuration\": {\"Server config properties\": \"The following is an example of the required properties that need to be added\\nto the coordinator's `config.properties` file:\\n\\n```\\nhttp-server.authentication.type=PASSWORD\\n\\nhttp-server.https.enabled=true\\nhttp-server.https.port=8443\\n\\nhttp-server.https.keystore.path=/etc/trino/keystore.jks\\nhttp-server.https.keystore.key=keystore_password\\n```\\n\\nFind detailed description for the available properties in\\n[](/admin/properties-http-server) and the following table:\\n\\n:::{list-table}\\n:widths: 20, 80\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`http-server.authentication.password.user-mapping.pattern`', 'Regex to match against user. If matched, user is replaced with first regex\\\\ngroup. If not matched, authentication is denied. Defaults to `(.*)`.'], ['`http-server.authentication.password.user-mapping.file`', 'File containing rules for mapping user. See [](/security/user-mapping)\\\\nfor more information.\\\\n:::']]\", \"Password authenticator configuration\": {\"Active Directory\": \"```\\nldap.user-bind-pattern=${USER}@<domain_name_of_the_server>\\n```\\n\\nExample:\\n\\n```\\nldap.user-bind-pattern=${USER}@corp.example.com\\n```\", \"OpenLDAP\": \"```\\nldap.user-bind-pattern=uid=${USER},<distinguished_name_of_the_user>\\n```\\n\\nExample:\\n\\n```\\nldap.user-bind-pattern=uid=${USER},OU=America,DC=corp,DC=example,DC=com\\n```\"}, \"Authorization based on LDAP group membership\": \"You can further restrict the set of users allowed to connect to the Trino\\ncoordinator, based on their group membership, by setting the optional\\n`ldap.group-auth-pattern` and `ldap.user-base-dn` properties, in addition\\nto the basic LDAP authentication properties.\\n\\n:::{list-table}\\n:widths: 35, 65\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`ldap.user-base-dn`', 'The base LDAP distinguished name for the user who tries to connect to the\\\\nserver. Example: `OU=America,DC=corp,DC=example,DC=com`'], ['`ldap.group-auth-pattern`', 'This property is used to specify the LDAP query for the LDAP group\\\\nmembership authorization. This query is executed against the LDAP server and\\\\nif successful, the user is authorized.', 'This property must contain a pattern `${USER}`, which is replaced by the\\\\nactual username in the group authorization search query. See details in the\\\\n[examples section](ldap-group-auth-examples).\\\\n:::']]\", \"Authorization using Trino LDAP service user\": {\"LDAP group authorization examples\": \"With Active Directory, the following syntax can be used:\\n\\n```\\nldap.group-auth-pattern=(&(objectClass=<objectclass_of_user>)(sAMAccountName=${USER})(memberof=<dn_of_the_authorized_group>))\\n```\\n\\nExample:\\n\\n```\\nldap.group-auth-pattern=(&(objectClass=person)(sAMAccountName=${USER})(memberof=CN=AuthorizedGroup,OU=Asia,DC=corp,DC=example,DC=com))\\n```\\n\\nWith OpenLDAP, the following syntax can be used:\\n\\n```\\nldap.group-auth-pattern=(&(objectClass=<objectclass_of_user>)(uid=${USER})(memberof=<dn_of_the_authorized_group>))\\n```\\n\\nExample:\\n\\n```\\nldap.group-auth-pattern=(&(objectClass=inetOrgPerson)(uid=${USER})(memberof=CN=AuthorizedGroup,OU=Asia,DC=corp,DC=example,DC=com))\\n```\\n\\nFor OpenLDAP, for this query to work, make sure you enable the\\n`memberOf` [overlay](http://www.openldap.org/doc/admin24/overlays.html).\\n\\nYou can use this property for scenarios where you want to authorize a user\\nbased on complex group authorization search queries. For example, if you want to\\nauthorize a user belonging to any one of multiple groups (in OpenLDAP), this\\nproperty may be set as follows:\\n\\n```\\nldap.group-auth-pattern=(&(|(memberOf=CN=normal_group,DC=corp,DC=com)(memberOf=CN=another_group,DC=com))(objectClass=inetOrgPerson)(uid=${USER}))\\n```\\n\\n(cli-ldap)=\"}}}, \"Trino CLI\": {\"Environment configuration\": {\"TLS configuration\": \"When using LDAP authentication, access to the Trino coordinator must be through\\n{doc}`TLS/HTTPS </security/tls>`.\"}, \"Trino CLI execution\": \"In addition to the options that are required when connecting to a Trino\\ncoordinator that does not require LDAP authentication, invoking the CLI\\nwith LDAP support enabled requires a number of additional command line\\noptions. You can either use `--keystore-*` or `--truststore-*` properties\\nto secure TLS connection. The simplest way to invoke the CLI is with a\\nwrapper script.\\n\\n```\\n#!/bin/bash\\n\\n./trino \\\\\\n--server https://trino-coordinator.example.com:8443 \\\\\\n--keystore-path /tmp/trino.jks \\\\\\n--keystore-password password \\\\\\n--truststore-path /tmp/trino_truststore.jks \\\\\\n--truststore-password password \\\\\\n--catalog <catalog> \\\\\\n--schema <schema> \\\\\\n--user <LDAP user> \\\\\\n--password\\n```\\n\\nFind details on the options used in {ref}`cli-tls` and\\n{ref}`cli-username-password-auth`.\"}, \"Troubleshooting\": {\"Java keystore file verification\": \"Verify the password for a keystore file and view its contents using\\n{ref}`troubleshooting-keystore`.\", \"Debug Trino to LDAP server issues\": \"If you need to debug issues with Trino communicating with the LDAP server,\\nyou can change the [log level](logging-configuration) for the LDAP authenticator:\\n\\n```\\nio.trino.plugin.password=DEBUG\\n```\", \"TLS debugging for Trino CLI\": {\"Common TLS/SSL errors\": {\"java.security.cert.CertificateException: No subject alternative names present\": \"This error is seen when the Trino coordinator\\u2019s certificate is invalid, and does not have the IP you provide\\nin the `--server` argument of the CLI. You have to regenerate the coordinator's TLS certificate\\nwith the appropriate {abbr}`SAN (Subject Alternative Name)` added.\\n\\nAdding a SAN to this certificate is required in cases where `https://` uses IP address in the URL, rather\\nthan the domain contained in the coordinator's certificate, and the certificate does not contain the\\n{abbr}`SAN (Subject Alternative Name)` parameter with the matching IP address as an alternative attribute.\"}, \"Authentication or TLS errors with JDK upgrade\": \"Starting with the JDK 8u181 release, to improve the robustness of LDAPS\\n(secure LDAP over TLS) connections, endpoint identification algorithms were\\nenabled by default. See release notes\\n[from Oracle](https://www.oracle.com/technetwork/java/javase/8u181-relnotes-4479407.html#JDK-8200666.).\\nThe same LDAP server certificate on the Trino coordinator, running on JDK\\nversion >= 8u181, that was previously able to successfully connect to an\\nLDAPS server, may now fail with the following error:\\n\\n```\\njavax.naming.CommunicationException: simple bind failed: ldapserver:636\\n[Root exception is javax.net.ssl.SSLHandshakeException: java.security.cert.CertificateException: No subject alternative DNS name matching ldapserver found.]\\n```\\n\\nIf you want to temporarily disable endpoint identification, you can add the\\nproperty `-Dcom.sun.jndi.ldap.object.disableEndpointIdentification=true`\\nto Trino's `jvm.config` file. However, in a production environment, we\\nsuggest fixing the issue by regenerating the LDAP server certificate so that\\nthe certificate {abbr}`SAN (Subject Alternative Name)` or certificate subject\\nname matches the LDAP server.\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 10]\"}, {\"title\": \"OAuth 2.0 authentication\", \"description\": null, \"content\": {\"OpenID Connect Discovery\": \"Trino supports reading Authorization Server configuration from [OIDC provider\\nconfiguration metadata document](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\\nDuring startup of the coordinator Trino retrieves the document and uses provided\\nvalues to set corresponding OAuth2 authentication configuration properties:\\n\\n['`authorization_endpoint` -> `http-server.authentication.oauth2.auth-url`', '`token_endpoint` -> `http-server.authentication.oauth2.token-url`', '`jwks_uri` -> `http-server.authentication.oauth2.jwks-url`', '`userinfo_endpoint` -> `http-server.authentication.oauth2.userinfo-url`', '`access_token_issuer` -> `http-server.authentication.oauth2.access-token-issuer`', '`end_session_endpoint` -> `http-server.authentication.oauth2.end-session-url`']\\n\\n:::{warning}\\nIf the authorization server is issuing JSON Web Tokens (JWTs) and the\\nmetadata document contains `userinfo_endpoint`, Trino uses this endpoint to\\ncheck the validity of OAuth2 access tokens. Since JWTs can be inspected\\nlocally, using them against `userinfo_endpoint` may result in authentication\\nfailure. In this case, set the\\n`http-server.authentication.oauth2.oidc.use-userinfo-endpoint` configuration\\nproperty to `false`\\n(`http-server.authentication.oauth2.oidc.use-userinfo-endpoint=false`). This\\ninstructs Trino to ignore `userinfo_endpoint` and inspect tokens locally.\\n:::\\n\\nThis functionality is enabled by default but can be turned off with:\\n`http-server.authentication.oauth2.oidc.discovery=false`.\\n\\n(trino-server-configuration-oauth2)=\", \"Trino server configuration\": {\"Refresh tokens\": \"*Refresh tokens* allow you to securely control the length of user sessions\\nwithin applications. The refresh token has a longer lifespan (TTL) and is used\\nto refresh the *access token* that has a shorter lifespan. When refresh tokens\\nare used in conjunction with access tokens, users can remain logged in for an\\nextended duration without interruption by another login request.\\n\\nIn a refresh token flow, there are three tokens with different expiration times:\\n\\n['access token', 'refresh token', 'Trino-encrypted token that is a combination of the access and refresh tokens.\\\\nThe encrypted token manages the session lifetime with the timeout value that\\\\nis set with the\\\\n`http-server.authentication.oauth2.refresh-tokens.issued-token.timeout`\\\\nproperty.']\\n\\nIn the following scenario, the lifespan of the tokens issued by an IdP are:\\n\\n['access token 5m', 'refresh token 24h']\\n\\nBecause the access token lifespan is only five minutes, Trino uses the longer\\nlifespan refresh token to request another access token every five minutes on\\nbehalf of a user. In this case, the maximum\\n`http-server.authentication.oauth2.refresh-tokens.issued-token.timeout` is\\ntwenty-four hours.\\n\\nTo use refresh token flows, the following property must be\\nenabled in the coordinator configuration.\\n\\n```\\nhttp-server.authentication.oauth2.refresh-tokens=true\\n```\\n\\nAdditional scopes for offline access might be required, depending on\\nIdP configuration.\\n\\n```\\nhttp-server.authentication.oauth2.scopes=openid,offline_access [or offline]\\n```\\n\\nThe following configuration properties are available:\\n\\n:::{list-table} OAuth2 configuration properties for refresh flow\\n:widths: 40 60\\n:header-rows: 1\\n\\n[['Property', 'Description'], ['`http-server.authentication.oauth2.refresh-tokens.issued-token.timeout`', 'Expiration time for an issued token, which is the Trino-encrypted token that\\\\ncontains an access token and a refresh token. The timeout value must be less\\\\nthan or equal to the [duration](prop-type-duration) of the refresh token\\\\nexpiration issued by the IdP. Defaults to `1h`. The timeout value is the\\\\nmaximum session time for an OAuth2-authenticated client with refresh tokens\\\\nenabled. For more details, see [](trino-oauth2-troubleshooting).'], ['`http-server.authentication.oauth2.refresh-tokens.issued-token.issuer`', 'Issuer representing the coordinator instance, that is referenced in the\\\\nissued token, defaults to `Trino_coordinator`. The current Trino version is\\\\nappended to the value. This is mainly used for debugging purposes.'], ['`http-server.authentication.oauth2.refresh-tokens.issued-token.audience`', 'Audience representing this coordinator instance, that is used in the\\\\nissued token. Defaults to `Trino_coordinator`.'], ['`http-server.authentication.oauth2.refresh-tokens.secret-key`', \\\"Base64-encoded secret key used to encrypt the generated token. By default\\\\nit's generated during startup.\\\\n:::\\\"]]\\n\\n(trino-oauth2-troubleshooting)=\"}, \"Troubleshooting\": \"To debug issues, change the [log level <log-levels>` for the OAuth 2.0\\nauthenticator:\\n\\n```\\nio.trino.server.security.oauth2=DEBUG\\n```\\n\\nTo debug issues with OAuth 2.0 authentication use with the web UI, set the\\nfollowing configuration property:\\n\\n```\\nio.trino.server.ui.OAuth2WebUiAuthenticationFilter=DEBUG\\n```\\n\\nThis assumes the OAuth 2.0 authentication for the Web UI is enabled as described\\nin {ref}`trino-server-configuration-oauth2`.\\n\\nThe logged debug error for a lapsed refresh token is `Tokens refresh challenge\\nhas failed`.\\n\\n:::{warning}\\nIf a refresh token lapses, the user session is interrupted and the user must\\nreauthenticate by logging in again. Ensure you set the\\n`http-server.authentication.oauth2.refresh-tokens.issued-token.timeout`\\nvalue to less than or equal to the duration of the refresh token expiration\\nissued by your IdP. Optimally, the timeout should be slightly less than the\\nrefresh token lifespan of your IdP to ensure that sessions end gracefully.\\n:::\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 11]\"}, {\"title\": \"Open Policy Agent access control\", \"description\": null, \"content\": {\"Requirements\": [\"A running [OPA deployment](https://www.openpolicyagent.org/docs/latest/#running-opa)\", \"Network connectivity from the Trino cluster to the OPA server\"], \"Trino configuration\": {\"Logging\": \"When request or response logging is enabled, details are logged at the `DEBUG`\\nlevel under the `io.trino.plugin.opa.OpaHttpClient` logger. The Trino logging\\nconfiguration must be updated to include this class, to ensure log entries are\\ncreated.\\n\\nNote that enabling these options produces very large amounts of log data.\\n\\n(opa-permission-management)=\", \"Permission management\": \"The following operations are allowed or denied based on the setting of\\n`opa.allow-permission-management-operations` If set to `true`, these operations are\\nallowed. If set to `false`, they are denied. In both cases, no request is sent\\nto OPA.\\n\\n['`GrantSchemaPrivilege`', '`DenySchemaPrivilege`', '`RevokeSchemaPrivilege`', '`GrantTablePrivilege`', '`DenyTablePrivilege`', '`RevokeTablePrivilege`', '`CreateRole`', '`DropRole`', '`GrantRoles`', '`RevokeRoles`']\\n\\nThe setting defaults to `false` due to the complexity and potential unexpected\\nconsequences of having SQL-style grants and roles together with OPA.\\n\\nYou must enable permission management if another custom security system in Trino\\nis capable of grant management and used together with OPA access control.\\n\\nAdditionally, users are always allowed to show information about roles (`SHOW\\nROLES`), regardless of this setting. The following operations are _always_\\nallowed:\\n\\n['`ShowRoles`', '`ShowCurrentRoles`', '`ShowRoleGrants`']\"}, \"OPA configuration\": {\"Example requests to OPA\": \"Accessing a table results in a query similar to the following example:\\n\\n```\\n{\\n \\\"context\\\": {\\n \\\"identity\\\": {\\n \\\"user\\\": \\\"foo\\\",\\n \\\"groups\\\": [\\\"some-group\\\"]\\n },\\n \\\"softwareStack\\\": {\\n \\\"trinoVersion\\\": \\\"434\\\"\\n }\\n },\\n \\\"action\\\": {\\n \\\"operation\\\": \\\"SelectFromColumns\\\",\\n \\\"resource\\\": {\\n \\\"table\\\": {\\n \\\"catalogName\\\": \\\"example_catalog\\\",\\n \\\"schemaName\\\": \\\"example_schema\\\",\\n \\\"tableName\\\": \\\"example_table\\\",\\n \\\"columns\\\": [\\n \\\"column1\\\",\\n \\\"column2\\\",\\n \\\"column3\\\"\\n ]\\n }\\n }\\n }\\n}\\n```\\n\\nThe `targetResource` is used in cases where a new resource, distinct from the one in\\n`resource` is created. For example, when renaming a table.\\n\\n```\\n{\\n \\\"context\\\": {\\n \\\"identity\\\": {\\n \\\"user\\\": \\\"foo\\\",\\n \\\"groups\\\": [\\\"some-group\\\"]\\n },\\n \\\"softwareStack\\\": {\\n \\\"trinoVersion\\\": \\\"434\\\"\\n }\\n },\\n \\\"action\\\": {\\n \\\"operation\\\": \\\"RenameTable\\\",\\n \\\"resource\\\": {\\n \\\"table\\\": {\\n \\\"catalogName\\\": \\\"example_catalog\\\",\\n \\\"schemaName\\\": \\\"example_schema\\\",\\n \\\"tableName\\\": \\\"example_table\\\"\\n }\\n },\\n \\\"targetResource\\\": {\\n \\\"table\\\": {\\n \\\"catalogName\\\": \\\"example_catalog\\\",\\n \\\"schemaName\\\": \\\"example_schema\\\",\\n \\\"tableName\\\": \\\"new_table_name\\\"\\n }\\n }\\n }\\n}\\n```\"}, \"Row filtering\": \"Row filtering allows Trino to remove some rows from the result before returning\\nit to the caller, controlling what data different users can see. The plugin\\nsupports retrieving filter definitions from OPA by configuring the OPA endpoint\\nfor row filter processing with `opa.policy.row-filters-uri`.\\n\\nFor example, an OPA policy for row filtering may be defined by the following\\nrego script:\\n\\n```\\n package trino\\n import future.keywords.in\\n import future.keywords.if\\n import future.keywords.contains\\n\\n default allow := true\\n\\n table_resource := input.action.resource.table\\n is_admin {\\n input.context.identity.user == \\\"admin\\\"\\n }\\n\\n rowFilters contains {\\\"expression\\\": \\\"user_type <> 'customer'\\\"} if {\\n not is_admin\\n table_resource.catalogName == \\\"sample_catalog\\\"\\n table_resource.schemaName == \\\"sample_schema\\\"\\n table_resource.tableName == \\\"restricted_table\\\"\\n }\\n```\\n\\nThe response expected by the plugin is an array of objects, each of them in the\\nformat `{\\\"expression\\\":\\\"clause\\\"}`. Each expression essentially behaves like an\\nadditional `WHERE` clause. The script can also return multiple row filters for a\\nsingle OPA request, and all filters are subsequently applied.\\n\\nEach object may contain an identity field. The identity field allows Trino to\\nevaluate these row filters under a **different** identity - such that a filter\\ncan target a column the requesting user cannot see.\", \"Column masking\": {\"Batch column masking\": \"If column masking is enabled, by default, the plugin will fetch each column\\nmask individually from OPA. When working with very wide tables this\\ncan result in a performance degradation.\\n\\nConfiguring `opa.policy.batch-column-masking-uri` allows Trino to fetch the masks\\nfor multiple columns in a single request. The list of requested columns is included\\nin the request under `action.filterResources`.\\n\\nIf `opa.policy.batch-column-masking-uri` is set it overrides the value of\\n`opa.policy.column-masking-uri` so that the plugin uses batch column\\nmasking.\\n\\nAn OPA policy supporting batch column masking must return a list of objects,\\neach containing the following data:\\n\\n['`viewExpression`:', ['`expression`: the expression to apply to the column, as a string', '`identity` (optional): the identity to evaluate the expression as, as a\\\\nstring'], '`index`: a reference the index of the column in the request to which this mask\\\\napplies']\\n\\nFor example, a policy configuring batch column masking may be defined by the\\nfollowing rego script:\\n\\n```\\npackage trino\\nimport future.keywords.in\\nimport future.keywords.if\\nimport future.keywords.contains\\n\\ndefault allow := true\\n\\nbatchColumnMasks contains {\\n \\\"index\\\": i,\\n \\\"viewExpression\\\": {\\n \\\"expression\\\": \\\"NULL\\\"\\n }\\n} if {\\n some i\\n column_resource := input.action.filterResources[i]\\n column_resource.catalogName == \\\"sample_catalog\\\"\\n column_resource.schemaName == \\\"sample_schema\\\"\\n column_resource.tableName == \\\"restricted_table\\\"\\n column_resource.columnName == \\\"user_phone\\\"\\n}\\n\\n\\nbatchColumnMasks contains {\\n \\\"index\\\": i,\\n \\\"viewExpression\\\": {\\n \\\"expression\\\": \\\"'****' || substring(user_name, -3)\\\",\\n \\\"identity\\\": \\\"admin\\\"\\n }\\n} if {\\n some i\\n column_resource := input.action.filterResources[i]\\n column_resource.catalogName == \\\"sample_catalog\\\"\\n column_resource.schemaName == \\\"sample_schema\\\"\\n column_resource.tableName == \\\"restricted_table\\\"\\n column_resource.columnName == \\\"user_name\\\"\\n}\\n```\\n\\nA batch column masking request is similar to the following example:\\n\\n```\\n{\\n \\\"context\\\": {\\n \\\"identity\\\": {\\n \\\"user\\\": \\\"foo\\\",\\n \\\"groups\\\": [\\\"some-group\\\"]\\n },\\n \\\"softwareStack\\\": {\\n \\\"trinoVersion\\\": \\\"434\\\"\\n }\\n },\\n \\\"action\\\": {\\n \\\"operation\\\": \\\"GetColumnMask\\\",\\n \\\"filterResources\\\": [\\n {\\n \\\"column\\\": {\\n \\\"catalogName\\\": \\\"sample_catalog\\\",\\n \\\"schemaName\\\": \\\"sample_schema\\\",\\n \\\"tableName\\\": \\\"restricted_table\\\",\\n \\\"columnName\\\": \\\"user_phone\\\",\\n \\\"columnType\\\": \\\"VARCHAR\\\"\\n }\\n },\\n {\\n \\\"column\\\": {\\n \\\"catalogName\\\": \\\"sample_catalog\\\",\\n \\\"schemaName\\\": \\\"sample_schema\\\",\\n \\\"tableName\\\": \\\"restricted_table\\\",\\n \\\"columnName\\\": \\\"user_name\\\",\\n \\\"columnType\\\": \\\"VARCHAR\\\"\\n }\\n }\\n ]\\n }\\n}\\n```\\n\\nThe related OPA response is displayed in the following snippet:\\n\\n```\\n[\\n {\\n \\\"index\\\": 0,\\n \\\"viewExpression\\\": {\\n \\\"expression\\\": \\\"NULL\\\"\\n }\\n },\\n {\\n \\\"index\\\": 1,\\n \\\"viewExpression\\\": {\\n \\\"expression\\\": \\\"'****' || substring(user_name, -3)\\\",\\n \\\"identity\\\": \\\"admin\\\"\\n }\\n }\\n]\\n```\\n\\n(opa-batch-mode)=\"}, \"Batch mode\": \"A very powerful feature provided by OPA is its ability to respond to\\nauthorization queries with more complex answers than a `true` or `false` boolean\\nvalue.\\n\\nMany features in Trino require filtering to determine to which resources a user\\nis granted access. These resources are catalogs, schema, queries, views, and\\nothers objects.\\n\\nIf `opa.policy.batched-uri` is not configured, Trino sends one request to OPA\\nfor each object, and then creates a filtered list of permitted objects.\\n\\nConfiguring `opa.policy.batched-uri` allows Trino to send a request to\\nthe batch endpoint, with a list of resources in one request using the\\nunder `action.filterResources` node.\\n\\nAll other fields in the request are identical to the non-batch endpoint.\\n\\nAn OPA policy supporting batch operations must return a list containing the\\n_indices_ of the items for which authorization is granted. Returning a `null`\\nvalue or an empty list is equivalent and denies any access.\\n\\nYou can add batching support for policies that do not support it:\\n\\n```\\npackage foo\\n\\nimport future.keywords.contains\\n\\n# ... rest of the policy ...\\n# this assumes the non-batch response field is called \\\"allow\\\"\\nbatch contains i {\\n some i\\n raw_resource := input.action.filterResources[i]\\n allow with input.action.resource as raw_resource\\n}\\n\\n# Corner case: filtering columns is done with a single table item, and many columns inside\\n# We cannot use our normal logic in other parts of the policy as they are based on sets\\n# and we need to retain order\\nbatch contains i {\\n some i\\n input.action.operation == \\\"FilterColumns\\\"\\n count(input.action.filterResources) == 1\\n raw_resource := input.action.filterResources[0]\\n count(raw_resource[\\\"table\\\"][\\\"columns\\\"]) > 0\\n new_resources := [\\n object.union(raw_resource, {\\\"table\\\": {\\\"column\\\": column_name}})\\n | column_name := raw_resource[\\\"table\\\"][\\\"columns\\\"][_]\\n ]\\n allow with input.action.resource as new_resources[i]\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 12]\"}, {\"title\": \"Security overview\", \"description\": null, \"content\": {\"Aspects of configuring security\": \"The default installation of Trino has no security features enabled. Security\\ncan be enabled for different parts of the Trino architecture:\\n\\n['{ref}`security-client`', '{ref}`security-inside-cluster`', '{ref}`security-data-sources`']\", \"Suggested configuration workflow\": \"To configure security for a new Trino cluster, follow this best practice\\norder of steps. Do not skip or combine steps.\\n\\n['**Enable** {doc}`TLS/HTTPS </security/tls>`', ['Work with your security team.', 'Use a {ref}`load balancer or proxy <https-load-balancer>` to terminate\\\\nHTTPS, if possible.', 'Use a globally trusted TLS certificate.'], '{ref}`Verify this step is working correctly.<verify-tls>`', '**Configure** a {doc}`a shared secret </security/internal-communication>`', '{ref}`Verify this step is working correctly.<verify-secrets>`', '**Enable authentication**', ['Start with {doc}`password file authentication <password-file>` to get up\\\\nand running.', 'Then configure your preferred authentication provider, such as {doc}`LDAP\\\\n</security/ldap>`.', 'Avoid the complexity of Kerberos for client authentication, if possible.'], '{ref}`Verify this step is working correctly.<verify-authentication>`', '**Enable authorization and access control**', ['Start with {doc}`file-based rules <file-system-access-control>`.', 'Then configure another access control method as required.'], '{ref}`Verify this step is working correctly. <verify-rules>`']\\n\\nConfigure one step at a time. Always restart the Trino server after each\\nchange, and verify the results before proceeding.\\n\\n(security-client)=\", \"Securing client access to the cluster\": {\"Encryption\": \"The Trino server uses the standard {doc}`HTTPS protocol and TLS encryption\\n<tls>`, formerly known as SSL.\\n\\n(cl-access-auth)=\", \"Authentication\": {\"User name management\": \"Trino provides ways to map the user and group names from authentication\\nproviders to Trino usernames.\\n\\n['{doc}`User mapping <user-mapping>` applies to all authentication systems,\\\\nand allows for regular expression rules to be specified that map complex \\\\nusernames from other systems (`alice@example.com`) to simple usernames\\\\n(`alice`).', '{doc}`File group provider <group-file>` provides a way to assign a set\\\\nof usernames to a group name to ease access control.']\\n\\n(cl-access-control)=\"}, \"Authorization and access control\": \"Trino's {doc}`default method of access control <built-in-system-access-control>`\\nallows all operations for all authenticated users.\\n\\nTo implement access control, use:\\n\\n['{doc}`File-based system access control <file-system-access-control>`, where\\\\nyou configure JSON files that specify fine-grained user access restrictions at\\\\nthe catalog, schema, or table level.', '[](opa-access-control), where you use Open Policy Agent to make access control\\\\ndecisions on a fined-grained level.', '[](ranger-access-control), where you use Apache Ranger to make fine-grained\\\\naccess control decisions, apply dynamic row-filters and column-masking at\\\\nquery execution time, and generate audit logs.']\\n\\nIn addition, Trino {doc}`provides an API </develop/system-access-control>` that\\nallows you to create a custom access control method, or to extend an existing\\none.\\n\\nAccess control can limit access to columns of a table. The default behavior\\nof a query to all columns with a `SELECT *` statement is to show an error\\ndenying access to any inaccessible columns.\\n\\nYou can change this behavior to silently hide inaccessible columns with the\\nglobal property `hide-inaccessible-columns` configured in\\n{ref}`config-properties`:\\n\\n```\\nhide-inaccessible-columns = true\\n```\\n\\n(security-inside-cluster)=\"}, \"Securing inside the cluster\": \"You can {doc}`secure the internal communication <internal-communication>`\\nbetween coordinator and workers inside the clusters.\\n\\nSecrets in properties files, such as passwords in catalog files, can be secured\\nwith {doc}`secrets management <secrets>`.\\n\\n(security-data-sources)=\", \"Securing cluster access to data sources\": \"Communication between the Trino cluster and data sources is configured for each\\ncatalog. Each catalog uses a connector, which supports a variety of\\nsecurity-related configurations.\\n\\nMore information is available with the documentation for individual\\n{doc}`connectors </connector>`.\\n\\n{doc}`Secrets management <secrets>` can be used for the catalog properties files\\ncontent.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 13]\"}, {\"title\": \"Password file authentication\", \"description\": null, \"content\": {\"Password authenticator configuration\": \"To enable password file authentication, set the {doc}`password authentication\\ntype <authentication-types>` in `etc/config.properties`:\\n\\n```\\nhttp-server.authentication.type=PASSWORD\\n```\\n\\nIn addition, create a `etc/password-authenticator.properties` file on the\\ncoordinator with the `file` authenticator name:\\n\\n```\\npassword-authenticator.name=file\\nfile.password-file=/path/to/password.db\\n```\\n\\nThe following configuration properties are available:\\n\\n| Property | Description |\\n| -------------------------------- | ----------------------------------------------------------------- |\\n| `file.password-file` | Path of the password file. |\\n| `file.refresh-period` | How often to reload the password file. Defaults to `5s`. |\\n| `file.auth-token-cache.max-size` | Max number of cached authenticated passwords. Defaults to `1000`. |\", \"Password files\": {\"File format\": \"The password file contains a list of usernames and passwords, one per line,\\nseparated by a colon. Passwords must be securely hashed using bcrypt or PBKDF2.\\n\\nbcrypt passwords start with `$2y$` and must use a minimum cost of `8`:\\n\\n```\\ntest:$2y$10$BqTb8hScP5DfcpmHo5PeyugxHz5Ky/qf3wrpD7SNm8sWuA3VlGqsa\\n```\\n\\nPBKDF2 passwords are composed of the iteration count, followed by the\\nhex encoded salt and hash:\\n\\n```\\ntest:1000:5b4240333032306164:f38d165fce8ce42f59d366139ef5d9e1ca1247f0e06e503ee1a611dd9ec40876bb5edb8409f5abe5504aab6628e70cfb3d3a18e99d70357d295002c3d0a308a0\\n```\", \"Creating a password file\": \"Password files utilizing the bcrypt format can be created using the\\n[htpasswd](https://httpd.apache.org/docs/current/programs/htpasswd.html)\\nutility from the [Apache HTTP Server](https://httpd.apache.org/).\\nThe cost must be specified, as Trino enforces a higher minimum cost\\nthan the default.\\n\\nCreate an empty password file to get started:\\n\\n```\\ntouch password.db\\n```\\n\\nAdd or update the password for the user `test`:\\n\\n```\\nhtpasswd -B -C 10 password.db test\\n```\\n\\n(verify-authentication)=\", \"Verify configuration\": \"To verify password file authentication, log in to the {doc}`Web UI\\n</admin/web-interface>`, and connect with the Trino {doc}`CLI </client/cli>` to\\nthe cluster:\\n\\n['Connect to the Web UI from your browser using a URL that uses HTTPS, such as\\\\n`https://trino.example.com:8443`. Enter a username in the `Username` text\\\\nbox and the corresponding password in the `Password` text box, and log in to\\\\nthe UI. Confirm that you are not able to log in using an incorrect username\\\\nand password combination. A successful login displays the username in the\\\\ntop right corner of the UI.', 'Connect with the Trino CLI using a URL that uses HTTPS, such as\\\\n`https://trino.example.net:8443` with the addition of the `--user` and\\\\n`--password` properties:']\\n\\n```\\n./trino --server https://trino.example.com:8443 --user test --password\\n```\\n\\nThe above command quotes you for a password. Supply the password set for the\\nuser entered for the `--user` property to use the `trino>` prompt. Successful\\nauthentication allows you to run queries from the CLI.\\n\\nTo test the connection, send a query:\\n\\n```\\ntrino> SELECT 'rocks' AS trino;\\n\\ntrino\\n-------\\nrocks\\n(1 row)\\n\\nQuery 20220919_113804_00017_54qfi, FINISHED, 1 node\\nSplits: 1 total, 1 done (100.00%)\\n0.12 [0 rows, 0B] [0 rows/s, 0B/s]\\n```\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 14]\"}, {\"title\": \"Ranger access control\", \"description\": null, \"content\": {\"Requirements\": [\"Access to a Apache Ranger deployment with the desired authorization policies.\", \"Access to an audit store using Solr, HDFS, Log4J, or S3 to save audit logs.\", \"Apache Ranger 2.5.0 and greater include the required Trino service definition.\\nEarlier versions of Apache Ranger require an [update to the service definition\\navailable on\\nGitHub](https://github.com/apache/ranger/blob/ranger-2.5/agents-common/src/main/resources/service-defs/ranger-servicedef-trino.json).\"], \"Configuration\": {\"ranger-trino-security.xml\": \"```\\n<?xml-stylesheet type=\\\"text/xsl\\\" href=\\\"configuration.xsl\\\"?>\\n<configuration xmlns:xi=\\\"http://www.w3.org/2001/XInclude\\\">\\n <property>\\n <name>ranger.plugin.trino.policy.rest.url</name>\\n <value>https://ranger-hostname:6182</value>\\n <description>MANDATORY: a comma separated list of URLs to Apache Ranger instances in a deployment</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.access.cluster.name</name>\\n <value></value>\\n <description>Name to identify the cluster running the Trino instance. This is recorded in audit logs generated by the plugin</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.use.rangerGroups</name>\\n <value>false</value>\\n <description>Boolean flag to specify whether user-to-groups mapping should be obtained from in Apache Ranger. Default: false</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.use.only.rangerGroups</name>\\n <value>false</value>\\n <description>Boolean flag. true: use only user-to-groups mapping from Apache Ranger; false: use user-to-groups mappings from Apache Ranger and Trino. Default: false</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.super.users</name>\\n <value></value>\\n <description>Comma separated list of user names. Superusers will be authorized for all accesses, without requiring explicit policy grants.</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.super.groups</name>\\n <value></value>\\n <description>Comma separated list of group names. Users in supergroups will be authorized for all accesses, without requiring explicit policy grants</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.ugi.initialize</name>\\n <value>false</value>\\n <description>Initialize the kerberos identity used to authenticate with Ranger admin server</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.ugi.login.type</name>\\n <value></value>\\n <description>Valid value: keytab</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.ugi.keytab.principal</name>\\n <value></value>\\n <description>Kerberos principal. Example: trino@EXAMPLE.COM</description>\\n </property>\\n\\n <property>\\n <name>ranger.plugin.trino.ugi.keytab.file</name>\\n <value></value>\\n <description>Location of keytab file. Example: /etc/trino/trino.keytab</description>\\n </property>\\n</configuration>\\n```\", \"ranger-trino-audit.xml\": \"```\\n<?xml-stylesheet type=\\\"text/xsl\\\" href=\\\"configuration.xsl\\\"?>\\n<configuration xmlns:xi=\\\"http://www.w3.org/2001/XInclude\\\">\\n <property>\\n <name>xasecure.audit.is.enabled</name>\\n <value>true</value>\\n <description>Boolean flag to specify if the plugin should generate access audit logs. Default: true</description>\\n </property>\\n\\n <property>\\n <name>xasecure.audit.solr.is.enabled</name>\\n <value>false</value>\\n <description>Boolean flag to specify if audit logs should be stored in Solr. Default: false</description>\\n </property>\\n\\n <property>\\n <name>xasecure.audit.solr.solr_url</name>\\n <value></value>\\n <description>URL to Solr deployment where the plugin should send access audits to</description>\\n </property>\\n</configuration>\\n```\", \"ranger-policymgr-ssl.xml\": \"```\\n<?xml-stylesheet type=\\\"text/xsl\\\" href=\\\"configuration.xsl\\\"?>\\n<configuration xmlns:xi=\\\"http://www.w3.org/2001/XInclude\\\">\\n <!-- properties used for 2-way SSL between the Trino plugin and Apache Ranger server -->\\n <property>\\n <name>xasecure.policymgr.clientssl.keystore</name>\\n <value></value>\\n <description>Path to keystore file. Only required for two-way SSL. This property should not be included for one-way SSL</description>\\n </property>\\n\\n <property>\\n <name>xasecure.policymgr.clientssl.keystore.type</name>\\n <value>jks</value>\\n <description>Type of keystore. Default: jks</description>\\n </property>\\n\\n <property>\\n <name>xasecure.policymgr.clientssl.keystore.credential.file</name>\\n <value></value>\\n <description>Path to credential file for the keystore; the credential should be in alias sslKeyStore. Only required for two-way SSL. This property should not be included for one-way SSL</description>\\n </property>\\n\\n <property>\\n <name>xasecure.policymgr.clientssl.truststore</name>\\n <value></value>\\n <description>Path to truststore file</description>\\n </property>\\n\\n <property>\\n <name>xasecure.policymgr.clientssl.truststore.type</name>\\n <value>jks</value>\\n <description>Type of truststore. Default: jks</description>\\n </property>\\n\\n <property>\\n <name>xasecure.policymgr.clientssl.truststore.credential.file</name>\\n <value></value>\\n <description>Path to credential file for the truststore; the credential should be in alias sslTrustStore</description>\\n </property>\\n</configuration>\\n```\"}, \"Required policies\": [\"Users must have permission to execute queries in Trino. Without a policy in\\nApache Ranger to grant this permission, users are not able to execute any\\nquery.\", [\"To allow this, create a policy in Apache Ranger for a `queryId` resource\\nwith a value `*` and with the `execute` permission for the user `{USER}`.\"], \"Users must have permission to impersonate themselves in Trino. Without a\\npolicy in Apache Ranger to grant this permission, users are not able to\\nexecute any query.\", [\"To allow this, create a policy in Apache Ranger for a `trinouser` resource\\nwith value `{USER}` and with the `impersonate` permission for user `{USER}`.\"]]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 15]\"}, {\"title\": \"Salesforce authentication\", \"description\": null, \"content\": {\"Salesforce authenticator configuration\": \"To enable Salesforce authentication, set the {doc}`password authentication\\ntype <authentication-types>` in `etc/config.properties`:\\n\\n```\\nhttp-server.authentication.type=PASSWORD\\n```\\n\\nIn addition, create a `etc/password-authenticator.properties` file on the\\ncoordinator with the `salesforce` authenticator name:\\n\\n```\\npassword-authenticator.name=salesforce\\nsalesforce.allowed-organizations=<allowed-org-ids or all>\\n```\\n\\nThe following configuration properties are available:\\n\\n| Property | Description |\\n| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\\n| `salesforce.allowed-organizations` | Comma separated list of 18 character Salesforce.com Organization IDs for a second, simple layer of security. This option can be explicitly ignored using `all`, which bypasses any of the authenticated user's Salesforce.com Organization ID. |\\n| `salesforce.cache-size` | Maximum number of cached authenticated users. Defaults to `4096`. |\\n| `salesforce.cache-expire-duration` | How long a cached authentication should be considered valid. Defaults to `2m`. |\", \"Salesforce concepts\": {\"Security token\": \"Credentials are a user's Salesforce username and password if Trino is connecting\\nfrom a whitelisted IP, or username and password/[security\\ntoken](https://help.salesforce.com/articleView?id=user_security_token.htm&type=5)\\nconcatenation otherwise. For example, if Trino is *not* whitelisted, and your\\npassword is `password` and security token is `token`, use `passwordtoken` to\\nauthenticate.\\n\\nYou can configure a public IP for Trino as a trusted IP by [whitelisting an IP range](https://help.salesforce.com/articleView?id=security_networkaccess.htm&type=5).\", \"Salesforce.com organization IDs\": \"You can configure one or more Salesforce Organization IDs for additional\\nsecurity. When the user authenticates, the Salesforce API returns the *18\\ncharacter* Salesforce.com Organization ID for the user. The Trino Salesforce\\nauthenticator ensures that the ID matches one of the IDs configured in\\n`salesforce.allowed-organizations`.\\n\\nOptionally, you can configure `all` to explicitly ignore this layer of security.\\n\\nAdmins can find their Salesforce.com Organization ID using the [Salesforce Setup\\nUI](https://help.salesforce.com/articleView?id=000325251&type=1&mode=1). This 15\\ncharacter ID can be [converted to the 18 character ID](https://sf1518.click/).\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 16]\"}, {\"title\": \"Secrets\", \"description\": null, \"content\": {\"Secrets\": \"Trino manages configuration details in static properties files. This\\nconfiguration needs to include values such as usernames, passwords and other\\nstrings, that are often required to be kept secret. Only a few select\\nadministrators or the provisioning system has access to the actual value.\\n\\nThe secrets support in Trino allows you to use environment variables as values\\nfor any configuration property. All properties files used by Trino, including\\n`config.properties` and catalog properties files, are supported. When loading\\nthe properties, Trino replaces the reference to the environment variable with\\nthe value of the environment variable.\\n\\nEnvironment variables are the most widely-supported means of setting and\\nretrieving values. Environment variables can be set in the scope of the task\\nbeing performed, preventing external access. Most provisioning and configuration\\nmanagement systems include support for setting environment variables. This\\nincludes systems such as Ansible, often used for virtual machines, and\\nKubernetes for container usage. You can also manually set an environment\\nvariable on the command line.\\n\\n```\\nexport DB_PASSWORD=my-super-secret-pwd\\n```\\n\\nTo use this variable in the properties file, you reference it with the syntax\\n`${ENV:VARIABLE}`. For example, if you want to use the password in a catalog\\nproperties file like `etc/catalog/db.properties`, add the following line:\\n\\n```\\nconnection-password=${ENV:DB_PASSWORD}\\n```\\n\\nWith this setup in place, the secret is managed by the provisioning system\\nor by the administrators handling the machines. No secret is stored in the Trino\\nconfiguration files on the filesystem or wherever they are managed.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 17]\"}, {\"title\": \"TLS and HTTPS\", \"description\": null, \"content\": {\"Supported standards\": \"When configured to use TLS, the Trino server responds to client connections\\nusing TLS 1.2 and TLS 1.3 certificates. The server rejects TLS 1.1, TLS 1.0, and\\nall SSL format certificates.\\n\\nThe Trino server does not specify a set of supported ciphers, instead deferring\\nto the defaults set by the JVM version in use. The documentation for Java 24\\nlists its [supported cipher suites](https://docs.oracle.com/en/java/javase/24/security/oracle-providers.html#GUID-7093246A-31A3-4304-AC5F-5FB6400405E2__SUNJSSE_CIPHER_SUITES).\\n\\nRun the following two-line code on the same JVM from the same vendor as\\nconfigured on the coordinator to determine that JVM's default cipher list.\\n\\n```\\necho \\\"java.util.Arrays.asList(((javax.net.ssl.SSLServerSocketFactory) \\\\\\njavax.net.ssl.SSLServerSocketFactory.getDefault()).getSupportedCipherSuites()).forEach(System.out::println)\\\" | jshell -\\n```\\n\\nThe default Trino server specifies a set of regular expressions that exclude\\nolder cipher suites that do not support forward secrecy (FS).\\n\\nUse the `http-server.https.included-cipher` property to specify a\\ncomma-separated list of ciphers in preferred use order. If one of your preferred\\nselections is a non-FS cipher, you must also set the\\n`http-server.https.excluded-cipher` property to an empty list to override the\\ndefault exclusions. For example:\\n\\n```\\nhttp-server.https.included-cipher=TLS_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA256\\nhttp-server.https.excluded-cipher=\\n```\\n\\nSpecifying a different cipher suite is a complex issue that should only be\\nconsidered in conjunction with your organization's security managers. Using a\\ndifferent suite may require downloading and installing a different SunJCE\\nimplementation package. Some locales may have export restrictions on cipher\\nsuites. See the discussion in Java documentation that begins with [Customizing\\nthe Encryption Algorithm Providers](https://docs.oracle.com/en/java/javase/24/security/java-secure-socket-extension-jsse-reference-guide.html#GUID-316FB978-7588-442E-B829-B4973DB3B584).\\n\\n:::{note}\\nIf you manage the coordinator's direct TLS implementation, monitor the CPU\\nusage on the Trino coordinator after enabling HTTPS. Java prefers the more\\nCPU-intensive cipher suites, if you allow it to choose from a big list of\\nciphers. If the CPU usage is unacceptably high after enabling HTTPS, you can\\nconfigure Java to use specific cipher suites as described in this section.\\n\\nHowever, best practice is to instead use an external load balancer, as\\ndiscussed next.\\n:::\", \"Approaches\": \"To configure Trino with TLS support, consider two alternative paths:\\n\\n['Use the {ref}`load balancer or proxy <https-load-balancer>` at your site\\\\nor cloud environment to terminate TLS/HTTPS. This approach is the simplest and\\\\nstrongly preferred solution.', \\\"Secure the Trino {ref}`server directly <https-secure-directly>`. This\\\\nrequires you to obtain a valid certificate, and add it to the Trino\\\\ncoordinator's configuration.\\\"]\\n\\n(https-load-balancer)=\", \"Use a load balancer to terminate TLS/HTTPS\": \"Your site or cloud environment may already have a {ref}`load balancer <glossLB>`\\nor proxy server configured and running with a valid, globally trusted TLS\\ncertificate. In this case, you can work with your network administrators to set\\nup your Trino server behind the load balancer. The load balancer or proxy server\\naccepts TLS connections and forwards them to the Trino coordinator, which\\ntypically runs with default HTTP configuration on the default port, 8080.\\n\\nWhen a load balancer accepts a TLS encrypted connection, it adds a\\n[forwarded](https://developer.mozilla.org/docs/Web/HTTP/Proxy_servers_and_tunneling#forwarding_client_information_through_proxies)\\nHTTP header to the request, such as `X-Forwarded-Proto: https`.\\n\\nThis tells the Trino coordinator to process the connection as if a TLS\\nconnection has already been successfully negotiated for it. This is why you do\\nnot need to configure `http-server.https.enabled=true` for a coordinator\\nbehind a load balancer.\\n\\nHowever, to enable processing of such forwarded headers, the server's\\n{ref}`config properties file <config-properties>` *must* include the following:\\n\\n```\\nhttp-server.process-forwarded=true\\n```\\n\\nMore information about HTTP server configuration is available in\\n[](/admin/properties-http-server).\\n\\nThis completes any necessary configuration for using HTTPS with a load balancer.\\nClient tools can access Trino with the URL exposed by the load balancer.\\n\\n(https-secure-directly)=\", \"Secure Trino directly\": {\"Add a TLS certificate\": \"Obtain a TLS certificate file for use with your Trino server. Consider the\\nfollowing types of certificates:\\n\\n['**Globally trusted certificates** \\u2014 A certificate that is automatically\\\\ntrusted by all browsers and clients. This is the easiest type to use because\\\\nyou do not need to configure clients. Obtain a certificate of this type from:', ['A commercial certificate vendor', 'Your cloud infrastructure provider', 'A domain name registrar, such as Verisign or GoDaddy', 'A free certificate generator, such as\\\\n[letsencrypt.org](https://letsencrypt.org/) or\\\\n[sslforfree.com](https://www.sslforfree.com/)'], \\\"**Corporate trusted certificates** \\u2014 A certificate trusted by browsers and\\\\nclients in your organization. Typically, a site's IT department runs a local\\\\n{ref}`certificate authority <glossCA>` and preconfigures clients and servers\\\\nto trust this CA.\\\", '**Generated self-signed certificates** \\u2014 A certificate generated just for\\\\nTrino that is not automatically trusted by any client. Before using, make sure\\\\nyou understand the {ref}`limitations of self-signed certificates\\\\n<self-signed-limits>`.']\\n\\nThe most convenient option and strongly recommended option is a globally trusted\\ncertificate. It may require a little more work up front, but it is worth it to\\nnot have to configure every single client.\", \"Keys and certificates\": \"Trino can read certificates and private keys encoded in PEM encoded PKCS #1, PEM\\nencoded PKCS #8, PKCS #12, and the legacy Java KeyStore (JKS) format.\\nCertificates and private keys encoded in a binary format such as DER must be\\nconverted.\\n\\nMake sure you obtain a certificate that is validated by a recognized\\n{ref}`certificate authority <glossCA>`.\", \"Inspect received certificates\": \"Before installing your certificate, inspect and validate the received key and\\ncertificate files to make sure they reference the correct information to access\\nyour Trino server. Much unnecessary debugging time is saved by taking the time\\nto validate your certificates before proceeding to configure the server.\\n\\nInspect PEM-encoded files as described in {doc}`Inspect PEM files\\n</security/inspect-pem>`.\\n\\nInspect PKCS # 12 and JKS keystores as described in {doc}`Inspect JKS files\\n</security/inspect-jks>`.\", \"Invalid certificates\": \"If your certificate does not pass validation, or does not show the expected\\ninformation on inspection, contact the group or vendor who provided it for a\\nreplacement.\\n\\n(cert-placement)=\", \"Place the certificate file\": \"There are no location requirements for a certificate file as long as:\\n\\n['The file can be read by the Trino coordinator server process.', 'The location is secure from copying or tampering by malicious actors.']\\n\\nYou can place your file in the Trino coordinator's `etc` directory, which\\nallows you to use a relative path reference in configuration files. However,\\nthis location can require you to keep track of the certificate file, and move it\\nto a new `etc` directory when you upgrade your Trino version.\\n\\n(configure-https)=\", \"Configure the coordinator\": \"On the coordinator, add the following lines to the {ref}`config properties file\\n<config-properties>` to enable TLS/HTTPS support for the server.\\n\\n:::{note}\\nLegacy `keystore` and `truststore` wording is used in property names, even\\nwhen directly using PEM-encoded certificates.\\n:::\\n\\n```\\nhttp-server.https.enabled=true\\nhttp-server.https.port=8443\\nhttp-server.https.keystore.path=etc/clustercoord.pem\\n```\\n\\nPossible alternatives for the third line include:\\n\\n```\\nhttp-server.https.keystore.path=etc/clustercoord.jks\\nhttp-server.https.keystore.path=/usr/local/certs/clustercoord.p12\\n```\\n\\nRelative paths are relative to the Trino server's root directory. In a\\n`tar.gz` installation, the root directory is one level above `etc`.\\n\\nJKS keystores always require a password, while PEM files with passwords are not\\nsupported by Trino. For JKS, add the following line to the configuration:\\n\\n```\\nhttp-server.https.keystore.key=<keystore-password>\\n```\\n\\nIt is possible for a key inside a keystore to have its own password,\\nindependent of the keystore's password. In this case, specify the key's password\\nwith the following property:\\n\\n```\\nhttp-server.https.keymanager.password=<key-password>\\n```\\n\\nWhen your Trino coordinator has an authenticator enabled along with HTTPS\\nenabled, HTTP access is automatically disabled for all clients, including the\\n{doc}`Web UI </admin/web-interface>`. Although not recommended, you can\\nre-enable it by setting:\\n\\n```\\nhttp-server.authentication.allow-insecure-over-http=true\\n```\\n\\n(verify-tls)=\", \"Verify configuration\": \"To verify TLS/HTTPS configuration, log in to the {doc}`Web UI\\n</admin/web-interface>`, and send a query with the Trino {doc}`CLI\\n</client/cli>`.\\n\\n['Connect to the Web UI from your browser using a URL that uses HTTPS, such as\\\\n`https://trino.example.com:8443`. Enter any username into the `Username`\\\\ntext box, and log in to the UI. The `Password` box is disabled while\\\\n{doc}`authentication <authentication-types>` is not configured.', 'Connect with the Trino CLI using a URL that uses HTTPS, such as\\\\n`https://trino.example.com:8443`:']\\n\\n```\\n./trino --server https://trino.example.com:8443\\n```\\n\\nSend a query to test the connection:\\n\\n```\\ntrino> SELECT 'rocks' AS trino;\\n\\ntrino\\n-------\\nrocks\\n(1 row)\\n\\nQuery 20220919_113804_00017_54qfi, FINISHED, 1 node\\nSplits: 1 total, 1 done (100.00%)\\n0.12 [0 rows, 0B] [0 rows/s, 0B/s]\\n```\\n\\n(self-signed-limits)=\"}, \"Limitations of self-signed certificates\": \"It is possible to generate a self-signed certificate with the `openssl`,\\n`keytool`, or on Linux, `certtool` commands. Self-signed certificates can be\\nuseful during development of a cluster for internal use only. We recommend never\\nusing a self-signed certificate for a production Trino server.\\n\\nSelf-signed certificates are not trusted by anyone. They are typically created\\nby an administrator for expediency, because they do not require getting trust\\nsignoff from anyone.\\n\\nTo use a self-signed certificate while developing your cluster requires:\\n\\n['distributing to every client a local truststore that validates the certificate', 'configuring every client to use this certificate']\\n\\nHowever, even with this client configuration, modern browsers reject these\\ncertificates, which makes self-signed servers difficult to work with.\\n\\nThere is a difference between self-signed and unsigned certificates. Both types\\nare created with the same tools, but unsigned certificates are meant to be\\nforwarded to a CA with a Certificate Signing Request (CSR). The CA returns the\\ncertificate signed by the CA and now globally trusted.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 18]\"}, {\"title\": \"User mapping\", \"description\": null, \"content\": {\"Pattern mapping rule\": \"If you can map all of your authentication method\\u2019s usernames with a single\\nregular expression, consider using a **Pattern mapping rule**.\\n\\nFor example, your authentication method uses all usernames in the form\\n`alice@example.com`, with no exceptions. In this case, choose a regex that\\nbreaks incoming usernames into at least two regex capture groups, such that the\\nfirst capture group includes only the name before the `@` sign. You can use\\nthe simple regex `(.*)(@.*)` for this case.\\n\\nTrino automatically uses the first capture group \\u2013 the \\\\$1 group \\u2013 as the\\nusername to emit after the regex substitution. If the regular expression does\\nnot match the incoming username, authentication is denied.\\n\\nSpecify your regex pattern in the appropriate property in your coordinator\\u2019s\\n`config.properties` file, using one of the `*user-mapping.pattern`\\nproperties from the table below that matches the authentication type of your\\nconfigured authentication provider. For example, for an {doc}`LDAP\\n</security/ldap>` authentication provider:\\n\\n```\\nhttp-server.authentication.password.user-mapping.pattern=(.*)(@.*)\\n```\\n\\nRemember that an {doc}`authentication type </security/authentication-types>`\\nrepresents a category, such as `PASSWORD`, `OAUTH2`, `KERBEROS`. More than\\none authentication method can have the same authentication type. For example,\\nthe Password file, LDAP, and Salesforce authentication methods all share the\\n`PASSWORD` authentication type.\\n\\nYou can specify different user mapping patterns for different authentication\\ntypes when multiple authentication methods are enabled:\\n\\n| Authentication type | Property |\\n| --------------------------------- | ------------------------------------------------------------- |\\n| Password (file, LDAP, Salesforce) | `http-server.authentication.password.user-mapping.pattern` |\\n| OAuth2 | `http-server.authentication.oauth2.user-mapping.pattern` |\\n| Certificate | `http-server.authentication.certificate.user-mapping.pattern` |\\n| Header | `http-server.authentication.header.user-mapping.pattern` |\\n| JSON Web Token | `http-server.authentication.jwt.user-mapping.pattern` |\\n| Kerberos | `http-server.authentication.krb5.user-mapping.pattern` |\\n| Insecure | `http-server.authentication.insecure.user-mapping.pattern` |\\n\\n(pattern-file)=\", \"File mapping rules\": \"Use the **File mapping rules** method if your authentication provider expresses\\nusernames in a way that cannot be reduced to a single rule, or if you want to\\nexclude a set of users from accessing the cluster.\\n\\nThe rules are loaded from a JSON file identified in a configuration property.\\nThe mapping is based on the first matching rule, processed from top to bottom.\\nIf no rules match, authentication is denied. Each rule is composed of the\\nfollowing fields:\\n\\n[\\\"`pattern` (required): regex to match against the authentication method's\\\\nusername.\\\", '`user` (optional): replacement string to substitute against *pattern*.\\\\nThe default value is `$1`.', '`allow` (optional): boolean indicating whether authentication is to be\\\\nallowed for the current match.', '`case` (optional): one of:', ['`keep` - keep the matched username as is (default behavior)', '`lower` - lowercase the matched username; thus both `Admin` and `ADMIN` become `admin`', '`upper` - uppercase the matched username; thus both `admin` and `Admin` become `ADMIN`']]\\n\\nThe following example maps all usernames in the form `alice@example.com` to\\njust `alice`, except for the `test` user, which is denied authentication. It\\nalso maps users in the form `bob@uk.example.com` to `bob_uk`:\\n\\n```\\n:language: json\\n```\\n\\nSet up the preceding example to use the {doc}`LDAP </security/ldap>`\\nauthentication method with the {doc}`PASSWORD </security/authentication-types>`\\nauthentication type by adding the following line to your coordinator's\\n`config.properties` file:\\n\\n```\\nhttp-server.authentication.password.user-mapping.file=etc/user-mapping.json\\n```\\n\\nYou can place your user mapping JSON file in any local file system location on\\nthe coordinator, but placement in the `etc` directory is typical. There is no\\nnaming standard for the file or its extension, although using `.json` as the\\nextension is traditional. Specify an absolute path or a path relative to the\\nTrino installation root.\\n\\nYou can specify different user mapping files for different authentication\\ntypes when multiple authentication methods are enabled:\\n\\n| Authentication type | Property |\\n| --------------------------------- | ---------------------------------------------------------- |\\n| Password (file, LDAP, Salesforce) | `http-server.authentication.password.user-mapping.file` |\\n| OAuth2 | `http-server.authentication.oauth2.user-mapping.file` |\\n| Certificate | `http-server.authentication.certificate.user-mapping.file` |\\n| Header | `http-server.authentication.header.user-mapping.pattern` |\\n| JSON Web Token | `http-server.authentication.jwt.user-mapping.file` |\\n| Kerberos | `http-server.authentication.krb5.user-mapping.file` |\\n| Insecure | `http-server.authentication.insecure.user-mapping.file` |\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29, \\\"subpages\\\", 19]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 29]\"}, {\"title\": \"Sql\", \"description\": \"Documentation section: sql\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/sql\"}, \"subpages\": [{\"title\": \"ALTER MATERIALIZED VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nALTER MATERIALIZED VIEW [ IF EXISTS ] name RENAME TO new_name\\nALTER MATERIALIZED VIEW name SET PROPERTIES property_name = expression [, ...]\\nALTER MATERIALIZED VIEW name SET AUTHORIZATION ( user | USER user | ROLE role )\\n```\", \"Description\": {\"SET PROPERTIES\": \"The `ALTER MATERIALIZED VIEW SET PROPERTIES` statement followed by some number\\nof `property_name` and `expression` pairs applies the specified properties\\nand values to a materialized view. Omitting an already-set property from this\\nstatement leaves that property unchanged in the materialized view.\\n\\nA property in a `SET PROPERTIES` statement can be set to `DEFAULT`, which\\nreverts its value back to the default in that materialized view.\\n\\nSupport for `ALTER MATERIALIZED VIEW SET PROPERTIES` varies between\\nconnectors. Refer to the connector documentation for more details.\"}, \"Examples\": \"Rename materialized view `people` to `users` in the current schema:\\n\\n```\\nALTER MATERIALIZED VIEW people RENAME TO users;\\n```\\n\\nRename materialized view `people` to `users`, if materialized view\\n`people` exists in the current catalog and schema:\\n\\n```\\nALTER MATERIALIZED VIEW IF EXISTS people RENAME TO users;\\n```\\n\\nSet view properties (`x = y`) in materialized view `people`:\\n\\n```\\nALTER MATERIALIZED VIEW people SET PROPERTIES x = 'y';\\n```\\n\\nSet multiple view properties (`foo = 123` and `foo bar = 456`) in\\nmaterialized view `people`:\\n\\n```\\nALTER MATERIALIZED VIEW people SET PROPERTIES foo = 123, \\\"foo bar\\\" = 456;\\n```\\n\\nSet view property `x` to its default value in materialized view `people`:\\n\\n```\\nALTER MATERIALIZED VIEW people SET PROPERTIES x = DEFAULT;\\n```\\n\\nChange owner of materialized view `people` to user `alice`:\\n\\n```\\nALTER MATERIALIZED VIEW people SET AUTHORIZATION alice\\n```\", \"See also\": [\"{doc}`create-materialized-view`\", \"{doc}`refresh-materialized-view`\", \"{doc}`drop-materialized-view`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 0]\"}, {\"title\": \"ALTER SCHEMA\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nALTER SCHEMA name RENAME TO new_name\\nALTER SCHEMA name SET AUTHORIZATION ( user | USER user | ROLE role )\\n```\", \"Description\": \"Change the definition of an existing schema.\", \"Examples\": \"Rename schema `web` to `traffic`:\\n\\n```\\nALTER SCHEMA web RENAME TO traffic\\n```\\n\\nChange owner of schema `web` to user `alice`:\\n\\n```\\nALTER SCHEMA web SET AUTHORIZATION alice\\n```\\n\\nAllow everyone to drop schema and create tables in schema `web`:\\n\\n```\\nALTER SCHEMA web SET AUTHORIZATION ROLE PUBLIC\\n```\", \"See Also\": \"{doc}`create-schema`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 1]\"}, {\"title\": \"ALTER TABLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nALTER TABLE [ IF EXISTS ] name RENAME TO new_name\\nALTER TABLE [ IF EXISTS ] name ADD COLUMN [ IF NOT EXISTS ] column_name data_type\\n [ DEFAULT default ] [ NOT NULL ] [ COMMENT comment ]\\n [ WITH ( property_name = expression [, ...] ) ]\\n [ FIRST | LAST | AFTER after_column_name ]\\nALTER TABLE [ IF EXISTS ] name DROP COLUMN [ IF EXISTS ] column_name\\nALTER TABLE [ IF EXISTS ] name RENAME COLUMN [ IF EXISTS ] old_name TO new_name\\nALTER TABLE [ IF EXISTS ] name ALTER COLUMN column_name SET DATA TYPE new_type\\nALTER TABLE [ IF EXISTS ] name ALTER COLUMN column_name DROP NOT NULL\\nALTER TABLE name SET AUTHORIZATION ( user | USER user | ROLE role )\\nALTER TABLE name SET PROPERTIES property_name = expression [, ...]\\nALTER TABLE name EXECUTE command [ ( parameter => expression [, ... ] ) ]\\n [ WHERE expression ]\\n```\", \"Description\": {\"SET PROPERTIES\": \"The `ALTER TABLE SET PROPERTIES` statement followed by a number of\\n`property_name` and `expression` pairs applies the specified properties and\\nvalues to a table. Omitting an already-set property from this statement leaves\\nthat property unchanged in the table.\\n\\nA property in a `SET PROPERTIES` statement can be set to `DEFAULT`, which\\nreverts its value back to the default in that table.\\n\\nSupport for `ALTER TABLE SET PROPERTIES` varies between\\nconnectors, as not all connectors support modifying table properties.\\n\\n(alter-table-execute)=\", \"EXECUTE\": \"The `ALTER TABLE EXECUTE` statement followed by a `command` and\\n`parameters` modifies the table according to the specified command and\\nparameters. `ALTER TABLE EXECUTE` supports different commands on a\\nper-connector basis.\\n\\nYou can use the `=>` operator for passing named parameter values. The left side\\nis the name of the parameter, the right side is the value being passed.\\n\\nExecutable commands are contributed by connectors, such as the `optimize`\\ncommand provided by the [Hive](hive-alter-table-execute), [Delta\\nLake](delta-lake-alter-table-execute), and\\n[Iceberg](iceberg-alter-table-execute) connectors. For example, a user observing\\nmany small files in the storage of a table called `test_table` in the `test`\\nschema of the `example` catalog, can use the `optimize` command to merge all\\nfiles below the `file_size_threshold` value. The result is fewer, but larger\\nfiles, which typically results in higher query performance on the data in the\\nfiles:\\n\\n```\\nALTER TABLE example.test.test_table EXECUTE optimize(file_size_threshold => '16MB')\\n```\"}, \"Examples\": \"Rename table `users` to `people`:\\n\\n```\\nALTER TABLE users RENAME TO people;\\n```\\n\\nRename table `users` to `people` if table `users` exists:\\n\\n```\\nALTER TABLE IF EXISTS users RENAME TO people;\\n```\\n\\nAdd column `zip` to the `users` table:\\n\\n```\\nALTER TABLE users ADD COLUMN zip varchar;\\n```\\n\\nAdd column `zip` to the `users` table if table `users` exists and column `zip`\\nnot already exists:\\n\\n```\\nALTER TABLE IF EXISTS users ADD COLUMN IF NOT EXISTS zip varchar;\\n```\\n\\nAdd column `id` as the first column to the `users` table:\\n\\n```\\nALTER TABLE users ADD COLUMN id varchar FIRST;\\n```\\n\\nAdd column `zip` after column `country` to the `users` table:\\n\\n```\\nALTER TABLE users ADD COLUMN zip varchar AFTER country;\\n```\\n\\nDrop column `zip` from the `users` table:\\n\\n```\\nALTER TABLE users DROP COLUMN zip;\\n```\\n\\nDrop column `zip` from the `users` table if table `users` and column `zip`\\nexists:\\n\\n```\\nALTER TABLE IF EXISTS users DROP COLUMN IF EXISTS zip;\\n```\\n\\nRename column `id` to `user_id` in the `users` table:\\n\\n```\\nALTER TABLE users RENAME COLUMN id TO user_id;\\n```\\n\\nRename column `id` to `user_id` in the `users` table if table `users` and column\\n`id` exists:\\n\\n```\\nALTER TABLE IF EXISTS users RENAME column IF EXISTS id to user_id;\\n```\\n\\nChange type of column `id` to `bigint` in the `users` table:\\n\\n```\\nALTER TABLE users ALTER COLUMN id SET DATA TYPE bigint;\\n```\\n\\nDrop a not null constraint on `id` column in the `users` table:\\n\\n```\\nALTER TABLE users ALTER COLUMN id DROP NOT NULL;\\n```\\n\\nChange owner of table `people` to user `alice`:\\n\\n```\\nALTER TABLE people SET AUTHORIZATION alice\\n```\\n\\nAllow everyone with role public to drop and alter table `people`:\\n\\n```\\nALTER TABLE people SET AUTHORIZATION ROLE PUBLIC\\n```\\n\\nSet table properties (`x = y`) in table `people`:\\n\\n```\\nALTER TABLE people SET PROPERTIES x = 'y';\\n```\\n\\nSet multiple table properties (`foo = 123` and `foo bar = 456`) in\\ntable `people`:\\n\\n```\\nALTER TABLE people SET PROPERTIES foo = 123, \\\"foo bar\\\" = 456;\\n```\\n\\nSet table property `x` to its default value in table\\\\`\\\\`people\\\\`\\\\`:\\n\\n```\\nALTER TABLE people SET PROPERTIES x = DEFAULT;\\n```\", \"See also\": \"{doc}`create-table`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 2]\"}, {\"title\": \"ALTER VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nALTER VIEW name RENAME TO new_name\\nALTER VIEW name REFRESH\\nALTER VIEW name SET AUTHORIZATION ( user | USER user | ROLE role )\\n```\", \"Description\": \"Change the definition of an existing view.\", \"Examples\": \"Rename view `people` to `users`:\\n\\n```\\nALTER VIEW people RENAME TO users\\n```\\n\\nRefresh view `people`:\\n\\n```\\nALTER VIEW people REFRESH\\n```\\n\\nChange owner of VIEW `people` to user `alice`:\\n\\n```\\nALTER VIEW people SET AUTHORIZATION alice\\n```\", \"See also\": \"{doc}`create-view`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 3]\"}, {\"title\": \"ANALYZE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nANALYZE table_name [ WITH ( property_name = expression [, ...] ) ]\\n```\", \"Description\": \"Collects table and column statistics for a given table.\\n\\nThe optional `WITH` clause can be used to provide connector-specific properties.\\nTo list all available properties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.analyze_properties\\n```\", \"Examples\": \"Analyze table `web` to collect table and column statistics:\\n\\n```\\nANALYZE web;\\n```\\n\\nAnalyze table `stores` in catalog `hive` and schema `default`:\\n\\n```\\nANALYZE hive.default.stores;\\n```\\n\\nAnalyze partitions `'1992-01-01', '1992-01-02'` from a Hive partitioned table `sales`:\\n\\n```\\nANALYZE hive.default.sales WITH (partitions = ARRAY[ARRAY['1992-01-01'], ARRAY['1992-01-02']]);\\n```\\n\\nAnalyze partitions with complex partition key (`state` and `city` columns) from a Hive partitioned table `customers`:\\n\\n```\\nANALYZE hive.default.customers WITH (partitions = ARRAY[ARRAY['CA', 'San Francisco'], ARRAY['NY', 'NY']]);\\n```\\n\\nAnalyze only columns `department` and `product_id` for partitions `'1992-01-01', '1992-01-02'` from a Hive partitioned\\ntable `sales`:\\n\\n```\\nANALYZE hive.default.sales WITH (\\n partitions = ARRAY[ARRAY['1992-01-01'], ARRAY['1992-01-02']],\\n columns = ARRAY['department', 'product_id']);\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 4]\"}, {\"title\": \"CALL\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCALL procedure_name ( [ name => ] expression [, ...] )\\n```\", \"Description\": \"Call a procedure.\\n\\nProcedures can be provided by connectors to perform data manipulation or\\nadministrative tasks. For example, the {doc}`/connector/system` defines a\\nprocedure for killing a running query.\\n\\nSome connectors, such as the {doc}`/connector/postgresql`, are for systems\\nthat have their own stored procedures. These stored procedures are separate\\nfrom the connector-defined procedures discussed here and thus are not\\ndirectly callable via `CALL`.\\n\\nSee connector documentation for details on available procedures.\", \"Examples\": \"Call a procedure using positional arguments:\\n\\n```\\nCALL test(123, 'apple');\\n```\\n\\nCall a procedure using named arguments:\\n\\n```\\nCALL test(name => 'apple', id => 123);\\n```\\n\\nCall a procedure using a fully qualified name:\\n\\n```\\nCALL catalog.schema.test();\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 5]\"}, {\"title\": \"COMMENT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCOMMENT ON ( TABLE | VIEW | COLUMN ) name IS 'comments'\\n```\", \"Description\": \"Set the comment for an object. The comment can be removed by setting the comment to `NULL`.\", \"Examples\": \"Change the comment for the `users` table to be `master table`:\\n\\n```\\nCOMMENT ON TABLE users IS 'master table';\\n```\\n\\nChange the comment for the `users` view to be `master view`:\\n\\n```\\nCOMMENT ON VIEW users IS 'master view';\\n```\\n\\nChange the comment for the `users.name` column to be `full name`:\\n\\n```\\nCOMMENT ON COLUMN users.name IS 'full name';\\n```\", \"See also\": \"[](/language/comments)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 6]\"}, {\"title\": \"COMMIT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCOMMIT [ WORK ]\\n```\", \"Description\": \"Commit the current transaction.\", \"Examples\": \"```\\nCOMMIT;\\nCOMMIT WORK;\\n```\", \"See also\": \"{doc}`rollback`, {doc}`start-transaction`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 7]\"}, {\"title\": \"CREATE CATALOG\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE CATALOG\\ncatalog_name\\nUSING connector_name\\n[ WITH ( property_name = expression [, ...] ) ]\\n```\", \"Description\": \"Create a new catalog using the specified connector.\\n\\nThe optional `WITH` clause is used to set properties on the newly created\\ncatalog. Property names can be double-quoted, which is required if they contain\\nspecial characters, like `-`. Refer to the [connectors\\ndocumentation](/connector) to learn about all available properties. All\\nproperty values must be varchars (single quoted), including numbers and boolean\\nvalues.\\n\\nThe query fails in the following circumstances:\\n\\n['A required property is missing.', 'An invalid property is set, for example there is a typo in the property name,\\\\nor a property name from a different connector was used.', \\\"The value of the property is invalid, for example a numeric value is out of\\\\nrange, or a string value doesn't match the required pattern.\\\", 'The value references an environmental variable that is not set on the\\\\ncoordinator node.']\\n\\n:::{warning}\\nThe complete `CREATE CATALOG` query is logged, and visible in the [Web\\nUI](/admin/web-interface). This includes any sensitive properties, like\\npasswords and other credentials. See [](/security/secrets).\\n:::\\n\\n:::{note}\\nThis command requires the [catalog management type](/admin/properties-catalog)\\nto be set to `dynamic`.\\n:::\", \"Examples\": \"Create a new catalog called `tpch` using the [](/connector/tpch):\\n\\n```\\nCREATE CATALOG tpch USING tpch;\\n```\\n\\nCreate a new catalog called `brain` using the [](/connector/memory):\\n\\n```\\nCREATE CATALOG brain USING memory\\nWITH (\\\"memory.max-data-per-node\\\" = '128MB');\\n```\\n\\nNotice that the connector property contains dashes (`-`) and needs to quoted\\nusing a double quote (`\\\"`). The value `128MB` is quoted using single quotes,\\nbecause it is a string literal.\\n\\nCreate a new catalog called `example` using the [](/connector/postgresql):\\n\\n```\\nCREATE CATALOG example USING postgresql\\nWITH (\\n \\\"connection-url\\\" = 'jdbc:pg:localhost:5432',\\n \\\"connection-user\\\" = '${ENV:POSTGRES_USER}',\\n \\\"connection-password\\\" = '${ENV:POSTGRES_PASSWORD}',\\n \\\"case-insensitive-name-matching\\\" = 'true'\\n);\\n```\\n\\nThis example assumes that the `POSTGRES_USER` and `POSTGRES_PASSWORD`\\nenvironmental variables are set as [secrets](/security/secrets) on all nodes of\\nthe cluster.\", \"See also\": [\"[](/sql/drop-catalog)\", \"[](/admin/properties-catalog)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 8]\"}, {\"title\": \"CREATE FUNCTION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE [OR REPLACE] FUNCTION\\n udf_definition\\n```\", \"Description\": \"Create or replace a [](udf-catalog). The `udf_definition` is composed of the\\nusage of [](/udf/function) and nested statements. The name of the UDF must be\\nfully qualified with catalog and schema location, unless the [default UDF\\nstorage catalog and schema](/admin/properties-sql-environment) are configured.\\nThe connector used in the catalog must support UDF storage.\\n\\nThe optional `OR REPLACE` clause causes the UDF to be replaced if it already\\nexists rather than raising an error.\", \"Examples\": \"The following example creates the `meaning_of_life` UDF in the `default`\\nschema of the `example` catalog:\\n\\n```\\nCREATE FUNCTION example.default.meaning_of_life()\\n RETURNS bigint\\n BEGIN\\n RETURN 42;\\n END;\\n```\\n\\nIf the [default catalog and schema for UDF\\nstorage](/admin/properties-sql-environment) is configured, you can use the\\nfollowing more compact syntax:\\n\\n```\\nCREATE FUNCTION meaning_of_life() RETURNS bigint RETURN 42;\\n```\\n\\nFurther examples of varying complexity that cover usage of the `FUNCTION`\\nstatement in combination with other statements are available in the [SQL\\nUDF examples documentation](/udf/sql/examples).\", \"See also\": [\"[](/sql/drop-function)\", \"[](/sql/show-create-function)\", \"[](/sql/show-functions)\", \"[](/udf)\", \"[](/admin/properties-sql-environment)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 9]\"}, {\"title\": \"CREATE MATERIALIZED VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE [ OR REPLACE ] MATERIALIZED VIEW\\n[ IF NOT EXISTS ] view_name\\n[ GRACE PERIOD interval ]\\n[ COMMENT string ]\\n[ WITH properties ]\\nAS query\\n```\", \"Description\": \"Create and validate the definition of a new materialized view `view_name` of a\\n{doc}`select` `query`. You need to run the {doc}`refresh-materialized-view`\\nstatement after the creation to populate the materialized view with data. This\\nmaterialized view is a physical manifestation of the query results at time of\\nrefresh. The data is stored, and can be referenced by future queries.\\n\\nQueries accessing materialized views are typically faster than retrieving data\\nfrom a view created with the same query. Any computation, aggregation, and other\\noperation to create the data is performed once during refresh of the\\nmaterialized views, as compared to each time of accessing the view. Multiple\\nreads of view data over time, or by multiple users, all trigger repeated\\nprocessing. This is avoided for materialized views.\\n\\nThe optional `OR REPLACE` clause causes the materialized view to be replaced\\nif it already exists rather than raising an error.\\n\\nThe optional `IF NOT EXISTS` clause causes the materialized view only to be\\ncreated if it does not exist yet.\\n\\nNote that `OR REPLACE` and `IF NOT EXISTS` are mutually exclusive clauses.\\n\\n(mv-grace-period)=\\nThe optional `GRACE PERIOD` clause specifies how long the query materialization\\nis used for querying:\\n\\n['Within the grace period since last refresh, data retrieval is highly\\\\nperformant because the query materialization is used. However, the data may\\\\nnot be up to date with the base tables.', 'After the grace period has elapsed, the data of the materialized view is\\\\ncomputed on-the-fly using the `query`. Retrieval is therefore slower, but the\\\\ndata is up to date with the base tables.', 'If not specified, the grace period defaults to infinity, and therefore all\\\\nqueries are within the grace period.', 'Every [](refresh-materialized-view) operation resets the start time for the\\\\ngrace period.']\\n\\nThe optional `COMMENT` clause causes a `string` comment to be stored with\\nthe metadata about the materialized view. The comment is displayed with the\\n{doc}`show-create-materialized-view` statement and is available in the table\\n`system.metadata.materialized_view_properties`.\\n\\nThe optional `WITH` clause is used to define properties for the materialized\\nview creation. Separate multiple property/value pairs by commas. The connector\\nuses the properties as input parameters for the materialized view refresh\\noperation. The supported properties are different for each connector and\\ndetailed in the SQL support section of the specific connector's documentation.\\n\\nAfter successful creation, all metadata about the materialized view is available\\nin a {ref}`system table <system-metadata-materialized-views>`.\", \"Examples\": \"Create a simple materialized view `cancelled_orders` over the `orders` table\\nthat only includes cancelled orders. Note that `orderstatus` is a numeric\\nvalue that is potentially meaningless to a consumer, yet the name of the view\\nclarifies the content:\\n\\n```\\nCREATE MATERIALIZED VIEW cancelled_orders\\nAS\\n SELECT orderkey, totalprice\\n FROM orders\\n WHERE orderstatus = 3;\\n```\\n\\nCreate or replace a materialized view `order_totals_by_date` that summarizes\\n`orders` across all orders from all customers:\\n\\n```\\nCREATE OR REPLACE MATERIALIZED VIEW order_totals_by_date\\nAS\\n SELECT orderdate, sum(totalprice) AS price\\n FROM orders\\n GROUP BY orderdate;\\n```\\n\\nCreate a materialized view for a catalog using the Iceberg connector, with a\\ncomment and partitioning on two fields in the storage:\\n\\n```\\nCREATE MATERIALIZED VIEW orders_nation_mkgsegment\\nCOMMENT 'Orders with nation and market segment data'\\nWITH ( partitioning = ARRAY['mktsegment', 'nationkey'] )\\nAS\\n SELECT o.*, c.nationkey, c.mktsegment\\n FROM orders AS o\\n JOIN customer AS c\\n ON o.custkey = c.custkey;\\n```\\n\\nSet multiple properties:\\n\\n```\\nWITH ( format = 'ORC', partitioning = ARRAY['_date'] )\\n```\\n\\nShow defined materialized view properties for all catalogs:\\n\\n```\\nSELECT * FROM system.metadata.materialized_view_properties;\\n```\\n\\nShow metadata about the materialized views in all catalogs:\\n\\n```\\nSELECT * FROM system.metadata.materialized_views;\\n```\", \"See also\": [\"{doc}`drop-materialized-view`\", \"{doc}`show-create-materialized-view`\", \"{doc}`refresh-materialized-view`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 10]\"}, {\"title\": \"CREATE ROLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE ROLE role_name\\n[ WITH ADMIN ( user | USER user | ROLE role | CURRENT_USER | CURRENT_ROLE ) ]\\n[ IN catalog ]\\n```\", \"Description\": \"`CREATE ROLE` creates the specified role.\\n\\nThe optional `WITH ADMIN` clause causes the role to be created with\\nthe specified user as a role admin. A role admin has permission to drop\\nor grant a role. If the optional `WITH ADMIN` clause is not\\nspecified, the role is created with current user as admin.\\n\\nThe optional `IN catalog` clause creates the role in a catalog as opposed\\nto a system role.\", \"Examples\": \"Create role `admin`\\n\\n```\\nCREATE ROLE admin;\\n```\\n\\nCreate role `moderator` with admin `bob`:\\n\\n```\\nCREATE ROLE moderator WITH ADMIN USER bob;\\n```\", \"Limitations\": \"Some connectors do not support role management.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`drop-role`, {doc}`set-role`, {doc}`grant-roles`, {doc}`revoke-roles`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 11]\"}, {\"title\": \"CREATE SCHEMA\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE SCHEMA [ IF NOT EXISTS ] schema_name\\n[ AUTHORIZATION ( user | USER user | ROLE role ) ]\\n[ WITH ( property_name = expression [, ...] ) ]\\n```\", \"Description\": \"Create a new, empty schema. A schema is a container that\\nholds tables, views and other database objects.\\n\\nThe optional `IF NOT EXISTS` clause causes the error to be\\nsuppressed if the schema already exists.\\n\\nThe optional `AUTHORIZATION` clause can be used to set the\\nowner of the newly created schema to a user or role.\\n\\nThe optional `WITH` clause can be used to set properties\\non the newly created schema. To list all available schema\\nproperties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.schema_properties\\n```\", \"Examples\": \"Create a new schema `web` in the current catalog:\\n\\n```\\nCREATE SCHEMA web\\n```\\n\\nCreate a new schema `sales` in the `hive` catalog:\\n\\n```\\nCREATE SCHEMA hive.sales\\n```\\n\\nCreate the schema `traffic` if it does not already exist:\\n\\n```\\nCREATE SCHEMA IF NOT EXISTS traffic\\n```\\n\\nCreate a new schema `web` and set the owner to user `alice`:\\n\\n```\\nCREATE SCHEMA web AUTHORIZATION alice\\n```\\n\\nCreate a new schema `web`, set the `LOCATION` property to `/hive/data/web`\\nand set the owner to user `alice`:\\n\\n```\\nCREATE SCHEMA web AUTHORIZATION alice WITH ( LOCATION = '/hive/data/web' )\\n```\\n\\nCreate a new schema `web` and allow everyone to drop schema and create tables\\nin schema `web`:\\n\\n```\\nCREATE SCHEMA web AUTHORIZATION ROLE PUBLIC\\n```\\n\\nCreate a new schema `web`, set the `LOCATION` property to `/hive/data/web`\\nand allow everyone to drop schema and create tables in schema `web`:\\n\\n```\\nCREATE SCHEMA web AUTHORIZATION ROLE PUBLIC WITH ( LOCATION = '/hive/data/web' )\\n```\", \"See also\": \"{doc}`alter-schema`, {doc}`drop-schema`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 12]\"}, {\"title\": \"CREATE TABLE AS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE [ OR REPLACE ] TABLE [ IF NOT EXISTS ] table_name [ ( column_alias, ... ) ]\\n[ COMMENT table_comment ]\\n[ WITH ( property_name = expression [, ...] ) ]\\nAS query\\n[ WITH [ NO ] DATA ]\\n```\", \"Description\": \"Create a new table containing the result of a {doc}`select` query.\\nUse {doc}`create-table` to create an empty table.\\n\\nThe optional `OR REPLACE` clause causes an existing table with the\\nspecified name to be replaced with the new table definition. Support\\nfor table replacement varies across connectors. Refer to the\\nconnector documentation for details.\\n\\nThe optional `IF NOT EXISTS` clause causes the error to be\\nsuppressed if the table already exists.\\n\\n`OR REPLACE` and `IF NOT EXISTS` cannot be used together.\\n\\nThe optional `WITH` clause can be used to set properties\\non the newly created table. To list all available table\\nproperties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.table_properties\\n```\", \"Examples\": \"Create a new table `orders_column_aliased` with the results of a query and the given column names:\\n\\n```\\nCREATE TABLE orders_column_aliased (order_date, total_price)\\nAS\\nSELECT orderdate, totalprice\\nFROM orders\\n```\\n\\nCreate a new table `orders_by_date` that summarizes `orders`:\\n\\n```\\nCREATE TABLE orders_by_date\\nCOMMENT 'Summary of orders by date'\\nWITH (format = 'ORC')\\nAS\\nSELECT orderdate, sum(totalprice) AS price\\nFROM orders\\nGROUP BY orderdate\\n```\\n\\nCreate the table `orders_by_date` if it does not already exist:\\n\\n```\\nCREATE TABLE IF NOT EXISTS orders_by_date AS\\nSELECT orderdate, sum(totalprice) AS price\\nFROM orders\\nGROUP BY orderdate\\n```\\n\\nCreate a new `empty_nation` table with the same schema as `nation` and no data:\\n\\n```\\nCREATE TABLE empty_nation AS\\nSELECT *\\nFROM nation\\nWITH NO DATA\\n```\", \"See also\": \"{doc}`create-table`, {doc}`select`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 13]\"}, {\"title\": \"CREATE TABLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE [ OR REPLACE ] TABLE [ IF NOT EXISTS ]\\ntable_name (\\n { column_name data_type [ DEFAULT default ] [ NOT NULL ]\\n [ COMMENT comment ]\\n [ WITH ( property_name = expression [, ...] ) ]\\n | LIKE existing_table_name\\n [ { INCLUDING | EXCLUDING } PROPERTIES ]\\n }\\n [, ...]\\n)\\n[ COMMENT table_comment ]\\n[ WITH ( property_name = expression [, ...] ) ]\\n```\", \"Description\": \"Create a new, empty table with the specified columns.\\nUse {doc}`create-table-as` to create a table with data.\\n\\nThe optional `OR REPLACE` clause causes an existing table with the\\nspecified name to be replaced with the new table definition. Support\\nfor table replacement varies across connectors. Refer to the\\nconnector documentation for details.\\n\\nThe optional `IF NOT EXISTS` clause causes the error to be\\nsuppressed if the table already exists.\\n\\n`OR REPLACE` and `IF NOT EXISTS` cannot be used together.\\n\\nThe optional `WITH` clause can be used to set properties\\non the newly created table or on single columns. To list all available table\\nproperties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.table_properties\\n```\\n\\nTo list all available column properties, run the following query:\\n\\n```\\nSELECT * FROM system.metadata.column_properties\\n```\\n\\nThe `LIKE` clause can be used to include all the column definitions from\\nan existing table in the new table. Multiple `LIKE` clauses may be\\nspecified, which allows copying the columns from multiple tables.\\n\\nIf `INCLUDING PROPERTIES` is specified, all the table properties are\\ncopied to the new table. If the `WITH` clause specifies the same property\\nname as one of the copied properties, the value from the `WITH` clause\\nwill be used. The default behavior is `EXCLUDING PROPERTIES`. The\\n`INCLUDING PROPERTIES` option maybe specified for at most one table.\", \"Examples\": \"Create a new table `orders`:\\n\\n```\\nCREATE TABLE orders (\\n orderkey bigint,\\n orderstatus varchar,\\n totalprice double,\\n orderdate date\\n)\\nWITH (format = 'ORC')\\n```\\n\\nCreate the table `orders` if it does not already exist, adding a table comment\\nand a column comment:\\n\\n```\\nCREATE TABLE IF NOT EXISTS orders (\\n orderkey bigint,\\n orderstatus varchar,\\n totalprice double COMMENT 'Price in cents.',\\n orderdate date\\n)\\nCOMMENT 'A table to keep track of orders.'\\n```\\n\\nCreate the table `bigger_orders` using the columns from `orders`\\nplus additional columns at the start and end:\\n\\n```\\nCREATE TABLE bigger_orders (\\n another_orderkey bigint,\\n LIKE orders,\\n another_orderdate date\\n)\\n```\", \"See also\": \"{doc}`alter-table`, {doc}`drop-table`, {doc}`create-table-as`, {doc}`show-create-table`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 14]\"}, {\"title\": \"CREATE VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nCREATE [ OR REPLACE ] VIEW view_name\\n[ COMMENT view_comment ]\\n[ SECURITY { DEFINER | INVOKER } ]\\nAS query\\n```\", \"Description\": \"Create a new view of a {doc}`select` query. The view is a logical table\\nthat can be referenced by future queries. Views do not contain any data.\\nInstead, the query stored by the view is executed every time the view is\\nreferenced by another query.\\n\\nThe optional `OR REPLACE` clause causes the view to be replaced if it\\nalready exists rather than raising an error.\", \"Security\": \"In the default `DEFINER` security mode, tables referenced in the view\\nare accessed using the permissions of the view owner (the *creator* or\\n*definer* of the view) rather than the user executing the query. This\\nallows providing restricted access to the underlying tables, for which\\nthe user may not be allowed to access directly.\\n\\nIn the `INVOKER` security mode, tables referenced in the view are accessed\\nusing the permissions of the user executing the query (the *invoker* of the view).\\nA view created in this mode is simply a stored query.\\n\\nRegardless of the security mode, the `current_user` function will\\nalways return the user executing the query and thus may be used\\nwithin views to filter out rows or otherwise restrict access.\", \"Examples\": \"Create a simple view `test` over the `orders` table:\\n\\n```\\nCREATE VIEW test AS\\nSELECT orderkey, orderstatus, totalprice / 2 AS half\\nFROM orders\\n```\\n\\nCreate a view `test_with_comment` with a view comment:\\n\\n```\\nCREATE VIEW test_with_comment\\nCOMMENT 'A view to keep track of orders.'\\nAS\\nSELECT orderkey, orderstatus, totalprice\\nFROM orders\\n```\\n\\nCreate a view `orders_by_date` that summarizes `orders`:\\n\\n```\\nCREATE VIEW orders_by_date AS\\nSELECT orderdate, sum(totalprice) AS price\\nFROM orders\\nGROUP BY orderdate\\n```\\n\\nCreate a view that replaces an existing view:\\n\\n```\\nCREATE OR REPLACE VIEW test AS\\nSELECT orderkey, orderstatus, totalprice / 4 AS quarter\\nFROM orders\\n```\", \"See also\": [\"[](/sql/alter-view)\", \"[](/sql/drop-view)\", \"[](/sql/show-create-view)\", \"[](/sql/show-tables)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 15]\"}, {\"title\": \"DEALLOCATE PREPARE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDEALLOCATE PREPARE statement_name\\n```\", \"Description\": \"Removes a statement with the name `statement_name` from the list of prepared\\nstatements in a session.\", \"Examples\": \"Deallocate a statement with the name `my_query`:\\n\\n```\\nDEALLOCATE PREPARE my_query;\\n```\", \"See also\": \"{doc}`prepare`, {doc}`execute`, {doc}`execute-immediate`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 16]\"}, {\"title\": \"DELETE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDELETE FROM table_name [ WHERE condition ]\\n```\", \"Description\": \"Delete rows from a table. If the `WHERE` clause is specified, only the\\nmatching rows are deleted. Otherwise, all rows from the table are deleted.\", \"Examples\": \"Delete all line items shipped by air:\\n\\n```\\nDELETE FROM lineitem WHERE shipmode = 'AIR';\\n```\\n\\nDelete all line items for low priority orders:\\n\\n```\\nDELETE FROM lineitem\\nWHERE orderkey IN (SELECT orderkey FROM orders WHERE priority = 'LOW');\\n```\\n\\nDelete all orders:\\n\\n```\\nDELETE FROM orders;\\n```\", \"Limitations\": \"Some connectors have limited or no support for `DELETE`.\\nSee connector documentation for more details.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 17]\"}, {\"title\": \"DENY\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDENY ( privilege [, ...] | ( ALL PRIVILEGES ) )\\nON ( table_name | TABLE table_name | SCHEMA schema_name)\\nTO ( user | USER user | ROLE role )\\n```\", \"Description\": \"Denies the specified privileges to the specified grantee.\\n\\nDeny on a table rejects the specified privilege on all current and future\\ncolumns of the table.\\n\\nDeny on a schema rejects the specified privilege on all current and future\\ncolumns of all current and future tables of the schema.\", \"Examples\": \"Deny `INSERT` and `SELECT` privileges on the table `orders`\\nto user `alice`:\\n\\n```\\nDENY INSERT, SELECT ON orders TO alice;\\n```\\n\\nDeny `DELETE` privilege on the schema `finance` to user `bob`:\\n\\n```\\nDENY DELETE ON SCHEMA finance TO bob;\\n```\\n\\nDeny `SELECT` privilege on the table `orders` to everyone:\\n\\n```\\nDENY SELECT ON orders TO ROLE PUBLIC;\\n```\", \"Limitations\": \"The system access controls as well as the connectors provided by default\\nin Trino have no support for `DENY`.\", \"See also\": \"{doc}`grant`, {doc}`revoke`, {doc}`show-grants`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 18]\"}, {\"title\": \"DESCRIBE INPUT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDESCRIBE INPUT statement_name\\n```\", \"Description\": \"Lists the input parameters of a prepared statement along with the\\nposition and type of each parameter. Parameter types that cannot be\\ndetermined will appear as `unknown`.\", \"Examples\": \"Prepare and describe a query with three parameters:\\n\\n```\\nPREPARE my_select1 FROM\\nSELECT ? FROM nation WHERE regionkey = ? AND name < ?;\\n```\\n\\n```\\nDESCRIBE INPUT my_select1;\\n```\\n\\n```\\n Position | Type\\n--------------------\\n 0 | unknown\\n 1 | bigint\\n 2 | varchar\\n(3 rows)\\n```\\n\\nPrepare and describe a query with no parameters:\\n\\n```\\nPREPARE my_select2 FROM\\nSELECT * FROM nation;\\n```\\n\\n```\\nDESCRIBE INPUT my_select2;\\n```\\n\\n```\\n Position | Type\\n-----------------\\n(0 rows)\\n```\", \"See also\": \"{doc}`prepare`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 19]\"}, {\"title\": \"DESCRIBE OUTPUT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDESCRIBE OUTPUT statement_name\\n```\", \"Description\": \"List the output columns of a prepared statement, including the\\ncolumn name (or alias), catalog, schema, table, type, type size in\\nbytes, and a boolean indicating if the column is aliased.\", \"Examples\": \"Prepare and describe a query with four output columns:\\n\\n```\\nPREPARE my_select1 FROM\\nSELECT * FROM nation;\\n```\\n\\n```\\nDESCRIBE OUTPUT my_select1;\\n```\\n\\n```\\n Column Name | Catalog | Schema | Table | Type | Type Size | Aliased\\n-------------+---------+--------+--------+---------+-----------+---------\\n nationkey | tpch | sf1 | nation | bigint | 8 | false\\n name | tpch | sf1 | nation | varchar | 0 | false\\n regionkey | tpch | sf1 | nation | bigint | 8 | false\\n comment | tpch | sf1 | nation | varchar | 0 | false\\n(4 rows)\\n```\\n\\nPrepare and describe a query whose output columns are expressions:\\n\\n```\\nPREPARE my_select2 FROM\\nSELECT count(*) as my_count, 1+2 FROM nation;\\n```\\n\\n```\\nDESCRIBE OUTPUT my_select2;\\n```\\n\\n```\\n Column Name | Catalog | Schema | Table | Type | Type Size | Aliased\\n-------------+---------+--------+-------+--------+-----------+---------\\n my_count | | | | bigint | 8 | true\\n _col1 | | | | bigint | 8 | false\\n(2 rows)\\n```\\n\\nPrepare and describe a row count query:\\n\\n```\\nPREPARE my_create FROM\\nCREATE TABLE foo AS SELECT * FROM nation;\\n```\\n\\n```\\nDESCRIBE OUTPUT my_create;\\n```\\n\\n```\\n Column Name | Catalog | Schema | Table | Type | Type Size | Aliased\\n-------------+---------+--------+-------+--------+-----------+---------\\n rows | | | | bigint | 8 | false\\n(1 row)\\n```\", \"See also\": \"{doc}`prepare`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 20]\"}, {\"title\": \"DESCRIBE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDESCRIBE table_name\\n```\", \"Description\": \"`DESCRIBE` is an alias for {doc}`show-columns`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 21]\"}, {\"title\": \"DROP CATALOG\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP CATALOG catalog_name\\n```\", \"Description\": \"Drops an existing catalog. Dropping a catalog does not interrupt any running\\nqueries that use it, but makes it unavailable to any new queries.\\n\\n:::{warning}\\nSome connectors are known not to release all resources when dropping a catalog\\nthat uses such connector. This includes all connectors that can read data from\\nHDFS, S3, GCS, or Azure, which are [](/connector/hive),\\n[](/connector/iceberg), [](/connector/delta-lake), and\\n[](/connector/hudi).\\n:::\\n\\n:::{note}\\nThis command requires the [catalog management type](/admin/properties-catalog)\\nto be set to `dynamic`.\\n:::\", \"Examples\": \"Drop the catalog `example`:\\n\\n```\\nDROP CATALOG example;\\n```\", \"See also\": [\"[](/sql/create-catalog)\", \"[](/admin/properties-catalog)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 22]\"}, {\"title\": \"DROP FUNCTION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP FUNCTION [ IF EXISTS ] udf_name ( [ [ parameter_name ] data_type [, ...] ] )\\n```\", \"Description\": \"Removes a [catalog UDF](udf-catalog). The value of `udf_name` must be fully\\nqualified with catalog and schema location of the UDF, unless the [default UDF storage catalog and schema](/admin/properties-sql-environment) are\\nconfigured.\\n\\nThe `data_type`s must be included for UDFs that use parameters to ensure the UDF\\nwith the correct name and parameter signature is removed.\\n\\nThe optional `IF EXISTS` clause causes the error to be suppressed if\\nthe function does not exist.\", \"Examples\": \"The following example removes the `meaning_of_life` UDF in the `default` schema\\nof the `example` catalog:\\n\\n```\\nDROP FUNCTION example.default.meaning_of_life();\\n```\\n\\nIf the UDF uses an input parameter, the type must be added:\\n\\n```\\nDROP FUNCTION multiply_by_two(bigint);\\n```\\n\\nIf the [default catalog and schema for UDF\\nstorage](/admin/properties-sql-environment) is configured, you can use the\\nfollowing more compact syntax:\\n\\n```\\nDROP FUNCTION meaning_of_life();\\n```\", \"See also\": [\"[](/sql/create-function)\", \"[](/sql/show-create-function)\", \"[](/sql/show-functions)\", \"[](/udf)\", \"[](/admin/properties-sql-environment)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 23]\"}, {\"title\": \"DROP MATERIALIZED VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP MATERIALIZED VIEW [ IF EXISTS ] view_name\\n```\", \"Description\": \"Drop an existing materialized view `view_name`.\\n\\nThe optional `IF EXISTS` clause causes the error to be suppressed if\\nthe materialized view does not exist.\", \"Examples\": \"Drop the materialized view `orders_by_date`:\\n\\n```\\nDROP MATERIALIZED VIEW orders_by_date;\\n```\\n\\nDrop the materialized view `orders_by_date` if it exists:\\n\\n```\\nDROP MATERIALIZED VIEW IF EXISTS orders_by_date;\\n```\", \"See also\": [\"{doc}`create-materialized-view`\", \"{doc}`show-create-materialized-view`\", \"{doc}`refresh-materialized-view`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 24]\"}, {\"title\": \"DROP ROLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP ROLE [ IF EXISTS ] role_name\\n[ IN catalog ]\\n```\", \"Description\": \"`DROP ROLE` drops the specified role.\\n\\nFor `DROP ROLE` statement to succeed, the user executing it should possess\\nadmin privileges for the given role.\\n\\nThe optional `IF EXISTS` prevents the statement from failing if the role\\nisn't found.\\n\\nThe optional `IN catalog` clause drops the role in a catalog as opposed\\nto a system role.\", \"Examples\": \"Drop role `admin`\\n\\n```\\nDROP ROLE admin;\\n```\", \"Limitations\": \"Some connectors do not support role management.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`create-role`, {doc}`set-role`, {doc}`grant-roles`, {doc}`revoke-roles`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 25]\"}, {\"title\": \"DROP SCHEMA\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP SCHEMA [ IF EXISTS ] schema_name [ CASCADE | RESTRICT ]\\n```\", \"Description\": \"Drop an existing schema. The schema must be empty.\\n\\nThe optional `IF EXISTS` clause causes the error to be suppressed if\\nthe schema does not exist.\", \"Examples\": \"Drop the schema `web`:\\n\\n```\\nDROP SCHEMA web\\n```\\n\\nDrop the schema `sales` if it exists:\\n\\n```\\nDROP SCHEMA IF EXISTS sales\\n```\\n\\nDrop the schema `archive`, along with everything it contains:\\n\\n```\\nDROP SCHEMA archive CASCADE\\n```\\n\\nDrop the schema `archive`, only if there are no objects contained in the schema:\\n\\n```\\nDROP SCHEMA archive RESTRICT\\n```\", \"See also\": \"{doc}`alter-schema`, {doc}`create-schema`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 26]\"}, {\"title\": \"DROP TABLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP TABLE [ IF EXISTS ] table_name\\n```\", \"Description\": \"Drops an existing table.\\n\\nThe optional `IF EXISTS` clause causes the error to be suppressed if the table\\ndoes not exist. The error is not suppressed if a Trino view with the same name\\nexists.\", \"Examples\": \"Drop the table `orders_by_date`:\\n\\n```\\nDROP TABLE orders_by_date\\n```\\n\\nDrop the table `orders_by_date` if it exists:\\n\\n```\\nDROP TABLE IF EXISTS orders_by_date\\n```\", \"See also\": \"{doc}`alter-table`, {doc}`create-table`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 27]\"}, {\"title\": \"DROP VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDROP VIEW [ IF EXISTS ] view_name\\n```\", \"Description\": \"Drop an existing view.\\n\\nThe optional `IF EXISTS` clause causes the error to be suppressed if\\nthe view does not exist.\", \"Examples\": \"Drop the view `orders_by_date`:\\n\\n```\\nDROP VIEW orders_by_date\\n```\\n\\nDrop the view `orders_by_date` if it exists:\\n\\n```\\nDROP VIEW IF EXISTS orders_by_date\\n```\", \"See also\": \"{doc}`create-view`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 28]\"}, {\"title\": \"EXECUTE IMMEDIATE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nEXECUTE IMMEDIATE `statement` [ USING parameter1 [ , parameter2, ... ] ]\\n```\", \"Description\": \"Executes a statement without the need to prepare or deallocate the statement.\\nParameter values are defined in the `USING` clause.\", \"Examples\": \"Execute a query with no parameters:\\n\\n```\\nEXECUTE IMMEDIATE\\n'SELECT name FROM nation';\\n```\\n\\nExecute a query with two parameters:\\n\\n```\\nEXECUTE IMMEDIATE\\n'SELECT name FROM nation WHERE regionkey = ? and nationkey < ?'\\nUSING 1, 3;\\n```\\n\\nThis is equivalent to:\\n\\n```\\nPREPARE statement_name FROM SELECT name FROM nation WHERE regionkey = ? and nationkey < ?\\nEXECUTE statement_name USING 1, 3\\nDEALLOCATE PREPARE statement_name\\n```\", \"See also\": \"{doc}`execute`, {doc}`prepare`, {doc}`deallocate-prepare`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 29]\"}, {\"title\": \"EXECUTE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nEXECUTE statement_name [ USING parameter1 [ , parameter2, ... ] ]\\n```\", \"Description\": \"Executes a prepared statement with the name `statement_name`. Parameter values\\nare defined in the `USING` clause.\", \"Examples\": \"Prepare and execute a query with no parameters:\\n\\n```\\nPREPARE my_select1 FROM\\nSELECT name FROM nation;\\n```\\n\\n```\\nEXECUTE my_select1;\\n```\\n\\nPrepare and execute a query with two parameters:\\n\\n```\\nPREPARE my_select2 FROM\\nSELECT name FROM nation WHERE regionkey = ? and nationkey < ?;\\n```\\n\\n```\\nEXECUTE my_select2 USING 1, 3;\\n```\\n\\nThis is equivalent to:\\n\\n```\\nSELECT name FROM nation WHERE regionkey = 1 AND nationkey < 3;\\n```\", \"See also\": \"{doc}`prepare`, {doc}`deallocate-prepare`, {doc}`execute-immediate`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 30]\"}, {\"title\": \"EXPLAIN ANALYZE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nEXPLAIN ANALYZE [VERBOSE] statement\\n```\", \"Description\": \"Execute the statement and show the distributed execution plan of the statement\\nalong with the cost of each operation.\\n\\nThe `VERBOSE` option will give more detailed information and low-level statistics;\\nunderstanding these may require knowledge of Trino internals and implementation details.\\n\\n:::{note}\\nThe stats may not be entirely accurate, especially for queries that complete quickly.\\n:::\", \"Examples\": \"In the example below, you can see the CPU time spent in each stage, as well as the relative\\ncost of each plan node in the stage. Note that the relative cost of the plan nodes is based on\\nwall time, which may or may not be correlated to CPU time. For each plan node you can see\\nsome additional statistics (e.g: average input per node instance). Such statistics are useful\\nwhen one wants to detect data anomalies for a query (e.g: skewness).\\n\\n```\\nEXPLAIN ANALYZE SELECT count(*), clerk FROM orders\\nWHERE orderdate > date '1995-01-01' GROUP BY clerk;\\n```\\n\\n```\\n Query Plan\\n-----------------------------------------------------------------------------------------------\\nTrino version: version\\nQueued: 374.17us, Analysis: 190.96ms, Planning: 179.03ms, Execution: 3.06s\\nFragment 1 [HASH]\\n CPU: 22.58ms, Scheduled: 96.72ms, Blocked 46.21s (Input: 23.06s, Output: 0.00ns), Input: 1000 rows (37.11kB); per task: avg.: 1000.00 std.dev.: 0.00, Output: 1000 rows (28.32kB)\\n Output layout: [clerk, count]\\n Output partitioning: SINGLE []\\n Project[]\\n \\u2502 Layout: [clerk:varchar(15), count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: 0B}\\n \\u2502 CPU: 8.00ms (3.51%), Scheduled: 63.00ms (15.11%), Blocked: 0.00ns (0.00%), Output: 1000 rows (28.32kB)\\n \\u2502 Input avg.: 15.63 rows, Input std.dev.: 24.36%\\n \\u2514\\u2500 Aggregate[type = FINAL, keys = [clerk], hash = [$hashvalue]]\\n \\u2502 Layout: [clerk:varchar(15), $hashvalue:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: 0B}\\n \\u2502 CPU: 8.00ms (3.51%), Scheduled: 22.00ms (5.28%), Blocked: 0.00ns (0.00%), Output: 1000 rows (37.11kB)\\n \\u2502 Input avg.: 15.63 rows, Input std.dev.: 24.36%\\n \\u2502 count := count(\\\"count_0\\\")\\n \\u2514\\u2500 LocalExchange[partitioning = HASH, hashColumn = [$hashvalue], arguments = [\\\"clerk\\\"]]\\n \\u2502 Layout: [clerk:varchar(15), count_0:bigint, $hashvalue:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: 0B, network: 0B}\\n \\u2502 CPU: 2.00ms (0.88%), Scheduled: 4.00ms (0.96%), Blocked: 23.15s (50.10%), Output: 1000 rows (37.11kB)\\n \\u2502 Input avg.: 15.63 rows, Input std.dev.: 793.73%\\n \\u2514\\u2500 RemoteSource[sourceFragmentIds = [2]]\\n Layout: [clerk:varchar(15), count_0:bigint, $hashvalue_1:bigint]\\n CPU: 0.00ns (0.00%), Scheduled: 0.00ns (0.00%), Blocked: 23.06s (49.90%), Output: 1000 rows (37.11kB)\\n Input avg.: 15.63 rows, Input std.dev.: 793.73%\\n\\nFragment 2 [SOURCE]\\n CPU: 210.60ms, Scheduled: 327.92ms, Blocked 0.00ns (Input: 0.00ns, Output: 0.00ns), Input: 1500000 rows (18.17MB); per task: avg.: 1500000.00 std.dev.: 0.00, Output: 1000 rows (37.11kB)\\n Output layout: [clerk, count_0, $hashvalue_2]\\n Output partitioning: HASH [clerk][$hashvalue_2]\\n Aggregate[type = PARTIAL, keys = [clerk], hash = [$hashvalue_2]]\\n \\u2502 Layout: [clerk:varchar(15), $hashvalue_2:bigint, count_0:bigint]\\n \\u2502 CPU: 30.00ms (13.16%), Scheduled: 30.00ms (7.19%), Blocked: 0.00ns (0.00%), Output: 1000 rows (37.11kB)\\n \\u2502 Input avg.: 818058.00 rows, Input std.dev.: 0.00%\\n \\u2502 count_0 := count(*)\\n \\u2514\\u2500 ScanFilterProject[table = hive:sf1:orders, filterPredicate = (\\\"orderdate\\\" > DATE '1995-01-01')]\\n Layout: [clerk:varchar(15), $hashvalue_2:bigint]\\n Estimates: {rows: 1500000 (41.48MB), cpu: 35.76M, memory: 0B, network: 0B}/{rows: 816424 (22.58MB), cpu: 35.76M, memory: 0B, network: 0B}/{rows: 816424 (22.58MB), cpu: 22.58M, memory: 0B, network: 0B}\\n CPU: 180.00ms (78.95%), Scheduled: 298.00ms (71.46%), Blocked: 0.00ns (0.00%), Output: 818058 rows (12.98MB)\\n Input avg.: 1500000.00 rows, Input std.dev.: 0.00%\\n $hashvalue_2 := combine_hash(bigint '0', COALESCE(\\\"$operator$hash_code\\\"(\\\"clerk\\\"), 0))\\n clerk := clerk:varchar(15):REGULAR\\n orderdate := orderdate:date:REGULAR\\n Input: 1500000 rows (18.17MB), Filtered: 45.46%, Physical Input: 4.51MB\\n```\\n\\nWhen the `VERBOSE` option is used, some operators may report additional information.\\nFor example, the window function operator will output the following:\\n\\n```\\nEXPLAIN ANALYZE VERBOSE SELECT count(clerk) OVER() FROM orders\\nWHERE orderdate > date '1995-01-01';\\n```\\n\\n```\\n Query Plan\\n-----------------------------------------------------------------------------------------------\\n ...\\n \\u2500 Window[]\\n \\u2502 Layout: [clerk:varchar(15), count:bigint]\\n \\u2502 CPU: 157.00ms (53.40%), Scheduled: 158.00ms (37.71%), Blocked: 0.00ns (0.00%), Output: 818058 rows (22.62MB)\\n \\u2502 metrics:\\n \\u2502 'CPU time distribution (s)' = {count=1.00, p01=0.16, p05=0.16, p10=0.16, p25=0.16, p50=0.16, p75=0.16, p90=0.16, p95=0.16, p99=0.16, min=0.16, max=0.16}\\n \\u2502 'Input rows distribution' = {count=1.00, p01=818058.00, p05=818058.00, p10=818058.00, p25=818058.00, p50=818058.00, p75=818058.00, p90=818058.00, p95=818058.00, p99=818058.00, min=818058.00, max=818058.00}\\n \\u2502 'Scheduled time distribution (s)' = {count=1.00, p01=0.16, p05=0.16, p10=0.16, p25=0.16, p50=0.16, p75=0.16, p90=0.16, p95=0.16, p99=0.16, min=0.16, max=0.16}\\n \\u2502 Input avg.: 818058.00 rows, Input std.dev.: 0.00%\\n \\u2502 Active Drivers: [ 1 / 1 ]\\n \\u2502 Index size: std.dev.: 0.00 bytes, 0.00 rows\\n \\u2502 Index count per driver: std.dev.: 0.00\\n \\u2502 Rows per driver: std.dev.: 0.00\\n \\u2502 Size of partition: std.dev.: 0.00\\n \\u2502 count := count(\\\"clerk\\\") RANGE UNBOUNDED_PRECEDING CURRENT_ROW\\n ...\\n```\", \"See also\": \"{doc}`explain`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 31]\"}, {\"title\": \"EXPLAIN\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nEXPLAIN [ ( option [, ...] ) ] statement\\n```\\n\\nwhere `option` can be one of:\\n\\n```\\nFORMAT { TEXT | GRAPHVIZ | JSON }\\nTYPE { LOGICAL | DISTRIBUTED | VALIDATE | IO }\\n```\", \"Description\": \"Show the logical or distributed execution plan of a statement, or validate the statement.\\nThe distributed plan is shown by default. Each plan fragment of the distributed plan is executed by\\na single or multiple Trino nodes. Fragments separation represent the data exchange between Trino nodes.\\nFragment type specifies how the fragment is executed by Trino nodes and how the data is\\ndistributed between fragments:\\n\\n`SINGLE`\\n\\n: Fragment is executed on a single node.\\n\\n`HASH`\\n\\n: Fragment is executed on a fixed number of nodes with the input data\\ndistributed using a hash function.\\n\\n`ROUND_ROBIN`\\n\\n: Fragment is executed on a fixed number of nodes with the input data\\ndistributed in a round-robin fashion.\\n\\n`BROADCAST`\\n\\n: Fragment is executed on a fixed number of nodes with the input data\\nbroadcasted to all nodes.\\n\\n`SOURCE`\\n\\n: Fragment is executed on nodes where input splits are accessed.\", \"Examples\": {\"EXPLAIN (TYPE LOGICAL)\": \"Process the supplied query statement and create a logical plan in text format:\\n\\n```\\nEXPLAIN (TYPE LOGICAL) SELECT regionkey, count(*) FROM nation GROUP BY 1;\\n```\\n\\n```\\n Query Plan\\n-----------------------------------------------------------------------------------------------------------------\\n Trino version: version\\n Output[regionkey, _col1]\\n \\u2502 Layout: [regionkey:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 _col1 := count\\n \\u2514\\u2500 RemoteExchange[GATHER]\\n \\u2502 Layout: [regionkey:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 Aggregate(FINAL)[regionkey]\\n \\u2502 Layout: [regionkey:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 count := count(\\\"count_8\\\")\\n \\u2514\\u2500 LocalExchange[HASH][$hashvalue] (\\\"regionkey\\\")\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint, $hashvalue:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 RemoteExchange[REPARTITION][$hashvalue_9]\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint, $hashvalue_9:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 Project[]\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint, $hashvalue_10:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 $hashvalue_10 := \\\"combine_hash\\\"(bigint '0', COALESCE(\\\"$operator$hash_code\\\"(\\\"regionkey\\\"), 0))\\n \\u2514\\u2500 Aggregate(PARTIAL)[regionkey]\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint]\\n \\u2502 count_8 := count(*)\\n \\u2514\\u2500 TableScan[tpch:nation:sf0.01]\\n Layout: [regionkey:bigint]\\n Estimates: {rows: 25 (225B), cpu: 225, memory: 0B, network: 0B}\\n regionkey := tpch:regionkey\\n```\", \"EXPLAIN (TYPE LOGICAL, FORMAT JSON)\": \":::{warning}\\nThe output format is not guaranteed to be backward compatible across Trino versions.\\n:::\\n\\nProcess the supplied query statement and create a logical plan in JSON format:\\n\\n```\\nEXPLAIN (TYPE LOGICAL, FORMAT JSON) SELECT regionkey, count(*) FROM nation GROUP BY 1;\\n```\\n\\n```\\n{\\n \\\"id\\\": \\\"9\\\",\\n \\\"name\\\": \\\"Output\\\",\\n \\\"descriptor\\\": {\\n \\\"columnNames\\\": \\\"[regionkey, _col1]\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n \\\"_col1 := count\\\"\\n ],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"145\\\",\\n \\\"name\\\": \\\"RemoteExchange\\\",\\n \\\"descriptor\\\": {\\n \\\"type\\\": \\\"GATHER\\\",\\n \\\"isReplicateNullsAndAny\\\": \\\"\\\",\\n \\\"hashColumn\\\": \\\"\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n\\n ],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"4\\\",\\n \\\"name\\\": \\\"Aggregate\\\",\\n \\\"descriptor\\\": {\\n \\\"type\\\": \\\"FINAL\\\",\\n \\\"keys\\\": \\\"[regionkey]\\\",\\n \\\"hash\\\": \\\"\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n \\\"count := count(\\\\\\\"count_0\\\\\\\")\\\"\\n ],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"194\\\",\\n \\\"name\\\": \\\"LocalExchange\\\",\\n \\\"descriptor\\\": {\\n \\\"partitioning\\\": \\\"HASH\\\",\\n \\\"isReplicateNullsAndAny\\\": \\\"\\\",\\n \\\"hashColumn\\\": \\\"[$hashvalue]\\\",\\n \\\"arguments\\\": \\\"[\\\\\\\"regionkey\\\\\\\"]\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count_0\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"$hashvalue\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\":[],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"200\\\",\\n \\\"name\\\": \\\"RemoteExchange\\\",\\n \\\"descriptor\\\": {\\n \\\"type\\\": \\\"REPARTITION\\\",\\n \\\"isReplicateNullsAndAny\\\": \\\"\\\",\\n \\\"hashColumn\\\": \\\"[$hashvalue_1]\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count_0\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"$hashvalue_1\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\":[],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"226\\\",\\n \\\"name\\\": \\\"Project\\\",\\n \\\"descriptor\\\": {},\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count_0\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"$hashvalue_2\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n \\\"$hashvalue_2 := combine_hash(bigint '0', COALESCE(\\\\\\\"$operator$hash_code\\\\\\\"(\\\\\\\"regionkey\\\\\\\"), 0))\\\"\\n ],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\": \\\"NaN\\\",\\n \\\"cpuCost\\\": \\\"NaN\\\",\\n \\\"memoryCost\\\": \\\"NaN\\\",\\n \\\"networkCost\\\": \\\"NaN\\\"\\n }\\n ],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"198\\\",\\n \\\"name\\\": \\\"Aggregate\\\",\\n \\\"descriptor\\\": {\\n \\\"type\\\": \\\"PARTIAL\\\",\\n \\\"keys\\\": \\\"[regionkey]\\\",\\n \\\"hash\\\": \\\"\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n },\\n {\\n \\\"symbol\\\": \\\"count_0\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n \\\"count_0 := count(*)\\\"\\n ],\\n \\\"estimates\\\":[],\\n \\\"children\\\": [\\n {\\n \\\"id\\\": \\\"0\\\",\\n \\\"name\\\": \\\"TableScan\\\",\\n \\\"descriptor\\\": {\\n \\\"table\\\": \\\"hive:tpch_sf1_orc_part:nation\\\"\\n },\\n \\\"outputs\\\": [\\n {\\n \\\"symbol\\\": \\\"regionkey\\\",\\n \\\"type\\\": \\\"bigint\\\"\\n }\\n ],\\n \\\"details\\\": [\\n \\\"regionkey := regionkey:bigint:REGULAR\\\"\\n ],\\n \\\"estimates\\\": [\\n {\\n \\\"outputRowCount\\\": 25,\\n \\\"outputSizeInBytes\\\": 225,\\n \\\"cpuCost\\\": 225,\\n \\\"memoryCost\\\": 0,\\n \\\"networkCost\\\": 0\\n }\\n ],\\n \\\"children\\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}\\n```\", \"EXPLAIN (TYPE DISTRIBUTED)\": \"Process the supplied query statement and create a distributed plan in text\\nformat. The distributed plan splits the logical plan into stages, and therefore\\nexplicitly shows the data exchange between workers:\\n\\n```\\nEXPLAIN (TYPE DISTRIBUTED) SELECT regionkey, count(*) FROM nation GROUP BY 1;\\n```\\n\\n```\\n Query Plan\\n------------------------------------------------------------------------------------------------------\\n Trino version: version\\n Fragment 0 [SINGLE]\\n Output layout: [regionkey, count]\\n Output partitioning: SINGLE []\\n Output[regionkey, _col1]\\n \\u2502 Layout: [regionkey:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 _col1 := count\\n \\u2514\\u2500 RemoteSource[1]\\n Layout: [regionkey:bigint, count:bigint]\\n\\n Fragment 1 [HASH]\\n Output layout: [regionkey, count]\\n Output partitioning: SINGLE []\\n Aggregate(FINAL)[regionkey]\\n \\u2502 Layout: [regionkey:bigint, count:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 count := count(\\\"count_8\\\")\\n \\u2514\\u2500 LocalExchange[HASH][$hashvalue] (\\\"regionkey\\\")\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint, $hashvalue:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2514\\u2500 RemoteSource[2]\\n Layout: [regionkey:bigint, count_8:bigint, $hashvalue_9:bigint]\\n\\n Fragment 2 [SOURCE]\\n Output layout: [regionkey, count_8, $hashvalue_10]\\n Output partitioning: HASH [regionkey][$hashvalue_10]\\n Project[]\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint, $hashvalue_10:bigint]\\n \\u2502 Estimates: {rows: ? (?), cpu: ?, memory: ?, network: ?}\\n \\u2502 $hashvalue_10 := \\\"combine_hash\\\"(bigint '0', COALESCE(\\\"$operator$hash_code\\\"(\\\"regionkey\\\"), 0))\\n \\u2514\\u2500 Aggregate(PARTIAL)[regionkey]\\n \\u2502 Layout: [regionkey:bigint, count_8:bigint]\\n \\u2502 count_8 := count(*)\\n \\u2514\\u2500 TableScan[tpch:nation:sf0.01, grouped = false]\\n Layout: [regionkey:bigint]\\n Estimates: {rows: 25 (225B), cpu: 225, memory: 0B, network: 0B}\\n regionkey := tpch:regionkey\\n```\", \"EXPLAIN (TYPE DISTRIBUTED, FORMAT JSON)\": \":::{warning}\\nThe output format is not guaranteed to be backward compatible across Trino versions.\\n:::\\n\\nProcess the supplied query statement and create a distributed plan in JSON\\nformat. The distributed plan splits the logical plan into stages, and therefore\\nexplicitly shows the data exchange between workers:\\n\\n```\\nEXPLAIN (TYPE DISTRIBUTED, FORMAT JSON) SELECT regionkey, count(*) FROM nation GROUP BY 1;\\n```\\n\\n```\\n{\\n \\\"0\\\" : {\\n \\\"id\\\" : \\\"9\\\",\\n \\\"name\\\" : \\\"Output\\\",\\n \\\"descriptor\\\" : {\\n \\\"columnNames\\\" : \\\"[regionkey, _col1]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ \\\"_col1 := count\\\" ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\" : \\\"NaN\\\",\\n \\\"cpuCost\\\" : \\\"NaN\\\",\\n \\\"memoryCost\\\" : \\\"NaN\\\",\\n \\\"networkCost\\\" : \\\"NaN\\\"\\n } ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"145\\\",\\n \\\"name\\\" : \\\"RemoteSource\\\",\\n \\\"descriptor\\\" : {\\n \\\"sourceFragmentIds\\\" : \\\"[1]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ ],\\n \\\"estimates\\\" : [ ],\\n \\\"children\\\" : [ ]\\n } ]\\n },\\n \\\"1\\\" : {\\n \\\"id\\\" : \\\"4\\\",\\n \\\"name\\\" : \\\"Aggregate\\\",\\n \\\"descriptor\\\" : {\\n \\\"type\\\" : \\\"FINAL\\\",\\n \\\"keys\\\" : \\\"[regionkey]\\\",\\n \\\"hash\\\" : \\\"[]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ \\\"count := count(\\\\\\\"count_0\\\\\\\")\\\" ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\" : \\\"NaN\\\",\\n \\\"cpuCost\\\" : \\\"NaN\\\",\\n \\\"memoryCost\\\" : \\\"NaN\\\",\\n \\\"networkCost\\\" : \\\"NaN\\\"\\n } ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"194\\\",\\n \\\"name\\\" : \\\"LocalExchange\\\",\\n \\\"descriptor\\\" : {\\n \\\"partitioning\\\" : \\\"SINGLE\\\",\\n \\\"isReplicateNullsAndAny\\\" : \\\"\\\",\\n \\\"hashColumn\\\" : \\\"[]\\\",\\n \\\"arguments\\\" : \\\"[]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count_0\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\" : \\\"NaN\\\",\\n \\\"cpuCost\\\" : \\\"NaN\\\",\\n \\\"memoryCost\\\" : \\\"NaN\\\",\\n \\\"networkCost\\\" : \\\"NaN\\\"\\n } ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"227\\\",\\n \\\"name\\\" : \\\"Project\\\",\\n \\\"descriptor\\\" : { },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count_0\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\" : \\\"NaN\\\",\\n \\\"cpuCost\\\" : \\\"NaN\\\",\\n \\\"memoryCost\\\" : \\\"NaN\\\",\\n \\\"networkCost\\\" : \\\"NaN\\\"\\n } ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"200\\\",\\n \\\"name\\\" : \\\"RemoteSource\\\",\\n \\\"descriptor\\\" : {\\n \\\"sourceFragmentIds\\\" : \\\"[2]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count_0\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"$hashvalue\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ ],\\n \\\"estimates\\\" : [ ],\\n \\\"children\\\" : [ ]\\n } ]\\n } ]\\n } ]\\n },\\n \\\"2\\\" : {\\n \\\"id\\\" : \\\"226\\\",\\n \\\"name\\\" : \\\"Project\\\",\\n \\\"descriptor\\\" : { },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count_0\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"$hashvalue_1\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ \\\"$hashvalue_1 := combine_hash(bigint '0', COALESCE(\\\\\\\"$operator$hash_code\\\\\\\"(\\\\\\\"regionkey\\\\\\\"), 0))\\\" ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : \\\"NaN\\\",\\n \\\"outputSizeInBytes\\\" : \\\"NaN\\\",\\n \\\"cpuCost\\\" : \\\"NaN\\\",\\n \\\"memoryCost\\\" : \\\"NaN\\\",\\n \\\"networkCost\\\" : \\\"NaN\\\"\\n } ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"198\\\",\\n \\\"name\\\" : \\\"Aggregate\\\",\\n \\\"descriptor\\\" : {\\n \\\"type\\\" : \\\"PARTIAL\\\",\\n \\\"keys\\\" : \\\"[regionkey]\\\",\\n \\\"hash\\\" : \\\"[]\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n }, {\\n \\\"symbol\\\" : \\\"count_0\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ \\\"count_0 := count(*)\\\" ],\\n \\\"estimates\\\" : [ ],\\n \\\"children\\\" : [ {\\n \\\"id\\\" : \\\"0\\\",\\n \\\"name\\\" : \\\"TableScan\\\",\\n \\\"descriptor\\\" : {\\n \\\"table\\\" : \\\"tpch:tiny:nation\\\"\\n },\\n \\\"outputs\\\" : [ {\\n \\\"symbol\\\" : \\\"regionkey\\\",\\n \\\"type\\\" : \\\"bigint\\\"\\n } ],\\n \\\"details\\\" : [ \\\"regionkey := tpch:regionkey\\\" ],\\n \\\"estimates\\\" : [ {\\n \\\"outputRowCount\\\" : 25.0,\\n \\\"outputSizeInBytes\\\" : 225.0,\\n \\\"cpuCost\\\" : 225.0,\\n \\\"memoryCost\\\" : 0.0,\\n \\\"networkCost\\\" : 0.0\\n } ],\\n \\\"children\\\" : [ ]\\n } ]\\n } ]\\n }\\n}\\n```\", \"EXPLAIN (TYPE VALIDATE)\": \"Validate the supplied query statement for syntactical and semantic correctness.\\nReturns true if the statement is valid:\\n\\n```\\nEXPLAIN (TYPE VALIDATE) SELECT regionkey, count(*) FROM nation GROUP BY 1;\\n```\\n\\n```\\n Valid\\n-------\\n true\\n```\\n\\nIf the statement is not correct because a syntax error, such as an unknown\\nkeyword, is found the error message details the problem:\\n\\n```\\nEXPLAIN (TYPE VALIDATE) SELET 1=0;\\n```\\n\\n```\\nQuery 20220929_234840_00001_vjwxj failed: line 1:25: mismatched input 'SELET'.\\nExpecting: 'ALTER', 'ANALYZE', 'CALL', 'COMMENT', 'COMMIT', 'CREATE',\\n'DEALLOCATE', 'DELETE', 'DENY', 'DESC', 'DESCRIBE', 'DROP', 'EXECUTE',\\n'EXPLAIN', 'GRANT', 'INSERT', 'MERGE', 'PREPARE', 'REFRESH', 'RESET',\\n'REVOKE', 'ROLLBACK', 'SET', 'SHOW', 'START', 'TRUNCATE', 'UPDATE', 'USE',\\n<query>\\n```\\n\\nSimilarly if semantic issues are detected, such as an invalid object name\\n`nations` instead of `nation`, the error message returns useful\\ninformation:\\n\\n```\\nEXPLAIN(TYPE VALIDATE) SELECT * FROM tpch.tiny.nations;\\n```\\n\\n```\\nQuery 20220929_235059_00003_vjwxj failed: line 1:15: Table 'tpch.tiny.nations' does not exist\\nSELECT * FROM tpch.tiny.nations\\n```\", \"EXPLAIN (TYPE IO)\": \"Process the supplied query statement and create a plan with input and output\\ndetails about the accessed objects in JSON format:\\n\\n```\\nEXPLAIN (TYPE IO, FORMAT JSON) INSERT INTO test_lineitem\\nSELECT * FROM lineitem WHERE shipdate = '2020-02-01' AND quantity > 10;\\n```\\n\\n```\\n Query Plan\\n-----------------------------------\\n{\\n inputTableColumnInfos: [\\n {\\n table: {\\n catalog: \\\"hive\\\",\\n schemaTable: {\\n schema: \\\"tpch\\\",\\n table: \\\"test_orders\\\"\\n }\\n },\\n columnConstraints: [\\n {\\n columnName: \\\"orderkey\\\",\\n type: \\\"bigint\\\",\\n domain: {\\n nullsAllowed: false,\\n ranges: [\\n {\\n low: {\\n value: \\\"1\\\",\\n bound: \\\"EXACTLY\\\"\\n },\\n high: {\\n value: \\\"1\\\",\\n bound: \\\"EXACTLY\\\"\\n }\\n },\\n {\\n low: {\\n value: \\\"2\\\",\\n bound: \\\"EXACTLY\\\"\\n },\\n high: {\\n value: \\\"2\\\",\\n bound: \\\"EXACTLY\\\"\\n }\\n }\\n ]\\n }\\n },\\n {\\n columnName: \\\"processing\\\",\\n type: \\\"boolean\\\",\\n domain: {\\n nullsAllowed: false,\\n ranges: [\\n {\\n low: {\\n value: \\\"false\\\",\\n bound: \\\"EXACTLY\\\"\\n },\\n high: {\\n value: \\\"false\\\",\\n bound: \\\"EXACTLY\\\"\\n }\\n }\\n ]\\n }\\n },\\n {\\n columnName: \\\"custkey\\\",\\n type: \\\"bigint\\\",\\n domain: {\\n nullsAllowed: false,\\n ranges: [\\n {\\n low: {\\n bound: \\\"ABOVE\\\"\\n },\\n high: {\\n value: \\\"10\\\",\\n bound: \\\"EXACTLY\\\"\\n }\\n }\\n ]\\n }\\n }\\n ],\\n estimate: {\\n outputRowCount: 2,\\n outputSizeInBytes: 40,\\n cpuCost: 40,\\n maxMemory: 0,\\n networkCost: 0\\n }\\n }\\n ],\\n outputTable: {\\n catalog: \\\"hive\\\",\\n schemaTable: {\\n schema: \\\"tpch\\\",\\n table: \\\"test_orders\\\"\\n }\\n },\\n estimate: {\\n outputRowCount: \\\"NaN\\\",\\n outputSizeInBytes: \\\"NaN\\\",\\n cpuCost: \\\"NaN\\\",\\n maxMemory: \\\"NaN\\\",\\n networkCost: \\\"NaN\\\"\\n }\\n}\\n```\"}, \"See also\": \"{doc}`explain-analyze`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 32]\"}, {\"title\": \"GRANT role\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nGRANT role_name [, ...]\\nTO ( user | USER user_name | ROLE role_name) [, ...]\\n[ GRANTED BY ( user | USER user | ROLE role | CURRENT_USER | CURRENT_ROLE ) ]\\n[ WITH ADMIN OPTION ]\\n[ IN catalog ]\\n```\", \"Description\": \"Grants the specified role(s) to the specified principal(s).\\n\\nIf the `WITH ADMIN OPTION` clause is specified, the role(s) are granted\\nto the users with `GRANT` option.\\n\\nFor the `GRANT` statement for roles to succeed, the user executing it either should\\nbe the role admin or should possess the `GRANT` option for the given role.\\n\\nThe optional `GRANTED BY` clause causes the role(s) to be granted with\\nthe specified principal as a grantor. If the `GRANTED BY` clause is not\\nspecified, the roles are granted with the current user as a grantor.\\n\\nThe optional `IN catalog` clause grants the roles in a catalog as opposed\\nto a system roles.\", \"Examples\": \"Grant role `bar` to user `foo`\\n\\n```\\nGRANT bar TO USER foo;\\n```\\n\\nGrant roles `bar` and `foo` to user `baz` and role `qux` with admin option\\n\\n```\\nGRANT bar, foo TO USER baz, ROLE qux WITH ADMIN OPTION;\\n```\", \"Limitations\": \"Some connectors do not support role management.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`create-role`, {doc}`drop-role`, {doc}`set-role`, {doc}`revoke-roles`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 33]\"}, {\"title\": \"GRANT privilege\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nGRANT ( privilege [, ...] | ( ALL PRIVILEGES ) )\\nON ( table_name | TABLE table_name | SCHEMA schema_name)\\nTO ( user | USER user | ROLE role )\\n[ WITH GRANT OPTION ]\\n```\", \"Description\": \"Grants the specified privileges to the specified grantee.\\n\\nSpecifying `ALL PRIVILEGES` grants {doc}`delete`, {doc}`insert`, {doc}`update` and {doc}`select` privileges.\\n\\nSpecifying `ROLE PUBLIC` grants privileges to the `PUBLIC` role and hence to all users.\\n\\nThe optional `WITH GRANT OPTION` clause allows the grantee to grant these same privileges to others.\\n\\nFor `GRANT` statement to succeed, the user executing it should possess the specified privileges as well as the `GRANT OPTION` for those privileges.\\n\\nGrant on a table grants the specified privilege on all current and future columns of the table.\\n\\nGrant on a schema grants the specified privilege on all current and future columns of all current and future tables of the schema.\", \"Examples\": \"Grant `INSERT` and `SELECT` privileges on the table `orders` to user `alice`:\\n\\n```\\nGRANT INSERT, SELECT ON orders TO alice;\\n```\\n\\nGrant `DELETE` privilege on the schema `finance` to user `bob`:\\n\\n```\\nGRANT DELETE ON SCHEMA finance TO bob;\\n```\\n\\nGrant `SELECT` privilege on the table `nation` to user `alice`, additionally allowing `alice` to grant `SELECT` privilege to others:\\n\\n```\\nGRANT SELECT ON nation TO alice WITH GRANT OPTION;\\n```\\n\\nGrant `SELECT` privilege on the table `orders` to everyone:\\n\\n```\\nGRANT SELECT ON orders TO ROLE PUBLIC;\\n```\", \"Limitations\": \"Some connectors have no support for `GRANT`.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`deny`, {doc}`revoke`, {doc}`show-grants`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 34]\"}, {\"title\": \"INSERT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nINSERT INTO table_name [ ( column [, ... ] ) ] query\\n```\", \"Description\": \"Insert new rows into a table.\\n\\nIf the list of column names is specified, they must exactly match the list\\nof columns produced by the query. Each column in the table not present in the\\ncolumn list will be filled with a `null` value. Otherwise, if the list of\\ncolumns is not specified, the columns produced by the query must exactly match\\nthe columns in the table being inserted into.\", \"Examples\": \"Load additional rows into the `orders` table from the `new_orders` table:\\n\\n```\\nINSERT INTO orders\\nSELECT * FROM new_orders;\\n```\\n\\nInsert a single row into the `cities` table:\\n\\n```\\nINSERT INTO cities VALUES (1, 'San Francisco');\\n```\\n\\nInsert multiple rows into the `cities` table:\\n\\n```\\nINSERT INTO cities VALUES (2, 'San Jose'), (3, 'Oakland');\\n```\\n\\nInsert a single row into the `nation` table with the specified column list:\\n\\n```\\nINSERT INTO nation (nationkey, name, regionkey, comment)\\nVALUES (26, 'POLAND', 3, 'no comment');\\n```\\n\\nInsert a row without specifying the `comment` column.\\nThat column will be `null`:\\n\\n```\\nINSERT INTO nation (nationkey, name, regionkey)\\nVALUES (26, 'POLAND', 3);\\n```\", \"See also\": \"{doc}`values`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 35]\"}, {\"title\": \"MATCH_RECOGNIZE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nMATCH_RECOGNIZE (\\n [ PARTITION BY column [, ...] ]\\n [ ORDER BY column [, ...] ]\\n [ MEASURES measure_definition [, ...] ]\\n [ rows_per_match ]\\n [ AFTER MATCH skip_to ]\\n PATTERN ( row_pattern )\\n [ SUBSET subset_definition [, ...] ]\\n DEFINE variable_definition [, ...]\\n )\\n```\", \"Description\": \"The `MATCH_RECOGNIZE` clause is an optional subclause of the `FROM` clause.\\nIt is used to detect patterns in a set of rows. Patterns of interest are\\nspecified using row pattern syntax based on regular expressions. The input to\\npattern matching is a table, a view or a subquery. For each detected match, one\\nor more rows are returned. They contain requested information about the match.\\n\\nRow pattern matching is a powerful tool when analyzing complex sequences of\\nevents. The following examples show some of the typical use cases:\\n\\n['in trade applications, tracking trends or identifying customers with specific\\\\nbehavioral patterns', 'in shipping applications, tracking packages through all possible valid paths,', 'in financial applications, detecting unusual incidents, which might signal\\\\nfraud']\", \"Example\": \"In the following example, the pattern describes a V-shape over the\\n`totalprice` column. A match is found whenever orders made by a customer\\nfirst decrease in price, and then increase past the starting point:\\n\\n```\\nSELECT * FROM orders MATCH_RECOGNIZE(\\n PARTITION BY custkey\\n ORDER BY orderdate\\n MEASURES\\n A.totalprice AS starting_price,\\n LAST(B.totalprice) AS bottom_price,\\n LAST(U.totalprice) AS top_price\\n ONE ROW PER MATCH\\n AFTER MATCH SKIP PAST LAST ROW\\n PATTERN (A B+ C+ D+)\\n SUBSET U = (C, D)\\n DEFINE\\n B AS totalprice < PREV(totalprice),\\n C AS totalprice > PREV(totalprice) AND totalprice <= A.totalprice,\\n D AS totalprice > PREV(totalprice)\\n )\\n```\\n\\nIn the following sections, all subclauses of the `MATCH_RECOGNIZE` clause are\\nexplained with this example query.\", \"Partitioning and ordering\": \"```\\nPARTITION BY custkey\\n```\\n\\nThe `PARTITION BY` clause allows you to break up the input table into\\nseparate sections, that are independently processed for pattern matching.\\nWithout a partition declaration, the whole input table is used. This behavior\\nis analogous to the semantics of `PARTITION BY` clause in {ref}`window\\nspecification<window-clause>`. In the example, the `orders` table is\\npartitioned by the `custkey` value, so that pattern matching is performed for\\nall orders of a specific customer independently from orders of other\\ncustomers.\\n\\n```\\nORDER BY orderdate\\n```\\n\\nThe optional `ORDER BY` clause is generally useful to allow matching on an\\nordered data set. For example, sorting the input by `orderdate` allows for\\nmatching on a trend of changes over time.\\n\\n(row-pattern-measures)=\", \"Row pattern measures\": \"The `MEASURES` clause allows to specify what information is retrieved from a\\nmatched sequence of rows.\\n\\n```\\nMEASURES measure_expression AS measure_name [, ...]\\n```\\n\\nA measure expression is a scalar expression whose value is computed based on a\\nmatch. In the example, three row pattern measures are specified:\\n\\n`A.totalprice AS starting_price` returns the price in the first row of the\\nmatch, which is the only row associated with `A` according to the pattern.\\n\\n`LAST(B.totalprice) AS bottom_price` returns the lowest price (corresponding\\nto the bottom of the \\\"V\\\" in the pattern). It is the price in the last row\\nassociated with `B`, which is the last row of the descending section.\\n\\n`LAST(U.totalprice) AS top_price` returns the highest price in the match. It\\nis the price in the last row associated with `C` or `D`, which is also the\\nfinal row of the match.\\n\\nMeasure expressions can refer to the columns of the input table. They also\\nallow special syntax to combine the input information with the details of the\\nmatch (see {ref}`pattern-recognition-expressions`).\\n\\nEach measure defines an output column of the pattern recognition. The column\\ncan be referenced with the `measure_name`.\\n\\nThe `MEASURES` clause is optional. When no measures are specified, certain\\ninput columns (depending on {ref}`ROWS PER MATCH<rows-per-match>` clause) are\\nthe output of the pattern recognition.\\n\\n(rows-per-match)=\", \"Rows per match\": \"This clause can be used to specify the quantity of output rows. There are two\\nmain options:\\n\\n```\\nONE ROW PER MATCH\\n```\\n\\nand\\n\\n```\\nALL ROWS PER MATCH\\n```\\n\\n`ONE ROW PER MATCH` is the default option. For every match, a single row of\\noutput is produced. Output consists of `PARTITION BY` columns and measures.\\nThe output is also produced for empty matches, based on their starting rows.\\nRows that are unmatched (that is, neither included in some non-empty match, nor\\nbeing the starting row of an empty match), are not included in the output.\\n\\nFor `ALL ROWS PER MATCH`, every row of a match produces an output row, unless\\nit is excluded from the output by the {ref}`exclusion-syntax`. Output consists\\nof `PARTITION BY` columns, `ORDER BY` columns, measures and remaining\\ncolumns from the input table. By default, empty matches are shown and unmatched\\nrows are skipped, similarly as with the `ONE ROW PER MATCH` option. However,\\nthis behavior can be changed by modifiers:\\n\\n```\\nALL ROWS PER MATCH SHOW EMPTY MATCHES\\n```\\n\\nshows empty matches and skips unmatched rows, like the default.\\n\\n```\\nALL ROWS PER MATCH OMIT EMPTY MATCHES\\n```\\n\\nexcludes empty matches from the output.\\n\\n```\\nALL ROWS PER MATCH WITH UNMATCHED ROWS\\n```\\n\\nshows empty matches and produces additional output row for each unmatched row.\\n\\nThere are special rules for computing row pattern measures for empty matches\\nand unmatched rows. They are explained in\\n{ref}`empty-matches-and-unmatched-rows`.\\n\\nUnmatched rows can only occur when the pattern does not allow an empty match.\\nOtherwise, they are considered as starting rows of empty matches. The option\\n`ALL ROWS PER MATCH WITH UNMATCHED ROWS` is recommended when pattern\\nrecognition is expected to pass all input rows, and it is not certain whether\\nthe pattern allows an empty match.\\n\\n(after-match-skip)=\", \"After match skip\": \"The `AFTER MATCH SKIP` clause specifies where pattern matching resumes after\\na non-empty match is found.\\n\\nThe default option is:\\n\\n```\\nAFTER MATCH SKIP PAST LAST ROW\\n```\\n\\nWith this option, pattern matching starts from the row after the last row of\\nthe match. Overlapping matches are not detected.\\n\\nWith the following option, pattern matching starts from the second row of the\\nmatch:\\n\\n```\\nAFTER MATCH SKIP TO NEXT ROW\\n```\\n\\nIn the example, if a V-shape is detected, further overlapping matches are\\nfound, starting from consecutive rows on the descending slope of the \\\"V\\\".\\nSkipping to the next row is the default behavior after detecting an empty match\\nor unmatched row.\\n\\nThe following `AFTER MATCH SKIP` options allow to resume pattern matching\\nbased on the components of the pattern. Pattern matching starts from the last\\n(default) or first row matched to a certain row pattern variable. It can be\\neither a primary pattern variable (they are explained in\\n{ref}`row-pattern-syntax`) or a\\n{ref}`union variable<row-pattern-union-variables>`:\\n\\n```\\nAFTER MATCH SKIP TO [ FIRST | LAST ] pattern_variable\\n```\\n\\nIt is forbidden to skip to the first row of the current match, because it\\nresults in an infinite loop. For example specifying `AFTER MATCH SKIP TO A`\\nfails, because `A` is the first element of the pattern, and jumping back to\\nit creates an infinite loop. Similarly, skipping to a pattern variable which is\\nnot present in the match causes failure.\\n\\nAll other options than the default `AFTER MATCH SKIP PAST LAST ROW` allow\\ndetection of overlapping matches. The combination of `ALL ROWS PER MATCH WITH\\nUNMATCHED ROWS` with `AFTER MATCH SKIP PAST LAST ROW` is the only\\nconfiguration that guarantees exactly one output row for each input row.\\n\\n(row-pattern-syntax)=\", \"Row pattern syntax\": {\"concatenation\": \"```\\nA B+ C+ D+\\n```\\n\\nIt is a sequence of components without operators between them. All components\\nare matched in the same order as they are specified.\", \"alternation\": \"```\\nA | B | C\\n```\\n\\nIt is a sequence of components separated by `|`. Exactly one of the\\ncomponents is matched. In case when multiple components can be matched, the\\nleftmost matching component is chosen.\\n\\n(permute-function)=\", \"permutation\": \"```\\nPERMUTE(A, B, C)\\n```\\n\\nIt is equivalent to alternation of all permutations of its components. All\\ncomponents are matched in some order. If multiple matches are possible for\\ndifferent orderings of the components, the match is chosen based on the\\nlexicographical order established by the order of components in the `PERMUTE`\\nlist. In the above example, the most preferred option is `A B C`, and the\\nleast preferred option is `C B A`.\", \"grouping\": \"```\\n(A B C)\\n```\", \"partition start anchor\": \"```\\n^\\n```\", \"partition end anchor\": \"```\\n$\\n```\", \"empty pattern\": \"```\\n()\\n```\\n\\n(exclusion-syntax)=\", \"exclusion syntax\": \"```\\n{- row_pattern -}\\n```\\n\\nExclusion syntax is used to specify portions of the match to exclude from the\\noutput. It is useful in combination with the `ALL ROWS PER MATCH` option,\\nwhen only certain sections of the match are interesting.\\n\\nIf you change the example to use `ALL ROWS PER MATCH`, and the pattern is\\nmodified to `PATTERN (A {- B+ C+ -} D+)`, the result consists of the initial\\nmatched row and the trailing section of rows.\\n\\nSpecifying pattern exclusions does not affect the computation of expressions in\\n`MEASURES` and `DEFINE` clauses. Exclusions also do not affect pattern\\nmatching. They have the same semantics as regular grouping with parentheses.\\n\\nIt is forbidden to specify pattern exclusions with the option `ALL ROWS PER\\nMATCH WITH UNMATCHED ROWS`.\", \"quantifiers\": \"Pattern quantifiers allow to specify the desired number of repetitions of a\\nsub-pattern in a match. They are appended after the relevant pattern\\ncomponent:\\n\\n```\\n(A | B)*\\n```\\n\\nThere are following row pattern quantifiers:\\n\\n['zero or more repetitions:']\\n\\n```\\n*\\n```\\n\\n['one or more repetitions:']\\n\\n```\\n+\\n```\\n\\n['zero or one repetition:']\\n\\n```\\n?\\n```\\n\\n['exact number of repetitions, specified by a non-negative integer number:']\\n\\n```\\n{n}\\n```\\n\\n['number of repetitions ranging between bounds, specified by non-negative\\\\ninteger numbers:']\\n\\n```\\n{m, n}\\n```\\n\\nSpecifying bounds is optional. If the left bound is omitted, it defaults to\\n`0`. So, `{, 5}` can be described as \\\"between zero and five repetitions\\\".\\nIf the right bound is omitted, the number of accepted repetitions is unbounded.\\nSo, `{5, }` can be described as \\\"at least five repetitions\\\". Also, `{,}` is\\nequivalent to `*`.\\n\\nQuantifiers are greedy by default. It means that higher number of repetitions\\nis preferred over lower number. This behavior can be changed to reluctant by\\nappending `?` immediately after the quantifier. With `{3, 5}`, 3\\nrepetitions is the least desired option and 5 repetitions -- the most desired.\\nWith `{3, 5}?`, 3 repetitions are most desired. Similarly, `?` prefers 1\\nrepetition, while `??` prefers 0 repetitions.\\n\\n(row-pattern-union-variables)=\"}, \"Row pattern union variables\": \"As explained in {ref}`row-pattern-syntax`, primary pattern variables are the\\nbasic elements of row pattern. In addition to primary pattern variables, you\\ncan define union variables. They are introduced in the `SUBSET` clause:\\n\\n```\\nSUBSET U = (C, D), ...\\n```\\n\\nIn the preceding example, union variable `U` is defined as union of primary\\nvariables `C` and `D`. Union variables are useful in `MEASURES`,\\n`DEFINE` and `AFTER MATCH SKIP` clauses. They allow you to refer to set of\\nrows matched to either primary variable from a subset.\\n\\nWith the pattern: `PATTERN((A | B){5} C+)` it cannot be determined upfront if\\nthe match contains any `A` or any `B`. A union variable can be used to\\naccess the last row matched to either `A` or `B`. Define `SUBSET U =\\n(A, B)`, and the expression `LAST(U.totalprice)` returns the value of the\\n`totalprice` column from the last row mapped to either `A` or `B`. Also,\\n`AFTER MATCH SKIP TO LAST A` or `AFTER MATCH SKIP TO LAST B` can result in\\nfailure if `A` or `B` is not present in the match. `AFTER MATCH SKIP TO\\nLAST U` does not fail.\\n\\n(row-pattern-variable-definitions)=\", \"Row pattern variable definitions\": \"The `DEFINE` clause is where row pattern primary variables are defined. Each\\nvariable is associated with a boolean condition:\\n\\n```\\nDEFINE B AS totalprice < PREV(totalprice), ...\\n```\\n\\nDuring pattern matching, when a certain variable is considered for the next\\nstep of the match, the boolean condition is evaluated in context of the current\\nmatch. If the result is `true`, then the current row, \\\"labeled\\\" with the\\nvariable, becomes part of the match.\\n\\nIn the preceding example, assume that the pattern allows to match `B` at some\\npoint. There are some rows already matched to some pattern variables. Now,\\nvariable `B` is being considered for the current row. Before the match is\\nmade, the defining condition for `B` is evaluated. In this example, it is\\nonly true if the value of the `totalprice` column in the current row is lower\\nthan `totalprice` in the preceding row.\\n\\nThe mechanism of matching variables to rows shows the difference between\\npattern matching in row sequences and regular expression matching in text. In\\ntext, characters remain constantly in their positions. In row pattern matching,\\na row can be mapped to different variables in different matches, depending on\\nthe preceding part of the match, and even on the match number.\\n\\nIt is not required that every primary variable has a definition in the\\n`DEFINE` clause. Variables not mentioned in the `DEFINE` clause are\\nimplicitly associated with `true` condition, which means that they can be\\nmatched to every row.\\n\\nBoolean expressions in the `DEFINE` clause allow the same special syntax as\\nexpressions in the `MEASURES` clause. Details are explained in\\n{ref}`pattern-recognition-expressions`.\\n\\n(pattern-recognition-expressions)=\", \"Row pattern recognition expressions\": {\"pattern variable references\": \"```\\nA.totalprice\\n\\nU.orderdate\\n\\norderstatus\\n```\\n\\nA column name prefixed with a pattern variable refers to values of this column\\nin all rows matched to this variable, or to any variable from the subset in\\ncase of union variable. If a column name is not prefixed, it is considered as\\nprefixed with the `universal pattern variable`, defined as union of all\\nprimary pattern variables. In other words, a non-prefixed column name refers to\\nall rows of the current match.\\n\\nIt is forbidden to prefix a column name with a table name in the pattern\\nrecognition context.\\n\\n(classifier-function)=\", \"classifier function\": \"```\\nCLASSIFIER()\\n\\nCLASSIFIER(A)\\n\\nCLASSIFIER(U)\\n```\\n\\nThe `classifier` function returns the primary pattern variable associated\\nwith the row. The return type is `varchar`. The optional argument is a\\npattern variable. It limits the rows of interest, the same way as with prefixed\\ncolumn references. The `classifier` function is particularly useful with a\\nunion variable as the argument. It allows you to determine which variable from\\nthe subset actually matched.\\n\\n(match-number-function)=\", \"match_number function\": \"```\\nMATCH_NUMBER()\\n```\\n\\nThe `match_number` function returns the sequential number of the match within\\npartition, starting from `1`. Empty matches are assigned sequential numbers\\nas well as non-empty matches. The return type is `bigint`.\\n\\n(logical-navigation-functions)=\", \"logical navigation functions\": \"```\\nFIRST(A.totalprice, 2)\\n```\\n\\nIn the above example, the `first` function navigates to the first row matched\\nto pattern variable `A`, and then searches forward until it finds two more\\noccurrences of variable `A` within the match. The result is the value of the\\n`totalprice` column in that row.\\n\\n```\\nLAST(A.totalprice, 2)\\n```\\n\\nIn the above example, the `last` function navigates to the last row matched\\nto pattern variable `A`, and then searches backwards until it finds two more\\noccurrences of variable `A` within the match. The result is the value of the\\n`totalprice` column in that row.\\n\\nWith the `first` and `last` functions the result is `null`, if the\\nsearched row is not found in the mach.\\n\\nThe second argument is optional. The default value is `0`, which means that\\nby default these functions navigate to the first or last row of interest. If\\nspecified, the second argument must be a non-negative integer number.\\n\\n(physical-navigation-functions)=\", \"physical navigation functions\": \"```\\nPREV(A.totalprice, 2)\\n```\\n\\nIn the above example, the `prev` function navigates to the last row matched\\nto pattern variable `A`, and then searches two rows backward. The result is\\nthe value of the `totalprice` column in that row.\\n\\n```\\nNEXT(A.totalprice, 2)\\n```\\n\\nIn the above example, the `next` function navigates to the last row matched\\nto pattern variable `A`, and then searches two rows forward. The result is\\nthe value of the `totalprice` column in that row.\\n\\nWith the `prev` and `next` functions, it is possible to navigate and\\nretrieve values outside the match. If the navigation goes beyond partition\\nbounds, the result is `null`.\\n\\nThe second argument is optional. The default value is `1`, which means that\\nby default these functions navigate to previous or next row. If specified, the\\nsecond argument must be a non-negative integer number.\", \"nesting of navigation functions\": \"It is possible to nest logical navigation functions within physical navigation\\nfunctions:\\n\\n```\\nPREV(FIRST(A.totalprice, 3), 2)\\n```\\n\\nIn case of nesting, first the logical navigation is performed. It establishes\\nthe starting row for the physical navigation. When both navigation operations\\nsucceed, the value is retrieved from the designated row.\\n\\nPattern navigation functions require at least one column reference or\\n`classifier` function inside of their first argument. The following examples\\nare correct:\\n\\n```\\nLAST(\\\"pattern_variable_\\\" || CLASSIFIER())\\n\\nNEXT(U.totalprice + 10)\\n```\\n\\nThis is incorrect:\\n\\n```\\nLAST(1)\\n```\\n\\nIt is also required that all column references and all `classifier` calls\\ninside a pattern navigation function are consistent in referred pattern\\nvariables. They must all refer either to the same primary variable, the same\\nunion variable, or to the implicit universal pattern variable. The following\\nexamples are correct:\\n\\n```\\nLAST(CLASSIFIER() = 'A' OR totalprice > 10) /* universal pattern variable */\\n\\nLAST(CLASSIFIER(U) = 'A' OR U.totalprice > 10) /* pattern variable U */\\n```\\n\\nThis is incorrect:\\n\\n```\\nLAST(A.totalprice + B.totalprice)\\n```\", \"Aggregate functions\": {\"Aggregation arguments\": \"In case when the aggregate function has multiple arguments, it is required that\\nall arguments refer consistently to the same set of rows:\\n\\n```\\nmax_by(totalprice, tax) /* aggregate over all rows of the match */\\n\\nmax_by(CLASSIFIER(A), A.tax) /* aggregate over all rows matched to A */\\n```\\n\\nThis is incorrect:\\n\\n```\\nmax_by(A.totalprice, tax)\\n\\nmax_by(A.totalprice, A.tax + B.tax)\\n```\\n\\nIf an aggregate argument does not contain any column reference or\\n`classifier` function, it does not refer to any pattern variable. In such a\\ncase other aggregate arguments determine the set of rows to aggregate over. If\\nnone of the arguments contains a pattern variable reference, the universal row\\npattern variable is implicit. This means that the aggregate function applies to\\nall rows of the match:\\n\\n```\\ncount(1) /* aggregate over all rows of the match */\\n\\nmin_by(1, 2) /* aggregate over all rows of the match */\\n\\nmin_by(1, totalprice) /* aggregate over all rows of the match */\\n\\nmin_by(totalprice, 1) /* aggregate over all rows of the match */\\n\\nmin_by(A.totalprice, 1) /* aggregate over all rows matched to A */\\n\\nmax_by(1, A.totalprice) /* aggregate over all rows matched to A */\\n```\", \"Nesting of aggregate functions\": \"Aggregate function arguments must not contain pattern navigation functions.\\nSimilarly, aggregate functions cannot be nested in pattern navigation\\nfunctions.\", \"Usage of the `classifier` and `match_number` functions\": \"It is allowed to use the `classifier` and `match_number` functions in\\naggregate function arguments. The following expression returns an array\\ncontaining all matched pattern variables:\\n\\n```\\narray_agg(CLASSIFIER())\\n```\\n\\nThis is particularly useful in combination with the option\\n`ONE ROW PER MATCH`. It allows to get all the components of the match while\\nkeeping the output size reduced.\", \"Row pattern count aggregation\": \"Like other aggregate functions in a row pattern recognition context, the\\n`count` function can be applied to all rows of the match, or to rows\\nassociated with certain row pattern variables:\\n\\n```\\ncount(*), count() /* count all rows of the match */\\n\\ncount(totalprice) /* count non-null values of the totalprice column\\n in all rows of the match */\\n\\ncount(A.totalprice) /* count non-null values of the totalprice column\\n in all rows matched to A */\\n```\\n\\nThe `count` function in a row pattern recognition context allows special syntax\\nto support the `count(*)` behavior over a limited set of rows:\\n\\n```\\ncount(A.*) /* count rows matched to A */\\n\\ncount(U.*) /* count rows matched to pattern variables from subset U */\\n```\\n\\n(running-and-final)=\"}, \"`RUNNING` and `FINAL` semantics\": \"During pattern matching in a sequence of rows, one row after another is\\nexamined to determine if it fits the pattern. At any step, a partial match is\\nknown, but it is not yet known what rows will be added in the future or what\\npattern variables they will be mapped to. So, when evaluating a boolean\\ncondition in the `DEFINE` clause for the current row, only the preceding part\\nof the match (plus the current row) is \\\"visible\\\". This is the `running`\\nsemantics.\\n\\nWhen evaluating expressions in the `MEASURES` clause, the match is complete.\\nIt is then possible to apply the `final` semantics. In the `final`\\nsemantics, the whole match is \\\"visible\\\" as from the position of the final row.\\n\\nIn the `MEASURES` clause, the `running` semantics can also be applied. When\\noutputting information row by row (as in `ALL ROWS PER MATCH`), the\\n`running` semantics evaluate expressions from the positions of consecutive\\nrows.\\n\\nThe `running` and `final` semantics are denoted by the keywords:\\n`RUNNING` and `FINAL`, preceding a logical navigation function `first` or\\n`last`, or an aggregate function:\\n\\n```\\nRUNNING LAST(A.totalprice)\\n\\nFINAL LAST(A.totalprice)\\n\\nRUNNING avg(A.totalprice)\\n\\nFINAL count(A.*)\\n```\\n\\nThe `running` semantics is default in `MEASURES` and `DEFINE` clauses.\\n`FINAL` can only be specified in the `MEASURES` clause.\\n\\nWith the option `ONE ROW PER MATCH`, row pattern measures are evaluated from\\nthe position of the final row in the match. Therefore, `running` and\\n`final` semantics are the same.\\n\\n(empty-matches-and-unmatched-rows)=\"}, \"Evaluating expressions in empty matches and unmatched rows\": \"An empty match occurs when the row pattern is successfully matched, but no\\npattern variables are assigned. The following pattern produces an empty match\\nfor every row:\\n\\n```\\nPATTERN(())\\n```\\n\\nWhen evaluating row pattern measures for an empty match:\\n\\n['all column references return `null`', 'all navigation operations return `null`', '`classifier` function returns `null`', '`match_number` function returns the sequential number of the match', 'all aggregate functions are evaluated over an empty set of rows']\\n\\nLike every match, an empty match has its starting row. All input values which\\nare to be output along with the measures (as explained in\\n{ref}`rows-per-match`), are the values from the starting row.\\n\\nAn unmatched row is a row that is neither part of any non-empty match nor the\\nstarting row of an empty match. With the option `ALL ROWS PER MATCH WITH\\nUNMATCHED ROWS`, a single output row is produced. In that row, all row pattern\\nmeasures are `null`. All input values which are to be output along with the\\nmeasures (as explained in {ref}`rows-per-match`), are the values from the\\nunmatched row. Using the `match_number` function as a measure can help\\ndifferentiate between an empty match and unmatched row.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 36]\"}, {\"title\": \"MERGE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nMERGE INTO target_table [ [ AS ] target_alias ]\\nUSING { source_table | query } [ [ AS ] source_alias ]\\nON search_condition\\nwhen_clause [...]\\n```\\n\\nwhere `when_clause` is one of\\n\\n```\\nWHEN MATCHED [ AND condition ]\\n THEN DELETE\\n```\\n\\n```\\nWHEN MATCHED [ AND condition ]\\n THEN UPDATE SET ( column = expression [, ...] )\\n```\\n\\n```\\nWHEN NOT MATCHED [ AND condition ]\\n THEN INSERT [ column_list ] VALUES (expression, ...)\\n```\", \"Description\": \"Conditionally update and/or delete rows of a table and/or insert new\\nrows into a table.\\n\\n`MERGE` changes data in the `target_table` based on the contents of the\\n`source_table`. The `search_condition` defines a condition, such as a relation\\nfrom identical columns, to associate the source and target data.\\n\\n`MERGE` supports an arbitrary number of `WHEN` clauses. `MATCHED` conditions can\\nexecute `DELETE` or `UPDATE` operations on the target data, while `NOT MATCHED`\\nconditions can add data from the source to the target table with `INSERT`.\\nAdditional conditions can narrow down the affected rows.\\n\\nFor each source row, the `WHEN` clauses are processed in order. Only the first\\nmatching `WHEN` clause is executed and subsequent clauses are ignored. The query\\nfails if a single target table row matches more than one source row.\\n\\nIn `WHEN` clauses with `UPDATE` operations, the column value expressions\\ncan depend on any field of the target or the source. In the `NOT MATCHED`\\ncase, the `INSERT` expressions can depend on any field of the source.\\n\\nTypical usage of `MERGE` involves two tables with similar structure, containing\\ndifferent data. For example, the source table is part of a transactional usage\\nin a production system, while the target table is located in a data warehouse\\nused for analytics. Periodically, `MERGE` operations are run to combine recent\\nproduction data with long-term data in the analytics warehouse. As long as you\\ncan define a search condition between the two tables, you can also use very\\ndifferent tables.\", \"Examples\": \"Delete all customers mentioned in the source table:\\n\\n```\\nMERGE INTO accounts t USING monthly_accounts_update s\\n ON t.customer = s.customer\\n WHEN MATCHED\\n THEN DELETE\\n```\\n\\nFor matching customer rows, increment the purchases, and if there is no\\nmatch, insert the row from the source table:\\n\\n```\\nMERGE INTO accounts t USING monthly_accounts_update s\\n ON (t.customer = s.customer)\\n WHEN MATCHED\\n THEN UPDATE SET purchases = s.purchases + t.purchases\\n WHEN NOT MATCHED\\n THEN INSERT (customer, purchases, address)\\n VALUES(s.customer, s.purchases, s.address)\\n```\\n\\n`MERGE` into the target table from the source table, deleting any matching\\ntarget row for which the source address is `Centreville`. For all other matching\\nrows, add the source purchases and set the address to the source address. If\\nthere is no match in the target table, insert the source table row:\\n\\n```\\nMERGE INTO accounts t USING monthly_accounts_update s\\n ON (t.customer = s.customer)\\n WHEN MATCHED AND s.address = 'Centreville'\\n THEN DELETE\\n WHEN MATCHED\\n THEN UPDATE\\n SET purchases = s.purchases + t.purchases, address = s.address\\n WHEN NOT MATCHED\\n THEN INSERT (customer, purchases, address)\\n VALUES(s.customer, s.purchases, s.address)\\n```\", \"Limitations\": \"Any connector can be used as a source table for a `MERGE` statement.\\nOnly connectors which support the `MERGE` statement can be the target of a\\nmerge operation. See the {doc}`connector documentation </connector>` for more\\ninformation.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 37]\"}, {\"title\": \"Row pattern recognition in window structures\", \"description\": null, \"content\": {\"Window with row pattern recognition\": \"**Window specification:**\\n\\n```\\n(\\n[ existing_window_name ]\\n[ PARTITION BY column [, ...] ]\\n[ ORDER BY column [, ...] ]\\n[ window_frame ]\\n)\\n```\\n\\n**Window frame:**\\n\\n```\\n[ MEASURES measure_definition [, ...] ]\\nframe_extent\\n[ AFTER MATCH skip_to ]\\n[ INITIAL | SEEK ]\\n[ PATTERN ( row_pattern ) ]\\n[ SUBSET subset_definition [, ...] ]\\n[ DEFINE variable_definition [, ...] ]\\n```\\n\\nGenerally, a window frame specifies the `frame_extent`, which defines the\\n\\\"sliding window\\\" of rows to be processed by a window function. It can be\\ndefined in terms of `ROWS`, `RANGE` or `GROUPS`.\\n\\nA window frame with row pattern recognition involves many other syntactical\\ncomponents, mandatory or optional, and enforces certain limitations on the\\n`frame_extent`.\\n\\n**Window frame with row pattern recognition:**\\n\\n```\\n[ MEASURES measure_definition [, ...] ]\\nROWS BETWEEN CURRENT ROW AND frame_end\\n[ AFTER MATCH skip_to ]\\n[ INITIAL | SEEK ]\\nPATTERN ( row_pattern )\\n[ SUBSET subset_definition [, ...] ]\\nDEFINE variable_definition [, ...]\\n```\", \"Description of the pattern recognition clauses\": \"The `frame_extent` with row pattern recognition must be defined in terms of\\n`ROWS`. The frame start must be at the `CURRENT ROW`, which limits the\\nallowed frame extent values to the following:\\n\\n```\\nROWS BETWEEN CURRENT ROW AND CURRENT ROW\\n\\nROWS BETWEEN CURRENT ROW AND <expression> FOLLOWING\\n\\nROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING\\n```\\n\\nFor every input row processed by the window, the portion of rows enclosed by\\nthe `frame_extent` limits the search area for row pattern recognition. Unlike\\nin `MATCH_RECOGNIZE`, where the pattern search can explore all rows until the\\npartition end, and all rows of the partition are available for computations, in\\nwindow structures the pattern matching can neither match rows nor retrieve\\ninput values outside the frame.\\n\\nBesides the `frame_extent`, pattern matching requires the `PATTERN` and\\n`DEFINE` clauses.\\n\\nThe `PATTERN` clause specifies a row pattern, which is a form of a regular\\nexpression with some syntactical extensions. The row pattern syntax is similar\\nto the {ref}`row pattern syntax in MATCH_RECOGNIZE<row-pattern-syntax>`.\\nHowever, the anchor patterns `^` and `$` are not allowed in a window\\nspecification.\\n\\nThe `DEFINE` clause defines the row pattern primary variables in terms of\\nboolean conditions that must be satisfied. It is similar to the\\n{ref}`DEFINE clause of MATCH_RECOGNIZE<row-pattern-variable-definitions>`.\\nThe only difference is that the window syntax does not support the\\n`MATCH_NUMBER` function.\\n\\nThe `MEASURES` clause is syntactically similar to the\\n{ref}`MEASURES clause of MATCH_RECOGNIZE<row-pattern-measures>`. The only\\nlimitation is that the `MATCH_NUMBER` function is not allowed. However, the\\nsemantics of this clause differs between `MATCH_RECOGNIZE` and window.\\nWhile in `MATCH_RECOGNIZE` every measure produces an output column, the\\nmeasures in window should be considered as **definitions** associated with the\\nwindow structure. They can be called over the window, in the same manner as\\nregular window functions:\\n\\n```\\nSELECT cust_key, value OVER w, label OVER w\\n FROM orders\\n WINDOW w AS (\\n PARTITION BY cust_key\\n ORDER BY order_date\\n MEASURES\\n RUNNING LAST(total_price) AS value,\\n CLASSIFIER() AS label\\n ROWS BETWEEN CURRENT ROW AND UNBOUNDED FOLLOWING\\n PATTERN (A B+ C+)\\n DEFINE\\n B AS B.value < PREV (B.value),\\n C AS C.value > PREV (C.value)\\n )\\n```\\n\\nMeasures defined in a window can be referenced in the `SELECT` clause and in\\nthe `ORDER BY` clause of the enclosing query.\\n\\nThe `RUNNING` and `FINAL` keywords are allowed in the `MEASURES` clause.\\nThey can precede a logical navigation function `FIRST` or `LAST`, or an\\naggregate function. However, they have no effect. Every computation is\\nperformed from the position of the final row of the match, so the semantics is\\neffectively `FINAL`.\\n\\nThe `AFTER MATCH SKIP` clause has the same syntax as the\\n{ref}`AFTER MATCH SKIP clause of MATCH_RECOGNIZE<after-match-skip>`.\\n\\nThe `INITIAL` or `SEEK` modifier is specific to row pattern recognition in\\nwindow. With `INITIAL`, which is the default, the pattern match for an input\\nrow can only be found starting from that row. With `SEEK`, if there is no\\nmatch starting from the current row, the engine tries to find a match starting\\nfrom subsequent rows within the frame. As a result, it is possible to associate\\nan input row with a match which is detached from that row.\\n\\nThe `SUBSET` clause is used to define {ref}`union variables\\n<row-pattern-union-variables>` as sets of primary pattern variables. You can\\nuse union variables to refer to a set of rows matched to any primary pattern\\nvariable from the subset:\\n\\n```\\nSUBSET U = (A, B)\\n```\\n\\nThe following expression returns the `total_price` value from the last row\\nmatched to either `A` or `B`:\\n\\n```\\nLAST(U.total_price)\\n```\\n\\nIf you want to refer to all rows of the match, there is no need to define a\\n`SUBSET` containing all pattern variables. There is an implicit *universal\\npattern variable* applied to any non prefixed column name and any\\n`CLASSIFIER` call without an argument. The following expression returns the\\n`total_price` value from the last matched row:\\n\\n```\\nLAST(total_price)\\n```\\n\\nThe following call returns the primary pattern variable of the first matched\\nrow:\\n\\n```\\nFIRST(CLASSIFIER())\\n```\\n\\nIn window, unlike in `MATCH_RECOGNIZE`, you cannot specify `ONE ROW PER\\nMATCH` or `ALL ROWS PER MATCH`. This is because all calls over window,\\nwhether they are regular window functions or measures, must comply with the\\nwindow semantics. A call over window is supposed to produce exactly one output\\nrow for every input row. And so, the output mode of pattern recognition in\\nwindow is a combination of `ONE ROW PER MATCH` and `WITH UNMATCHED ROWS`.\", \"Processing input with row pattern recognition\": \"Pattern recognition in window processes input rows in two different cases:\\n\\n['upon a row pattern measure call over the window:', '```\\\\nsome_measure OVER w\\\\n```', 'upon a window function call over the window:', '```\\\\nsum(total_price) OVER w\\\\n```']\\n\\nThe output row produced for each input row, consists of:\\n\\n['all values from the input row', 'the value of the called measure or window function, computed with respect to\\\\nthe pattern match associated with the row']\\n\\nProcessing the input can be described as the following sequence of steps:\\n\\n['Partition the input data accordingly to `PARTITION BY`', 'Order each partition by the `ORDER BY` expressions', \\\"For every row of the ordered partition:\\\\n: If the row is 'skipped' by a match of some previous row:\\\\n: - For a measure, produce a one-row output as for an unmatched row\\\\n- For a window function, evaluate the function over an empty frame\\\\nand produce a one-row output\\\", 'Otherwise:\\\\n: - Determine the frame extent\\\\n- Try match the row pattern starting from the current row within\\\\nthe frame extent\\\\n- If no match is found, and `SEEK` is specified, try to find a match\\\\nstarting from subsequent rows within the frame extent', \\\"If no match is found:\\\\n: - For a measure, produce a one-row output for an unmatched row\\\\n - For a window function, evaluate the function over an empty\\\\n frame and produce a one-row output\\\\n\\\\nOtherwise:\\\\n: - For a measure, produce a one-row output for the match\\\\n - For a window function, evaluate the function over a frame\\\\n limited to the matched rows sequence and produce a one-row\\\\n output\\\\n - Evaluate the `AFTER MATCH SKIP` clause, and mark the 'skipped'\\\\n rows\\\\n\\\"]\", \"Empty matches and unmatched rows\": \"If no match can be associated with a particular input row, the row is\\n*unmatched*. This happens when no match can be found for the row. This also\\nhappens when no match is attempted for the row, because it is skipped by the\\n`AFTER MATCH SKIP` clause of some preceding row. For an unmatched row,\\nevery row pattern measure is `null`. Every window function is evaluated over\\nan empty frame.\\n\\nAn *empty match* is a successful match which does not involve any pattern\\nvariables. In other words, an empty match does not contain any rows. If an\\nempty match is associated with an input row, every row pattern measure for that\\nrow is evaluated over an empty sequence of rows. All navigation operations and\\nthe `CLASSIFIER` function return `null`. Every window function is evaluated\\nover an empty frame.\\n\\nIn most cases, the results for empty matches and unmatched rows are the same.\\nA constant measure can be helpful to distinguish between them:\\n\\nThe following call returns `'matched'` for every matched row, including empty\\nmatches, and `null` for every unmatched row:\\n\\n```\\nmatched OVER (\\n ...\\n MEASURES 'matched' AS matched\\n ...\\n )\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 38]\"}, {\"title\": \"PREPARE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nPREPARE statement_name FROM statement\\n```\", \"Description\": \"Prepares a statement for execution at a later time. Prepared statements are\\nqueries that are saved in a session with a given name. The statement can\\ninclude parameters in place of literals to be replaced at execution time.\\nParameters are represented by question marks.\", \"Examples\": \"Prepare a select query:\\n\\n```\\nPREPARE my_select1 FROM\\nSELECT * FROM nation;\\n```\\n\\nPrepare a select query that includes parameters. The values to compare with\\n`regionkey` and `nationkey` will be filled in with the {doc}`execute` statement:\\n\\n```\\nPREPARE my_select2 FROM\\nSELECT name FROM nation WHERE regionkey = ? AND nationkey < ?;\\n```\\n\\nPrepare an insert query:\\n\\n```\\nPREPARE my_insert FROM\\nINSERT INTO cities VALUES (1, 'San Francisco');\\n```\", \"See also\": \"{doc}`execute`, {doc}`deallocate-prepare`, {doc}`execute-immediate`, {doc}`describe-input`, {doc}`describe-output`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 39]\"}, {\"title\": \"REFRESH MATERIALIZED VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nREFRESH MATERIALIZED VIEW view_name\\n```\", \"Description\": \"Initially populate or refresh the data stored in the materialized view\\n`view_name`. The materialized view must be defined with\\n{doc}`create-materialized-view`. Data is retrieved from the underlying tables\\naccessed by the defined query.\\n\\nThe initial population of the materialized view is typically processing\\nintensive since it reads the data from the source tables and performs physical\\nwrite operations.\\n\\nThe refresh operation can be less intensive, if the underlying data has not\\nchanged and the connector has implemented a mechanism to be aware of that. The\\nspecific implementation and performance varies by connector used to create the\\nmaterialized view.\", \"See also\": [\"{doc}`create-materialized-view`\", \"{doc}`drop-materialized-view`\", \"{doc}`show-create-materialized-view`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 40]\"}, {\"title\": \"RESET SESSION AUTHORIZATION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nRESET SESSION AUTHORIZATION\\n```\", \"Description\": \"Resets the current authorization user back to the original user. The original\\nuser is usually the authenticated user (principal), or it can be the session\\nuser when the session user is provided by the client.\", \"See also\": \"[](set-session-authorization)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 41]\"}, {\"title\": \"RESET SESSION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nRESET SESSION name\\nRESET SESSION catalog.name\\n```\", \"Description\": \"Reset a {ref}`session property <session-properties-definition>` value to the\\ndefault value.\", \"Examples\": \"```\\nRESET SESSION query_max_run_time;\\nRESET SESSION hive.optimized_reader_enabled;\\n```\", \"See also\": \"{doc}`set-session`, {doc}`show-session`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 42]\"}, {\"title\": \"REVOKE role\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nREVOKE\\n[ ADMIN OPTION FOR ]\\nrole_name [, ...]\\nFROM ( user | USER user | ROLE role) [, ...]\\n[ GRANTED BY ( user | USER user | ROLE role | CURRENT_USER | CURRENT_ROLE ) ]\\n[ IN catalog ]\\n```\", \"Description\": \"Revokes the specified role(s) from the specified principal(s).\\n\\nIf the `ADMIN OPTION FOR` clause is specified, the `GRANT` permission is\\nrevoked instead of the role.\\n\\nFor the `REVOKE` statement for roles to succeed, the user executing it either should\\nbe the role admin or should possess the `GRANT` option for the given role.\\n\\nThe optional `GRANTED BY` clause causes the role(s) to be revoked with\\nthe specified principal as a revoker. If the `GRANTED BY` clause is not\\nspecified, the roles are revoked by the current user as a revoker.\\n\\nThe optional `IN catalog` clause revokes the roles in a catalog as opposed\\nto a system roles.\", \"Examples\": \"Revoke role `bar` from user `foo`\\n\\n```\\nREVOKE bar FROM USER foo;\\n```\\n\\nRevoke admin option for roles `bar` and `foo` from user `baz` and role `qux`\\n\\n```\\nREVOKE ADMIN OPTION FOR bar, foo FROM USER baz, ROLE qux;\\n```\", \"Limitations\": \"Some connectors do not support role management.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`create-role`, {doc}`drop-role`, {doc}`set-role`, {doc}`grant-roles`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 43]\"}, {\"title\": \"REVOKE privilege\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nREVOKE [ GRANT OPTION FOR ]\\n( privilege [, ...] | ALL PRIVILEGES )\\nON ( table_name | TABLE table_name | SCHEMA schema_name )\\nFROM ( user | USER user | ROLE role )\\n```\", \"Description\": \"Revokes the specified privileges from the specified grantee.\\n\\nSpecifying `ALL PRIVILEGES` revokes {doc}`delete`, {doc}`insert` and {doc}`select` privileges.\\n\\nSpecifying `ROLE PUBLIC` revokes privileges from the `PUBLIC` role. Users will retain privileges assigned to them directly or via other roles.\\n\\nIf the optional `GRANT OPTION FOR` clause is specified, only the `GRANT OPTION`\\nis removed. Otherwise, both the `GRANT` and `GRANT OPTION` are revoked.\\n\\nFor `REVOKE` statement to succeed, the user executing it should possess the specified privileges as well as the `GRANT OPTION` for those privileges.\\n\\nRevoke on a table revokes the specified privilege on all columns of the table.\\n\\nRevoke on a schema revokes the specified privilege on all columns of all tables of the schema.\", \"Examples\": \"Revoke `INSERT` and `SELECT` privileges on the table `orders` from user `alice`:\\n\\n```\\nREVOKE INSERT, SELECT ON orders FROM alice;\\n```\\n\\nRevoke `DELETE` privilege on the schema `finance` from user `bob`:\\n\\n```\\nREVOKE DELETE ON SCHEMA finance FROM bob;\\n```\\n\\nRevoke `SELECT` privilege on the table `nation` from everyone, additionally revoking the privilege to grant `SELECT` privilege:\\n\\n```\\nREVOKE GRANT OPTION FOR SELECT ON nation FROM ROLE PUBLIC;\\n```\\n\\nRevoke all privileges on the table `test` from user `alice`:\\n\\n```\\nREVOKE ALL PRIVILEGES ON test FROM alice;\\n```\", \"Limitations\": \"Some connectors have no support for `REVOKE`.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`deny`, {doc}`grant`, {doc}`show-grants`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 44]\"}, {\"title\": \"ROLLBACK\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nROLLBACK [ WORK ]\\n```\", \"Description\": \"Rollback the current transaction.\", \"Examples\": \"```\\nROLLBACK;\\nROLLBACK WORK;\\n```\", \"See also\": \"{doc}`commit`, {doc}`start-transaction`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 45]\"}, {\"title\": \"SELECT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\n[ WITH SESSION [ name = expression [, ...] ]\\n[ WITH [ FUNCTION udf ] [, ...] ]\\n[ WITH [ RECURSIVE ] with_query [, ...] ]\\nSELECT [ ALL | DISTINCT ] select_expression [, ...]\\n[ FROM from_item [, ...] ]\\n[ WHERE condition ]\\n[ GROUP BY [ ALL | DISTINCT ] grouping_element [, ...] ]\\n[ HAVING condition]\\n[ WINDOW window_definition_list]\\n[ { UNION | INTERSECT | EXCEPT } [ ALL | DISTINCT ] select ]\\n[ ORDER BY expression [ ASC | DESC ] [, ...] ]\\n[ OFFSET count [ ROW | ROWS ] ]\\n[ LIMIT { count | ALL } ]\\n[ FETCH { FIRST | NEXT } [ count ] { ROW | ROWS } { ONLY | WITH TIES } ]\\n```\\n\\nwhere `from_item` is one of\\n\\n```\\ntable_name [ [ AS ] alias [ ( column_alias [, ...] ) ] ]\\n```\\n\\n```\\nfrom_item join_type from_item\\n [ ON join_condition | USING ( join_column [, ...] ) ]\\n```\\n\\n```\\ntable_name [ [ AS ] alias [ ( column_alias [, ...] ) ] ]\\n MATCH_RECOGNIZE pattern_recognition_specification\\n [ [ AS ] alias [ ( column_alias [, ...] ) ] ]\\n```\\n\\nFor detailed description of `MATCH_RECOGNIZE` clause, see {doc}`pattern\\nrecognition in FROM clause</sql/match-recognize>`.\\n\\n```\\nTABLE (table_function_invocation) [ [ AS ] alias [ ( column_alias [, ...] ) ] ]\\n```\\n\\nFor description of table functions usage, see {doc}`table functions</functions/table>`.\\n\\nand `join_type` is one of\\n\\n```\\n[ INNER ] JOIN\\nLEFT [ OUTER ] JOIN\\nRIGHT [ OUTER ] JOIN\\nFULL [ OUTER ] JOIN\\nCROSS JOIN\\n```\\n\\nand `grouping_element` is one of\\n\\n```\\n()\\nexpression\\nAUTO\\nGROUPING SETS ( ( column [, ...] ) [, ...] )\\nCUBE ( column [, ...] )\\nROLLUP ( column [, ...] )\\n```\", \"Description\": \"Retrieve rows from zero or more tables.\\n\\n(select-with-session)=\", \"WITH SESSION clause\": \"The `WITH SESSION` clause allows you to [set session and catalog session\\nproperty values](/sql/set-session) applicable for the processing of the current\\nSELECT statement only. The defined values override any other configuration and\\nsession property settings. Multiple properties are separated by commas.\\n\\nThe following example overrides the global configuration property\\n`query.max-execution-time` with the session property `query_max_execution_time`\\nto reduce the time to `2h`. It also overrides the catalog property\\n`iceberg.query-partition-filter-required` from the `example` catalog using\\n[](/connector/iceberg) setting the catalog session property\\n`query_partition_filter_required` to `true`:\\n\\n```\\nWITH\\n SESSION\\n query_max_execution_time='2h',\\n example.query_partition_filter_required=true\\nSELECT *\\nFROM example.default.thetable\\nLIMIT 100;\\n```\", \"WITH FUNCTION clause\": \"The `WITH FUNCTION` clause allows you to define a list of [](udf-inline) that\\nare available for use in the rest of the query.\\n\\nThe following example declares and uses two inline UDFs:\\n\\n```\\nWITH \\n FUNCTION hello(name varchar)\\n RETURNS varchar\\n RETURN format('Hello %s!', 'name'),\\n FUNCTION bye(name varchar)\\n RETURNS varchar\\n RETURN format('Bye %s!', 'name')\\nSELECT hello('Finn') || ' and ' || bye('Joe');\\n-- Hello Finn! and Bye Joe!\\n```\\n\\nFind further information about UDFs in general, inline UDFs, all supported\\nstatements, and examples in [](/udf).\", \"WITH clause\": \"The `WITH` clause defines named relations for use within a query.\\nIt allows flattening nested queries or simplifying subqueries.\\nFor example, the following queries are equivalent:\\n\\n```\\nSELECT a, b\\nFROM (\\n SELECT a, MAX(b) AS b FROM t GROUP BY a\\n) AS x;\\n\\nWITH x AS (SELECT a, MAX(b) AS b FROM t GROUP BY a)\\nSELECT a, b FROM x;\\n```\\n\\nThis also works with multiple subqueries:\\n\\n```\\nWITH\\n t1 AS (SELECT a, MAX(b) AS b FROM x GROUP BY a),\\n t2 AS (SELECT a, AVG(d) AS d FROM y GROUP BY a)\\nSELECT t1.*, t2.*\\nFROM t1\\nJOIN t2 ON t1.a = t2.a;\\n```\\n\\nAdditionally, the relations within a `WITH` clause can chain:\\n\\n```\\nWITH\\n x AS (SELECT a FROM t),\\n y AS (SELECT a AS b FROM x),\\n z AS (SELECT b AS c FROM y)\\nSELECT c FROM z;\\n```\\n\\n:::{warning}\\nCurrently, the SQL for the `WITH` clause will be inlined anywhere the named\\nrelation is used. This means that if the relation is used more than once and the query\\nis non-deterministic, the results may be different each time.\\n:::\", \"WITH RECURSIVE clause\": \"The `WITH RECURSIVE` clause is a variant of the `WITH` clause. It defines\\na list of queries to process, including recursive processing of suitable\\nqueries.\\n\\n:::{warning}\\nThis feature is experimental only. Proceed to use it only if you understand\\npotential query failures and the impact of the recursion processing on your\\nworkload.\\n:::\\n\\nA recursive `WITH`-query must be shaped as a `UNION` of two relations. The\\nfirst relation is called the *recursion base*, and the second relation is called\\nthe *recursion step*. Trino supports recursive `WITH`-queries with a single\\nrecursive reference to a `WITH`-query from within the query. The name `T` of\\nthe query `T` can be mentioned once in the `FROM` clause of the recursion\\nstep relation.\\n\\nThe following listing shows a simple example, that displays a commonly used\\nform of a single query in the list:\\n\\n```\\nWITH RECURSIVE t(n) AS (\\n VALUES (1)\\n UNION ALL\\n SELECT n + 1 FROM t WHERE n < 4\\n)\\nSELECT sum(n) FROM t;\\n```\\n\\nIn the preceding query the simple assignment `VALUES (1)` defines the\\nrecursion base relation. `SELECT n + 1 FROM t WHERE n < 4` defines the\\nrecursion step relation. The recursion processing performs these steps:\\n\\n['recursive base yields `1`', 'first recursion yields `1 + 1 = 2`', 'second recursion uses the result from the first and adds one: `2 + 1 = 3`', 'third recursion uses the result from the second and adds one again:\\\\n`3 + 1 = 4`', 'fourth recursion aborts since `n = 4`', 'this results in `t` having values `1`, `2`, `3` and `4`', 'the final statement performs the sum operation of these elements with the\\\\nfinal result value `10`']\\n\\nThe types of the returned columns are those of the base relation. Therefore it\\nis required that types in the step relation can be coerced to base relation\\ntypes.\\n\\nThe `RECURSIVE` clause applies to all queries in the `WITH` list, but not\\nall of them must be recursive. If a `WITH`-query is not shaped according to\\nthe rules mentioned above or it does not contain a recursive reference, it is\\nprocessed like a regular `WITH`-query. Column aliases are mandatory for all\\nthe queries in the recursive `WITH` list.\\n\\nThe following limitations apply as a result of following the SQL standard and\\ndue to implementation choices, in addition to `WITH` clause limitations:\\n\\n['only single-element recursive cycles are supported. Like in regular\\\\n`WITH`-queries, references to previous queries in the `WITH` list are\\\\nallowed. References to following queries are forbidden.', 'usage of outer joins, set operations, limit clause, and others is not always\\\\nallowed in the step relation', \\\"recursion depth is fixed, defaults to `10`, and doesn't depend on the actual\\\\nquery results\\\"]\\n\\nYou can adjust the recursion depth with the {doc}`session property\\n</sql/set-session>` `max_recursion_depth`. When changing the value consider\\nthat the size of the query plan growth is quadratic with the recursion depth.\", \"SELECT clause\": {\"Select expressions\": \"Each `select_expression` must be in one of the following forms:\\n\\n```\\nexpression [ [ AS ] column_alias ]\\n```\\n\\n```\\nrow_expression.* [ AS ( column_alias [, ...] ) ]\\n```\\n\\n```\\nrelation.*\\n```\\n\\n```\\n*\\n```\\n\\nIn the case of `expression [ [ AS ] column_alias ]`, a single output column\\nis defined.\\n\\nIn the case of `row_expression.* [ AS ( column_alias [, ...] ) ]`,\\nthe `row_expression` is an arbitrary expression of type `ROW`.\\nAll fields of the row define output columns to be included in the result set.\\n\\nIn the case of `relation.*`, all columns of `relation` are included\\nin the result set. In this case column aliases are not allowed.\\n\\nIn the case of `*`, all columns of the relation defined by the query\\nare included in the result set.\\n\\nIn the result set, the order of columns is the same as the order of their\\nspecification by the select expressions. If a select expression returns multiple\\ncolumns, they are ordered the same way they were ordered in the source\\nrelation or row type expression.\\n\\nIf column aliases are specified, they override any preexisting column\\nor row field names:\\n\\n```\\nSELECT (CAST(ROW(1, true) AS ROW(field1 bigint, field2 boolean))).* AS (alias1, alias2);\\n```\\n\\n```\\n alias1 | alias2\\n--------+--------\\n 1 | true\\n(1 row)\\n```\\n\\nOtherwise, the existing names are used:\\n\\n```\\nSELECT (CAST(ROW(1, true) AS ROW(field1 bigint, field2 boolean))).*;\\n```\\n\\n```\\n field1 | field2\\n--------+--------\\n 1 | true\\n(1 row)\\n```\\n\\nand in their absence, anonymous columns are produced:\\n\\n```\\nSELECT (ROW(1, true)).*;\\n```\\n\\n```\\n _col0 | _col1\\n-------+-------\\n 1 | true\\n(1 row)\\n```\"}, \"GROUP BY clause\": {\"Complex grouping operations\": \"Trino also supports complex aggregations using the `GROUPING SETS`, `CUBE`\\nand `ROLLUP` syntax. This syntax allows users to perform analysis that requires\\naggregation on multiple sets of columns in a single query. Complex grouping\\noperations do not support grouping on expressions composed of input columns.\\nOnly column names are allowed.\\n\\nComplex grouping operations are often equivalent to a `UNION ALL` of simple\\n`GROUP BY` expressions, as shown in the following examples. This equivalence\\ndoes not apply, however, when the source of data for the aggregation\\nis non-deterministic.\", \"GROUPING SETS\": \"Grouping sets allow users to specify multiple lists of columns to group on.\\nThe columns not part of a given sublist of grouping columns are set to `NULL`.\\n\\n```\\nSELECT * FROM shipping;\\n```\\n\\n```\\n origin_state | origin_zip | destination_state | destination_zip | package_weight\\n--------------+------------+-------------------+-----------------+----------------\\n California | 94131 | New Jersey | 8648 | 13\\n California | 94131 | New Jersey | 8540 | 42\\n New Jersey | 7081 | Connecticut | 6708 | 225\\n California | 90210 | Connecticut | 6927 | 1337\\n California | 94131 | Colorado | 80302 | 5\\n New York | 10002 | New Jersey | 8540 | 3\\n(6 rows)\\n```\\n\\n`GROUPING SETS` semantics are demonstrated by this example query:\\n\\n```\\nSELECT origin_state, origin_zip, destination_state, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state),\\n (origin_state, origin_zip),\\n (destination_state));\\n```\\n\\n```\\n origin_state | origin_zip | destination_state | _col0\\n--------------+------------+-------------------+-------\\n New Jersey | NULL | NULL | 225\\n California | NULL | NULL | 1397\\n New York | NULL | NULL | 3\\n California | 90210 | NULL | 1337\\n California | 94131 | NULL | 60\\n New Jersey | 7081 | NULL | 225\\n New York | 10002 | NULL | 3\\n NULL | NULL | Colorado | 5\\n NULL | NULL | New Jersey | 58\\n NULL | NULL | Connecticut | 1562\\n(10 rows)\\n```\\n\\nThe preceding query may be considered logically equivalent to a `UNION ALL` of\\nmultiple `GROUP BY` queries:\\n\\n```\\nSELECT origin_state, NULL, NULL, sum(package_weight)\\nFROM shipping GROUP BY origin_state\\n\\nUNION ALL\\n\\nSELECT origin_state, origin_zip, NULL, sum(package_weight)\\nFROM shipping GROUP BY origin_state, origin_zip\\n\\nUNION ALL\\n\\nSELECT NULL, NULL, destination_state, sum(package_weight)\\nFROM shipping GROUP BY destination_state;\\n```\\n\\nHowever, the query with the complex grouping syntax (`GROUPING SETS`, `CUBE`\\nor `ROLLUP`) will only read from the underlying data source once, while the\\nquery with the `UNION ALL` reads the underlying data three times. This is why\\nqueries with a `UNION ALL` may produce inconsistent results when the data\\nsource is not deterministic.\", \"CUBE\": \"The `CUBE` operator generates all possible grouping sets (i.e. a power set)\\nfor a given set of columns. For example, the query:\\n\\n```\\nSELECT origin_state, destination_state, sum(package_weight)\\nFROM shipping\\nGROUP BY CUBE (origin_state, destination_state);\\n```\\n\\nis equivalent to:\\n\\n```\\nSELECT origin_state, destination_state, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state, destination_state),\\n (origin_state),\\n (destination_state),\\n ()\\n);\\n```\\n\\n```\\n origin_state | destination_state | _col0\\n--------------+-------------------+-------\\n California | New Jersey | 55\\n California | Colorado | 5\\n New York | New Jersey | 3\\n New Jersey | Connecticut | 225\\n California | Connecticut | 1337\\n California | NULL | 1397\\n New York | NULL | 3\\n New Jersey | NULL | 225\\n NULL | New Jersey | 58\\n NULL | Connecticut | 1562\\n NULL | Colorado | 5\\n NULL | NULL | 1625\\n(12 rows)\\n```\", \"ROLLUP\": \"The `ROLLUP` operator generates all possible subtotals for a given set of\\ncolumns. For example, the query:\\n\\n```\\nSELECT origin_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY ROLLUP (origin_state, origin_zip);\\n```\\n\\n```\\n origin_state | origin_zip | _col2\\n--------------+------------+-------\\n California | 94131 | 60\\n California | 90210 | 1337\\n New Jersey | 7081 | 225\\n New York | 10002 | 3\\n California | NULL | 1397\\n New York | NULL | 3\\n New Jersey | NULL | 225\\n NULL | NULL | 1625\\n(8 rows)\\n```\\n\\nis equivalent to:\\n\\n```\\nSELECT origin_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS ((origin_state, origin_zip), (origin_state), ());\\n```\", \"Combining multiple grouping expressions\": \"Multiple grouping expressions in the same query are interpreted as having\\ncross-product semantics. For example, the following query:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY\\n GROUPING SETS ((origin_state, destination_state)),\\n ROLLUP (origin_zip);\\n```\\n\\nwhich can be rewritten as:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY\\n GROUPING SETS ((origin_state, destination_state)),\\n GROUPING SETS ((origin_zip), ());\\n```\\n\\nis logically equivalent to:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state, destination_state, origin_zip),\\n (origin_state, destination_state)\\n);\\n```\\n\\n```\\n origin_state | destination_state | origin_zip | _col3\\n--------------+-------------------+------------+-------\\n New York | New Jersey | 10002 | 3\\n California | New Jersey | 94131 | 55\\n New Jersey | Connecticut | 7081 | 225\\n California | Connecticut | 90210 | 1337\\n California | Colorado | 94131 | 5\\n New York | New Jersey | NULL | 3\\n New Jersey | Connecticut | NULL | 225\\n California | Colorado | NULL | 5\\n California | Connecticut | NULL | 1337\\n California | New Jersey | NULL | 55\\n(10 rows)\\n```\\n\\nThe `ALL` and `DISTINCT` quantifiers determine whether duplicate grouping\\nsets each produce distinct output rows. This is particularly useful when\\nmultiple complex grouping sets are combined in the same query. For example, the\\nfollowing query:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY ALL\\n CUBE (origin_state, destination_state),\\n ROLLUP (origin_state, origin_zip);\\n```\\n\\nis equivalent to:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state, destination_state, origin_zip),\\n (origin_state, origin_zip),\\n (origin_state, destination_state, origin_zip),\\n (origin_state, origin_zip),\\n (origin_state, destination_state),\\n (origin_state),\\n (origin_state, destination_state),\\n (origin_state),\\n (origin_state, destination_state),\\n (origin_state),\\n (destination_state),\\n ()\\n);\\n```\\n\\nHowever, if the query uses the `DISTINCT` quantifier for the `GROUP BY`:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY DISTINCT\\n CUBE (origin_state, destination_state),\\n ROLLUP (origin_state, origin_zip);\\n```\\n\\nonly unique grouping sets are generated:\\n\\n```\\nSELECT origin_state, destination_state, origin_zip, sum(package_weight)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state, destination_state, origin_zip),\\n (origin_state, origin_zip),\\n (origin_state, destination_state),\\n (origin_state),\\n (destination_state),\\n ()\\n);\\n```\\n\\nThe default set quantifier is `ALL`.\", \"GROUPING operation\": \"`grouping(col1, ..., colN) -> bigint`\\n\\nThe grouping operation returns a bit set converted to decimal, indicating which columns are present in a\\ngrouping. It must be used in conjunction with `GROUPING SETS`, `ROLLUP`, `CUBE` or `GROUP BY`\\nand its arguments must match exactly the columns referenced in the corresponding `GROUPING SETS`,\\n`ROLLUP`, `CUBE` or `GROUP BY` clause.\\n\\nTo compute the resulting bit set for a particular row, bits are assigned to the argument columns with\\nthe rightmost column being the least significant bit. For a given grouping, a bit is set to 0 if the\\ncorresponding column is included in the grouping and to 1 otherwise. For example, consider the query\\nbelow:\\n\\n```\\nSELECT origin_state, origin_zip, destination_state, sum(package_weight),\\n grouping(origin_state, origin_zip, destination_state)\\nFROM shipping\\nGROUP BY GROUPING SETS (\\n (origin_state),\\n (origin_state, origin_zip),\\n (destination_state)\\n);\\n```\\n\\n```\\norigin_state | origin_zip | destination_state | _col3 | _col4\\n--------------+------------+-------------------+-------+-------\\nCalifornia | NULL | NULL | 1397 | 3\\nNew Jersey | NULL | NULL | 225 | 3\\nNew York | NULL | NULL | 3 | 3\\nCalifornia | 94131 | NULL | 60 | 1\\nNew Jersey | 7081 | NULL | 225 | 1\\nCalifornia | 90210 | NULL | 1337 | 1\\nNew York | 10002 | NULL | 3 | 1\\nNULL | NULL | New Jersey | 58 | 6\\nNULL | NULL | Connecticut | 1562 | 6\\nNULL | NULL | Colorado | 5 | 6\\n(10 rows)\\n```\\n\\nThe first grouping in the above result only includes the `origin_state` column and excludes\\nthe `origin_zip` and `destination_state` columns. The bit set constructed for that grouping\\nis `011` where the most significant bit represents `origin_state`.\"}, \"HAVING clause\": \"The `HAVING` clause is used in conjunction with aggregate functions and\\nthe `GROUP BY` clause to control which groups are selected. A `HAVING`\\nclause eliminates groups that do not satisfy the given conditions.\\n`HAVING` filters groups after groups and aggregates are computed.\\n\\nThe following example queries the `customer` table and selects groups\\nwith an account balance greater than the specified value:\\n\\n```\\nSELECT count(*), mktsegment, nationkey,\\n CAST(sum(acctbal) AS bigint) AS totalbal\\nFROM customer\\nGROUP BY mktsegment, nationkey\\nHAVING sum(acctbal) > 5700000\\nORDER BY totalbal DESC;\\n```\\n\\n```\\n _col0 | mktsegment | nationkey | totalbal\\n-------+------------+-----------+----------\\n 1272 | AUTOMOBILE | 19 | 5856939\\n 1253 | FURNITURE | 14 | 5794887\\n 1248 | FURNITURE | 9 | 5784628\\n 1243 | FURNITURE | 12 | 5757371\\n 1231 | HOUSEHOLD | 3 | 5753216\\n 1251 | MACHINERY | 2 | 5719140\\n 1247 | FURNITURE | 8 | 5701952\\n(7 rows)\\n```\\n\\n(window-clause)=\", \"WINDOW clause\": \"The `WINDOW` clause is used to define named window specifications. The defined named\\nwindow specifications can be referred to in the `SELECT` and `ORDER BY` clauses\\nof the enclosing query:\\n\\n```\\nSELECT orderkey, clerk, totalprice,\\n rank() OVER w AS rnk\\nFROM orders\\nWINDOW w AS (PARTITION BY clerk ORDER BY totalprice DESC)\\nORDER BY count() OVER w, clerk, rnk\\n```\\n\\nThe window definition list of `WINDOW` clause can contain one or multiple named window\\nspecifications of the form\\n\\n```\\nwindow_name AS (window_specification)\\n```\\n\\nA window specification has the following components:\\n\\n['The existing window name, which refers to a named window specification in the\\\\n`WINDOW` clause. The window specification associated with the referenced name\\\\nis the basis of the current specification.', 'The partition specification, which separates the input rows into different\\\\npartitions. This is analogous to how the `GROUP BY` clause separates rows\\\\ninto different groups for aggregate functions.', 'The ordering specification, which determines the order in which input rows\\\\nwill be processed by the window function.', 'The window frame, which specifies a sliding window of rows to be processed\\\\nby the function for a given row. If the frame is not specified, it defaults\\\\nto `RANGE UNBOUNDED PRECEDING`, which is the same as\\\\n`RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW`. This frame contains all\\\\nrows from the start of the partition up to the last peer of the current row.\\\\nIn the absence of `ORDER BY`, all rows are considered peers, so `RANGE\\\\nBETWEEN UNBOUNDED PRECEDING AND CURRENT ROW` is equivalent to `BETWEEN\\\\nUNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING`. The window frame syntax\\\\nsupports additional clauses for row pattern recognition. If the row pattern\\\\nrecognition clauses are specified, the window frame for a particular row\\\\nconsists of the rows matched by a pattern starting from that row.\\\\nAdditionally, if the frame specifies row pattern measures, they can be\\\\ncalled over the window, similarly to window functions. For more details, see\\\\n[Row pattern recognition in window structures](/sql/pattern-recognition-in-window) .']\\n\\nEach window component is optional. If a window specification does not specify\\nwindow partitioning, ordering or frame, those components are obtained from\\nthe window specification referenced by the `existing window name`, or from\\nanother window specification in the reference chain. In case when there is no\\n`existing window name` specified, or none of the referenced window\\nspecifications contains the component, the default value is used.\", \"Set operations\": {\"UNION clause\": \"`UNION` combines all the rows that are in the result set from the\\nfirst query with those that are in the result set for the second query.\\nThe following is an example of one of the simplest possible `UNION` clauses.\\nIt selects the value `13` and combines this result set with a second query\\nthat selects the value `42`:\\n\\n```\\nSELECT 13\\nUNION\\nSELECT 42;\\n```\\n\\n```\\n _col0\\n-------\\n 13\\n 42\\n(2 rows)\\n```\\n\\nThe following query demonstrates the difference between `UNION` and `UNION ALL`.\\nIt selects the value `13` and combines this result set with a second query that\\nselects the values `42` and `13`:\\n\\n```\\nSELECT 13\\nUNION\\nSELECT * FROM (VALUES 42, 13);\\n```\\n\\n```\\n _col0\\n-------\\n 13\\n 42\\n(2 rows)\\n```\\n\\n```\\nSELECT 13\\nUNION ALL\\nSELECT * FROM (VALUES 42, 13);\\n```\\n\\n```\\n _col0\\n-------\\n 13\\n 42\\n 13\\n(2 rows)\\n```\\n\\n`CORRESPONDING` matches columns by name instead of by position:\\n\\n```\\nSELECT * FROM (VALUES (1, 'alice')) AS t(id, name)\\nUNION ALL CORRESPONDING\\nSELECT * FROM (VALUES ('bob', 2)) AS t(name, id);\\n```\\n\\n```\\n id | name\\n----+-------\\n 1 | alice\\n 2 | bob\\n(2 rows)\\n```\\n\\n```\\nSELECT * FROM (VALUES (DATE '2025-04-23', 'alice')) AS t(order_date, name)\\nUNION ALL CORRESPONDING\\nSELECT * FROM (VALUES ('bob', 123.45)) AS t(name, price);\\n```\\n\\n```\\n name\\n-------\\n alice\\n bob\\n(2 rows)\\n```\", \"INTERSECT clause\": \"`INTERSECT` returns only the rows that are in the result sets of both the first and\\nthe second queries. The following is an example of one of the simplest\\npossible `INTERSECT` clauses. It selects the values `13` and `42` and combines\\nthis result set with a second query that selects the value `13`. Since `42`\\nis only in the result set of the first query, it is not included in the final results.:\\n\\n```\\nSELECT * FROM (VALUES 13, 42)\\nINTERSECT\\nSELECT 13;\\n```\\n\\n```\\n _col0\\n-------\\n 13\\n(2 rows)\\n```\\n\\n`CORRESPONDING` matches columns by name instead of by position:\\n\\n```\\nSELECT * FROM (VALUES (1, 'alice')) AS t(id, name)\\nINTERSECT CORRESPONDING\\nSELECT * FROM (VALUES ('alice', 1)) AS t(name, id);\\n```\\n\\n```\\n id | name\\n----+-------\\n 1 | alice\\n(1 row)\\n```\", \"EXCEPT clause\": \"`EXCEPT` returns the rows that are in the result set of the first query,\\nbut not the second. The following is an example of one of the simplest\\npossible `EXCEPT` clauses. It selects the values `13` and `42` and combines\\nthis result set with a second query that selects the value `13`. Since `13`\\nis also in the result set of the second query, it is not included in the final result.:\\n\\n```\\nSELECT * FROM (VALUES 13, 42)\\nEXCEPT\\nSELECT 13;\\n```\\n\\n```\\n _col0\\n-------\\n 42\\n(2 rows)\\n```\\n\\n`CORRESPONDING` matches columns by name instead of by position:\\n\\n```\\nSELECT * FROM (VALUES (1, 'alice'), (2, 'bob')) AS t(id, name)\\nEXCEPT CORRESPONDING\\nSELECT * FROM (VALUES ('alice', 1)) AS t(name, id);\\n```\\n\\n```\\n id | name\\n----+------\\n 2 | bob\\n(1 row)\\n```\\n\\n(order-by-clause)=\"}, \"ORDER BY clause\": \"The `ORDER BY` clause is used to sort a result set by one or more\\noutput expressions:\\n\\n```\\nORDER BY expression [ ASC | DESC ] [ NULLS { FIRST | LAST } ] [, ...]\\n```\\n\\nEach expression may be composed of output columns, or it may be an ordinal\\nnumber selecting an output column by position, starting at one. The\\n`ORDER BY` clause is evaluated after any `GROUP BY` or `HAVING` clause,\\nand before any `OFFSET`, `LIMIT` or `FETCH FIRST` clause.\\nThe default null ordering is `NULLS LAST`, regardless of the ordering direction.\\n\\nNote that, following the SQL specification, an `ORDER BY` clause only\\naffects the order of rows for queries that immediately contain the clause.\\nTrino follows that specification, and drops redundant usage of the clause to\\navoid negative performance impacts.\\n\\nIn the following example, the clause only applies to the select statement.\\n\\n```\\nINSERT INTO some_table\\nSELECT * FROM another_table\\nORDER BY field;\\n```\\n\\nSince tables in SQL are inherently unordered, and the `ORDER BY` clause in\\nthis case does not result in any difference, but negatively impacts performance\\nof running the overall insert statement, Trino skips the sort operation.\\n\\nAnother example where the `ORDER BY` clause is redundant, and does not affect\\nthe outcome of the overall statement, is a nested query:\\n\\n```\\nSELECT *\\nFROM some_table\\n JOIN (SELECT * FROM another_table ORDER BY field) u\\n ON some_table.key = u.key;\\n```\\n\\nMore background information and details can be found in\\n[a blog post about this optimization](https://trino.io/blog/2019/06/03/redundant-order-by.html).\\n\\n(offset-clause)=\", \"OFFSET clause\": \"The `OFFSET` clause is used to discard a number of leading rows\\nfrom the result set:\\n\\n```\\nOFFSET count [ ROW | ROWS ]\\n```\\n\\nIf the `ORDER BY` clause is present, the `OFFSET` clause is evaluated\\nover a sorted result set, and the set remains sorted after the\\nleading rows are discarded:\\n\\n```\\nSELECT name FROM nation ORDER BY name OFFSET 22;\\n```\\n\\n```\\n name\\n----------------\\n UNITED KINGDOM\\n UNITED STATES\\n VIETNAM\\n(3 rows)\\n```\\n\\nOtherwise, it is arbitrary which rows are discarded.\\nIf the count specified in the `OFFSET` clause equals or exceeds the size\\nof the result set, the final result is empty.\\n\\n(limit-clause)=\", \"LIMIT or FETCH FIRST clause\": \"The `LIMIT` or `FETCH FIRST` clause restricts the number of rows\\nin the result set.\\n\\n```\\nLIMIT { count | ALL }\\n```\\n\\n```\\nFETCH { FIRST | NEXT } [ count ] { ROW | ROWS } { ONLY | WITH TIES }\\n```\\n\\nThe following example queries a large table, but the `LIMIT` clause\\nrestricts the output to only have five rows (because the query lacks an `ORDER BY`,\\nexactly which rows are returned is arbitrary):\\n\\n```\\nSELECT orderdate FROM orders LIMIT 5;\\n```\\n\\n```\\n orderdate\\n------------\\n 1994-07-25\\n 1993-11-12\\n 1992-10-06\\n 1994-01-04\\n 1997-12-28\\n(5 rows)\\n```\\n\\n`LIMIT ALL` is the same as omitting the `LIMIT` clause.\\n\\nThe `FETCH FIRST` clause supports either the `FIRST` or `NEXT` keywords\\nand the `ROW` or `ROWS` keywords. These keywords are equivalent and\\nthe choice of keyword has no effect on query execution.\\n\\nIf the count is not specified in the `FETCH FIRST` clause, it defaults to `1`:\\n\\n```\\nSELECT orderdate FROM orders FETCH FIRST ROW ONLY;\\n```\\n\\n```\\n orderdate\\n------------\\n 1994-02-12\\n(1 row)\\n```\\n\\nIf the `OFFSET` clause is present, the `LIMIT` or `FETCH FIRST` clause\\nis evaluated after the `OFFSET` clause:\\n\\n```\\nSELECT * FROM (VALUES 5, 2, 4, 1, 3) t(x) ORDER BY x OFFSET 2 LIMIT 2;\\n```\\n\\n```\\n x\\n---\\n 3\\n 4\\n(2 rows)\\n```\\n\\nFor the `FETCH FIRST` clause, the argument `ONLY` or `WITH TIES`\\ncontrols which rows are included in the result set.\\n\\nIf the argument `ONLY` is specified, the result set is limited to the exact\\nnumber of leading rows determined by the count.\\n\\nIf the argument `WITH TIES` is specified, it is required that the `ORDER BY`\\nclause be present. The result set consists of the same set of leading rows\\nand all of the rows in the same peer group as the last of them ('ties')\\nas established by the ordering in the `ORDER BY` clause. The result set is sorted:\\n\\n```\\nSELECT name, regionkey\\nFROM nation\\nORDER BY regionkey FETCH FIRST ROW WITH TIES;\\n```\\n\\n```\\n name | regionkey\\n------------+-----------\\n ETHIOPIA | 0\\n MOROCCO | 0\\n KENYA | 0\\n ALGERIA | 0\\n MOZAMBIQUE | 0\\n(5 rows)\\n```\\n\\n(tablesample)=\", \"TABLESAMPLE\": \"There are multiple sample methods:\\n\\n`BERNOULLI`\\n\\n: Each row is selected to be in the table sample with a probability of\\nthe sample percentage. When a table is sampled using the Bernoulli\\nmethod, all physical blocks of the table are scanned and certain\\nrows are skipped (based on a comparison between the sample percentage\\nand a random value calculated at runtime).\\n\\nThe probability of a row being included in the result is independent\\nfrom any other row. This does not reduce the time required to read\\nthe sampled table from disk. It may have an impact on the total\\nquery time if the sampled output is processed further.\\n\\n`SYSTEM`\\n\\n: This sampling method divides the table into logical segments of data\\nand samples the table at this granularity. This sampling method either\\nselects all the rows from a particular segment of data or skips it\\n(based on a comparison between the sample percentage and a random\\nvalue calculated at runtime).\\n\\nThe rows selected in a system sampling will be dependent on which\\nconnector is used. For example, when used with Hive, it is dependent\\non how the data is laid out on HDFS. This method does not guarantee\\nindependent sampling probabilities.\\n\\n:::{note}\\nNeither of the two methods allow deterministic bounds on the number of rows returned.\\n:::\\n\\nExamples:\\n\\n```\\nSELECT *\\nFROM users TABLESAMPLE BERNOULLI (50);\\n\\nSELECT *\\nFROM users TABLESAMPLE SYSTEM (75);\\n```\\n\\nUsing sampling with joins:\\n\\n```\\nSELECT o.*, i.*\\nFROM orders o TABLESAMPLE SYSTEM (10)\\nJOIN lineitem i TABLESAMPLE BERNOULLI (40)\\n ON o.orderkey = i.orderkey;\\n```\\n\\n(unnest)=\", \"UNNEST\": \"`UNNEST` can be used to expand an {ref}`array-type` or {ref}`map-type` into a relation.\\nArrays are expanded into a single column:\\n\\n```\\nSELECT * FROM UNNEST(ARRAY[1,2]) AS t(number);\\n```\\n\\n```\\n number\\n--------\\n 1\\n 2\\n(2 rows)\\n```\\n\\nMaps are expanded into two columns (key, value):\\n\\n```\\nSELECT * FROM UNNEST(\\n map_from_entries(\\n ARRAY[\\n ('SQL',1974),\\n ('Java', 1995)\\n ]\\n )\\n) AS t(language, first_appeared_year);\\n```\\n\\n```\\n language | first_appeared_year\\n----------+---------------------\\n SQL | 1974\\n Java | 1995\\n(2 rows)\\n```\\n\\n`UNNEST` can be used in combination with an `ARRAY` of {ref}`row-type` structures for expanding each\\nfield of the `ROW` into a corresponding column:\\n\\n```\\nSELECT *\\nFROM UNNEST(\\n ARRAY[\\n ROW('Java', 1995),\\n ROW('SQL' , 1974)],\\n ARRAY[\\n ROW(false),\\n ROW(true)]\\n) as t(language,first_appeared_year,declarative);\\n```\\n\\n```\\n language | first_appeared_year | declarative\\n----------+---------------------+-------------\\n Java | 1995 | false\\n SQL | 1974 | true\\n(2 rows)\\n```\\n\\n`UNNEST` can optionally have a `WITH ORDINALITY` clause, in which case an additional ordinality column\\nis added to the end:\\n\\n```\\nSELECT a, b, rownumber\\nFROM UNNEST (\\n ARRAY[2, 5],\\n ARRAY[7, 8, 9]\\n ) WITH ORDINALITY AS t(a, b, rownumber);\\n```\\n\\n```\\n a | b | rownumber\\n------+---+-----------\\n 2 | 7 | 1\\n 5 | 8 | 2\\n NULL | 9 | 3\\n(3 rows)\\n```\\n\\n`UNNEST` returns zero entries when the array/map is empty:\\n\\n```\\nSELECT * FROM UNNEST (ARRAY[]) AS t(value);\\n```\\n\\n```\\n value\\n-------\\n(0 rows)\\n```\\n\\n`UNNEST` returns zero entries when the array/map is null:\\n\\n```\\nSELECT * FROM UNNEST (CAST(null AS ARRAY(integer))) AS t(number);\\n```\\n\\n```\\n number\\n--------\\n(0 rows)\\n```\\n\\n`UNNEST` is normally used with a `JOIN`, and can reference columns\\nfrom relations on the left side of the join:\\n\\n```\\nSELECT student, score\\nFROM (\\n VALUES\\n ('John', ARRAY[7, 10, 9]),\\n ('Mary', ARRAY[4, 8, 9])\\n) AS tests (student, scores)\\nCROSS JOIN UNNEST(scores) AS t(score);\\n```\\n\\n```\\n student | score\\n---------+-------\\n John | 7\\n John | 10\\n John | 9\\n Mary | 4\\n Mary | 8\\n Mary | 9\\n(6 rows)\\n```\\n\\n`UNNEST` can also be used with multiple arguments, in which case they are expanded into multiple columns,\\nwith as many rows as the highest cardinality argument (the other columns are padded with nulls):\\n\\n```\\nSELECT numbers, animals, n, a\\nFROM (\\n VALUES\\n (ARRAY[2, 5], ARRAY['dog', 'cat', 'bird']),\\n (ARRAY[7, 8, 9], ARRAY['cow', 'pig'])\\n) AS x (numbers, animals)\\nCROSS JOIN UNNEST(numbers, animals) AS t (n, a);\\n```\\n\\n```\\n numbers | animals | n | a\\n-----------+------------------+------+------\\n [2, 5] | [dog, cat, bird] | 2 | dog\\n [2, 5] | [dog, cat, bird] | 5 | cat\\n [2, 5] | [dog, cat, bird] | NULL | bird\\n [7, 8, 9] | [cow, pig] | 7 | cow\\n [7, 8, 9] | [cow, pig] | 8 | pig\\n [7, 8, 9] | [cow, pig] | 9 | NULL\\n(6 rows)\\n```\\n\\n`LEFT JOIN` is preferable in order to avoid losing the row containing the array/map field in question\\nwhen referenced columns from relations on the left side of the join can be empty or have `NULL` values:\\n\\n```\\nSELECT runner, checkpoint\\nFROM (\\n VALUES\\n ('Joe', ARRAY[10, 20, 30, 42]),\\n ('Roger', ARRAY[10]),\\n ('Dave', ARRAY[]),\\n ('Levi', NULL)\\n) AS marathon (runner, checkpoints)\\nLEFT JOIN UNNEST(checkpoints) AS t(checkpoint) ON TRUE;\\n```\\n\\n```\\n runner | checkpoint\\n--------+------------\\n Joe | 10\\n Joe | 20\\n Joe | 30\\n Joe | 42\\n Roger | 10\\n Dave | NULL\\n Levi | NULL\\n(7 rows)\\n```\\n\\nNote that in case of using `LEFT JOIN` the only condition supported by the current implementation is `ON TRUE`.\\n\\n(select-json-table)=\", \"JSON_TABLE\": \"`JSON_TABLE` transforms JSON data into a relational table format. Like `UNNEST`\\nand `LATERAL`, use `JSON_TABLE` in the `FROM` clause of a `SELECT` statement.\\nFor more information, see [`JSON_TABLE`](json-table).\", \"Joins\": {\"CROSS JOIN\": \"A cross join returns the Cartesian product (all combinations) of two\\nrelations. Cross joins can either be specified using the explit\\n`CROSS JOIN` syntax or by specifying multiple relations in the\\n`FROM` clause.\\n\\nBoth of the following queries are equivalent:\\n\\n```\\nSELECT *\\nFROM nation\\nCROSS JOIN region;\\n\\nSELECT *\\nFROM nation, region;\\n```\\n\\nThe `nation` table contains 25 rows and the `region` table contains 5 rows,\\nso a cross join between the two tables produces 125 rows:\\n\\n```\\nSELECT n.name AS nation, r.name AS region\\nFROM nation AS n\\nCROSS JOIN region AS r\\nORDER BY 1, 2;\\n```\\n\\n```\\n nation | region\\n----------------+-------------\\n ALGERIA | AFRICA\\n ALGERIA | AMERICA\\n ALGERIA | ASIA\\n ALGERIA | EUROPE\\n ALGERIA | MIDDLE EAST\\n ARGENTINA | AFRICA\\n ARGENTINA | AMERICA\\n...\\n(125 rows)\\n```\", \"LATERAL\": \"Subqueries appearing in the `FROM` clause can be preceded by the keyword `LATERAL`.\\nThis allows them to reference columns provided by preceding `FROM` items.\\n\\nA `LATERAL` join can appear at the top level in the `FROM` list, or anywhere\\nwithin a parenthesized join tree. In the latter case, it can also refer to any items\\nthat are on the left-hand side of a `JOIN` for which it is on the right-hand side.\\n\\nWhen a `FROM` item contains `LATERAL` cross-references, evaluation proceeds as follows:\\nfor each row of the `FROM` item providing the cross-referenced columns,\\nthe `LATERAL` item is evaluated using that row set's values of the columns.\\nThe resulting rows are joined as usual with the rows they were computed from.\\nThis is repeated for set of rows from the column source tables.\\n\\n`LATERAL` is primarily useful when the cross-referenced column is necessary for\\ncomputing the rows to be joined:\\n\\n```\\nSELECT name, x, y\\nFROM nation\\nCROSS JOIN LATERAL (SELECT name || ' :-' AS x)\\nCROSS JOIN LATERAL (SELECT x || ')' AS y);\\n```\", \"Qualifying column names\": \"When two relations in a join have columns with the same name, the column\\nreferences must be qualified using the relation alias (if the relation\\nhas an alias), or with the relation name:\\n\\n```\\nSELECT nation.name, region.name\\nFROM nation\\nCROSS JOIN region;\\n\\nSELECT n.name, r.name\\nFROM nation AS n\\nCROSS JOIN region AS r;\\n\\nSELECT n.name, r.name\\nFROM nation n\\nCROSS JOIN region r;\\n```\\n\\nThe following query will fail with the error `Column 'name' is ambiguous`:\\n\\n```\\nSELECT name\\nFROM nation\\nCROSS JOIN region;\\n```\"}, \"Subqueries\": {\"EXISTS\": \"The `EXISTS` predicate determines if a subquery returns any rows:\\n\\n```\\nSELECT name\\nFROM nation\\nWHERE EXISTS (\\n SELECT *\\n FROM region\\n WHERE region.regionkey = nation.regionkey\\n);\\n```\", \"IN\": \"The `IN` predicate determines if any values produced by the subquery\\nare equal to the provided expression. The result of `IN` follows the\\nstandard rules for nulls. The subquery must produce exactly one column:\\n\\n```\\nSELECT name\\nFROM nation\\nWHERE regionkey IN (\\n SELECT regionkey\\n FROM region\\n WHERE name = 'AMERICA' OR name = 'AFRICA'\\n);\\n```\", \"Scalar subquery\": \"A scalar subquery is a non-correlated subquery that returns zero or\\none row. It is an error for the subquery to produce more than one\\nrow. The returned value is `NULL` if the subquery produces no rows:\\n\\n```\\nSELECT name\\nFROM nation\\nWHERE regionkey = (SELECT max(regionkey) FROM region);\\n```\\n\\n:::{note}\\nCurrently only single column can be returned from the scalar subquery.\\n:::\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 46]\"}, {\"title\": \"SET PATH\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET PATH path-element[, ...]\\n```\", \"Description\": \"Define a collection of paths to functions or table functions in specific\\ncatalogs and schemas for the current session.\\n\\nEach path-element uses a period-separated syntax to specify the catalog name and\\nschema location `<catalog>.<schema>` of the function, or only the schema\\nlocation `<schema>` in the current catalog. The current catalog is set with\\n{doc}`use`, or as part of a client tool connection. Catalog and schema must\\nexist.\", \"Examples\": \"The following example sets a path to access functions in the `system` schema\\nof the `example` catalog:\\n\\n```\\nSET PATH example.system;\\n```\\n\\nThe catalog uses the PostgreSQL connector, and you can therefore use the\\n{ref}`query table function <postgresql-query-function>` directly, without the\\nfull catalog and schema qualifiers:\\n\\n```\\nSELECT\\n *\\nFROM\\n TABLE(\\n query(\\n query => 'SELECT\\n *\\n FROM\\n tpch.nation'\\n )\\n );\\n```\", \"See also\": [\"[](/sql/use)\", \"[](/admin/properties-sql-environment)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 47]\"}, {\"title\": \"SET ROLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET ROLE ( role | ALL | NONE )\\n[ IN catalog ]\\n```\", \"Description\": \"`SET ROLE` sets the enabled role for the current session.\\n\\n`SET ROLE role` enables a single specified role for the current session.\\nFor the `SET ROLE role` statement to succeed, the user executing it should\\nhave a grant for the given role.\\n\\n`SET ROLE ALL` enables all roles that the current user has been granted for the\\ncurrent session.\\n\\n`SET ROLE NONE` disables all the roles granted to the current user for the\\ncurrent session.\\n\\nThe optional `IN catalog` clause sets the role in a catalog as opposed\\nto a system role.\", \"Limitations\": \"Some connectors do not support role management.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`create-role`, {doc}`drop-role`, {doc}`grant-roles`, {doc}`revoke-roles`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 48]\"}, {\"title\": \"SET SESSION AUTHORIZATION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET SESSION AUTHORIZATION username\\n```\", \"Description\": \"Changes the current user of the session. For the `SET SESSION AUTHORIZATION\\nusername` statement to succeed, the original user (that the client connected\\nwith) must be able to impersonate the specified user. User impersonation can be\\nenabled in the system access control.\", \"Examples\": \"In the following example, the original user when the connection to Trino is made\\nis Kevin. The following sets the session authorization user to John:\\n\\n```\\nSET SESSION AUTHORIZATION 'John';\\n```\\n\\nQueries will now execute as John instead of Kevin.\\n\\nAll supported syntax to change the session authorization users are shown below.\\n\\nChanging the session authorization with single quotes:\\n\\n```\\nSET SESSION AUTHORIZATION 'John';\\n```\\n\\nChanging the session authorization with double quotes:\\n\\n```\\nSET SESSION AUTHORIZATION \\\"John\\\";\\n```\\n\\nChanging the session authorization without quotes:\\n\\n```\\nSET SESSION AUTHORIZATION John;\\n```\", \"See also\": \"[](reset-session-authorization)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 49]\"}, {\"title\": \"SET SESSION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET SESSION name = expression\\nSET SESSION catalog.name = expression\\n```\", \"Description\": \"Set a session property value or a catalog session property.\\n\\n(session-properties-definition)=\", \"Session properties\": \"A session property is a {doc}`configuration property </admin/properties>` that\\ncan be temporarily modified by a user for the duration of the current\\nconnection session to the Trino cluster. Many configuration properties have a\\ncorresponding session property that accepts the same values as the config\\nproperty.\\n\\nThere are two types of session properties:\\n\\n['**System session properties** apply to the whole cluster. Most session\\\\nproperties are system session properties unless specified otherwise.', '**Catalog session properties** are connector-defined session properties that\\\\ncan be set on a per-catalog basis. These properties must be set separately for\\\\neach catalog by including the catalog name as a prefix, such as\\\\n`catalogname.property_name`.']\\n\\nSession properties are tied to the current session, so a user can have multiple\\nconnections to a cluster that each have different values for the same session\\nproperties. Once a session ends, either by disconnecting or creating a new\\nsession, any changes made to session properties during the previous session are\\nlost.\", \"Examples\": \"The following example sets a system session property change maximum query run time:\\n\\n```\\nSET SESSION query_max_run_time = '10m';\\n```\\n\\nThe following example sets the `incremental_refresh_enabled` catalog session\\nproperty for a catalog using the [](/connector/iceberg) named `example`:\\n\\n```\\nSET SESSION example.incremental_refresh_enabled=false;\\n```\\n\\nThe related catalog configuration property `iceberg.incremental-refresh-enabled`\\ndefaults to `true`, and the session property allows you to override this setting\\nin for specific catalog and the current session. The\\n`example.incremental_refresh_enabled` catalog session property does not apply to\\nany other catalog, even if another catalog also uses the Iceberg connector.\", \"See also\": \"{doc}`reset-session`, {doc}`show-session`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 50]\"}, {\"title\": \"SET TIME ZONE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET TIME ZONE LOCAL\\nSET TIME ZONE expression\\n```\", \"Description\": \"Sets the default time zone for the current session.\\n\\nIf the `LOCAL` option is specified, the time zone for the current session\\nis set to the initial time zone of the session.\\n\\nIf the `expression` option is specified:\\n\\n['if the type of the `expression` is a string, the time zone for the current\\\\nsession is set to the corresponding region-based time zone ID or the\\\\ncorresponding zone offset.', 'if the type of the `expression` is an interval, the time zone for the\\\\ncurrent session is set to the corresponding zone offset relative to UTC.\\\\nIt must be in the range of \\\\\\\\[-14,14\\\\\\\\] hours.']\", \"Examples\": \"Use the default time zone for the current session:\\n\\n```\\nSET TIME ZONE LOCAL;\\n```\\n\\nUse a zone offset for specifying the time zone:\\n\\n```\\nSET TIME ZONE '-08:00';\\n```\\n\\nUse an interval literal for specifying the time zone:\\n\\n```\\nSET TIME ZONE INTERVAL '10' HOUR;\\nSET TIME ZONE INTERVAL -'08:00' HOUR TO MINUTE;\\n```\\n\\nUse a region-based time zone identifier for specifying the time zone:\\n\\n```\\nSET TIME ZONE 'America/Los_Angeles';\\n```\\n\\nThe time zone identifier to be used can be passed as the output of a\\nfunction call:\\n\\n```\\nSET TIME ZONE concat_ws('/', 'America', 'Los_Angeles');\\n```\", \"Limitations\": \"Setting the default time zone for the session has no effect if\\nthe `sql.forced-session-time-zone` configuration property is already set.\", \"See also\": [\"{func}`current_timezone`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 51]\"}, {\"title\": \"SHOW CATALOGS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CATALOGS [ LIKE pattern ]\\n```\", \"Description\": \"List the available catalogs.\\n\\n{ref}`Specify a pattern <like-operator>` in the optional `LIKE` clause to\\nfilter the results to the desired subset. For example, the following query\\nallows you to find catalogs that begin with `t`:\\n\\n```\\nSHOW CATALOGS LIKE 't%'\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 52]\"}, {\"title\": \"SHOW COLUMNS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW COLUMNS FROM table [ LIKE pattern ]\\n```\", \"Description\": \"List the columns in a `table` along with their data type and other attributes:\\n\\n```\\nSHOW COLUMNS FROM nation;\\n```\\n\\n```\\n Column | Type | Extra | Comment\\n-----------+--------------+-------+---------\\n nationkey | bigint | |\\n name | varchar(25) | |\\n regionkey | bigint | |\\n comment | varchar(152) | |\\n```\\n\\n{ref}`Specify a pattern <like-operator>` in the optional `LIKE` clause to\\nfilter the results to the desired subset. For example, the following query\\nallows you to find columns ending in `key`:\\n\\n```\\nSHOW COLUMNS FROM nation LIKE '%key';\\n```\\n\\n```\\n Column | Type | Extra | Comment\\n-----------+--------------+-------+---------\\n nationkey | bigint | |\\n regionkey | bigint | |\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 53]\"}, {\"title\": \"SHOW CREATE FUNCTION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CREATE FUNCTION function_name\\n```\", \"Description\": \"Show the SQL statement that creates the specified function.\", \"Examples\": \"Show the SQL that can be run to create the `meaning_of_life` function:\\n\\n```\\nSHOW CREATE FUNCTION example.default.meaning_of_life;\\n```\", \"See also\": [\"[](/sql/create-function)\", \"[](/sql/drop-function)\", \"[](/sql/show-functions)\", \"[](/udf)\", \"[](/admin/properties-sql-environment)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 54]\"}, {\"title\": \"SHOW CREATE MATERIALIZED VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CREATE MATERIALIZED VIEW view_name\\n```\", \"Description\": \"Show the SQL statement that creates the specified materialized view\\n`view_name`.\", \"See also\": [\"{doc}`create-materialized-view`\", \"{doc}`drop-materialized-view`\", \"{doc}`refresh-materialized-view`\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 55]\"}, {\"title\": \"SHOW CREATE SCHEMA\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CREATE SCHEMA schema_name\\n```\", \"Description\": \"Show the SQL statement that creates the specified schema.\", \"See also\": \"{doc}`create-schema`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 56]\"}, {\"title\": \"SHOW CREATE TABLE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CREATE TABLE table_name\\n```\", \"Description\": \"Show the SQL statement that creates the specified table.\", \"Examples\": \"Show the SQL that can be run to create the `orders` table:\\n\\n```\\nSHOW CREATE TABLE sf1.orders;\\n```\\n\\n```\\n Create Table\\n-----------------------------------------\\n CREATE TABLE tpch.sf1.orders (\\n orderkey bigint,\\n orderstatus varchar,\\n totalprice double,\\n orderdate varchar\\n )\\n WITH (\\n format = 'ORC',\\n partitioned_by = ARRAY['orderdate']\\n )\\n(1 row)\\n```\", \"See also\": \"{doc}`create-table`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 57]\"}, {\"title\": \"SHOW CREATE VIEW\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW CREATE VIEW view_name\\n```\", \"Description\": \"Show the SQL statement that creates the specified view.\", \"See also\": \"{doc}`create-view`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 58]\"}, {\"title\": \"SHOW FUNCTIONS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW FUNCTIONS [ FROM schema ] [ LIKE pattern ]\\n```\", \"Description\": \"List functions in `schema` or all functions in the current session path. This\\ncan include built-in functions, [functions from a custom\\nplugin](/develop/functions), and [](/udf).\\n\\nFor each function returned, the following information is displayed:\\n\\n['Function name', 'Return type', 'Argument types', 'Function type', 'Deterministic', 'Description']\\n\\nUse the optional `FROM` keyword to only list functions in a specific catalog and\\nschema. The location in `schema` must be specified as\\n`cataglog_name.schema_name`.\\n\\n{ref}`Specify a pattern <like-operator>` in the optional `LIKE` clause to\\nfilter the results to the desired subset.\", \"Examples\": \"List all UDFs and plugin functions in the `default` schema of the `example`\\ncatalog:\\n\\n```\\nSHOW FUNCTIONS FROM example.default;\\n```\\n\\nList all functions with a name beginning with `array`:\\n\\n```\\nSHOW FUNCTIONS LIKE 'array%';\\n```\\n\\nList all functions with a name beginning with `cf`:\\n\\n```\\nSHOW FUNCTIONS LIKE 'cf%';\\n```\\n\\nExample output:\\n\\n```\\n Function | Return Type | Argument Types | Function Type | Deterministic | Description\\n ------------------+-------------+----------------+---------------+---------------+-----------------------------------------\\n cf_getgroups | varchar | | scalar | true | Returns the current session's groups\\n cf_getprincipal | varchar | | scalar | true | Returns the current session's principal\\n cf_getuser | varchar | | scalar | true | Returns the current session's user\\n```\", \"See also\": [\"[](/functions)\", \"[](/udf)\", \"[](/develop/functions)\", \"[](/sql/create-function)\", \"[](/sql/drop-function)\", \"[](/sql/show-create-function)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 59]\"}, {\"title\": \"SHOW GRANTS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW GRANTS [ ON [ TABLE ] table_name ]\\n```\", \"Description\": \"List the grants for the current user on the specified table in the current catalog.\\n\\nIf no table name is specified, the command lists the grants for the current user on all the tables in all schemas of the current catalog.\\n\\nThe command requires the current catalog to be set.\\n\\n:::{note}\\nEnsure that authentication has been enabled before running any of the authorization commands.\\n:::\", \"Examples\": \"List the grants for the current user on table `orders`:\\n\\n```\\nSHOW GRANTS ON TABLE orders;\\n```\\n\\nList the grants for the current user on all the tables in all schemas of the current catalog:\\n\\n```\\nSHOW GRANTS;\\n```\", \"Limitations\": \"Some connectors have no support for `SHOW GRANTS`.\\nSee connector documentation for more details.\", \"See also\": \"{doc}`grant`, {doc}`revoke`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 60]\"}, {\"title\": \"SHOW ROLE GRANTS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW ROLE GRANTS [ FROM catalog ]\\n```\", \"Description\": \"List non-recursively the system roles or roles in `catalog` that have been granted to the session user.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 61]\"}, {\"title\": \"SHOW ROLES\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW [CURRENT] ROLES [ FROM catalog ]\\n```\", \"Description\": \"`SHOW ROLES` lists all the system roles or all the roles in `catalog`.\\n\\n`SHOW CURRENT ROLES` lists the enabled system roles or roles in `catalog`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 62]\"}, {\"title\": \"SHOW SCHEMAS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW SCHEMAS [ FROM catalog ] [ LIKE pattern ]\\n```\", \"Description\": \"List the schemas in `catalog` or in the current catalog.\\n\\n{ref}`Specify a pattern <like-operator>` in the optional `LIKE` clause to\\nfilter the results to the desired subset. For example, the following query\\nallows you to find schemas that have `3` as the third character:\\n\\n```\\nSHOW SCHEMAS FROM tpch LIKE '__3%'\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 63]\"}, {\"title\": \"SHOW SESSION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW SESSION [ LIKE pattern ]\\n```\", \"Description\": \"List the current {ref}`session properties <session-properties-definition>`.\\n\\n{ref}`Specify a pattern <like-operator>` in the optional `LIKE` clause to\\nfilter the results to the desired subset. For example, the following query\\nallows you to find session properties that begin with `query`:\\n\\n```\\nSHOW SESSION LIKE 'query%'\\n```\", \"See also\": \"{doc}`reset-session`, {doc}`set-session`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 64]\"}, {\"title\": \"SHOW STATS\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW STATS FOR table\\nSHOW STATS FOR ( query )\\n```\", \"Description\": \"Returns approximated statistics for the named table or for the results of a\\nquery. Returns `NULL` for any statistics that are not populated or\\nunavailable on the data source.\\n\\nStatistics are returned as a row for each column, plus a summary row for\\nthe table (identifiable by a `NULL` value for `column_name`). The following\\ntable lists the returned columns and what statistics they represent. Any\\nadditional statistics collected on the data source, other than those listed\\nhere, are not included.\\n\\n:::{list-table} Statistics\\n:widths: 20, 40, 40\\n:header-rows: 1\\n\\n[['Column', 'Description', 'Notes'], ['`column_name`', 'The name of the column', '`NULL` in the table summary row'], ['`data_size`', 'The total size in bytes of all the values in the column', '`NULL` in the table summary row. Available for columns of\\\\n[string](string-data-types) data types with variable widths.'], ['`distinct_values_count`', 'The estimated number of distinct values in the column', '`NULL` in the table summary row'], ['`nulls_fractions`', 'The portion of the values in the column that are `NULL`', '`NULL` in the table summary row.'], ['`row_count`', 'The estimated number of rows in the table', '`NULL` in column statistic rows'], ['`low_value`', 'The lowest value found in this column', '`NULL` in the table summary row. Available for columns of\\\\n[DATE](date-data-type), [integer](integer-data-types),\\\\n[floating-point](floating-point-data-types), and\\\\n[exact numeric](exact-numeric-data-types) data types.'], ['`high_value`', 'The highest value found in this column', '`NULL` in the table summary row. Available for columns of\\\\n[DATE](date-data-type), [integer](integer-data-types),\\\\n[floating-point](floating-point-data-types), and\\\\n[exact numeric](exact-numeric-data-types) data types.\\\\n:::']]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 65]\"}, {\"title\": \"SHOW TABLES\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSHOW TABLES [ FROM schema ] [ LIKE pattern ]\\n```\", \"Description\": \"List the tables and views in the current schema, for example set with\\n[](/sql/use) or by a client connection.\\n\\nUse a fully qualified path to a schema in the form of `catalog_name.schema_name`\\nto specify any schema in any catalog in the `FROM` clause.\\n\\n[Specify a pattern](like-operator) in the optional `LIKE` clause to filter\\nthe results to the desired subset.\", \"Examples\": \"The following query lists tables and views that begin with `p` in\\nthe `tiny` schema of the `tpch` catalog:\\n\\n```\\nSHOW TABLES FROM tpch.tiny LIKE 'p%';\\n```\", \"See also\": [\"[](sql-schema-table-management)\", \"[](sql-view-management)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 66]\"}, {\"title\": \"START TRANSACTION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSTART TRANSACTION [ mode [, ...] ]\\n```\\n\\nwhere `mode` is one of\\n\\n```\\nISOLATION LEVEL { READ UNCOMMITTED | READ COMMITTED | REPEATABLE READ | SERIALIZABLE }\\nREAD { ONLY | WRITE }\\n```\", \"Description\": \"Start a new transaction for the current session.\", \"Examples\": \"```\\nSTART TRANSACTION;\\nSTART TRANSACTION ISOLATION LEVEL REPEATABLE READ;\\nSTART TRANSACTION READ WRITE;\\nSTART TRANSACTION ISOLATION LEVEL READ COMMITTED, READ ONLY;\\nSTART TRANSACTION READ WRITE, ISOLATION LEVEL SERIALIZABLE;\\n```\", \"See also\": \"{doc}`commit`, {doc}`rollback`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 67]\"}, {\"title\": \"TRUNCATE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nTRUNCATE TABLE table_name\\n```\", \"Description\": \"Delete all rows from a table.\", \"Examples\": \"Truncate the table `orders`:\\n\\n```\\nTRUNCATE TABLE orders;\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 68]\"}, {\"title\": \"UPDATE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nUPDATE table_name SET [ ( column = expression [, ... ] ) ] [ WHERE condition ]\\n```\", \"Description\": \"Update selected columns values in existing rows in a table.\\n\\nThe columns named in the `column = expression` assignments will be updated\\nfor all rows that match the `WHERE` condition. The values of all column update\\nexpressions for a matching row are evaluated before any column value is changed.\\nWhen the type of the expression and the type of the column differ, the usual implicit\\nCASTs, such as widening numeric fields, are applied to the `UPDATE` expression values.\", \"Examples\": \"Update the status of all purchases that haven't been assigned a ship date:\\n\\n```\\nUPDATE\\n purchases\\nSET\\n status = 'OVERDUE'\\nWHERE\\n ship_date IS NULL;\\n```\\n\\nUpdate the account manager and account assign date for all customers:\\n\\n```\\nUPDATE\\n customers\\nSET\\n account_manager = 'John Henry',\\n assign_date = now();\\n```\\n\\nUpdate the manager to be the name of the employee who matches the manager ID:\\n\\n```\\nUPDATE\\n new_hires\\nSET\\n manager = (\\n SELECT\\n e.name\\n FROM\\n employees e\\n WHERE\\n e.employee_id = new_hires.manager_id\\n );\\n```\", \"Limitations\": \"Some connectors have limited or no support for `UPDATE`.\\nSee connector documentation for more details.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 69]\"}, {\"title\": \"USE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nUSE catalog.schema\\nUSE schema\\n```\", \"Description\": \"Update the session to use the specified catalog and schema. If a\\ncatalog is not specified, the schema is resolved relative to the\\ncurrent catalog.\", \"Examples\": \"```\\nUSE hive.finance;\\nUSE information_schema;\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 70]\"}, {\"title\": \"VALUES\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nVALUES row [, ...]\\n```\\n\\nwhere `row` is a single expression or\\n\\n```\\n( column_expression [, ...] )\\n```\", \"Description\": \"Defines a literal inline table.\\n\\n`VALUES` can be used anywhere a query can be used (e.g., the `FROM` clause\\nof a {doc}`select`, an {doc}`insert`, or even at the top level). `VALUES` creates\\nan anonymous table without column names, but the table and columns can be named\\nusing an `AS` clause with column aliases.\", \"Examples\": \"Return a table with one column and three rows:\\n\\n```\\nVALUES 1, 2, 3\\n```\\n\\nReturn a table with two columns and three rows:\\n\\n```\\nVALUES\\n (1, 'a'),\\n (2, 'b'),\\n (3, 'c')\\n```\\n\\nReturn table with column `id` and `name`:\\n\\n```\\nSELECT * FROM (\\n VALUES\\n (1, 'a'),\\n (2, 'b'),\\n (3, 'c')\\n) AS t (id, name)\\n```\\n\\nCreate a new table with column `id` and `name`:\\n\\n```\\nCREATE TABLE example AS\\nSELECT * FROM (\\n VALUES\\n (1, 'a'),\\n (2, 'b'),\\n (3, 'c')\\n) AS t (id, name)\\n```\", \"See also\": \"{doc}`insert`, {doc}`select`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30, \\\"subpages\\\", 71]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 30]\"}, {\"title\": \"Udf\", \"description\": \"Documentation section: udf\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/udf\"}, \"subpages\": [{\"title\": \"FUNCTION\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nFUNCTION name ( [ parameter_name data_type [, ...] ] )\\n RETURNS type\\n [ LANGUAGE language]\\n [ NOT? DETERMINISTIC ]\\n [ RETURNS NULL ON NULL INPUT ]\\n [ CALLED ON NULL INPUT ]\\n [ SECURITY { DEFINER | INVOKER } ]\\n [ COMMENT description]\\n [ WITH ( property_name = expression [, ...] ) ]\\n { statements | AS definition }\\n```\", \"Description\": \"Declare a [user-defined function](/udf). \\n\\nThe `name` of the UDF. [](udf-inline) can use a simple string. [](udf-catalog)\\nmust qualify the name of the catalog and schema, delimited by `.`, to store the\\nUDF or rely on the [default catalog and schema for UDF\\nstorage](/admin/properties-sql-environment).\\n\\nThe list of parameters is a comma-separated list of names `parameter_name` and\\ndata types `data_type`, see [data type](/language/types). An empty list, specified as\\n`()` is also valid.\\n\\nThe `type` value after the `RETURNS` keyword identifies the [data\\ntype](/language/types) of the UDF output.\\n\\nThe optional `LANGUAGE` characteristic identifies the language used for the UDF\\ndefinition with `language`. The `SQL` and `PYTHON` languages are supported by\\ndefault. Additional languages may be supported via a language engine plugin.\\nIf not specified, the default language is `SQL`.\\n\\nThe optional `DETERMINISTIC` or `NOT DETERMINISTIC` characteristic declares that\\nthe UDF is deterministic. This means that repeated UDF calls with identical\\ninput parameters yield the same result. A UDF is non-deterministic if it calls\\nany non-deterministic UDFs and [functions](/functions). By default, UDFs are\\nassumed to have a deterministic behavior.\\n\\nThe optional `RETURNS NULL ON NULL INPUT` characteristic declares that the UDF\\nreturns a `NULL` value when any of the input parameters are `NULL`. The UDF is\\nnot invoked with a `NULL` input value.\\n\\nThe `CALLED ON NULL INPUT` characteristic declares that the UDF is invoked with\\n`NULL` input parameter values.\\n\\nThe `RETURNS NULL ON NULL INPUT` and `CALLED ON NULL INPUT` characteristics are\\nmutually exclusive, with `CALLED ON NULL INPUT` as the default.\\n\\nThe security declaration of `SECURITY INVOKER` or `SECURITY DEFINER` is only\\nvalid for catalog UDFs. It sets the mode for processing the UDF with the\\npermissions of the user who calls the UDF (`INVOKER`) or the user who created\\nthe UDF (`DEFINER`).\\n\\nThe `COMMENT` characteristic can be used to provide information about the\\nfunction to other users as `description`. The information is accessible with\\n[](/sql/show-functions).\\n\\nThe optional `WITH` clause can be used to specify properties for the function.\\nThe available properties vary based on the function language. For\\n[](/udf/python), the `handler` property specifies the name of the Python\\nfunction to invoke.\\n\\nFor SQL UDFs the body of the UDF can either be a simple single `RETURN`\\nstatement with an expression, or compound list of `statements` in a `BEGIN`\\nblock. UDF must contain a `RETURN` statement at the end of the top-level block,\\neven if it's unreachable.\\n\\nFor UDFs in other languages, the `definition` is enclosed in a `$$`-quoted\\nstring.\", \"Examples\": \"A simple catalog function:\\n\\n```\\nCREATE FUNCTION example.default.meaning_of_life()\\n RETURNS BIGINT\\n RETURN 42;\\n```\\n\\nAnd used:\\n\\n```\\nSELECT example.default.meaning_of_life(); -- returns 42\\n```\\n\\nEquivalent usage with an inline function:\\n\\n```\\nWITH FUNCTION meaning_of_life()\\n RETURNS BIGINT\\n RETURN 42\\nSELECT meaning_of_life();\\n```\\n\\nFurther examples of varying complexity that cover usage of the `FUNCTION`\\nstatement in combination with other statements are available in the [SQL UDF\\ndocumentation](/udf/sql/examples) and the [Python UDF\\ndocumentation](/udf/python).\", \"See also\": [\"[](/udf)\", \"[](/udf/sql)\", \"[](/udf/python)\", \"[](/sql/create-function)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 0]\"}, {\"title\": \"Introduction to UDFs\", \"description\": null, \"content\": {\"UDF declaration\": \"Declare the UDF with the SQL [](/udf/function) keyword and the supported\\nstatements for [](/udf/sql) or [](/udf/python).\\n\\nA UDF can be declared as an [inline UDF](udf-inline) to be used in the current\\nquery, or declared as a [catalog UDF](udf-catalog) to be used in any future\\nquery.\\n\\n(udf-inline)=\", \"Inline user-defined functions\": \"An inline user-defined function (inline UDF) declares and uses the UDF within a\\nquery processing context. The UDF is declared in a `WITH` block before the\\nquery:\\n\\n```\\nWITH\\n FUNCTION doubleup(x integer)\\n RETURNS integer\\n RETURN x * 2\\nSELECT doubleup(21);\\n-- 42\\n```\\n\\nInline UDF names must follow SQL identifier naming conventions, and cannot\\ncontain `.` characters.\\n\\nThe UDF declaration is only valid within the context of the query. A separate\\nlater invocation of the UDF is not possible. If this is desired, use a [catalog\\nUDF](udf-catalog).\\n\\nMultiple inline UDF declarations are comma-separated, and can include UDFs\\ncalling each other, as long as a called UDF is declared before the first\\ninvocation.\\n\\n```\\nWITH\\n FUNCTION doubleup(x integer)\\n RETURNS integer\\n RETURN x * 2,\\n FUNCTION doubleupplusone(x integer)\\n RETURNS integer\\n RETURN doubleup(x) + 1\\nSELECT doubleupplusone(21);\\n-- 43\\n```\\n\\nNote that inline UDFs can mask and override the meaning of a built-in function:\\n\\n```\\nWITH\\n FUNCTION abs(x integer)\\n RETURNS integer\\n RETURN x * 2\\nSELECT abs(-10); -- -20, not 10!\\n```\\n\\n(udf-catalog)=\", \"Catalog user-defined functions\": \"You can store a UDF in the context of a catalog, if the connector used in the\\ncatalog supports UDF storage. The following connectors support catalog UDF\\nstorage:\\n\\n['[](/connector/hive)', '[](/connector/memory)']\\n\\nIn this scenario, the following commands can be used:\\n\\n['[](/sql/create-function) to create and store a UDF.', '[](/sql/drop-function) to remove a UDF.', '[](/sql/show-functions) to display a list of UDFs in a catalog.']\\n\\nCatalog UDFs must use a name that combines the catalog name and schema name with\\nthe UDF name, such as `example.default.power` for the `power` UDF in the\\n`default` schema of the `example` catalog.\\n\\nInvocation must use the fully qualified name, such as `example.default.power`.\\n\\n(udf-sql-environment)=\", \"SQL environment configuration for UDFs\": \"Configuration of the `sql.default-function-catalog` and\\n`sql.default-function-schema` [](/admin/properties-sql-environment) allows you\\nto set the default storage for UDFs. The catalog and schema must be added to the\\n`sql.path` as well. This enables users to call UDFs and perform all\\n[](udf-management) without specifying the full path to the UDF.\\n\\n:::{note}\\nUse the [](/connector/memory) in a catalog for simple storing and\\ntesting of your UDFs.\\n:::\", \"Recommendations\": \"Processing UDFs can potentially be resource intensive on the cluster in\\nterms of memory and processing. Take the following considerations into account\\nwhen writing and running UDFs:\\n\\n['Some checks for the runtime behavior of queries, and therefore UDF processing,\\\\nare in place. For example, if a query takes longer to process than a hardcoded\\\\nthreshold, processing is automatically terminated.', 'Avoid creation of arrays in a looping construct. Each iteration creates a\\\\nseparate new array with all items and copies the data for each modification,\\\\nleaving the prior array in memory for automated clean up later. Use a [lambda\\\\nexpression](/functions/lambda) instead of the loop.', 'Avoid concatenating strings in a looping construct. Each iteration creates a\\\\nseparate new string and copying the old string for each modification, leaving\\\\nthe prior string in memory for automated clean up later. Use a [lambda\\\\nexpression](/functions/lambda) instead of the loop.', 'Most UDFs should declare the `RETURNS NULL ON NULL INPUT` characteristics\\\\nunless the code has some special handling for null values. You must declare\\\\nthis explicitly since `CALLED ON NULL INPUT` is the default characteristic.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 1]\"}, {\"title\": \"Python user-defined functions\", \"description\": null, \"content\": {\"Python UDF declaration\": \"Declare a Python UDF as [inline](udf-inline) or [catalog UDF](udf-catalog) with\\nthe following steps:\\n\\n['Use the [](/udf/function) keyword to declare the UDF name and parameters.', 'Add the `RETURNS` declaration to specify the data type of the result.', 'Set the `LANGUAGE` to `PYTHON`.', 'Declare the name of the Python function to call with the `handler` property in\\\\nthe `WITH` block.', 'Use `$$` to enclose the Python code after the `AS` keyword.', 'Add the function from the handler property and ensure it returns the declared\\\\ndata type.', 'Expand your Python code section to implement the function using the available\\\\n[Python language](python-udf-lang).']\\n\\nThe following snippet shows pseudo-code:\\n\\n```\\nFUNCTION python_udf_name(input_parameter data_type)\\n RETURNS result_data_type\\n LANGUAGE PYTHON\\n WITH (handler = 'python_function')\\n AS $$\\n ...\\n def python_function(input):\\n return ...\\n ...\\n $$\\n```\\n\\nA minimal example declares the UDF `doubleup` that returns the input integer\\nvalue `x` multiplied by two. The example shows declaration as [](udf-inline) and\\ninvocation with the value `21` to yield the result `42`.\\n\\nSet the language to `PYTHON` to override the default `SQL` for [](/udf/sql).\\nThe Python code is enclosed with `$$` and must use valid formatting.\\n\\n```\\nWITH\\n FUNCTION doubleup(x integer)\\n RETURNS integer\\n LANGUAGE PYTHON\\n WITH (handler = 'twice')\\n AS $$\\n def twice(a):\\n return a * 2\\n $$\\nSELECT doubleup(21);\\n-- 42\\n```\\n\\nThe same UDF can also be declared as [](udf-catalog).\\n\\nRefer to the [](/udf/python/examples) for more complex use cases and examples.\\n\\n```\\n:titlesonly: true\\n:hidden:\\n\\n/udf/python/examples\\n```\\n\\n(python-udf-lang)=\", \"Python language details\": \"The Trino Python UDF integrations uses Python 3.13.0 in a sandboxed environment.\\nPython code runs within a WebAssembly (WASM) runtime within the Java virtual\\nmachine running Trino.\\n\\nPython language rules including indents must be observed.\\n\\nPython UDFs therefore only have access to the Python language and core libraries\\nincluded in the sandboxed runtime. Access to external resources with network or\\nfile system operations is not supported. Usage of other Python libraries as well\\nas command line tools or package managers is not supported.\\n\\nThe following libraries are explicitly removed from the runtime and therefore\\nnot available within a Python UDF:\\n\\n['`bdb`', '`concurrent`', '`curses`', '`ensurepip`', '`doctest`', '`idlelib`', '`multiprocessing`', '`pdb`', '`pydoc`', '`socketserver`', '`sqlite3`', '`ssl`', '`subprocess`', '`tkinter`', '`turtle`', '`unittest`', '`venv`', '`webbrowser`', '`wsgiref`', '`xmlrpc`']\\n\\nThe following libraries are explicitly added to the runtime and therefore\\navailable within a Python UDF:\\n\\n['`attrs`', '`bleach`', '`charset-normalizer`', '`defusedxml`', '`idna`', '`jmespath`', '`jsonschema`', '`pyasn1`', '`pyparsing`', '`python-dateutil`', '`rsa`', '`tomli`', '`ua-parser`']\", \"Type mapping\": {\"Time and timestamp\": \"Python `datetime` and `time` objects only support microsecond precision.\\nTrino argument values with greater precision are rounded when converted to\\nPython values, and Python return values are rounded if the Trino return type\\nhas less than microsecond precision.\", \"Timestamp with time zone\": \"Only fixed offset time zones are supported. Timestamps with political time zones\\nhave the zone converted to the zone's offset for the timestamp's instant.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 2]\"}, {\"title\": \"SQL user-defined functions\", \"description\": null, \"content\": {\"SQL UDF declaration\": \"Declare a SQL UDF using the [](/udf/function) keyword and the following\\nstatements can be used in addition to [built-in functions and\\noperators](/functions) and other UDFs:\\n\\n['[](/udf/sql/begin)', '[](/udf/sql/case)', '[](/udf/sql/declare)', '[](/udf/sql/if)', '[](/udf/sql/iterate)', '[](/udf/sql/leave)', '[](/udf/sql/loop)', '[](/udf/sql/repeat)', '[](/udf/sql/return)', '[](/udf/sql/set)', '[](/udf/sql/while)']\\n\\n```\\n:titlesonly: true\\n:hidden:\\n\\nsql/examples\\nsql/begin\\nsql/case\\nsql/declare\\nsql/if\\nsql/iterate\\nsql/leave\\nsql/loop\\nsql/repeat\\nsql/return\\nsql/set\\nsql/while\\n```\\n\\nA minimal example declares the UDF `doubleup` that returns the input integer\\nvalue `x` multiplied by two. The example shows declaration as [](udf-inline) and\\ninvocation with the value 21 to yield the result 42:\\n\\n```\\nWITH\\n FUNCTION doubleup(x integer)\\n RETURNS integer\\n RETURN x * 2\\nSELECT doubleup(21);\\n-- 42\\n```\\n\\nThe same UDF can also be declared as [](udf-catalog).\\n\\nFind simple examples in each statement documentation, and refer to the\\n[](/udf/sql/examples) for more complex use cases that combine multiple\\nstatements.\\n\\n(udf-sql-label)=\", \"Labels\": \"SQL UDFs can contain labels as markers for a specific block in the declaration\\nbefore the following keywords:\\n\\n['`CASE`', '`IF`', '`LOOP`', '`REPEAT`', '`WHILE`']\\n\\nThe label is used to name the block to continue processing with the `ITERATE`\\nstatement or exit the block with the `LEAVE` statement. This flow control is\\nsupported for nested blocks, allowing to continue or exit an outer block, not\\njust the innermost block. For example, the following snippet uses the label\\n`top` to name the complete block from `REPEAT` to `END REPEAT`:\\n\\n```\\ntop: REPEAT\\n SET a = a + 1;\\n IF a <= 3 THEN\\n ITERATE top;\\n END IF;\\n SET b = b + 1;\\n UNTIL a >= 10\\nEND REPEAT;\\n```\\n\\nLabels can be used with the `ITERATE` and `LEAVE` statements to continue\\nprocessing the block or leave the block. This flow control is also supported for\\nnested blocks and labels.\", \"Limitations\": \"The following limitations apply to SQL UDFs.\\n\\n['UDFs must be declared before they are referenced.', 'Recursion cannot be declared or processed.', 'Mutual recursion can not be declared or processed.', 'Queries cannot be processed in a UDF.']\\n\\nSpecifically this means that UDFs can not use `SELECT` queries to retrieve\\ndata or any other queries to process data within the UDF. Instead queries can\\nuse UDFs to process data. UDFs only work on data provided as input values and\\nonly provide output data from the `RETURN` statement.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 3]\"}, {\"title\": \"Python\", \"description\": \"Documentation section: python\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/udf/python\"}, \"subpages\": [{\"title\": \"Example Python UDFs\", \"description\": null, \"content\": {\"Inline and catalog Python UDFs\": \"The following section shows the differences in usage with inline and catalog\\nUDFs with a simple Python UDF example. The same pattern applies to all other\\nfollowing sections.\\n\\nA very simple Python UDF that returns the static int value `42` without\\nrequiring any input:\\n\\n```\\nFUNCTION answer()\\nLANGUAGE PYTHON\\nRETURNS int\\nWITH (handler='theanswer')\\nAS $$\\ndef theanswer():\\n return 42\\n$$\\n```\\n\\nA full example of this UDF as inline UDF and usage in a string concatenation\\nwith a cast:\\n\\n```\\nWITH\\n FUNCTION answer()\\n RETURNS int\\n LANGUAGE PYTHON\\n WITH (handler='theanswer')\\n AS $$\\n def theanswer():\\n return 42\\n $$\\nSELECT 'The answer is ' || CAST(answer() as varchar);\\n-- The answer is 42\\n```\\n\\nProvided the catalog `example` supports UDF storage in the `default` schema, you\\ncan use the following:\\n\\n```\\nCREATE FUNCTION example.default.answer()\\n RETURNS int\\n LANGUAGE PYTHON\\n WITH (handler='theanswer')\\n AS $$\\n def theanswer():\\n return 42\\n $$;\\n```\\n\\nWith the UDF stored in the catalog, you can run the UDF multiple times without\\nrepeated definition:\\n\\n```\\nSELECT example.default.answer() + 1; -- 43\\nSELECT 'The answer is ' || CAST(example.default.answer() as varchar); -- The answer is 42\\n```\\n\\nAlternatively, you can configure the SQL PATH in the [](config-properties) to a\\ncatalog and schema that support UDF storage:\\n\\n```\\nsql.default-function-catalog=example\\nsql.default-function-schema=default\\nsql.path=example.default\\n```\\n\\nNow you can manage UDFs without the full path:\\n\\n```\\nCREATE FUNCTION answer()\\n RETURNS int\\n LANGUAGE PYTHON\\n WITH (handler='theanswer')\\n AS $$\\n def theanswer():\\n return 42\\n $$;\\n```\\n\\nUDF invocation works without the full path:\\n\\n```\\nSELECT answer() + 5; -- 47\\n```\", \"XOR\": \"The following example implements a `xor` function for a logical Exclusive OR\\noperation on two boolean input parameters and tests it with two invocations:\\n\\n```\\nWITH FUNCTION xor(a boolean, b boolean)\\nRETURNS boolean\\nLANGUAGE PYTHON\\nWITH (handler = 'bool_xor')\\nAS $$\\nimport operator\\ndef bool_xor(a, b):\\n return operator.xor(a, b)\\n$$\\nSELECT xor(true, false), xor(false, true);\\n```\\n\\nResult of the query:\\n\\n```\\n true | true\\n```\", \"reverse_words\": \"The following example uses a more elaborate Python script to reverse the\\ncharacters in each word of the input string `s` of type `varchar` and tests the\\nfunction.\\n\\n```\\nWITH FUNCTION reverse_words(s varchar)\\nRETURNS varchar\\nLANGUAGE PYTHON\\nWITH (handler = 'reverse_words')\\nAS $$\\nimport re\\n\\ndef reverse(s):\\n str = \\\"\\\"\\n for i in s:\\n str = i + str\\n return str\\n\\npattern = re.compile(r\\\"\\\\w+[.,'!?\\\\\\\"]\\\\w*\\\")\\n\\ndef process_word(word):\\n # Reverse only words without non-letter signs\\n return word if pattern.match(word) else reverse(word)\\n\\ndef reverse_words(payload):\\n text_words = payload.split(' ')\\n return ' '.join([process_word(w) for w in text_words])\\n$$\\nSELECT reverse_words('Civic, level, dna racecar era semordnilap');\\n```\\n\\nResult of the query:\\n\\n```\\nCivic, level, and racecar are palindromes\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 4]\"}, {\"title\": \"Sql\", \"description\": \"Documentation section: sql\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/trino/original/docs/src/main/sphinx/udf/sql\"}, \"subpages\": [{\"title\": \"BEGIN\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nBEGIN\\n [ DECLARE ... ]\\n statements\\nEND\\n```\", \"Description\": \"Marks the start and end of a block in a [](/udf/sql). `BEGIN` can be used\\nwherever a statement can be used to group multiple statements together and to\\ndeclare variables local to the block. A typical use case is as first statement\\nwithin a [](/udf/function). Blocks can also be nested.\\n\\nAfter the `BEGIN` keyword, you can add variable declarations using\\n[](/udf/sql/declare) statements, followed by one or more statements that define\\nthe main body of the SQL UDF, separated by `;`. The following statements can be\\nused:\\n\\n['[](/udf/sql/case)', '[](/udf/sql/if)', '[](/udf/sql/iterate)', '[](/udf/sql/leave)', '[](/udf/sql/loop)', '[](/udf/sql/repeat)', '[](/udf/sql/return)', '[](/udf/sql/set)', '[](/udf/sql/while)', 'Nested [](/udf/sql/begin) blocks']\", \"Examples\": \"The following example computes the value `42`:\\n\\n```\\nFUNCTION meaning_of_life()\\n RETURNS integer\\n BEGIN\\n DECLARE a integer DEFAULT 6;\\n DECLARE b integer DEFAULT 7;\\n RETURN a * b;\\n END\\n```\\n\\nFurther examples of varying complexity that cover usage of the `BEGIN` statement\\nin combination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf)\", \"[](/udf/sql)\", \"[](/udf/function)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"CASE\", \"description\": null, \"content\": {\"Synopsis\": \"Simple case:\\n\\n```\\nCASE\\n WHEN condition THEN statements\\n [ ... ]\\n [ ELSE statements ]\\nEND CASE\\n```\\n\\nSearched case:\\n\\n```\\nCASE expression\\n WHEN expression THEN statements\\n [ ... ]\\n [ ELSE statements ]\\nEND\\n```\", \"Description\": \"The `CASE` statement is an optional construct to allow conditional processing\\nin [](/udf/sql).\\n\\nThe `WHEN` clauses are evaluated sequentially, stopping after the first match,\\nand therefore the order of the statements is significant. The statements of the\\n`ELSE` clause are executed if none of the `WHEN` clauses match.\\n\\nUnlike other languages like C or Java, SQL does not support case fall through,\\nso processing stops at the end of the first matched case.\\n\\nOne or more `WHEN` clauses can be used.\", \"Examples\": \"The following example shows a simple `CASE` statement usage:\\n\\n```\\nFUNCTION simple_case(a bigint)\\n RETURNS varchar\\n BEGIN\\n CASE a\\n WHEN 0 THEN RETURN 'zero';\\n WHEN 1 THEN RETURN 'one';\\n ELSE RETURN 'more than one or negative';\\n END CASE;\\n RETURN NULL;\\n END\\n```\\n\\nFurther examples of varying complexity that cover usage of the `CASE` statement\\nin combination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[Conditional expressions using `CASE`](case-expression)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"DECLARE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nDECLARE identifier [, ...] type [ DEFAULT expression ]\\n```\", \"Description\": \"Use the `DECLARE` statement directly after the [](/udf/sql/begin) keyword in\\n[](/udf/sql) to define one or more variables with an `identifier` as name. Each\\nstatement must specify the [data type](/language/types) of the variable with\\n`type`. It can optionally include a default, initial value defined by an\\n`expression`. The default value is `NULL` if not specified.\", \"Examples\": \"A simple declaration of the variable `x` with the `tinyint` data type and the\\nimplicit default value of `null`:\\n\\n```\\nDECLARE x tinyint;\\n```\\n\\nA declaration of multiple string variables with length restricted to 25\\ncharacters:\\n\\n```\\nDECLARE first_name, last_name, middle_name varchar(25);\\n```\\n\\nA declaration of an exact decimal number with a default value:\\n\\n```\\nDECLARE uptime_requirement decimal DEFAULT 99.999;\\n```\\n\\nA declaration with a default value from an expression:\\n\\n```\\nDECLARE start_time timestamp(3) with time zone DEFAULT now();\\n```\\n\\nFurther examples of varying complexity that cover usage of the `DECLARE`\\nstatement in combination with other statements are available in the\\n[](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/language/types)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}, {\"title\": \"Example SQL UDFs\", \"description\": null, \"content\": {\"Inline and catalog UDFs\": \"The following section shows the differences in usage with inline and catalog\\nUDFs with a simple SQL UDF example. The same pattern applies to all other\\nfollowing sections.\\n\\nA very simple SQL UDF that returns a static value without requiring any input:\\n\\n```\\nFUNCTION answer()\\nRETURNS BIGINT\\nRETURN 42\\n```\\n\\nA full example of this UDF as inline UDF and usage in a string concatenation\\nwith a cast:\\n\\n```\\nWITH\\n FUNCTION answer()\\n RETURNS BIGINT\\n RETURN 42\\nSELECT 'The answer is ' || CAST(answer() as varchar);\\n-- The answer is 42\\n```\\n\\nProvided the catalog `example` supports UDF storage in the `default` schema, you\\ncan use the following:\\n\\n```\\nCREATE FUNCTION example.default.answer()\\n RETURNS BIGINT\\n RETURN 42;\\n```\\n\\nWith the UDF stored in the catalog, you can run the UDF multiple times without\\nrepeated definition:\\n\\n```\\nSELECT example.default.answer() + 1; -- 43\\nSELECT 'The answer is ' || CAST(example.default.answer() as varchar); -- The answer is 42\\n```\\n\\nAlternatively, you can configure the SQL PATH in the [](config-properties) to a\\ncatalog and schema that support UDF storage:\\n\\n```\\nsql.default-function-catalog=example\\nsql.default-function-schema=default\\nsql.path=example.default\\n```\\n\\nNow you can manage UDFs without the full path:\\n\\n```\\nCREATE FUNCTION answer()\\n RETURNS BIGINT\\n RETURN 42;\\n```\\n\\nUDF invocation works without the full path:\\n\\n```\\nSELECT answer() + 5; -- 47\\n```\", \"Declaration examples\": \"The result of calling the UDF `answer()` is always identical, so you can\\ndeclare it as deterministic, and add some other information:\\n\\n```\\nFUNCTION answer()\\nLANGUAGE SQL\\nDETERMINISTIC\\nRETURNS BIGINT\\nCOMMENT 'Provide the answer to the question about life, the universe, and everything.'\\nRETURN 42\\n```\\n\\nThe comment and other information about the UDF is visible in the output of\\n[](/sql/show-functions).\\n\\nA simple UDF that returns a greeting back to the input string `fullname`\\nconcatenating two strings and the input value:\\n\\n```\\nFUNCTION hello(fullname VARCHAR)\\nRETURNS VARCHAR\\nRETURN 'Hello, ' || fullname || '!'\\n```\\n\\nFollowing is an example invocation:\\n\\n```\\nSELECT hello('Jane Doe'); -- Hello, Jane Doe!\\n```\\n\\nA first example UDF, that uses multiple statements in a `BEGIN` block. It\\ncalculates the result of a multiplication of the input integer with `99`. The\\n`bigint` data type is used for all variables and values. The value of integer\\n`99` is cast to `bigint` in the default value assignment for the variable `x`:\\n\\n```\\nFUNCTION times_ninety_nine(a bigint)\\nRETURNS bigint\\nBEGIN\\n DECLARE x bigint DEFAULT CAST(99 AS bigint);\\n RETURN x * a;\\nEND\\n```\\n\\nFollowing is an example invocation:\\n\\n```\\nSELECT times_ninety_nine(CAST(2 as bigint)); -- 198\\n```\", \"Conditional flows\": \"A first example of conditional flow control in a SQL UDF using the `CASE`\\nstatement. The simple `bigint` input value is compared to a number of values:\\n\\n```\\nFUNCTION simple_case(a bigint)\\nRETURNS varchar\\nBEGIN\\n CASE a\\n WHEN 0 THEN RETURN 'zero';\\n WHEN 1 THEN RETURN 'one';\\n WHEN 10 THEN RETURN 'ten';\\n WHEN 20 THEN RETURN 'twenty';\\n ELSE RETURN 'other';\\n END CASE;\\n RETURN NULL;\\nEND\\n```\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT simple_case(0); -- zero\\nSELECT simple_case(1); -- one\\nSELECT simple_case(-1); -- other (from else clause)\\nSELECT simple_case(10); -- ten\\nSELECT simple_case(11); -- other (from else clause)\\nSELECT simple_case(20); -- twenty\\nSELECT simple_case(100); -- other (from else clause)\\nSELECT simple_case(null); -- null .. but really??\\n```\\n\\nA second example of a SQL UDF with a `CASE` statement, this time with two\\nparameters, showcasing the importance of the order of the conditions:\\n\\n```\\nFUNCTION search_case(a bigint, b bigint)\\nRETURNS varchar\\nBEGIN\\n CASE\\n WHEN a = 0 THEN RETURN 'zero';\\n WHEN b = 1 THEN RETURN 'one';\\n WHEN a = DECIMAL '10.0' THEN RETURN 'ten';\\n WHEN b = 20.0E0 THEN RETURN 'twenty';\\n ELSE RETURN 'other';\\n END CASE;\\n RETURN NULL;\\nEND\\n```\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT search_case(0,0); -- zero\\nSELECT search_case(1,1); -- one\\nSELECT search_case(0,1); -- zero (not one since the second check is never reached)\\nSELECT search_case(10,1); -- one (not ten since the third check is never reached)\\nSELECT search_case(10,2); -- ten\\nSELECT search_case(10,20); -- ten (not twenty)\\nSELECT search_case(0,20); -- zero (not twenty)\\nSELECT search_case(3,20); -- twenty\\nSELECT search_case(3,21); -- other\\nSELECT simple_case(null,null); -- null .. but really??\\n```\", \"Fibonacci example\": \"This SQL UDF calculates the `n`-th value in the Fibonacci series, in which each\\nnumber is the sum of the two preceding ones. The two initial values are set to\\n`1` as the defaults for `a` and `b`. The UDF uses an `IF` statement condition to\\nreturn `1` for all input values of `2` or less. The `WHILE` block then starts to\\ncalculate each number in the series, starting with `a=1` and `b=1` and iterates\\nuntil it reaches the `n`-th position. In each iteration it sets `a` and `b` for\\nthe preceding to values, so it can calculate the sum, and finally return it.\\nNote that processing the UDF takes longer and longer with higher `n` values, and\\nthe result is deterministic:\\n\\n```\\nFUNCTION fib(n bigint)\\nRETURNS bigint\\nBEGIN\\n DECLARE a, b bigint DEFAULT 1;\\n DECLARE c bigint;\\n IF n <= 2 THEN\\n RETURN 1;\\n END IF;\\n WHILE n > 2 DO\\n SET n = n - 1;\\n SET c = a + b;\\n SET a = b;\\n SET b = c;\\n END WHILE;\\n RETURN c;\\nEND\\n```\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT fib(-1); -- 1\\nSELECT fib(0); -- 1\\nSELECT fib(1); -- 1\\nSELECT fib(2); -- 1\\nSELECT fib(3); -- 2\\nSELECT fib(4); -- 3\\nSELECT fib(5); -- 5\\nSELECT fib(6); -- 8\\nSELECT fib(7); -- 13\\nSELECT fib(8); -- 21\\n```\", \"Labels and loops\": \"This SQL UDF uses the `top` label to name the `WHILE` block, and then controls\\nthe flow with conditional statements, `ITERATE`, and `LEAVE`. For the values of\\n`a=1` and `a=2` in the first two iterations of the loop the `ITERATE` call moves\\nthe flow up to `top` before `b` is ever increased. Then `b` is increased for the\\nvalues `a=3`, `a=4`, `a=5`, `a=6`, and `a=7`, resulting in `b=5`. The `LEAVE`\\ncall then causes the exit of the block before a is increased further to `10` and\\ntherefore the result of the UDF is `5`:\\n\\n```\\nFUNCTION labels()\\nRETURNS bigint\\nBEGIN\\n DECLARE a, b int DEFAULT 0;\\n top: WHILE a < 10 DO\\n SET a = a + 1;\\n IF a < 3 THEN\\n ITERATE top;\\n END IF;\\n SET b = b + 1;\\n IF a > 6 THEN\\n LEAVE top;\\n END IF;\\n END WHILE;\\n RETURN b;\\nEND\\n```\\n\\nThis SQL UDF implements calculating the `n` to the power of `p` by repeated\\nmultiplication and keeping track of the number of multiplications performed.\\nNote that this SQL UDF does not return the correct `0` for `p=0` since the `top`\\nblock is merely escaped and the value of `n` is returned. The same incorrect\\nbehavior happens for negative values of `p`:\\n\\n```\\nFUNCTION power(n int, p int)\\nRETURNS int\\n BEGIN\\n DECLARE r int DEFAULT n;\\n top: LOOP\\n IF p <= 1 THEN\\n LEAVE top;\\n END IF;\\n SET r = r * n;\\n SET p = p - 1;\\n END LOOP;\\n RETURN r;\\n END\\n```\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT power(2, 2); -- 4\\nSELECT power(2, 8); -- 256\\nSELECT power(3, 3); -- 256\\nSELECT power(3, 0); -- 3, which is wrong\\nSELECT power(3, -2); -- 3, which is wrong\\n```\\n\\nThis SQL UDF returns `7` as a result of the increase of `b` in the loop from\\n`a=3` to `a=10`:\\n\\n```\\nFUNCTION test_repeat_continue()\\nRETURNS bigint\\nBEGIN\\n DECLARE a int DEFAULT 0;\\n DECLARE b int DEFAULT 0;\\n top: REPEAT\\n SET a = a + 1;\\n IF a <= 3 THEN\\n ITERATE top;\\n END IF;\\n SET b = b + 1;\\n UNTIL a >= 10\\n END REPEAT;\\n RETURN b;\\nEND\\n```\\n\\nThis SQL UDF returns `2` and shows that labels can be repeated and label usage\\nwithin a block refers to the label of that block:\\n\\n```\\nFUNCTION test()\\nRETURNS int\\nBEGIN\\n DECLARE r int DEFAULT 0;\\n abc: LOOP\\n SET r = r + 1;\\n LEAVE abc;\\n END LOOP;\\n abc: LOOP\\n SET r = r + 1;\\n LEAVE abc;\\n END LOOP;\\n RETURN r;\\nEND\\n```\", \"SQL UDFs and built-in functions\": \"This SQL UDF shows that multiple data types and built-in functions like\\n`length()` and `cardinality()` can be used in a UDF. The two nested `BEGIN`\\nblocks also show how variable names are local within these blocks `x`, but the\\nglobal `r` from the top-level block can be accessed in the nested blocks:\\n\\n```\\nFUNCTION test()\\nRETURNS bigint\\nBEGIN\\n DECLARE r bigint DEFAULT 0;\\n BEGIN\\n DECLARE x varchar DEFAULT 'hello';\\n SET r = r + length(x);\\n END;\\n BEGIN\\n DECLARE x array(int) DEFAULT array[1, 2, 3];\\n SET r = r + cardinality(x);\\n END;\\n RETURN r;\\nEND\\n```\", \"Optional parameter example\": \"UDFs can invoke other UDFs and other functions. The full signature of a UDF is\\ncomposed of the UDF name and parameters, and determines the exact UDF to use.\\nYou can declare multiple UDFs with the same name, but with a different number of\\narguments or different argument types. One example use case is to implement an\\noptional parameter.\\n\\nThe following SQL UDF truncates a string to the specified length including three\\ndots at the end of the output:\\n\\n```\\nFUNCTION dots(input varchar, length integer)\\nRETURNS varchar\\nBEGIN\\n IF length(input) > length THEN\\n RETURN substring(input, 1, length-3) || '...';\\n END IF;\\n RETURN input;\\nEND;\\n```\\n\\nFollowing are example invocations and output:\\n\\n```\\nSELECT dots('A long string that will be shortened',15);\\n-- A long strin...\\nSELECT dots('A short string',15);\\n-- A short string\\n```\\n\\nIf you want to provide a UDF with the same name, but without the parameter\\nfor length, you can create another UDF that invokes the preceding UDF:\\n\\n```\\nFUNCTION dots(input varchar)\\nRETURNS varchar\\nRETURN dots(input, 15);\\n```\\n\\nYou can now use both UDFs. When the length parameter is omitted, the default\\nvalue from the second declaration is used.\\n\\n```\\nSELECT dots('A long string that will be shortened',15);\\n-- A long strin...\\nSELECT dots('A long string that will be shortened');\\n-- A long strin...\\nSELECT dots('A long string that will be shortened',20);\\n-- A long string tha...\\n```\", \"Date string parsing example\": \"This example SQL UDF parses a date string of type `VARCHAR` into `TIMESTAMP WITH\\nTIME ZONE`. Date strings are commonly represented by ISO 8601 standard, such as\\n`2023-12-01`, `2023-12-01T23`. Date strings are also often represented in the\\n`YYYYmmdd` and `YYYYmmddHH` format, such as `20230101` and `2023010123`. Hive\\ntables can use this format to represent day and hourly partitions, for example\\n`/day=20230101`, `/hour=2023010123`.\\n\\nThis UDF parses date strings in a best-effort fashion and can be used as a\\nreplacement for date string manipulation functions such as `date`, `date_parse`,\\n`from_iso8601_date`, and `from_iso8601_timestamp`.\\n\\nNote that the UDF defaults the time value to `00:00:00.000` and the time\\nzone to the session time zone:\\n\\n```\\nFUNCTION from_date_string(date_string VARCHAR)\\nRETURNS TIMESTAMP WITH TIME ZONE\\nBEGIN\\n IF date_string like '%-%' THEN -- ISO 8601\\n RETURN from_iso8601_timestamp(date_string);\\n ELSEIF length(date_string) = 8 THEN -- YYYYmmdd\\n RETURN date_parse(date_string, '%Y%m%d');\\n ELSEIF length(date_string) = 10 THEN -- YYYYmmddHH\\n RETURN date_parse(date_string, '%Y%m%d%H');\\n END IF;\\n RETURN NULL;\\nEND\\n```\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT from_date_string('2023-01-01'); -- 2023-01-01 00:00:00.000 UTC (using the ISO 8601 format)\\nSELECT from_date_string('2023-01-01T23'); -- 2023-01-01 23:00:00.000 UTC (using the ISO 8601 format)\\nSELECT from_date_string('2023-01-01T23:23:23'); -- 2023-01-01 23:23:23.000 UTC (using the ISO 8601 format)\\nSELECT from_date_string('20230101'); -- 2023-01-01 00:00:00.000 UTC (using the YYYYmmdd format)\\nSELECT from_date_string('2023010123'); -- 2023-01-01 23:00:00.000 UTC (using the YYYYmmddHH format)\\nSELECT from_date_string(NULL); -- NULL (handles NULL string)\\nSELECT from_date_string('abc'); -- NULL (not matched to any format)\\n```\", \"Human-readable days\": \"Trino includes a built-in function called {func}`human_readable_seconds` that\\nformats a number of seconds into a string:\\n\\n```\\nSELECT human_readable_seconds(134823);\\n-- 1 day, 13 hours, 27 minutes, 3 seconds\\n```\\n\\nThe example SQL UDF `hrd` formats a number of days into a human-readable text\\nthat provides the approximate number of years and months:\\n\\n```\\nFUNCTION hrd(d integer)\\nRETURNS VARCHAR\\nBEGIN\\n DECLARE answer varchar default 'About ';\\n DECLARE years real;\\n DECLARE months real;\\n SET years = truncate(d/365);\\n IF years > 0 then\\n SET answer = answer || format('%1.0f', years) || ' year';\\n END IF;\\n IF years > 1 THEN\\n SET answer = answer || 's';\\n END IF;\\n SET d = d - cast( years AS integer) * 365 ;\\n SET months = truncate(d / 30);\\n IF months > 0 and years > 0 THEN\\n SET answer = answer || ' and ';\\n END IF;\\n IF months > 0 THEN\\n set answer = answer || format('%1.0f', months) || ' month';\\n END IF;\\n IF months > 1 THEN\\n SET answer = answer || 's';\\n END IF;\\n IF years < 1 and months < 1 THEN\\n SET answer = 'Less than 1 month';\\n END IF;\\n RETURN answer;\\nEND;\\n```\\n\\nThe following examples show the output for a range of values under one month,\\nunder one year, and various larger values:\\n\\n```\\nSELECT hrd(10); -- Less than 1 month\\nSELECT hrd(95); -- About 3 months\\nSELECT hrd(400); -- About 1 year and 1 month\\nSELECT hrd(369); -- About 1 year\\nSELECT hrd(800); -- About 2 years and 2 months\\nSELECT hrd(1100); -- About 3 years\\nSELECT hrd(5000); -- About 13 years and 8 months\\n```\\n\\nImprovements of the SQL UDF could include the following modifications:\\n\\n['Take into account that one month equals 30.4375 days.', 'Take into account that one year equals 365.25 days.', 'Add weeks to the output.', 'Expand to cover decades, centuries, and millennia.']\", \"Truncating long strings\": \"This example SQL UDF `strtrunc` truncates strings longer than 60 characters,\\nleaving the first 30 and the last 25 characters, and cutting out extra\\ncharacters in the middle:\\n\\n```\\nFUNCTION strtrunc(input VARCHAR)\\nRETURNS VARCHAR\\nRETURN\\n CASE WHEN length(input) > 60\\n THEN substr(input, 1, 30) || ' ... ' || substr(input, length(input) - 25)\\n ELSE input\\n END;\\n```\\n\\nThe preceding declaration is very compact and consists of only one complex\\nstatement with a [`CASE` expression](case-expression) and multiple function\\ncalls. It can therefore define the complete logic in the `RETURN` clause.\\n\\nThe following statement shows the same capability within the SQL UDF itself.\\nNote the duplicate `RETURN` inside and outside the `CASE` statement and the\\nrequired `END CASE;`. The second `RETURN` statement is required, because a SQL\\nUDF must end with a `RETURN` statement. As a result the `ELSE` clause can be\\nomitted:\\n\\n```\\nFUNCTION strtrunc(input VARCHAR)\\nRETURNS VARCHAR\\nBEGIN\\n CASE WHEN length(input) > 60\\n THEN\\n RETURN substr(input, 1, 30) || ' ... ' || substr(input, length(input) - 25);\\n ELSE\\n RETURN input;\\n END CASE;\\n RETURN input;\\nEND;\\n```\\n\\nThe next example changes over from a `CASE` to an `IF` statement, and avoids the\\nduplicate `RETURN`:\\n\\n```\\nFUNCTION strtrunc(input VARCHAR)\\nRETURNS VARCHAR\\nBEGIN\\n IF length(input) > 60 THEN\\n RETURN substr(input, 1, 30) || ' ... ' || substr(input, length(input) - 25);\\n END IF;\\n RETURN input;\\nEND;\\n```\\n\\nAll the preceding examples create the same output. Following is an example query\\nwhich generates long strings to truncate:\\n\\n```\\nWITH\\ndata AS (\\n SELECT substring('strtrunc truncates strings longer than 60 characters,\\n leaving the prefix and suffix visible', 1, s.num) AS value\\n FROM table(sequence(start=>40, stop=>80, step=>5)) AS s(num)\\n)\\nSELECT\\n data.value\\n , strtrunc(data.value) AS truncated\\nFROM data\\nORDER BY data.value;\\n```\\n\\nThe preceding query produces the following output with all variants of the SQL\\nUDF:\\n\\n```\\n value | truncated\\n----------------------------------------------------------------------------------+---------------------------------------------------------------\\n strtrunc truncates strings longer than 6 | strtrunc truncates strings longer than 6\\n strtrunc truncates strings longer than 60 cha | strtrunc truncates strings longer than 60 cha\\n strtrunc truncates strings longer than 60 characte | strtrunc truncates strings longer than 60 characte\\n strtrunc truncates strings longer than 60 characters, l | strtrunc truncates strings longer than 60 characters, l\\n strtrunc truncates strings longer than 60 characters, leavin | strtrunc truncates strings longer than 60 characters, leavin\\n strtrunc truncates strings longer than 60 characters, leaving the | strtrunc truncates strings lon ... 60 characters, leaving the\\n strtrunc truncates strings longer than 60 characters, leaving the pref | strtrunc truncates strings lon ... aracters, leaving the pref\\n strtrunc truncates strings longer than 60 characters, leaving the prefix an | strtrunc truncates strings lon ... ers, leaving the prefix an\\n strtrunc truncates strings longer than 60 characters, leaving the prefix and suf | strtrunc truncates strings lon ... leaving the prefix and suf\\n```\\n\\nA possible improvement is to introduce parameters for the total length.\", \"Formatting bytes\": \"Trino includes a built-in `format_number()` function. However, it is using units\\nthat do not work well with bytes. The following `format_data_size` SQL UDF can\\nformat large values of bytes into a human-readable string:\\n\\n```\\nFUNCTION format_data_size(input BIGINT)\\nRETURNS VARCHAR\\n BEGIN\\n DECLARE value DOUBLE DEFAULT CAST(input AS DOUBLE);\\n DECLARE result BIGINT;\\n DECLARE base INT DEFAULT 1024;\\n DECLARE unit VARCHAR DEFAULT 'B';\\n DECLARE format VARCHAR;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'kB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'MB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'GB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'TB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'PB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'EB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'ZB';\\n END IF;\\n IF abs(value) >= base THEN\\n SET value = value / base;\\n SET unit = 'YB';\\n END IF;\\n IF abs(value) < 10 THEN\\n SET format = '%.2f';\\n ELSEIF abs(value) < 100 THEN\\n SET format = '%.1f';\\n ELSE\\n SET format = '%.0f';\\n END IF;\\n RETURN format(format, value) || unit;\\n END;\\n```\\n\\nBelow is a query that shows how it formats a wide range of values:\\n\\n```\\nWITH\\ndata AS (\\n SELECT CAST(pow(10, s.p) AS BIGINT) AS num\\n FROM table(sequence(start=>1, stop=>18)) AS s(p)\\n UNION ALL\\n SELECT -CAST(pow(10, s.p) AS BIGINT) AS num\\n FROM table(sequence(start=>1, stop=>18)) AS s(p)\\n)\\nSELECT\\n data.num\\n , format_data_size(data.num) AS formatted\\nFROM data\\nORDER BY data.num;\\n```\\n\\nThe preceding query produces the following output:\\n\\n```\\n num | formatted\\n----------------------+-----------\\n -1000000000000000000 | -888PB\\n -100000000000000000 | -88.8PB\\n -10000000000000000 | -8.88PB\\n -1000000000000000 | -909TB\\n -100000000000000 | -90.9TB\\n -10000000000000 | -9.09TB\\n -1000000000000 | -931GB\\n -100000000000 | -93.1GB\\n -10000000000 | -9.31GB\\n -1000000000 | -954MB\\n -100000000 | -95.4MB\\n -10000000 | -9.54MB\\n -1000000 | -977kB\\n -100000 | -97.7kB\\n -10000 | -9.77kB\\n -1000 | -1000B\\n -100 | -100B\\n -10 | -10.0B\\n 0 | 0.00B\\n 10 | 10.0B\\n 100 | 100B\\n 1000 | 1000B\\n 10000 | 9.77kB\\n 100000 | 97.7kB\\n 1000000 | 977kB\\n 10000000 | 9.54MB\\n 100000000 | 95.4MB\\n 1000000000 | 954MB\\n 10000000000 | 9.31GB\\n 100000000000 | 93.1GB\\n 1000000000000 | 931GB\\n 10000000000000 | 9.09TB\\n 100000000000000 | 90.9TB\\n 1000000000000000 | 909TB\\n 10000000000000000 | 8.88PB\\n 100000000000000000 | 88.8PB\\n 1000000000000000000 | 888PB\\n```\", \"Charts\": \"Trino already has a built-in `bar()` [color function](/functions/color), but it\\nis using ANSI escape codes to output colors, and thus is only usable for\\ndisplaying results in a terminal. The following example shows a similar SQL UDF\\nthat only uses ASCII characters:\\n\\n```\\nFUNCTION ascii_bar(value DOUBLE)\\nRETURNS VARCHAR\\nBEGIN\\n DECLARE max_width DOUBLE DEFAULT 40.0;\\n RETURN array_join(\\n repeat('\\u2588',\\n greatest(0, CAST(floor(max_width * value) AS integer) - 1)), '')\\n || ARRAY[' ', '\\u258f', '\\u258e', '\\u258d', '\\u258c', '\\u258b', '\\u258a', '\\u2589', '\\u2588']\\n [cast((value % (cast(1 as double) / max_width)) * max_width * 8 + 1 as int)];\\nEND;\\n```\\n\\nIt can be used to visualize a value:\\n\\n```\\nWITH\\ndata AS (\\n SELECT\\n cast(s.num as double) / 100.0 AS x,\\n sin(cast(s.num as double) / 100.0) AS y\\n FROM table(sequence(start=>0, stop=>314, step=>10)) AS s(num)\\n)\\nSELECT\\n data.x,\\n round(data.y, 4) AS y,\\n ascii_bar(data.y) AS chart\\nFROM data\\nORDER BY data.x;\\n```\\n\\nThe preceding query produces the following output:\\n\\n```\\n x | y | chart\\n-----+--------+-----------------------------------------\\n 0.0 | 0.0 |\\n 0.1 | 0.0998 | \\u2588\\u2588\\u2588\\n 0.2 | 0.1987 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\n 0.3 | 0.2955 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2589\\n 0.4 | 0.3894 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 0.5 | 0.4794 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258f\\n 0.6 | 0.5646 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 0.7 | 0.6442 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258a\\n 0.8 | 0.7174 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258a\\n 0.9 | 0.7833 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258d\\n 1.0 | 0.8415 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 1.1 | 0.8912 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 1.2 | 0.932 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258e\\n 1.3 | 0.9636 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258c\\n 1.4 | 0.9854 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258d\\n 1.5 | 0.9975 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2589\\n 1.6 | 0.9996 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\n 1.7 | 0.9917 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 1.8 | 0.9738 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\n 1.9 | 0.9463 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2589\\n 2.0 | 0.9093 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258d\\n 2.1 | 0.8632 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258c\\n 2.2 | 0.8085 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258d\\n 2.3 | 0.7457 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2589\\n 2.4 | 0.6755 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\n 2.5 | 0.5985 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\n 2.6 | 0.5155 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 2.7 | 0.4274 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258f\\n 2.8 | 0.335 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258d\\n 2.9 | 0.2392 | \\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u2588\\u258b\\n 3.0 | 0.1411 | \\u2588\\u2588\\u2588\\u2588\\u258b\\n 3.1 | 0.0416 | \\u258b\\n```\\n\\nIt is also possible to draw more compacted charts. Following is a SQL UDF\\ndrawing vertical bars:\\n\\n```\\nFUNCTION vertical_bar(value DOUBLE)\\nRETURNS VARCHAR\\nRETURN ARRAY[' ', '\\u2581', '\\u2582', '\\u2583', '\\u2584', '\\u2585', '\\u2586', '\\u2587', '\\u2588'][cast(value * 8 + 1 as int)];\\n```\\n\\nIt can be used to draw a distribution of values, in a single column:\\n\\n```\\nWITH\\nmeasurements(sensor_id, recorded_at, value) AS (\\n VALUES\\n ('A', date '2023-01-01', 5.0)\\n , ('A', date '2023-01-03', 7.0)\\n , ('A', date '2023-01-04', 15.0)\\n , ('A', date '2023-01-05', 14.0)\\n , ('A', date '2023-01-08', 10.0)\\n , ('A', date '2023-01-09', 1.0)\\n , ('A', date '2023-01-10', 7.0)\\n , ('A', date '2023-01-11', 8.0)\\n , ('B', date '2023-01-03', 2.0)\\n , ('B', date '2023-01-04', 3.0)\\n , ('B', date '2023-01-05', 2.5)\\n , ('B', date '2023-01-07', 2.75)\\n , ('B', date '2023-01-09', 4.0)\\n , ('B', date '2023-01-10', 1.5)\\n , ('B', date '2023-01-11', 1.0)\\n),\\ndays AS (\\n SELECT date_add('day', s.num, date '2023-01-01') AS day\\n -- table function arguments need to be constant but range could be calculated\\n -- using: SELECT date_diff('day', max(recorded_at), min(recorded_at)) FROM measurements\\n FROM table(sequence(start=>0, stop=>10)) AS s(num)\\n),\\nsensors(id) AS (VALUES ('A'), ('B')),\\nnormalized AS (\\n SELECT\\n sensors.id AS sensor_id,\\n days.day,\\n value,\\n value / max(value) OVER (PARTITION BY sensor_id) AS normalized\\n FROM days\\n CROSS JOIN sensors\\n LEFT JOIN measurements m ON day = recorded_at AND m.sensor_id = sensors.id\\n)\\nSELECT\\n sensor_id,\\n min(day) AS start,\\n max(day) AS stop,\\n count(value) AS num_values,\\n min(value) AS min_value,\\n max(value) AS max_value,\\n avg(value) AS avg_value,\\n array_join(array_agg(coalesce(vertical_bar(normalized), ' ') ORDER BY day),\\n '') AS distribution\\nFROM normalized\\nWHERE sensor_id IS NOT NULL\\nGROUP BY sensor_id\\nORDER BY sensor_id;\\n```\\n\\nThe preceding query produces the following output:\\n\\n```\\n sensor_id | start | stop | num_values | min_value | max_value | avg_value | distribution\\n-----------+------------+------------+------------+-----------+-----------+-----------+--------------\\n A | 2023-01-01 | 2023-01-11 | 8 | 1.00 | 15.00 | 8.38 | \\u2583 \\u2584\\u2588\\u2587 \\u2585\\u2581\\u2584\\u2584\\n B | 2023-01-01 | 2023-01-11 | 7 | 1.00 | 4.00 | 2.39 | \\u2584\\u2586\\u2585 \\u2586 \\u2588\\u2583\\u2582\\n```\", \"Top-N\": \"Trino already has a built-in [aggregate function](/functions/aggregate) called\\n`approx_most_frequent()` that can calculate the most frequently occurring\\nvalues. It returns a map with values as keys and number of occurrences as\\nvalues. Maps are not ordered, so when displayed, the entries can change places\\non subsequent runs of the same query, and readers must still compare all\\nfrequencies to find the one most frequent value. The following is a SQL UDF that\\nreturns ordered results as a string:\\n\\n```\\nFUNCTION format_topn(input map<varchar, bigint>)\\nRETURNS VARCHAR\\nNOT DETERMINISTIC\\nBEGIN\\n DECLARE freq_separator VARCHAR DEFAULT '=';\\n DECLARE entry_separator VARCHAR DEFAULT ', ';\\n RETURN array_join(transform(\\n reverse(array_sort(transform(\\n transform(\\n map_entries(input),\\n r -> cast(r AS row(key varchar, value bigint))\\n ),\\n r -> cast(row(r.value, r.key) AS row(value bigint, key varchar)))\\n )),\\n r -> r.key || freq_separator || cast(r.value as varchar)),\\n entry_separator);\\nEND;\\n```\\n\\nFollowing is an example query to count generated strings:\\n\\n```\\nWITH\\ndata AS (\\n SELECT lpad('', 3, chr(65+(s.num / 3))) AS value\\n FROM table(sequence(start=>1, stop=>10)) AS s(num)\\n),\\naggregated AS (\\n SELECT\\n array_agg(data.value ORDER BY data.value) AS all_values,\\n approx_most_frequent(3, data.value, 1000) AS top3\\n FROM data\\n)\\nSELECT\\n a.all_values,\\n a.top3,\\n format_topn(a.top3) AS top3_formatted\\nFROM aggregated a;\\n```\\n\\nThe preceding query produces the following result:\\n\\n```\\n all_values | top3 | top3_formatted\\n----------------------------------------------------+-----------------------+---------------------\\n [AAA, AAA, BBB, BBB, BBB, CCC, CCC, CCC, DDD, DDD] | {AAA=2, CCC=3, BBB=3} | CCC=3, BBB=3, AAA=2\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 3]\"}, {\"title\": \"IF\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nIF condition\\n THEN statements\\n [ ELSEIF condition THEN statements ]\\n [ ... ]\\n [ ELSE statements ]\\nEND IF\\n```\", \"Description\": \"The `IF THEN` statement is an optional construct to allow conditional processing\\nin [](/udf/sql). Each `condition` following an `IF` or `ELSEIF` must evaluate\\nto a boolean. The result of processing the expression must result in a boolean\\n`true` value to process the `statements` in the `THEN` block. A result of\\n`false` results in skipping the `THEN` block and moving to evaluate the next\\n`ELSEIF` and `ELSE` blocks in order.\\n\\nThe `ELSEIF` and `ELSE` segments are optional.\", \"Examples\": \"```\\nFUNCTION simple_if(a bigint)\\n RETURNS varchar\\n BEGIN\\n IF a = 0 THEN\\n RETURN 'zero';\\n ELSEIF a = 1 THEN\\n RETURN 'one';\\n ELSE\\n RETURN 'more than one or negative';\\n END IF;\\n END\\n```\\n\\nFurther examples of varying complexity that cover usage of the `IF` statement in\\ncombination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[Conditional expressions using `IF`](if-expression)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 4]\"}, {\"title\": \"ITERATE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nITERATE label\\n```\", \"Description\": \"The `ITERATE` statement allows processing of blocks in [](/udf/sql) to move\\nprocessing back to the start of a context block. Contexts are defined by a\\n[`label`](udf-sql-label). If no label is found, the functions fails with an\\nerror message.\", \"Examples\": \"```\\nFUNCTION count()\\nRETURNS bigint\\nBEGIN\\n DECLARE a int DEFAULT 0;\\n DECLARE b int DEFAULT 0;\\n top: REPEAT\\n SET a = a + 1;\\n IF a <= 3 THEN\\n ITERATE top;\\n END IF;\\n SET b = b + 1;\\n RETURN b;\\nEND\\n```\\n\\nFurther examples of varying complexity that cover usage of the `ITERATE`\\nstatement in combination with other statements are available in the\\n[](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/leave)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 5]\"}, {\"title\": \"LEAVE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nLEAVE label\\n```\", \"Description\": \"The `LEAVE` statement allows processing of blocks in [](/udf/sql) to move out of\\na specified context. Contexts are defined by a [`label`](udf-sql-label). If no\\nlabel is found, the functions fails with an error message.\", \"Examples\": \"The following function includes a `LOOP` labelled `top`. The conditional `IF`\\nstatement inside the loop can cause the exit from processing the loop when the\\nvalue for the parameter `p` is 1 or less. This can be the case if the value is\\npassed in as 1 or less or after a number of iterations through the loop.\\n\\n```\\nFUNCTION my_pow(n int, p int)\\nRETURNS int\\nBEGIN\\n DECLARE r int DEFAULT n;\\n top: LOOP\\n IF p <= 1 THEN\\n LEAVE top;\\n END IF;\\n SET r = r * n;\\n SET p = p - 1;\\n END LOOP;\\n RETURN r;\\nEND\\n```\\n\\nFurther examples of varying complexity that cover usage of the `LEAVE` statement\\nin combination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/iterate)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 6]\"}, {\"title\": \"LOOP\", \"description\": null, \"content\": {\"Synopsis\": \"```\\n[label :] LOOP\\n statements\\nEND LOOP\\n```\", \"Description\": \"The `LOOP` statement is an optional construct in [](/udf/sql) to allow processing of a block of statements\\nrepeatedly.\\n\\nThe block of `statements` is processed until an explicit use of `LEAVE` causes\\nprocessing to exit the loop. If processing reaches `END LOOP`, another iteration\\nof processing from the beginning starts. `LEAVE` statements are typically\\nwrapped in an `IF` statement that declares a condition to stop the loop.\\n\\nThe optional `label` before the `LOOP` keyword can be used to [name the\\nblock](udf-sql-label).\", \"Examples\": \"The following function counts up to `100` with a step size `step` in a loop\\nstarting from the start value `start_value`, and returns the number of\\nincremental steps in the loop to get to a value of `100` or higher:\\n\\n```\\nFUNCTION to_one_hundred(start_value int, step int)\\n RETURNS int\\n BEGIN\\n DECLARE count int DEFAULT 0;\\n DECLARE current int DEFAULT 0;\\n SET current = start_value;\\n abc: LOOP\\n IF current >= 100 THEN\\n LEAVE abc;\\n END IF;\\n SET count = count + 1;\\n SET current = current + step;\\n END LOOP;\\n RETURN count;\\n END\\n```\\n\\nExample invocations:\\n\\n```\\nSELECT to_one_hundred(90, 1); --10\\nSELECT to_one_hundred(0, 5); --20\\nSELECT to_one_hundred(12, 3); -- 30\\n```\\n\\nFurther examples of varying complexity that cover usage of the `LOOP` statement\\nin combination with other statements are available in the [SQL UDF examples\\ndocumentation](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/leave)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 7]\"}, {\"title\": \"REPEAT\", \"description\": null, \"content\": {\"Synopsis\": \"```\\n[label :] REPEAT\\n statements\\nUNTIL condition\\nEND REPEAT\\n```\", \"Description\": \"The `REPEAT UNTIL` statement is an optional construct in [](/udf/sql) to allow\\nprocessing of a block of statements as long as a condition is met. The condition\\nis validated as a last step of each iteration.\\n\\nThe block of statements is processed at least once. After the first, and every\\nsubsequent processing the expression `condidtion` is validated. If the result is\\n`true`, processing moves to `END REPEAT` and continues with the next statement in\\nthe function. If the result is `false`, the statements are processed again.\\n\\nThe optional `label` before the `REPEAT` keyword can be used to [name the\\nblock](udf-sql-label).\\n\\nNote that a `WHILE` statement is very similar, with the difference that for\\n`REPEAT` the statements are processed at least once, and for `WHILE` blocks the\\nstatements might not be processed at all.\", \"Examples\": \"The following SQL UDF shows a UDF with a `REPEAT` statement that runs until\\nthe value of `a` is greater or equal to `10`.\\n\\n```\\nFUNCTION test_repeat(a bigint)\\n RETURNS bigint\\n BEGIN\\n REPEAT\\n SET a = a + 1;\\n UNTIL a >= 10\\n END REPEAT;\\n RETURN a;\\n END\\n```\\n\\nSince `a` is also the input value and it is increased before the check the\\nUDF always returns `10` for input values of `9` or less, and the input value\\n\\n['1 for all higher values.']\\n\\nFollowing are a couple of example invocations with result and explanation:\\n\\n```\\nSELECT test_repeat(5); -- 10\\nSELECT test_repeat(9); -- 10\\nSELECT test_repeat(10); -- 11\\nSELECT test_repeat(11); -- 12\\nSELECT test_repeat(12); -- 13\\n```\\n\\nFurther examples of varying complexity that cover usage of the `REPEAT`\\nstatement in combination with other statements are available in the\\n[](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/loop)\", \"[](/udf/sql/while)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 8]\"}, {\"title\": \"RETURN\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nRETURN expression\\n```\", \"Description\": \"Provide the value from a [](/udf/sql) to the caller. The value is the result of\\nevaluating the expression. It can be a static value, a declared variable or a\\nmore complex expression.\", \"Examples\": \"The following examples return a static value, the result of an expression, and\\nthe value of the variable x:\\n\\n```\\nRETURN 42;\\nRETURN 6 * 7;\\nRETURN x;\\n```\\n\\nFurther examples of varying complexity that cover usage of the `RETURN`\\nstatement in combination with other statements are available in the\\n[](/udf/sql/examples).\\n\\nAll SQL UDFs must contain a `RETURN` statement at the end of the top-level block\\nin the `FUNCTION` declaration, even if it's unreachable.\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/function)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 9]\"}, {\"title\": \"SET\", \"description\": null, \"content\": {\"Synopsis\": \"```\\nSET identifier = expression\\n```\", \"Description\": \"Use the `SET` statement in [](/udf/sql) to assign a value to a variable,\\nreferenced by comma-separated `identifier`s. The value is determined by\\nevaluating the `expression` after the `=` sign.\\n\\nBefore the assignment the variable must be defined with a `DECLARE` statement.\\nThe data type of the variable must be identical to the data type of evaluating\\nthe `expression`.\", \"Examples\": \"The following functions returns the value `1` after setting the counter variable\\nmultiple times to different values:\\n\\n```\\nFUNCTION one()\\n RETURNS int\\n BEGIN\\n DECLARE counter int DEFAULT 1;\\n SET counter = 0;\\n SET counter = counter + 2;\\n SET counter = counter / counter;\\n RETURN counter;\\n END\\n```\\n\\nFurther examples of varying complexity that cover usage of the `SET` statement\\nin combination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/declare)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 10]\"}, {\"title\": \"WHILE\", \"description\": null, \"content\": {\"Synopsis\": \"```\\n[label :] WHILE condition DO\\n statements\\nEND WHILE\\n```\", \"Description\": \"The `WHILE` statement is an optional construct in [](/udf/sql) to allow\\nprocessing of a block of statements as long as a condition is met. The condition\\nis validated as a first step of each iteration.\\n\\nThe expression that defines the `condition` is evaluated at least once. If the\\nresult is `true`, processing moves to `DO`, through following `statements` and\\nback to `WHILE` and the `condition`. If the result is `false`, processing moves\\nto `END WHILE` and continues with the next statement in the function.\\n\\nThe optional `label` before the `WHILE` keyword can be used to [name the\\nblock](udf-sql-label).\\n\\nNote that a `WHILE` statement is very similar, with the difference that for\\n`REPEAT` the statements are processed at least once, and for `WHILE` blocks the\\nstatements might not be processed at all.\", \"Examples\": \"```\\nWHILE p > 1 DO\\n SET r = r * n;\\n SET p = p - 1;\\nEND WHILE;\\n```\\n\\nFurther examples of varying complexity that cover usage of the `WHILE` statement\\nin combination with other statements are available in the [](/udf/sql/examples).\", \"See also\": [\"[](/udf/sql)\", \"[](/udf/sql/loop)\", \"[](/udf/sql/repeat)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5, \\\"subpages\\\", 11]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0, \\\"subpages\\\", 31]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 2]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Distributed SQL Query Engine Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Core Query Processing Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Query Execution Model with Coordinator-Worker Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Coordinator node manages query planning, optimization, and coordination\", \"weight\": 3}, {\"requirements\": \"Worker nodes execute query fragments (tasks) with parallel processing\", \"weight\": 3}, {\"requirements\": \"Stage-based execution with split processing and driver management\", \"weight\": 3}, {\"requirements\": \"Exchange mechanism for inter-node data transfer\", \"weight\": 3}]}, {\"requirements\": \"Query Optimizer with Cost-Based Optimization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Rule-based and cost-based query plan optimization\", \"weight\": 3}, {\"requirements\": \"Join reordering and distribution strategy selection\", \"weight\": 2}, {\"requirements\": \"Predicate and projection pushdown to connectors\", \"weight\": 3}, {\"requirements\": \"Adaptive plan optimizations for runtime adjustments\", \"weight\": 2}]}, {\"requirements\": \"Memory and Resource Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Hierarchical memory pools with spill-to-disk capabilities\", \"weight\": 3}, {\"requirements\": \"Resource groups for query prioritization and limits\", \"weight\": 2}, {\"requirements\": \"Task concurrency and worker thread management\", \"weight\": 2}]}]}, {\"requirements\": \"Fault-Tolerant Execution System\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Query and task-level retry mechanisms\", \"weight\": 3}, {\"requirements\": \"Exchange manager for intermediate result persistence\", \"weight\": 3}, {\"requirements\": \"Graceful shutdown and failure recovery\", \"weight\": 2}]}]}, {\"requirements\": \"Pluggable Connector Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Service Provider Interface (SPI) Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Connector metadata and split management interfaces\", \"weight\": 3}, {\"requirements\": \"Page source and sink providers for data I/O\", \"weight\": 3}, {\"requirements\": \"Type mapping and serialization system\", \"weight\": 2}, {\"requirements\": \"Pushdown capability negotiation\", \"weight\": 2}]}, {\"requirements\": \"Data Source Connectors\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Relational Database Connectors\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"JDBC-based connectors with query pushdown\", \"weight\": 3}, {\"requirements\": \"Connection pooling and transaction management\", \"weight\": 2}]}, {\"requirements\": \"Big Data and Analytics Connectors\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Object storage connectors (Hive, Iceberg, Delta Lake)\", \"weight\": 3}, {\"requirements\": \"Streaming and real-time connectors (Kafka, Kinesis)\", \"weight\": 2}, {\"requirements\": \"Search and document stores (Elasticsearch, MongoDB)\", \"weight\": 2}]}, {\"requirements\": \"Cloud Platform Connectors\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Cloud warehouse connectors (BigQuery, Snowflake, Redshift)\", \"weight\": 3}, {\"requirements\": \"Cloud-native authentication and authorization\", \"weight\": 2}]}]}, {\"requirements\": \"Object Storage Integration\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"File System Abstraction Layer\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-cloud storage support (S3, Azure, GCS, HDFS)\", \"weight\": 3}, {\"requirements\": \"Authentication and security mapping\", \"weight\": 2}, {\"requirements\": \"File system caching for performance\", \"weight\": 2}]}, {\"requirements\": \"Table Format Support\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Columnar format readers (Parquet, ORC)\", \"weight\": 3}, {\"requirements\": \"Transactional table formats (Iceberg, Delta Lake, Hudi)\", \"weight\": 3}, {\"requirements\": \"Schema evolution and time travel capabilities\", \"weight\": 2}]}]}]}, {\"requirements\": \"Security and Access Control Framework\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Layer Authentication System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Protocol-level authentication (TLS/HTTPS, certificates)\", \"weight\": 3}, {\"requirements\": \"Identity provider integration (LDAP, OAuth2, Kerberos, JWT)\", \"weight\": 3}, {\"requirements\": \"Internal cluster security with shared secrets\", \"weight\": 2}]}, {\"requirements\": \"Authorization and Access Control\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Pluggable access control systems\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"File-based access control with rule evaluation\", \"weight\": 2}, {\"requirements\": \"External policy engines (OPA, Ranger)\", \"weight\": 2}, {\"requirements\": \"Role-based access control (RBAC)\", \"weight\": 2}]}, {\"requirements\": \"Fine-grained Permission System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Catalog, schema, table, and column-level permissions\", \"weight\": 3}, {\"requirements\": \"Row filtering and column masking\", \"weight\": 2}, {\"requirements\": \"Function and procedure access control\", \"weight\": 2}]}]}, {\"requirements\": \"User and Group Management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"User mapping and identity transformation\", \"weight\": 2}, {\"requirements\": \"Group provider integration\", \"weight\": 2}]}]}, {\"requirements\": \"SQL Language Engine and Function System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"ANSI SQL Compliance and Extensions\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Complete DDL/DML statement support\", \"weight\": 3}, {\"requirements\": \"Advanced SQL features (CTEs, window functions, pattern matching)\", \"weight\": 2}, {\"requirements\": \"Transaction support with ACID properties\", \"weight\": 2}]}, {\"requirements\": \"Comprehensive Function Library\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Built-in function categories (math, string, date, JSON, etc.)\", \"weight\": 2}, {\"requirements\": \"Aggregate and window functions\", \"weight\": 2}, {\"requirements\": \"Specialized functions (geospatial, ML, statistical)\", \"weight\": 1}]}, {\"requirements\": \"User-Defined Function (UDF) Framework\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"SQL UDF support with control flow\", \"weight\": 2}, {\"requirements\": \"Python UDF integration\", \"weight\": 2}, {\"requirements\": \"Inline and catalog function management\", \"weight\": 2}]}, {\"requirements\": \"Type System and Data Handling\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Rich type system with complex types (arrays, maps, rows)\", \"weight\": 3}, {\"requirements\": \"Type coercion and conversion mechanisms\", \"weight\": 2}, {\"requirements\": \"JSON processing and path expressions\", \"weight\": 2}]}]}, {\"requirements\": \"Administration and Operations Framework\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Configuration Management System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Hierarchical property system with validation\", \"weight\": 3}, {\"requirements\": \"Dynamic catalog management\", \"weight\": 2}, {\"requirements\": \"Session property management\", \"weight\": 2}]}, {\"requirements\": \"Monitoring and Observability\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"JMX metrics and monitoring integration\", \"weight\": 2}, {\"requirements\": \"Event listener framework for auditing\", \"weight\": 2}, {\"requirements\": \"OpenTelemetry and OpenMetrics support\", \"weight\": 2}, {\"requirements\": \"Query execution tracking and statistics\", \"weight\": 3}]}, {\"requirements\": \"Web UI and Client Interfaces\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Administrative web interface with query monitoring\", \"weight\": 2}, {\"requirements\": \"Command-line interface (CLI) with interactive features\", \"weight\": 2}, {\"requirements\": \"JDBC driver with protocol optimization\", \"weight\": 3}, {\"requirements\": \"Client protocol with spooling support\", \"weight\": 2}]}, {\"requirements\": \"Deployment and Scaling\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Container and Kubernetes deployment support\", \"weight\": 2}, {\"requirements\": \"Node scheduling and network topology awareness\", \"weight\": 2}, {\"requirements\": \"Plugin system for extensibility\", \"weight\": 2}]}]}]}"}}},{"rowIdx":20,"cells":{"repo_name":{"kind":"string","value":"wazuh"},"repo_url":{"kind":"string","value":"https://github.com/wazuh/wazuh"},"commit_id":{"kind":"string","value":"44b7cd33e05abb7730228bb092b23b419ee4f15e"},"docs_tree":{"kind":"string","value":"{\"title\": \"wazuh\", \"description\": \"Documentation for wazuh\", \"subpages\": [{\"title\": \"Readme\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"Introduction \": \"<detail_content>\"}}, {\"title\": \"Summary\", \"path\": \"[\\\"subpages\\\", 1]\", \"content\": {\"Summary\": \"<detail_content>\", \"Development Documentation\": \"<detail_content>\", \"Reference Manual\": \"<detail_content>\", \"Diagnostic Documentation\": \"<detail_content>\"}}, {\"title\": \"Ref\", \"description\": \"Documentation section: ref\", \"path\": \"[\\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Readme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Introduction\": \"<detail_content>\"}}, {\"title\": \"Architecture\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"Architecture\": \"<detail_content>\"}}, {\"title\": \"Backup Restore\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"Back Up and Restore\": \"<detail_content>\"}}, {\"title\": \"Compatibility\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"Compatibility\": \"<detail_content>\"}}, {\"title\": \"Configuration\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"Configuration\": \"<detail_content>\"}}, {\"title\": \"Description\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\", \"content\": {\"Description\": \"<detail_content>\"}}, {\"title\": \"Glossary\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\", \"content\": {\"Glossary\": \"<detail_content>\"}}, {\"title\": \"Performance\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\", \"content\": {\"Performance\": \"<detail_content>\"}}, {\"title\": \"Security\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\", \"content\": {\"Security\": \"<detail_content>\"}}, {\"title\": \"Uninstall\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 9]\", \"content\": {\"Uninstall\": \"<detail_content>\"}}, {\"title\": \"Upgrade\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 10]\", \"content\": {\"Upgrade\": \"<detail_content>\"}}, {\"title\": \"Getting Started\", \"description\": \"Documentation section: getting-started\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11]\", \"subpages\": [{\"title\": \"Readme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\", \"content\": {\"Getting Started\": \"<detail_content>\"}}, {\"title\": \"Installation\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\", \"content\": {\"Installation\": \"<detail_content>\"}}, {\"title\": \"Packages\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\", \"content\": {\"Packages\": \"<detail_content>\"}}, {\"title\": \"Requirements\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\", \"content\": {\"Requirements\": \"<detail_content>\"}}]}, {\"title\": \"Modules\", \"description\": \"Documentation section: modules\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12]\", \"subpages\": [{\"title\": \"Readme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 0]\", \"content\": {\"Modules\": \"<detail_content>\"}}, {\"title\": \"Engine\", \"description\": \"Documentation section: engine\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"Engine\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"Introduction\": \"<detail_content>\", \"Data flow\": {\"Event\": \"<detail_content>\", \"Policy processing\": \"<detail_content>\", \"Decoding process\": \"<detail_content>\", \"Security enrichment process\": \"<detail_content>\", \"Archiving and alerting process\": \"<detail_content>\", \"Full pipeline\": \"<detail_content>\"}, \"Schema\": {\"Configuration\": \"<detail_content>\", \"Implications\": \"<detail_content>\"}, \"Managing the Engine's processing\": {\"Namespaces\": \"<detail_content>\", \"Assets Catalog\": \"<detail_content>\", \"Policies and Routes\": {\"Architecture\": \"<detail_content>\"}}, \"Assets\": {\"Attributes\": \"<detail_content>\", \"Stages\": \"<detail_content>\", \"Asset types\": \"<detail_content>\", \"Operations\": \"<detail_content>\", \"Execution Graph Summary\": \"<detail_content>\", \"Helper functions\": {\"Condition Helpers\": \"<detail_content>\", \"Mapping Helpers\": \"<detail_content>\", \"Transform Helpers\": \"<detail_content>\", \"Parsing rules\": \"<detail_content>\"}, \"Definitions\": {\"Restrictions\": \"<detail_content>\", \"Use Cases\": \"<detail_content>\"}, \"Variables\": \"<detail_content>\", \"Log Parsing\": \"<detail_content>\", \"Key Value Databases\": {\"Use cases\": \"<detail_content>\"}, \"Dates and Timestamps\": \"<detail_content>\", \"Geolocation\": \"<detail_content>\", \"Decoders\": \"<detail_content>\", \"Rules\": \"<detail_content>\", \"Outputs\": \"<detail_content>\", \"Filters\": \"<detail_content>\"}, \"Stages\": {\"Check/Allow\": {\"Condition list\": \"<detail_content>\", \"Conditional expression\": \"<detail_content>\"}, \"Parse\": {\"Parser expression\": \"<detail_content>\", \"Schema fields and parsers\": \"<detail_content>\", \"End tokens and field expressions\": \"<detail_content>\"}, \"Map\": \"<detail_content>\", \"Normalize/Enrichment\": \"<detail_content>\", \"Output\": \"<detail_content>\"}, \"Parsers\": {\"Schema parsers\": \"<detail_content>\"}, \"Debugging\": {\"Filtering Logs by Executable Name\": \"<detail_content>\", \"Filtering Logs by Severity\": \"<detail_content>\", \"Traces\": \"<detail_content>\"}, \"F.A.Q\": \"<detail_content>\"}}, {\"title\": \"Api Reference\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"API Reference\": \"<detail_content>\"}}, {\"title\": \"Architecture\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"Introduction\": \"<detail_content>\", \"Main Modules\": \"<detail_content>\", \"Module: Server\": \"<detail_content>\", \"Module: Orchestrator\": \"<detail_content>\", \"Module: Backend\": \"<detail_content>\", \"Module: Geo\": \"<detail_content>\", \"Module: KVDB\": \"<detail_content>\", \"Module: Persistent Storage\": \"<detail_content>\", \"Module: Global\": \"<detail_content>\", \"Module: Builder\": \"<detail_content>\", \"Module: API\": \"<detail_content>\"}}, {\"title\": \"Internal Development Tools\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"Api-communication\": \"<detail_content>\", \"Engine Suite\": {\"Key Tools in `engine-suite`:\": \"<detail_content>\"}, \"Engine Test Utils\": \"<detail_content>\", \"Engine Helper Test\": \"<detail_content>\", \"Engine Health Test\": \"<detail_content>\", \"Engine Integration Test\": \"<detail_content>\"}}, {\"title\": \"Summary\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\", \"content\": {\"Index\": {\"Filter\": \"<detail_content>\", \"Map\": \"<detail_content>\", \"Transformation\": \"<detail_content>\"}}}, {\"title\": \"Output Reference\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\", \"content\": {\"File\": {\"Signature\": \"<detail_content>\", \"Parameters\": \"<detail_content>\", \"Asset example\": \"<detail_content>\"}, \"Indexer\": {\"Signature\": \"<detail_content>\", \"Parameters\": \"<detail_content>\", \"Asset example\": \"<detail_content>\"}}}, {\"title\": \"Schema parser reference\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\", \"content\": {\"Boolean parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Long parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Double parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Float parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Byte parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Text parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples: With prefix\": \"<detail_content>\", \"Examples 2: With Prefix and suffix\": \"<detail_content>\"}, \"IP parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples\": \"<detail_content>\"}, \"Date parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Examples: Without locale\": \"<detail_content>\", \"Examples: With locale\": \"<detail_content>\"}, \"Binary parser\": {\"Behavior\": \"<detail_content>\", \"Signature\": \"<detail_content>\", \"Example\": \"<detail_content>\"}}}]}, {\"title\": \"Inventory Harvester\", \"description\": \"Documentation section: inventory-harvester\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"InventoryHarvester\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Overview\": {\"Key Responsibilities\": \"<detail_content>\", \"Data Flow\": \"<detail_content>\", \"Supported modules\": \"<detail_content>\"}, \"Related Epic\": \"<detail_content>\", \"Functional Requirements\": \"<detail_content>\", \"Non-Functional Requirements\": \"<detail_content>\", \"Implementation Restrictions\": \"<detail_content>\", \"Implementation Missing Features\": \"<detail_content>\"}}, {\"title\": \"Api Reference\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"API Reference\": \"<detail_content>\"}}, {\"title\": \"Architecture\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"Main Components\": \"<detail_content>\", \"High-Level Architecture Diagram\": \"<detail_content>\"}}, {\"title\": \"Settings\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"Connection to Wazuh Indexer\": \"<detail_content>\", \"Data to index\": \"<detail_content>\"}}, {\"title\": \"Description\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"FIM\": {\"Files\": \"<detail_content>\", \"Registries\": \"<detail_content>\"}, \"Inventory\": {\"System\": \"<detail_content>\", \"Packages\": \"<detail_content>\", \"Processes\": \"<detail_content>\", \"Ports\": \"<detail_content>\", \"Hardware\": \"<detail_content>\", \"Hotfixes\": \"<detail_content>\", \"Network Protocol\": \"<detail_content>\", \"Network address\": \"<detail_content>\", \"Network interfaces\": \"<detail_content>\", \"Groups\": \"<detail_content>\", \"Users\": \"<detail_content>\"}}}]}, {\"title\": \"Utils\", \"description\": \"Documentation section: utils\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3]\", \"subpages\": [{\"title\": \"Flatbuffers\", \"description\": \"Documentation section: flatbuffers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"Flatbuffers\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"Flatbuffer schemas\": {\"Common AgentInfo table\": \"<detail_content>\", \"FIM Delta table\": \"<detail_content>\", \"FIM Data table\": \"<detail_content>\", \"FIM Attributes table\": \"<detail_content>\", \"Inventory Delta table\": \"<detail_content>\", \"Inventory Provider union table\": \"<detail_content>\", \"Inventory providers\": \"<detail_content>\", \"SyncMsg table\": \"<detail_content>\", \"DataUnion table union\": \"<detail_content>\", \"State table\": \"<detail_content>\", \"AttributesUnion table union\": \"<detail_content>\", \"fim_file table\": \"<detail_content>\", \"fim_registry_key table\": \"<detail_content>\", \"fim_registry_value\": \"<detail_content>\"}}}]}]}, {\"title\": \"Vulnerability Scanner\", \"description\": \"Documentation section: vulnerability-scanner\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"Readme\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"Introduction\": \"<detail_content>\"}}, {\"title\": \"Indexed vulnerabilities \", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 1]\", \"content\": {\"Ubuntu \": \"<detail_content>\", \"Centos\": \"<detail_content>\", \"Windows \": \"<detail_content>\"}}, {\"title\": \"Arquitecture\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 2]\", \"content\": {\"Main Components\": \"<detail_content>\", \"High-Level diagram\": \"<detail_content>\"}}, {\"title\": \"Configuration \", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 3]\", \"content\": {\"Connection to Wazuh Indexer\": \"<detail_content>\"}}, {\"title\": \"Events format \", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 4]\", \"content\": {\"Syscollector event types\": \"<detail_content>\", \"Hotfix events (Only Windows)\": {\"Delta event\": \"<detail_content>\", \"Synchronization event\": \"<detail_content>\"}, \"Os events \": {\"Delta events \": \"<detail_content>\", \"Synchronization events\": \"<detail_content>\"}, \"Package events \": {\"Delta events \": \"<detail_content>\", \"Synchronization events\": \"<detail_content>\"}}}, {\"title\": \"Flatbuffer schemas\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 5]\", \"content\": {\"Flatbuffer schemas\": {\"Common AgentInfo table\": \"<detail_content>\", \"Inventory Delta table\": \"<detail_content>\", \"Inventory Provider union table\": \"<detail_content>\", \"Inventory providers\": \"<detail_content>\", \"SyncMsg table\": \"<detail_content>\", \"DataUnion table union\": \"<detail_content>\", \"State table\": \"<detail_content>\", \"AttributesUnion table union\": \"<detail_content>\", \"Integrity clear table\": \"<detail_content>\"}}}, {\"title\": \"Test tools\", \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 6]\", \"content\": {\"Compilation \": \"<detail_content>\", \"Vulnerability Scanner tool \": {\"Database creation \": \"<detail_content>\", \"Detection \": \"<detail_content>\", \"Mocking Wazuh-DB information\": \"<detail_content>\"}, \"RocksDB tool \": {\"Inspect databases \": {\"Indexer databases \": \"<detail_content>\", \"Inventory database\": \"<detail_content>\"}, \"Remove indexed vulnerability and clean databases\": {\"Output examples \": \"<detail_content>\"}}, \"`databaseFeedManager` Tool\": {\"Inject CVEs into the Vulnerability Scanner Database\": {\"Output example\": \"<detail_content>\"}}}}]}]}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"wazuh\", \"description\": \"Documentation for wazuh\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs\"}, \"subpages\": [{\"title\": \"Readme\", \"description\": null, \"content\": {\"Introduction \": \"In an attempt to explain the functioning and responsibilities of each component of the **Wazuh Manager**, the following documentation provides a comprehensive overview of main modules within the project. \"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"Summary\", \"description\": null, \"content\": {\"Summary\": [\"[Introduction](README.md)\"], \"Development Documentation\": \"\", \"Reference Manual\": [\"[Introduction](ref/README.md)\", [\"[Description](ref/description.md)\", \"[Architecture](ref/architecture.md)\", \"[Compatibility](ref/compatibility.md)\"], \"[Getting Started](ref/getting-started/README.md)\", [\"[Requirements](ref/getting-started/requirements.md)\", \"[Packages](ref/getting-started/packages.md)\", \"[Installation](ref/getting-started/installation.md)\"], \"[Configuration](ref/configuration.md)\", \"[Modules](ref/modules/README.md)\", [\"[Engine](ref/modules/engine/README.md)\", [\"[Architecture](ref/modules/engine/architecture.md)\", \"[API Reference](ref/modules/engine/api-reference.md)\", \"[Outputs Reference](ref/modules/engine/ref-output.md)\", \"[Parsers Reference](ref/modules/engine/ref-parser.md)\", \"[Helper Functions Reference](ref/modules/engine/ref-helper-functions.md)\", \"[Dev internal tools](ref/modules/engine/internal-tools.md)\"], \"[InventoryHarvester](ref/modules/inventory-harvester/README.md)\", [\"[Architecture](ref/modules/inventory-harvester/architecture.md)\", \"[API Reference](ref/modules/inventory-harvester/api-reference.md)\", \"[Configuration](ref/modules/inventory-harvester/configuration.md)\", \"[Description](ref/modules/inventory-harvester/description.md)\"], \"[VulnerabilityScanner](ref/modules/vulnerability-scanner/README.md)\", [\"[Architecture](ref/modules/vulnerability-scanner/architecture.md)\", \"[API Reference](ref/modules/vulnerability-scanner/api-reference.md)\", \"[Configuration](ref/modules/vulnerability-scanner/configuration.md)\", \"[Schemas](ref/modules/vulnerability-scanner/flatbuffers.md)\", \"[Test Tools](ref/modules/vulnerability-scanner/test-tools.md)\", \"[Events description](ref/modules/vulnerability-scanner/events.md)\"], \"[Flatbuffers](ref/modules/utils/flatbuffers/README.md)\"], \"[Upgrade](ref/upgrade.md)\", \"[Uninstall](ref/uninstall.md)\", \"[Back Up and Restore](ref/backup-restore.md)\", \"[Security](ref/security.md)\", \"[Performance](ref/performance.md)\", \"[Glossary](ref/glossary.md)\"], \"Diagnostic Documentation\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1]\"}, {\"title\": \"Ref\", \"description\": \"Documentation section: ref\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref\"}, \"subpages\": [{\"title\": \"Readme\", \"description\": null, \"content\": {\"Introduction\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Architecture\", \"description\": null, \"content\": {\"Architecture\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"Backup Restore\", \"description\": null, \"content\": {\"Back Up and Restore\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"Compatibility\", \"description\": null, \"content\": {\"Compatibility\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"Configuration\", \"description\": null, \"content\": {\"Configuration\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}, {\"title\": \"Description\", \"description\": null, \"content\": {\"Description\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 5]\"}, {\"title\": \"Glossary\", \"description\": null, \"content\": {\"Glossary\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 6]\"}, {\"title\": \"Performance\", \"description\": null, \"content\": {\"Performance\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 7]\"}, {\"title\": \"Security\", \"description\": null, \"content\": {\"Security\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 8]\"}, {\"title\": \"Uninstall\", \"description\": null, \"content\": {\"Uninstall\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 9]\"}, {\"title\": \"Upgrade\", \"description\": null, \"content\": {\"Upgrade\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 10]\"}, {\"title\": \"Getting Started\", \"description\": \"Documentation section: getting-started\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/getting-started\"}, \"subpages\": [{\"title\": \"Readme\", \"description\": null, \"content\": {\"Getting Started\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\"}, {\"title\": \"Installation\", \"description\": null, \"content\": {\"Installation\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\"}, {\"title\": \"Packages\", \"description\": null, \"content\": {\"Packages\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\"}, {\"title\": \"Requirements\", \"description\": null, \"content\": {\"Requirements\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 11]\"}, {\"title\": \"Modules\", \"description\": \"Documentation section: modules\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules\"}, \"subpages\": [{\"title\": \"Readme\", \"description\": null, \"content\": {\"Modules\": [\"[Inventory Harvester](inventory-harvester/)\", \"[Vulnerability Scanner](vulnerability-scanner/)\", \"[Flatbuffers](utils/flatbuffers/)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 0]\"}, {\"title\": \"Engine\", \"description\": \"Documentation section: engine\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules/engine\"}, \"subpages\": [{\"title\": \"Engine\", \"description\": null, \"content\": {\"Introduction\": \"The engine is responsible for transforming raw data into standardized schema documents, enriching it with threat intelligence, and forwarding it to designated destinations.\", \"Data flow\": {\"Event\": \"The purpose of the Engine is to convert unstructured or semi-structured logs into normalized and enriched events. The agent transmits logs within a JSON payload, which includes additional metadata such as OS information, log source, and other relevant details. The Engine processes these logs and generates a structured JSON event, incorporating all relevant information in accordance with the defined [schema](#).\\n\\nInput event example:\\n\\n```\\n{\\n \\\"@timestamp\\\": \\\"2025-01-23T17:40:37Z\\\",\\n \\\"agent\\\": {\\n \\\"groups\\\": [\\n \\\"group1\\\",\\n \\\"group2\\\"\\n ],\\n \\\"host\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"hostname\\\": \\\"wazuh-endpoint-linux\\\",\\n \\\"ip\\\": [\\n \\\"192.168.1.2\\\"\\n ],\\n \\\"os\\\": {\\n \\\"name\\\": \\\"Amazon Linux 2\\\",\\n \\\"platform\\\": \\\"Linux\\\"\\n }\\n },\\n \\\"id\\\": \\\"2887e1cf-9bf2-431a-b066-a46860080f56\\\",\\n \\\"name\\\": \\\"wazuh-agent-name\\\",\\n \\\"type\\\": \\\"endpoint\\\",\\n \\\"version\\\": \\\"5.0.0\\\"\\n },\\n \\\"event\\\": {\\n \\\"collector\\\": \\\"file\\\",\\n \\\"module\\\": \\\"logcollector\\\",\\n \\\"original\\\": \\\"Dec 13 11:35:28 a-mac-with-esc-key GoogleSoftwareUpdateAgent[21412]: 2016-12-13 11:35:28.421 GoogleSoftwareUpdateAgent[21412/0x700007399000] [lvl=2] -[KSUpdateEngine updateAllExceptProduct:] KSUpdateEngine updating all installed products, except:'com.google.Keystone'.\\\"\\n },\\n \\\"log\\\": {\\n \\\"file\\\": {\\n \\\"path\\\": \\\"/var/log/syslog.log\\\"\\n }\\n },\\n}\\n```\\n\\nProcessed event:\\n\\n```\\n{\\n \\\"@timestamp\\\": \\\"2025-01-23T17:40:37Z\\\",\\n \\\"agent\\\": {\\n \\\"groups\\\": [\\n \\\"group1\\\",\\n \\\"group2\\\"\\n ],\\n \\\"host\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"hostname\\\": \\\"wazuh-endpoint-linux\\\",\\n \\\"ip\\\": [\\n \\\"192.168.1.2\\\"\\n ],\\n \\\"os\\\": {\\n \\\"name\\\": \\\"Amazon Linux 2\\\",\\n \\\"platform\\\": \\\"Linux\\\"\\n }\\n },\\n \\\"id\\\": \\\"2887e1cf-9bf2-431a-b066-a46860080f56\\\",\\n \\\"name\\\": \\\"wazuh-agent-name\\\",\\n \\\"type\\\": \\\"endpoint\\\",\\n \\\"version\\\": \\\"5.0.0\\\"\\n },\\n \\\"event\\\": {\\n \\\"collector\\\": \\\"file\\\",\\n \\\"created\\\": \\\"2024-11-22T02:00:00Z\\\",\\n \\\"kind\\\": \\\"event\\\",\\n \\\"module\\\": \\\"logcollector\\\",\\n \\\"original\\\": \\\"Dec 13 11:35:28 a-mac-with-esc-key GoogleSoftwareUpdateAgent[21412]: 2016-12-13 11:35:28.421 GoogleSoftwareUpdateAgent[21412/0x700007399000] [lvl=2] -[KSUpdateEngine updateAllExceptProduct:] KSUpdateEngine updating all installed products, except:'com.google.Keystone'.\\\",\\n \\\"start\\\": \\\"2025-12-13T11:35:28.000Z\\\"\\n },\\n \\\"host\\\": {\\n \\\"hostname\\\": \\\"a-mac-with-esc-key\\\"\\n },\\n \\\"log\\\": {\\n \\\"file\\\": {\\n \\\"path\\\": \\\"/var/log/syslog.log\\\"\\n }\\n },\\n \\\"message\\\": \\\"2016-12-13 11:35:28.421 GoogleSoftwareUpdateAgent[21412/0x700007399000] [lvl=2] -[KSUpdateEngine updateAllExceptProduct:] KSUpdateEngine updating all installed products, except:'com.google.Keystone'.\\\",\\n \\\"process\\\": {\\n \\\"name\\\": \\\"GoogleSoftwareUpdateAgent\\\",\\n \\\"pid\\\": 21412\\n },\\n \\\"related\\\": {\\n \\\"hosts\\\": [\\n \\\"a-mac-with-esc-key\\\"\\n ]\\n },\\n \\\"tags\\\": [\\n \\\"production-server\\\"\\n ],\\n \\\"wazuh\\\": {\\n \\\"decoders\\\": [\\n \\\"syslog\\\"\\n ]\\n }\\n}\\n```\", \"Policy processing\": \"The policy is the operational graph applied to each event, structured into decoders, rules, and outputs, each related to normalizing, enriching, and delivery respectively.\\n\\n```\\n---\\ntitle: Security policy dataflow\\n---\\nflowchart LR\\n\\nclassDef EventBoxClass font-size: 15px,stroke-width:2px, color:#fff, fill:#3f51b5\\nclassDef TreeBoxClass font-size: 15px,stroke-width:2px,stroke-dasharray: 5 5\\n\\n subgraph decoTree[\\\"Decoders\\\"]\\n direction TB\\n\\n deco01(\\\" \\\")\\n deco02(\\\" \\\")\\n deco03(\\\" \\\")\\n deco04(\\\" \\\")\\n deco05(\\\" \\\")\\n deco06(\\\" \\\")\\n deco07(\\\" \\\")\\n deco08(\\\" \\\")\\n\\n deco01 --> deco02 & deco03 & deco04\\n deco02 --> deco05\\n deco03 --> deco06 & deco07\\n deco04 --> deco08\\n end\\n\\n subgraph ruleTree[\\\"Rules\\\"]\\n direction TB\\n\\n rule01(\\\" \\\")\\n rule02(\\\" \\\")\\n rule03(\\\" \\\")\\n rule04(\\\" \\\")\\n rule05(\\\" \\\")\\n rule06(\\\" \\\")\\n rule07(\\\" \\\")\\n rule08(\\\" \\\")\\n\\n rule01 --> rule02 & rule03 & rule04\\n rule02 --> rule05\\n rule03 --> rule06 & rule07\\n rule04 --> rule08\\n end\\n\\n subgraph outputTree[\\\"Outputs\\\"]\\n direction TB\\n\\n output01(\\\" \\\")\\n output02(\\\" \\\")\\n output03(\\\" \\\")\\n output04(\\\" \\\")\\n output05(\\\" \\\")\\n output06(\\\" \\\")\\n output07(\\\" \\\")\\n output08(\\\" \\\")\\n\\n output01 --> output02 & output03 & output04\\n output02 --> output05\\n output03 --> output06 & output07\\n output04 --> output08\\n\\n end\\n\\n decoTree:::TreeBoxClass\\n ruleTree:::TreeBoxClass\\n outputTree:::TreeBoxClass\\n eventInput:::EventBoxClass\\n eventOutput:::EventBoxClass\\n\\n %% Pipeline\\n eventInput@{shape: doc, label: \\\"Event</br>Input\\\"}==>decoTree==>ruleTree==>outputTree==>eventOutput@{shape: doc, label: \\\"Enriched</br>Event\\\"}\\n\\n```\\n\\nWazuh comes with a predefined policy that enables all its components to work properly and it is structured on top of Wazuh-supported log sources.\\n\\nEach source does have a particular way to format and send logs to the engine. The default policy takes care of that, allowing the users to focus on their integrations and not on the nuances of the logs transports for each source.\\n\\n```\\ngraph LR;\\n subgraph Endpoint\\n Service[\\\"Service\\\"]\\n WazuhAgent[\\\"Wazuh agent\\\"]\\n Service --- WazuhAgent\\n end\\n\\n WazuhAgent -.-> Orchestrator[\\\"Orchestrator: Router\\\"]\\n\\n subgraph WazuhServer[\\\"Wazuh server\\\"]\\n\\n subgraph Engine\\n Orchestrator --> Route[\\\"Route\\\"]\\n Route --> Decoding[\\\"Decoding Stage\\\"]\\n subgraph SecurityPolicy[\\\"Security Policy\\\"]\\n Decoding --> Rule[\\\"Rule Stage\\\"]\\n Rule --> OutputStage[\\\"Output Stage\\\"]\\n end\\n end\\n end\\n```\", \"Decoding process\": \"The decoding process converts unstructured data received by the engine into schema-based JSON events.\\n\\nAll events enter the pipeline through the root decoder, which determines the appropriate decoder for processing. Each subsequent decoder processes the event as much as possible before passing it to the next suitable decoder. This continues until no further processing can be performed.\\n\\nA closer examination of the predefined decoders reveals the following structure:\\n\\n```\\n---\\ntitle: Decoder tree\\n---\\nflowchart TD\\n\\n%% Style\\nclassDef AssetSuccessClass fill:#2196f3,stroke-width:2px,fill-opacity:0.8\\nclassDef AssetFailClass fill:#f50057,stroke-width:2px,fill-opacity:0.8\\nclassDef AssetNotExecutedClass fill:#90a4ae,stroke-width:2px,fill-opacity:0.8\\n\\n\\n%% First Level\\ndecoderR(\\\"root decoder\\\"):::AssetSuccessClass\\ndecoderR --x decoder1\\ndecoderR --> decoder2 --> decoder21\\ndecoderR -.-> decoder3 -.-> decoder31\\n\\ndecoder1(\\\"decoder 1\\\"):::AssetFailClass\\ndecoder2(\\\"decoder 2\\\"):::AssetSuccessClass\\n\\ndecoder1 -.-> decoder11 & decoder12\\ndecoder2 -.-> decoder22\\n\\ndecoder11(\\\"decoder 1-1\\\"):::AssetNotExecutedClass\\ndecoder12(\\\"decoder 1-2\\\"):::AssetNotExecutedClass\\ndecoder21(\\\"decoder 2-1\\\"):::AssetSuccessClass\\ndecoder22(\\\"decoder 2-2\\\"):::AssetNotExecutedClass\\ndecoder3(\\\"decoder 3\\\"):::AssetNotExecutedClass\\ndecoder31(\\\"decoder 3-1\\\"):::AssetNotExecutedClass\\nlinkStyle 0 stroke:#f50057,stroke-width:2px\\n\\n\\n\\n```\\n\\nThe event is evaluated by a decoder to determine if it matches the conditions defined within the decoder. If the decoder rejects the event, it is passed to the next sibling decoder within the same hierarchy for evaluation. This process continues until a decoder accepts the event or no more sibling decoders are available.\\n\\nWhen a decoder accepts an event, it may modify the event by normalizing or enriching its data. After this, the event is passed to the child decoders of the accepted decoder for further processing. Each child decoder evaluates the event using the same logic, ensuring a hierarchical and iterative approach to event processing.\\n\\nThis hierarchical evaluation ensures that events are processed efficiently and routed through the appropriate decoders based on their structure and content.\\n\\nThe following diagram illustrates the event flow on the decoder tree of default policy:\\n\\n```\\n---\\ntitle: Event flow on decoder tree\\n---\\nflowchart LR\\n\\n classDef EventBoxClass font-size: 15px,stroke-width:2px, color:#fff, fill:#3f51b5\\n classDef TreeBoxClass font-size: 15px,stroke-width:2px,stroke-dasharray: 5 5\\n\\n subgraph decoTree[\\\"First layer - Internal decoders\\\"]\\n direction TB\\n deco01(\\\" \\\")\\n deco02(\\\" \\\")\\n deco03(\\\" \\\")\\n deco04(\\\"Integration Decoder\\\")\\n deco05(\\\" \\\")\\n deco06(\\\" \\\")\\n deco07(\\\" \\\")\\n\\n deco01 --> deco02 & deco03 & deco04\\n deco02 --> deco05\\n deco03 --> deco06 & deco07\\n end\\n\\n deco04 -..-> decoIntegration[\\\"Integration Decoder\\\"]:::TreeBoxClass\\n eventInput@{shape: doc, label: \\\"Event</br>Input\\\"} ==> decoTree\\n decoTree:::TreeBoxClass\\n\\n subgraph userDecoTree[\\\"Integrations & User decoders\\\"]\\n direction TB\\n userDeco01(\\\" \\\")\\n userDeco02(\\\" \\\")\\n userDeco03(\\\" \\\")\\n userDeco04(\\\" \\\")\\n userDeco05(\\\" \\\")\\n userDeco06(\\\" \\\")\\n userDeco07(\\\" \\\")\\n userDeco08(\\\" \\\")\\n\\n userDeco01 --> userDeco02 & userDeco03 & userDeco04\\n userDeco02 --> userDeco05\\n userDeco03 --> userDeco06 & userDeco07\\n userDeco04 --> userDeco08\\n end\\n\\n\\n\\n%% decoIntegration --> userDecoTree\\ndecoIntegration --> userDeco01\\nuserDecoTree ----> eventOutput@{shape: doc, label: \\\"Normalized</br>event\\\"}\\n\\nuserDecoTree:::TreeBoxClass\\neventInput:::EventBoxClass\\neventOutput:::EventBoxClass\\n```\\n\\nIn the default policy, the first layer is for internal decoders, which are responsible for normalizing events.\\nThe second layer is for integrations and user-defined decoders, which are used to process events from specific\\nsources or applications.\", \"Security enrichment process\": \"The analysis process evaluates all event fields to identify potential security concerns, which are represented as threat\\nindicators within the common schema. These indicators are later stored in the Wazuh Indexer, where they can be used for\\nthreat hunting and detecting security issues.\\n\\nAll decoded events pass through the analysis pipeline, starting with the root rule. The root rule determines the next\\nappropriate rule for processing the event. If a rule matches, it triggers all its child rules for evaluation in a\\nbroadcast manner. Each child rule is independently evaluated, contributing additional threat indicators to the event's\\nanalysis. If a rule does not match, its child rules are not evaluated, ensuring efficient processing.\\n\\nThis hierarchical and broadcast-based evaluation allows the analysis pipeline to enrich events with relevant security\\ncontext while maintaining performance and scalability.\\n\\n```\\n---\\ntitle: Rules tree\\n---\\nflowchart TD\\n\\n%% Style\\n classDef AssetSuccessClass fill:#2196f3,stroke-width:2px,fill-opacity:0.8\\n classDef AssetFailClass fill:#f50057,stroke-width:2px,fill-opacity:0.8\\n classDef AssetNotExecutedClass fill:#90a4ae,stroke-width:2px,fill-opacity:0.8\\n ruleR(\\\"root rule\\\") --x rule1(\\\"rule 1\\\")\\n rule1 -.-> rule11(\\\"rule 1-1\\\") & rule12(\\\"rule 1-2\\\")\\n ruleR --> rule2(\\\"rule 2\\\")\\n rule2 --> rule21(\\\"rule 2-1\\\")\\n rule2 --x rule22(\\\"rule 2-2\\\")\\n rule2 --> rule23(\\\"rule 2-3\\\")\\n ruleR --> rule3(\\\"rule 3\\\")\\n rule3 --> rule31(\\\"rule 3-1\\\")\\n\\n ruleR:::AssetSuccessClass\\n rule1:::AssetFailClass\\n rule11:::AssetNotExecutedClass\\n rule12:::AssetNotExecutedClass\\n rule2:::AssetSuccessClass\\n rule21:::AssetSuccessClass\\n rule22:::AssetFailClass\\n rule23:::AssetSuccessClass\\n rule3:::AssetSuccessClass\\n rule31:::AssetSuccessClass\\n linkStyle 0,5 stroke:#f50057,stroke-width:2px\\n\\n\\n```\\n\\nThe following diagram illustrates the event flow on the rules tree of the default policy:\\n\\n```\\n---\\ntitle: Event flow on rules\\n---\\nflowchart LR\\n\\nclassDef EventBoxClass font-size: 15px,stroke-width:2px, color:#fff, fill:#3f51b5\\nclassDef TreeBoxClass font-size: 15px,stroke-width:2px,stroke-dasharray: 5 5\\n\\n subgraph wazuhRulesTree[\\\"Wazuh Rules\\\"]\\n direction TB\\n\\n wazuhRules01(\\\" \\\")\\n wazuhRules02(\\\" \\\")\\n wazuhRules03(\\\" \\\")\\n wazuhRules04(\\\" \\\")\\n wazuhRules05(\\\" \\\")\\n wazuhRules06(\\\" \\\")\\n wazuhRules07(\\\" \\\")\\n wazuhRules08(\\\" \\\")\\n\\n wazuhRules01 --> wazuhRules02 & wazuhRules03 & wazuhRules04\\n wazuhRules02 --> wazuhRules05\\n wazuhRules03 --> wazuhRules06 & wazuhRules07\\n wazuhRules04 --> wazuhRules08\\n end\\n\\n subgraph userRulesTree[\\\"User rules\\\"]\\n direction TB\\n\\n userRules01(\\\" \\\")\\n userRules02(\\\" \\\")\\n userRules03(\\\" \\\")\\n userRules04(\\\" \\\")\\n userRules05(\\\" \\\")\\n userRules06(\\\" \\\")\\n userRules07(\\\" \\\")\\n userRules08(\\\" \\\")\\n\\n userRules01 --> userRules02 & userRules03 & userRules04\\n userRules02 --> userRules05\\n userRules03 --> userRules06 & userRules07\\n userRules04 --> userRules08\\n\\n end\\n\\n wazuhRulesTree:::TreeBoxClass\\n userRulesTree:::TreeBoxClass\\n eventInput:::EventBoxClass\\n eventOutput:::EventBoxClass\\n\\n %% Pipeline\\n eventInput@{shape: doc, label: \\\"Normalized</br>Event\\\"}==>wazuhRulesTree & userRulesTree-.->eventOutput@{shape: doc, label: \\\"Security</br>event\\\"}\\n\\n```\\n\\nThe analysis pipeline is divided into two layers:\\n\\n['**Wazuh Rules**: Contains the default rules provided by Wazuh.', '**User Rules**: Contains user-defined rules.']\\n\\nThen both the Wazuh and user rules are applied to the event.\", \"Archiving and alerting process\": \"Once an event has completed processing through the decoder and rule pipelines, it enters the output pipeline.\\nSimilar to previous stages, the event first passes through the root output, which determines the appropriate output(s)\\nfor further processing. Multiple outputs can be selected, enabling flexible storage and distribution policies.\\n\\nThe output process in Wazuh is designed to efficiently distribute alerts through broadcasting, with each output capable\\nof filtering alerts to support customized distribution:\\n\\n```\\n---\\ntitle: Event flow on outputs\\n---\\nflowchart TD\\n\\n outputR --> output1(\\\"Indexer alert output\\\") & output2(\\\"File alerts output\\\")\\n outputR(\\\"Broadcaster output\\\") --x output3(\\\"File archive output\\\")\\n outputR(\\\"Broadcaster output\\\") --x output4(\\\"Other output\\\")\\n\\n outputR:::AssetSuccessClass\\n output1:::AssetSuccessClass\\n output2:::AssetSuccessClass\\n output3:::AssetFailClass\\n output4:::AssetSuccessClass\\n classDef AssetSuccessClass fill:#3f51b5,stroke-width:2px,fill-opacity:0.5\\n classDef AssetFailClass fill:#f44336,stroke-width:2px,fill-opacity:0.5\\n classDef AssetNotExecutedClass fill:#9e9e9e,stroke-width:2px,fill-opacity:0.5\\n linkStyle 2 stroke:#D50000,fill:none\\n```\", \"Full pipeline\": \"The following diagram illustrates the full pipeline of the default policy, including the decoding, rule, and output\\nstages:\\n\\n```\\nflowchart TD\\n\\n classDef EventBoxClass font-size: 15px,stroke-width:2px, color:#fff, fill:#3f51b5\\n classDef TreeBoxClass font-size: 15px,stroke-width:2px,stroke-dasharray: 5 5\\n classDef ModuleArchClass fill:#673ab7,stroke-width:2px,fill-opacity:0.5, font-size: 20px\\n classDef SubModuleArchClass fill:#673ab7,stroke-width:2px,fill-opacity:0.5, font-size: 15px\\n\\n%% --------------------------------------\\n%% Decoding Stage\\n%% --------------------------------------\\n\\n subgraph decoTree[\\\"First layer - Internal decoders\\\"]\\n direction TB\\n decoInputRoot(\\\" \\\")\\n deco02(\\\" \\\")\\n deco03(\\\" \\\")\\n integrationDecoder(\\\"Integration Decoder\\\")\\n deco05(\\\" \\\")\\n deco06(\\\" \\\")\\n deco07(\\\" \\\")\\n\\n decoInputRoot --> deco02 & deco03 & integrationDecoder\\n deco02 --> deco05\\n deco03 --> deco06 & deco07\\n end\\n\\n integrationDecoder -..-> userDecoRoot:::TreeBoxClass\\n\\n\\n subgraph userDecoTree[\\\"Integrations & User decoders\\\"]\\n direction TB\\n userDecoRoot(\\\" \\\")\\n userDeco02(\\\" \\\")\\n userDeco03(\\\" \\\")\\n userDeco04(\\\" \\\")\\n userDeco05(\\\" \\\")\\n userDeco06(\\\" \\\")\\n userDeco07(\\\" \\\")\\n userDeco08(\\\" \\\")\\n\\n userDecoRoot --> userDeco02 & userDeco03 & userDeco04\\n userDeco02 --> userDeco05\\n userDeco03 --> userDeco06 & userDeco07\\n userDeco04 --> userDeco08\\n end\\n\\n%% Stage block\\nsubgraph decoderStage[\\\"Decoding Stage\\\"]\\n decoTree:::TreeBoxClass\\n userDecoTree:::TreeBoxClass\\nend\\n\\n\\n\\n%% Output decoder stage\\neventNormalized@{shape: doc, label: \\\"Normalized</br>event\\\"}\\neventNormalized:::EventBoxClass\\n\\n%% Pipieline\\nrouteSelector ==> decoInputRoot\\nuserDecoTree ====> eventNormalized\\n\\n%% --------------------------------------\\n%% Rules Stage\\n%% --------------------------------------\\n\\n subgraph wazuhRulesTree[\\\"Wazuh Rules\\\"]\\n direction TB\\n\\n wazuhRules01(\\\" \\\")\\n wazuhRules02(\\\" \\\")\\n wazuhRules03(\\\" \\\")\\n wazuhRules04(\\\" \\\")\\n wazuhRules05(\\\" \\\")\\n wazuhRules06(\\\" \\\")\\n wazuhRules07(\\\" \\\")\\n wazuhRules08(\\\" \\\")\\n\\n wazuhRules01 --> wazuhRules02 & wazuhRules03 & wazuhRules04\\n wazuhRules02 --> wazuhRules05\\n wazuhRules03 --> wazuhRules06 & wazuhRules07\\n wazuhRules04 --> wazuhRules08\\n end\\n\\n subgraph userRulesTree[\\\"User rules\\\"]\\n direction TB\\n\\n userRules01(\\\" \\\")\\n userRules02(\\\" \\\")\\n userRules03(\\\" \\\")\\n userRules04(\\\" \\\")\\n userRules05(\\\" \\\")\\n userRules06(\\\" \\\")\\n userRules07(\\\" \\\")\\n userRules08(\\\" \\\")\\n\\n userRules01 --> userRules02 & userRules03 & userRules04\\n userRules02 --> userRules05\\n userRules03 --> userRules06 & userRules07\\n userRules04 --> userRules08\\n\\n end\\n\\n\\n\\nsubgraph ruleStage[\\\"Rules Stage\\\"]\\n wazuhRulesTree:::TreeBoxClass\\n userRulesTree:::TreeBoxClass\\nend\\n\\n%% Output stage rules\\nsecurityEvent@{shape: doc, label: \\\"Security</br>event\\\"}\\nsecurityEvent:::EventBoxClass\\n\\n%% Pipieline\\neventNormalized==>wazuhRulesTree & userRulesTree-.->securityEvent\\n\\n%% --------------------------------------\\n%% Output Stage\\n%% --------------------------------------\\n subgraph outputTree[\\\"Outputs\\\"]\\n direction TB\\n\\n output01(\\\" \\\")\\n output02(\\\" \\\")\\n output03(\\\" \\\")\\n output04(\\\" \\\")\\n output05(\\\" \\\")\\n output06(\\\" \\\")\\n output07(\\\" \\\")\\n output08(\\\" \\\")\\n\\n output01 --> output02 & output03 & output04\\n output02 --> output05\\n output03 --> output06 & output07\\n output04 --> output08\\n\\n end\\n outputTree:::TreeBoxClass\\n\\n%% Pipieline output\\n securityEvent ==> outputTree\\n\\n\\n%% --------------------------------------\\n%% Default Policy\\n%% --------------------------------------\\nsubgraph defaultPolicy[\\\"Default policy\\\"]\\n decoderStage\\n eventNormalized\\n ruleStage\\n securityEvent\\n outputTree\\nend\\ndefaultPolicy:::SubModuleArchClass\\n\\n\\n%% --------------------------------------\\n%% Engine\\n%% --------------------------------------\\n%% Input Decodeing Stage\\neventInput@{shape: doc, label: \\\"Incoming event</br>from endpoint\\\"}\\neventInput:::EventBoxClass\\n\\nsubgraph engine[\\\"engine\\\"]\\n defaultPolicy\\n routeSelector([\\\"Orchestrator: Router (Route selector)\\\"])\\nend\\nengine:::ModuleArchClass\\n\\neventInput ===> routeSelector\\n\\n```\"}, \"Schema\": {\"Configuration\": \"The schema configuration for the engine follows a structured format where each field is defined with specific attributes. The schema consists of a JSON object with the following key elements:\\n\\n['Fields Definition:', ['The fields object contains a list of field names as keys.', 'Each field has a corresponding object defining its properties.'], 'Field Properties:\\\\nEach field in the schema contains two primary properties:', ['`type`: Specifies the OpenSearch field type, such as date, keyword, text, integer, etc.', '`array`: A boolean value (true or false) indicating whether the field can store multiple values (i.e., an array) or just a single value.']]\\n\\n```\\n{\\n \\\"name\\\": \\\"schema/engine-schema/0\\\",\\n \\\"fields\\\": {\\n \\\"@timestamp\\\": {\\n \\\"type\\\": \\\"date\\\",\\n \\\"array\\\": false\\n },\\n \\\"agent.build.original\\\": {\\n \\\"type\\\": \\\"keyword\\\",\\n \\\"array\\\": false\\n },\\n \\\"agent.ephemeral_id\\\": {\\n \\\"type\\\": \\\"keyword\\\",\\n \\\"array\\\": false\\n },\\n \\\"agent.id\\\": {\\n \\\"type\\\": \\\"keyword\\\",\\n \\\"array\\\": false\\n }\\n }\\n}\\n```\", \"Implications\": [\"Operational Graph and Consistency Enforcement\", [\"The schema is used during the construction of the operational graph to ensure that all operations are valid based on the defined field types and structures.\", \"Whenever possible, schema validation is performed at build time to prevent misconfigurations before execution.\", \"If an operation's consistency cannot be fully validated at build time, additional runtime checks are applied to ensure adherence to the schema.\"], \"Consistency and Normalization in Dashboards\", [\"The schema ensures that data displayed in dashboards follows a consistent structure.\", \"This enables seamless aggregation, filtering, and visualization by maintaining a predictable and normalized data format.\"]]}, \"Managing the Engine's processing\": {\"Namespaces\": \"To organize assets efficiently, the Engine categorizes them into namespaces. Internally, assets are stored directly under a specific namespace, allowing for structured management and role-based segregation of policies.\\n\\nThe default policy asset namespaces in the Engine are:\\n\\n['`system` \\u2013 Core assets responsible for handling internal event processing and ensuring basic event normalization.', '`wazuh` \\u2013 Default integrations developed and maintained by Wazuh.', '`user` \\u2013 A default namespace for end-user-defined assets.']\\n\\nWhile these are the predefined namespaces, the Engine allows creating as many namespaces as needed, enabling flexibility in asset management.\", \"Assets Catalog\": \"The Catalog is responsible for managing the Engine\\u2019s assets, organizing them under namespaces. Each asset is uniquely identified by its name, following the convention:\\n\\n```\\n<type>/<name>/<version>\\n```\\n\\nThis naming structure ensures clear versioning and categorization of assets. The following asset types are defined:\\n\\n['**decoders** \\u2013 Responsible for normalizing events, transforming raw data into a structured format.', '**rules** \\u2013 Handle security analysis and event enrichment, identifying threats and adding contextual information.', '**outputs** \\u2013 Define storage policies for processed events, determining how and where data is stored.', '**filters** \\u2013 Used for event routing, ensuring events are correctly directed to the appropriate policies.', '**integrations** \\u2013 Serve as manifests for other assets, grouping related assets that support a common goal. Typically used to bundle all assets required for specific services.']\\n\\nAll API calls to the Catalog support name-path operations, allowing users to manage specific assets or entire groups efficiently. (Refer to the API documentation for a full list of available catalog operations.)\", \"Policies and Routes\": {\"Architecture\": \"The Engine is composed of distinct modules, each responsible for managing a specific aspect of event processing:\\n\\n['Catalog \\u2192 Manages assets (decoders, rules, filters, outputs, integrations).', 'Policy \\u2192 Manages policies, defining how assets are organized and processed.', 'Orchestrator \\u2192 Manages routes, pairing filters with policies to control event processing.']\\n\\nAll modules follow the same naming convention, ensuring that every item\\u2014whether an asset, policy, or route\\u2014can be stored and identified homogeneously by the Store module.\\n\\nFor more information on the Engine\\u2019s architecture and how the modules interact, refer to [architecture documentation](architecture.md).\"}}, \"Assets\": {\"Attributes\": \"Attributes are configuration details. Although the order of definition does not matter, we follow the convention of defining them in the order of name, metadata, and parents.\\n\\n['**Name**: Identifies the asset and follows the pattern `<asset_type>/<name>/<version>`.', '**Metadata**: Contains all information about the asset. The exact subfields depend on the asset type.', '**Parents**: When applicable to the asset, this defines the order in the asset graph. The exact child selection depends on the specific asset graph type.', '**Definitions**: Defines symbols that will be replaced throughout the document in its occurrences.']\", \"Stages\": \"The stages define the operation chain and flow the asset performs on events. Each stage is executed in the order of definition:\\n\\n```\\n---\\nconfig:\\n nodeSpacing: 30\\n rankSpacing: 25\\n flowchart:\\n subGraphTitleMargin:\\n top: 20\\n bottom: 20\\n---\\nflowchart TB\\n\\nclassDef partsAssetsClass font-size:15px,stroke-width:2px,stroke-dasharray:10px,rx:15,ry:15\\nclassDef EventBoxClass font-size: 15px,stroke-width:2px, color:#fff, fill:#3f51b5\\nclassDef stateFailClass fill:#f50057,stroke-width:2px,fill-opacity:0.5\\nclassDef stateSuccessClass fill:#2196f3,stroke-width:2px,fill-opacity:0.8\\n\\neventInput@{ shape: doc, label: \\\"Event input\\\"}\\neventInput:::EventBoxClass\\neventInput ---> stage_1\\n\\n\\nsubgraph stages[\\\"Stages\\\"]\\n direction TB\\n stage_1([\\\"Process stage 1\\\"])\\n stage_2([\\\"Process stage 2\\\"])\\n stage_3([\\\"Process stage ...\\\"])\\n stage_4([\\\"Process stage n\\\"])\\n stage_1 --->|success| stage_2\\n stage_2 --->|success| stage_3\\n stage_3 --->|success| stage_4\\nend\\nstages:::partsAssetsClass\\n\\nfailedState@{ shape: dbl-circ, label: \\\"Asset fail\\\" }\\nfailedState:::stateFailClass\\nstage_1 --->|failed|failedState\\nstage_2 --->|failed|failedState\\nstage_3 --->|failed|failedState\\n\\nsuccessState@{ shape: dbl-circ, label: \\\"Asset success\\\" }\\nsuccessState:::stateSuccessClass\\nstage_4 --->|success| successState\\n```\\n\\nWhen a stage is executed, it can either fail or succeed, depending on the logic of the stage and the operations performed. Each stage is sequentially executed only if the previous stage succeeds.\\n\\nStages:\\n\\n['**Check/Allow**: Allows conditional operations to be made on the event. Cannot modify the event.', '**Parse**: Parses fields on the event, acting both as a condition and normalization.', '**Map**: Allows mapping and transformation operations on the event.', '**Normalize**: Defines blocks with a combination of check, parse, and map stages.', '**Output**: Allows operations to communicate outside the Engine, typically used to send events outward. Cannot modify the event.']\", \"Asset types\": \"The type of asset is an allowed combination of certain stages. The following table outlines the stages available for each type of asset:\\n\\n| Asset Type | Allowed Stages |\\n|-|-|\\n|Decoders|check, parse, map, normalize|\\n|Rules|check, map, normalize_rule|\\n|Outputs|check, output|\\n|Filters|allow|\\n\\nEach asset has a name and metadata, with custom metadata suited to its specific needs. Additionally, each asset can have parents.\", \"Operations\": \"Operations are the fundamental units within the operation graph. Each operation can succeed or fail, forming the basis for defining the graph by combining operations based on their execution results.\\n\\nOperations are always defined as:\\n\\n```\\ntarget_field: operation\\n```\\n\\nWhere the operation can be:\\n\\n['**Literal Value**: A direct check or map operation depending on the stage it is defined. This can be any of the YAML native values (string, number, boolean, etc.).', '**Reference**: Denoted by $field_name, it performs a direct check or map operation using the referenced value.', '**Helper Function**: Denoted by helper_name(args), it performs a check or map operation depending on the called helper.']\\n\\nWhen building an asset, the process can fail if there is any operation that contains a:\\n\\n['**Syntax Error**: Errors in the target_field or operation syntax.', '**Schema Validation Failure**: Errors such as mapping a boolean into a keyword field, which violates the schema validation rules.', '**Semantic Error**: Incorrect usage, such as using a conditional helper in a map stage.\\\\nThese errors will be notified when trying to upload the asset to the catalog.']\", \"Execution Graph Summary\": \"With a basic understanding of a policy and its components, we can look at the global picture of how the operation graph is defined.\\nWithin the policy, we have subgraphs, each corresponding to an asset type:\\n\\n['Decoders', 'Rules', 'Outputs']\\n\\n<workflow_placeholder>\\n\\nEvery event traverses each subgraph independently, forming a chain of subgraphs.\\n\\nEach graph is composed of assets defined by parent relationships. An event moves down in the graph based on the asset's logical output. If an asset operation succeeds, the event is sent to its child assets.\\n\\nThe traversal of each subgraph follows these rules:\\n\\n['**Decoders**: If the current decoder asset succeeds, the event is sent to its first child. If it fails, the event is sent to the next sibling of the parent decoder (logical OR between children).', '**Rules**: If the current rule asset succeeds, the event is broadcast to all its child assets.', '**Outputs**: Events are broadcast to all defined output assets.']\\n\\nAn asset is considered successful if it accepts the event, meaning all conditional stages have succeeded, regardless of the outcome of transformational stages. This ensures that events are processed through the appropriate path based on successful acceptance checks.\\n\\nA stage succeeds if the logical combination of its operations succeeds. The exact combination logic is determined by the stage itself. This ensures that each stage can apply its own logic to decide whether it has successfully processed an event.\\n\\n<workflow_placeholder>\", \"Helper functions\": {\"Condition Helpers\": \"When using conditional helpers, the syntax is:\\n\\n```\\ntarget_field: condition_helper(args)\\n```\\n\\nThe helper will always test a condition on *target_field*. If the condition passes, the operation succeeds; otherwise, it fails.\", \"Mapping Helpers\": \"When using mapping helpers, the syntax is:\\n\\n```\\ntarget_field: map_helper(args)\\n```\\n\\nThe helper will always map the *target_field* if the operation succeeds. If the operation fails, the *target_field* remains unchanged.\", \"Transform Helpers\": \"When using transformational helpers, the syntax is:\\n\\n```\\ntarget_field: transform_helper(args)\\n```\\n\\nThe helper will transform the *target_field* if the operation succeeds. If the operation fails, the *target_field* remains unchanged.\\n\\nA transformational helper may fail due to implicit conditions, such as expecting a specific type for the target field, missing a reference passed as an argument, etc.\\n\\n***It is important to understand that every operation can succeed or fail, and this is the foundation for defining the operation graph.***\", \"Parsing rules\": \"When using a helper function in a map or check operation:\\n\\n```\\ntarget.field: helper_name(args\\u2026)\\n```\\n\\nThe arguments for `helper_name` can be references to other fields, or JSON values (string, number, boolean, array, or object). Multiple arguments should be separated by commas.\\n\\nWhen the helper function is built, arguments are parsed in the following order:\\n\\n[\\\"**Quoted argument**: `'value'` starts and ends with a single quote. `\\\\\\\\` and `'` can be escaped.\\\", '**Reference**: `$reference` starts with `$`, followed by alphanumerics plus `#`, `_`, `@`, and `-`, separated by dots.', '**JSON value**: An attempt is made to parse the argument as JSON (any valid JSON type).', \\\"**Raw string**: If none of the above apply, the argument is handled as a string value, with escapes allowed for `$`, `'`, `,`, `)`, `\\\\\\\\`, and whitespace.\\\"]\\n\\nInvalid escape sequences will always fail.\\n\\nFor example:\\n\\n```\\ntarget.field: helper_name('string', $reference, 123, {\\\"key\\\": \\\"value\\\"})\\n```\\n\\nThis call applies `helper_name` to the `target.field` with arguments:\\n\\n[\\\"`'string'`: A string value.\\\", '`$reference`: A reference to another field.', '`123`: A numeric value (valid JSON).', '`{\\\"key\\\": \\\"value\\\"}`: A JSON object.']\\n\\n['[!NOTE]\\\\n`123` is a valid json, not only the objects are valid jsons according to the JSON standard,\\\\nbut also the numbers, strings, booleans and null values are valid JSON values.']\\n\\nWhen parsing a helper function inside a logical check expression the same rules apply adding that at least one argument\\nis expected for the helper, specifying the target field:\\n\\n```\\ncheck: helper_name($target.field, args\\u2026)\\n```\\n\\nAdded we can specify comparison helpers as operators:\\n\\n```\\ncheck: $target.field <op> <value>\\n```\\n\\nWhere value is parsed as a single helper argument following the same escaping rules and order.\\n\\nWhere op is any of the following:\\n\\n['`==`', '`!=`', '`<`', '`<=`', '`>`', '`>=`']\\n\\nWhen using any operator that is not the equality operator only string or integer values are allowed.\\n\\nWhen using the default map or filter functions for string operations, values are parsed according to standard YAML\\n(or JSON) types. If a value is a string and begins with the reference symbol `$`, it is treated as a potential\\nreference. If the reference is invalid the operation building fails.\\n\\n```\\ncheck:\\n - target.field: <yaml_type>|<$ref>\\nmap:\\n - target.field: <yaml_type>|<$ref>\\n```\\n\\nBelow are some usage examples:\\n\\n```\\n# Example 1: Simple equality check\\ncheck: http.method == \\\"GET\\\"\\n\\n# Example 2: Comparison with an integer value\\ncheck: $event.severity > 3\\n\\n# Example 3: Using a helper function in check\\ncheck: cidr_match($source.ip, \\\"192.168.0.0\\\", 24)\\n\\n```\"}, \"Definitions\": {\"Restrictions\": [\"**Naming Conflicts**: Definitions cannot have the same name as a schema field. Doing so will result in a failure to build the asset.\", \"**Precedence**: Definitions take precedence over custom fields. If a definition exists with the same name as a custom field, all references to the field will be replaced by the definition's value.\", \"**Chaining Definitions**: Definitions can use other definitions in their values as long as they are defined beforehand.\", \"**Context**: Definitions can only appear on the right side of operations, meaning we can't define the structure of the document with definitions or be used inside non operational stages.\", \"**Scope**: Definitions are scoped to the asset where they are defined. They cannot be shared across assets.\"], \"Use Cases\": [\"**Parsing Complex Logs**\", [\"Logs with extensive or structured headers can be broken into reusable definitions for clarity and to avoid redundancy.\", \"**Example**: Defining reusable components (TYPE_FIELD, MSG_FIELD) for parsing various log formats.\"], \"**Handling Large Value Lists**\", [\"When working with extensive arrays (e.g., banned IPs), definitions keep the configuration readable and maintainable.\", \"**Example**: Using a predefined list of banned IPs to check against source IPs in a normalize stage.\"], \"**Small Key-Value Databases (kvdbs)**\", [\"When small mappings are needed but don\\u2019t justify a full kvdb, definitions provide a lightweight alternative.\", \"**Example**: Mapping log levels or event IDs to structured categories, types, and outcomes for normalization.\"]]}, \"Variables\": \"Variables are temporary fields scoped to the current asset that is processing an event. They are identified by prefixing their name with an underscore `_`, following the standard field naming convention and supporting any operation just like fields.\\n\\n```\\n_field.name\\n```\\n\\nKey characteristics:\\n\\n['Scoped to the current asset \\u2013 Variables exist only within the asset processing the event and do not persist beyond it.', 'Runtime Modifiable \\u2013 Unlike definitions, which are static, variables can be modified during event processing.']\", \"Log Parsing\": \"Log parsing transforms raw log entries into structured data using parser expressions. These expressions serve as an alternative to Grok, eliminating the need for explicit type declarations by leveraging predefined schema-based parsing. Instead of regular expressions, they use specialized parsers for improved accuracy and efficiency.\\n\\nKey Components:\\n\\n['Literals: Direct character matches with escape rules for special characters.', 'Fields: Extract structured data, including:', ['Schema fields (predefined in the schema)', 'Custom fields (user-defined, defaulting to text)', 'Optional fields (ignored if missing)', 'Field choices (choosing between multiple fields)'], 'Wildcards: Capture patterns without mapping data to fields.', 'Optional Groups: Make subexpressions optional for flexible parsing.', 'Schema Parsers: Automatically applied when a field of a known type is used, ensuring compatibility with Wazuh Indexer.']\\n\\nExample:\\nThis expression captures an IP or hostname into `client.ip` or `client.address` and, if present, captures a port into `server.port`:\\n\\n```\\nparse|event.original:\\n - \\\"<client.ip>?<client.address> connected to <server.ip>(?:<server.port>)\\\"\\n```\\n\\nFor a log entry:\\n\\n```\\n192.168.1.10 connected to 10.0.0.5:443\\n```\\n\\nIt extracts:\\n\\n```\\n{\\n \\\"client.ip\\\": \\\"192.168.1.10\\\",\\n \\\"server.ip\\\": \\\"10.0.0.5\\\",\\n \\\"server.port\\\": \\\"443\\\"\\n}\\n```\\n\\nParsers are also available as helper functions for use in map and check operations. For a detailed explanation, see the Parser Stage and Parser Helper Functions sections.\", \"Key Value Databases\": {\"Use cases\": \"**Normalizing Large Serializable Data**: Maps event IDs to predefined categorization fields using a kvdb, simplifying event classification. Example:\\n\\n```\\nnormalize:\\n - map:\\n - event: kvdb_get_merge(windows_security_eventid_to_category_type_action, $event.code)\\n```\\n\\nThis retrieves event categories, types, and actions based on the event ID.\\n\\n**Checking Indicators of Compromise (IoCs)**: Compares log entries against a kvdb of known malicious IPs to identify potential threats. Example:\\n\\n```\\nnormalize:\\n - check:\\n - source.ip: kvdb_match(known_malicious_ips)\\n```\\n\\nIf a match is found, security-related data is mapped to the event.\"}, \"Dates and Timestamps\": \"Assets are capable of handling dates in various formats and time zones. This flexibility is achieved through configurable\\nparsers (refer to the [date parser documentation](ref-parser.html#date-parser) for more details).\\n\\nOnce a date is parsed, the Engine normalizes it to UTC. This ensures that all timestamps are stored and processed\\nhomogeneously, maintaining consistency across event processing and dashboard visualization.\", \"Geolocation\": \"Assets are capable of enriching events with geolocation information, enhancing event data with location-based context.\\nThis is achieved by using [Maxmind - GeoLite databases](https://www.maxmind.com/), which provide location data based on\\nIP addresses. For more details, see the [geo location](ref-helper-functions.md#geoip) helper documentation.\\n\\nThe GeoLite databases are configured through the API, allowing you to specify the relevant databases to be used for\\ngeolocation enrichment. For more information on how to configure these databases, refer to the API documentation.\", \"Decoders\": \"Decoders are the first layer of assets that pass through the event when it is processed by a security policy. They are responsible for normalizing the event, transforming it into a structured event.\\n\\nAll events enter the pipeline through the root decoder, which selects the appropriate decoder to process the event. Each subsequent decoder processes the event as much as it can and then passes it to the next suitable decoder. This continues until no more decoders can process the event. A decoder can only select one next decoder from the available ones.\\n\\n```\\n---\\ntitle: Decoder schema\\n---\\nkanban\\n Decoder[Decoder schema]\\n assetName[\\\"name\\\"]@{ priority: 'Very Low'}\\n assetMetadata[\\\"metadata\\\"]@{ priority: 'Very Low'}\\n assetParents[\\\"parents\\\"]\\n assetChecks[\\\"checks\\\"]\\n decoParsers[\\\"parser\\\"]\\n decoNormalize[\\\"normalize\\\"]\\n```\\n\\n['**Name**: Identifies the decoder and follows the pattern `<asset_type>/<name>/<version>`. The name is unique and cannot\\\\nbe repeated. The naming convention for components is `<type>/<name>/<version>`. The component type is `decoder`, and\\\\nthe version must be 0, since versioning is not implemented:', '**Metadata**: Each decoder has metadata that provides information about the decoder, such as the supported products,\\\\nversions, and formats. This metadata does not affect the processing stages.\\\\nThe metadata fields are:', ['`module` (string): The module that the decoder is associated with. I.e., `syslog`, `windows`, `apache`, etc.', '`title` (string): The title of the decoder. I.e., `Windows Event Log Decoder`, `Linux audit system log decoder`, etc.', '`description` (string): A brief description of the decoder.', '`compatibility` (string): A description of the compatibility of the decoder with different products, versions, and formats.\\\\ni.e `The Apache datasets were tested with Apache 2.4.12 and 2.4.46 and are expected to work with all versions >= 2.2.31 and >= 2.4.16 (independent from operating system)`', '`version` (array): A list of versions for which the logs have been tested and supported. I.e., `2.2.x`, `3.x`, etc.', '`author` (object): The author of the decoder, ie:', '```\\\\nname: Wazuh, Inc.\\\\nemail: info@wazuh.com\\\\nurl: https://wazuh.com\\\\ndate: 2022-11-15\\\\n```', '`reference` (array): A list of references to the documentation, i.e.:', '```\\\\n- https://httpd.apache.org/docs/2.2/logs.html\\\\n- https://httpd.apache.org/docs/2.4/logs.html\\\\n```'], '**Parents**: Defines the order in the decoder graph, establishing the parent-child relationship between decoders.\\\\nA decoder can have multiple parents, when an event is successfully processed in a decoder, it will evaluate the\\\\nchildren, one by one, until it finds a decoder that successfully processes the event.']\\n\\n['[!IMPORTANT]\\\\nThere is no order of priority when evaluating the children, and it cannot be assumed that a sibling decoder will be evaluated before another one.']\\n\\n['**Checks**: The checks stage is a preliminary stage in the asset processing sequence, designed to assess whether an\\\\nevent meets specific conditions without modifying the event itself.\\\\nMore information on the checks stage can be found in the [Check section](#checkallow).']\", \"Rules\": \"Rules are the second layer of assets that process events in a security policy. They are responsible for analyzing the\\nnormalized event, when the decoding stage is finished, to add context, security indicators, and threat intelligence.\\nUnlike decoders, the rule cannot modify the decoded event, but it can add new certain fields to enrich the event, this\\nprevents the rules from being used to decode events.\\n\\n```\\n---\\ntitle: Rule schema\\n---\\nkanban\\n Rule[Rule schema]\\n assetName[\\\"name\\\"]@{ priority: 'Very Low'}\\n assetMetadata[\\\"metadata\\\"]@{ priority: 'Very Low'}\\n assetParents[\\\"parents\\\"]\\n assetChecks[\\\"checks\\\"]\\n ruleNormalize[\\\"rule_enrichment\\\"]\\n```\\n\\n['**Name**: Identifies the rule and follows the pattern `<asset_type>/<name>/<version>`. The name is unique and cannot\\\\nbe repeated. The naming convention for components is `<type>/<name>/<version>`. The component type is `rule`, and\\\\nthe version must be 0, since versioning is not implemented:', '**Metadata**: Each rule has metadata that provides information about the rule, such as the supported products,\\\\nversions, and formats. This metadata does not affect the processing stages.\\\\nThe metadata fields are:', ['`description` (string): A brief description of the rule.', '`TODO: Add more fields when the metadata is defined.`'], '**Parents**: Defines the order in the rule graph, establishing the parent-child relationship between rules, a rule can\\\\nhave multiple parents, when an event is successfully processed in a rule (rule matches), it will evaluate all the\\\\nchildren. Unlike decoders, and all children will be evaluated.', '**Checks**: The checks stage is a preliminary stage in the asset processing sequence, designed to assess whether an\\\\nevent meets specific conditions. On the rules, the checks stage is used to evaluate the conditions that the event must\\\\nmeet to be considered a security event. More information on the checks stage can be found in the [Check section](#checkallow).', '**Rule Enrichment**: The rule enrichment stage is used to add context, security indicators, and threat intelligence to\\\\nthe normalized event. This stage is used to add new fields to the event, but it cannot modify the normalized event, it\\\\nlike the `map` stage, but with the restriction that it cannot modify the normalized event, only rule fields can be added.']\", \"Outputs\": \"Outputs are the last layer of assets that process events in a security policy. They are responsible for storing the\\nsecurity events in a storage system, sending them to a wazuh-indexer, a file, or sending them to a third-party system.\\n\\n```\\n---\\ntitle: Output schema\\n---\\nkanban\\n Output[Output schema]\\n assetName[\\\"name\\\"]@{ priority: 'Very Low'}\\n assetMetadata[\\\"metadata\\\"]@{ priority: 'Very Low'}\\n assetParents[\\\"parents\\\"]\\n assetChecks[\\\"checks\\\"]\\n OutputNormalize[\\\"output stage\\\"]\\n```\\n\\n['**Name**: Identifies the output and follows the pattern `<asset_type>/<name>/<version>`. The name is unique and cannot\\\\nbe repeated. The naming convention for components is `<type>/<name>/<version>`. The component type is `output`, and\\\\nthe version must be 0, since versioning is not implemented:', '**Metadata**: Each output has metadata that provides information about the output, such as the destination, version,\\\\nand format. This metadata does not affect the processing stages.\\\\nThe metadata fields are:', ['`description`: A brief description of the output.', 'TODO: Add more fields when the metadata is defined.'], '**Parents**: Defines the order in the output graph, establishing the parent-child relationship between outputs.\\\\nAn output can have multiple parents, when an event is successfully processed in an output, it will evaluate all the\\\\nchildren. Usually, the outputs are the last assets in the policy, so they do not have children.', '**Checks**: The checks stage is a stage in the output asset used to evaluate the conditions that the event must meet to\\\\nbe sent to the output. More information on the checks stage can be found in the [Check section](#checkallow).']\", \"Filters\": \"The filters are assets with a single stage, the check stage, used to evaluate the conditions without modifying the event.\\n\\nThe filters are used to:\\n\\n['Route events to the correct policy in the orchestrator (Most common use case).', 'Filter a event between parent assets and child assets.']\\n\\n```\\n---\\ntitle: Filter schema\\n---\\nkanban\\n Output[Output schema]\\n assetName[\\\"name\\\"]@{ priority: 'Very Low'}\\n assetMetadata[\\\"metadata\\\"]@{ priority: 'Very Low'}\\n %% assetParents[\\\"parents\\\"]\\n assetChecks[\\\"allow\\\"]\\n```\\n\\n['**Name**: Identifies the filter and follows the pattern `<asset_type>/<name>/<version>`. The name is unique and cannot\\\\nbe repeated. The naming convention for components is `<type>/<name>/<version>`. The component type is `filter`, and\\\\nthe version must be 0, since versioning is not implemented:', '**Metadata**: Each filter has metadata that provides information about the filter, such as the proposed use case, version,\\\\nand format. This metadata does not affect the processing stages.\\\\nThe metadata fields are:', ['`description`: A brief description of the filter.', 'TODO: Add more fields when the metadata is defined.'], '**Allow**: The allow stage is a stage in the filter asset used to evaluate the conditions that the event must meet to\\\\npass the filter. More information on the checks stage can be found in the [Check/allow section](#checkallow).']\\n\\n[\\\"[!NOTE]\\\\nWhen filter assets are used in the orchestrator, the don't have parents, they are a check stage that is evaluated before\\\\nthe event is sent to the policy.\\\"]\"}, \"Stages\": {\"Check/Allow\": {\"Condition list\": \"In a condition list, each condition is described with a pair `property:value`. Here, `property` is the name of any field, and `value` is the condition that the field must meet.\\n\\nThe event is filtered through all listed conditions, and only events that satisfy all conditions in order are processed further.\\n\\nDepending on the value, the condition to test is:\\n\\n['**JSON value**: Tests that the field contains a specific value.', '**Field reference**: Checks that the event contains the field denoted by the reference, and both fields have the same value. A reference is formatted as `$field.name`.', '**Helper function**: Executes a conditional operation on the field, specified by `helper_name(args\\u2026)`.']\\n\\nExample checklist:\\n\\n```\\ncheck:\\n - event.format: text\\n - user.name: $root_user\\n - event.original: exists()\\n - event.id: 1234\\n```\\n\\nAll conditions must be met for the event to pass through the check stage. If any condition fails, the event is not processed further.\\n\\n['[!NOTE]\\\\n`event.id: 1234` is not the same as `event.id: \\\"1234\\\"` because the first one is a number and the second one is a string.']\", \"Conditional expression\": \"For scenarios requiring complex conditions, especially in rules, a conditional expression allows for more nuanced logic. This string uses a subset of first-order logic language, including logical connectives and support for grouping through parentheses.\\n\\nLogical Connectives:\\n\\n['Negation (`NOT`)', 'Conjunction (`AND`)', 'Disjunction (`OR`)']\\n\\nThese connectives facilitate writing conditions between terms where a term can be:\\n\\n['Value comparison: Formatted as `<$field><op><value>`.', 'Helper function: Expressed as `<helper_name>(<field>, args...)`, except for the \\u201cexists\\u201d helper, which can be denoted by the field name alone.']\\n\\nSupported Operators:\\n\\n['Comparison operators `!=` and `==` are applicable to all data types.', 'Operators `<=`, `<`, `>=`, `>` are supported for numbers and strings (lexicographically).']\\n\\nExamples of conditional expressions:\\n\\n```\\ncheck: $event.category==\\\"registry\\\" AND $event.type==\\\"change\\\" AND ($registry.path==\\\"/some/path\\\" OR $registry.path==\\\"/some/other/path\\\")\\n```\\n\\n```\\ncheck: int_less($http.response.status_code, 400)\\n```\\n\\n```\\ncheck: $wazuh.origin == /var/log/apache2/access.log OR $wazuh.origin == /var/log/httpd/access_log\\n```\"}, \"Parse\": {\"Parser expression\": \"Parser expressions facilitate the transformation of log entries into structured objects, offering an alternative to Grok by eliminating the need for explicit type declarations as these are predefined in the schema. Instead of regular expressions, these expressions utilize tailored parsers, enhancing precision.\\n\\nThe parser expressions are composed of various tokens or expressions, where these expressions can be any one of the following:\\n\\n['**Literals**, Direct characters that match input text exactly. with certain reserved characters that require escaping (used in other tokens), with the character `\\\\\\\\` , precisely: `<>?\\\\\\\\(`', 'E.g.: The following expression will match exactly that in the log line\\\\n`[Fri Sep 09 10:42:29.902022 2011] [core:error]`', '**Fields**, are expressions of the form `<[?]field_name[/param1\\u2026]>`, where we can identify 4 different types of field expressions:', ['**Schema fields**: Directly correspond to fields defined in the schema, with the engine automatically applying the appropriate parser and can have parameters depending on the parser.', 'E.g.: `<source.ip>` will match any IPv4 or IPv6 and map it to the field `source.ip`.', '**Custom fields**: Are those that are not in the schema, in contrast to schema fields, custom fields use the text parser unless specified otherwise by the parameters. These are intended for temporary/auxiliary use.', 'Custom fields are indexed as text by default in open search, depending on the configuration open search may try to detect and index as other types.', 'E.g.: `<custom_field/long>` will match any number and map it to the field `custom_field`.', '**Optional fields**: we indicate that a field parse expression is optional writing the interrogation symbol `?` at the beginning of the expression. If the parsing fails it will continue with the next expressions.', 'E.g.: `<field1>|<?field2>|<field3>` will match anything between `|` symbols three times, and the second may be empty or not.', '**Field choice**: Expresses a choice between two field expressions, meaning one of the fields must match. We write two field expressions splitted by the interrogation symbol `?`. As the first choice we can only use parsers that do not require end token, if we use one that does the expression will fail to compile because the end tokens are not sent to the parser.', 'E.g.: `<source.ip>?<~/literal/->` will match an IP and map it to source ip or a hyphen, skipping it.', 'Note: `?` only needs to be scaped when it appears right after a field expression: `<source.ip>\\\\\\\\?...`'], '`Wildcards`, follows the same syntax and behaves the same as a custom field but has no name and does not map to any field. It is used to parse some pattern without extracting. Can be a optional or in a field choice also.', 'E.g.:`<~/byte>` will parse a byte value and continue.', 'E.g.:`Error Code: <~/long> Description: <message>` Here, `<~/long>` uses a wildcard to parse an integer error code that isn\\u2019t mapped to any field, essentially ignoring it while capturing the subsequent error description into message.', '**Optional groups**, make a logpar subexpression optional. The optional expression is denoted with `(?sub_expression)`. Used to make some more complex patterns optional where a simple optional field won\\u2019t suffice. It can contains any valid logpar expression with the exception of another optional group. An optional group can not contains another group, and two optional groups may not appear in a row.', 'E.g.:`[<source.ip>(?:<source.port>)]` will match any ip address optionally followed by a port separated by double dots, and being between brackets.']\\n\\n**Examples**:\\n\\nThis expression will capture an IP address or hostname into `client.ip` or `client.address`, and optionally capture a port into `server.port` if it is present.\\n\\n```\\n<client.ip>?<client.address> connected to <server.ip>(?:<server.port>)\\n```\\n\\nApache error parser:\\n\\n```\\n# [Mon Dec 26 16:15:55.103522 2016] [mpm_prefork:notice] [pid 11379] AH00163: Apache/2.4.23 (Unix) configured -- resuming normal operations\\n# [Mon Dec 26 16:15:55.103786 2016] [core:notice] [pid 11379] AH00094: Command line: '/usr/local/Cellar/httpd24/2.4.23_2/bin/httpd'\\n# [Wed Oct 20 19:20:59.121211 2021] [rewrite:trace3] [pid 121591:tid 140413273032448] mod_rewrite.c(470): [client 10.121.192.8:38350] 10.121.192.8 - - [dev.elastic.co/sid#55a374e851c8][rid#7fb438083ac0/initial] applying pattern '^/import/?(.*)$' to uri '/'\\n# [Wed Oct 20 19:20:59.121211 2021] [rewrite:trace3] [pid 121591:tid 140413273032448] mod_rewrite.c(470): [client milo.dom.com:513] 10.121.192.8 - - [dev.elastic.co/sid#55a374e851c8][rid#7fb438083ac0/initial] applying pattern '^/import/?(.*)$' to uri '/'\\n# [Mon Dec 26 16:22:08 2016] [error] [client 192.168.33.1] File does not exist: /var/www/favicon.ico\\n# [Fri Sep 09 10:42:29.902022 2011] [core:error] [pid 35708:tid 4328636416] [client 89.160.20.112] File does not exist: /usr/local/apache2/htdocs/favicon.ico\\n# [Thu Jun 27 06:58:09.169510 2019] [include:warn] [pid 15934] [client 67.43.156.12:12345] AH01374: mod_include: Options +Includes (or IncludesNoExec) wasn't set, INCLUDES filter removed: /test.html\\n# [Mon Dec 26 16:17:53 2016] [notice] Apache/2.2.22 (Ubuntu) configured -- resuming normal operations\\n# [Mon Dec 26 16:22:00 2016] [error] [client 192.168.33.1] File does not exist: /var/www/favicon.ico, referer: http://192.168.33.72/\\n# [Mon Dec 26 16:22:08 2016] [error] [client 192.168.33.1] File does not exist: /var/www/favicon.ico\\nparse|event.original:\\n - \\\"[<@timestamp/Mon Dec 26 16:22:00 2016>] [<log.level>] [client <source.address>(?:<source.port>)] <message>\\\"\\n\\n - \\\"[<@timestamp/%a %b %d %T %Y/en_US.UTF-8>] [<~apache.error.module>:<log.level>] [pid <process.pid>(?:tid <process.thread.id>)] [client <source.address>(?:<source.port>)] <message>\\\"\\n\\n - \\\"[<@timestamp/%a %b %d %T %Y/en_US.UTF-8>] [<~apache.error.module>:<log.level>] [pid <process.pid>(?:tid <process.thread.id>)] <message>\\\"\\n```\", \"Schema fields and parsers\": \"Fields within the schema are bound to specific parsers that ensure the data matches the expected format. For example, date fields may require a specific time format, which is denoted using parameters following the field name in the format `<field_name/param_0/param_n>`. This allows for flexible data validation against predefined types or custom formats specified by additional parameters.\\n\\nFor standard fields defined in the schema, each field type has an associated parser. For instance, a field of type long (like `event.severity`) will utilize a numeric parser.\\n\\nCustom fields not defined in the schema default to using the text parser, which continues parsing until a specified delimiter or the end of the log entry. Fields at the end of a parser expression are interpreted as catch-all, capturing all remaining text in the log entry. This approach facilitates partial parsing where full matching is not required, ensuring flexibility in log analysis.\\n\\nFor example, the case of `<tmp_field>c` this will parse everything until character `c` is found. It is possible to specify the parser name as the first argument, for example `<tmp_field/ip>c` will use the ip parser instead of the text parser. It is also possible to pass parameters to the parser, for example `<tmp_field/date/RFC822>c` parses the timestamp using the RFC822 format.\", \"End tokens and field expressions\": \"Some parsers need an anchor token to stop parsing, i.e. the text parser used by default in all custom fields will parse any character until the end token is found. The end token is the literal following the field expression, or if the field expression is at the end it will parse the remaining string.\\n\\nE.g.:`<header>:<message>` will parse and capture any text up to a double dots in the header field, and the remaining of the log will be captured in the message field.\\n\\nThis implicates that two field expressions must be splited by a literal unless the first one does not need an end token, while `<custom/long><~>` is valid, as the long parsers does not need end token, `<text><~>` will be invalid.\\n\\nIn choice expressions the end token is the same for both field expressions, it is the literal right after the second field expression. E.g, `<custom_ip>?<~>|` will be valid, as both parsers require an end token, in this case the literal `|`. This implies the same as before, if one of the choices needs an end token, it must be followed by a literal.\\n\\nIn optional group expressions, i.e. when a field is followed by an optional group, there are multiple end tokens. The literal at the beginning of the optional group and the literal right after the group, meaning if a field needs an end token and is followed by an optional group, the group must start with a literal and a literal must appear right after the group.\\n\\nE.g.: `<custom_text>(?|<opt/long>):`, in this case the text parser will try to search for a `|`, so the optional group can be parsed, and if the optional group fails, then the text parser will use the symbol `:` as end token.\"}, \"Map\": \"Executes each operation of the list in order until the last operation. If any operation fails, it continues with the next one.\\n\\nIf all operations fail the stage is not marked as failed and continues to the next stage.\\n\\n**Type Validation**:\\n\\n['When mapping a custom field (not defined in the schema), it can store any value without additional type checks.', 'When mapping a field that belongs to the schema, a validation is performed based on the field\\u2019s type (e.g.,\\\\n`source.ip` \\u2192 IP, `event.start` \\u2192 timestamp).', ['If a fixed value is provided at build time and its type is invalid, the asset build fails immediately.', 'If the value is dynamically obtained, for example from a helper or another schema field, and it eventually fails\\\\ntype validation, it will fail at runtime. The field is then left unmapped to maintain the event\\u2019s integrity.']]\\n\\nExample:\\n\\n```\\n- map:\\n - event.kind: event\\n - event.dataset: apache.access\\n - event.category: +array_append/web\\n - event.module: apache\\n - service.type: apache\\n - event.outcome: success\\n```\", \"Normalize/Enrichment\": \"The normalize stage is where the event undergoes transformations and adjustments after passing through the check and parse stages successfully. Composed of a list of sub-stages that are executed in the specified order. These sub-stages can include operations such as check, map, and parse.\\n\\n['**Check**: Applies conditional checks within the normalize context to determine if subsequent mappings or parsing should be executed.', '**Parse**: Further decomposes and extracts fields from the event data if required.', '**Map**: Transforms and assigns new values to fields in the event based on predefined rules.']\\n\\nEach set of sub-stages is processed sequentially. If a check and parse within a normalization block is successful, the corresponding map is executed, replicating the check, parse, and normalize stages of the asset.\\n\\nExample:\\n\\n```\\nnormalize:\\n - map:\\n - wazuh.decoders: array_append(windows-sysmon)\\n - event.dataset: sysmon\\n - event.kind: event\\n\\n # Only maps network.protocol if event.code is 22\\n - check: $event.code == '22'\\n map:\\n - network.protocol: dns\\n\\n # Only maps resources if the check and parse stages succeeded\\n - check: $event.outcome == failure\\n parse|message:\\n - \\\"[<error.code/int>]<details>\\\"\\n map:\\n - resources: split($details, \\\",\\\")\\n```\", \"Output\": \"The Output Stage allows you to specify and configure the different outputs, defining the final destinations for events before they leave the Engine.\\n\\n```\\noutputs:\\n - output_name: configuration\\n```\\n\\nFor more details on the available output types and configurations, refer to [output documentation](ref-output.md).\"}, \"Parsers\": {\"Schema parsers\": \"These parsers are used automatically when a field of its type is used in a logpar expression.\\n\\nFor example, if you use the field `<event.start>` which is of type `date`, it will be parsed automatically by the date parser.\\n\\nThese parsers will generate fields which are type-compatible with Wazuh Indexer.\\n\\n| Type | Parser | Description |\\n|-------------|--------------|------------------------------------------------------------------------------------------------------|\\n| null | - | A null field can\\u2019t be indexed or searched. When a field is set to null, OpenSearch behaves as if that field has no values. |\\n| boolean | bool | OpenSearch accepts true and false as boolean values. An empty string is equal to false. |\\n| float | float | Codified as decimal representation in string format. A single-precision 32-bit IEEE 754 floating point number, restricted to finite values. |\\n| scaled_float| scaled_float | Codified as decimal representation in string format. The scaling factor is defined in the schema. |\\n| double | double | Codified as decimal representation in string format. A double-precision 64-bit IEEE 754 floating point number, restricted to finite values. |\\n| long | long | Codified as decimal representation in string format. A signed 64-bit integer with a minimum value of `-2^63` and a maximum value of `2^63-1`. |\\n| byte | byte | Codified as a decimal representation in string format. A signed 8-bit integer with a minimum value of `-128` and a maximum value of `127`. |\\n| object | - | - |\\n| array | - | - |\\n| nested | - | - |\\n| text | text | A string sequence of characters that represent full-text values. |\\n| keyword | text | A string sequence of characters that represent full-text values. |\\n| ip | ip | A string with IPv4 or IPv6 address. |\\n| date | date | Date codified as string. All dates are converted to a unified date in UTC timezone. |\\n| geo_point | - | - |\\n| binary | binary | A codified base64 string. |\\n\\nAditionally we define some types for the purpose to use specific parsers, normally used to parse objects or structured types from an input text. This is the case for `url` field for example.\\n\\n| Type | Parser | Description |\\n|-------------|------------|-------------------------------------------------------------------------------------------------------|\\n| url | uri | Parses URI text and generates the URL object with all the parsed parts. |\\n| useragent | useragent | Parses a user agent string. It does not build the user agent object; this can be done with the OpenSearch plugin. |\"}, \"Debugging\": {\"Filtering Logs by Executable Name\": \"You can retrieve logs specifically for the Engine using journald\\u2019s _COMM field:\\n\\n```\\njournalctl _COMM=wazuh-engine\\n```\\n\\nFor real-time monitoring of errors:\\n\\n```\\njournalctl -f _COMM=wazuh-engine\\n```\", \"Filtering Logs by Severity\": \"To refine logs based on severity levels you can combine grep:\\n\\n```\\njournalctl _COMM=wazuh-engine | grep info\\n\\nDec 18 14:59:22 WazPc env[12974]: 2024-12-18 14:59:22.663 12974:12974 info: Logging initialized.\\nDec 18 14:59:22 WazPc env[12974]: 2024-12-18 14:59:22.668 12974:12974 fileDriver.cpp:231 at readCol(): debug: FileDriver readCol name: 'namespaces/system/decoder/core-hostinfo'.\\nDec 18 14:59:22 WazPc env[12974]: 2024-12-18 14:59:22.669 12974:12974 main.cpp:166 at main(): info: Store initialized.\\nDec 18 14:59:22 WazPc env[12974]: 2024-12-18 14:59:22.669 12974:12974 main.cpp:172 at main(): info: RBAC initialized.\\n```\\n\\nAvailable severity levels:\\n\\n['**trace** \\u2013 Provides highly detailed debugging information, useful for deep troubleshooting.', '**debug** \\u2013 Contains diagnostic messages intended for developers to track execution flow.', '**info** \\u2013 General operational logs that indicate normal Engine activity.', '**warning** \\u2013 Highlights potential issues that do not impact functionality but may require attention.', '**error** \\u2013 Reports issues that may cause incorrect behavior but do not stop the Engine.', '**critical** \\u2013 Indicates severe failures that may result in the Engine stopping or becoming unstable.']\", \"Traces\": \"Traces allow you to inspect the operational graph behavior, providing insights into how events are processed within the Engine. By using the tester endpoint (refer to the API documentation for details), you can specify several options to debug event processing effectively.\\n\\nAvailable trace options:\\n\\n['**Namespaces** \\u2013 Filters traces to show only the assets under a specified namespace.', '**Graph History** \\u2013 Displays all assets that processed a given event, allowing a complete view of its journey.', '**Traces** \\u2013 Provides a detailed history of all operations performed by each asset (or a specified set of assets).']\\n\\nHere is a test example showing the graph history:\\n\\n```\\ntraces:\\n[\\ud83d\\udd34] decoder/zeek-x509/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-weird/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-traceroute/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-stats/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-software/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-socks/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-snmp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-smb_mapping/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-smb_files/0 -> failed\\n[\\ud83d\\udd34] decoder/apache-error/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-smb_cmd/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ssl/0 -> failed\\n[\\ud83d\\udd34] decoder/snort-json/0 -> failed\\n[\\ud83d\\udd34] decoder/squid-access/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-known_certs/0 -> failed\\n[\\ud83d\\udd34] decoder/suricata/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-irc/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-exchange-server-smtp/0 -> failed\\n[\\ud83d\\udd34] decoder/snort-plaintext/0 -> failed\\n[\\ud83d\\udd34] decoder/pfsense-firewall/0 -> failed\\n[\\ud83d\\udd34] decoder/pfsense-dhcp/0 -> failed\\n[\\ud83d\\udd34] decoder/apache-access/0 -> failed\\n[\\ud83d\\udd34] decoder/snort-plaintext-csv/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-sip/0 -> failed\\n[\\ud83d\\udd34] decoder/pfsense-unbound/0 -> failed\\n[\\ud83d\\udd34] decoder/iis/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-signature/0 -> failed\\n[\\ud83d\\udd34] decoder/modsecurity-nginx/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-dhcpv6/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-conn/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-modbus/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-exchange-server-imap4-pop3/0 -> failed\\n[\\ud83d\\udd34] decoder/pfsense-php-fpm/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-exchange-server-messagetracking/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-exchange-server-httpproxy/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-kerberos/0 -> failed\\n[\\ud83d\\udd34] decoder/modsecurity-apache/0 -> failed\\n[\\ud83d\\udd34] decoder/microsoft-dhcp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-pe/0 -> failed\\n[\\ud83d\\udd34] decoder/windows-event/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-capture_loss/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-dhcp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-dnp3/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-dns/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-smtp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-http/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-rfb/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-files/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ftp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ssh/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ocsp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-dce_rpc/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-intel/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-syslog/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-known_hosts/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-dpd/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-known_services/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-mysql/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ntlm/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-tunnel/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-notice/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-ntp/0 -> failed\\n[\\ud83d\\udd34] decoder/zeek-radius/0 -> failed\\n[\\ud83d\\udfe2] decoder/syslog/0 -> success\\n[\\ud83d\\udd34] decoder/sysmon-linux/0 -> failed\\n[\\ud83d\\udd34] decoder/system-auth/0 -> failed\\n[\\ud83d\\udd34] decoder/snort-plaintext-syslog/0 -> failed\\n[\\ud83d\\udd34] decoder/wazuh-dashboard/0 -> failed\\n```\\n\\nShowing full traces:\\n\\n```\\ntraces:\\n[\\ud83d\\udfe2] decoder/syslog/0 -> success\\n \\u21b3 [/event/original: <event.start/Jun 14 15:16:01> <host.hostname> <TAG/alphanumeric/->[<process.pid>]:<~/ignore/ ><message>] -> Failure: Parse operation failed: Parser <event.start/Jun 14 15:16:01> failed at: 2018-08-14T14:30:02.203151+02:00 linux-sqrz systemd[4179]: Stopped target Basic System.\\n \\u21b3 [/event/original: <event.start/Jun 14 15:16:01> <host.hostname> <TAG/alphanumeric/->:<~/ignore/ ><message>] -> Failure: Parse operation failed: Parser <event.start/Jun 14 15:16:01> failed at: 2018-08-14T14:30:02.203151+02:00 linux-sqrz systemd[4179]: Stopped target Basic System.\\n \\u21b3 [/event/original: <event.start/2018-08-14T14:30:02.203151+02:00> <host.hostname> <TAG/alphanumeric/->[<process.pid>]: <message>] -> Success\\n \\u21b3 event.kind: map(\\\"event\\\") -> Success\\n \\u21b3 wazuh.decoders: array_append(\\\"syslog\\\") -> Success\\n \\u21b3 related.hosts: array_append($host.hostname) -> Success\\n \\u21b3 process.name: rename($TAG) -> Success\\n \\u21b3 host.ip: array_append($tmp.host_ip) -> Failure: 'tmp.host_ip' not found\\n```\"}, \"F.A.Q\": [\"A explanation of the time zone and how it works in the engine.\", \"A explanation of diferent timestamp fields and how they are used.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Api Reference\", \"description\": null, \"content\": {\"API Reference\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"Architecture\", \"description\": null, \"content\": {\"Introduction\": \"```\\n---\\nconfig:\\n title: \\\"Simplified architecture\\\"\\n nodeSpacing: 30\\n rankSpacing: 25\\n flowchart:\\n curve: stepAfter\\n subGraphTitleMargin:\\n top: 20\\n bottom: 20\\n---\\nflowchart LR\\n\\nclassDef SubmoduleClass font-size:15px,stroke-width:2px,stroke-dasharray:10px,rx:15,ry:15\\nclassDef ModuleClass font-size:15px,stroke-width:2px,rx:15,ry:15\\n\\n%% ----------------------------------\\n%% API\\n%% ----------------------------------\\n\\nsubgraph apiModule[\\\"API\\\"]\\n direction LR\\n api_orchestrator@{ shape: stadium, label: \\\"Orchestrator manager\\\" }\\n api_kvdb@{ shape: stadium, label: \\\"KVDB manager\\\" }\\n api_metrics@{ shape: stadium, label: \\\"Metric manager\\\" }\\n api_geo@{ shape: stadium, label: \\\"Geo manager\\\" }\\n api_orchestrator ~~~ api_kvdb\\n api_metrics ~~~ api_geo\\n\\n api_catalog@{ shape: disk, label: \\\"Catalog of assets\\\" }\\n api_policies@{ shape: disk, label: \\\"Policies\\\" }\\n api_policies ~~~ api_catalog\\nend\\napiModule:::ModuleClass\\n\\n\\n%% ----------------------------------\\n%% Geo module\\n%% ----------------------------------\\nsubgraph geoModule[\\\"Geolocator\\\"]\\n geo_mmdb@{ shape: disk, label: \\\"MaxMind DBs\\\" }\\nend\\ngeoModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% KVDB\\n%% ----------------------------------\\nsubgraph kvdbModule[\\\"KVDB\\\"]\\n direction TB\\n kvdb_db_2@{ shape: docs, label: \\\"Key-Value DataBases\\\" }\\nend\\nkvdbModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% Global module\\n%% ----------------------------------\\nsubgraph globalModule[\\\"Global\\\"]\\n global_metrics(\\\"Metrics\\\")\\n global_logger(\\\"Logger\\\")\\nend\\nglobalModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% Server\\n%% ----------------------------------\\n\\nsubgraph serverModule[\\\"Server\\\"]\\n direction RL\\n server_API>Server API]\\n server_engine>Server engine]\\nend\\nserverModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% Storage\\n%% ----------------------------------\\nstorageModule@{ shape: cyl, label: \\\"Persistent</br>Storage\\\" }\\nstorageModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% Builder\\n%% ----------------------------------\\nsubgraph builderModule[\\\"Builder\\\"]\\n builder_asset@{ shape: stadium, label: \\\"Builder asset\\\" }\\n builder_policy@{ shape: stadium, label: \\\"Builder policy\\\" }\\n builder_parser@{ shape: stadium, label: \\\"Builder parser\\\" }\\n builder_hp@{ shape: stadium, label: \\\"Builder helper function\\\" }\\n\\n builder_policy ~~~ builder_asset --- builder_parser & builder_hp\\n builder_parser --- builder_catalog_hf@{ shape: disk, label: \\\"Catalog of helper functions\\\" }\\n builder_hp --- builder_catalog_parser@{ shape: disk, label: \\\"Catalog of parser\\\" }\\n\\nend\\nbuilderModule:::ModuleClass\\n\\n%% ----------------------------------\\n%% Orchestrator\\n%% ----------------------------------\\nsubgraph orchestratorModule[\\\"Orchestrator\\\"]\\n direction RL\\n orchestrator_router@{ shape: stadium, label: \\\"Router\\\" }\\n orchestrator_tester@{ shape: stadium, label: \\\"Tester\\\" }\\n orchestrator_routerTable@{ shape: disk, label: \\\"Routes\\\" }\\n orchestrator_sessionTable@{ shape: disk, label: \\\"Session\\\" }\\n orchestrator_router --- orchestrator_routerTable\\n orchestrator_tester --- orchestrator_sessionTable\\nend\\norchestratorModule:::ModuleClass\\n\\nsubgraph backendModule[\\\"Backend\\\"]\\n\\nend\\n\\n%% ----------------------------------\\n%% Modules conexion\\n%% ----------------------------------\\nserverModule ------- orchestratorModule & apiModule\\norchestratorModule ---- backendModule\\nbuilderModule & apiModule --- geoModule & kvdbModule\\napiModule --- storageModule\\n\\napiModule ------ builderModule\\n\\norchestratorModule ------ builderModule\\norchestratorModule ----- apiModule\\nstorageModule --- builderModule\\n\\n```\\n\\n<center><i>Simplified architecture of the Wazuh engine</i></center>\\n\\nThe **Wazuh-Engine** is composed of multiple modules that work together to provide all engine functionality. Below is a summary of each module\\u2019s responsibilities and interactions.\\n\\n[]\", \"Main Modules\": [\"**Server**\\nThe Server module exposes the Wazuh-Engine to the rest of the Wazuh-Server system. It creates two Unix stream sockets:\", [\"**engine.socket**: Receives events from Wazuh agents and forwards them to the Orchestrator module for processing.\", \"**api.socket**: Exposes the engine\\u2019s REST API, forwarding requests to the API module. These requests manage engine state (policies, assets, routes, DB updates, etc.).\"], \"**Orchestrator**\\nThe Orchestrator module manages runtime routes and policy testing:\", [\"**Router**: Decides which policy to apply for each incoming event. It refers to a **Routes Table** that defines filters, priorities, and mappings to specific policies.\", \"**Tester**: Evaluates events against the assigned policies. It uses a **Session Table** to store context/state of session. The Tester returns the outcome of policy checks (e.g., alerts and traces).\"], \"**Backend**\\nWhile Orchestrator handles routing and policy instantiation, the Backend module executes the code produced by the Builder module. The Backend is effectively the runtime environment for those policies.\", \"**Builder**\\nThe Builder module generates executable code based on policies and assets. It has four components:\", [\"**Policy**: Constructs code representing policy logic.\", \"**Asset**: Constructs code for asset definitions.\", \"**Parser**: Constructs code for any parsing functionalities.\", \"**Helper Functions**: Builds code for auxiliary or common utility functions.\"], \"**API**\\nThe API module manages interactions between the Wazuh-Engine and external modules or services via a REST interface. Its major components include:\", [\"**Orchestrator Manager**: Handles orchestrator-related tasks.\", \"**KVDB Manager**: Manages access to the KVDB module.\", \"**Metric Manager**: Interfaces with the metrics system in the Global module.\", \"**Geo Manager**: Manages the Geo module.\", \"**Catalog of Assets**: Maintains definitions of assets used across the engine.\", \"**Policies**: Maintains definitions of policies used across the engine.\"], \"**KVDB**\\nThe KVDB module provides key-value database functionality, using [RocksDB](https://rocksdb.org/) under the hood. It is typically employed by helper functions.\", \"**Geo**\\nThe Geo module manages geolocation data, relying on [MaxMind](https://www.maxmind.com/) databases. It exposes an internal API for updating and querying geolocation information.\", \"**Persistent Storage**\\nThe Storage module oversees long-term persistence for policies, assets, sessions, and other data (e.g., routes, schemas, configurations). It currently uses the local file system.\", \"**Global**\\nThe Global module offers cross-cutting engine resources:\", [\"**Metrics**: Tracks performance and usage statistics for Wazuh-Engine.\", \"**Logger**: Centralizes logging features for all modules.\"]], \"Module: Server\": \"The **Server** module provides the primary interface for both incoming agent events and external API requests:\\n\\n['**engine.socket**:', ['Receives raw events from Wazuh agents.', 'Forwards these events to the Orchestrator for routing and policy application.'], '**api.socket**:', ['Exposes the REST API of the Wazuh-Engine.', 'Forwards requests to the API module, which then manages tasks such as policy updates, asset management, and configuration changes.']]\\n\\n[]\", \"Module: Orchestrator\": \"The **Orchestrator** determines how incoming events are routed and tested against policies:\\n\\n['**Router**:', ['Uses a **Routes Table** to map events to policies based on defined filters and priorities.', 'Example of a routes table:', '| Route name (ID) | Priority | Filter | Policy |\\\\n|-------------------|----------|---------------|--------------------------|\\\\n| router_example | 1 | filter_1 | policy_1 |\\\\n| ... | ... | filter_2 | policy_2 |\\\\n| default | 255 | * (catch-all) | wazuh-default-policy |'], '**Tester**:', ['Uses a **Session Table** to maintain session state.', 'Receives an event and a sesion, then produces a result (alerts sample and traces).']]\\n\\n[]\", \"Module: Backend\": \"The **Backend** executes the compiled policy and routing code generated by the Builder module. It effectively serves as the runtime environment for custom logic crafted by the Builder and orchestrated by the Orchestrator.\\n\\n[]\", \"Module: Geo\": \"The **Geo** module offers geolocation capabilities:\\n\\n['Relies on [MaxMind](https://www.maxmind.com/) databases.', 'Provides an internal interface for updating these databases and querying geolocation data.']\\n\\n[]\", \"Module: KVDB\": \"The **KVDB** module manages key-value databases for various engine operations:\\n\\n['Primarily used by helper functions.', 'Internally uses [RocksDB](https://rocksdb.org/) for data management.']\\n\\n[]\", \"Module: Persistent Storage\": \"The **Persistent Storage** module handles local storage for:\\n\\n['Policies, routes, assets, sessions, configurations, and other engine-related data.', 'Uses the file system for data persistence.']\\n\\n[]\", \"Module: Global\": \"The **Global** module unifies core engine-wide features:\\n\\n['**Metrics**: Collects real-time performance statistics and usage data.', '**Logger**: Centralizes logging, enabling consistent log output for all modules.']\\n\\n[]\", \"Module: Builder\": \"The **Builder** module translates high-level definitions of policies, assets, parsers, and helper functions into executable code:\\n\\n['**Policy**: Generates policy-related logic.', '**Asset**: Defines and compiles asset representation.', '**Parser**: Builds parser logic.', '**Helper Functions**: Compiles shared utility code used by assets.']\\n\\n[]\", \"Module: API\": \"The **API** module offers a REST interface for external tools and internal modules:\\n\\n['**Orchestrator Manager**: Oversees orchestrator tasks (e.g., route administration).', '**KVDB Manager**: Interfaces with KVDB for data operations.', '**Metric Manager**: Exposes engine metrics for monitoring.', '**Geo Manager**: Manages geolocation data updates and queries.', '**Catalog of Assets**: Maintains a registry of asset definitions.', '**Policies**: Maintains a registry of policies used throughout the engine.']\\n\\n[]\\n\\n**Note**: This architecture is intentionally simplified to illustrate high-level relationships and flows. For more specific implementation details (such as internal data structures, APIs, or design patterns), please refer to the respective module documentation or source code.\\n\\n[]\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \"Internal Development Tools\", \"description\": null, \"content\": {\"Api-communication\": \"This library provides a client interface for local communication with the Wazuh engine. It is designed to facilitate seamless interaction between components during development and testing.\\n\\nFor more details, refer to the README on src/engine/tools/api-communication/README.md\\n\\n[]\", \"Engine Suite\": {\"Key Tools in `engine-suite`:\": [\"**engine-clear**: Clears specific configurations or data from the engine.\", \"**engine-decoder**: Manages and tests decoders used by the engine.\", \"**engine-diff**: Compares configurations or data for differences.\", \"**engine-integration**: Handles integrations with external systems.\", \"**engine-policy**: Manages policies within the Wazuh engine.\", \"**engine-router**: Configures and tests routing within the engine.\", \"**engine-test**: Provides utilities for testing engine functionality.\"]}, \"Engine Test Utils\": \"A Python library containing utility functions and helpers for testing scripts that interact with the Wazuh engine.\\nThese utilities streamline the creation and execution of test cases.\\n\\nFor more details, refer to the README on src/engine/test/engine-test-utils/README.md\\n\\n[]\", \"Engine Helper Test\": \"This tool automates the generation of test cases to verify the correct end-to-end operation of helper functions used\\nin asset. It uses YAML files to define the parameters of helper functions and generates corresponding test cases\\nautomatically. The tool also generates documentation for helper functions.\\n\\n**Features:**\\n\\n['YAML-based test case generation.', 'Simplifies testing of helper functions.', 'Generate documentation for helper functions.']\\n\\nFor more details, refer to the README on src/engine/test/helper-test/README.md\\n\\n[]\", \"Engine Health Test\": \"The `engine-health-test` tool performs comprehensive health checks on the Wazuh ruleset.\\nIt runs a series of automated tests against the Wazuh engine to ensure the ruleset operates as expected.\\nThis tool is essential for validating the integrity and functionality of the ruleset.\\n\\nFor more details, refer to the README on src/engine/test/health_test/README.md\\n\\n**Location:** `src/engine/test/health_test/engine-health-test`\\n\\n[]\", \"Engine Integration Test\": \"The `engine-integration-test` tool is designed to test the integration of the Wazuh engine with external systems.\\nIt verifies the correct operation of integrations and ensures that data is correctly processed and forwarded to the\\nengine.\\n\\nFor more details, refer to the README on src/engine/test/integration_test/README.md.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}, {\"title\": \"Summary\", \"description\": null, \"content\": {\"Index\": {\"Filter\": [\"[array_contains](#array_contains)\", \"[array_contains_any](#array_contains_any)\", \"[array_not_contains](#array_not_contains)\", \"[array_not_contains_any](#array_not_contains_any)\", \"[binary_and](#binary_and)\", \"[contains](#contains)\", \"[ends_with](#ends_with)\", \"[exists](#exists)\", \"[exists_key_in](#exists_key_in)\", \"[int_equal](#int_equal)\", \"[int_greater](#int_greater)\", \"[int_greater_or_equal](#int_greater_or_equal)\", \"[int_less](#int_less)\", \"[int_less_or_equal](#int_less_or_equal)\", \"[int_not_equal](#int_not_equal)\", \"[ip_cidr_match](#ip_cidr_match)\", \"[is_array](#is_array)\", \"[is_boolean](#is_boolean)\", \"[is_ipv4](#is_ipv4)\", \"[is_ipv6](#is_ipv6)\", \"[is_not_array](#is_not_array)\", \"[is_not_boolean](#is_not_boolean)\", \"[is_not_object](#is_not_object)\", \"[is_not_string](#is_not_string)\", \"[is_number](#is_number)\", \"[is_object](#is_object)\", \"[is_public_ip](#is_public_ip)\", \"[is_string](#is_string)\", \"[is_test_session](#is_test_session)\", \"[keys_exist_in_list](#keys_exist_in_list)\", \"[kvdb_match](#kvdb_match)\", \"[kvdb_not_match](#kvdb_not_match)\", \"[match_value](#match_value)\", \"[number_equal](#number_equal)\", \"[number_greater](#number_greater)\", \"[number_greater_or_equal](#number_greater_or_equal)\", \"[number_less](#number_less)\", \"[number_less_or_equal](#number_less_or_equal)\", \"[number_not_equal](#number_not_equal)\", \"[regex_match](#regex_match)\", \"[starts_with](#starts_with)\", \"[string_equal](#string_equal)\", \"[string_greater](#string_greater)\", \"[string_less](#string_less)\", \"[string_less_or_equal](#string_less_or_equal)\", \"[string_not_equal](#string_not_equal)\"], \"Map\": [\"[as](#as)\", \"[concat](#concat)\", \"[concat_any](#concat_any)\", \"[date_from_epoch](#date_from_epoch)\", \"[decode_base16](#decode_base16)\", \"[downcase](#downcase)\", \"[float_calculate](#float_calculate)\", \"[geoip](#geoip)\", \"[get_date](#get_date)\", \"[hex_to_number](#hex_to_number)\", \"[int_calculate](#int_calculate)\", \"[ip_version](#ip_version)\", \"[join](#join)\", \"[regex_extract](#regex_extract)\", \"[sha1](#sha1)\", \"[system_epoch](#system_epoch)\", \"[to_int](#to_int)\", \"[to_string](#to_string)\", \"[upcase](#upcase)\"], \"Transformation\": [\"[array_append](#array_append)\", \"[array_append_any](#array_append_any)\", \"[array_append_unique](#array_append_unique)\", \"[array_append_unique_any](#array_append_unique_any)\", \"[delete](#delete)\", \"[erase_custom_fields](#erase_custom_fields)\", \"[get_key_in](#get_key_in)\", \"[kvdb_decode_bitmask](#kvdb_decode_bitmask)\", \"[kvdb_get](#kvdb_get)\", \"[kvdb_get_array](#kvdb_get_array)\", \"[kvdb_get_merge](#kvdb_get_merge)\", \"[kvdb_get_merge_recursive](#kvdb_get_merge_recursive)\", \"[merge](#merge)\", \"[merge_key_in](#merge_key_in)\", \"[merge_recursive_key_in](#merge_recursive_key_in)\", \"[parse_alphanumeric](#parse_alphanumeric)\", \"[parse_between](#parse_between)\", \"[parse_binary](#parse_binary)\", \"[parse_bool](#parse_bool)\", \"[parse_byte](#parse_byte)\", \"[parse_csv](#parse_csv)\", \"[parse_double](#parse_double)\", \"[parse_dsv](#parse_dsv)\", \"[parse_file](#parse_file)\", \"[parse_float](#parse_float)\", \"[parse_fqdn](#parse_fqdn)\", \"[parse_ip](#parse_ip)\", \"[parse_json](#parse_json)\", \"[parse_key_value](#parse_key_value)\", \"[parse_quoted](#parse_quoted)\", \"[parse_uri](#parse_uri)\", \"[parse_useragent](#parse_useragent)\", \"[parse_xml](#parse_xml)\", \"[rename](#rename)\", \"[replace](#replace)\", \"[split](#split)\", \"[trim](#trim)\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\"}, {\"title\": \"Output Reference\", \"description\": null, \"content\": {\"File\": {\"Signature\": \"```\\nfile:\\n path: ${PATH}\\n```\", \"Parameters\": \"| Name | type | required | Description |\\n|------|------|----------|-------------|\\n| path | string | yes | Absolute path to the file where the alerts will be written. The path should be writable by the user `wazuh-server`. |\", \"Asset example\": \"```\\nname: output/file-output-integrations/0\\n\\nmetadata:\\n module: wazuh\\n title: file output event\\n description: Output integrations events to a file\\n compatibility: >\\n This decoder has been tested on Wazuh version 5.x\\n versions:\\n - 5.x\\n author:\\n name: Wazuh, Inc.\\n date: 2022/11/08\\n references:\\n - \\\"\\\"\\n\\noutputs:\\n - file:\\n path: /var/lib/wazuh-server/engine/alerts-ecs.json\\n```\"}, \"Indexer\": {\"Signature\": \"```\\nwazuh-indexer:\\n index: ${INDEX}\\n```\", \"Parameters\": \"| Name | type | required | Description |\\n|------|------|----------|-------------|\\n| index | string | yes | Index name where the alerts will be indexed. Should be a valid Elasticsearch index name and start with `wazuh-`. |\", \"Asset example\": \"```\\nname: output/indexer/0\\n\\nmetadata:\\n module: wazuh\\n title: Indexer output event\\n description: Output integrations events to wazuh-indexer\\n compatibility: >\\n This decoder has been tested on Wazuh version 5.0\\n versions:\\n - \\\"\\\"\\n author:\\n name: Wazuh, Inc.\\n date: 2024/12/01\\n references:\\n - \\\"\\\"\\n\\noutputs:\\n - wazuh-indexer:\\n index: wazuh-alerts-$(DATE)\\n```\\n\\n['[!TIP]\\\\nThe `$(DATE)` macro is replaced by the current date in the format `YYYY.MM.DD` when the alert is indexed.']\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\"}, {\"title\": \"Schema parser reference\", \"description\": null, \"content\": {\"Boolean parser\": {\"Behavior\": [\"The Boolean parser strictly matches \\\"true\\\" or \\\"false\\\" without supporting parameters or alternative representations\\nlike \\\"yes\\\"/\\\"no\\\" or \\\"on\\\"/\\\"off\\\".\", \"Is key insensitive.\", \"The parser does not require an end token.\"], \"Signature\": \"```\\n<field/bool>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/bool>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"true\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"true\\\",\\n \\\"output_field\\\": true\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"False\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"False\\\",\\n \\\"output_field\\\": false\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a boolean\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid boolean.\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid boolean.\\n\\n**Example 5**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"FALSE\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"FALSE\\\",\\n \\\"output_field\\\": false\\n}\\n```\"}, \"Long parser\": {\"Behavior\": [\"Accepts strings that represent integer values, including those prefixed with a '-' sign to denote negative numbers.\", \"This parser can process numbers with decimal points but discards any fractional part,\\neffectively rounding down to the nearest whole number.\", \"It does not require a specific end token\"], \"Signature\": \"```\\n<field/long>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/long>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\",\\n \\\"output_field\\\": 123\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\",\\n \\\"output_field\\\": -123\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123.456\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123.456\\\",\\n \\\"output_field\\\": 123\\n}\\n```\\n\\nSuccess with rounding\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a number\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid long.\\n\\n**Example 5**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.23\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.23\\\",\\n \\\"output_field\\\": 1\\n}\\n```\"}, \"Double parser\": {\"Behavior\": [\"Accepts numbers with optional leading '-' signs to indicate negative values.\", \"Supports numbers with or without a decimal point, and can interpret numbers in scientific notation (e.g., `1.23E+10`).\", \"It does not require a specific end token\"], \"Signature\": \"```\\n<field/double>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/double>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\",\\n \\\"output_field\\\": 123.0\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\",\\n \\\"output_field\\\": -123.0\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2.99792458E8\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2.99792458E8\\\",\\n \\\"output_field\\\": 299792458.0\\n}\\n```\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a number\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid double.\\n\\n**Example 5**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"abc123\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid double.\\n\\n**Example 6**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1,234\\\"\\n}\\n```\\n\\nFailed parsing, commas are not supported.\\n\\n**Example 7**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.23\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.23\\\",\\n \\\"output_field\\\": 1.23\\n}\\n```\"}, \"Float parser\": {\"Behavior\": [\"Accepts both integers and decimals, with or without a negative sign.\", \"Efficiently processes numbers expressed in scientific notation (e.g., 2.5E3).\", \"Does not require a specific end token.\"], \"Signature\": \"```\\n<field/scaled_float>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/scaled_float>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\",\\n \\\"output_field\\\": 123.0\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\",\\n \\\"output_field\\\": -123.0\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2.5E3\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2.5E3\\\",\\n \\\"output_field\\\": 2500.0\\n}\\n```\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a number\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid scaled float.\\n\\n**Example 5**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.0E-2\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"1.0E-2\\\",\\n \\\"output_field\\\": 0.01\\n}\\n```\"}, \"Byte parser\": {\"Behavior\": [\"Strictly limits the accepted values to the defined byte range, rejecting inputs outside -128 to 127.\", \"Does not require a specific end token.\", \"Accepts numeric strings that may optionally include a '-' sign to indicate negative values.\"], \"Signature\": \"```\\n<field/byte>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <status_code/byte>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"123\\\",\\n \\\"status_code\\\": 123\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"-123\\\",\\n \\\"status_code\\\": -123\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"128\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid byte (out of range).\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a number\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid byte.\"}, \"Text parser\": {\"Behavior\": [\"Captures all characters in the input string until it reaches a designated end token.\", \"If no specific end token is provided, the parser consumes all characters up to the end of the input string\"], \"Signature\": \"```\\n<field/text>\\n```\", \"Examples: With prefix\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|event.original:\\n - \\\"Prefix: <output_field/text>\\\"\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: This is a test\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: This is a test\\\",\\n \\\"output_field\\\": \\\"This is a test\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: \\\"\\n}\\n```\\n\\nFailed parsing, no text to parse.\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Some text\\\"\\n}\\n```\\n\\nFailed parsing, no prefix to match.\", \"Examples 2: With Prefix and suffix\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|event.original:\\n - \\\"Prefix: <output_field/text> Suffix\\\"\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: This is a test Suffix\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: This is a test Suffix\\\",\\n \\\"output_field\\\": \\\"This is a test\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: - Suffix\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: - Suffix\\\",\\n \\\"output_field\\\": \\\"-\\\"\\n}\\n```\\n\\n**Example 3**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Prefix: Suffix\\\"\\n}\\n```\\n\\nFailed parsing, no text to parse.\\n\\n**Example 4**\\n\\nEvent input\\n\\n```\\n{\\n \\\"event.original\\\": \\\"Some text\\\"\\n}\\n```\\n\\nFailed parsing, no prefix to match.\"}, \"IP parser\": {\"Behavior\": [\"Extracts and validates IP addresses in both IPv4 and IPv6 formats.\", \"Does not require a specific end token.\"], \"Signature\": \"```\\n<field/ip>\\n```\", \"Examples\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/ip>\\n```\\n\\n**Example 1**\\n\\nInput event\\n\\n```\\n{\\n \\\"input_field\\\": \\\"192.168.1.1\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"192.168.1.1\\\",\\n \\\"output_field\\\": \\\"192.168.1.1\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nInput event\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2001:0db8:85a3:0000:0000:8a2e:0370:7334\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"2001:0db8:85a3:0000:0000:8a2e:0370:7334\\\",\\n \\\"output_field\\\": \\\"2001:0db8:85a3:0000:0000:8a2e:0370:7334\\\"\\n}\\n```\\n\\n**Example 3**\\n\\nInput event\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not an IP address\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not an IP address\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid IP address.\"}, \"Date parser\": {\"Behavior\": [\"Format Matching: Attempts to match the input date string against the specified format.\", \"Adjustment and Validation: Misformatted or incomplete date entries may result in adjustments based on default values (like assuming the current year when it's missing) or parsing failures, depending on the format's requirements.\", \"Standardization: Successfully parsed dates are systematically converted to the ISO 8601 format, enhancing data consistency across systems.\", \"Custom Field Applicability: Can be manually applied to custom fields where specific date parsing is required\", \"Does not require a specific end token.\"], \"Signature\": \"```\\n<field/date/Format/[Locale]>\\n```\\n\\n['`Format`: Date format string or predefined format name.', '`Locale`: Optional locale string for date parsing. The default locale is \\\"en_US.UTF-8\\\", which handles the most\\\\ncommonly encountered date formats.']\\n\\n***Supported formats***\\n\\nThe parser supports several predefined date formats which are commonly used in various logging standards, such as syslog,\\nRFCs, and more. Users can specify a custom format using the [syntax from Howard Hinnant's date library](https://howardhinnant.github.io/date/date.html#from_stream_formatting), or choose from\\npredefined formats like RFC3339, ISO8601, etc.\\n\\n| Predefined Format | Equivalent expression | Match example |\\n|-----------------------|---------------------|-----------------------------------|\\n| ANSIC | %a %b %d %T %Y | Mon Jan _2 15:04:05 2006 |\\n| UnixDate | %a %b %d %T %Z %Y | Mon Jan _2 15:04:05 MST 2006 |\\n| RubyDate | %a %b %d %T %z %Y | Mon Jan 02 15:04:05 -0700 2006 |\\n| RFC822 | %d %b %y %R %Z | 02 Jan 06 15:04 MST |\\n| RFC822Z | %d %b %y %R %z | 02 Jan 06 15:04 -0000 |\\n| RFC850 | %A, %d-%b-%y %T %Z | Monday, 02-Jan-06 15:04:05 MST |\\n| RFC1123 | %a, %d %b %Y %T %Z | Mon, 02 Jan 2006 15:04:05 MST |\\n| RFC1123Z | %a, %d %b %Y %T %z | Mon, 02 Jan 2006 15:04:05 -0700 |\\n| RFC3339 | %FT%TZ%Ez | 2006-01-02T15:04:05Z07:00 |\\n| RFC3164 | %b %d %R:%6S %Z | Mar 1 18:48:50.483 UTC |\\n| SYSLOG | %b %d %T | Jun 14 15:16:01 |\\n| ISO8601 | %FT%T%Ez | 2018-08-14T14:30:02.203151+02:00 |\\n| ISO8601Z | %FT%TZ | 2018-08-14T14:30:02.203151Z |\\n| HTTPDATE | %d/%b/%Y:%T %z | 26/Dec/2016:16:22:14 +0000 |\\n| NGINX_ERROR | %Y/%m/%d %T | 2019/10/30 23:26:34 |\\n| POSTGRES | %F %H:%M:%6S %Z | 2021-02-14 10:45:33 UTC |\", \"Examples: Without locale\": \"**Parser configuration**\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|event_time:\\n - <tmp_time/date/RFC3339>\\n```\\n\\n**Example 1**\\nEvent input\\n\\n```\\n{\\n \\\"event_time\\\": \\\"2020-01-02T03:04:05Z07:00\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"event_time\\\": \\\"2020-01-02T03:04:05Z07:00\\\",\\n \\\"tmp_time\\\": \\\"2020-01-01T20:04:05.000Z\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nInput event\\n\\n```\\n{\\n \\\"event_time\\\": \\\"Not a date\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid date.\\n\\n**Example 3**\\n\\nInput event\\n\\n```\\n{\\n \\\"event_time\\\": \\\"2020-01-02T03:04:05\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid date, missing timezone.\", \"Examples: With locale\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|event_time:\\n - <event.start/HTTPDATE/en_GB.UTF-8>\\n```\\n\\n['[!NOTE]\\\\nThe `date` parser use is implicit, because the parser is automatically applied to schema fields defined as type `date`\\\\nlike `event.start`.']\\n\\n**Example 1**\\n\\nInput event\\n\\n```\\n{\\n \\\"event_time\\\": \\\"02/Jan/2020:03:04:05 +0000\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"event_time\\\": \\\"02/Jan/2020:03:04:05 +0000\\\",\\n \\\"event.start\\\": \\\"2020-01-02T03:04:05.000Z\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nInput event\\n\\n```\\n{\\n \\\"event_time\\\": \\\"Not a date\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid date.\"}, \"Binary parser\": {\"Behavior\": [\"Validates base64 encoded strings, ensuring they conform to the base64 encoding standard.\\nensuring the character set includes only A-Z, a-z, 0-9, '+', '/', and '=' for end padding.\", \"Does not require a specific end token.\"], \"Signature\": \"```\\n<field/binary>\\n```\", \"Example\": \"**Parser configuration**\\n\\nFor the following examples, the parser configuration is as follows:\\n\\n```\\nparse|input_field:\\n - <output_field/binary>\\n```\\n\\n**Example 1**\\n\\nEvent input\\n\\n```\\n{\\n \\\"input_field\\\": \\\"SGVsbG8sIFdvcmxkIQ==\\\"\\n}\\n```\\n\\nOutput after parse\\n\\n```\\n{\\n \\\"input_field\\\": \\\"SGVsbG8sIFdvcmxkIQ==\\\",\\n \\\"output_field\\\": \\\"Hello, World!\\\"\\n}\\n```\\n\\n**Example 2**\\n\\nInput event\\n\\n```\\n{\\n \\\"input_field\\\": \\\"Not a base64 string\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid base64 string.\\n\\n**Example 3**\\n\\nInput event\\n\\n```\\n{\\n \\\"input_field\\\": \\\"SGVsbG8sIFdvcmxkIQ\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid base64 string, missing padding.\\n\\n**Input event**\\n\\n```\\n{\\n \\\"input_field\\\": \\\"SGVsbG8sIFdvcmxkIQ@=\\\"\\n}\\n```\\n\\nFailed parsing, the input is not a valid base64 string, invalid character.\\n\\n[]\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 1]\"}, {\"title\": \"Inventory Harvester\", \"description\": \"Documentation section: inventory-harvester\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules/inventory-harvester\"}, \"subpages\": [{\"title\": \"InventoryHarvester\", \"description\": null, \"content\": {\"Overview\": {\"Key Responsibilities\": [\"**Receive** inventory data (e.g., hardware/software/network details, FIM data) via flatbuffer messages.\", \"**Index** all collected data in the Wazuh Indexer in accordance with global state requirements.\", \"**Manage** bulk operations, reducing overhead and improving overall performance.\", \"**Integrate** seamlessly with FIM and other Wazuh modules that rely on inventory data.\"], \"Data Flow\": [\"**Message Ingestion**\", [\"Both the `System inventory` module and the `FIM` module event messages arrive to the manager.\", \"Flatbuffer messages arrive to the Inventory Harvester module through the router.\"], \"**Deserialization & Validation**\", [\"Each message is deserialized, validated, and processed for indexing.\"], \"**Indexer Connector**\", [\"Validated data is batched and sent to the Wazuh Indexer in bulk, minimizing overhead.\"], \"**Storage**\", [\"The data is stored in a dedicated global state index, following Wazuh Common Schemas (WCS). There is one index for each type of inventory data.\"], \"**Monitoring & Feedback**\", [\"Any indexing issues or failures are reported to the relevant components for retries or error handling.\"]], \"Supported modules\": [\"**System inventory**\", [\"System: Operating system running on agent.\", \"Programs: Installed programs in the agent endpoint.\", \"Processes: Running programs in the agent endpoint at the moment of the scan.\", \"Hotfixes: Installed vulnerability and fix patches for Windows system endpoints.\", \"Hardware: Installed CPU and memory information.\", \"Network protocol: Network protocol shows information for detected network interfaces.\", \"Network address: Current network connection.\", \"Network interface: Descriptive information of network interfaces.\", \"Ports: Details about open ports in the agent endpoint.\", \"Users: Detailed information for each user registered in the OS for control access and permissions.\", \"Groups: Detailed information for each group present in the OS for control access and permissions.\"], \"**File Integrity Monitoring**\", [\"Files: Monitored files\", \"Registries: Monitored registries for Windows system endpoints.\"]]}, \"Related Epic\": \"FIM (File Integrity Monitoring) and Inventory modules can leverage global queries in the Wazuh Indexer to perform complex searches and filtering on collected data. This capability significantly enhances Wazuh\\u2019s security and compliance features.\\n\\n['**Epic**: [#27894 \\u2013 Global Queries for FIM and Inventory Modules](https://github.com/wazuh/wazuh/issues/27894)', '**Responsible Team**: [@wazuh/devel-xdrsiem-server](https://github.com/orgs/wazuh/teams/devel-xdrsiem-server)']\\n\\n[]\", \"Functional Requirements\": [\"Users can run **built-in** visualizations and queries on **FIM** and **System Inventory** global state data.\", \"Users can create **custom** visualizations and queries for the same data.\", \"Users **cannot edit or delete** a global state index or its data directly.\", \"When an **agent is removed**, the global state data reflects the removal.\", \"Supports both **Wazuh server cluster** and **Wazuh server standalone** deployments.\", \"**FIM** and **System Inventory** schemas must comply with **WCS**.\"], \"Non-Functional Requirements\": [\"Global state changes are reflected in the Wazuh Indexer based on whichever of the following occurs first:\", [\"**25,000** accumulated change events.\", \"**20 seconds** after the last bulk operation.\"], \"Hardware resource usage (CPU, memory, storage) must stay within acceptable limits.\", \"No new external libraries, frameworks, or dependencies are introduced.\"], \"Implementation Restrictions\": [\"**FIM** and **system inventory** global state data resides in the Wazuh Indexer.\", \"The **Indexer connector** handles the creation of required indices.\", \"Permissions to edit or delete **global state indices** differ from regular user permissions.\", \"**Manager-Indexer synchronization** is guaranteed when both operate under the same Wazuh version.\", \"FIM and system inventory fields follow a **common schema** wherever possible.\", \"The **UI** for FIM and system inventory is designed to mirror the **Vulnerability Detector** interface for consistency.\"], \"Implementation Missing Features\": [\"Currently, the events indexation for **agent 000 (Wazuh manager)** is not supported.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Api Reference\", \"description\": null, \"content\": {\"API Reference\": \"The Inventory Harvester module indexes FIM and Inventory data into dedicated indices within the Wazuh-indexer (OpenSearch). So the information is retrieved by using the Opensearch API (ref: https://opensearch.org/docs/latest/api-reference/).\\n\\nFor a quick reference, the table below lists the component and its specific query.\\n\\n| Component | Query |\\n|------------------------------|--------------------------------------------------|\\n| Inventory OS | GET /wazuh-states-inventory-system-*/_search |\\n| Inventory Packages | GET /wazuh-states-inventory-packages-*/_search |\\n| Inventory Processes | GET /wazuh-states-inventory-processes-*/_search |\\n| Inventory Ports | GET /wazuh-states-inventory-ports-*/_search |\\n| Inventory Hardware | GET /wazuh-states-inventory-hardware-*/_search |\\n| Inventory Hotfixes | GET /wazuh-states-inventory-hotfixes-*/_search |\\n| Inventory Network Addresses | GET /wazuh-states-inventory-networks-*/_search |\\n| Inventory Network Protocols | GET /wazuh-states-inventory-protocols-*/_search |\\n| Inventory Network Interfaces | GET /wazuh-states-inventory-interfaces-*/_search |\\n| Inventory Users | GET /wazuh-states-inventory-users-*/_search |\\n| Inventory Groups | GET /wazuh-states-inventory-groups-*/_search |\\n| FIM Files | GET /wazuh-states-fim-files-*/_search |\\n| FIM Registries | GET /wazuh-states-fim-registries-*/_search |\\n\\nRefer to [Description](description.md) to visualize the retrieved document format for each request.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"Architecture\", \"description\": null, \"content\": {\"Main Components\": [\"**`src/wazuh_modules/inventory_harvester/src/inventoryHarvester.cpp`**\\nThe primary module file that defines the `InventoryHarvester` class and its methods. It orchestrates how incoming messages are ingested and then handed off for indexing.\", \"**`src/wazuh_modules/inventory_harvester/src/inventoryHarvesterFacade.cpp`**\\nA **Facade** class that provides a simplified interface to `InventoryHarvester`. By masking the underlying logic of:\", [\"Flatbuffer message handling\", \"Index schema management\", \"Bulk operations\"], \"So the external components interact with `InventoryHarvester` through a unified, minimal interface.\", \"**`src/wazuh_modules/inventory_harvester/src/common/`**\\nA folder containing common operations used by the `InventoryHarvester` module:\", [\"**`clearAgent`**: Removes all data related to an agent (when the agent is removed from the manager) by sending a `DELETED_BY_QUERY` message to the Wazuh Indexer.\", \"**`clearElements`**: Similar to the previous operation, this function is triggered by `DeleteAllEntries` message types mapped to `integrity_clear` events from the `FIM` and `System inventory` modules.\", [\"In the `System inventory` module, `integrity_clear` events are sent to the manager for each provider when it is disabled in the configuration file. i.e. packages, ports, hardware.\", \"In the `FIM` module, `integrity_clear` events are sent to the manager for the `fim_file` component when no directories are being monitored. Similarly, for `Windows` systems, they are sent for the `fim_registry_key` and `fim_registry_value` components when no registries are being monitored.\"], \"**`elementDispatch`**: Dispatches incoming elements to the correct handler based on the element type.\", \"**`indexSync`**: Synchronizes indices with the Wazuh Indexer.\", \"**`upgradeAgentDb`**: Action that performs a re-synchronization between databases when upgrading the manager from a legacy ensuring that synchronization events are triggered.\\nThe Inventory Harvester does not process information stored in databases, only delta and synchronization events.\"], \"**`src/wazuh_modules/inventory_harvester/src/fimInventory/` and `src/wazuh_modules/inventory_harvester/src/systemInventory/`**\\nThese folders combine the **Factory Method** and **Chain of Responsibility** patterns:\", [\"**Factory Method**: Defines an interface for creating indexer-related objects (e.g., index writers or message handlers), while allowing subclasses to decide the specific type of object to instantiate. This ensures the creation logic is flexible and easily modifiable.\", \"**Chain of Responsibility**: Organizes handlers (validation, indexing, error handling, etc.) in a chain. Each handler can either process a request or delegate it to the next handler, making the ingestion/indexing pipeline more maintainable and extensible.\"], \"**`src/wazuh_modules/inventory_harvester/src/wcsModel/`**\\nContains schema definitions for the **Wazuh Common Schema (WCS)** models. By adhering to WCS, the InventoryHarvester ensures consistency and compatibility across Wazuh modules. The models capture essential information (system inventory, FIM data, etc.) and use a **JSON reflection mechanism** to convert internal data structures into JSON for the Wazuh Indexer.\"], \"High-Level Architecture Diagram\": \"```\\nflowchart TD\\n\\nsubgraph WazuhManager[\\\"Wazuh Manager\\\"]\\n Remoted[\\\"Remoted\\\"]\\n subgraph WazuhModulesM[\\\"Wazuh Modules\\\"]\\n InventoryHarvester[\\\"Inventory Harvester\\\"]\\n IndexerConnector[\\\"Indexer Connector\\\"]\\n InventoryHarvester -- \\\"JSON Reflection\\\" --> IndexerConnector\\n end\\n Remoted -- \\\"Plain text JSON event\\\" --> Router\\n Router -- \\\"Flatbuffer event\\\" --> InventoryHarvester\\nend\\nIndexerConnector -- indexes JSON document --> WazuhIndexer\\nsubgraph WazuhAgent[\\\"Wazuh Agent\\\"]\\n subgraph Providers[\\\"Data Provider\\\"]\\n OS[\\\"Operating System\\\"]\\n Packages[\\\"Packages\\\"]\\n Processes[\\\"Processes\\\"]\\n Hotfixes[\\\"Hotfixes\\\"]\\n Ports[\\\"Ports\\\"]\\n Hardware[\\\"Hardware\\\"]\\n Network[\\\"Networks\\\"]\\n Users[\\\"Users\\\"]\\n Groups[\\\"Groups\\\"]\\n end\\n subgraph WazuhModulesA[\\\"wazuh-modulesd\\\"]\\n SystemInventory[\\\"System inventory\\\"]\\n end\\n subgraph Syscheckd[\\\"wazuh-syscheckd\\\"]\\n FileM[\\\"File monitoring\\\"]\\n RegistryM[\\\"Registry monitoring\\\"]\\n end\\n Syscheckd -- \\\"Plain text JSON event\\\" --> Remoted\\n SystemInventory -- \\\"Plain text JSON event\\\" --> Remoted\\nend\\nProviders --> SystemInventory\\nWazuhIndexer[\\\"Wazuh Indexer\\\"]\\nWazuhDashboard[\\\"Wazuh Dashboard\\\"]\\nWazuhDashboard -- /_search/dedicated_index --> WazuhIndexer\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"Settings\", \"description\": null, \"content\": {\"Connection to Wazuh Indexer\": \"As mentioned above, the Inventory Harvester module needs to connect to the Wazuh Indexer through the Indexer Connector module.\\n\\n['Default Indexer Connector configuration block']\\n\\n```\\n <indexer>\\n <enabled>yes</enabled>\\n <hosts>\\n <host>https://0.0.0.0:9200</host>\\n </hosts>\\n <ssl>\\n <certificate_authorities>\\n <ca>/etc/filebeat/certs/root-ca.pem</ca>\\n </certificate_authorities>\\n <certificate>/etc/filebeat/certs/filebeat.pem</certificate>\\n <key>/etc/filebeat/certs/filebeat-key.pem</key>\\n </ssl>\\n </indexer>\\n```\\n\\nIt is important to verify the status of the Wazuh Indexer **GET /_cluster/health**\\n\\n['e.g. Response']\\n\\n```\\n{\\n \\\"cluster_name\\\": \\\"wazuh-cluster\\\",\\n \\\"status\\\": \\\"green\\\",\\n \\\"timed_out\\\": false,\\n \\\"number_of_nodes\\\": 1,\\n \\\"number_of_data_nodes\\\": 1,\\n \\\"discovered_master\\\": true,\\n \\\"discovered_cluster_manager\\\": true,\\n \\\"active_primary_shards\\\": 15,\\n \\\"active_shards\\\": 15,\\n \\\"relocating_shards\\\": 0,\\n \\\"initializing_shards\\\": 0,\\n \\\"unassigned_shards\\\": 0,\\n \\\"delayed_unassigned_shards\\\": 0,\\n \\\"number_of_pending_tasks\\\": 0,\\n \\\"number_of_in_flight_fetch\\\": 0,\\n \\\"task_max_waiting_in_queue_millis\\\": 0,\\n \\\"active_shards_percent_as_number\\\": 100\\n}\\n```\", \"Data to index\": \"Once again, the **Inventory Harvester** does not have the ability to choose the information that will be indexed. All events received from agents are processed and indexed. To prevent specific information from being indexed, the corresponding feature must be disabled on the agent side, just as it works with database information.\\n\\n['Disabling specific Inventory providers']\\n\\nTurn off specific providers individually\\n\\n```\\n<wodle name=\\\"syscollector\\\">\\n<disabled>no</disabled>\\n<interval>1h</interval>\\n<scan_on_start>yes</scan_on_start>\\n<hardware>yes</hardware>\\n<os>yes</os>\\n<network>yes</network>\\n<packages>yes</packages>\\n<ports all=\\\"no\\\">yes</ports>\\n<processes>yes</processes>\\n<users>yes</users>\\n<groups>yes</groups>\\n\\n<!-- Database synchronization settings -->\\n<synchronization>\\n <max_eps>10</max_eps>\\n</synchronization>\\n</wodle>\\n```\\n\\n**`<hotfixes>` provider is hidden by default**\\n\\n['Disabling FIM components']\\n\\nTo disable files monitoring the following configuration must not exist\\n\\n```\\n<directories><FILEPATH_OF_MONITORED_FILE></directories>\\n```\\n\\nTo disabled registries monitoring the following configuration must not exist (Only Windows)\\n\\n```\\n<windows_registry><REGISTRYPATH_OF_MONITORED_REGISTRY></windows_registry>\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"Description\", \"description\": null, \"content\": {\"FIM\": {\"Files\": [\"Windows\"], \"Registries\": [\"Windows\"]}, \"Inventory\": {\"System\": [\"Windows\"], \"Packages\": [\"Windows\"], \"Processes\": [\"Windows\"], \"Ports\": [\"Windows\"], \"Hardware\": [\"Windows\"], \"Hotfixes\": [\"Windows\"], \"Network Protocol\": [\"Windows\"], \"Network address\": [\"Windows\"], \"Network interfaces\": [\"Windows\"], \"Groups\": [\"Linux\"], \"Users\": [\"Linux\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 2]\"}, {\"title\": \"Utils\", \"description\": \"Documentation section: utils\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules/utils\"}, \"subpages\": [{\"title\": \"Flatbuffers\", \"description\": \"Documentation section: flatbuffers\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules/utils/flatbuffers\"}, \"subpages\": [{\"title\": \"Flatbuffers\", \"description\": null, \"content\": {\"Flatbuffer schemas\": {\"Common AgentInfo table\": [\"Common agent information for FIM Delta, Inventory Delta and Synchronization events.\"], \"FIM Delta table\": [\"Main table in flatbuffer schema for FIM Delta events.\"], \"FIM Data table\": [\"Data table for FIM delta events.\"], \"FIM Attributes table\": [\"Attributes table for FIM delta events.\"], \"Inventory Delta table\": [\"Main table in flatbuffer schema for inventory Delta events.\"], \"Inventory Provider union table\": [\"Provider union table for inventory delta events.\"], \"Inventory providers\": [\"Provider tables for inventory delta events.\"], \"SyncMsg table\": [\"Main table in flatbuffer schema for synchronization events.\"], \"DataUnion table union\": [\"DataUnion table union for synchronization events.\"], \"State table\": [\"State event type for synchronization events.\"], \"AttributesUnion table union\": [\"Different event component types for synchronization events.\"], \"fim_file table\": [\"fim_file table for file monitoring in synchronization events.\"], \"fim_registry_key table\": [\"fim_registry_key table for registry monitoring in synchronization events.\"], \"fim_registry_value\": [\"fim_registry_value table for registry monitoring in synchronization events.\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 3]\"}, {\"title\": \"Vulnerability Scanner\", \"description\": \"Documentation section: vulnerability-scanner\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs/ref/modules/vulnerability-scanner\"}, \"subpages\": [{\"title\": \"Readme\", \"description\": null, \"content\": {\"Introduction\": \"The vulnerability scanner is an event-driven module that processes operating system, hotfix and package Syscollector events looking for vulnerabilities relying on [CTI](https://cti.wazuh.com/vulnerabilities/cves) data for detection. \\n\\nThe CVE information provided by CTI is the result of a processing pipeline that analyzes, parses and formats the information from multiple sources in a common JSON CVE5 schema.\\n\\nThe vulnerability scanner reads and processes the data creating local RocksDB databases with the CVE information that later will be correlated with the incoming events. \\n\\nThe vulnerabilities detected are represented in a JSON document format ready to be indexed.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}, {\"title\": \"Indexed vulnerabilities \", \"description\": null, \"content\": {\"Ubuntu \": \"```\\n{\\n \\\"_index\\\": \\\"wazuh-states-vulnerabilities-jammy\\\",\\n \\\"_id\\\": \\\"001_9ad9d4c11defa663706b9812ffdf99572e969058_CVE-2016-2781\\\",\\n \\\"_score\\\": 1,\\n \\\"_source\\\": {\\n \\\"agent\\\": {\\n \\\"id\\\": \\\"001\\\",\\n \\\"name\\\": \\\"1495da319fdc\\\",\\n \\\"type\\\": \\\"Wazuh\\\",\\n \\\"version\\\": \\\"v4.11.2\\\"\\n },\\n \\\"host\\\": {\\n \\\"os\\\": {\\n \\\"full\\\": \\\"Ubuntu 22.04.5 LTS (Jammy Jellyfish)\\\",\\n \\\"kernel\\\": \\\"5.15.0-138-generic\\\",\\n \\\"name\\\": \\\"Ubuntu\\\",\\n \\\"platform\\\": \\\"ubuntu\\\",\\n \\\"type\\\": \\\"ubuntu\\\",\\n \\\"version\\\": \\\"22.04.5\\\"\\n }\\n },\\n \\\"package\\\": {\\n \\\"architecture\\\": \\\"amd64\\\",\\n \\\"description\\\": \\\"GNU core utilities\\\",\\n \\\"name\\\": \\\"coreutils\\\",\\n \\\"size\\\": 7282688,\\n \\\"type\\\": \\\"deb\\\",\\n \\\"version\\\": \\\"8.32-4.1ubuntu1.2\\\"\\n },\\n \\\"vulnerability\\\": {\\n \\\"category\\\": \\\"Packages\\\",\\n \\\"classification\\\": \\\"-\\\",\\n \\\"description\\\": \\\"chroot in GNU coreutils, when used with --userspec, allows local users toescape to the parent session via a crafted TIOCSTI ioctl call, which pushescharacters to the terminal's input buffer.\\\",\\n \\\"detected_at\\\": \\\"2025-05-05T19:04:19.577Z\\\",\\n \\\"enumeration\\\": \\\"CVE\\\",\\n \\\"id\\\": \\\"CVE-2016-2781\\\",\\n \\\"published_at\\\": \\\"2017-02-07T15:59:00Z\\\",\\n \\\"reference\\\": \\\"https://ubuntu.com/security/CVE-2016-2781, https://www.cve.org/CVERecord?id=CVE-2016-2781\\\",\\n \\\"scanner\\\": {\\n \\\"condition\\\": \\\"Package default status\\\",\\n \\\"reference\\\": \\\"https://cti.wazuh.com/vulnerabilities/cves/CVE-2016-2781\\\",\\n \\\"source\\\": \\\"Canonical Security Tracker\\\",\\n \\\"vendor\\\": \\\"Wazuh\\\"\\n },\\n \\\"score\\\": {\\n \\\"base\\\": 6.5,\\n \\\"version\\\": \\\"3.0\\\"\\n },\\n \\\"severity\\\": \\\"Medium\\\",\\n \\\"under_evaluation\\\": false\\n },\\n \\\"wazuh\\\": {\\n \\\"cluster\\\": {\\n \\\"name\\\": \\\"jammy\\\"\\n },\\n \\\"schema\\\": {\\n \\\"version\\\": \\\"1.0.0\\\"\\n }\\n }\\n }\\n}\\n```\", \"Centos\": \"```\\n{\\n \\\"_index\\\": \\\"wazuh-states-vulnerabilities-jammy\\\",\\n \\\"_id\\\": \\\"002_f660c0f64f48a92f0afe744f658e223bd5238bf1_CVE-2022-3219\\\",\\n \\\"_score\\\": 1,\\n \\\"_source\\\": {\\n \\\"agent\\\": {\\n \\\"id\\\": \\\"002\\\",\\n \\\"name\\\": \\\"5abe6b9cecda\\\",\\n \\\"type\\\": \\\"Wazuh\\\",\\n \\\"version\\\": \\\"v4.11.2\\\"\\n },\\n \\\"host\\\": {\\n \\\"os\\\": {\\n \\\"full\\\": \\\"CentOS Linux 8.4.2105\\\",\\n \\\"kernel\\\": \\\"5.15.0-138-generic\\\",\\n \\\"name\\\": \\\"CentOS Linux\\\",\\n \\\"platform\\\": \\\"centos\\\",\\n \\\"type\\\": \\\"centos\\\",\\n \\\"version\\\": \\\"8.4.2105\\\"\\n }\\n },\\n \\\"package\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"description\\\": \\\"Utility for secure communication and data storage\\\",\\n \\\"installed\\\": \\\"2021-09-15T14:17:36.000Z\\\",\\n \\\"name\\\": \\\"gnupg2\\\",\\n \\\"size\\\": 9923131,\\n \\\"type\\\": \\\"rpm\\\",\\n \\\"version\\\": \\\"2.2.20-2.el8\\\"\\n },\\n \\\"vulnerability\\\": {\\n \\\"category\\\": \\\"Packages\\\",\\n \\\"classification\\\": \\\"-\\\",\\n \\\"description\\\": \\\"DOCUMENTATION: A vulnerability was found in GnuPG. GnuPG can spin on a relatively small input by crafting a public key with thousands of signatures attached and compressed down to a few kilobytes. This issue can potentially cause a denial of service.\\\",\\n \\\"detected_at\\\": \\\"2025-05-05T19:04:20.037Z\\\",\\n \\\"enumeration\\\": \\\"CVE\\\",\\n \\\"id\\\": \\\"CVE-2022-3219\\\",\\n \\\"published_at\\\": \\\"2023-02-23T20:15:12Z\\\",\\n \\\"reference\\\": \\\"https://access.redhat.com/security/cve/CVE-2022-3219\\\",\\n \\\"scanner\\\": {\\n \\\"condition\\\": \\\"Package default status\\\",\\n \\\"reference\\\": \\\"https://cti.wazuh.com/vulnerabilities/cves/CVE-2022-3219\\\",\\n \\\"source\\\": \\\"Red Hat CVE Database\\\",\\n \\\"vendor\\\": \\\"Wazuh\\\"\\n },\\n \\\"score\\\": {\\n \\\"base\\\": 6.2,\\n \\\"version\\\": \\\"3.1\\\"\\n },\\n \\\"severity\\\": \\\"Medium\\\",\\n \\\"under_evaluation\\\": false\\n },\\n \\\"wazuh\\\": {\\n \\\"cluster\\\": {\\n \\\"name\\\": \\\"jammy\\\"\\n },\\n \\\"schema\\\": {\\n \\\"version\\\": \\\"1.0.0\\\"\\n }\\n }\\n }\\n}\\n```\", \"Windows \": \"```\\n{\\n \\\"_index\\\": \\\"wazuh-states-vulnerabilities-jammy\\\",\\n \\\"_id\\\": \\\"003_Microsoft Windows Server 2019 Datacenter Evaluation_CVE-2024-43558\\\",\\n \\\"_score\\\": 1,\\n \\\"_source\\\": {\\n \\\"agent\\\": {\\n \\\"id\\\": \\\"003\\\",\\n \\\"name\\\": \\\"vagrant\\\",\\n \\\"type\\\": \\\"Wazuh\\\",\\n \\\"version\\\": \\\"v4.11.2\\\"\\n },\\n \\\"host\\\": {\\n \\\"os\\\": {\\n \\\"full\\\": \\\"Microsoft Windows Server 2019 Datacenter Evaluation 10.0.17763.1935\\\",\\n \\\"name\\\": \\\"Microsoft Windows Server 2019 Datacenter Evaluation\\\",\\n \\\"platform\\\": \\\"windows\\\",\\n \\\"type\\\": \\\"windows\\\",\\n \\\"version\\\": \\\"10.0.17763.1935\\\"\\n }\\n },\\n \\\"package\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"name\\\": \\\"Microsoft Windows Server 2019 Datacenter Evaluation 10.0.17763.1935\\\",\\n \\\"type\\\": \\\"windows\\\",\\n \\\"version\\\": \\\"10.0.17763.1935\\\"\\n },\\n \\\"vulnerability\\\": {\\n \\\"category\\\": \\\"OS\\\",\\n \\\"classification\\\": \\\"CVSS\\\",\\n \\\"description\\\": \\\"Windows Mobile Broadband Driver Denial of Service Vulnerability\\\",\\n \\\"detected_at\\\": \\\"2025-05-05T19:23:53.627Z\\\",\\n \\\"enumeration\\\": \\\"CVE\\\",\\n \\\"id\\\": \\\"CVE-2024-43558\\\",\\n \\\"published_at\\\": \\\"2024-10-08T18:15:22Z\\\",\\n \\\"reference\\\": \\\"https://msrc.microsoft.com/update-guide/vulnerability/CVE-2024-43558\\\",\\n \\\"scanner\\\": {\\n \\\"condition\\\": \\\"Package less than 10.0.17763.6414\\\",\\n \\\"reference\\\": \\\"https://cti.wazuh.com/vulnerabilities/cves/CVE-2024-43558\\\",\\n \\\"source\\\": \\\"National Vulnerability Database\\\",\\n \\\"vendor\\\": \\\"Wazuh\\\"\\n },\\n \\\"score\\\": {\\n \\\"base\\\": 6.5,\\n \\\"version\\\": \\\"3.1\\\"\\n },\\n \\\"severity\\\": \\\"Medium\\\",\\n \\\"under_evaluation\\\": false\\n },\\n \\\"wazuh\\\": {\\n \\\"cluster\\\": {\\n \\\"name\\\": \\\"jammy\\\"\\n },\\n \\\"schema\\\": {\\n \\\"version\\\": \\\"1.0.0\\\"\\n }\\n }\\n }\\n}\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 1]\"}, {\"title\": \"Arquitecture\", \"description\": null, \"content\": {\"Main Components\": [\"**`src/wazuh_modules/vulnerability_scanner/src/vulnerabilityScannerFacade.cpp`**\\nThe main class that provides the starting point for the vulnerability scanner functionality. \", [\"This section of the code is in charge of verifying whether or not a compressed database exists in a defined path to speed up the CVE local database availability.\", \"Initializes `Router` communication for sync, deltas, and wazuh-db events.\", \"Initializes the `DatabaseFeedManager` submodule and the Indexer Connector dependency module.\", \"Creates a dispatching thread to handle incoming events, delayed events, and vulnerability reports.\"], \"**`src/wazuh_modules/vulnerability_scanner/src/scanOrchestrator/`**\\nThis implementation uses the `Chain of Responsibility` design pattern to represent different stages for detection based on the event type.\", \"We can enumerate the following cases:\", [\"ScannerType::PackageInsert: The scanner receives an event of a new detected package in the system. \", \"ScannerType::PackageDelete: The scanner receives an event of a package deletion. The package was uninstalled from the system and should no longer be reported as vulnerable.\", \"ScannerType::HotfixInsert: Similar case of a package insert, but only for Windows. This specific event may solve an existent vulnerability.\", \"ScannerType::HotfixDelete: For this case, the deletion may trigger the detection of a vulnerability.\", \"ScannerType::Os: OS event that may trigger vulnerability detections for OS (for Windows and MacOS only).\", \"ScannerType::IntegrityClear: Remove all existent data for specified component (OS or packages).\", \"ScannerType::ReScanAllAgents: Triggered if the module is enabled after being disabled.\", \"ScannerType::ReScanSingleAgent: Triggers a rescan for a single agent if the agent database is upgraded.\", \"ScannerType::CleanupSingleAgentData: Clean action during the removal of an agent.\", \"ScannerType::CleanupAllAgentData: Clean action to remove all agent data.\", \"ScannerType::GlobalSyncInventory: Triggers a synchronization between the indexer local database and the information in the Wazuh Indexer.\"], \"**`src/wazuh_modules/vulnerability_scanner/src/databaseFeedManager/`**\\nSubmodule in charge of process the information downloaded from CTI. Between the responsibilities of this implementation we have: \", [\"Parse, process and create CTI information to create feed database.\", \"Parse CVE5 formatted information.\", \"Create CVSS, description, and other related tables to augment the vulnerability indexed information and alert reports.\", \"Parse and process mapping details and translation information for OS and packages.\", \"Parse and process offset information to keep the CVE database up to date.\"]], \"High-Level diagram\": \"```\\nflowchart TD\\n\\nsubgraph WazuhManager[\\\" \\\"]\\n Remoted[\\\"Remoted\\\"]\\n subgraph WazuhModulesM[\\\" \\\"]\\n subgraph VulnerabilityScanner[\\\" \\\"]\\n scanContext\\n end\\n D@{ shape: braces, label: \\\"Vulnerability Scanner\\\" } --> VulnerabilityScanner\\n IndexerConnector[\\\"Indexer Connector\\\"]\\n VulnerabilityScanner -- \\\"JSON Reflection\\\" --> IndexerConnector\\n end\\n C@{ shape: braces, label: \\\"Wazuh Modules\\\" } --> WazuhModulesM\\n Remoted -- \\\"Plain text JSON event\\\" --> Router\\n Router -- \\\"Flatbuffer event\\\" --> scanContext\\nend\\nB@{ shape: braces, label: \\\"Wazuh Manager\\\" } --> WazuhManager\\nIndexerConnector -- indexes JSON document --> WazuhIndexer\\nsubgraph WazuhAgent[\\\"Wazuh Agent\\\"]\\n subgraph Providers[\\\"Data Provider\\\"]\\n OS[\\\"Operating System\\\"]\\n Packages[\\\"Packages\\\"]\\n Hotfixes[\\\"Hotfixes\\\"]\\n end\\n subgraph WazuhModulesA[\\\" \\\"]\\n Syscollector[\\\"Syscollector\\\"]\\n end\\n A@{ shape: braces, label: \\\"Wazuh Modules\\\" } --> WazuhModulesA\\n Syscollector -- \\\"Plain text JSON event\\\" --> Remoted\\nend\\nProviders --> Syscollector\\nWazuhIndexer[\\\"Wazuh Indexer\\\"]\\nWazuhDashboard[\\\"Wazuh Dashboard\\\"]\\nWazuhDashboard -- /wazuh-states-vulnerabilities-*/_search --> WazuhIndexer\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 2]\"}, {\"title\": \"Configuration \", \"description\": null, \"content\": {\"Connection to Wazuh Indexer\": \"As mentioned above, the **Vulnerability Scanner** delegates the indexing to the Indexer Connector module. It receives OS and package events that will be processed against a local CVE database and hotfix information (only for Windows) to detect vulnerabilities that will be indexed through the indexer connector. \\n\\n['Default Indexer Connector configuration block']\\n\\n```\\n <indexer>\\n <enabled>yes</enabled>\\n <hosts>\\n <host>https://0.0.0.0:9200</host>\\n </hosts>\\n <ssl>\\n <certificate_authorities>\\n <ca>/etc/filebeat/certs/root-ca.pem</ca>\\n </certificate_authorities>\\n <certificate>/etc/filebeat/certs/filebeat.pem</certificate>\\n <key>/etc/filebeat/certs/filebeat-key.pem</key>\\n </ssl>\\n </indexer>\\n```\\n\\nIt is important to verify the green status of the Wazuh Indexer with a request to the **GET /_cluster/health** endpoint. \\n\\n['e.g. Response']\\n\\n```\\n{\\n \\\"cluster_name\\\": \\\"wazuh-cluster\\\",\\n \\\"status\\\": \\\"green\\\",\\n \\\"timed_out\\\": false,\\n \\\"number_of_nodes\\\": 1,\\n \\\"number_of_data_nodes\\\": 1,\\n \\\"discovered_master\\\": true,\\n \\\"discovered_cluster_manager\\\": true,\\n \\\"active_primary_shards\\\": 15,\\n \\\"active_shards\\\": 15,\\n \\\"relocating_shards\\\": 0,\\n \\\"initializing_shards\\\": 0,\\n \\\"unassigned_shards\\\": 0,\\n \\\"delayed_unassigned_shards\\\": 0,\\n \\\"number_of_pending_tasks\\\": 0,\\n \\\"number_of_in_flight_fetch\\\": 0,\\n \\\"task_max_waiting_in_queue_millis\\\": 0,\\n \\\"active_shards_percent_as_number\\\": 100\\n}\\n```\\n\\n**Currently, the module does not allow insecure connections, so it is important to verify carefully the indexer connector configuration**\\n\\nThe connection can be easily tested using the CURL command line with the right arguments. It is relevant to mention once again that the module does not support insecure connections, so using the **-k** option won't help to properly configure the **Indexer Connector** component. \\n\\n```\\ncurl --cacert <root_CA_path> --cert <cert_path> --key <key_path> https://<indexer-ip>:9200/_cluster/health\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 3]\"}, {\"title\": \"Events format \", \"description\": null, \"content\": {\"Syscollector event types\": \"The vulnerability scanner as an event-driven module, reacts to the Syscollector events sent by the agents. There are two types of events received by the scanner: synchronization and delta events. \\n\\n['Synchronization events are sent during the first scan of the Syscollector scan or if a delta event fails. ', 'Delta events are the ones sent from the second Syscollector scan. ']\\n\\nThese event types provide the same information to the scanner, the detection is not affected by the type of event sent, they are just parsed differently.\\n\\nWithin synchronization events, an **integrity_clear** event will remove the information for a certain provider. For the case of a package provider, it will remove all vulnerabilities related to packages, for OS will remove vulnerabilities related to OS, but also affect the detection for packages, since the source operating system is a required information for detection.\\nIn the case of hotfixes it should detect vulnerabilities fixed by the presence of those security patches. \", \"Hotfix events (Only Windows)\": {\"Delta event\": \"```\\n{\\n \\\"agent_info\\\": {\\n \\\"agent_id\\\": \\\"002\\\"\\n },\\n \\\"data_type\\\": \\\"dbsync_hotfixes\\\",\\n \\\"data\\\": {\\n \\\"checksum\\\": \\\"1691178971959743855\\\",\\n \\\"hotfix\\\": \\\"KB5034763\\\",\\n \\\"scan_time\\\": \\\"2023/08/04 19:56:11\\\"\\n },\\n \\\"operation\\\": \\\"INSERTED\\\"\\n}\\n```\", \"Synchronization event\": \"```\\n{\\n \\\"agent_info\\\": {\\n \\\"agent_id\\\": \\\"002\\\"\\n },\\n \\\"data_type\\\": \\\"state\\\",\\n \\\"data\\\": {\\n \\\"attributes_type\\\": \\\"syscollector_hotfixes\\\",\\n \\\"attributes\\\": {\\n \\\"checksum\\\": \\\"1691178971959743855\\\",\\n \\\"hotfix\\\": \\\"KB3114960\\\",\\n \\\"scan_time\\\": \\\"2023/08/04 19:56:11\\\"\\n }\\n }\\n}\\n```\\n\\n['Integrity clear event']\\n\\n```\\n{\\n \\\"agent_info\\\": {\\n \\\"agent_id\\\": \\\"002\\\"\\n },\\n \\\"data_type\\\": \\\"integrity_clear\\\",\\n \\\"data\\\": {\\n \\\"id\\\": 1700236640,\\n \\\"attributes_type\\\": \\\"syscollector_hotfixes\\\"\\n }\\n}\\n```\"}, \"Os events \": {\"Delta events \": [\"Debian \"], \"Synchronization events\": [\"Windows \"]}, \"Package events \": {\"Delta events \": [\"RPM package, vendor Amazon Linux \"], \"Synchronization events\": [\"Windows package\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 4]\"}, {\"title\": \"Flatbuffer schemas\", \"description\": null, \"content\": {\"Flatbuffer schemas\": {\"Common AgentInfo table\": [\"Common agent information for FIM Delta, Inventory Delta and Synchronization events.\"], \"Inventory Delta table\": [\"Main table in flatbuffer schema for inventory Delta events.\"], \"Inventory Provider union table\": [\"Provider union table for inventory delta events. (Vulnerability scanner only process osinfo, packages, and hotfixes events).\"], \"Inventory providers\": [\"Provider tables for inventory delta events.\"], \"SyncMsg table\": [\"Main table in flatbuffer schema for synchronization events.\"], \"DataUnion table union\": [\"DataUnion table union for synchronization events.\"], \"State table\": [\"State event type for synchronization events.\"], \"AttributesUnion table union\": [\"Different event component types for synchronization events.\"], \"Integrity clear table\": [\"Integrity clear event for synchronization events.\"]}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 5]\"}, {\"title\": \"Test tools\", \"description\": null, \"content\": {\"Compilation \": \"Command line test tools are intended for development purposes and they are not delivered in the Wazuh manager packages. To use them, it is required to compile the project by sources.\\n\\n```\\ncd wazuh/src\\nmake deps \\nmake -j$(nproc) TARGET=server\\n```\", \"Vulnerability Scanner tool \": {\"Database creation \": \"Command\\n\\n```\\nsrc/build/wazuh_modules/vulnerability_scanner/testtool/scanner/vd_scanner_testtool -c config.json -d\\n```\\n\\nConfiguration file\\n\\n```\\n{\\n \\\"vulnerability-detection\\\": {\\n \\\"enabled\\\": \\\"yes\\\",\\n \\\"index-status\\\": \\\"no\\\",\\n \\\"cti-url\\\": \\\"https://cti.wazuh.com/api/v1/catalog/contexts/vd_1.0.0/consumers/vd_4.8.0\\\"\\n },\\n \\\"clusterName\\\": \\\"cluster01\\\",\\n \\\"clusterEnabled\\\": false\\n}\\n```\\n\\n['The **-d** flag performs a snapshot download from CTI and processes the content to create a local CVE database.', 'In a real Wazuh Manager installation, **clusterName** is the hostname for a single node deployment, or the cluster name for a cluster setup.', 'The outcome of this command is a RocksDB CVE database **queue** in the current directory. ', 'The process will take some minutes until the snapshot file is processed.']\\n\\n**Note:** It's possible to follow the process with the logs printed by the tool. Optionally, with the **-l* argument,* the logs can be dumped to a file. \\n\\n```\\n...\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 180001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 181001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 182001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 183001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 184001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 185001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 186001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 187001\\n...\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:254 processMessage : Processing line: 292001\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:369 operator() : Feed update process completed.\\nOnly download content flag is set. Stopping the scanner...\\n```\\n\\n**Note:** Starting the vulnerability scanner tool without the **-d** option will update the CVE database with new data not present in the snapshot.\\n\\n```\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:355 operator() : Initiating update feed process.\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:188 processMessage : Processing file: queue/vd_updater/tmp/contents/1906695-api_file.json\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:188 processMessage : Processing file: queue/vd_updater/tmp/contents/1907695-api_file.json\\n...\\nwazuh-modulesd:vulnerability-scanner:databaseFeedManager.hpp:369 operator() : Feed update process completed.\\n```\", \"Detection \": \"For details about event format please refer to [Events](events.md)\\n\\nCommand\\n\\n```\\nsrc/build/wazuh_modules/vulnerability_scanner/testtool/scanner/vd_scanner_testtool -c config.json -u -i os.json,package.json\\n```\\n\\n['The command will detect vulnerabilities and fill the indexer databases. ']\\n\\n**Note:** It is possible to connect an instance of the Wazuh-Indexer and index the result of the vulnerability scan by adding the **Indexer Connector** configuration (more details [Configuration](configuration.md)).\\n\\n```\\nsrc/build/wazuh_modules/vulnerability_scanner/testtool/scanner/vd_scanner_testtool -c config.json -t index-template.json -u -i os_event.json,package_event.json\\n```\\n\\nExpanded configuration options for indexing\\n\\n```\\n{\\n \\\"vulnerability-detection\\\": {\\n \\\"enabled\\\": \\\"yes\\\",\\n \\\"index-status\\\": \\\"yes\\\",\\n \\\"cti-url\\\": \\\"https://cti.wazuh.com/api/v1/catalog/contexts/vd_1.0.0/consumers/vd_4.8.0\\\"\\n },\\n \\\"indexer\\\": {\\n \\\"enabled\\\": \\\"yes\\\",\\n \\\"hosts\\\": [\\n \\\"https://0.0.0.0:9200\\\"\\n ],\\n \\\"username\\\": \\\"admin\\\",\\n \\\"password\\\": \\\"admin\\\",\\n \\\"ssl\\\": {\\n \\\"certificate_authorities\\\": [\\n \\\"/PATH/root-ca.pem\\\"\\n ],\\n \\\"certificate\\\": \\\"/PATH/node-1.pem\\\",\\n \\\"key\\\": \\\"/PATH/node-1-key.pem\\\"\\n },\\n \\\"update_mappings_path\\\": \\\"\\\"\\n },\\n \\\"clusterName\\\": \\\"cluster01\\\",\\n \\\"clusterEnabled\\\": false\\n}\\n```\\n\\n**Note:** It is important to modify accordingly the following fields:\\n\\n['hosts', 'certificate ', 'key ', 'certificate_authorities ', 'username', 'password']\\n\\nAlso, a template is required to create the mapping in the Wazuh Indexer.\\n\\n<details><summary>Expand</summary>\\n\\n```\\n{\\n \\\"index_patterns\\\": [\\n \\\"wazuh-states-vulnerabilities-*\\\"\\n ],\\n \\\"priority\\\": 1,\\n \\\"template\\\": {\\n \\\"settings\\\": {\\n \\\"index\\\": {\\n \\\"codec\\\": \\\"best_compression\\\",\\n \\\"mapping\\\": {\\n \\\"total_fields\\\": {\\n \\\"limit\\\": 1000\\n }\\n },\\n \\\"number_of_replicas\\\": \\\"0\\\",\\n \\\"number_of_shards\\\": \\\"1\\\",\\n \\\"query.default_field\\\": [\\n \\\"agent.id\\\",\\n \\\"host.os.family\\\",\\n \\\"host.os.full\\\",\\n \\\"host.os.version\\\",\\n \\\"package.name\\\",\\n \\\"package.version\\\",\\n \\\"vulnerability.id\\\",\\n \\\"vulnerability.description\\\",\\n \\\"vulnerability.severity\\\",\\n \\\"wazuh.cluster.name\\\"\\n ],\\n \\\"refresh_interval\\\": \\\"2s\\\"\\n }\\n },\\n \\\"mappings\\\": {\\n \\\"date_detection\\\": false,\\n \\\"dynamic\\\": \\\"strict\\\",\\n \\\"properties\\\": {\\n \\\"agent\\\": {\\n \\\"properties\\\": {\\n \\\"build\\\": {\\n \\\"properties\\\": {\\n \\\"original\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"ephemeral_id\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"id\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"name\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"type\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"host\\\": {\\n \\\"properties\\\": {\\n \\\"os\\\": {\\n \\\"properties\\\": {\\n \\\"full\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"kernel\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"name\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"platform\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"type\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n }\\n }\\n },\\n \\\"package\\\": {\\n \\\"properties\\\": {\\n \\\"architecture\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"build_version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"checksum\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"description\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"install_scope\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"installed\\\": {\\n \\\"type\\\": \\\"date\\\"\\n },\\n \\\"license\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"name\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"path\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"reference\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"size\\\": {\\n \\\"type\\\": \\\"long\\\"\\n },\\n \\\"type\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"vulnerability\\\": {\\n \\\"properties\\\": {\\n \\\"category\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"classification\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"description\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"detected_at\\\": {\\n \\\"type\\\": \\\"date\\\"\\n },\\n \\\"enumeration\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"id\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"published_at\\\": {\\n \\\"type\\\": \\\"date\\\"\\n },\\n \\\"reference\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"report_id\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"scanner\\\": {\\n \\\"properties\\\": {\\n \\\"vendor\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"source\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"score\\\": {\\n \\\"properties\\\": {\\n \\\"base\\\": {\\n \\\"type\\\": \\\"float\\\"\\n },\\n \\\"environmental\\\": {\\n \\\"type\\\": \\\"float\\\"\\n },\\n \\\"temporal\\\": {\\n \\\"type\\\": \\\"float\\\"\\n },\\n \\\"version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"severity\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"under_evaluation\\\": {\\n \\\"type\\\": \\\"boolean\\\"\\n }\\n }\\n },\\n \\\"wazuh\\\": {\\n \\\"properties\\\": {\\n \\\"cluster\\\": {\\n \\\"properties\\\": {\\n \\\"name\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n },\\n \\\"node\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n },\\n \\\"schema\\\": {\\n \\\"properties\\\": {\\n \\\"version\\\": {\\n \\\"ignore_above\\\": 1024,\\n \\\"type\\\": \\\"keyword\\\"\\n }\\n }\\n }\\n }\\n }\\n }\\n }\\n }\\n}\\n```\\n\\n</details>\\n\\nAdditional logs will be printed related to the vulnerabilities indexed.\\n\\n```\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28835.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28834.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28835.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28834.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28835.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28834.\\nindexer-connector:indexerConnector.cpp:606 operator() : Added document for insertion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243.\\n```\\n\\n**Note**: To request the information please refer to the [Opensearch API](api-reference.md)\\n\\n**Note**: The **-u** option disables the **Content Updater** module, so it won't process any snapshots or offsets, and it will directly process incoming events looking for vulnerabilities.\\n\\n**Note**: A package event needs an OS event; if we send a package event without the OS event, the tool may hang even if we later use the right command with the OS event. To overcome this, remove the **queue/vd/event** or use the **-b** option explained below.\", \"Mocking Wazuh-DB information\": \"As previously mentioned, the scanner requires OS and hotfixes information for detection. That could be mocked using the options **-h** for hotfixes and **-b** for OS. \\n\\nExample mocked hotfix data\\n\\n```\\n{\\n \\\"001\\\": [\\n { \\\"hotfix\\\":\\\"KB2468871\\\" },\\n { \\\"hotfix\\\":\\\"KB2478063\\\" },\\n { \\\"hotfix\\\":\\\"KB2533523\\\" },\\n { \\\"hotfix\\\":\\\"KB2544514\\\" },\\n { \\\"hotfix\\\":\\\"KB2600211\\\" },\\n { \\\"hotfix\\\":\\\"KB2600217\\\" },\\n { \\\"hotfix\\\":\\\"KB4502496\\\" },\\n { \\\"hotfix\\\":\\\"KB4512577\\\" },\\n { \\\"hotfix\\\":\\\"KB4512578\\\" },\\n { \\\"hotfix\\\":\\\"KB4514366\\\" },\\n { \\\"hotfix\\\":\\\"KB4535680\\\" },\\n { \\\"hotfix\\\":\\\"KB4535684\\\" },\\n { \\\"hotfix\\\":\\\"KB4535685\\\" },\\n { \\\"hotfix\\\":\\\"KB4577586\\\" },\\n { \\\"hotfix\\\":\\\"KB4580325\\\" },\\n { \\\"hotfix\\\":\\\"KB4589208\\\" },\\n { \\\"hotfix\\\":\\\"KB4601558\\\" },\\n { \\\"hotfix\\\":\\\"KB5003171\\\" },\\n { \\\"hotfix\\\":\\\"KB5003243\\\" },\\n { \\\"hotfix\\\":\\\"KB5034619\\\" },\\n { \\\"hotfix\\\":\\\"KB5034768\\\" },\\n { \\\"hotfix\\\":\\\"KB5034863\\\" },\\n { \\\"hotfix\\\":\\\"KB5012649\\\"}\\n ]\\n}\\n```\\n\\nExample mocked OS data for Ubuntu\\n\\n```\\n{\\n \\\"001\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"checksum\\\": \\\"1704514361693635656\\\",\\n \\\"hostname\\\": \\\"ubuntu-jammy\\\",\\n \\\"os_codename\\\": \\\"jammy\\\",\\n \\\"os_major\\\": \\\"22\\\",\\n \\\"os_minor\\\": \\\"04\\\",\\n \\\"os_name\\\": \\\"Ubuntu\\\",\\n \\\"os_patch\\\": \\\"3\\\",\\n \\\"os_platform\\\": \\\"ubuntu\\\",\\n \\\"os_version\\\": \\\"22.04.3 LTS (Jammy Jellyfish)\\\",\\n \\\"reference\\\": \\\"f22553c945b045bfc0d162cb890344d2f4fa8609\\\",\\n \\\"release\\\": \\\"5.15.0-91-generic\\\",\\n \\\"scan_id\\\": 0,\\n \\\"scan_time\\\": \\\"2024/01/06 04:12:44\\\",\\n \\\"sysname\\\": \\\"Linux\\\",\\n \\\"version\\\": \\\"#101-Ubuntu SMP Tue Nov 14 13:30:08 UTC 2023\\\"\\n }\\n}\\n```\\n\\nUsage\\n\\n```\\nsrc/build/wazuh_modules/vulnerability_scanner/testtool/scanner/vd_scanner_testtool -c config2.json -t index-template.json -u -i package_event.json -b os_wdb.json\\n```\\n\\n**Note:** More details about required fields [Events](events.md).\"}, \"RocksDB tool \": {\"Inspect databases \": {\"Indexer databases \": \"Commands\\n\\n```\\nrocksDBQuery/rocks_db_query_testtool -d queue/indexer/db/wazuh-states-vulnerabilities-<hostname>\\nrocksDBQuery/rocks_db_query_testtool -d queue/indexer/wazuh-states-vulnerabilities-<hostname>\\n```\\n\\nExample output\\n\\n```\\n001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243 ==> \\n{\\n \\\"agent\\\": {\\n \\\"id\\\": \\\"001\\\",\\n \\\"type\\\": \\\"Wazuh\\\",\\n \\\"version\\\": \\\"v4.10.1\\\"\\n },\\n \\\"host\\\": {\\n \\\"os\\\": {\\n \\\"full\\\": \\\"CentOS Stream 9\\\",\\n \\\"kernel\\\": \\\"5.14.0-391.el9.x86_64\\\",\\n \\\"name\\\": \\\"CentOS Stream\\\",\\n \\\"platform\\\": \\\"centos\\\",\\n \\\"type\\\": \\\"centos\\\",\\n \\\"version\\\": \\\"9\\\"\\n }\\n },\\n \\\"package\\\": {\\n \\\"architecture\\\": \\\"x86_64\\\",\\n \\\"name\\\": \\\"gnutls\\\",\\n \\\"size\\\": 0,\\n \\\"type\\\": \\\"rpm\\\",\\n \\\"version\\\": \\\"3.8.2-1.el9\\\"\\n },\\n \\\"vulnerability\\\": {\\n \\\"category\\\": \\\"Packages\\\",\\n \\\"classification\\\": \\\"-\\\",\\n \\\"description\\\": \\\"DOCUMENTATION: A flaw was found in GnuTLS, which relies on libtasn1 for ASN.1 data processing. Due to an inefficient algorithm in libtasn1, decoding certain DER-encoded certificate data can take excessive time, leading to increased resource consumption. This flaw allows a remote attacker to send a specially crafted certificate, causing GnuTLS to become unresponsive or slow, resulting in a denial-of-service condition.\\\",\\n \\\"detected_at\\\": \\\"2025-04-25T18:49:27.929Z\\\",\\n \\\"enumeration\\\": \\\"CVE\\\",\\n \\\"id\\\": \\\"CVE-2024-12243\\\",\\n \\\"published_at\\\": \\\"2025-02-10T16:15:37Z\\\",\\n \\\"reference\\\": \\\"https://access.redhat.com/security/cve/CVE-2024-12243\\\",\\n \\\"scanner\\\": {\\n \\\"source\\\": \\\"Red Hat CVE Database\\\",\\n \\\"vendor\\\": \\\"Wazuh\\\"\\n },\\n \\\"score\\\": {\\n \\\"base\\\": 5.3,\\n \\\"version\\\": \\\"3.1\\\"\\n },\\n \\\"severity\\\": \\\"Medium\\\",\\n \\\"under_evaluation\\\": false\\n },\\n \\\"wazuh\\\": {\\n \\\"cluster\\\": {\\n \\\"name\\\": \\\"cluster01\\\"\\n },\\n \\\"schema\\\": {\\n \\\"version\\\": \\\"1.0.0\\\"\\n }\\n }\\n}\\n```\", \"Inventory database\": \"Command \\n\\n```\\nrocksDBQuery/rocks_db_query_testtool -d queue/inventory\\n```\\n\\nExample output\\n\\n```\\n001_f21aca719022f009d80bbf9224741d79029b31f2 ==> CVE-2024-28835,CVE-2024-28834,CVE-2024-12243\\n```\"}, \"Remove indexed vulnerability and clean databases\": {\"Output examples \": \"Clean all agents\\n\\n```\\nwazuh-modulesd:vulnerability-scanner:scanOrchestrator.hpp:319 run : Clean-up all data event received. Cleaning up data for all agents\\nwazuh-modulesd:vulnerability-scanner:resultIndexer.hpp:60 handleRequest : Processing and publish key: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28835\\nwazuh-modulesd:vulnerability-scanner:resultIndexer.hpp:60 handleRequest : Processing and publish key: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28834\\nwazuh-modulesd:vulnerability-scanner:resultIndexer.hpp:60 handleRequest : Processing and publish key: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243\\nwazuh-modulesd:vulnerability-scanner:cleanInventory.hpp:89 operator() : Deleting all entries for key prefix: 001_f21aca719022f009d80bbf9224741d79029b31f2\\nwazuh-modulesd:vulnerability-scanner:scanOrchestrator.hpp:339 run : Event type: 9 processed\\nindexer-connector:indexerConnector.cpp:584 operator() : Added document for deletion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28835.\\nindexer-connector:indexerConnector.cpp:584 operator() : Added document for deletion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-28834.\\nindexer-connector:indexerConnector.cpp:584 operator() : Added document for deletion with id: 001_f21aca719022f009d80bbf9224741d79029b31f2_CVE-2024-12243.\\n```\\n\\nClean single agent\\n\\n```\\nwazuh-modulesd:vulnerability-scanner:scanOrchestrator.hpp:324 run : Processing 'CleanupSingleAgentData' event for agent '001'\\nwazuh-modulesd:vulnerability-scanner:cleanAgentInventory.hpp:81 operator() : Deleting package agent vulnerabilities key: 001_f21aca719022f009d80bbf9224741d79029b31f2\\nwazuh-modulesd:vulnerability-scanner:resultIndexer.hpp:60 handleRequest : Processing and publish key: DeleteByQuery request\\n```\"}}, \"`databaseFeedManager` Tool\": {\"Inject CVEs into the Vulnerability Scanner Database\": {\"Output example\": \"```\\nError deleting directory ./queue/vd #Ignore this\\nReplacing information for CVE: CVE-1999-0103\\nProcess complete for CVE: CVE-1999-0103\\nReplacing information for CVE: CVE-2023-36617\\nProcess complete for CVE: CVE-2023-36617\\nPress enter to stop the tool...\\n```\"}}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4, \\\"subpages\\\", 6]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12, \\\"subpages\\\", 4]\"}], \"path\": \"[\\\"subpages\\\", 2, \\\"subpages\\\", 12]\"}], \"path\": \"[\\\"subpages\\\", 2]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Distributed Security Information and Event Management (SIEM) Platform\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Event Processing Engine\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Core Event Processing Pipeline Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Stage Data Flow Pipeline\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Initial Event Ingestion and Filtering (Check/Allow Stage): Policy-based routing and conditional logic to accept, discard, or direct events through user-defined directed acyclic graphs\", \"weight\": 3}, {\"requirements\": \"Data Parsing and Structuring (Parse Stage): Schema-driven parsing that deconstructs raw logs into canonical JSON with strict validation using type-specific parsers (IP, Date, Long, Text, Boolean, Binary, etc.)\", \"weight\": 3}, {\"requirements\": \"Data Mapping and Transformation (Map Stage): Field modification, restructuring, and token processing with sandboxed helper functions\", \"weight\": 2}, {\"requirements\": \"Data Enrichment and Normalization (Normalize/Enrichment Stage): Context augmentation with geolocation, threat intelligence, and KVDB lookups for security enrichment\", \"weight\": 3}, {\"requirements\": \"Final Processing and Output Routing (Output Stage): Deterministic destination routing for archiving, alerting, and indexer delivery\", \"weight\": 3}]}, {\"requirements\": \"Modular Backend Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Server Module: Core processing engine that handles incoming data streams and connections\", \"weight\": 3}, {\"requirements\": \"Orchestrator Module: Workflow coordination and overall data processing flow management\", \"weight\": 3}, {\"requirements\": \"Backend and Persistent Storage Modules: Data storage, retrieval interfaces, and global state management\", \"weight\": 2}, {\"requirements\": \"Specialized Data Modules: Geolocation enrichment (Geo) and Key-Value Database (KVDB) operations for in-memory lookups\", \"weight\": 2}, {\"requirements\": \"API Module: Management interface and integration capabilities for external systems\", \"weight\": 2}, {\"requirements\": \"Dynamic Asset Builder: Runtime asset compilation and deployment capabilities\", \"weight\": 2}]}]}, {\"requirements\": \"Configurable Asset Management System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Asset Catalog and Namespace Organization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Versioned Asset Registry: Content-addressable storage for decoders, rules, filters, and outputs with version control\", \"weight\": 3}, {\"requirements\": \"Multi-tenant Namespace Isolation: Isolated asset sets and runtime policies for different organizational units\", \"weight\": 2}]}, {\"requirements\": \"Asset Type Classification and Processing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Decoders: Schema-aware parsing definitions for extracting fields from unstructured log messages with expression-based logic\", \"weight\": 3}, {\"requirements\": \"Rules: Event evaluation logic with condition assessment, severity assignment, and alert triggering capabilities\", \"weight\": 3}, {\"requirements\": \"Filters: Event flow control mechanisms based on specific criteria and conditions\", \"weight\": 2}, {\"requirements\": \"Outputs: Pluggable output sinks defining serialization and delivery to files, indexers, or external search clusters\", \"weight\": 2}]}, {\"requirements\": \"Helper Function Ecosystem\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Condition Evaluation Helpers: Logic assessment and boolean operations for rule processing\", \"weight\": 2}, {\"requirements\": \"Data Mapping and Transformation Helpers: Field manipulation, format conversion, and data restructuring functions\", \"weight\": 2}, {\"requirements\": \"Parsing Rule Definitions: Expression-based parsing logic with prefixes, suffixes, and locale awareness\", \"weight\": 2}]}]}]}, {\"requirements\": \"System Monitoring and Inventory Management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Inventory Harvester Module\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Source Data Collection Architecture\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"File Integrity Monitoring (FIM): File system and Windows registry change detection with attribute and metadata tracking\", \"weight\": 3}, {\"requirements\": \"System Inventory Collection: Comprehensive gathering of system information, packages, processes, ports, hardware, network interfaces, users, groups, and hotfixes\", \"weight\": 3}, {\"requirements\": \"Delta Computation and State Reconciliation: Periodic snapshots with minimal update message generation against previous states\", \"weight\": 2}]}, {\"requirements\": \"Data Processing and Integration\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Wazuh Indexer Connectivity: Bulk indexing and searchable current-state indices maintenance\", \"weight\": 3}, {\"requirements\": \"Configurable Data Filtering: Selective data forwarding and filtering based on collection policies\", \"weight\": 2}]}]}]}, {\"requirements\": \"Automated Vulnerability Detection and Assessment\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Stateless Vulnerability Scanner Module\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Platform Vulnerability Detection\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"CVE Feed Management: RocksDB-backed vulnerability database with incremental updates from external sources (Ubuntu/Debian, CentOS/RHEL, Windows)\", \"weight\": 3}, {\"requirements\": \"Real-time Vulnerability Correlation: Event-driven processing that correlates endpoint inventory data (OS, packages, hotfixes) against vulnerability databases\", \"weight\": 3}, {\"requirements\": \"Syscollector Event Processing: Delta and synchronization event handling for OS, package, and hotfix correlation\", \"weight\": 2}]}, {\"requirements\": \"Internal Data Management and Architecture\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Local RocksDB Management: Vulnerability feed data and agent inventory state management for efficient scanning\", \"weight\": 2}, {\"requirements\": \"Indexer Integration: Connection to Wazuh Indexer for agent data retrieval and vulnerability finding reporting\", \"weight\": 2}]}]}]}, {\"requirements\": \"Data Serialization and Communication Infrastructure\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"FlatBuffers Schema System\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Agent Communication Protocol\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Agent Information Serialization: Compact, versioned message formats for agent metadata and status\", \"weight\": 2}, {\"requirements\": \"SyncMsg Protocol: Full state and incremental delta transfer support for efficient communication\", \"weight\": 3}]}, {\"requirements\": \"Data Structure Definitions\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"FIM Data Serialization: File and registry delta serialization with attribute and metadata encoding\", \"weight\": 2}, {\"requirements\": \"Inventory Data Serialization: Provider union type system and synchronization message formatting for system inventory\", \"weight\": 2}, {\"requirements\": \"Zero-Copy Serialization: High-performance, zero-copy data exchange between components ensuring interoperability\", \"weight\": 2}]}]}]}, {\"requirements\": \"System Lifecycle and Operations Management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Installation and Deployment Framework\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Multi-Platform Distribution: Package-based distribution system with system requirements validation and compatibility layer\", \"weight\": 2}, {\"requirements\": \"Configuration Management: Schema-driven configuration validation with runtime implications handling and centralized configuration files\", \"weight\": 2}]}, {\"requirements\": \"Maintenance and Operations Support\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Data Persistence and Recovery: Backup and restore functionality for configuration and data with structured upgrade procedures\", \"weight\": 2}, {\"requirements\": \"Performance and Security Optimization: Monitoring, tuning capabilities, security hardening, and access control mechanisms\", \"weight\": 2}, {\"requirements\": \"Clean System Management: Structured uninstallation procedures and system cleanup capabilities\", \"weight\": 1}]}]}, {\"requirements\": \"Development and Testing Infrastructure\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Engine Development Toolkit\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"CLI Development Suite: Engine-suite CLI for compiling, testing, and validating assets offline with API communication testing tools\", \"weight\": 1}, {\"requirements\": \"Specialized Testing Framework: Health checks, integration tests, and helper function testing utilities\", \"weight\": 1}]}, {\"requirements\": \"Vulnerability Scanner Testing Framework\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Database Management Tools: CVE database creation, injection, feed management, and RocksDB inspection utilities\", \"weight\": 1}, {\"requirements\": \"Detection Testing Capabilities: Mocking capabilities and detection testing for vulnerability assessment validation\", \"weight\": 1}]}, {\"requirements\": \"Debugging and Observability Framework\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Live Debugging Capabilities: Trace-based debugging with severity and executable filtering for pipeline execution analysis\", \"weight\": 1}, {\"requirements\": \"End-to-End Validation: Health and integration test harnesses for correctness validation across the entire system\", \"weight\": 1}]}]}]}]}"}}},{"rowIdx":21,"cells":{"repo_name":{"kind":"string","value":"x64dbg"},"repo_url":{"kind":"string","value":"https://github.com/x64dbg/x64dbg"},"commit_id":{"kind":"string","value":"134e7ebb26523757ca9042f2a0925024751f42c7"},"docs_tree":{"kind":"string","value":"{\"title\": \"x64dbg\", \"description\": \"Documentation for x64dbg\", \"subpages\": [{\"title\": \"Compile Linux\", \"path\": \"[\\\"subpages\\\", 0]\", \"content\": {\"Prerequisites\": \"<detail_content>\", \"Install MSVC\": \"<detail_content>\", \"Build\": \"<detail_content>\", \"Issues\": \"<detail_content>\"}}, {\"title\": \"docs\", \"path\": \"[\\\"subpages\\\", 1]\", \"content\": {\"Building\": \"<detail_content>\"}}, {\"title\": \"Licenses\", \"path\": \"[\\\"subpages\\\", 2]\", \"content\": {\"Licenses\": \"<detail_content>\"}}, {\"title\": \"Commands\", \"description\": \"Documentation section: commands\", \"path\": \"[\\\"subpages\\\", 3]\", \"subpages\": [{\"title\": \"Analysis\", \"description\": \"Documentation section: analysis\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"GetRelocSize/grs\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"analadv\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"analrecur/analr\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"analxrefs/analx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"analyse/analyze/anal\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"analyse_nukem/analyze_nukem/anal_nukem\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"cfanalyze/cfanalyse/cfanal\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"exanalyse/exanalyze/exanal\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"Exhandlers\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"Exinfo\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\", \"content\": {\"exinfo\": \"<detail_content>\"}}, {\"title\": \"imageinfo\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"symdownload/downloadsym\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"symload/loadsym\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"symunload/unloadsym\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"traceexecute\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"virtualmod\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Breakpoint Control\", \"description\": \"Documentation section: breakpoint-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"DeleteBPX/bpc/bc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Deleteexceptionbpx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DeleteHardwareBreakpoint/bphc/bphwc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DeleteMemoryBPX/membpc/bpmc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DisableBPX/bpd/bd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Disableexceptionbpx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DisableHardwareBreakpoint/bphd/bphwd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DisableMemoryBreakpoint/membpd/bpmd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"EnableBPX/bpe/be\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"EnableExceptionBPX\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"EnableHardwareBreakpoint/bphe/bphwe\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"EnableMemoryBreakpoint/membpe/bpme\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Librariandisablebreakpoint\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"LibrarianEnableBreakpoint/bpedll\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"LibrarianRemoveBreakpoint/bcdll\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"LibrarianSetBreakpoint/bpdll\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Setbpx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBPXOptions/bptype\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Setexceptionbpx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpoint/bph/bphws\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBPX/membp/bpm\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryRangeBPX/memrangebp/bpmrange\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 21]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"bpgoto\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 22]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"bplist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 23]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Conditional Breakpoint Control\", \"description\": \"Documentation section: conditional-breakpoint-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"GetBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"GetExceptionBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"GetHardwareBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"GetLibrarianBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"GetMemoryBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ResetBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ResetExceptionBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ResetHardwareBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ResetLibrarianBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ResetMemoryBreakpointHitCount\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointCommandCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointCondition/bpcond/bpcnd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointFastResume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointLog/bplog/bpl\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointLogCondition/bplogcondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointName/bpname\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointSilent\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetBreakpointSingleshoot\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointCommandCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 21]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointFastResume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 22]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointLog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 23]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointLogCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 24]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointName\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 25]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointSilent\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 26]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetExceptionBreakpointSingleshoot\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 27]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 28]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointCommandCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 29]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointCondition/bphwcond\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 30]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointFastResume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 31]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointLog/bphwlog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 32]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointLogCondition/bphwlogcondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 33]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointName/bphwname\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 34]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointSilent\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 35]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetHardwareBreakpointSingleshoot\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 36]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 37]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointCommandCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 38]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 39]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointFastResume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 40]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointLog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 41]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointLogCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 42]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointName\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 43]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointSilent\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 44]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetLibrarianBreakpointSingleshoot\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 45]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 46]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointCommandCondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 47]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointCondition/bpmcond\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 48]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointFastResume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 49]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointLog/bpmlog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 50]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointLogCondition/bpmlogcondition\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 51]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointName/bpmname\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 52]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointSilent\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 53]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetMemoryBreakpointSingleshoot\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 54]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Debug Control\", \"description\": \"Documentation section: debug-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\", \"subpages\": [{\"title\": \"AttachDebugger/attach\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DebugContinue/con\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DetachDebugger/detach\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"InitDebug/initdbg/init\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"InstrUndo\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"StepInto/sti\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"StepOut/rtr\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"StepOver/step/sto/st\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"StepSystem/StepSystemInto\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"StepUser/StepUserInto\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"StopDebug/stop/dbgstop\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"eStepInto/esti\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"eStepOut/ertr\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"eStepOver/estep/esto/est\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"erun/ego/er/eg\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"pause\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"run/go/r/g\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"seStepInto/sesti\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"seStepOver/sestep/sesto/sest\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"serun/sego\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"skip\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"General Purpose\", \"description\": \"Documentation section: general-purpose\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"add\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"and\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"bswap\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"cmp\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"Dec\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"div\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"inc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"kmovd/kmovq\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"lzcnt\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"mov/set\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"movdqu/movups/movupd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"mul\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"mulhi\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"neg\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"not\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"or\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"pop\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"popcnt\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"push\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"rol\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ror\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"sar\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 21]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"shl/sal\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 22]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"shr\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 23]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"sub\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 24]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"test\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 25]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"vmovdqu/vmovups/vmovupd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 26]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"xor\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 27]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"AddFavouriteCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"AddFavouriteTool\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"AddFavouriteToolShortcut/SetFavouriteToolShortcut\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"ClearLog/cls/lc/lclr\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DisableLog/LogDisable\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"EnableLog/LogEnable\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"FoldDisassembly\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"disasm/dis/d\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"dump\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"graph\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"guiupdatedisable\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"guiupdateenable\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"memmapdump\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"refadd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"refget\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"refinit\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"sdump\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setfreezestack\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Memory Operations\", \"description\": \"Documentation section: memory-operations\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\", \"subpages\": [{\"title\": \"Fill/memset\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"alloc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"free\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"getpagerights/getpagerights/getrightspage\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"memcpy\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"minidump\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"savedata\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"setpagerights/setpagerights/setrightspage\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Misc\", \"description\": \"Documentation section: misc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\", \"subpages\": [{\"title\": \"HideDebugger/dbh/hide\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"asm\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"chd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"config\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"getcommandline/getcmdline\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"getjit/jitget\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"getjitauto/jitgetauto\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"gpa\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"loadlib\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"mnemonicbrief\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"mnemonichelp\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setcommandline/setcmdline\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setjit/jitset\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setjitauto/jitsetauto\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"zzz/doSleep\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Operating System Control\", \"description\": \"Documentation section: operating-system-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\", \"subpages\": [{\"title\": \"DisablePrivilege\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"EnablePrivilege\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"GetPrivilegeState\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"handleclose/closehandle\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}]}, {\"title\": \"Plugins\", \"description\": \"Documentation section: plugins\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\", \"subpages\": [{\"title\": \"StartScylla/scylla/imprec\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"plugload/pluginload/loadplugin\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"plugunload/pluginunload/unloadplugin\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Script\", \"description\": \"Documentation section: script\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10]\", \"subpages\": [{\"title\": \"Jxx\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 0]\", \"content\": {\"root\": \"<detail_content>\"}}, {\"title\": \"call\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"error\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"invalid\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"msg\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"msgyn\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"pause\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"printstack[,logstack]\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ret\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"scriptcmd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"execution behavior\": \"<detail_content>\", \"example\": \"<detail_content>\"}}, {\"title\": \"scriptdll/dllscript\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"scriptexec\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"execution behavior\": \"<detail_content>\", \"notes\": \"<detail_content>\"}}, {\"title\": \"scriptload\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"scriptrun\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"execution behavior\": \"<detail_content>\", \"prerequisites\": \"<detail_content>\", \"notes\": \"<detail_content>\"}}]}, {\"title\": \"Searching\", \"description\": \"Documentation section: searching\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11]\", \"subpages\": [{\"title\": \"find\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"findall\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"examples\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"findallmem/findmemall\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"findasm/asmfind\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"findguid/guidfind\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"modcallfind\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"reffind/findref/ref\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"reffindrange/findrefrange/refrange\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"refstr/strref\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"setmaxfindresult/findsetmaxresult\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}]}, {\"title\": \"Thread Control\", \"description\": \"Documentation section: thread-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12]\", \"subpages\": [{\"title\": \"createthread[,threadcreate,newthread,threadnew]\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"killthread/threadkill\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"resumeallthreads/threadresumeall\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"resumethread/threadresume\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setthreadname/threadsetname\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"setthreadpriority/setprioritythread/threadsetpriority\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"suspendallthreads/threadsuspendall\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"suspendthread/threadsuspend\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"switchthread/threadswitch\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Tracing\", \"description\": \"Documentation section: tracing\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13]\", \"subpages\": [{\"title\": \"RunToParty\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\", \"see also\": \"<detail_content>\"}}, {\"title\": \"RunToUserCode/rtu\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"StartTraceRecording/StartRunTrace/opentrace\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"StopTraceRecording/StopRunTrace/tc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"TraceIntoBeyondTraceCoverage/TraceIntoBeyondTraceRecord/tibt\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"TraceIntoConditional/ticnd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"TraceIntoIntoTraceCoverage/TraceIntoIntoTraceRecord/tiit\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"TraceOverBeyondTraceCoverage,TraceOverBeyondTraceRecord/tobt\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"TraceOverConditional/tocnd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"TraceOverIntoTraceCoverage/TraceOverIntoTraceRecord/toit\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"TraceSetCommand/SetTraceCommand\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"TraceSetLog/SetTraceLog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"TraceSetLogFile/SetTraceLogFile\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}]}, {\"title\": \"Types\", \"description\": \"Documentation section: types\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14]\", \"subpages\": [{\"title\": \"AddArg\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AddFunction\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AddMember\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AddStruct\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AddType\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AddUnion\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AppendArg\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"AppendMember\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ClearTypes\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataAscii/da\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataByte/db\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataCode/dc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataDouble/DataReal8\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataDword/dw\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataFloat/DataReal4/df\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataFword\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataJunk\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataLongdouble/DataReal10\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataMiddle\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataMmword\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataOword\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataQword/dq\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 21]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataTbyte\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 22]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataUnicode/du\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 23]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataUnknown\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 24]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataWord/dw\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 25]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataXmmword\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 26]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"DataYmmword\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 27]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"EnumTypes\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 28]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"LoadTypes\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 29]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"ParseTypes\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 30]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"RemoveType\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 31]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SizeofType\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 32]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"VisitType/DisplayType/dt\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 33]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"User Database\", \"description\": \"Documentation section: user-database\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15]\", \"subpages\": [{\"title\": \"argumentadd\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"argumentclear\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"argumentdel\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"argumentlist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"bookmarkclear\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"bookmarkdel/bookmarkc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"bookmarklist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 6]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"bookmarkset/bookmark\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 7]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"commentclear\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 8]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"commentdel/cmtc/cmtdel\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 9]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"commentlist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 10]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"commentset/cmt/cmtset\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 11]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"dbclear/cleardb\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 12]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"dbload/loaddb\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 13]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"dbsave/savedb\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 14]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"functionadd/func\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 15]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"functionclear\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 16]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"functiondel/funcc\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 17]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"functionlist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 18]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"labelclear\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 19]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"labeldel/lblc/lbldel\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 20]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"labellist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 21]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\", \"remarks\": \"<detail_content>\"}}, {\"title\": \"labelset/lbl/lblset\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 22]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Variables\", \"description\": \"Documentation section: variables\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16]\", \"subpages\": [{\"title\": \"var/varnew\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"vardel\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"varlist\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}]}, {\"title\": \"Watch Control\", \"description\": \"Documentation section: watch-control\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17]\", \"subpages\": [{\"title\": \"AddWatch\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 0]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"CheckWatchdog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 1]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"DelWatch\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 2]\", \"content\": {\"arguments\": \"<detail_content>\", \"result\": \"<detail_content>\"}}, {\"title\": \"SetWatchExpression\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 3]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"SetWatchName\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 4]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}, {\"title\": \"SetWatchdog\", \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 5]\", \"content\": {\"arguments\": \"<detail_content>\", \"results\": \"<detail_content>\"}}]}]}, {\"title\": \"Developers\", \"description\": \"Documentation section: developers\", \"path\": \"[\\\"subpages\\\", 4]\", \"subpages\": [{\"title\": \"x64dbg trace file format specification\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\", \"content\": {\"Magic word\": \"<detail_content>\", \"Header\": \"<detail_content>\", \"Binary trace blocks\": \"<detail_content>\"}}, {\"title\": \"Functions\", \"description\": \"Documentation section: functions\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"Bridge\", \"description\": \"Documentation section: bridge\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"BridgeAlloc\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeFree\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeGetDbgVersion\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeInit\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingFlush\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingGetUint\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingRead\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingSet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeSettingSetUint\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"BridgeStart\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}]}, {\"title\": \"Debug\", \"description\": \"Documentation section: debug\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"DbgArgumentAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgArgumentDel\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgArgumentGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgArgumentOverlaps\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgAssembleAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearAutoBookmarkRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearAutoCommentRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearAutoFunctionRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 7]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearAutoLabelRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 8]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearBookmarkRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 9]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearCommentRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 10]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgClearLabelRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 11]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgCmdExec\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 12]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgCmdExecDirect\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 13]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgDelEncodeTypeRange\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 14]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgDelEncodeTypeSegment\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 15]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgDisasmAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 16]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgDisasmFastAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 17]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgExit\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 18]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgFunctionAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 19]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgFunctionDel\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 20]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgFunctionGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 21]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgFunctionOverlaps\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 22]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgFunctions\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 23]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetArgTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 24]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetBookmarkAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 25]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetBpList\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 26]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetBpxTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 27]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetBranchDestination\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 28]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetCommentAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 29]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetEncodeSizeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 30]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetEncodeTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 31]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetEncodeTypeBuffer\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 32]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetFunctionTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 33]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetLabelAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 34]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetLoopTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 35]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetModuleAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 36]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetRegDump\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 37]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetStringAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 38]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetThreadList\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 39]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetTimeWastedCounter\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 40]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetWatchList\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 41]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetXrefCountAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 42]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgGetXrefTypeAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 43]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgInit\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 44]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsBpDisabled\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 45]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsDebugging\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 46]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsJumpGoingToExecute\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 47]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsRunLocked\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 48]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsRunning\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 49]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgIsValidExpression\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 50]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgLoopAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 51]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgLoopDel\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 52]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgLoopGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 53]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgLoopOverlaps\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 54]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemFindBaseAddr\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 55]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemGetPageSize\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 56]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemIsValidReadPtr\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 57]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemMap\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 58]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemRead\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 59]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMemWrite\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 60]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgMenuEntryClicked\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 61]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgModBaseFromName\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 62]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgReleaseEncodeTypeBuffer\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 63]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptAbort\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 64]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptBpGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 65]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptBpToggle\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 66]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptCmdExec\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 67]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptGetBranchInfo\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 68]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptGetLineType\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 69]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptLoad\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 70]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptRun\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 71]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptSetIp\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 72]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptStep\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 73]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgScriptUnload\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 74]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetAutoBookmarkAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 75]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetAutoCommentAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 76]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetAutoFunctionAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 77]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetAutoLabelAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 78]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetBookmarkAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 79]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetCommentAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 80]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetEncodeType\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 81]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSetLabelAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 82]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSettingsUpdated\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 83]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgStackCommentGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 84]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSymbolEnum\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 85]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgSymbolEnumFromCache\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 86]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgValFromString\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 87]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgValToString\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 88]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgWinEvent\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 89]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgWinEventGlobal\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 90]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgXrefAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 91]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgXrefDelAll\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 92]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"DbgXrefGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 93]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}]}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"GuiAddLogMessage\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAddLogMessageHtml\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAddQWidgetTab\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAddRecentFile\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAddStatusBarMessage\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAutoCompleteAddCmd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 5]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAutoCompleteClearAll\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 6]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiAutoCompleteDelCmd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 7]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiCloseQWidgetTab\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 8]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiDisasmAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 9]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiDisplayWarning\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 10]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiDumpAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 11]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiDumpAtN\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 12]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiExecuteOnGuiThread\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 13]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiExecuteOnGuiThreadEx\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 14]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiFocusView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 15]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGetDebuggeeNotes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 16]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGetDisassembly\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 17]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGetGlobalNotes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 18]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGetLineWindow\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 19]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGetWindowHandle\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 20]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiGraphAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 21]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiIsUpdateDisabled\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 22]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiLoadGraph\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 23]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiLoadSourceFile\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 24]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiLogClear\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 25]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 26]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuAddEntry\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 27]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuAddSeparator\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 28]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuClear\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 29]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuSetEntryIcon\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 30]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiMenuSetIcon\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 31]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiOpenTraceFile\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 32]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceAddColumn\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 33]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceDeleteAllColumns\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 34]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceGetCellContent\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 35]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceGetRowCount\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 36]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceInitialize\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 37]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceReloadData\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 38]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetCellContent\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 39]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Notes\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetCurrentTaskProgress\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 40]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetProgress\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 41]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetRowCount\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 42]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetSearchStartCol\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 43]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiReferenceSetSingleSelection\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 44]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiRegisterScriptLanguage\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 45]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiRepaintTableView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 46]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 47]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptClear\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 48]\", \"content\": {\"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptEnableHighlighting\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 49]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptError\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 50]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptMessage\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 51]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptMsgyn\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 52]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptSetInfoLine\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 53]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptSetIp\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 54]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiScriptSetTitle\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 55]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSelectionGet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 56]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSelectionSet\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 57]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSetDebugState\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 58]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSetDebuggeeNotes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 59]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSetGlobalNotes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 60]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSetLastException\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 61]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiShowCpu\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 62]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiShowQWidgetTab\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 63]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiStackDumpAt\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 64]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSymbolLogAdd\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 65]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSymbolLogClear\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 66]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSymbolRefreshCurrent\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 67]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSymbolSetProgress\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 68]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiSymbolUpdateModuleList\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 69]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUnregisterScriptLanguage\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 70]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateAllViews\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 71]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateArgumentWidget\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 72]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateBreakpointsView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 73]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateCallStack\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 74]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateDisable\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 75]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateDisassemblyView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 76]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateDumpView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 77]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateEnable\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 78]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateGraphView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 79]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateMemoryView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 80]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdatePatches\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 81]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateRegisterView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 82]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateSEHChain\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 83]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateSideBar\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 84]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateThreadView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 85]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateTimeWastedCounter\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 86]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateWatchView\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 87]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}, {\"title\": \"GuiUpdateWindowTitle\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 88]\", \"content\": {\"Parameters\": \"<detail_content>\", \"Return Value\": \"<detail_content>\", \"Example\": \"<detail_content>\", \"Related functions\": \"<detail_content>\"}}]}]}, {\"title\": \"Plugins\", \"description\": \"Documentation section: plugins\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"The basics\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Exports\": \"<detail_content>\", \"Definitions\": \"<detail_content>\"}}, {\"title\": \"Notes\", \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"Character encoding\": \"<detail_content>\"}}]}]}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"path\": \"[\\\"subpages\\\", 5]\", \"subpages\": [{\"title\": \"Dialogs\", \"description\": \"Documentation section: dialogs\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\", \"subpages\": [{\"title\": \"Entropy\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\", \"content\": {\"Entropy\": \"<detail_content>\"}}]}, {\"title\": \"Settings\", \"description\": \"Documentation section: settings\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\", \"subpages\": [{\"title\": \"Events\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\", \"content\": {\"System Breakpoint\": \"<detail_content>\", \"TLS Callbacks\": \"<detail_content>\", \"Entry Breakpoint\": \"<detail_content>\", \"DLL Entry\": \"<detail_content>\", \"Attach Breakpoint\": \"<detail_content>\", \"Thread Entry\": \"<detail_content>\", \"DLL Load\": \"<detail_content>\", \"DLL Unload\": \"<detail_content>\", \"Thread Start\": \"<detail_content>\", \"Thread End\": \"<detail_content>\", \"Debug Strings\": \"<detail_content>\"}}, {\"title\": \"Exceptions\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\", \"content\": {\"Add Range\": \"<detail_content>\", \"Delete Range\": \"<detail_content>\", \"Add Last\": \"<detail_content>\"}}, {\"title\": \"GUI\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\", \"content\": {\"Show FPU registers as little endian\": \"<detail_content>\", \"Save GUI layout and column orders\": \"<detail_content>\", \"Don't show close dialog\": \"<detail_content>\", \"Show PID in HEX\": \"<detail_content>\", \"Enable Load/Save Tab Order\": \"<detail_content>\", \"Show Watch Labels in Side Bar\": \"<detail_content>\", \"Do not call SetForegroundWindow\": \"<detail_content>\", \"Show RVA addresses in graph view\": \"<detail_content>\", \"Graph zoom mode\": \"<detail_content>\", \"Show exit confirmation dialog\": \"<detail_content>\", \"Disable auto completion in goto dialog\": \"<detail_content>\", \"Show ASCII/Unicode in address dump mode\": \"<detail_content>\"}}, {\"title\": \"Other settings\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\", \"content\": {\"Engine\": {\"AnimateInterval\": \"<detail_content>\", \"MaxSkipExceptionCount\": \"<detail_content>\"}, \"Gui\": {\"NonprintReplaceCharacter\": \"<detail_content>\", \"NullReplaceCharacter\": \"<detail_content>\"}, \"Misc\": {\"AnimateIgnoreError\": \"<detail_content>\", \"NoSeasons\": \"<detail_content>\"}}}]}, {\"title\": \"Views\", \"description\": \"Documentation section: views\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\", \"subpages\": [{\"title\": \"Source\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\", \"content\": {\"Source\": \"<detail_content>\"}}, {\"title\": \"Trace\", \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\", \"content\": {\"Start trace recording\": \"<detail_content>\", \"Stop trace recording\": \"<detail_content>\", \"Close\": \"<detail_content>\", \"Close and delete\": \"<detail_content>\", \"Open\": \"<detail_content>\", \"Recent files\": \"<detail_content>\", \"Search\": {\"Constant\": \"<detail_content>\", \"Memory Reference\": \"<detail_content>\"}, \"Toggle Auto Disassembly Scroll\": \"<detail_content>\"}}]}]}, {\"title\": \"Introduction\", \"description\": \"Documentation section: introduction\", \"path\": \"[\\\"subpages\\\", 6]\", \"subpages\": [{\"title\": \"Commandline\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\", \"content\": {\"Command line\": \"<detail_content>\"}}, {\"title\": \"Conditional Breakpoints\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\", \"content\": {\"Operations overview\": \"<detail_content>\", \"Hit counter\": \"<detail_content>\", \"Logging\": \"<detail_content>\", \"Notes\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Comparison with Conditional Tracing\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"Conditional Tracing\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\", \"content\": {\"Operations overview\": \"<detail_content>\", \"Logging\": \"<detail_content>\", \"Trace coverage\": \"<detail_content>\", \"Notes\": \"<detail_content>\", \"See also\": \"<detail_content>\"}}, {\"title\": \"Expression Functions\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\", \"content\": {\"Strings\": \"<detail_content>\", \"GUI Interaction\": \"<detail_content>\", \"Source\": \"<detail_content>\", \"Modules\": \"<detail_content>\", \"Process Information\": \"<detail_content>\", \"General Purpose\": \"<detail_content>\", \"Memory\": \"<detail_content>\", \"Disassembly\": \"<detail_content>\", \"Tracing\": \"<detail_content>\", \"Byte/Word/Dword/Qword/Ptr\": \"<detail_content>\", \"Functions\": \"<detail_content>\", \"References\": \"<detail_content>\", \"Arguments\": \"<detail_content>\", \"Exceptions\": \"<detail_content>\", \"Syscalls\": \"<detail_content>\", \"Plugins\": \"<detail_content>\"}}, {\"title\": \"Expressions\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\", \"content\": {\"Values\": \"<detail_content>\", \"Operators\": \"<detail_content>\", \"Quick-Assigning\": \"<detail_content>\", \"Functions\": \"<detail_content>\"}}, {\"title\": \"Features\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 5]\", \"content\": {\"Basic features\": \"<detail_content>\", \"Advanced features\": \"<detail_content>\", \"GUI features\": \"<detail_content>\"}}, {\"title\": \"String Formatting\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 6]\", \"content\": {\"Types\": \"<detail_content>\", \"Complex Type\": \"<detail_content>\", \"Examples\": \"<detail_content>\", \"Logging\": \"<detail_content>\", \"Plugins\": \"<detail_content>\"}}, {\"title\": \"Glossary\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7]\", \"content\": {\"Glossary\": \"<detail_content>\"}}, {\"title\": \"Inability\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8]\", \"content\": {\"Inability\": \"<detail_content>\"}}, {\"title\": \"Input\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 9]\", \"content\": {\"Input\": \"<detail_content>\"}}, {\"title\": \"Values\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 10]\", \"content\": {\"Numbers\": \"<detail_content>\", \"Variables\": \"<detail_content>\", \"Registers\": {\"Remarks\": \"<detail_content>\"}, \"Flags\": \"<detail_content>\", \"Memory locations\": \"<detail_content>\", \"Labels/Symbols\": \"<detail_content>\", \"Module Data\": {\"DLL exports\": \"<detail_content>\", \"Loaded module bases\": \"<detail_content>\", \"RVA/File offset\": \"<detail_content>\", \"Module entry points\": \"<detail_content>\"}}}, {\"title\": \"Variables\", \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 11]\", \"content\": {\"Setting variables\": \"<detail_content>\", \"Reserved Variables\": \"<detail_content>\"}}]}]}"},"structured_docs":{"kind":"string","value":"{\"title\": \"x64dbg\", \"description\": \"Documentation for x64dbg\", \"content\": {}, \"metadata\": {\"type\": \"root\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs\"}, \"subpages\": [{\"title\": \"Compile Linux\", \"description\": null, \"content\": {\"Prerequisites\": \"```\\nsudo apt update\\nsudo apt install cmake ninja-build wine\\n```\", \"Install MSVC\": \"Download https://github.com/mstorsjo/msvc-wine\\n\\n```\\ncd msvc-wine\\n./vsdownload.py --accept-license --dest ~/opt/msvc Microsoft.VisualStudio.Workload.VCTools Microsoft.VisualStudio.Component.VC.ATL\\n./install.sh ~/opt/msvc\\n```\", \"Build\": \"x86\\n\\n```\\ncd x64dbg\\nexport MSVC_BIN_DIR=~/opt/msvc/bin/x86\\nexport QT_BIN_DIR=~/src/x64dbg/build32/_deps/qt5-src/bin\\ncmake -B build32 -DCMAKE_TOOLCHAIN_FILE=cmake/msvc-wine.cmake -G Ninja\\ncmake --build build32 -j4\\n```\\n\\nx64\\n\\n```\\ncd x64dbg\\nexport MSVC_BIN_DIR=~/opt/msvc/bin/x64\\nexport QT_BIN_DIR=~/src/x64dbg/build64/_deps/qt5-src/bin\\ncmake -B build64 -DCMAKE_TOOLCHAIN_FILE=cmake/msvc-wine.cmake -G Ninja\\ncmake --build build64 -j4\\n```\", \"Issues\": [\"```LINK : fatal error LNK1158: cannot run 'rc.exe'```\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 0]\"}, {\"title\": \"docs\", \"description\": null, \"content\": {\"Building\": \"Run `makechm.bat`. It will build the .CHM help file.\\n\\nWhen first building the .CHM help file, it automatically downloads\\n[python 2.7.18 portable](https://github.com/x64dbg/docs/releases/download/python27-portable/python-2.7.18.amd64.portable.7z) and\\n[Microsoft HTML Help Compiler 4.74.8702](https://github.com/x64dbg/deps/releases/download/dependencies/hhc-4.74.8702.7z) from GitHub.\\nThen, `7z` is used to extract the downloaded archive, so make sure [7-zip](https://7-zip.org/) is installed, and `7z` command can be accessed from\\nthe current directory.\\n\\nNote: The following patch was applied:\\n\\nAdd `relpath = relpath.replace(os.path.sep, '/')` after `C:\\\\Python27\\\\Lib\\\\site-packages\\\\recommonmark\\\\transform.py` line `63`\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 1]\"}, {\"title\": \"Licenses\", \"description\": null, \"content\": {\"Licenses\": [\"[x64dbg](https://github.com/x64dbg/x64dbg): [`GPL`](https://github.com/x64dbg/x64dbg/blob/development/LICENSE)\", \"[TitanEngine](https://github.com/x64dbg/TitanEngine): [`LGPL`](https://github.com/x64dbg/TitanEngine/blob/x64dbg/LICENSE)\", \"[GleeBug](https://github.com/x64dbg/GleeBug): [`MIT`](https://github.com/x64dbg/GleeBug/blob/vs2015/LICENSE)\", \"[asmtk](https://github.com/asmjit/asmtk): [`zlib`](https://github.com/asmjit/asmtk/blob/master/LICENSE.md)\", \"[asmjit](https://github.com/asmjit/asmjit/blob/master/LICENSE.md): [`zlib`](https://github.com/asmjit/asmjit/blob/master/LICENSE.md)\", \"[XEDParse](https://github.com/x64dbg/xedparse): [`LGPL`](https://github.com/x64dbg/XEDParse/blob/master/LICENSE)\", \"[jansson](https://github.com/x64dbg/jansson): [`MIT`](https://github.com/x64dbg/jansson/blob/master/LICENSE)\", \"[Zydis](https://github.com/zyantific/zydis): [`MIT`](https://github.com/zyantific/zydis/blob/master/LICENSE)\", \"[lz4](https://github.com/x64dbg/lz4): [`BSD`](https://github.com/x64dbg/lz4/blob/master/LICENSE)\", \"[Qt 5](https://www.qt.io/): [`LGPL`](https://www.qt.io/licensing/open-source-lgpl-obligations)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 2]\"}, {\"title\": \"Commands\", \"description\": \"Documentation section: commands\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands\"}, \"subpages\": [{\"title\": \"Analysis\", \"description\": \"Documentation section: analysis\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/analysis\"}, \"subpages\": [{\"title\": \"GetRelocSize/grs\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the relocation table to analyze.\", \"results\": \"The found size of the relocation table is stored in `$result`.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}, {\"title\": \"analadv\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\"}, {\"title\": \"analrecur/analr\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The base address of the function to analyze.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\"}, {\"title\": \"analxrefs/analx\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\"}, {\"title\": \"analyse/analyze/anal\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\"}, {\"title\": \"analyse_nukem/analyze_nukem/anal_nukem\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\"}, {\"title\": \"cfanalyze/cfanalyse/cfanal\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\"}, {\"title\": \"exanalyse/exanalyze/exanal\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\"}, {\"title\": \"Exhandlers\", \"description\": null, \"content\": {\"root\": [\"exhandlers\", \"Print all exception handlers, including SEH(StructuredExceptionHandler), VEH(VectoredExceptionHandler),\\nVCH(VectoredContinueHandler) and UnhandledExceptionFilter, into the log.\", \"arguments\", \"This command has no arguments\", \"results\", \"This command does not set any result variables.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\"}, {\"title\": \"Exinfo\", \"description\": null, \"content\": {\"exinfo\": \"Print the `EXCEPTION_DEBUG_INFO` structure from the last exception.\\n\\nSample output:\\n\\n```\\nEXCEPTION_DEBUG_INFO:\\n dwFirstChance: 1\\n ExceptionCode: 80000001 (EXCEPTION_GUARD_PAGE)\\n ExceptionFlags: 00000000\\n ExceptionAddress: 00007FFE16FB1B91 ntdll.00007FFE16FB1B91\\n NumberParameters: 2\\nExceptionInformation[00]: 0000000000000008\\nExceptionInformation[01]: 00007FFE16FB1B91 ntdll.00007FFE16FB1B91\\n```\\n\\narguments\\n\\nThis command has no arguments\\n\\nresults\\n\\nThis command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\"}, {\"title\": \"imageinfo\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The base of the module. If not specified the module at CIP will be used.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\"}, {\"title\": \"symdownload/downloadsym\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Module name (with or without extension) to attempt to download symbols for. When not specified, an attempt will be done to download symbols for all loaded modules.\\n\\n`[arg2]` Symbol Store URL. When not specified, the\\u00a0default store will be used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 11]\"}, {\"title\": \"symload/loadsym\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Module name (with or without extension) to attempt to load symbols for.\\n\\n`arg2` Path to the symbol file.\\n\\n`[arg3]` Force load. Set to `1` to skip symbol validation.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 12]\"}, {\"title\": \"symunload/unloadsym\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Module name (with or without extension) to unload symbols from.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 13]\"}, {\"title\": \"traceexecute\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 14]\"}, {\"title\": \"virtualmod\", \"description\": null, \"content\": {\"arguments\": \"`arg1` the user-supplied module name.\\n\\n`arg2` the base of the memory range.\\n\\n`[arg3]` the size of the memory range.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0, \\\"subpages\\\", 15]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 0]\"}, {\"title\": \"Breakpoint Control\", \"description\": \"Documentation section: breakpoint-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/breakpoint-control\"}, \"subpages\": [{\"title\": \"DeleteBPX/bpc/bc\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name or address of the breakpoint to delete. If this argument is not specified, all breakpoints will be deleted.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Deleteexceptionbpx\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name, exception name or code of the exception breakpoint to delete. If this argument is not specified, all exception breakpoints will be deleted.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"DeleteHardwareBreakpoint/bphc/bphwc\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name or address of the hardware breakpoint to delete. If this argument is not specified, all hardware breakpoints will be deleted.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \"DeleteMemoryBPX/membpc/bpmc\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name or (base) address of the memory breakpoint to delete. If this argument is not specified, all memory breakpoints will be deleted.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}, {\"title\": \"DisableBPX/bpd/bd\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name or address of the breakpoint to disable. If this argument is not specified, all breakpoints will be disabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\"}, {\"title\": \"Disableexceptionbpx\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name, exception name or code of the exception breakpoint to enable. If this argument is not specified, all exception breakpoints will be disabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\"}, {\"title\": \"DisableHardwareBreakpoint/bphd/bphwd\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of the hardware breakpoint to disable. If this argument is not specified, all hardware breakpoints will be disabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\"}, {\"title\": \"DisableMemoryBreakpoint/membpd/bpmd\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of the memory breakpoint to disable. If this argument is not specified, all memory breakpoints will be disabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 7]\"}, {\"title\": \"EnableBPX/bpe/be\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name or address of the breakpoint to enable. If this argument is not specified, all breakpoints will be enabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 8]\"}, {\"title\": \"EnableExceptionBPX\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Name, exception name or code of the exception breakpoint to enable. If this argument is not specified, all exception breakpoints will be enabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 9]\"}, {\"title\": \"EnableHardwareBreakpoint/bphe/bphwe\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of the hardware breakpoint to enable. If this argument is not specified, as many as possible hardware breakpoints will be enabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 10]\"}, {\"title\": \"EnableMemoryBreakpoint/membpe/bpme\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of the memory breakpoint to enable. If this argument is not specified, all memory breakpoints will be enabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 11]\"}, {\"title\": \"Librariandisablebreakpoint\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` DLL Name of the DLL breakpoint to disable. If this argument is not specified, all DLL breakpoints will be disabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 12]\"}, {\"title\": \"LibrarianEnableBreakpoint/bpedll\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` DLL Name of the DLL breakpoint to enable. If this argument is not specified, all DLL breakpoints will be enabled.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 13]\"}, {\"title\": \"LibrarianRemoveBreakpoint/bcdll\", \"description\": null, \"content\": {\"arguments\": \"`arg1` DLL Name to remove the breakpoint from.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 14]\"}, {\"title\": \"LibrarianSetBreakpoint/bpdll\", \"description\": null, \"content\": {\"arguments\": \"`arg1` DLL Name to break on.\\n\\n`[arg2]` `a` means on load and unload, `l` means on load, `u` means on unload. When not specified, x64dbg will break on both load and unload.\\n\\n`[arg3]` When specified, the breakpoint will be singleshoot. When not specified the breakpoint will not be removed after it has been hit.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 15]\"}, {\"title\": \"Setbpx\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to put a breakpoint on. This can be an API name.\\n\\n`[arg2]` Name of the breakpoint, use quotation marks to include spaces. This name can be used by the EnableBPX, DisableBPX and DeleteBPX functions as alias, but is mainly intended to provide a single line of information about the currently-hit breakpoint. When arg2 equals to a valid type (arg3) the type is used and arg2 is ignored.\\n\\n`[arg3]` Breakpoint type. Can be one of the following options in random order: \\\"ss\\\" (single shot breakpoint), \\\"long\\\" (CD03), \\\"ud2\\\" (0F0B) and \\\"short\\\" (CC). You can combine the \\\"ss\\\" option with one of the type options in one string. Example: \\\"SetBPX 00401000,\\\"entrypoint\\\",ssud2\\\" will set a single shot\\u00a0UD2\\u00a0breakpoint at 00401000 with the name \\\"entrypoint\\\". When specifying no type or just the type \\\"ss\\\" the default type will be used. Per default this equals to the \\\"short\\\" type. You can change the default type using the \\\"SetBPXOptions\\\" command.\", \"result\": \"This command\\u00a0does\\u00a0not any\\u00a0result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 16]\"}, {\"title\": \"SetBPXOptions/bptype\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Default type. This can be \\\"short\\\" (CC), \\\"long\\\" (CD03) or \\\"ud2\\\" (0F0B). Type default type affects both NORMAL and SINGLESHOT breakpoints.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 17]\"}, {\"title\": \"Setexceptionbpx\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Exception name or code of the new exception breakpoint\\n\\n`[arg2]` Chance. Set to `first`/`1` to capture first-chance exceptions, `second`/`2` to capture second-chance exceptions, `all`/`3` to capture all exceptions. Default value is `first`.\", \"result\": \"This command does not any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 18]\"}, {\"title\": \"SetHardwareBreakpoint/bph/bphws\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address\\u00a0of the hardware breakpoint.\\n\\n`[arg2]` Hardware breakpoint type. Can be either 'r' (readwrite), 'w' (write) or 'x' (execute). When not specified, 'x' is assumed.\\n\\n`[arg3]` Hardware breakpoint size.\\u00a0Can be either '1', '2', '4' or '8' (x64 only). Per default, '1' is assumed. The address you're putting the hardware breakpoint on must be aligned to the specified size.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 19]\"}, {\"title\": \"SetMemoryBPX/membp/bpm\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address\\u00a0of or inside a memory region that will be watched.\\n\\n`[arg2]` 1/0 restore the memory breakpoint once it's hit? When this value is not equal to '1' or '0', it's assumed to be arg3. This means \\\"bpm eax,r\\\" would be the same command as: \\\"bpm eax,0,r\\\".\\n\\n`[arg3]` Breakpoint type, it can be 'a' (read+write+execute) 'r' (read),\\u00a0'w' (write) or 'x' (execute). Per default, it's 'a' (read+write+execute)\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 20]\"}, {\"title\": \"SetMemoryRangeBPX/memrangebp/bpmrange\", \"description\": null, \"content\": {\"arguments\": \"`start` Start of the memory range.\\n\\n`size` Size of the memory range.\\n\\n`[type]` Breakpoint type, it can be 'a' (read+write+execute) 'r' (read),\\u00a0'w' (write) or 'x' (execute). Per default, it's 'a' (read+write+execute). Append `ss` for a singleshot breakpoint (you can also use [`SetMemoryBreakpointSingleshoot`](../conditional-breakpoint-control/SetMemoryBreakpointSingleshoot.md) to do this).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 21]\"}, {\"title\": \"bpgoto\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`arg2` The new address to execute if the breakpoint is reached.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 22]\"}, {\"title\": \"bplist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables. A list entry has the following format:\\n\\nSTATE:TYPE:ADDRESS\\\\[:NAME\\\\]\\n\\nSTATEcan be 0 or 1. 0 means disabled, 1 means enabled. Only singleshoot and 'normal' breakpoints can be disabled.\\n\\nTYPEcan be one of the following values: BP, SS, HW and GP. BP stands for a normal breakpoint (set using the SetBPX command), SS stands for SINGLESHOT, HW stands for HARDWARE and GP stand for Guard Page, the way of setting memory breakpoints.\\n\\nADDRESSis the breakpoint address, given in 32 and 64 bits for the x32 and x64 debugger respectively.\\n\\nNAMEis the name assigned to the breakpoint.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1, \\\"subpages\\\", 23]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 1]\"}, {\"title\": \"Conditional Breakpoint Control\", \"description\": \"Documentation section: conditional-breakpoint-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/conditional-breakpoint-control\"}, \"subpages\": [{\"title\": \"GetBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\", \"result\": \"`$result` will be set to the current value of the hit counter.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"GetExceptionBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\", \"result\": \"`$result` will be set to the current value of the hit counter.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"GetHardwareBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\", \"result\": \"`$result` will be set to the current value of the hit counter.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"GetLibrarianBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\", \"result\": \"`$result` will be set to the current value of the hit counter.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"GetMemoryBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\", \"result\": \"`$result` will be set to the current value of the hit counter.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}, {\"title\": \"ResetBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The new hit count (zero when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 5]\"}, {\"title\": \"ResetExceptionBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception code or name of the exception breakpoint.\\n\\n`[arg2]` The new hit count (zero when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 6]\"}, {\"title\": \"ResetHardwareBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The new hit count (zero when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 7]\"}, {\"title\": \"ResetLibrarianBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The new hit count (zero when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 8]\"}, {\"title\": \"ResetMemoryBreakpointHitCount\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The new hit count (zero when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 9]\"}, {\"title\": \"SetBreakpointCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 10]\"}, {\"title\": \"SetBreakpointCommandCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 11]\"}, {\"title\": \"SetBreakpointCondition/bpcond/bpcnd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The condition expression.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 12]\"}, {\"title\": \"SetBreakpointFastResume\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The fast resume flag. If it is 0 (default), fast resume is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 13]\"}, {\"title\": \"SetBreakpointLog/bplog/bpl\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The log format string (see introduction/formatting).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 14]\"}, {\"title\": \"SetBreakpointLogCondition/bplogcondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The logging condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 15]\"}, {\"title\": \"SetBreakpointName/bpname\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of an existing software breakpoint.\\n\\n`[arg2]` The name of the breakpoint (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 16]\"}, {\"title\": \"SetBreakpointSilent\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The silent flag. If it is 0 (default), silent is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 17]\"}, {\"title\": \"SetBreakpointSingleshoot\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The singleshoot flag. If it is 0 (default), singleshoot is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 18]\"}, {\"title\": \"SetExceptionBreakpointCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The command (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 19]\"}, {\"title\": \"SetExceptionBreakpointCommandCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The command condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 20]\"}, {\"title\": \"SetExceptionBreakpointCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The condition expression.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 21]\"}, {\"title\": \"SetExceptionBreakpointFastResume\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The fast resume flag. If it is 0 (default), fast resume is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 22]\"}, {\"title\": \"SetExceptionBreakpointLog\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The log format string (see introduction/formatting).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 23]\"}, {\"title\": \"SetExceptionBreakpointLogCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The logging condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 24]\"}, {\"title\": \"SetExceptionBreakpointName\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The name of the breakpoint (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 25]\"}, {\"title\": \"SetExceptionBreakpointSilent\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The silent flag. If it is 0 (default), silent is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 26]\"}, {\"title\": \"SetExceptionBreakpointSingleshoot\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name, exception name or code of the exception breakpoint.\\n\\n`[arg2]` The singleshoot flag. If it is 0 (default), singleshoot is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 27]\"}, {\"title\": \"SetHardwareBreakpointCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 28]\"}, {\"title\": \"SetHardwareBreakpointCommandCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 29]\"}, {\"title\": \"SetHardwareBreakpointCondition/bphwcond\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The condition expression.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 30]\"}, {\"title\": \"SetHardwareBreakpointFastResume\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The fast resume flag. If it is 0 (default), fast resume is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 31]\"}, {\"title\": \"SetHardwareBreakpointLog/bphwlog\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The log format string (see introduction/formatting).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 32]\"}, {\"title\": \"SetHardwareBreakpointLogCondition/bphwlogcondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The logging condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 33]\"}, {\"title\": \"SetHardwareBreakpointName/bphwname\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of an existing hardware breakpoint.\\n\\n`[arg2]` The name of the breakpoint (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 34]\"}, {\"title\": \"SetHardwareBreakpointSilent\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The silent flag. If it is 0 (default), silent is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 35]\"}, {\"title\": \"SetHardwareBreakpointSingleshoot\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The singleshoot flag. If it is 0 (default), singleshoot is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 36]\"}, {\"title\": \"SetLibrarianBreakpointCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The command (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 37]\"}, {\"title\": \"SetLibrarianBreakpointCommandCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The command condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 38]\"}, {\"title\": \"SetLibrarianBreakpointCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The condition expression.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 39]\"}, {\"title\": \"SetLibrarianBreakpointFastResume\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The fast resume flag. If it is 0 (default), fast resume is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 40]\"}, {\"title\": \"SetLibrarianBreakpointLog\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The log format string (see introduction/formatting).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 41]\"}, {\"title\": \"SetLibrarianBreakpointLogCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The logging condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 42]\"}, {\"title\": \"SetLibrarianBreakpointName\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The name of the breakpoint (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 43]\"}, {\"title\": \"SetLibrarianBreakpointSilent\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The silent flag. If it is 0 (default), silent is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 44]\"}, {\"title\": \"SetLibrarianBreakpointSingleshoot\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The DLL name.\\n\\n`[arg2]` The singleshoot flag. If it is 0 (default), singleshoot is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 45]\"}, {\"title\": \"SetMemoryBreakpointCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 46]\"}, {\"title\": \"SetMemoryBreakpointCommandCondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The command condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 47]\"}, {\"title\": \"SetMemoryBreakpointCondition/bpmcond\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The condition expression.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 48]\"}, {\"title\": \"SetMemoryBreakpointFastResume\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The fast resume flag. If it is 0 (default), fast resume is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 49]\"}, {\"title\": \"SetMemoryBreakpointLog/bpmlog\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The log format string (see introduction/formatting).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 50]\"}, {\"title\": \"SetMemoryBreakpointLogCondition/bpmlogcondition\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The logging condition (default condition when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 51]\"}, {\"title\": \"SetMemoryBreakpointName/bpmname\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of an existing memory breakpoint.\\n\\n`[arg2]` The name of the breakpoint (empty when not specified).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 52]\"}, {\"title\": \"SetMemoryBreakpointSilent\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The silent flag. If it is 0 (default), silent is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 53]\"}, {\"title\": \"SetMemoryBreakpointSingleshoot\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address of the breakpoint.\\n\\n`[arg2]` The singleshoot flag. If it is 0 (default), singleshoot is disabled, otherwise it is enabled\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2, \\\"subpages\\\", 54]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 2]\"}, {\"title\": \"Debug Control\", \"description\": \"Documentation section: debug-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/debug-control\"}, \"subpages\": [{\"title\": \"AttachDebugger/attach\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Process Identifier (PID) of the running process.\\n\\n`[arg2]` Handle to an Event Object to signal (this is for internal use only).\\n\\n`[arg3]` Thread Identifier (TID) of the thread to resume after attaching (this is for internal use only).\", \"result\": \"This command will give control back to the user after the system breakpoint is reached. It will set `$pid` and `$hp`/`$hProcess` variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 0]\"}, {\"title\": \"DebugContinue/con\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` When set (to anything), the exception will be handled by the program. Otherwise the exception will be swallowed.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 1]\"}, {\"title\": \"DetachDebugger/detach\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 2]\"}, {\"title\": \"InitDebug/initdbg/init\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Path to the executable file to debug. If no full path is given, the `GetCurrentDirectory` API will be called to retrieve a full path. Use quotation marks to include spaces in your path.\\n\\n`[arg2]` Commandline to create the process with.\\n\\n`[arg3]` Current folder (passed to the `CreateProcess` API) (this is also sometimes called 'working directory' or 'current directory')\", \"result\": \"This command will give control back to the user after the system breakpoint is reached. It will set `$pid` and `$hp`/`$hProcess` variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 3]\"}, {\"title\": \"InstrUndo\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 4]\"}, {\"title\": \"StepInto/sti\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of steps to take. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 5]\"}, {\"title\": \"StepOut/rtr\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of times to step out. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 6]\"}, {\"title\": \"StepOver/step/sto/st\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 7]\"}, {\"title\": \"StepSystem/StepSystemInto\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 8]\"}, {\"title\": \"StepUser/StepUserInto\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 9]\"}, {\"title\": \"StopDebug/stop/dbgstop\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 10]\"}, {\"title\": \"eStepInto/esti\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of steps to take. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 11]\"}, {\"title\": \"eStepOut/ertr\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of times to step out. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 12]\"}, {\"title\": \"eStepOver/estep/esto/est\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of steps to take. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 13]\"}, {\"title\": \"erun/ego/er/eg\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` When specified, place a single-shot breakpoint at this location before running.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 14]\"}, {\"title\": \"pause\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 15]\"}, {\"title\": \"run/go/r/g\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` When specified, place a single-shot breakpoint at this location before running.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 16]\"}, {\"title\": \"seStepInto/sesti\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of steps to take. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 17]\"}, {\"title\": \"seStepOver/sestep/sesto/sest\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of steps to take. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 18]\"}, {\"title\": \"serun/sego\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` When specified, place a single-shot breakpoint at this location before running.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 19]\"}, {\"title\": \"skip\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The number of instructions to skip. If not specified `1` is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3, \\\"subpages\\\", 20]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 3]\"}, {\"title\": \"General Purpose\", \"description\": \"Documentation section: general-purpose\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/general-purpose\"}, \"subpages\": [{\"title\": \"add\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}, {\"title\": \"and\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 1]\"}, {\"title\": \"bswap\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 2]\"}, {\"title\": \"cmp\", \"description\": null, \"content\": {\"arguments\": \"`arg1` First expression to compare.\\n\\n`arg2` Second expression to compare.\", \"result\": \"This command sets the internal variables $_EZ_FLAG and $_BS_FLAG. They are checked when a branch is performed.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 3]\"}, {\"title\": \"Dec\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 4]\"}, {\"title\": \"div\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 5]\"}, {\"title\": \"inc\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 6]\"}, {\"title\": \"kmovd/kmovq\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The destination operand.\\n\\n`arg2` The source operand.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 7]\"}, {\"title\": \"lzcnt\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Value.\", \"result\": \"`arg1` is set to the number of leading zeros. Additionaly, the internal variable `$_EZ_FLAG` is set to 1 if `arg1` is 0, and set to 0 otherwise. The internal variable `$_BS_FLAG` is set to 0.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 8]\"}, {\"title\": \"mov/set\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Variable name (optionally prefixed with a $) to set. When the variable does not exist, it will be created. Note that SSE registers are not supported (Instead use [movdqu](movdqu.md) for SSE registers).\\n\\n`arg2` Value to store in the variable. If you use `#11 22 33#` it will write the bytes `11 22 33` in the process memory at `arg1`.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 9]\"}, {\"title\": \"movdqu/movups/movupd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The destination operand.\\n\\n`arg2` The source operand.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 10]\"}, {\"title\": \"mul\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 11]\"}, {\"title\": \"mulhi\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 12]\"}, {\"title\": \"neg\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 13]\"}, {\"title\": \"not\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 14]\"}, {\"title\": \"or\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 15]\"}, {\"title\": \"pop\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The destination. When not specified it will just increase CSP.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 16]\"}, {\"title\": \"popcnt\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Value.\", \"result\": \"`arg1` is set to the population count. Additionaly, the internal variable `$_EZ_FLAG` is set to 1 if `arg1` is 0, and set to 0 otherwise. The internal variable `$_BS_FLAG` is set to 0.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 17]\"}, {\"title\": \"push\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The value to push on the stack.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 18]\"}, {\"title\": \"rol\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 19]\"}, {\"title\": \"ror\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 20]\"}, {\"title\": \"sar\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 21]\"}, {\"title\": \"shl/sal\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 22]\"}, {\"title\": \"shr\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 23]\"}, {\"title\": \"sub\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 24]\"}, {\"title\": \"test\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Value to test.\\n\\n`arg2` Tester.\", \"result\": \"This command\\u00a0sets the internal variables $_EZ_FLAG and $_BS_FLAG. $_EZ_FLAG is set to 1 when arg1 & arg2 == 0. $_BS_FLAG is always set to 0.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 25]\"}, {\"title\": \"vmovdqu/vmovups/vmovupd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The destination operand.\\n\\n`arg2` The source operand.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 26]\"}, {\"title\": \"xor\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination.\\n\\n`arg2` Source.\", \"result\": \"This command does not set any result\\u00a0variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4, \\\"subpages\\\", 27]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 4]\"}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/gui\"}, \"subpages\": [{\"title\": \"AddFavouriteCommand\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The command to add.\\n\\n`[arg2]` The optional shortcut key for the command.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"AddFavouriteTool\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The path of the tool.\\n\\n`[arg2]` The optional description of the tool. When this is set, it is displayed in the menu instead of the full path.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"AddFavouriteToolShortcut/SetFavouriteToolShortcut\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The full path of an existing favourite tool.\\n\\n`arg2` The shortcut key for it.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}, {\"title\": \"ClearLog/cls/lc/lclr\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 3]\"}, {\"title\": \"DisableLog/LogDisable\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 4]\"}, {\"title\": \"EnableLog/LogEnable\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 5]\"}, {\"title\": \"FoldDisassembly\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The start address of the range.\\n\\n`arg2` The length of the range.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 6]\"}, {\"title\": \"disasm/dis/d\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The address to disassemble at. When not specified, there will be disassembled at CIP.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 7]\"}, {\"title\": \"dump\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address to dump at.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 8]\"}, {\"title\": \"graph\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The address of the function. The default value is EIP or RIP.\\n`[arg2]` Options. If it contains \\\"force\\\" the graph will be reanalyzed, if it contains \\\"silent\\\" no messages will be printed on the console.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 9]\"}, {\"title\": \"guiupdatedisable\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 10]\"}, {\"title\": \"guiupdateenable\", \"description\": null, \"content\": {\"arguments\": \"`[arg0]` If not 0, tells the debugger to update its GUI immediately.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 11]\"}, {\"title\": \"memmapdump\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address to follow.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 12]\"}, {\"title\": \"refadd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to put in the reference view.\\n\\n`arg2` Text to put after the address. You can use [String Formatting](../../introduction/Formatting.md) here.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 13]\"}, {\"title\": \"refget\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Zero-based index of the reference address to retrieve.\", \"result\": \"The `$result` variable will be set to the address of the requested reference (zero on failure).\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 14]\"}, {\"title\": \"refinit\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The title of the new reference view. You can use [String Formatting](../../introduction/Formatting.md) here.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 15]\"}, {\"title\": \"sdump\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The address to dump at (must be inside the thread stack range). If not specified, `csp` will be used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 16]\"}, {\"title\": \"setfreezestack\", \"description\": null, \"content\": {\"arguments\": \"`arg1` '0' for unfrozen, '1' for frozen.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5, \\\"subpages\\\", 17]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 5]\"}, {\"title\": \"Memory Operations\", \"description\": \"Documentation section: memory-operations\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/memory-operations\"}, \"subpages\": [{\"title\": \"Fill/memset\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Memory address to start setting bytes.\\n\\n`arg2` Value (byte) to set memory with.\\n\\n`[arg3]` Size to set. When not specified the rest of the page is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 0]\"}, {\"title\": \"alloc\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Size of the memory to allocate. When not specified, a default size of 0x1000 is used.\\n\\n`[arg2]` Address to allocate the memory at. Unspecified or zero means a random address.\", \"result\": \"This command sets $result to the allocated memory address. It also sets the $lastalloc variable to the allocated memory address when VirtualAllocEx succeeded.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 1]\"}, {\"title\": \"free\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of the memory to free. When not specified, the value at $lastalloc is used.\", \"result\": \"This command sets $result to 1 if VirtualFreeEx succeeded, otherwise it's set to 0. $lastalloc is set to zero when the address specified is equal to $lastalloc.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 2]\"}, {\"title\": \"getpagerights/getpagerights/getrightspage\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Memory Address\\u00a0of page (it fix\\u00a0the address if\\u00a0this arg\\u00a0is not the top address of a page).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 3]\"}, {\"title\": \"memcpy\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Destination address.\\n\\n`arg2` Source address.\\n\\n`arg3` Size to copy.\", \"result\": \"This command sets `$result` to the total amount of bytes written at the destination. The condition `$result == arg3` is true if all memory was copied.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 4]\"}, {\"title\": \"minidump\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The filename of the `.dmp`.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 5]\"}, {\"title\": \"savedata\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The filename. If you use `:memdump:` as name it will save a file as `memdump_pid_addr_size.bin` in the x64dbg directory. You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`arg2` The address of the memory region.\\n\\n`arg3` The size of the memory region.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 6]\"}, {\"title\": \"setpagerights/setpagerights/setrightspage\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Memory Address\\u00a0of page (it fix\\u00a0the address if\\u00a0this arg\\u00a0is not the top address of a page).\\n\\n`arg2` New Rights, this can be one of the following values: \\\"Execute\\\", \\\"ExecuteRead\\\", \\\"ExecuteReadWrite\\\", \\\"ExecuteWriteCopy\\\", \\\"NoAccess\\\", \\\"ReadOnly\\\", \\\"ReadWrite\\\", \\\"WriteCopy\\\". You can add a G at first for add PAGE GUARD. example: \\\"GReadOnly\\\". Read the MSDN for more info.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6, \\\"subpages\\\", 7]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 6]\"}, {\"title\": \"Misc\", \"description\": \"Documentation section: misc\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/misc\"}, \"subpages\": [{\"title\": \"HideDebugger/dbh/hide\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 0]\"}, {\"title\": \"asm\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to place the assembled instruction at.\\n\\n`arg2` Instruction text. You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`[arg3]` When specified the remainder of the previous instruction will be filled with NOPs.\", \"result\": \"$result will be set to the assembled instruction size. 0 on failure.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 1]\"}, {\"title\": \"chd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Path of a directory to change to.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 2]\"}, {\"title\": \"config\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Section name of the INI file.\\n\\n`arg2` Key name of the INI file.\\n\\n`[arg3]` Optional new value of the configuration. If this argument is set to a number, it will be stored in the configuration file and ``$result`` is not updated. If this argument is not set, the current configuration will be read into ``$result``.\", \"results\": \"This command sets `$result` to the current configuration number if `arg3` is not set.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 3]\"}, {\"title\": \"getcommandline/getcmdline\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 4]\"}, {\"title\": \"getjit/jitget\", \"description\": null, \"content\": {\"arguments\": \"Without arguments:\\u00a0Get the current JIT debugger.\\n\\n`arg2`\\n\\n['*old*:\\\\xa0Get the old JIT entry stored.', '*x32*: Get the x32-JIT\\\\xa0entry.x64: Get the x64-JIT\\\\xa0entry.']\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 5]\"}, {\"title\": \"getjitauto/jitgetauto\", \"description\": null, \"content\": {\"arguments\": \"without args: Get current JIT entry FLAG.\\n\\n`arg1`\\n\\n['x32: Get the x32-JIT AUTO\\\\xa0FLAG.', 'x64: Get the x64-JIT AUTO\\\\xa0FLAG.']\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 6]\"}, {\"title\": \"gpa\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Export name.\\n\\n`[arg2]` DLL name.\", \"result\": \"The $result variable is set to the export address. When the export is not found, $result will be set to 0.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 7]\"}, {\"title\": \"loadlib\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name/path of the module to load.\", \"result\": \"The `$result` variable will be set to the address of the loaded library.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 8]\"}, {\"title\": \"mnemonicbrief\", \"description\": null, \"content\": {\"arguments\": \"`arg1` the mnemonic name\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 9]\"}, {\"title\": \"mnemonichelp\", \"description\": null, \"content\": {\"arguments\": \"`arg1` the mnemonic name\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 10]\"}, {\"title\": \"setcommandline/setcmdline\", \"description\": null, \"content\": {\"arguments\": \"`arg1` New command line.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 11]\"}, {\"title\": \"setjit/jitset\", \"description\": null, \"content\": {\"arguments\": \"Without arguments:\\u00a0Set the current debugger as JIT.\\n\\n`arg1`\\n\\n['*oldsave*: Set the current debugger as JIT and save the last JIT entry.', '*restore*: Set the\\\\xa0old JIT entry stored\\\\xa0as JIT and remove it from debugger db.', '*old* (without arg2):\\\\xa0Set the old JIT entry stored\\\\xa0as new JIT.', '*old* (with arg2):\\\\xa0Set the arg2 as old JIT entry stored.', '*x32*: Set the arg2 as new x32-JIT\\\\xa0entry.', '*x64*: Set the arg2 as new x64-JIT\\\\xa0entry.']\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 12]\"}, {\"title\": \"setjitauto/jitsetauto\", \"description\": null, \"content\": {\"arguments\": \"`arg1`\\n\\n['1/ON: Set current JIT entry FLAG as TRUE.', '0/FALSE: Set current JIT entry FLAG as FALSE.', 'x32: Set the x32-JIT AUTO\\\\xa0FLAG TRUE or FALSE. It needs an arg2:\\\\xa0can be ON/1 or OFF/0.', 'x64: Set the x64-JIT AUTO\\\\xa0FLAG TRUE or FALSE. It needs an arg2: can be ON/1 or OFF/0.']\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 13]\"}, {\"title\": \"zzz/doSleep\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Time (in milliseconds) to sleep. If not specified this is set to 100ms (0.1 second). Keep in mind that input is in hex per default so `Sleep 100` will actually sleep 256 milliseconds (use `Sleep .100` instead).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7, \\\"subpages\\\", 14]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 7]\"}, {\"title\": \"Operating System Control\", \"description\": \"Documentation section: operating-system-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/operating-system-control\"}, \"subpages\": [{\"title\": \"DisablePrivilege\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name of the privilege. Example: `SeDebugPrivilege`\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 0]\"}, {\"title\": \"EnablePrivilege\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name of the privilege. Example: `SeDebugPrivilege`\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 1]\"}, {\"title\": \"GetPrivilegeState\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The name of the privilege. Example: `SeDebugPrivilege`.\", \"results\": \"This command sets `$result` to `1` if the privilege is disabled on the debuggee, `2` or `3` if the privilege is enabled on the debuggee, `0` if the privilege is not found in the privilege collection of the token of the debuggee or something is wrong with the API.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 2]\"}, {\"title\": \"handleclose/closehandle\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The handle value of the handle, in the context of the debuggee.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 8]\"}, {\"title\": \"Plugins\", \"description\": \"Documentation section: plugins\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/plugins\"}, \"subpages\": [{\"title\": \"StartScylla/scylla/imprec\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 0]\"}, {\"title\": \"plugload/pluginload/loadplugin\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Name of the plugin.\", \"result\": \"This command does not set any result variables. \"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 1]\"}, {\"title\": \"plugunload/pluginunload/unloadplugin\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Name of the plugin.\", \"result\": \"This command does not set any result variables. \"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 9]\"}, {\"title\": \"Script\", \"description\": \"Documentation section: script\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/script\"}, \"subpages\": [{\"title\": \"Jxx\", \"description\": null, \"content\": {\"root\": [\"Jxx/IFxx\", \"There are various branches that can react on the flags set by the `cmp` (and maybe other) command(s):\", [\"unconditional branch - `jmp`/`goto`\", \"branch if not equal\\u00a0- `jne`/`ifne(q)`/`jnz`/`ifnz`\", \"branch if equal\\u00a0- `je`/`ife(q)`/`jz`/`ifz`\", \"branch if smaller\\u00a0- `jb`/`ifb`/`jl`/`ifl`\", \"branch if bigger\\u00a0- `ja`/`ifa`/`jg`/`ifg`\", \"branch if smaller/equal\\u00a0- `jbe`/`ifbe(q)`/`jle`/`ifle(q)`\", \"branch if bigger/equal - `jae`/`ifae(q)`/`jge`/`ifge(q)`\"], \"arguments\", \"`arg1` The label to jump to.\", \"result\", \"This command does not set any result variables.\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 0]\"}, {\"title\": \"call\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The label to jump to.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 1]\"}, {\"title\": \"error\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The error message to show.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 2]\"}, {\"title\": \"invalid\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 3]\"}, {\"title\": \"msg\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Message box text. You can use [String Formatting](../../introduction/Formatting.md) here.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 4]\"}, {\"title\": \"msgyn\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Message box text. You can use [String Formatting](../../introduction/Formatting.md) here.\", \"result\": \"The `$result` variable will be set to 1 when the user answered yes. Otherwise it's set to 0.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 5]\"}, {\"title\": \"pause\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 6]\"}, {\"title\": \"printstack[,logstack]\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 7]\"}, {\"title\": \"ret\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 8]\"}, {\"title\": \"scriptcmd\", \"description\": null, \"content\": {\"arguments\": \"Unlike other commands this command forwards everything after `scriptcmd ` directly to the command processor.\\n\\nFor example `scriptcmd add rax, 0x1245` will execute the command `add rax, 0x1234`.\", \"result\": \"This command does not set any result variables.\", \"execution behavior\": \"This command blocks until the specified command completes execution. Script execution is handled by a single dedicated thread, ensuring commands execute in the order they are submitted without interference from other operations.\", \"example\": \"This command can be used in combination with [SetBreakpointCommand](../conditional-breakpoint-control/SetBreakpointCommand.md) to execute scripts on breakpoint callbacks:\\n\\n```\\nfn_addr = module.dll:$0x1234 // module.dll RVA 0x1234\\nbp fn_addr\\nSetBreakpointCommand fn_addr, \\\"scriptcmd call mycallback\\\"\\n\\n// TODO: make sure the script is not unloaded (using run)\\n\\nmycallback:\\nlog \\\"fn({arg.get(0)}, {arg.get(1)})\\\"\\nret\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 9]\"}, {\"title\": \"scriptdll/dllscript\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The filename and path of the script DLL. If a full path is not provided x64dbg will look in the `scripts` directory for the DLL.\", \"results\": \"This command does not set any result variables. However, the script DLL may set any variable.\", \"remarks\": \"A script DLL is a DLL that exports either `AsyncStart()` or `Start()` function.\\n\\nIf the DLL exports `AsyncStart()` function, then x64dbg will call this function on a separate thread. If the DLL exports `Start()` function, then x64dbg will call this function on the current thread, blocking any further command execution until the script DLL finishes execution. If both `AsyncStart()` and `Start()` are exported, only `AsyncStart()` will be executed. Any return value of `AsyncStart()` and `Start()` will not be used by x64dbg.\\n\\nAfter `AsyncStart()` or `Start()` finishes, the script DLL will be unloaded from the process.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 10]\"}, {\"title\": \"scriptexec\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Script file path to load and execute.\", \"result\": \"This command does not set any result variables.\", \"execution behavior\": \"This command blocks until the script completes execution. It performs the following operations:\\n\\n['Loads the specified script file', 'Executes the script from the beginning', 'Automatically unloads the script only if execution completes successfully']\\n\\nScript execution is handled by a single dedicated thread, ensuring that only one script runs at a time.\", \"notes\": [\"Cannot be used from within a running script\", \"If script execution fails or is aborted, the script remains loaded\", \"This is the most convenient way to run standalone scripts\", \"Execution always starts from the beginning of the script\", \"You can use the Script tab context menu to abort a running script if needed\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 11]\"}, {\"title\": \"scriptload\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Script file to load.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 12]\"}, {\"title\": \"scriptrun\", \"description\": null, \"content\": {\"arguments\": \"`arg1` (optional) Line number to stop execution at. If not provided, the script runs until completion.\", \"result\": \"This command does not set any result variables.\", \"execution behavior\": \"This command blocks until the script completes execution, reaches the specified stop line, encounters an error, or is manually aborted. Script execution is handled by a single dedicated thread, ensuring that only one script runs at a time.\", \"prerequisites\": \"A script must be loaded using [`scriptload`](scriptload.md) before using this command.\", \"notes\": [\"Only one script can run at a time\", \"Execution starts from the current script instruction pointer\", \"The script instruction pointer is automatically managed during execution\", \"Use [`scriptabort`](scriptabort.md) to stop a running script\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10, \\\"subpages\\\", 13]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 10]\"}, {\"title\": \"Searching\", \"description\": \"Documentation section: searching\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/searching\"}, \"subpages\": [{\"title\": \"find\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address to start searching from. Notice that the searching will stop when the end of the memory page this address resides in has been reached. This means you cannot search the complete process memory without enumerating the memory pages first. If you want to find all occurrences of a pattern in the entire memory map use [findallmem](./findallmem.md).\\n\\n`arg2` The byte pattern to search for. This byte pattern can contain wildcards (?) for example: `EB0?90??8D`. You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`[arg3]` The size of the data to search in. Default is the size of the memory region.\", \"result\": \"The `$result` variable is set to the virtual address of the address that matches the byte pattern. `$result` will be 0 when the pattern could not be matched.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 0]\"}, {\"title\": \"findall\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address to start searching from. Notice that the searching will stop when the end of the memory page this address resides in has been reached. This means you cannot search the complete process memory without enumerating the memory pages first. You can use [findallmem](./findallmem.md) to search for a pattern in the whole memory.\\n\\n`arg2` The byte pattern to search for. This byte pattern can contain wildcards (?) for example: `EB0?90??8D`. You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`[arg3]` The size of the data to search in. Default is the size of the memory region.\", \"result\": \"`$result` is set to the number of occurrences.\", \"examples\": \"Search for all occurrences a pattern in the memory page CIP is residing:\\n\\n```\\nfindall mem.base(cip), \\\"0FA2 E8 ???????? C3\\\"\\n```\\n\\nSearch for all occurences of the value of cax in the stack memory page:\\n\\n```\\nfindall mem.base(csp), \\\"{bswap@cax}\\\"\\n```\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 1]\"}, {\"title\": \"findallmem/findmemall\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address to start searching from.\\n\\n`arg2` The byte pattern to search for. This byte pattern can contain wildcards (?) for example: `EB0?90??8D`. You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`[arg3]` The size of the data to search in. Default is the entire memory map (`-1`).\\n\\n`[arg4]` Set to `user`/`system`/`module` to only include (user/system) modules in the search.\", \"result\": \"`$result` is set to the number of occurrences.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 2]\"}, {\"title\": \"findasm/asmfind\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Instruction to look for (make sure to use quoted \\\"mov eax, ebx\\\" to ensure you actually search for that instruction). You can use [String Formatting](../../introduction/Formatting.md) here.\\n\\n`[arg2]` Address\\u00a0of/inside a memory page to look in. When not specified CIP will be used.\\n\\n`[arg3]` The size of the data to search in. Default is the size of the memory region.\", \"result\": \"The `$result` variable is set to the number of references found.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 3]\"}, {\"title\": \"findguid/guidfind\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The base of the memory range. If not specified, `RIP` or `EIP` will be used.\\n\\n`[arg2]` The size of the memory range.\\n\\n`[arg3]` The region to search. `0` is current region (specified with arg1 and arg2). `1` is current module (the module specified with arg1). `2` is all modules.\", \"results\": \"Set `$result` to `1` if any GUID is found, `0` otherwise.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 4]\"}, {\"title\": \"modcallfind\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of/inside a memory page to\\u00a0find inter-modular calls in. When not specified EIP/RIP will be used.\\n\\n`[arg2]` The size of the data to search in.\", \"result\": \"The `$result` variable is set to the number of inter-modular calls found.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 5]\"}, {\"title\": \"reffind/findref/ref\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The value to look for.\\n\\n`[arg2]` Address\\u00a0of/inside a memory page to look in. When not specified CIP will be used.\\n\\n`[arg3]` The size of the data to search in.\", \"result\": \"The `$result` variable is set to the number of references found.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 6]\"}, {\"title\": \"reffindrange/findrefrange/refrange\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Start of the range (will be included in the results when found).\\n\\n`[arg2]` End of range (will be included in the results when found). When not specified the first argument will be used.\\n\\n`[arg3]` Address\\u00a0of/inside a memory page to look in. When not specified CIP will be used.\\n\\n`[arg4]` The size of the data to search in.\", \"result\": \"The `$result` variable is set to the number of references found.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 7]\"}, {\"title\": \"refstr/strref\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Address of/inside a memory page to\\u00a0find referenced text\\u00a0strings in. When not specified CIP will be used.\\n\\n`[arg2]` The size of the data to search in.\", \"result\": \"The `$result` variable is set to the number of string references found.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 8]\"}, {\"title\": \"setmaxfindresult/findsetmaxresult\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The maximum number of occurences. The default value is 5000.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11, \\\"subpages\\\", 9]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 11]\"}, {\"title\": \"Thread Control\", \"description\": \"Documentation section: thread-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/thread-control\"}, \"subpages\": [{\"title\": \"createthread[,threadcreate,newthread,threadnew]\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The entry of the new thread.\\n\\n`[arg2]` The argument of the new thread. If the argument is not specified, the default argument is 0.\", \"results\": \"`$result` will be set to the thread id of the new thread.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 0]\"}, {\"title\": \"killthread/threadkill\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` ThreadId of the thread to kill (see the Threads tab). When not specified, the main thread is used.\\n\\n`[arg2]` Thread exit code. When not specified, 0 will be used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 1]\"}, {\"title\": \"resumeallthreads/threadresumeall\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 2]\"}, {\"title\": \"resumethread/threadresume\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` ThreadId of the thread to resume (see the Threads tab). When not specified, the main thread is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 3]\"}, {\"title\": \"setthreadname/threadsetname\", \"description\": null, \"content\": {\"arguments\": \"`arg1` ThreadId of the thread to\\u00a0change the priority of\\u00a0(see the Threads tab).\\n\\n`arg2` New thread name. Leave empty to remove the current name.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 4]\"}, {\"title\": \"setthreadpriority/setprioritythread/threadsetpriority\", \"description\": null, \"content\": {\"arguments\": \"`arg1` ThreadId of the thread to\\u00a0change the priority of\\u00a0(see the Threads tab).\\n\\n`arg2` Priority value, this can be the integer of a valid thread priority (see MSDN)\\u00a0or\\u00a0one of the following values: \\\"Normal\\\", \\\"AboveNormal\\\", \\\"TimeCritical\\\", \\\"Idle\\\", \\\"BelowNormal\\\", \\\"Highest\\\", \\\"Lowest\\\".\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 5]\"}, {\"title\": \"suspendallthreads/threadsuspendall\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 6]\"}, {\"title\": \"suspendthread/threadsuspend\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` ThreadId of the thread to suspend (see the Threads tab). When not specified, the main thread is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 7]\"}, {\"title\": \"switchthread/threadswitch\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` ThreadId of the thread to switch to (see the Threads tab). When not specified, the main thread is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12, \\\"subpages\\\", 8]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 12]\"}, {\"title\": \"Tracing\", \"description\": \"Documentation section: tracing\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/tracing\"}, \"subpages\": [{\"title\": \"RunToParty\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The party number. This value cannot be an expression. Note: `0` is user module, `1` is system module.\", \"results\": \"This command does not set any result variables.\", \"see also\": \"[RunToUserCode](RunToUserCode.md)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 0]\"}, {\"title\": \"RunToUserCode/rtu\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 1]\"}, {\"title\": \"StartTraceRecording/StartRunTrace/opentrace\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The file name. Default file extension \\\"trace32\\\" or \\\"trace64\\\" is not added automatically.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 2]\"}, {\"title\": \"StopTraceRecording/StopRunTrace/tc\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 3]\"}, {\"title\": \"TraceIntoBeyondTraceCoverage/TraceIntoBeyondTraceRecord/tibt\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The break condition of tracing. When this condition is satisfied, tracing will stop regardless of `EIP`/`RIP` location. If this argument is not specified then tracing will be unconditional.\\n\\n`[arg2]` The maximun steps before the debugger gives up. If this argument is not specified, the default value will be 50000.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 4]\"}, {\"title\": \"TraceIntoConditional/ticnd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The condition used. When this is evaluated to be a value other than 0, tracing will stop.\\n\\n`[arg2]` The maximum step count to trace before the debugger gives up.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 5]\"}, {\"title\": \"TraceIntoIntoTraceCoverage/TraceIntoIntoTraceRecord/tiit\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The break condition of tracing. When this condition is satisfied, tracing will stop regardless of `EIP`/`RIP` location. If this argument is not specified then tracing will be unconditional.\\n\\n`[arg2]` The maximun steps before the debugger gives up. If this argument is not specified, the default value will be 50000.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 6]\"}, {\"title\": \"TraceOverBeyondTraceCoverage,TraceOverBeyondTraceRecord/tobt\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The break condition of tracing. When this condition is satisfied, tracing will stop regardless of `EIP`/`RIP` location. If this argument is not specified then tracing will be unconditional.\\n\\n`[arg2]` The maximun steps before the debugger gives up. If this argument is not specified, the default value will be 50000.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 7]\"}, {\"title\": \"TraceOverConditional/tocnd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The condition used. When this is evaluated to be a value other than 0, tracing will stop.\\n\\n`[arg2]` The maximum step count to trace before the debugger gives up.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 8]\"}, {\"title\": \"TraceOverIntoTraceCoverage/TraceOverIntoTraceRecord/toit\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The break condition of tracing. When this condition is satisfied, tracing will stop regardless of `EIP`/`RIP` location. If this argument is not specified then tracing will be unconditional.\\n\\n`[arg2]` The maximun steps before the debugger gives up. If this argument is not specified, the default value will be 50000.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 9]\"}, {\"title\": \"TraceSetCommand/SetTraceCommand\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Command text. If not specified the current text/condition is cleared.\\n\\n`[arg2]` Command condition. If not specified the default condition is used.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 10]\"}, {\"title\": \"TraceSetLog/SetTraceLog\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Log text. If not specified the current text/condition is cleared.\\n\\n`[arg2]` Log condition. If not specified the default condition is used.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 11]\"}, {\"title\": \"TraceSetLogFile/SetTraceLogFile\", \"description\": null, \"content\": {\"arguments\": \"`arg1` File name to redirect the trace log to. This file will be cleared and overwritten when the trace starts. **This does nothing if you don't set the log text!**\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13, \\\"subpages\\\", 12]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 13]\"}, {\"title\": \"Types\", \"description\": \"Documentation section: types\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/types\"}, \"subpages\": [{\"title\": \"AddArg\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type name of the function (parent).\\n\\n`arg2` The type of the new argument.\\n\\n`arg3` The name of the new argument.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 0]\"}, {\"title\": \"AddFunction\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type name of the function.\\n\\n`arg2` The return type.\\n\\n`[arg3]` Calling convention, choose between `cdecl`, `stdcall`, `thiscall` and `delphi`.\\n\\n`[arg4]` Set to nonzero to mark this function as `noreturn`.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 1]\"}, {\"title\": \"AddMember\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type name of the struct/union (parent).\\n\\n`arg2` The type of the new member.\\n\\n`arg3` The name of the new member.\\n\\n`[arg4]` The array size. A value greater than zero will make this member an array.\\n\\n`[arg5]` Offset from the start of the structure, only use this for implicitly padded structures. Overlapping with other members is **not** allowed.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 2]\"}, {\"title\": \"AddStruct\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type name of the struct.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 3]\"}, {\"title\": \"AddType\", \"description\": null, \"content\": {\"arguments\": \"`arg1` An existing type.\\n\\n`arg2` The new type alias.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 4]\"}, {\"title\": \"AddUnion\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type name of the union.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 5]\"}, {\"title\": \"AppendArg\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type of the new argument.\\n\\n`arg2` The name of the new argument.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 6]\"}, {\"title\": \"AppendMember\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type of the new member.\\n\\n`arg2` The name of the new member.\\n\\n`[arg3]` The array size. A value greater than zero will make this member an array.\\n\\n`[arg4]` Offset from the start of the structure, only use this for implicitly padded structures. Overlapping with other members is **not** allowed.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 7]\"}, {\"title\": \"ClearTypes\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` The owner to clear. Leave this empty unless you know what you're doing.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 8]\"}, {\"title\": \"DataAscii/da\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 9]\"}, {\"title\": \"DataByte/db\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 10]\"}, {\"title\": \"DataCode/dc\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 11]\"}, {\"title\": \"DataDouble/DataReal8\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 12]\"}, {\"title\": \"DataDword/dw\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 13]\"}, {\"title\": \"DataFloat/DataReal4/df\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 14]\"}, {\"title\": \"DataFword\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 15]\"}, {\"title\": \"DataJunk\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 16]\"}, {\"title\": \"DataLongdouble/DataReal10\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 17]\"}, {\"title\": \"DataMiddle\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 18]\"}, {\"title\": \"DataMmword\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 19]\"}, {\"title\": \"DataOword\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 20]\"}, {\"title\": \"DataQword/dq\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 21]\"}, {\"title\": \"DataTbyte\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 22]\"}, {\"title\": \"DataUnicode/du\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 23]\"}, {\"title\": \"DataUnknown\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 24]\"}, {\"title\": \"DataWord/dw\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 25]\"}, {\"title\": \"DataXmmword\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 26]\"}, {\"title\": \"DataYmmword\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The address you want to mark.\\n\\n`[arg2]` Size (in bytes) to mark, when not set this defaults to 1.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 27]\"}, {\"title\": \"EnumTypes\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 28]\"}, {\"title\": \"LoadTypes\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The path to the JSON file. The owner of the loaded types will be the filename of the JSON file. Any types previously defined with this owner will be removed.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 29]\"}, {\"title\": \"ParseTypes\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The path to the header file. The owner of the loaded types will be the filename of the header file. Any types previously defined with this owner will be removed.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 30]\"}, {\"title\": \"RemoveType\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type to remove.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 31]\"}, {\"title\": \"SizeofType\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Name of the type.\", \"result\": \"This command will set `$result` to the size of the type.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 32]\"}, {\"title\": \"VisitType/DisplayType/dt\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The type to display.\\n\\n`[arg2]` Address to print from. If not specified (or zero) the type will be printed without values.\\n\\n`[arg3]` Maximum pointer resolution depth. This can be used to also display structures (and values) pointed to by members of the type you are visiting. If not specified or negative, it will default to 2 (configurable with `[Engine].DefaultTypePtrDepth`).\\n\\n`[arg4]` Name of the variable. If not specified it will default to an empty string.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14, \\\"subpages\\\", 33]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 14]\"}, {\"title\": \"User Database\", \"description\": \"Documentation section: user-database\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/user-database\"}, \"subpages\": [{\"title\": \"argumentadd\", \"description\": null, \"content\": {\"arguments\": \"`arg1` argument range start.\\n\\n`arg2` argument range end.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 0]\"}, {\"title\": \"argumentclear\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 1]\"}, {\"title\": \"argumentdel\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address inside the argument range\\u00a0to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 2]\"}, {\"title\": \"argumentlist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"`$result` will be set to the number of user-defined arguments.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 3]\"}, {\"title\": \"bookmarkclear\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 4]\"}, {\"title\": \"bookmarkdel/bookmarkc\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address of the bookmark to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 5]\"}, {\"title\": \"bookmarklist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"`$result` will be set to the number of user-defined bookmarks.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 6]\"}, {\"title\": \"bookmarkset/bookmark\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to set the bookmark at (preferably inside a module).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 7]\"}, {\"title\": \"commentclear\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 8]\"}, {\"title\": \"commentdel/cmtc/cmtdel\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address of the comment to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 9]\"}, {\"title\": \"commentlist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"`$result` will be set to the number of user-defined comments.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 10]\"}, {\"title\": \"commentset/cmt/cmtset\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to set the comment at (preferably inside a module).\\n\\n`arg2` Comment text.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 11]\"}, {\"title\": \"dbclear/cleardb\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 12]\"}, {\"title\": \"dbload/loaddb\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Path to load the database from. If specified your current data will not be automatically cleared (import). If not specified all your data will be cleared and the current program database is reloaded from disk.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 13]\"}, {\"title\": \"dbsave/savedb\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Path to save the database to. If not specified your current program database is used.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 14]\"}, {\"title\": \"functionadd/func\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Function range start.\\n\\n`arg2` Function range end.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 15]\"}, {\"title\": \"functionclear\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 16]\"}, {\"title\": \"functiondel/funcc\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address inside the function range\\u00a0to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 17]\"}, {\"title\": \"functionlist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"`$result` will be set to the number of user-defined functions.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 18]\"}, {\"title\": \"labelclear\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 19]\"}, {\"title\": \"labeldel/lblc/lbldel\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address of the label to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 20]\"}, {\"title\": \"labellist\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"result\": \"`$result` will be set to the number of user-defined labels.\", \"remarks\": \"The contents of the reference view can be iterated in a script with the `ref.addr` [expression function](../../introduction/Expression-functions.md):\\n\\n```\\ni = 0\\nloop:\\n addr = ref.addr(i)\\n log \\\"reference {d:i} = {p:addr}\\\"\\n i++\\n cmp i, ref.count()\\n jne loop\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 21]\"}, {\"title\": \"labelset/lbl/lblset\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Address to set the label at (preferably inside a module).\\n\\n`arg2` Label text. You can use [String Formatting](../../introduction/Formatting.md) here.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15, \\\"subpages\\\", 22]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 15]\"}, {\"title\": \"Variables\", \"description\": \"Documentation section: variables\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/variables\"}, \"subpages\": [{\"title\": \"var/varnew\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Variable name (will be prefixed with '$' if not done).\\n\\n`[arg2]` Initial variable value (see console input for details).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 0]\"}, {\"title\": \"vardel\", \"description\": null, \"content\": {\"arguments\": \"`arg1` Name of the variable to delete ($ will be prepended when not present).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 1]\"}, {\"title\": \"varlist\", \"description\": null, \"content\": {\"arguments\": \"`[arg1]` Filter (USER, SYSTEM, READONLY).\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 16]\"}, {\"title\": \"Watch Control\", \"description\": \"Documentation section: watch-control\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/commands/watch-control\"}, \"subpages\": [{\"title\": \"AddWatch\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The expression to watch.\\n\\n`[arg2]` The data type of the watch item. `uint` displays hexadecimal value, `int` displays signed decimal value, `ascii` displays the ASCII string pointed by the value. `unicode` displays the Unicode string pointed by the value. `uint` is the default type.\", \"results\": \"This command sets `$result` value to the id of the watch item.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 0]\"}, {\"title\": \"CheckWatchdog\", \"description\": null, \"content\": {\"arguments\": \"This command has no arguments.\", \"results\": \"This command set `$result` to 1 if any watchdog is triggered, 0 otherwise.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 1]\"}, {\"title\": \"DelWatch\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The id of the watch item to delete.\", \"result\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 2]\"}, {\"title\": \"SetWatchExpression\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The id of the watch item.\\n\\n`arg2` The new expression to watch.\\n\\n`arg3` The new data type of the watch item.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 3]\"}, {\"title\": \"SetWatchName\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The id of the watch item to rename.\\n\\n`arg2` The new name.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 4]\"}, {\"title\": \"SetWatchdog\", \"description\": null, \"content\": {\"arguments\": \"`arg1` The id of the watch item.\\n\\n`[arg2]` The watchdog mode. Possible values:\\n\\n['disabled : Watchdog is disabled.', 'changed : Watchdog is triggered when the value is changed.', 'unchanged : Watchdog is triggered when the value is not changed.', 'istrue : Watchdog is triggered when the value is not 0.', 'isfalse : Watchdog is triggered when the value is 0.']\\n\\nWhen this argument is not specified, the mode will be set to \\\"changed\\\" if the current watchdog mode is \\\"disabled\\\", otherwise watchdog will be disabled.\", \"results\": \"This command does not set any result variables.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17, \\\"subpages\\\", 5]\"}], \"path\": \"[\\\"subpages\\\", 3, \\\"subpages\\\", 17]\"}], \"path\": \"[\\\"subpages\\\", 3]\"}, {\"title\": \"Developers\", \"description\": \"Documentation section: developers\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers\"}, \"subpages\": [{\"title\": \"x64dbg trace file format specification\", \"description\": null, \"content\": {\"Magic word\": \"Every trace file will begin with 4 bytes, \\\"TRAC\\\" (encoded in ASCII).\", \"Header\": \"Header is located after header at offset 4. It is composed of a 4-byte length field, followed by a JSON blob. The JSON blob might not be null-terminated and might not be aligned to 4-byte boundary.\", \"Binary trace blocks\": \"Binary trace data is immediately after header without any padding and might not be aligned to 4-byte boundary. It is defined as a sequence of blocks. Currently, only block type 0 is defined.\\n\\nEvery block is started with a 1-byte type number. This type number must be 0, which means it is a block that describes an instruction traced.\\n\\nIf the type number is 0, then the block will contain the following data:\\n\\n```\\nstruct {\\n uint8_t BlockType; //BlockType is 0, indicating it describes an instruction execution.\\n uint8_t RegisterChanges;\\n uint8_t MemoryAccesses;\\n uint8_t BlockFlagsAndOpcodeSize; //Bitfield\\n\\n DWORD ThreadId;\\n uint8_t Opcode[];\\n\\n uint8_t RegisterChangePosition[];\\n duint RegisterChangeNewData[];\\n\\n uint8_t MemoryAccessFlags[];\\n duint MemoryAccessAddress[];\\n duint MemoryAccessOldData[];\\n duint MemoryAccessNewData[];\\n};\\n```\\n\\n`RegisterChanges` is a unsigned byte that counts the number of elements in the array `RegisterChangePosition` and `RegisterChangeNewData`.\\n\\n`MemoryAccesses` is a unsigned byte that counts the number of elements in the array `MemoryAccessFlags`.\\n\\n`BlockFlagsAndOpcodeSize` is a bitfield. The most significant bit is ThreadId bit. When this bit is set, `ThreadId` field is available and indicates the thread id which executed the instruction. When this bit is clear, the thread id that executed the instruction is the same as last instruction, so it is not stored in file. The least 4 significant bits specify the length of `Opcode` field, in number of bytes. Other bits are reserved and set to 0. `Opcode` field contains the opcode of current instruction.\\n\\n`RegisterChangePosition` is an array of unsigned bytes. Each element indicates a pointer-sized integer in struct `REGDUMP` that is updated after execution of current instruction, as an offset to previous location. The absolute index is computed by adding the absolute index of previous element +1 (or 0 if it is first element) with this relative index. `RegisterChangeNewData` is an array of pointer-sized integers that contains the new value of register, that is recorded before the instruction is executed. `REGDUMP` structure is given below.\\n\\n```\\ntypedef struct\\n{\\n REGISTERCONTEXT regcontext;\\n FLAGS flags;\\n X87FPUREGISTER x87FPURegisters[8];\\n unsigned long long mmx[8];\\n MXCSRFIELDS MxCsrFields;\\n X87STATUSWORDFIELDS x87StatusWordFields;\\n X87CONTROLWORDFIELDS x87ControlWordFields;\\n LASTERROR lastError;\\n //LASTSTATUS lastStatus; //This field is not supported and not included in trace file.\\n} REGDUMP;\\n```\\n\\nFor example, `ccx` is the second member of `regcontext`. On x64 architecture, it is at byte offset 8 and on x86 architecture it is at byte offset 4. On both architectures, it is at index 1 and `cax` is at index 0. Therefore, when `RegisterChangePosition[0]` = 0, `RegisterChangeNewData[0]` contains the new value of `cax`. If `RegisterChangePosition[1]` = 0, `RegisterChangeNewData[1]` contains the new value of `ccx`, since the absolute index is computed by 0+0+1=1. The use of relative indexing helps achieve better data compression if a lossless compression is then applied to trace file, and also allow future expansion of `REGDUMP` structure without increasing size of `RegisterChanges` and `RegisterChangePosition` beyond a byte. Note: the file reader can locate the address of the instruction using `cip` register in this structure.\\n\\nx64dbg will save all registers at the start of trace, and every 512 instructions (this number might be changed in future versions to have different tradeoff between speed and space). A block with all registers saved will have `RegisterChanges`=172 on 64-bit platform and 216 on 32-bit platform. This allows x64dbg trace file to be randomly accessed. x64dbg might be unable to open a trace file that has a sequence of instruction longer than an implementation-defined limit without all registers saved.\\n\\n`MemoryAccessFlags` is an array of bytes that indicates properties of memory access. Currently, only bit 0 is defined and all other bits are reserved and set to 0. When bit 0 is set, it indicates the memory is not changed (This could mean it is read, or it is overwritten with identical value), so `MemoryAccessNewData` will not have an entry for this memory access. The file reader may use a disassembler to determine the true type of memory access.\\n\\n`MemoryAccessAddress` is an array of pointers that indicates the address of memory access.\\n\\n`MemoryAccessOldData` is an array of pointer-sized integers that stores the old content of memory.\\n\\n`MemoryAccessNewData` is an array of pointer-sized integers that stores the new content of memory.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 0]\"}, {\"title\": \"Functions\", \"description\": \"Documentation section: functions\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers/functions\"}, \"subpages\": [{\"title\": \"Bridge\", \"description\": \"Documentation section: bridge\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers/functions/bridge\"}, \"subpages\": [{\"title\": \"BridgeAlloc\", \"description\": null, \"content\": {\"Parameters\": \"`size` Memory size (in bytes) to allocate.\", \"Return Value\": \"Returns a pointer to the memory block allocated. If an error occurs allocating memory, then x64dbg is closed down.\", \"Example\": \"```\\nauto ptr = (char*)BridgeAlloc(128);\\n//do something with ptr\\nBridgeFree(ptr);\\n```\", \"Related functions\": [\"[BridgeFree](./BridgeFree.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}, {\"title\": \"BridgeFree\", \"description\": null, \"content\": {\"Parameters\": \"`ptr` Pointer to memory block to free\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nauto ptr = (char*)BridgeAlloc(128);\\n//do something with ptr\\nBridgeFree(ptr);\\n```\", \"Related functions\": [\"[BridgeAlloc](./BridgeAlloc.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 1]\"}, {\"title\": \"BridgeGetDbgVersion\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"Return an integer value representing the version of the x64dbg.\", \"Example\": \"```\\nint version = BridgeGetDbgVersion();\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 2]\"}, {\"title\": \"BridgeInit\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"Returns 0 if successful, otherwise a string indicating the error that occured.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 3]\"}, {\"title\": \"BridgeSettingFlush\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[BridgeSettingGet](./BridgeSettingGet.md)\", \"[BridgeSettingGetUint](./BridgeSettingGetUint.md)\", \"[BridgeSettingSet](./BridgeSettingSet.md)\", \"[BridgeSettingSetUint](./BridgeSettingSetUint.md)\", \"[BridgeSettingRead](./BridgeSettingRead.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 4]\"}, {\"title\": \"BridgeSettingGet\", \"description\": null, \"content\": {\"Parameters\": \"`section` Section name to read.\\n\\n`key` Key in the section to read.\\n\\n`value` Destination buffer. Should be of `MAX_SETTING_SIZE`.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 5]\"}, {\"title\": \"BridgeSettingGetUint\", \"description\": null, \"content\": {\"Parameters\": \"`section` Section name to read.\\n\\n`key` Key in the section to read.\\n\\n`value` Destination value.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 6]\"}, {\"title\": \"BridgeSettingRead\", \"description\": null, \"content\": {\"Parameters\": \"`errorLine` Line that error occurred on.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 7]\"}, {\"title\": \"BridgeSettingSet\", \"description\": null, \"content\": {\"Parameters\": \"`section` Section name to write to.\\n\\n`key` Key in the section to write.\\n\\n`value` New setting value.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 8]\"}, {\"title\": \"BridgeSettingSetUint\", \"description\": null, \"content\": {\"Parameters\": \"`section` Section name to read.\\n\\n`key` Key in the section to read.\\n\\n`value` New value.\", \"Return Value\": \"This function returns true if successful or false otherwise.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 9]\"}, {\"title\": \"BridgeStart\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0, \\\"subpages\\\", 10]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Debug\", \"description\": \"Documentation section: debug\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers/functions/debug\"}, \"subpages\": [{\"title\": \"DbgArgumentAdd\", \"description\": null, \"content\": {\"Parameters\": \"`start` first address of the argument range.\\n\\n`end` last address of the argument range.\", \"Return Value\": \"The function return TRUE if argument is successfully setted or FALSE otherwise.\", \"Example\": \"```\\nif(DbgArgumentAdd(0x00401000, 0x00401013))\\n GuiAddLogMessage(\\\"Argument successfully setted\\\\r\\\\n\\\");\\nelse\\n GuiAddLogMessage(\\\"Argument couldn't be set\\\\r\\\\n\\\");\\n```\", \"Related functions\": [\"DbgArgumentDel\", \"DbgArgumentGet\", \"DbgArgumentOverlaps\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"DbgArgumentDel\", \"description\": null, \"content\": {\"Parameters\": \"`addr` Address of the argument to delete.\", \"Return Value\": \"The function return TRUE if argument is successfully deleted or FALSE otherwise.\", \"Example\": \"```\\nif(DbgArgumentDel(0x00401013))\\n GuiAddLogMessage(\\\"Argument successfully deleted\\\\r\\\\n\\\");\\nelse\\n GuiAddLogMessage(\\\"Argument couldn't be deleted\\\\r\\\\n\\\");\\n```\", \"Related functions\": [\"DbgArgumentAdd\", \"DbgArgumentGet\", \"DbgArgumentOverlaps\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"DbgArgumentGet\", \"description\": null, \"content\": {\"Parameters\": \"`addr` Address of the argument to fetch.\\n\\n`start` Pointer to a duint variable that will hold the start address of the argument.\\n\\n`end` Pointer to a duint variable that will hold the end address of the argument.\", \"Return Value\": \"The function return TRUE if the start and end addresses are found or FALSE otherwise. If TRUE, the variables `start` and `end` will hold the fetched values.\", \"Example\": \"```\\nduint start;\\nduint end;\\nstd::string message;\\n\\nif(DbgArgumentGet(0x00401000, &start, &end))\\n{\\n sprintf_s(message.c_str(), MAX_PATH, \\\"Argument range: %08X-%08X\\\\r\\\\n\\\", start, end);\\n GuiAddLogMessage(message);\\n}\\nelse\\n{\\n GuiAddLogMessage(\\\"Argument start and end addresses couldn't be get\\\\r\\\\n\\\");\\n}\\n```\", \"Related functions\": [\"DbgArgumentAdd\", \"DbgArgumentDel\", \"DbgArgumentOverlaps\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \"DbgArgumentOverlaps\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}, {\"title\": \"DbgAssembleAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 4]\"}, {\"title\": \"DbgClearAutoBookmarkRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 5]\"}, {\"title\": \"DbgClearAutoCommentRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 6]\"}, {\"title\": \"DbgClearAutoFunctionRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 7]\"}, {\"title\": \"DbgClearAutoLabelRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 8]\"}, {\"title\": \"DbgClearBookmarkRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 9]\"}, {\"title\": \"DbgClearCommentRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 10]\"}, {\"title\": \"DbgClearLabelRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 11]\"}, {\"title\": \"DbgCmdExec\", \"description\": null, \"content\": {\"Parameters\": \"`cmd` The command string in UTF-8 encoding\", \"Return Value\": \"`true` if the command is sent to the command processing thread for asynchronous execution, `false` otherwise.\", \"Example\": \"```\\nDbgCmdExec(\\\"run\\\");\\n```\", \"Related functions\": [\"[DbgCmdExecDirect](./DbgCmdExecDirect.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 12]\"}, {\"title\": \"DbgCmdExecDirect\", \"description\": null, \"content\": {\"Parameters\": \"`cmd` The command string in UTF-8 encoding\", \"Return Value\": \"`true` if the command is executed successfully, `false` otherwise.\", \"Example\": \"```\\nDbgCmdExecDirect(\\\"run\\\");\\n```\", \"Related functions\": [\"[DbgCmdExec](./DbgCmdExec.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 13]\"}, {\"title\": \"DbgDelEncodeTypeRange\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 14]\"}, {\"title\": \"DbgDelEncodeTypeSegment\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 15]\"}, {\"title\": \"DbgDisasmAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 16]\"}, {\"title\": \"DbgDisasmFastAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 17]\"}, {\"title\": \"DbgExit\", \"description\": null, \"content\": {\"Parameters\": \"No parameters\", \"Return Value\": \"No return value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 18]\"}, {\"title\": \"DbgFunctionAdd\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 19]\"}, {\"title\": \"DbgFunctionDel\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 20]\"}, {\"title\": \"DbgFunctionGet\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 21]\"}, {\"title\": \"DbgFunctionOverlaps\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 22]\"}, {\"title\": \"DbgFunctions\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 23]\"}, {\"title\": \"DbgGetArgTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 24]\"}, {\"title\": \"DbgGetBookmarkAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 25]\"}, {\"title\": \"DbgGetBpList\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 26]\"}, {\"title\": \"DbgGetBpxTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 27]\"}, {\"title\": \"DbgGetBranchDestination\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 28]\"}, {\"title\": \"DbgGetCommentAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 29]\"}, {\"title\": \"DbgGetEncodeSizeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 30]\"}, {\"title\": \"DbgGetEncodeTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 31]\"}, {\"title\": \"DbgGetEncodeTypeBuffer\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 32]\"}, {\"title\": \"DbgGetFunctionTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 33]\"}, {\"title\": \"DbgGetLabelAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 34]\"}, {\"title\": \"DbgGetLoopTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 35]\"}, {\"title\": \"DbgGetModuleAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 36]\"}, {\"title\": \"DbgGetRegDump\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 37]\"}, {\"title\": \"DbgGetStringAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 38]\"}, {\"title\": \"DbgGetThreadList\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 39]\"}, {\"title\": \"DbgGetTimeWastedCounter\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 40]\"}, {\"title\": \"DbgGetWatchList\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 41]\"}, {\"title\": \"DbgGetXrefCountAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 42]\"}, {\"title\": \"DbgGetXrefTypeAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 43]\"}, {\"title\": \"DbgInit\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 44]\"}, {\"title\": \"DbgIsBpDisabled\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 45]\"}, {\"title\": \"DbgIsDebugging\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function returns true if x64dbg is currently debugging, or false otherwise.\", \"Example\": \"```\\nif(!DbgIsDebugging())\\n{\\n GuiAddLogMessage(\\\"You need to be debugging to use this option!\\\\n\\\");\\n return false;\\n}\\n```\\n\\n```\\n.data\\nszMsg db \\\"You need to be debugging to use this option!\\\",13,10,0 ; CRLF\\n \\n.code\\nInvoke DbgIsDebugging\\n.IF eax == FALSE\\n Invoke GuiAddLogMessage, Addr szMsg\\n.ENDIF\\n```\", \"Related functions\": [\"[DbgIsRunning](./DbgIsRunning.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 46]\"}, {\"title\": \"DbgIsJumpGoingToExecute\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 47]\"}, {\"title\": \"DbgIsRunLocked\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 48]\"}, {\"title\": \"DbgIsRunning\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 49]\"}, {\"title\": \"DbgIsValidExpression\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 50]\"}, {\"title\": \"DbgLoopAdd\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 51]\"}, {\"title\": \"DbgLoopDel\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 52]\"}, {\"title\": \"DbgLoopGet\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 53]\"}, {\"title\": \"DbgLoopOverlaps\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 54]\"}, {\"title\": \"DbgMemFindBaseAddr\", \"description\": null, \"content\": {\"Parameters\": \"`addr` Virtual address which is in a specific module. <br>\\n`size` Pointer, which will, on success, hold the module size.\", \"Return Value\": \"On success, returns the virtual address of a specific module. <br>\\nOn failure, it will return 0.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[DbgMemGetPageSize](./DbgMemGetPageSize.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 55]\"}, {\"title\": \"DbgMemGetPageSize\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"Get page base and size of selected instruction.\\n\\n```\\n SELECTIONDATA sel; // Define Address the slected line in the Disassembly window ( begin , End )\\n GuiSelectionGet(GUI_DISASSEMBLY, &sel); // Get the value of sel(begin addr , End addr )\\n duint pagesize = DbgMemGetPageSize(sel.start); // get the page size of the section from the selected memory addr\\n //Or use the following statement to get page base and size in one call.\\n duint sctionbase = DbgMemFindBaseAddr(sel.start, &pagesize); // get the base of this section ( begin addr of the section )\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 56]\"}, {\"title\": \"DbgMemIsValidReadPtr\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 57]\"}, {\"title\": \"DbgMemMap\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 58]\"}, {\"title\": \"DbgMemRead\", \"description\": null, \"content\": {\"Parameters\": \"`va` Virtual address to source<br>\\n`dest` Pointer to pre allocated buffer of size `size`<br>\\n`size` Number of bytes that should be read\", \"Return Value\": \"Returns true on success.\", \"Example\": \"```\\n// read user selected data from disassembly window\\nSELECTIONDATA sel;\\nGuiSelectionGet(GUI_DISASSEMBLY, &sel);\\nuint16_t size = sel.end - sel.start + 1;\\nuint8_t* dest = new uint8_t[size];\\nbool success = DbgMemRead(sel.start, dest, size);\\n// on success, the selected data is stored in dest\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 59]\"}, {\"title\": \"DbgMemWrite\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 60]\"}, {\"title\": \"DbgMenuEntryClicked\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 61]\"}, {\"title\": \"DbgModBaseFromName\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 62]\"}, {\"title\": \"DbgReleaseEncodeTypeBuffer\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 63]\"}, {\"title\": \"DbgScriptAbort\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 64]\"}, {\"title\": \"DbgScriptBpGet\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 65]\"}, {\"title\": \"DbgScriptBpToggle\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 66]\"}, {\"title\": \"DbgScriptCmdExec\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 67]\"}, {\"title\": \"DbgScriptGetBranchInfo\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 68]\"}, {\"title\": \"DbgScriptGetLineType\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 69]\"}, {\"title\": \"DbgScriptLoad\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 70]\"}, {\"title\": \"DbgScriptRun\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 71]\"}, {\"title\": \"DbgScriptSetIp\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 72]\"}, {\"title\": \"DbgScriptStep\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 73]\"}, {\"title\": \"DbgScriptUnload\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 74]\"}, {\"title\": \"DbgSetAutoBookmarkAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 75]\"}, {\"title\": \"DbgSetAutoCommentAt\", \"description\": null, \"content\": {\"Parameters\": \"`addr` The address to comment.\\n\\n`text` The auto comment in UTF-8 encoding.\", \"Return Value\": \"`true` if the function is successful, `false` otherwise.\", \"Example\": \"```\\nDbgSetAutoCommentAt(DbgValFromString(\\\"dis.sel()\\\"), \\\"This is the currently selected instruction\\\");\\n```\", \"Related functions\": [\"[DbgSetCommentAt](./DbgSetCommentAt.md)\", \"[DbgSetAutoLabelAt](./DbgSetAutoLabelAt.md)\", \"[DbgSetAutoBookmarkAt](./DbgSetAutoBookmarkAt.md)\", \"[DbgSetLabelAt](./DbgSetLabelAt.md)\", \"[DbgSetBookmarkAt](./DbgSetBookmarkAt.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 76]\"}, {\"title\": \"DbgSetAutoFunctionAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 77]\"}, {\"title\": \"DbgSetAutoLabelAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 78]\"}, {\"title\": \"DbgSetBookmarkAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 79]\"}, {\"title\": \"DbgSetCommentAt\", \"description\": null, \"content\": {\"Parameters\": \"`addr` The address to comment.\\n\\n`text` The comment in UTF-8 encoding.\", \"Return Value\": \"`true` if the function is successful, `false` otherwise.\", \"Example\": \"```\\nDbgSetCommentAt(DbgValFromString(\\\"dis.sel()\\\"), \\\"This is the currently selected instruction\\\");\\n```\", \"Related functions\": [\"[DbgSetAutoCommentAt](./DbgSetAutoCommentAt.md)\", \"[DbgSetAutoLabelAt](./DbgSetAutoLabelAt.md)\", \"[DbgSetAutoBookmarkAt](./DbgSetAutoBookmarkAt.md)\", \"[DbgSetLabelAt](./DbgSetLabelAt.md)\", \"[DbgSetBookmarkAt](./DbgSetBookmarkAt.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 80]\"}, {\"title\": \"DbgSetEncodeType\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 81]\"}, {\"title\": \"DbgSetLabelAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 82]\"}, {\"title\": \"DbgSettingsUpdated\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 83]\"}, {\"title\": \"DbgStackCommentGet\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 84]\"}, {\"title\": \"DbgSymbolEnum\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 85]\"}, {\"title\": \"DbgSymbolEnumFromCache\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 86]\"}, {\"title\": \"DbgValFromString\", \"description\": null, \"content\": {\"Parameters\": \"`string` The [expression](../../../introduction/Expressions.md) to evaluate in UTF-8 encoding.\", \"Return Value\": \"The value of the expression.\", \"Example\": \"```\\neip = DbgValFromString(\\\"cip\\\");\\n```\", \"Related functions\": [\"[DbgValToString](./DbgValToString.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 87]\"}, {\"title\": \"DbgValToString\", \"description\": null, \"content\": {\"Parameters\": \"`string` The name of the thing to set in UTF-8 encoding.\\n\\n`value` The value to set.\", \"Return Value\": \"`true` if the value was set successfully, `false` otherwise.\", \"Example\": \"```\\nDbgValToString(\\\"eax\\\", 1);\\n```\", \"Related functions\": [\"[DbgValFromString](./DbgValFromString.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 88]\"}, {\"title\": \"DbgWinEvent\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 89]\"}, {\"title\": \"DbgWinEventGlobal\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 90]\"}, {\"title\": \"DbgXrefAdd\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 91]\"}, {\"title\": \"DbgXrefDelAll\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 92]\"}, {\"title\": \"DbgXrefGet\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1, \\\"subpages\\\", 93]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers/functions/gui\"}, \"subpages\": [{\"title\": \"GuiAddLogMessage\", \"description\": null, \"content\": {\"Parameters\": \"`msg` String containing the message to add to the log. Ensure that a carriage line and return feed are included with the string for it to properly display it. Encoding is UTF-8.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiAddLogMessage(\\\"This text will be displayed in the log view.\\\\n\\\");\\n```\\n\\n```\\n.data\\nszMsg db \\\"This text will be displayed in the log view\\\",13,10,0 ; CRLF\\n \\n.code\\nInvoke GuiAddLogMessage, Addr szMsg\\n```\", \"Related functions\": [\"[GuiAddLogMessageHtml](./GuiAddLogMessageHtml.md)\", \"[GuiLogClear](./GuiLogClear.md)\", \"[GuiAddStatusBarMessage](./GuiAddStatusBarMessage.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"GuiAddLogMessageHtml\", \"description\": null, \"content\": {\"Parameters\": \"`msg` String containing the HTML-formatted message to add to the log. Ensure that a carriage line and return feed are included with the string for it to properly display it. Encoding is UTF-8.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiAddLogMessageHtml(\\\"<b>This <i>formatted</i> text will be displayed in the <u>log view</u></b>.\\\\n\\\");\\n```\\n\\n```\\n.data\\nszMsg db \\\"<b>This <i>formatted</i> text will be displayed in the <u>log view</u></b>\\\",13,10,0 ; CRLF\\n \\n.code\\nInvoke GuiAddLogMessageHtml, Addr szMsg\\n```\", \"Related functions\": [\"[GuiAddLogMessage](./GuiAddLogMessage.md)\", \"[GuiLogClear](./GuiLogClear.md)\", \"[GuiAddStatusBarMessage](./GuiAddStatusBarMessage.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}, {\"title\": \"GuiAddQWidgetTab\", \"description\": null, \"content\": {\"Parameters\": \"`qWidget` The Qt QWidget object.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiCloseQWidgetTab](./GuiCloseQWidgetTab.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 2]\"}, {\"title\": \"GuiAddRecentFile\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 3]\"}, {\"title\": \"GuiAddStatusBarMessage\", \"description\": null, \"content\": {\"Parameters\": \"`msg` String containing the message to add to the status bar.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiAddStatusBarMessage(\\\"This text will be displayed in the statusbar.\\\");\\n```\", \"Related functions\": [\"[GuiAddLogMessage](./GuiAddLogMessage.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 4]\"}, {\"title\": \"GuiAutoCompleteAddCmd\", \"description\": null, \"content\": {\"Parameters\": \"`cmd` The command that is added to the auto-completion list of the command bar.\", \"Return Value\": \"This function does not return a value.\", \"Related functions\": [\"[GuiAutoCompleteDelCmd](./GuiAutoCompleteDelCmd.md)\", \"[GuiAutoCompleteClearAll](./GuiAutoCompleteClearAll.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 5]\"}, {\"title\": \"GuiAutoCompleteClearAll\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 6]\"}, {\"title\": \"GuiAutoCompleteDelCmd\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 7]\"}, {\"title\": \"GuiCloseQWidgetTab\", \"description\": null, \"content\": {\"Parameters\": \"`qWidget` The Qt QWidget object of the tab to close.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiAddQWidgetTab](./GuiAddQWidgetTab.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 8]\"}, {\"title\": \"GuiDisasmAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 9]\"}, {\"title\": \"GuiDisplayWarning\", \"description\": null, \"content\": {\"Parameters\": \"`title` Dialog title in UTF-8 encoding.\\n\\n`text` Dialog text in UTF-8 encoding.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiDisplayWarning(\\\"Warning!\\\", \\\"Operation cannot be reversed.\\\");\\n```\", \"Related functions\": [\"[GuiAddLogMessage](./GuiAddLogMessage.md)\", \"[GuiAddStatusBarMessage](./GuiAddStatusBarMessage.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 10]\"}, {\"title\": \"GuiDumpAt\", \"description\": null, \"content\": {\"Parameters\": \"`va` Virtual address of the pointer to dump.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiDumpAtN](./GuiDumpAtN.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 11]\"}, {\"title\": \"GuiDumpAtN\", \"description\": null, \"content\": {\"Parameters\": \"`va` Virtual address of the pointer to dump.\\n\\n`index` Index of the dump window.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiDumpAt](./GuiDumpAt.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 12]\"}, {\"title\": \"GuiExecuteOnGuiThread\", \"description\": null, \"content\": {\"Parameters\": \"`cbGuiThread` A function pointer to the callback function.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiExecuteOnGuiThreadEx](./GuiExecuteOnGuiThreadEx.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 13]\"}, {\"title\": \"GuiExecuteOnGuiThreadEx\", \"description\": null, \"content\": {\"Parameters\": \"`cbGuiThread` A function pointer to the callback function.\\n\\n`userdata` A user-defined parameter that is passed to the callback function.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"[GuiExecuteOnGuiThread](./GuiExecuteOnGuiThread.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 14]\"}, {\"title\": \"GuiFocusView\", \"description\": null, \"content\": {\"Parameters\": \"`hWindow` One of the following values: GUI_DISASSEMBLY, GUI_DUMP, GUI_STACK, GUI_GRAPH, GUI_MEMMAP, GUI_SYMMOD, GUI_THREADS.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiFocusView(GUI_DISASSEMBLY); // focus on the disassembly tab.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 15]\"}, {\"title\": \"GuiGetDebuggeeNotes\", \"description\": null, \"content\": {\"Parameters\": \"`text` A variable that will contain a pointer to a buffer on return. The pointer returned points to a string that will contain the notes for the debuggee.\", \"Return Value\": \"This function does not return a value. The string containing the notes is returned via the pointer supplied via the `text` parameter.\", \"Example\": \"```\\nchar* text = nullptr;\\nGuiGetDebuggeeNotes(&text);\\nif(text)\\n{\\n // do something with text\\n BridgeFree(text);\\n}\\n```\", \"Related functions\": [\"[GuiSetDebuggeeNotes](./GuiSetDebuggeeNotes.md)\", \"[GuiGetGlobalNotes](./GuiGetGlobalNotes.md)\", \"[GuiSetGlobalNotes](./GuiSetGlobalNotes.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 16]\"}, {\"title\": \"GuiGetDisassembly\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 17]\"}, {\"title\": \"GuiGetGlobalNotes\", \"description\": null, \"content\": {\"Parameters\": \"`text` A variable that will contain a pointer to a buffer on return. The pointer returned points to a string that will contain the global notes.\", \"Return Value\": \"This function does not return a value. The string containing the notes is returned via the pointer supplied via the `text` parameter.\", \"Example\": \"```\\nchar* text = nullptr;\\nGuiGetGlobalNotes(&text);\\nif(text)\\n{\\n // do something with text\\n BridgeFree(text);\\n}\\n```\", \"Related functions\": [\"[GuiSetGlobalNotes](./GuiSetGlobalNotes.md)\", \"[GuiGetDebuggeeNotes](./GuiGetDebuggeeNotes.md)\", \"[GuiSetDebuggeeNotes](./GuiSetDebuggeeNotes.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 18]\"}, {\"title\": \"GuiGetLineWindow\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 19]\"}, {\"title\": \"GuiGetWindowHandle\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"Returns the main window handle for x6dbg as a HWND variable\", \"Example\": \"```\\nHWND hWnd = GuiGetWindowHandle();\\n```\", \"Related functions\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 20]\"}, {\"title\": \"GuiGraphAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 21]\"}, {\"title\": \"GuiIsUpdateDisabled\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"Returns a boolean value indicating if the internal update flag is set to disabled. If it is set to disabled the value is TRUE otherwise updates are enabled and the value is FALSE.\", \"Example\": \"```\\nbool bUpdate = GuiIsUpdateDisabled();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 22]\"}, {\"title\": \"GuiLoadGraph\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 23]\"}, {\"title\": \"GuiLoadSourceFile\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 24]\"}, {\"title\": \"GuiLogClear\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiLogClear();\\n```\", \"Related functions\": [\"[GuiAddLogMessage](./GuiAddLogMessage)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 25]\"}, {\"title\": \"GuiMenuAdd\", \"description\": null, \"content\": {\"Parameters\": \"`hMenu` Menu handle from a previously-added menu or from the main menu.\\n\\n`title` A const char repesenting the text title of the menu item to be added.\", \"Return Value\": \"Returns the menu handle (unique), or -1 on failure.\", \"Example\": \"```\\nhNewMenu = GuiMenuAdd(hMenu, &szMenuTitle);\\n```\", \"Related functions\": [\"[GuiMenuAddEntry](./GuiMenuAddEntry.md)\", \"[GuiMenuAddSeparator](./GuiMenuAddSeparator.md)\", \"[GuiMenuClear](./GuiMenuClear.md)\", \"[GuiMenuSetEntryIcon](./GuiMenuSetEntryIcon.md)\", \"[GuiMenuSetIcon](./GuiMenuSetIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 26]\"}, {\"title\": \"GuiMenuAddEntry\", \"description\": null, \"content\": {\"Parameters\": \"`hMenu` Menu handle from a previously-added menu or from the main menu.\\n\\n`title` A const char repesenting the text title of the menu item to be added.\", \"Return Value\": \"Returns the menu handle (unique), or -1 on failure.\", \"Example\": \"```\\nhNewMenuEntry = GuiMenuAddEntry(hMenu, &szMenuEntryText);\\n```\", \"Related functions\": [\"[GuiMenuAdd](./GuiMenuAdd.md)\", \"[GuiMenuAddSeparator](./GuiMenuAddSeparator.md)\", \"[GuiMenuClear](./GuiMenuClear.md)\", \"[GuiMenuSetEntryIcon](./GuiMenuSetEntryIcon.md)\", \"[GuiMenuSetIcon](./GuiMenuSetIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 27]\"}, {\"title\": \"GuiMenuAddSeparator\", \"description\": null, \"content\": {\"Parameters\": \"`hMenu` Menu handle from a previously-added menu or from the main menu.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nhNewMenu = GuiMenuAdd(hMenu, &szMenuTitle);\\nGuiMenuAddEntry(hNewMenu, &szMenuEntry1Text);\\nGuiMenuAddEntry(hNewMenu, &szMenuEntry2Text);\\nGuiMenuAddSeparator(hNewMenu);\\nGuiMenuAddEntry(hNewMenu, &szMenuEntry3Text);\\nGuiMenuAddEntry(hNewMenu, &szMenuEntry4Text);\\n\\n```\", \"Related functions\": [\"[GuiMenuAdd](./GuiMenuAdd.md)\", \"[GuiMenuAddEntry](./GuiMenuAddEntry.md)\", \"[GuiMenuClear](./GuiMenuClear.md)\", \"[GuiMenuSetEntryIcon](./GuiMenuSetEntryIcon.md)\", \"[GuiMenuSetIcon](./GuiMenuSetIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 28]\"}, {\"title\": \"GuiMenuClear\", \"description\": null, \"content\": {\"Parameters\": \"`hMenu` Menu handle from a previously-added menu or from the main menu.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nhNewMenu = GuiMenuAdd(hMenu, &szMenuTitle);\\nGuiMenuClear(hMenuNew);\\n```\", \"Related functions\": [\"[GuiMenuAdd](./GuiMenuAdd.md)\", \"[GuiMenuAddEntry](./GuiMenuAddEntry.md)\", \"[GuiMenuAddSeparator](./GuiMenuAddSeparator.md)\", \"[GuiMenuSetEntryIcon](./GuiMenuSetEntryIcon.md)\", \"[GuiMenuSetIcon](./GuiMenuSetIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 29]\"}, {\"title\": \"GuiMenuSetEntryIcon\", \"description\": null, \"content\": {\"Parameters\": \"`hEntry` Parameter description.\\n\\n`icon` \", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nICONDATA rocket;\\nrocket.data = icon_rocket;\\nrocket.size = sizeof(icon_rocket);\\nhNewMenuEntry = GuiMenuAddEntry(hMenu, &szMenuEntryText);\\nGuiMenuSetEntryIcon(hNewMenuEntry,&rocket);\\n```\", \"Related functions\": [\"[GuiMenuAdd](./GuiMenuAdd.md)\", \"[GuiMenuAddEntry](./GuiMenuAddEntry.md)\", \"[GuiMenuAddSeparator](./GuiMenuAddSeparator.md)\", \"[GuiMenuClear](./GuiMenuClear.md)\", \"[GuiMenuSetIcon](./GuiMenuSetIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 30]\"}, {\"title\": \"GuiMenuSetIcon\", \"description\": null, \"content\": {\"Parameters\": \"`hMenu` Menu handle from a previously-added menu or from the main menu.\\n\\n`icon` \", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nICONDATA rocket;\\nrocket.data = icon_rocket;\\nrocket.size = sizeof(icon_rocket);\\nhNewMenuEntry = GuiMenuAddEntry(hMenu, &szMenuEntryText);\\nGuiMenuSetIcon(hMenuDisasm,&rocket);\\n\\n```\", \"Related functions\": [\"[GuiMenuAdd](./GuiMenuAdd.md)\", \"[GuiMenuAddEntry](./GuiMenuAddEntry.md)\", \"[GuiMenuAddSeparator](./GuiMenuAddSeparator.md)\", \"[GuiMenuClear](./GuiMenuClear.md)\", \"[GuiMenuSetEntryIcon](./GuiMenuSetEntryIcon.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 31]\"}, {\"title\": \"GuiOpenTraceFile\", \"description\": null, \"content\": {\"Parameters\": \"`fileName` Path to the run trace file.\", \"Return Value\": \"This function does not return a value.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 32]\"}, {\"title\": \"GuiReferenceAddColumn\", \"description\": null, \"content\": {\"Parameters\": \"`width` An integer indicating the width of the column to add.\\n\\n`title` A const char representing the column's title name to add.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceAddColumn(8,&sztitle);\\n```\", \"Related functions\": [\"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 33]\"}, {\"title\": \"GuiReferenceDeleteAllColumns\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceDeleteAllColumns();\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 34]\"}, {\"title\": \"GuiReferenceGetCellContent\", \"description\": null, \"content\": {\"Parameters\": \"`row` An integer representing the row for the cell for which the data is fetched.\\n\\n`col` An integer representing the column for the cell for which the data is fetched.\", \"Return Value\": \"The return value is a pointer to a char representing the data (typically a string) that was stored at the specified row/column of the current Reference View instance. NULL if there was no data or the row/column specified was incorrect.\", \"Example\": \"```\\nData = GuiReferenceGetCellContent(0,0);\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 35]\"}, {\"title\": \"GuiReferenceGetRowCount\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"Returns an integer value representing the total rows in the current Reference View instance.\", \"Example\": \"```\\nint iTotalRows = GuiReferenceGetRowCount();\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 36]\"}, {\"title\": \"GuiReferenceInitialize\", \"description\": null, \"content\": {\"Parameters\": \"`name` A const char representing the text string to name the Reference View instance.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceInitialize(\\\"Code Caves\\\");\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 37]\"}, {\"title\": \"GuiReferenceReloadData\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceReloadData();\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 38]\"}, {\"title\": \"GuiReferenceSetCellContent\", \"description\": null, \"content\": {\"Parameters\": \"`row` integer representing the row to set data for.\\n\\n`col` integer representing the column to set data for.\\n\\n`str` const char* representing the string data to set at the row, col specified.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nconst char szRefStart = \\\"Start\\\";\\nconst char szRefFinish = \\\"Finish\\\";\\nconst char szRefType = \\\"Type\\\";\\nGuiReferenceInitialize(\\\"Some Information\\\"); // Add Reference View Header Title\\nGuiReferenceAddColumn(2 * sizeof(DWORD),&szRefStart); // Add column Name\\nGuiReferenceAddColumn(2 * sizeof(DWORD),&szRefFinish); // Add column Name\\nGuiReferenceAddColumn(8,&szRefType); // Add column Name\\nGuiReferenceSetRowCount(2); // add 2 rows\\nint iRow = 0;\\nGuiReferenceSetCellContent(iRow,0,&szCodeCaveStartAddress); // add start address\\nGuiReferenceSetCellContent(iRow,1,&szCodeCaveFinishAddress); // add finish address\\nGuiReferenceSetCellContent(iRow,2,&szNop); // add type\\niRow = iRow + 1; // Increment rows\\n// get variables to convert to strings (szCodeCaveStartAddress, szCodeCaveFinishAddress etc)\\n// add to next row's columns\\n```\", \"Notes\": \"The Reference View must be initialized beforehand, and any columns required added before adding any rows and setting data for them.\\n\\nEnsure you increment the row counter after you have set all data for all columns in a particular row, otherwise you will just overwrite any data you have set previously.\\n\\nGuiReferenceSetRowCount needs to be called before setting cell contents - to update the reference view with a total count of rows, for example to add 5 rows: GuiReferenceSetRowCount(5), if you then decide to add another row later on then you would specify GuiReferenceSetRowCount(6)\\n\\nIdeally you will use some variable that is incremented to automatically keep track of total rows added.\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 39]\"}, {\"title\": \"GuiReferenceSetCurrentTaskProgress\", \"description\": null, \"content\": {\"Parameters\": \"`progress` An integer representing the value of the percentage bar.\\n\\n`taskTitle` A const char representing a text string to indicate status or progress to the user.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceSetCurrentTaskProgress(0,\\\"Starting Search, Please Wait...\\\");\\n// do something\\nGuiReferenceSetCurrentTaskProgress(50,\\\"Searching, Please Wait...\\\");\\n// do something else\\nGuiReferenceSetCurrentTaskProgress(100,\\\"Finished Searching.\\\");\\n// finished\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 40]\"}, {\"title\": \"GuiReferenceSetProgress\", \"description\": null, \"content\": {\"Parameters\": \"`progress` An integer representing the percentage value to set the progress bar to.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceSetProgress(0);\\n// do something\\nGuiReferenceSetProgress(50);\\n// do something else\\nGuiReferenceSetProgress(100);\\n// tell user operation has ended\\n\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 41]\"}, {\"title\": \"GuiReferenceSetRowCount\", \"description\": null, \"content\": {\"Parameters\": \"`count` integer representing the total number of rows that the current Reference View will contain.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceSetRowCount(5);\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 42]\"}, {\"title\": \"GuiReferenceSetSearchStartCol\", \"description\": null, \"content\": {\"Parameters\": \"`col` An integer representing the 0 based column to use for searching.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceSetSearchStartCol(1);\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSingleSelection](./GuiReferenceSetSingleSelection.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 43]\"}, {\"title\": \"GuiReferenceSetSingleSelection\", \"description\": null, \"content\": {\"Parameters\": \"`index` integer representing the row index to set the current selection to.\\n\\n`scroll` a boolean value indicating if the selected index should be scrolled into view if it is not currently.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiReferenceSetSingleSelection(0,true);\\n```\", \"Related functions\": [\"[GuiReferenceAddColumn](./GuiReferenceAddColumn.md)\", \"[GuiReferenceDeleteAllColumns](./GuiReferenceDeleteAllColumns.md)\", \"[GuiReferenceGetCellContent](./GuiReferenceGetCellContent.md)\", \"[GuiReferenceGetRowCount](./GuiReferenceGetRowCount.md)\", \"[GuiReferenceInitialize](./GuiReferenceInitialize.md)\", \"[GuiReferenceReloadData](./GuiReferenceReloadData.md)\", \"[GuiReferenceSetCellContent](./GuiReferenceSetCellContent.md)\", \"[GuiReferenceSetCurrentTaskProgress](./GuiReferenceSetCurrentTaskProgress.md)\", \"[GuiReferenceSetProgress](./GuiReferenceSetProgress.md)\", \"[GuiReferenceSetRowCount](./GuiReferenceSetRowCount.md)\", \"[GuiReferenceSetSearchStartCol](./GuiReferenceSetSearchStartCol.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 44]\"}, {\"title\": \"GuiRegisterScriptLanguage\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 45]\"}, {\"title\": \"GuiRepaintTableView\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 46]\"}, {\"title\": \"GuiScriptAdd\", \"description\": null, \"content\": {\"Parameters\": \"`count` Number of lines;\\n\\n`lines` A buffer containing `count` pointers to UTF-8 strings, each representing a single line. This buffer is freed by [BridgeFree](../bridge/BridgeFree.md) afterwards.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 47]\"}, {\"title\": \"GuiScriptClear\", \"description\": null, \"content\": {\"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 48]\"}, {\"title\": \"GuiScriptEnableHighlighting\", \"description\": null, \"content\": {\"Parameters\": \"`enable` `True` to enable syntax highlighting in the script view, `false` otherwise.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiScriptEnableHighlighting(true);\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 49]\"}, {\"title\": \"GuiScriptError\", \"description\": null, \"content\": {\"Parameters\": \"`line` Line number where the script error occurred.\\n\\n`message` The error message.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 50]\"}, {\"title\": \"GuiScriptMessage\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 51]\"}, {\"title\": \"GuiScriptMsgyn\", \"description\": null, \"content\": {\"Parameters\": \"`message` The content of the yes/no choices message box.\", \"Return Value\": \"1 if the user chose yes, 0 if the user chose no.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 52]\"}, {\"title\": \"GuiScriptSetInfoLine\", \"description\": null, \"content\": {\"Parameters\": \"`line` Parameter description.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 53]\"}, {\"title\": \"GuiScriptSetIp\", \"description\": null, \"content\": {\"Parameters\": \"`line` The line number of the new current line.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiScriptSetIp(0);\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 54]\"}, {\"title\": \"GuiScriptSetTitle\", \"description\": null, \"content\": {\"Parameters\": \"`title` Window title of the script view.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiScriptSetTitle(\\\"Window Title\\\");\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 55]\"}, {\"title\": \"GuiSelectionGet\", \"description\": null, \"content\": {\"Parameters\": \"`hWindow` an integer representing one of the following supported GUI views: GUI_DISASSEMBLY, GUI_DUMP, GUI_STACK.\\n\\n`selection` a SELECTIONDATA structure variable that stores the start and end address of the current selection.\", \"Return Value\": \"Return TRUE if successful or FALSE otherwise.\", \"Example\": \"```\\nSELECTIONDATA sel;\\nGuiSelectionGet(GUI_DISASSEMBLY, &sel)\\nsprintf(msg, \\\"%p - %p\\\", sel.start, sel.end);\\n```\", \"Related functions\": [\"[GuiSelectionSet](./GuiSelectionSet.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 56]\"}, {\"title\": \"GuiSelectionSet\", \"description\": null, \"content\": {\"Parameters\": \"`hWindow` an integer representing one of the following supported GUI views: GUI_DISASSEMBLY, GUI_DUMP, GUI_STACK.\\n\\n`selection` a SELECTIONDATA structure variable that stores the start and end address of the current selection.\", \"Return Value\": \"Return TRUE if successful or FALSE otherwise.\", \"Example\": \"```\\nSELECTIONDATA sel;\\nGuiSelectionGet(GUI_DISASSEMBLY, &sel)\\nsel.end += 4; //expand selection\\nGuiSelectionSet(GUI_DISASSEMBLY, &sel)\\n```\", \"Related functions\": [\"[GuiSelectionGet](./GuiSelectionGet.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 57]\"}, {\"title\": \"GuiSetDebugState\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 58]\"}, {\"title\": \"GuiSetDebuggeeNotes\", \"description\": null, \"content\": {\"Parameters\": \"`text` A variable that contains a pointer to a string that contains the text to set as the debuggee notes.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nconst char* text = json_string_value(json_object_get(root, \\\"notes\\\"));\\nGuiSetDebuggeeNotes(text);\\n```\", \"Related functions\": [\"[GuiGetDebuggeeNotes](./GuiGetDebuggeeNotes.md)\", \"[GuiGetGlobalNotes](./GuiGetGlobalNotes.md)\", \"[GuiSetGlobalNotes](./GuiSetGlobalNotes.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 59]\"}, {\"title\": \"GuiSetGlobalNotes\", \"description\": null, \"content\": {\"Parameters\": \"`text` A variable that contains a pointer to a string that contains the text to set as the global notes.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nnotesFile = String(szProgramDir) + \\\"\\\\\\\\notes.txt\\\";\\nString text;\\nif(!FileExists(notesFile.c_str()) || FileHelper::ReadAllText(notesFile, text))\\n GuiSetGlobalNotes(text.c_str());\\n```\", \"Related functions\": [\"[GuiGetGlobalNotes](./GuiGetGlobalNotes.md)\", \"[GuiGetDebuggeeNotes](./GuiGetDebuggeeNotes.md)\", \"[GuiSetDebuggeeNotes](./GuiSetDebuggeeNotes.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 60]\"}, {\"title\": \"GuiSetLastException\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 61]\"}, {\"title\": \"GuiShowCpu\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiShowCpu();\\n```\", \"Related functions\": \"\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 62]\"}, {\"title\": \"GuiShowQWidgetTab\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 63]\"}, {\"title\": \"GuiStackDumpAt\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 64]\"}, {\"title\": \"GuiSymbolLogAdd\", \"description\": null, \"content\": {\"Parameters\": \"`message` String containing the message to add to the symbol log. Ensure that a carriage line and return feed are included with the string for it to properly display it. Encoding is UTF-8.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiSymbolLogAdd(&szMsg);\\n```\", \"Related functions\": [\"[GuiSymbolLogClear](./GuiSymbolLogClear.md)\", \"[GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)\", \"[GuiSymbolSetProgress](./GuiSymbolSetProgress.md)\", \"[GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 65]\"}, {\"title\": \"GuiSymbolLogClear\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiSymbolLogClear();\\n```\", \"Related functions\": [\"[GuiSymbolLogAdd](./GuiSymbolLogAdd.md)\", \"[GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)\", \"[GuiSymbolSetProgress](./GuiSymbolSetProgress.md)\", \"[GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 66]\"}, {\"title\": \"GuiSymbolRefreshCurrent\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiSymbolRefreshCurrent();\\n```\", \"Related functions\": [\"[GuiSymbolLogAdd](./GuiSymbolLogAdd.md)\", \"[GuiSymbolLogClear](./GuiSymbolLogClear.md)\", \"[GuiSymbolSetProgress](./GuiSymbolSetProgress.md)\", \"[GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 67]\"}, {\"title\": \"GuiSymbolSetProgress\", \"description\": null, \"content\": {\"Parameters\": \"`percent` an integer representing the percentage to set for the progress bar.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiSymbolSetProgress(50);\\n```\", \"Related functions\": [\"[GuiSymbolLogAdd](./GuiSymbolLogAdd.md)\", \"[GuiSymbolLogClear](./GuiSymbolLogClear.md)\", \"[GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)\", \"[GuiSymbolUpdateModuleList](./GuiSymbolUpdateModuleList.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 68]\"}, {\"title\": \"GuiSymbolUpdateModuleList\", \"description\": null, \"content\": {\"Parameters\": \"`count` An integer representing the number of symbol module's to update.\\n\\n`modules` A SYMBOLMODULEINFO variable that will hold the symbol module information.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\n// Build the vector of modules\\nstd::vector<SYMBOLMODULEINFO> modList;\\n\\nif(!SymGetModuleList(&modList))\\n{\\n GuiSymbolUpdateModuleList(0, nullptr);\\n return;\\n}\\n\\n// Create a new array to be sent to the GUI thread\\nsize_t moduleCount = modList.size();\\nSYMBOLMODULEINFO* data = (SYMBOLMODULEINFO*)BridgeAlloc(moduleCount * sizeof(SYMBOLMODULEINFO));\\n\\n// Direct copy from std::vector data\\nmemcpy(data, modList.data(), moduleCount * sizeof(SYMBOLMODULEINFO));\\n\\n// Send the module data to the GUI for updating\\nGuiSymbolUpdateModuleList((int)moduleCount, data);\\n```\", \"Related functions\": [\"[GuiSymbolLogAdd](./GuiSymbolLogAdd.md)\", \"[GuiSymbolLogClear](./GuiSymbolLogClear.md)\", \"[GuiSymbolRefreshCurrent](./GuiSymbolRefreshCurrent.md)\", \"[GuiSymbolSetProgress](./GuiSymbolSetProgress.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 69]\"}, {\"title\": \"GuiUnregisterScriptLanguage\", \"description\": null, \"content\": {\"Parameters\": \"`param1` Parameter description.\", \"Return Value\": \"Return value description.\", \"Example\": \"```\\nExample code.\\n```\", \"Related functions\": [\"List of related functions\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 70]\"}, {\"title\": \"GuiUpdateAllViews\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateAllViews();\\n```\", \"Related functions\": [\"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiIsUpdateDisabled](./GuiIsUpdateDisabled.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 71]\"}, {\"title\": \"GuiUpdateArgumentWidget\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateArgumentWidget();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 72]\"}, {\"title\": \"GuiUpdateBreakpointsView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateBreakpointsView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 73]\"}, {\"title\": \"GuiUpdateCallStack\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateCallStack();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 74]\"}, {\"title\": \"GuiUpdateDisable\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateDisable();\\n```\", \"Related functions\": [\"[GuiIsUpdateDisabled](./GuiIsUpdateDisabled.md)\", \"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 75]\"}, {\"title\": \"GuiUpdateDisassemblyView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateDisassemblyView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 76]\"}, {\"title\": \"GuiUpdateDumpView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateDumpView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 77]\"}, {\"title\": \"GuiUpdateEnable\", \"description\": null, \"content\": {\"Parameters\": \"`updateNow` is a boolean value indicating if the update of all views should occur straight away.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateEnable(bool updateNow);\\n```\", \"Related functions\": [\"[GuiIsUpdateDisabled](./GuiIsUpdateDisabled.md)\", \"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 78]\"}, {\"title\": \"GuiUpdateGraphView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateGraphView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 79]\"}, {\"title\": \"GuiUpdateMemoryView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateMemoryView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 80]\"}, {\"title\": \"GuiUpdatePatches\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdatePatches();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 81]\"}, {\"title\": \"GuiUpdateRegisterView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateRegisterView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 82]\"}, {\"title\": \"GuiUpdateSEHChain\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateSEHChain();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 83]\"}, {\"title\": \"GuiUpdateSideBar\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateSideBar();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 84]\"}, {\"title\": \"GuiUpdateThreadView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateThreadView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 85]\"}, {\"title\": \"GuiUpdateTimeWastedCounter\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateTimeWastedCounter();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 86]\"}, {\"title\": \"GuiUpdateWatchView\", \"description\": null, \"content\": {\"Parameters\": \"This function has no parameters.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateWatchView();\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 87]\"}, {\"title\": \"GuiUpdateWindowTitle\", \"description\": null, \"content\": {\"Parameters\": \"`filename` a const char variable to be appended to the x64dbg title bar.\", \"Return Value\": \"This function does not return a value.\", \"Example\": \"```\\nGuiUpdateWindowTitle(\\\"\\\");\\nGuiUpdateWindowTitle(szFileName);\\n```\", \"Related functions\": [\"[GuiUpdateAllViews](./GuiUpdateAllViews.md)\", \"[GuiUpdateArgumentWidget](./GuiUpdateArgumentWidget.md)\", \"[GuiUpdateBreakpointsView](./GuiUpdateBreakpointsView.md)\", \"[GuiUpdateCallStack](./GuiUpdateCallStack.md)\", \"[GuiUpdateDisable](./GuiUpdateDisable.md)\", \"[GuiUpdateDisassemblyView](./GuiUpdateDisassemblyView.md)\", \"[GuiUpdateDumpView](./GuiUpdateDumpView.md)\", \"[GuiUpdateEnable](./GuiUpdateEnable.md)\", \"[GuiUpdateGraphView](./GuiUpdateGraphView.md)\", \"[GuiUpdateMemoryView](./GuiUpdateMemoryView.md)\", \"[GuiUpdatePatches](./GuiUpdatePatches.md)\", \"[GuiUpdateRegisterView](./GuiUpdateRegisterView.md)\", \"[GuiUpdateSEHChain](./GuiUpdateSEHChain.md)\", \"[GuiUpdateSideBar](./GuiUpdateSideBar.md)\", \"[GuiUpdateThreadView](./GuiUpdateThreadView.md)\", \"[GuiUpdateTimeWastedCounter](./GuiUpdateTimeWastedCounter.md)\", \"[GuiUpdateWatchView](./GuiUpdateWatchView.md)\", \"[GuiUpdateWindowTitle](./GuiUpdateWindowTitle.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2, \\\"subpages\\\", 88]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 1]\"}, {\"title\": \"Plugins\", \"description\": \"Documentation section: plugins\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/developers/plugins\"}, \"subpages\": [{\"title\": \"The basics\", \"description\": null, \"content\": {\"Exports\": \"A plugin has at least one export. This export must be called `pluginit`. See the `PLUG_INITSTRUCT` and the plugin headers for more information. The other valid exports are:\\n\\n`plugstop` called when the plugin is about to be unloaded. Remove all registered commands and callbacks here. Also clean up plugin data.\\n\\n`plugsetup` Called when the plugin initialization was successful, here you can register menus and other GUI-related things.\\n\\n`CB*` Instead of calling `_plugin_registercallback`, you can create a `CDECL` export which has the name of the callback. For example when you create an export called `CBMENUENTRY`, this will be registered as your callback for the event `CB_MENUENTRY`. Notice that you should not use an underscore in the export name.\\n\\n`CBALLEVENTS` An export with the name `CBALLEVENTS` will get every event registered to it. This is done prior to registering optional other export names.\", \"Definitions\": \"Initialization exports.\\n\\n```\\nextern \\\"C\\\" __declspec(dllexport) bool pluginit(PLUG_INITSTRUCT* initStruct);\\nextern \\\"C\\\" __declspec(dllexport) bool plugstop();\\nextern \\\"C\\\" __declspec(dllexport) void plugsetup(PLUG_SETUPSTRUCT* setupStruct);\\n```\\n\\nCallback exports. **Make sure to only export callbacks that you actually use!**\\n\\n```\\nextern \\\"C\\\" __declspec(dllexport) void CBINITDEBUG(CBTYPE cbType, PLUG_CB_INITDEBUG* info);\\nextern \\\"C\\\" __declspec(dllexport) void CBSTOPDEBUG(CBTYPE cbType, PLUG_CB_STOPDEBUG* info);\\nextern \\\"C\\\" __declspec(dllexport) void CBEXCEPTION(CBTYPE cbType, PLUG_CB_EXCEPTION* info);\\nextern \\\"C\\\" __declspec(dllexport) void CBDEBUGEVENT(CBTYPE cbType, PLUG_CB_DEBUGEVENT* info);\\nextern \\\"C\\\" __declspec(dllexport) void CBMENUENTRY(CBTYPE cbType, PLUG_CB_MENUENTRY* info);\\n```\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Notes\", \"description\": null, \"content\": {\"Character encoding\": \"x64dbg uses UTF-8 encoding everywhere it accepts a string. If you are passing a string to x64dbg, ensure that it is converted to UTF-8 encoding. This will help to reduce encoding errors.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 4, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 4]\"}, {\"title\": \"Gui\", \"description\": \"Documentation section: gui\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/gui\"}, \"subpages\": [{\"title\": \"Dialogs\", \"description\": \"Documentation section: dialogs\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/gui/dialogs\"}, \"subpages\": [{\"title\": \"Entropy\", \"description\": null, \"content\": {\"Entropy\": \"This dialog contains a graph that displays the entropy changing trend of selected data.\\n\\nThe height of each point represents the entropy of a continous 128-byte data block.\\nThe data blocks are sampled evenly over the selected buffer.\\nThe base address differences between the neighbouring sampled data blocks are the same.\\nIf the selected buffer is over 38400 bytes (300\\\\*128), there will be gaps between sampled data blocks.\\nIf the selected buffer is less than 38400 bytes, the data blocks will overlap.\\nIf the selected buffer is less than 128 bytes (size of a data block), then the data block size will be set to half the buffer size.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0, \\\"subpages\\\", 0]\"}], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 0]\"}, {\"title\": \"Settings\", \"description\": \"Documentation section: settings\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/gui/settings\"}, \"subpages\": [{\"title\": \"Events\", \"description\": null, \"content\": {\"System Breakpoint\": \"This event happens when the process is being initialized but have not begun to execute user code yet.\", \"TLS Callbacks\": \"Set a single-shoot breakpoint on the TLS callbacks when a module is loaded to pause at the TLS callback.\", \"Entry Breakpoint\": \"Set a single-shoot breakpoint on the entry of the EXE module to pause at the entry point.\", \"DLL Entry\": \"Set a single-shoot breakpoint on the entry of the DLL module to pause at the entry point.\", \"Attach Breakpoint\": \"This event happens when the process is successfully attached.\", \"Thread Entry\": \"Set a single-shoot breakpoint on the entry of the thread when a thread is about to run.\", \"DLL Load\": \"Pause when a DLL is mapped to the address space.\", \"DLL Unload\": \"Pause when a DLL is unmapped from the address space.\", \"Thread Start\": \"Pause when a new thread is about to run.\", \"Thread End\": \"Pause when a thread has exited.\", \"Debug Strings\": \"Pause when a debug string is emitted by the debuggee.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 0]\"}, {\"title\": \"Exceptions\", \"description\": null, \"content\": {\"Add Range\": \"You can specify a range of exception codes to ignore. The input is hexadecimal.\", \"Delete Range\": \"Delete an ignored exception range, so that it will not be ignored.\", \"Add Last\": \"Add the last exception to the list.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 1]\"}, {\"title\": \"GUI\", \"description\": null, \"content\": {\"Show FPU registers as little endian\": \"Some FPU registers, especially SSE and AVX registers, are usually used to perform parallel computation.\\nUsing little endian helps to correspond floating point numbers to their index in memory arrays. However, big\\nendian representation are more familiar to most users. This option can set whether FPU registers are shown\\nas little endian or as big endian. You also edit the FPU registers in the endianness set here.\", \"Save GUI layout and column orders\": \"Allow column order, width and layout of some views, to be saved in the config file. Note that not all views support\\nthis option. Currently, this option has not been implemented in the CPU view.\", \"Don't show close dialog\": \"Do not show the close dialog when the debugger exits.\", \"Show PID in HEX\": \"Show PID in hexadecimal in the attach dialog. If not set, it will use decimal, just like in the Task Manager.\", \"Enable Load/Save Tab Order\": \"Allow x64dbg to load and save tab order. If not set, x64dbg will always use the default tab order.\", \"Show Watch Labels in Side Bar\": \"When you add a watched variable in the watch view, a label with the name of the watched variable can appear in\\nthe side bar of the disassembly view if the address is in the sight. They just look like labels for registers. This label\\nmight help you understand the operation and progress of a self modifying routine. If disabled, no labels will be added\\nin the side bar for watched variables.\", \"Do not call SetForegroundWindow\": \"When a debug event occurs, x64dbg will focus itself so you can view the state of the debuggee. In some circumstances\\nthis might not be desired. This option can be used to tell x64dbg not to focus itself when a debug event occurs.\", \"Show RVA addresses in graph view\": \"When enabled in graph view the offset addresses are shown in front of the disassembly.\", \"Graph zoom mode\": \"Allows to zoom graph view by holding <ctrl> and turning the mousewheel up and down.\\nNote: Press G on the CPU tab press G to open graph view \", \"Show exit confirmation dialog\": \"When enabled the dialog\\n\\\"The debuggee is still running and will be terminated if you exit. Do you really want to exit?\\\"\\nis shown when you exit x64dbg but it's still attached to some process for debugging.\", \"Disable auto completion in goto dialog\": \"Here you can turn of the auto completion that will suggest words as soon you start typing in the \\\"Enter expression\\\" dialog. Go to/expression from the right click context menu will bring up the \\\"Enter expression\\\" dialog. Note: That stting will be handy in case there are delays when typing.\", \"Show ASCII/Unicode in address dump mode\": \"When enabled the column \\\"ASCII\\\" is added to the dump panels.\\nFurthermore the view mode(right click) must be set to \\\"Address\\\" to see this effect.\\nNote: The column \\\"ASCII\\\" must not be hidden.\\nRight click on column header to bring up the 'Edit column' dialog to check.\\n^^\\nNote from the doc contributor: \\nHowever please don't ask why there is an option here\\nwhen there is also that 'Edit column' dialog that does nearly the same thing.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 2]\"}, {\"title\": \"Other settings\", \"description\": null, \"content\": {\"Engine\": {\"AnimateInterval\": \"If set to a value of milliseconds, animation will proceed every specified milliseconds.\\n\\nUpdate: This setting has been added into settings dialog, and previous lower limit of 20ms has been removed.\", \"MaxSkipExceptionCount\": \"If set (default is 10000), during a run that ignores first-chance exceptions(example, [erun](../../commands/debug-control/erun)), it will only ignore that specified number of first-chance exceptions. After that the debuggee will pause when one more first-chance exception happens. If set to 0 first-chance exceptions will always be ignored during such runs.\"}, \"Gui\": {\"NonprintReplaceCharacter\": \"If set to a Unicode value, dump view will use this character to represent nonprintable characters, instead of the default \\\".\\\"\", \"NullReplaceCharacter\": \"If set to a Unicode value, dump view will use this character to represent null characters, instead of the default \\\".\\\"\"}, \"Misc\": {\"AnimateIgnoreError\": \"Set to 1 to ignore errors while animating, so animation will continue when an error in the animated command occurs.\", \"NoSeasons\": \"Set to 1 to disable easter eggs and Christmas icons.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1, \\\"subpages\\\", 3]\"}], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 1]\"}, {\"title\": \"Views\", \"description\": \"Documentation section: views\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/gui/views\"}, \"subpages\": [{\"title\": \"Source\", \"description\": null, \"content\": {\"Source\": \"If available, the source view displays the source file corresponding to a specific instruction. The debugger won't automatically do this; instead, the user must right-click the desired instruction in the disassembly view and select \\\"Open Source File.\\\"\\n\\nTo successfully load the source file, both the debug symbols (typically the PDB file) and the source file must be accessible. Additionally, the debug symbols need to be loaded before the source file.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2, \\\"subpages\\\", 0]\"}, {\"title\": \"Trace\", \"description\": null, \"content\": {\"Start trace recording\": \"To enable trace logging into trace view, you first enable it via \\\"**Start trace recording**\\\" menu item. It will pop up a dialog allowing you to save the recorded instructions to a file. The default location of this file is in the database directory.\\n\\nOnce started, every instruction you stepped or traced will appear immediately in Trace view. If you let the application run the executed instructions will not be recorded.\", \"Stop trace recording\": \"This menu can stop recording instructions.\", \"Close\": \"Close current trace file and clear the trace view.\", \"Close and delete\": \"Close current trace file and clear the trace view, and also delete current trace file from disk.\", \"Open\": \"Open a trace file to view the content of it. It can be used when not debugging, but it is recommended that you debug the corresponding debuggee when viewing a trace, as it will be able to render the instructions with labels from the database of the debuggee. The debugger will show a warning if you want to load a trace file which is not recorded from currently debugged executable.\", \"Recent files\": \"Open a recent file to view the content of it.\", \"Search\": {\"Constant\": \"Search for the user-specified constant in the entire recorded trace, and record the occurances in references view.\", \"Memory Reference\": \"Search for memory accesses to the user-specified address.\"}, \"Toggle Auto Disassembly Scroll\": \"When turned on, the disassembly view in the [CPU view](CPU.rst) will automatically follow the EIP or RIP of selected instruction in trace view.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2, \\\"subpages\\\", 1]\"}], \"path\": \"[\\\"subpages\\\", 5, \\\"subpages\\\", 2]\"}], \"path\": \"[\\\"subpages\\\", 5]\"}, {\"title\": \"Introduction\", \"description\": \"Documentation section: introduction\", \"content\": {}, \"metadata\": {\"type\": \"directory\", \"path\": \"/home/anhnh/CodeWikiBench/data/x64dbg/original/docs/introduction\"}, \"subpages\": [{\"title\": \"Commandline\", \"description\": null, \"content\": {\"Command line\": \"x64dbg supports the following command line:\\n\\n['1 argument: `x64dbg filename.exe` will debug `filename.exe`.', '2 arguments: `x64dbg -p PID` will attach to the process with `PID` PID.', '2 arguments: `x64dbg filename.exe cmdline` will debug `filename.exe` with `cmdline` as command line.', '3 arguments: `x64dbg filename.exe cmdline currentdir` will debug `filename.exe` with `cmdline` as command line and `currentdir` as current directory.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 0]\"}, {\"title\": \"Conditional Breakpoints\", \"description\": null, \"content\": {\"Operations overview\": \"When a breakpoint is hit, x64dbg will do the following things:\\n\\n['Set the system variable `$breakpointexceptionaddress` to the address that triggered the breakpoint (memory location);', 'Increment the *hit counter*;', 'Set the system variable `$breakpointcounter` to the value of *hit counter*;', 'If *break condition* is set, evaluate the [expression](./Expressions.md) (defaults to `1`);', 'If *fast resume* is set and *break condition* evaluated to `0`:', ['Resume execution of the debuggee (skip the next steps). This will also skip executing plugin callbacks and GUI updates.'], 'If *log condition* is set, evaluate the [expression](./Expressions.md) (defaults to `1`);', 'If *command condition* is set, evaluate the [expression](./Expressions.md) (defaults to `1`);', \\\"If *break condition* evaluated to `1` (or any value other than '0'):\\\", ['Print the standard log message; (if [the breakpoint is set to be silent](../commands/conditional-breakpoint-control/SetBreakpointSilent.md), standard log message is supressed.)', 'Execute plugin callbacks.'], \\\"If *log text* is set and *log condition* evaluated to `1` (or any value other than '0'):\\\", ['Format and print the *log text* (see [String Formatting](./Formatting.md)).'], 'If *command text* is set and *command condition* evaluated to `1`:', ['Set the system variable `$breakpointcondition` to the *break condition*;', 'Set the system variable `$breakpointlogcondition` to the *log condition*;', 'Execute the command in *command text*;', 'The *break condition* will be set to the value of `$breakpointcondition`. So if you modify this system variable in the script, you will be able to control whether the debuggee would break.'], \\\"If *break condition* evaluated to `1` (or any value other than '0'):\\\", ['Break the debuggee and wait for the user to resume.']]\\n\\nIf any expression is invalid, the condition will be triggered (That is, an invalid expression as condition will cause the breakpoint to always break, log and execute command).\\n\\n**Warning: All numbers in expressions are interpreted as hex by default!** For decimal use `.123`.\", \"Hit counter\": \"A hit counter records how many times a breakpoint has been reached. It will be incremented unconditionally, even if fast resume is enabled on this breakpoint. It may be viewed at breakpoint view and reset with [ResetBreakpointHitCount](../commands/conditional-breakpoint-control/ResetBreakpointHitCount.md).\", \"Logging\": \"The log can be formatted by x64dbg to log the current state of the program. See [formatting](./Formatting.md) on how to format the log string.\", \"Notes\": \"You can set a conditional breakpoint with GUI by setting a software breakpoint(key F2) first, then right-click on the instruction and select \\\"Edit breakpoint\\\" command from the context menu. Fill in the conditional expression and/or other information as necessary, then confirm and close the dialog.\\n\\nYou should not use commands that can change the running state of the debuggee (such as `run`) inside the breakpoint command, because these commands are unstable when used here. You can use *break condition*, *command condition* or `$breakpointcondition` instead.\", \"Examples\": \"**A conditional breakpoint which never breaks**\\n\\n*break condition*: `0` (Useful if you only want to execute command or log data, but not pause the debuggee)\\n\\n**A conditional breakpoint which breaks only if EAX and ECX both equal to 1**\\n\\n*break condition*: `EAX==1 && ECX==1`\\n\\n**A conditional breakpoint which breaks only if the first argument is 1**\\n\\n*break condition*: `arg.get(0)==1`\\n\\n**A conditional breakpoint which breaks only if EAX is a valid address**\\n\\n*break condition*: `mem.valid(EAX)`\\n\\n**A conditional breakpoint which breaks on the third hit**\\n\\n*break condition*: `$breakpointcounter==3` or `($breakpointcounter%3)==0`\\n\\n**A conditional breakpoint which breaks only if executed by the thread 1C0**\\n\\n*break condition*: `tid()==1C0`\\n\\n**A conditional breakpoint which breaks only if ECX points to a UTF-16 string containing \\\"foo\\\"**\\n\\n*break condition*: `strstr(utf16(ECX), \\\"foo\\\")`\", \"Comparison with Conditional Tracing\": \"A conditional breakpoint can only pause the debuggee when it is executed. It cannot pause the debuggee when the breakpoint is not hit even if the condition is satisfied. If you don't know where the condition will become true, try [conditional tracing](./ConditionalTracing.md) instead!\", \"See also\": [\"[Conditional Breakpoint Control](../commands/conditional-breakpoint-control/index.rst)\", \"[Expressions](./Expressions.md)\", \"[Expression Functions](./Expression-functions.md)\", \"[String Formatting](./Formatting.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 1]\"}, {\"title\": \"Conditional Tracing\", \"description\": null, \"content\": {\"Operations overview\": \"When a trace step is hit, x64dbg will do the following things:\\n\\n['Increment the *trace counter*;', 'Set the system variable `$tracecounter` to the value of *trace counter*;', 'If *break condition* is set, evaluate the [expression](Expressions.md) (defaults to `0`);', 'Execute plugin callbacks (allowing plugins to change the *break condition*);', 'If *log condition* is set, evaluate the [expression](Expressions.md) (defaults to `1`);', 'If *command condition* is set, evaluate the [expression](Expressions.md) (defaults to *break condition*);', 'If *log text* is set and *log condition* evaluated to `1`:', ['Format and print the *log text* (see [String Formatting](Formatting.md)). To redirect the log to a file use [TraceSetLogFile](../commands/tracing/TraceSetLogFile.md).'], 'If *command text* is set and *command condition* evaluated to `1`:', ['Set the system variable `$tracecondition` to the *break condition*;', 'Set the system variable `$tracelogcondition` to the *log condition*;', 'Execute the command in *command text*;', 'The *break condition* will be set to the value of `$tracecondition`. So if you modify this system variable in the script, you will be able to control whether the debuggee would break.'], 'If *break condition* evaluated to `1`:', ['Print the standard log message; ', 'Break the debuggee and wait for the user to resume.']]\\n\\nIn addition to the above operations, x64dbg also has the ability to record traced instructions to the trace view and to update the trace coverage. This happens every time the debugger steps or pauses, also if you do it manually.\\n\\n**Warning: All numbers in expressions are interpreted as hex by default!** For decimal use `.123`.\", \"Logging\": \"The log can be formatted by x64dbg to log the current state of the program. See [formatting](./Formatting.md) on how to format the log string. If you are looking for logging the address and disassembly of all instructions traced you can use `{p:cip} {i:cip}`. To redirect the log to a file use [TraceSetLogFile](../commands/tracing/TraceSetLogFile.md), or use the graphical interface.\", \"Trace coverage\": \"If you use one of the trace coverage-based tracing options such as [TraceIntoBeyondTraceCoverage](../commands/tracing/TraceIntoBeyondTraceRecord.md), the initial evaluation of *break condition* includes the type of trace coverage tracing that you specified. The normal *break condition* can be used to break before the trace coverage condition is satisfied. If you want to include trace coverage in your condition for full control, you can use the [expression functions](./Expression-functions.md).\", \"Notes\": \"You can start a conditional tracing by \\\"Trace over until condition\\\"/\\\"Trace into until condition\\\" commands in the [Debug menu](../gui/menus/Debug.rst).\\n\\nYou should not use commands that can change the running state of the debuggee (such as `run`) inside the breakpoint command, because these commands are unstable when used here. You can use *break condition*, *command condition* or `$tracecondition` instead.\\n\\nWhen you use *Trace Over*, the debuggee would not be paused inside the calls that has been stepped over, even if the condition is true. Also other operations, such as logging and trace record, are not executed. This makes tracing faster, but if these operations are desired you should use *Trace Into*.\", \"See also\": [\"[Tracing](../commands/tracing/index.rst)\", \"[Expressions](Expressions.md)\", \"[Expression Functions](Expression-functions.md)\", \"[String Formatting](Formatting.md)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 2]\"}, {\"title\": \"Expression Functions\", \"description\": null, \"content\": {\"Strings\": [\"`utf8(addr[, count])`: Reads a null-terminated UTF-8 string from `addr` and returns the string value. When a `count` is specified the string will be truncated.\", \"`utf16(addr[, count])`: Reads a null-terminated UTF-16 string from `addr` and returns the string value. When a `count` is specified the string will be truncated.\", \"`ansi(addr[, count])`: Reads a null-terminated ANSI string from `addr` and returns the string value. When a `count` is specified the string will be truncated.\", \"`strstr(str1, str2)`: Find a substring. Example: `strstr(utf8(addr), \\\"abc\\\")`.\", \"`stristr(str1, str2)`: Find a substring (case insensitive).\", \"`streq(str1, str2)`: Compare two strings. Example: `streq(utf8(addr), \\\"abc\\\")`.\", \"`strieq(str1, str2)`: Compare two strings (case insensitive).\", \"`strlen(str)`: Calculates the length of a string.\"], \"GUI Interaction\": [\"`disasm.sel()`/`dis.sel()`: Get the selected address in the disassembly view.\", \"`dump.sel()`: Get the selected address in the dump view.\", \"`stack.sel()`: Get the selected address in the stack view.\"], \"Source\": [\"`src.disp(addr)`: Get displacement of `addr` relative to last source line.\", \"`src.line(addr)`: Get the source line number of `addr`.\"], \"Modules\": [\"`mod.party(addr)`: Get the party number of the module `addr`. `0` is user module, `1` is system module.\", \"`mod.base(addr)`: Get the base address of the module `addr`.\", \"`mod.size(addr)`: Get the size of the module `addr`.\", \"`mod.hash(addr)`: Get the hash of the module `addr`.\", \"`mod.entry(addr)`: Get the entry address of the module `addr`.\", \"`mod.system(addr)`: True if the module at `addr` is a system module. False: module is a user module.\", \"`mod.user(addr)`: True if the module at `addr` is a user module. False: module is NOT a user module.\", \"`mod.main()`: Returns the base of the main module (debuggee). If this is a DLL it will return `0` until loaded.\", \"`mod.rva(addr)`: Get the RVA of `addr`. If `addr` is not inside a module it will return `0`.\", \"`mod.offset(addr)`: Get the file offset of `addr`. If `addr` is not inside a module it will return `0`.\", \"`mod.isexport(addr)`: True if `addr` is an exported function from a module.\", \"`mod.fromname(str)`: Gets the module base for `str`. `0` if the module is not found. Example: `mod.fromname(\\\"ntdll.dll\\\")`.\"], \"Process Information\": [\"`peb()`: Get PEB address.\", \"`teb()`: Get TEB address.\", \"`tid()`: Get the current thread ID.\", \"`kusd()`,`KUSD()`,`KUSER_SHARED_DATA()`: Get the address of `KUSER_SHARED_DATA` (`0x7FFE0000`).\"], \"General Purpose\": [\"`bswap(value)`: Byte-swap `value`. For example, `bswap(44332211)` = 0x11223344.\", \"`ternary(condition, val1, val2)`: If condition is nonzero, return `val1`, otherwise return `val2`.\", \"`GetTickCount()`: The Windows API `GetTickCount()`, a timer that increases every 1ms.\", \"`rdtsc()`: The result of the `RDTSC` instruction, a CPU timer. Only 32-bit result is returned in 32-bit environment.\", \"`isdebuggerfocused()`: Check if x64dbg is focused. Return `1` when x64dbg is focused, otherwise return `0`.\", \"`isdebuggeefocused()`: Check if the debugged program is focused. Return `1` when the debugged program is focused, otherwise return `0`.\"], \"Memory\": [\"`mem.valid(addr)`: True if `addr` is a valid memory address.\", \"`mem.base(addr)`: Returns the base of the memory page of `addr` (can change depending on your memory map mode).\", \"`mem.size(addr)`: Returns the size of the memory page of `addr` (can change depending on your memory map mode).\", \"`mem.iscode(addr)`: True if `addr` is a page that is executable.\", \"`mem.decodepointer(ptr)`: Equivalent to calling the `DecodePointer` API on `ptr`, only works on Vista+.\"], \"Disassembly\": [\"`dis.len(addr)`: Get the length of the instruction at `addr`.\", \"`dis.iscond(addr)`: True if the instruction at `addr` is a conditional branch.\", \"`dis.isbranch(addr)`: True if the instruction at `addr` is a branch (jcc/call).\", \"`dis.isret(addr)`: True if the instruction at `addr` is a `ret`.\", \"`dis.iscall(addr)`: True if the instruction at `addr` is a `call`.\", \"`dis.ismem(addr)`: True if the instruction at `addr` has a memory operand.\", \"`dis.isnop(addr)`: True if the instruction at `addr` is equivalent to a NOP.\", \"`dis.isunusual(addr)`: True if the instruction at `addr` is unusual.\", \"`dis.branchdest(addr)`: Branch destination of the instruction at `addr` (what it follows if you press enter on it).\", \"`dis.branchexec(addr)`: True if the branch at `addr` is going to execute.\", \"`dis.imm(addr)`: Immediate value of the instruction at `addr`.\", \"`dis.brtrue(addr)`: Branch destination of the instruction at `addr`.\", \"`dis.brfalse(addr)`: Address of the next instruction if the instruction at `addr` is a conditional branch.\", \"`dis.next(addr)`: Address of the next instruction from `addr`.\", \"`dis.prev(addr)`: Address of the previous instruction from `addr`.\", \"`dis.iscallsystem(addr)`: True if the instruction at `addr` goes to a system module.\", \"`dis.mnemonic(addr)`: Returns the mnemonic `str` for `addr`. Example: `str.streq(dis.mnemonic(cip), \\\"cpuid\\\")`.\", \"`dis.text(addr)`: Returns the instruction text as a string `addr`. Can be used for conditions, for example: `strstr(dis.text(rip), \\\"rbx\\\")`. **Note**: the instruction text might not exactly match the formatting in the GUI.\", \"`dis.match(addr, str)`: True if the instruction at `addr` matches the regex in `str`. Example: `dis.match(rip, \\\"test.+, 0x1\\\")`. You can use `dis.text` to see what you can match on.\"], \"Tracing\": [\"`tr.enabled(addr)`: True if the trace coverage is enabled at `addr`.\", \"`tr.hitcount(addr)`: Number of hits in the trace coverage at `addr`.\", \"`tr.isrecording()`,`tr.runtraceenabled()`: True if trace recording is enabled.\"], \"Byte/Word/Dword/Qword/Ptr\": [\"`ReadByte(addr)`,`Byte(addr)`,`byte(addr)`: Read a byte from `addr` and return the value. Example: `byte(eax)` reads a byte from memory location `[eax]`.\", \"`ReadWord(addr)`,`Word(addr)`,`word(addr)`: Read a word (2 bytes) from `addr` and return the value.\", \"`ReadDword(addr)`,`Dword(addr)`,`dword(addr)`: Read a dword (4 bytes) from `addr` and return the value.\", \"`ReadQword(addr)`,`Qword(addr)`,`qword(addr)`: Read a qword (8 bytes) from `addr` and return the value (only available on x64).\", \"`ReadPtr(addr)`,`ReadPointer(addr)`,`ptr(addr)`,`Pointer(addr)`,`pointer(addr)`: Read a pointer (4/8 bytes) from `addr` and return the value.\"], \"Functions\": [\"`func.start()`: Return start of the function `addr` is part of, zero otherwise.\", \"`func.end()`: Return end of the function `addr` is part of, zero otherwise.\"], \"References\": [\"`ref.count()`: Number of entries in the current reference view.\", \"`ref.addr(index)`: Get the address of the reference at `index`. Zero on failure.\"], \"Arguments\": \"This assumes the return address is on the stack (eg you are inside the function).\\n\\n['`arg(index)`, `arg.get(index)`: Gets the argument at `index` (zero-based).', '`arg.set(index, value)`: Sets the argument at `index` (zero-based) to `value`.']\", \"Exceptions\": \"This is a set of functions to get information about the last exception. They can be used for exceptions breakpoints to construct more advanced conditions.\\n\\n['`ex.firstchance()`: Whether the last exception was a first chance exception.', '`ex.addr()`: Last exception address. For example the address of the instruction that caused the exception.', '`ex.code()`: Last exception code.', '`ex.flags()`: Last exception flags.', '`ex.infocount()`: Last exception information count (number of parameters).', '`ex.info(index)`: Last exception information, zero if index is out of bounds. For access violations or memory breakpoints `ex.info(1)` contains the address of the accessed memory (see [EXCEPTION_RECORD.ExceptionInformation](https://docs.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-exception_record) for details).']\", \"Syscalls\": [\"`syscall.name(number)`: Returns the name of the syscall of `number` as a string.\", \"`syscall.id(name)`: Returns the syscall number of a `name`.\"], \"Plugins\": \"Plugins can register their own expression functions. You can find an example in the [StackContains](https://github.com/mrexodia/StackContains/blob/315c55381676201ace4cf88bfcb684e62489b129/StackContains/plugin.cpp#L5-L39) plugin. Relevant functions:\\n\\n['[`_plugin_registerexprfunction`](../developers/plugins/API/registerexprfunction.rst)', '[`_plugin_registerexprfunctionex`](../developers/plugins/API/registerexprfunctionex.rst)', '[`_plugin_unregisterexprfunction`](../developers/plugins/API/unregisterexprfunction.rst)']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 3]\"}, {\"title\": \"Expressions\", \"description\": null, \"content\": {\"Values\": \"All values can be used as constants in expressions, see [values](./Values.md) for more information and examples.\\n\\n**Warning: All numbers in expressions are interpreted as hex by default!** For decimal use `.123`.\", \"Operators\": \"You can use the following operators in your expression. They are processed in the following order:\\n\\n['*parentheses/brackets*: `(1+2)`, `[1+6]` have priority over other operations.', '*unary minus/binary not/logical not*: `-1` (negative 1), `~1` (binary not of 1), `!0` (logical not of 0).', '*multiplication/division*: `2*3` (regular multiplication), `` 2`3 `` (gets high part of the multiplication), `6/3` (regular division), `5%3` (modulo/remainder of the division).', '*addition/subtraction*: `1+3` (addition), `5-2` (subtraction).', '*left/right shift/rotate*: `1<<2` (shift left, shl for unsigned, sal for signed), `10>>1` (shift right, shl for unsigned, sal for signed), `1<<<2` (rotate left), `1>>>2` (rotate right).', '*smaller (equal)/bigger (equal)*: `4<10`, `3>6`, `1<=2`, `6>=7` (resolves to 1 if true, 0 if false).', '*equal/not equal*: `1==1`, `2!=6` (resolves to 1 if true, 0 if false).', '*binary and*: `12&2` (regular binary and).', '*binary xor*: `2^1` (regular binary xor).', '*binary or*: `2|8` (regular binary or).', '*logical and*: `0&&3` (resolves to 1 if true, 0 if false).', '*logical or*: `0||3` (resolves to 1 if true, 0 if false).', '*logical implication*: `0->1` (resolved to 1 if true, 0 if false).']\", \"Quick-Assigning\": \"Changing memory, a variable, register or flag can be easily done using a C-like syntax:\\n\\n['`a?=b` where `?` can be any non-logical operator. `a` can be any register, flag, variable or memory location. `b` can be anything that is recognized as an expression.', '`a++/a--` where `a` can be any register, flag, variable or memory location.']\", \"Functions\": \"You can use functions in expressions. See [expression functions](./Expression-functions.md) for the documentation of these functions.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 4]\"}, {\"title\": \"Features\", \"description\": null, \"content\": {\"Basic features\": [\"Full-featured debugging of DLL and EXE files ([TitanEngine Community Edition](https://bitbucket.org/titanengineupdate/titanengine-update))\", \"32-bit and 64-bit Windows support from Windows XP to Windows 10\", \"Built-in assembler ([XEDParse](https://github.com/x64dbg/XEDParse)/[asmjit](https://github.com/asmjit))\", \"Fast disassembler ([Zydis](https://zydis.re))\", \"C-like expression parser\", \"Logging\", \"Notes\", \"Memory map view\", \"Modules and symbols view\", \"Source code view\", \"Thread view\", \"Content-sensitive register view\", \"Call stack view\", \"SEH view\", \"Handles, privileges and TCP connections enumeration.\", \"Multi-datatype memory dump\", \"Dynamic stack view\", \"Executable patching\", \"Dynamically recognize modules and strings\", \"User database ([JSON](http://www.digip.org/jansson)) for comments, labels, bookmarks, etc.\", \"Basic debug symbol (PDB) support\", \"Extendable, debuggable scripting language for automation\", \"Plugin support with growing API\", \"Basic anti-debugging\"], \"Advanced features\": [\"Import reconstructor integrated ([Scylla](https://github.com/NtQuery/Scylla))\", \"Analysis\", \"Conditional breakpoints and tracing with great flexibility\", \"Collect data while tracing\"], \"GUI features\": [\"Intuitive and familiar, yet new user interface\", \"IDA-like sidebar with jump arrows\", \"IDA-like instruction token highlighter (highlight registers, commands, etc.)\", \"Fully customizable color scheme and short-cut keys\", \"Control flow graph\", \"Integrated mnemonic and registers help\", \"Code folding\", \"Easy integration with custom tools (favourites menu)\"]}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 5]\"}, {\"title\": \"String Formatting\", \"description\": null, \"content\": {\"Types\": [\"`d` signed **d**ecimal: `-3`\", \"`u` **u**nsigned decimal: `57329171`\", \"`p` zero prefixed **p**ointer: `0000000410007683`\", \"`s` **s**tring pointer: `\\\"this is a string\\\"` (**not recommended**, use `{utf8@address}` instead)\", \"`x` he**x**: `3C28A` (default for integer values)\", \"`a` **a**ddress info: `00401010 <module.EntryPoint>`\", \"`i` **i**nstruction text: `jmp 0x77ac3c87`\", \"`f` single precision floating-point pointer or register: If `10001234` is an address of a single precision floating-point number 3.14, `{f:10001234}` will print `3.14`. It can also accept XMM, YMM and ZMM registers: `{f:XMM0}` prints the single precision floating-point number at XMM0 bit 31:0, `{f:YMM7[7]}` prints the single precision floating-point number at YMM7 bit 255:224. x87 registers are currently not supported.\", \"`F` double precision floating-point pointer or register: Similar to `f`, except that the data is interpreted as double precision floating-point number. It can also accept XMM, YMM and ZMM registers: `{F:YMM7[3]}` prints the double precision floating-point number at YMM7 bit 255:192.\"], \"Complex Type\": [\"`{mem;size@address}` will print the `size` bytes starting at `address` in hex.\", \"`{winerror@code}` will print the name of windows error code(returned with `GetLastError()`) and the description of it(with `FormatMessage`). It is similar to ErrLookup utility.\", \"`{winerrorname@code}` will print the name of windows error code(returned with `GetLastError()`) only.\", \"`{ntstatus@code}` will print the name of NTSTATUS error code and the description of it(with `FormatMessage`).\", \"`{ntstatusname@code}` will print the name of NTSTATUS error code only.\", \"`{ascii[;length]@address}` will print the ASCII string at `address` with an optional `length` (in bytes).\", \"`{ansi[;length]@address}` will print the ANSI (local codepage) string at `address` with an optional `length` (in bytes).\", \"`{utf8[;length]@address}` will print the UTF-8 string at `address` with an optional `length` (in bytes).\", \"`{utf16[;length]@address}` will print the UTF-16 string at `address` with an optional `length` (in words).\", \"`{disasm@address}` will print the disassembly at `address` (equivalent to `{i:address}`).\", \"`{modname@address}` will print the name of the module at `address`.\", \"`{bswap[;size]@value}` will byte-swap `value` for a specified `size` (size of pointer per default).\", \"`{label@address}` will print the (auto)label at `address`.\", \"`{comment@address}` will print the (auto)comment at `address`.\"], \"Examples\": [\"`rax: {rax}` formats to `rax: 4C76`\", \"`password: {utf16@4*ecx+0x402000}` formats to `password: s3cret`\", \"`function type: {mem;1@[ebp]+0xa}` formats to `function type: 01`\", \"`{x:bswap(rax)}` where `rax=0000000078D333E0` formats to `E033D37800000000` because of bswap fun which reverse the hex value\", \"`{bswap;4@rax}` where `rax=1122334455667788` formats to `88776655`\", \"`mnemonic: {dis.mnemonic(dis.sel())}` formats to `mnemonic: push`\", \"`return address: `{a:[rsp]}` formats to `00401010 <module.myfunction+N>`\"], \"Logging\": \"When using the `log` command you should put quotes around the format string (`log \\\"{mem;8@rax}\\\"`) to avoid ambiguity with the `;` (which separates two commands). See [issue #1931](https://github.com/x64dbg/x64dbg/issues/1931) for more details.\", \"Plugins\": \"Plugins can use [`_plugin_registerformatfunction`](../developers/plugins/API/registerformatfunction.rst) to register custom string formatting functions. The syntax is `{type;arg1;arg2;argN@expression}` where `type` is the name of the registered function, `argN` is any string (these are passed to the formatting function as arguments) and `expression` is any valid expression.\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 6]\"}, {\"title\": \"Glossary\", \"description\": null, \"content\": {\"Glossary\": \"This section describes various terms and concepts used by x64dbg.\\n\\n['**Breakpoint** A breakpoint defines a condition when the debuggee should be paused. There are 5 types of breakpoint, namely software breakpoint, hardware breakpoint, memory breakpoint, DLL breakpoint and exception breakpoint.', '**Conditional Breakpoint** A conditional breakpoint lets you define some simple operations that executes automatically when the breakpoint is hit, and then conditionally resumes program execution. See [documentation for conditional breakpoint](./ConditionalBreakpoint.md) for more information.', '**Conditional Tracing** Conditional tracing lets you execute the program step-by-step, and pause when the specified condition is met. See [documentation for conditional tracing](./ConditionalTracing.md) for more information.', '**DLL Breakpoint** A DLL breakpoint specifies the name of a DLL. When the DLL is loaded or unloaded, the debuggee will be paused.', '**Trace recording** A trace recording is a log of all traced instructions, typically displayed in the [Trace View](../gui/views/Trace.md).', '**Trace coverage** Trace coverage records if and how many times an instruction has been executed. An instruction that has been covered before will be displayed in a different background color (by default green). It is analogous to leaving footprints while exploring a maze.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 7]\"}, {\"title\": \"Inability\", \"description\": null, \"content\": {\"Inability\": \"This section gives a list of features currently not supported in x64dbg. You are always welcome to contribute to x64dbg to help fixing them.\\n\\n['Fine-grained memory breakpoint. Unlike other debuggers, memory breakpoint is supported only on a whole memory page, but not on a subrange of the memory page.', 'Search for non-English strings. Searching for non-English strings via the built-in strings search may not be able to find all the non-English strings. **Update: x64dbg now provides support for non-English strings through a generic algorithm.**', 'Other pending issues at [issues.x64dbg.com](http://issues.x64dbg.com).']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 8]\"}, {\"title\": \"Input\", \"description\": null, \"content\": {\"Input\": \"This section was moved [here](./Values.md)\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 9]\"}, {\"title\": \"Values\", \"description\": null, \"content\": {\"Numbers\": \"**All numbers are interpreted as hex by default!** If you want to be sure, you can `x` or `0x` as a prefix. Decimal numbers can be used by prefixing the number with a dot: `.123=7B`.\", \"Variables\": \"Variables optionally start with a `$` and can only store one DWORD (QWORD on x64). This means that `myvar` and `$myvar` are equivalent. See the [variables](./Variables.md) section for more information.\", \"Registers\": {\"Remarks\": [\"The variable names for most registers are the same as the names for them, except for the following registers: \", \"**x87 Control Word Flag**: The flags for this register is named like this: `_x87CW_UM`\", \"In addition to the registers in the architecture, x64dbg provides the following registers: `CAX` , `CBX` , `CCX` , `CDX` , `CSP` , `CBP` , `CSI` , `CDI` , `CIP`. These registers are mapped to 32-bit registers on 32-bit platform, and to 64-bit registers on 64-bit platform. For example, `CIP` is `EIP` on 32-bit platform, and is `RIP` on 64-bit platform. This feature is intended to support architecture-independent code.\"]}, \"Flags\": \"Debug flags (interpreted as integer) can be used as input. Flags are prefixed with an `_` followed by the flag name. Valid flags are: `_cf`, `_pf`, `_af`, `_zf`, `_sf`, `_tf`, `_if`, `_df`, `_of`, `_rf`, `_vm`, `_ac`, `_vif`, `_vip` and `_id`.\", \"Memory locations\": \"You can read/write from/to a memory location by using one of the following expressions:\\n\\n['`[addr]` read a DWORD/QWORD from `addr`.', '`n:[addr]` read n bytes from `addr`.', '`seg:[addr]` read a DWORD/QWORD from a segment at `addr`.', '`byte:[addr]` read a BYTE from `addr`.', '`word:[addr]` read a WORD from `addr`.', '`dword:[addr]` read a DWORD from `addr`.', '`qword:[addr]` read a QWORD from `addr` (x64 only).', '`n` is the amount of bytes to read, this can be anything not greater than 4 on x32 and not greater than 8 on x64 when specified, otherwise there will be an error.', '`seg` can be `gs`, `es`, `cs`, `fs`, `ds`, `ss`. Only `fs` and `gs` have an effect.']\\n\\nDereferencing an invalid address causes an error, which can be problematic for [conditional breakpoints](./ConditionalBreakpoint.md) or when scripting. You can use the `ReadByte(addr)` family of [expression functions](./Expression-functions.md) to return 0 on error instead.\", \"Labels/Symbols\": \"User-defined labels and symbols are a valid expressions (they resolve to the address of said label/symbol).\", \"Module Data\": {\"DLL exports\": \"Type `GetProcAddress` and it will automatically be resolved to the actual address of the function. To explicitly define from which module to load the API, use: `module.dll:api` or `module:api`. In a similar way you can resolve ordinals, try `module:ordinal`. Another macro allows you to get the loaded base of a module. When `module` is an empty string (`:myexport` for example), the module that is currently selected in the CPU will be used. Using a `.` instead of a `:` is equivalent.\\n\\n```\\nntdll.dll:ZwContinue\\nntdll:memcmp\\nntdll.memcmp // same as above\\nntdll:1D // Ordinal 0x1D\\n:myexport // Export 'myexport' in the current module\\n```\\n\\nForwarded exports are resolved to their final address. To prevent this you can use a `?` instead of `:`.\\n\\n```\\nkernel32:EnterCriticalSection // resolves to ntdll:RtlEnterCriticalSection\\nkernel32?EnterCriticalSection // resolves to the export in kernel32\\n```\", \"Loaded module bases\": \"If you want to access the loaded module base, you can write: `module`, `module:0`, `module:base`, `module:imagebase` or `module:header`.\", \"RVA/File offset\": \"If you want to access a module RVA you can either write `module + rva` or you can write `module:$rva`. If you want to convert a file offset to a VA you can use `module:#offset`. When `module` is an empty string (`:$123` for example), the module that is currently selected in the CPU will be used.\\n\\n```\\n// File offset 0x400\\nntdll.dll:#400\\n:#400\\n// RVA 0x1000\\nntdll.dll:$1000 // RVA 0x1000\\n:$1000\\n```\", \"Module entry points\": \"To access a module entry point you can write `module:entry`, `module:oep` or `module:ep`. Notice that when there are exports with the names `entry`, `oep` or `ep` the address of these will be returned instead.\"}}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 10]\"}, {\"title\": \"Variables\", \"description\": null, \"content\": {\"Setting variables\": \"You can set variables in the following ways:\\n\\n```\\nmov myvar, 1234\\nmov $myvar, 1234\\nmyvar = 1234\\n$myvar = 1234\\n```\\n\\nAll of the above set a USER variable `myvar` to the [value](./Values.md) `0x1234`. You can also use the C-style assignment operators (see the [expression](./Expressions.md) documentation for a full list of supported operators):\\n\\n```\\nmyvar += 0x10\\nmyvar |= 0x10\\nmyvar++\\nmyvar--\\n```\", \"Reserved Variables\": \"There are a few reserved variables:\\n\\n['`$res`/`$result`: General result variable.', '`$resN`/`$resultN`: Optional other result variables (N= 1-4).', '`$pid`: Process ID of the debugged executable.', '`$hp`/`$hProcess`: Debugged executable handle.', '`$lastalloc`: Last result of the `alloc` command.', '`$breakpointcondition` : Controls the pause behaviour in the conditional breakpoint command.', '`$breakpointcounter` : The hit counter of the breakpoint, set before the condition of the conditional breakpoint is evaluated.', '`$breakpointlogcondition` : The log condition of the conditional breakpoint. It cannot be used to control the logging behavoiur.']\"}, \"metadata\": {}, \"subpages\": [], \"path\": \"[\\\"subpages\\\", 6, \\\"subpages\\\", 11]\"}], \"path\": \"[\\\"subpages\\\", 6]\"}]}"},"rubrics":{"kind":"string","value":"{\"rubrics\": [{\"requirements\": \"Core Debugging Engine - Multi-architecture debugging system with comprehensive process control and memory management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Process Lifecycle Management - Controls target process execution states and debugging sessions\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Debug Session Control - Manages attachment, initialization, and termination of debugging sessions\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Process attachment and detachment mechanisms with state validation\", \"weight\": 3}, {\"requirements\": \"Debug initialization and cleanup procedures\", \"weight\": 3}, {\"requirements\": \"Anti-debugging evasion capabilities to hide debugger presence\", \"weight\": 1}]}, {\"requirements\": \"Execution Control Engine - Implements comprehensive execution flow control\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Single-step execution modes (into, over, out) with exception awareness\", \"weight\": 3}, {\"requirements\": \"Continuous execution with pause/resume capabilities\", \"weight\": 3}, {\"requirements\": \"Instruction undo and reverse execution support\", \"weight\": 1}]}, {\"requirements\": \"Thread Management System - Controls and monitors multiple execution threads\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Thread lifecycle operations (create, suspend, resume, terminate)\", \"weight\": 2}, {\"requirements\": \"Thread context switching and priority management\", \"weight\": 2}, {\"requirements\": \"Thread-specific debugging state tracking\", \"weight\": 2}]}]}, {\"requirements\": \"Memory Management Subsystem - Comprehensive virtual memory operations and analysis\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Memory Access Layer - Provides safe read/write operations with validation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Safe memory read/write with bounds checking\", \"weight\": 3}, {\"requirements\": \"Memory allocation and deallocation in target process\", \"weight\": 2}, {\"requirements\": \"Page protection and rights management\", \"weight\": 2}]}, {\"requirements\": \"Memory Layout Analysis - Tracks and analyzes virtual memory structure\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Virtual memory region enumeration and analysis\", \"weight\": 2}, {\"requirements\": \"Module base address resolution and tracking\", \"weight\": 3}, {\"requirements\": \"Memory dump generation and export capabilities\", \"weight\": 2}]}]}, {\"requirements\": \"OS-Level Integration - System-level debugging capabilities and privilege management\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Privilege escalation and management for system-level debugging\", \"weight\": 2}, {\"requirements\": \"Handle manipulation and system resource access\", \"weight\": 1}, {\"requirements\": \"JIT debugger registration and management\", \"weight\": 1}]}]}, {\"requirements\": \"Breakpoint Management System - Comprehensive multi-type breakpoint engine with advanced conditional logic\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Multi-Type Breakpoint Engine - Implements various breakpoint mechanisms\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Software Breakpoints - INT3-based execution breakpoints with collision management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Instruction patching and restoration mechanism\", \"weight\": 3}, {\"requirements\": \"Breakpoint collision detection and management\", \"weight\": 2}]}, {\"requirements\": \"Hardware Breakpoints - CPU debug register utilization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Debug register allocation and management\", \"weight\": 3}, {\"requirements\": \"Access type specification (read, write, execute)\", \"weight\": 3}]}, {\"requirements\": \"Memory Breakpoints - Page-based memory access monitoring\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Memory page protection manipulation for monitoring\", \"weight\": 3}, {\"requirements\": \"Range-based memory monitoring\", \"weight\": 2}]}, {\"requirements\": \"Exception Breakpoints - Exception-based debugging triggers\", \"weight\": 2}, {\"requirements\": \"Library Breakpoints - DLL load/unload event handling\", \"weight\": 1}]}, {\"requirements\": \"Conditional Logic Engine - Advanced breakpoint logic and automation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Expression Evaluation System - Runtime condition checking\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Boolean expression parser and evaluator for breakpoint conditions\", \"weight\": 3}, {\"requirements\": \"Context-aware variable, register, and memory value resolution\", \"weight\": 3}]}, {\"requirements\": \"Hit Count Management - Breakpoint frequency control\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Hit counter tracking and reset mechanisms\", \"weight\": 2}, {\"requirements\": \"Conditional hit count thresholds\", \"weight\": 2}]}, {\"requirements\": \"Automated Actions - Script execution and logging on breakpoint hits\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Command execution engine for breakpoint actions\", \"weight\": 3}, {\"requirements\": \"Logging and output generation system\", \"weight\": 2}, {\"requirements\": \"Silent breakpoint execution (no UI interruption)\", \"weight\": 2}]}]}]}, {\"requirements\": \"Code Analysis and Disassembly Engine - Multi-architecture instruction analysis with static and dynamic capabilities\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Disassembly Engine - Multi-architecture instruction decoding and assembly\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Instruction Decoder - Raw bytes to assembly conversion\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"x86/x64 instruction set support with extensions\", \"weight\": 3}, {\"requirements\": \"Instruction length calculation and validation\", \"weight\": 3}, {\"requirements\": \"Operand analysis and addressing mode resolution\", \"weight\": 2}]}, {\"requirements\": \"Assembly Engine - Assembly to machine code conversion\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Runtime instruction patching capabilities\", \"weight\": 2}, {\"requirements\": \"Instruction encoding validation\", \"weight\": 2}]}]}, {\"requirements\": \"Static Analysis Engine - Code structure and flow analysis without execution\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Control Flow Analysis - Program structure understanding\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Function boundary detection and basic block identification\", \"weight\": 3}, {\"requirements\": \"Loop detection and structure analysis\", \"weight\": 2}, {\"requirements\": \"Branch destination calculation and control flow mapping\", \"weight\": 3}]}, {\"requirements\": \"Cross-Reference Analysis - Code relationship mapping\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Reference tracking and enumeration for code and data\", \"weight\": 3}, {\"requirements\": \"Call graph construction and analysis\", \"weight\": 2}]}]}, {\"requirements\": \"Dynamic Analysis Capabilities - Runtime behavior analysis and tracing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Execution Tracing Engine - Runtime execution recording and playback\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Instruction trace recording to specified file formats\", \"weight\": 3}, {\"requirements\": \"Conditional tracing with intelligent filtering\", \"weight\": 3}, {\"requirements\": \"Trace coverage analysis and logic differentiation\", \"weight\": 2}]}]}, {\"requirements\": \"Search and Pattern Matching - Advanced search capabilities across memory and code\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Memory Search Engine - Pattern finding in process memory\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Binary pattern search with wildcards\", \"weight\": 2}, {\"requirements\": \"String search (ASCII/Unicode) with encoding detection\", \"weight\": 2}, {\"requirements\": \"GUID pattern recognition and search\", \"weight\": 1}]}, {\"requirements\": \"Code Search Engine - Assembly instruction and reference finding\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Assembly instruction pattern matching\", \"weight\": 2}, {\"requirements\": \"Reference and cross-reference enumeration\", \"weight\": 2}]}]}]}, {\"requirements\": \"Symbol and Data Type Management - Comprehensive symbolic information and user-defined type system\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Symbol Management System - Debug symbol loading and resolution\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Symbol Loading Engine - External symbol file management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"PDB symbol loading and management\", \"weight\": 2}, {\"requirements\": \"Symbol download and caching system\", \"weight\": 1}]}]}, {\"requirements\": \"User-Defined Type System - Custom data type definition and visualization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Data Type Engine - Memory interpretation and type definition\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Primitive type definitions (byte, word, dword, qword)\", \"weight\": 2}, {\"requirements\": \"Complex type definitions (structures, unions, function signatures)\", \"weight\": 3}, {\"requirements\": \"String type handling (ASCII, Unicode)\", \"weight\": 2}, {\"requirements\": \"Floating-point type support\", \"weight\": 1}]}, {\"requirements\": \"Type Visualization - Memory data interpretation display\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Type-aware memory dump formatting\", \"weight\": 2}, {\"requirements\": \"Structure member expansion and navigation\", \"weight\": 2}]}]}, {\"requirements\": \"Annotation Database - Persistent user metadata storage\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Annotation Management - User-defined code annotations\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Label management system for address naming\", \"weight\": 3}, {\"requirements\": \"Comment system for code documentation\", \"weight\": 2}, {\"requirements\": \"Bookmark system for important locations\", \"weight\": 2}]}, {\"requirements\": \"Function Metadata - Function signature and argument tracking\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Function definition and boundary management\", \"weight\": 2}, {\"requirements\": \"Argument type and name annotation\", \"weight\": 2}]}, {\"requirements\": \"Database Persistence - Save/load user analysis data\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Database serialization and deserialization\", \"weight\": 2}, {\"requirements\": \"Database clearing and reset operations\", \"weight\": 1}]}]}]}, {\"requirements\": \"Scripting and Automation Framework - Comprehensive automation system with expression evaluation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Expression Evaluation Engine - Mathematical and logical expression processing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Expression Parser - Complex expression evaluation with context awareness\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Arithmetic, bitwise, and logical operation support\", \"weight\": 2}, {\"requirements\": \"Register, flag, memory address, and symbol value resolution\", \"weight\": 3}, {\"requirements\": \"Built-in function library for advanced queries and manipulations\", \"weight\": 2}]}, {\"requirements\": \"Variable Management - User-defined variable storage and scope handling\", \"weight\": 2}]}, {\"requirements\": \"Script Execution Engine - Built-in scripting language runtime\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Script Language Parser - Command interpretation and execution\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Control flow statements (conditionals, loops, jumps)\", \"weight\": 2}, {\"requirements\": \"Function call and return mechanisms\", \"weight\": 2}, {\"requirements\": \"Script loading from files and direct command execution\", \"weight\": 2}]}, {\"requirements\": \"Script Debugging - Script execution control and monitoring\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Script breakpoint management\", \"weight\": 1}, {\"requirements\": \"Step-by-step script execution\", \"weight\": 1}]}]}]}, {\"requirements\": \"Plugin and Extensibility Architecture - Comprehensive third-party extension framework\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Plugin Lifecycle Management - Dynamic library loading and management\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Plugin discovery and loading mechanisms\", \"weight\": 2}, {\"requirements\": \"Plugin unloading and cleanup procedures\", \"weight\": 1}]}, {\"requirements\": \"Plugin API Bridge - Interface between plugins and core systems\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Debug Engine API - Core debugging functionality exposure\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Complete debugger engine API access for plugins\", \"weight\": 3}, {\"requirements\": \"Shared memory and data marshalling between components\", \"weight\": 2}]}, {\"requirements\": \"Event System - Plugin notification and callback management\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Event-driven callbacks for debugger events (process creation, breakpoint hit)\", \"weight\": 3}, {\"requirements\": \"Plugin registration system for event handling\", \"weight\": 2}]}, {\"requirements\": \"UI Integration - Plugin interface extension capabilities\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Custom menu and toolbar integration\", \"weight\": 2}, {\"requirements\": \"Plugin window and tab management\", \"weight\": 2}, {\"requirements\": \"Command-line auto-completion extension\", \"weight\": 1}]}]}]}, {\"requirements\": \"User Interface and Visualization System - Multi-view debugging interface with real-time state synchronization\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"View Management System - Multiple debugging perspective coordination\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Disassembly View - Code visualization and navigation\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Syntax highlighting and instruction formatting\", \"weight\": 2}, {\"requirements\": \"Address navigation and goto functionality\", \"weight\": 2}, {\"requirements\": \"Code folding and organization features\", \"weight\": 1}]}, {\"requirements\": \"Memory and Data Views - Memory visualization and editing\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Hexadecimal dump with ASCII representation and editing\", \"weight\": 3}, {\"requirements\": \"Multiple dump windows for comparison\", \"weight\": 2}, {\"requirements\": \"Stack memory dump with frame analysis and call trace\", \"weight\": 2}]}, {\"requirements\": \"Register and System State Views - CPU state visualization\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"General-purpose register display and editing\", \"weight\": 2}, {\"requirements\": \"FPU and SIMD register visualization\", \"weight\": 1}, {\"requirements\": \"Flag register state indication\", \"weight\": 2}]}, {\"requirements\": \"Specialized Views - Symbols, threads, and references\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Symbol browser and management interface\", \"weight\": 2}, {\"requirements\": \"Thread list and management interface\", \"weight\": 2}, {\"requirements\": \"Reference and search result display with navigation\", \"weight\": 2}]}]}, {\"requirements\": \"Graph Visualization - Control flow and call graph display\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"Interactive control flow graph generation and rendering\", \"weight\": 2}, {\"requirements\": \"Graph navigation, zoom controls, and export functionality\", \"weight\": 1}]}, {\"requirements\": \"State Synchronization Mechanism - Real-time UI updates and debugging state reflection\", \"weight\": 3, \"sub_tasks\": [{\"requirements\": \"Engine-to-GUI event propagation for state changes\", \"weight\": 3}, {\"requirements\": \"Performance-optimized update management with selective refresh\", \"weight\": 2}]}, {\"requirements\": \"Watch and Monitor System - Variable and expression monitoring\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Watch expression management and real-time evaluation\", \"weight\": 1}, {\"requirements\": \"Value change detection and notification\", \"weight\": 1}]}, {\"requirements\": \"User Input and Command Processing - Command line and UI interaction handling\", \"weight\": 2}]}, {\"requirements\": \"Configuration and Integration Management - System configuration and external tool integration\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Configuration Management - Settings and preference handling\", \"weight\": 2, \"sub_tasks\": [{\"requirements\": \"System-wide settings and configuration persistence\", \"weight\": 2}, {\"requirements\": \"Event handling configuration and customization\", \"weight\": 1}]}, {\"requirements\": \"External Tool Integration - Third-party tool and utility support\", \"weight\": 1, \"sub_tasks\": [{\"requirements\": \"Scylla import reconstruction integration\", \"weight\": 1}, {\"requirements\": \"External utility integration and workflow support\", \"weight\": 1}]}]}]}"}}}],"truncated":false,"partial":false},"paginationData":{"pageIndex":0,"numItemsPerPage":100,"numTotalItems":22,"offset":0,"length":100}},"jwt":"eyJhbGciOiJFZERTQSJ9.eyJyZWFkIjp0cnVlLCJwZXJtaXNzaW9ucyI6eyJyZXBvLmNvbnRlbnQucmVhZCI6dHJ1ZX0sImlhdCI6MTc4MDkzNjg4NSwic3ViIjoiL2RhdGFzZXRzL25kbWluaDE3MDYvYW5oZGVwIiwiZXhwIjoxNzgwOTQwNDg1LCJpc3MiOiJodHRwczovL2h1Z2dpbmdmYWNlLmNvIn0.ZCC8SFT362k8G0ICn9JDsgHE_pqN8xSXBs4s2nfLoTD-sFRruasFF5PuA5c-kbJjxJ6-eTNVmm0B3JuoADkEBw","displayUrls":true,"splitSizeSummaries":[{"config":"default","split":"train","numRows":22,"numBytesParquet":6142035}]},"discussionsStats":{"closed":0,"open":1,"total":1},"fullWidth":true,"hasGatedAccess":true,"hasFullAccess":true,"isEmbedded":false,"savedQueries":{"community":[],"user":[]}}">
repo_name stringlengths 4 27 | repo_url stringlengths 30 66 | commit_id stringlengths 40 40 | docs_tree stringlengths 5.5k 270k | structured_docs stringlengths 94.3k 2.51M | rubrics stringlengths 6.56k 18k |
|---|---|---|---|---|---|
Chart.js | https://github.com/chartjs/Chart.js | 6372280085625b43ef34d7b70f3e86b063d22a10 | {"title": "Chart.js", "description": "Documentation for Chart.js", "subpages": [{"title": "Chart.js", "path": "[\"subpages\", 0]", "content": {"Why Chart.js": {"Features": "<detail_content>", "Defaults": "<detail_content>", "Integrations": "<detail_content>", "Developer experience": "<detail_content>", "Canvas renderin... | {"title": "Chart.js", "description": "Documentation for Chart.js", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/Chart.js/original/docs"}, "subpages": [{"title": "Chart.js", "description": null, "content": {"Why Chart.js": {"Features": "Chart.js provides a set of frequently used ch... | {"rubrics": [{"requirements": "Chart Instance and Lifecycle Management", "weight": 3, "sub_tasks": [{"requirements": "Chart Instantiation and Configuration", "weight": 3, "sub_tasks": [{"requirements": "The system provides a primary Chart object that encapsulates all state and functionality for a single chart instance ... |
FluentValidation | https://github.com/FluentValidation/FluentValidation | 298069b4ef88241013d0573f38e25c936e80685f | {"title": "FluentValidation", "description": "Documentation for FluentValidation", "subpages": [{"title": "Other Advanced Features", "path": "[\"subpages\", 0]", "content": {"PreValidate": "<detail_content>", "Root Context Data": "<detail_content>", "Customizing the Validation Exception": "<detail_content>"}}, {"title"... | {"title": "FluentValidation", "description": "Documentation for FluentValidation", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/FluentValidation/original/docs"}, "subpages": [{"title": "Other Advanced Features", "description": null, "content": {"PreValidate": "If you need to run s... | {"rubrics": [{"requirements": "Core Validation Engine - The fundamental validation processing system that orchestrates rule definition, execution, and result generation", "weight": 3, "sub_tasks": [{"requirements": "Validation Rule Definition and Composition System - Framework for declaring, structuring, and combining ... |
OpenHands | https://github.com/All-Hands-AI/OpenHands | 30604c40fc6e9ac914089376f41e118582954f22 | {"title": "OpenHands", "description": "Documentation for OpenHands", "subpages": [{"title": "Documentation Style Guide", "path": "[\"subpages\", 0]", "content": {"General Writing Principles": "<detail_content>", "Formatting Guidelines": {"Headers": "<detail_content>", "Lists": "<detail_content>", "Procedures": "<detail... | {"title": "OpenHands", "description": "Documentation for OpenHands", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/OpenHands/original/docs"}, "subpages": [{"title": "Documentation Style Guide", "description": null, "content": {"General Writing Principles": ["**Clarit... | {"rubrics": [{"requirements": "Core AI Agent Architecture", "weight": 3, "sub_tasks": [{"requirements": "CodeActAgent - Primary Agentic Component", "weight": 3, "sub_tasks": [{"requirements": "Task-driven reasoning loop (plan \u2192 execute \u2192 observe \u2192 revise)", "weight": 3}, {"requirements": "ActionSpace man... |
electron | https://github.com/electron/electron | 828fd59a72e673acf03f878b4f488a40fca46dfe | {"title": "electron", "description": "Documentation for electron", "subpages": [{"title": "Official Guides", "path": "[\"subpages\", 0]", "content": {"FAQ": "<detail_content>", "Guides and Tutorials": {"Getting started": "<detail_content>", "Learning the basics": "<detail_content>", "Advanced steps": "<detail_content>"... | {"title": "electron", "description": "Documentation for electron", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/electron/original/docs"}, "subpages": [{"title": "Official Guides", "description": null, "content": {"FAQ": "There are questions that are asked quite ofte... | {"rubrics": [{"requirements": "Core Multi-Process Architecture: A desktop runtime combining Chromium frontend with Node.js backend in isolated processes", "weight": 3, "sub_tasks": [{"requirements": "Main Process: Central control unit with full Node.js and OS access managing application lifecycle and coordinating all c... |
git-credential-manager | https://github.com/git-ecosystem/git-credential-manager | b62021fdd7f0e28bf851580e0afd834976bd79d1 | {"title": "git-credential-manager", "description": "Documentation for git-credential-manager", "subpages": [{"title": "Readme", "path": "[\"subpages\", 0]", "content": {"User documentation": "<detail_content>"}}, {"title": "Architecture", "path": "[\"subpages\", 1]", "content": {"Overview": {"Cross-platform UI": "<deta... | {"title": "git-credential-manager", "description": "Documentation for git-credential-manager", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/git-credential-manager/original/docs"}, "subpages": [{"title": "Readme", "description": null, "content": {"User documentation": "The followin... | {"rubrics": [{"requirements": "Git Credential Helper Protocol Implementation and Core Execution Flow", "weight": 3, "sub_tasks": [{"requirements": "Git credential helper command implementation", "weight": 3, "sub_tasks": [{"requirements": "Implements the 'get' command to find and return a credential for a given remote ... |
graphrag | https://github.com/microsoft/graphrag | a398cc38bb75c17ee37894f2f2a751e2231d9347 | {"title": "graphrag", "description": "Documentation for graphrag", "subpages": [{"title": "Blog Posts", "path": "[\"subpages\", 0]", "content": {"root": "<detail_content>"}}, {"title": "Cli", "path": "[\"subpages\", 1]", "content": {"CLI Reference": "<detail_content>"}}, {"title": "Getting Started", "path": "[\"subpage... | {"title": "graphrag", "description": "Documentation for graphrag", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/graphrag/original/docs"}, "subpages": [{"title": "Blog Posts", "description": null, "content": {"root": ["<div class=\"grid cards\" markdown>", ["[:octicons-arrow-right-... | {"rubrics": [{"requirements": "GraphRAG Knowledge Graph Construction System", "weight": 3, "sub_tasks": [{"requirements": "Multi-Phase Indexing Pipeline", "weight": 3, "sub_tasks": [{"requirements": "Document Processing and Text Unit Composition", "weight": 3, "sub_tasks": [{"requirements": "Multi-format input data ing... |
json | https://github.com/nlohmann/json | 4bc4e37f4f56f88b3a80abb7a6508b19a244e803 | {"title": "json", "description": "Documentation for json", "subpages": [{"title": "Documentation", "path": "[\"subpages\", 0]", "content": {"Generate documentation": "<detail_content>"}}, {"title": "Docset", "description": "Documentation section: docset", "path": "[\"subpages\", 1]", "subpages": [{"title": "docset", "p... | {"title": "json", "description": "Documentation for json", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/json/original/docs"}, "subpages": [{"title": "Documentation", "description": null, "content": {"Generate documentation": "Note on documentation: The source files contain links t... | {"rubrics": [{"requirements": "Core JSON Object Model and Type System", "weight": 3, "sub_tasks": [{"requirements": "Templated Class Architecture", "weight": 3, "sub_tasks": [{"requirements": "The central class `basic_json` is a template, allowing customization of underlying container types (object_t, array_t), string ... |
libsql | https://github.com/tursodatabase/libsql | 6e55668cdb1d1d7406ea7fd6eea22991ac1ac301 | {"title": "libsql", "description": "Documentation for libsql", "subpages": [{"title": "Libsql-server admin API documentation", "path": "[\"subpages\", 0]", "content": {"Routes": "<detail_content>"}}, {"title": "Build and run sqld", "path": "[\"subpages\", 1]", "content": {"Running sqld": "<detail_content>", "Query sqld... | {"title": "libsql", "description": "Documentation for libsql", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/libsql/original/docs"}, "subpages": [{"title": "Libsql-server admin API documentation", "description": null, "content": {"Routes": "```\nPOST /v1/namespaces/:... | {"rubrics": [{"requirements": "libsql Distributed Database System: A SQLite-compatible database system built for replication and modern client-server interaction", "weight": 3, "sub_tasks": [{"requirements": "Core SQLite Engine Foundation: Extended SQLite engine with distributed capabilities", "weight": 3, "sub_tasks":... |
logstash | https://github.com/elastic/logstash | 895cfa5b14633ae9b9e671105f7b7935c9f2b9f1 | {"title": "logstash", "description": "Documentation for logstash", "subpages": [{"title": "Extend", "description": "Documentation section: extend", "path": "[\"subpages\", 0]", "subpages": [{"title": "How to write a Logstash codec plugin [codec-new-plugin]", "path": "[\"subpages\", 0, \"subpages\", 0]", "content": {"Ge... | {"title": "logstash", "description": "Documentation for logstash", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/logstash/original/docs"}, "subpages": [{"title": "Extend", "description": "Documentation section: extend", "content": {}, "metadata": {"type": "directory"... | {"rubrics": [{"requirements": "Core Pipeline Architecture and Processing Model", "weight": 3, "sub_tasks": [{"requirements": "Four-Stage Pipeline Structure (Input \u2192 Filter \u2192 Output with Codec support)", "weight": 3, "sub_tasks": [{"requirements": "Input Stage: Event ingestion and generation from diverse data ... |
marktext | https://github.com/marktext/marktext | 11c8cc1e1929a7975df39fa5f4503130fef53547 | {"title": "marktext", "description": "Documentation for marktext", "subpages": [{"title": "Application Data Directory", "path": "[\"subpages\", 0]", "content": {"Application Data Directory": "<detail_content>"}}, {"title": "Basics", "path": "[\"subpages\", 1]", "content": {"Getting started": {"Interface": {"Toggle side... | {"title": "marktext", "description": "Documentation for marktext", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/marktext/original/docs"}, "subpages": [{"title": "Application Data Directory", "description": null, "content": {"Application Data Directory": "The per-user application d... | {"rubrics": [{"requirements": "Cross-platform Electron Application Architecture", "weight": 3, "sub_tasks": [{"requirements": "Dual-Process Model Implementation", "weight": 3, "sub_tasks": [{"requirements": "Main Process Management", "weight": 3, "sub_tasks": [{"requirements": "Application lifecycle and window manageme... |
material-components-android | https://github.com/material-components/material-components-android | c2051db2a9be2a1e23f1128bfc76a9ff29ede7c4 | {"title": "material-components-android", "description": "Documentation for material-components-android", "subpages": [{"title": "Building From the Latest Source", "path": "[\"subpages\", 0]", "content": {"Useful Links": "<detail_content>"}}, {"title": "Catalog App", "path": "[\"subpages\", 1]", "content": {"Useful Link... | {"title": "material-components-android", "description": "Documentation for material-components-android", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/material-components-android/original/docs"}, "subpages": [{"title": "Building From the Latest Source", "description": null, "conten... | {"rubrics": [{"requirements": "Core Library Integration & Bootstrapping", "weight": 3, "sub_tasks": [{"requirements": "Application Setup and Environment Configuration", "weight": 3, "sub_tasks": [{"requirements": "Material Theme Inheritance System", "weight": 3, "sub_tasks": [{"requirements": "Requires application them... |
mermaid | https://github.com/mermaid-js/mermaid | 82800a2c8461370fe133458c12dd42bdc5dc3871 | {"title": "mermaid", "description": "Documentation for mermaid", "subpages": [{"title": "Custom SVG Shapes Library", "path": "[\"subpages\", 0]", "content": {"Overview": "<detail_content>", "Shape Helpers and Utilities": "<detail_content>", "Available Utilities": {"1. `labelHelper`": "<detail_content>", "2. `updateNode... | {"title": "mermaid", "description": "Documentation for mermaid", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/mermaid/original/docs"}, "subpages": [{"title": "Custom SVG Shapes Library", "description": null, "content": {"Overview": "", "Shape Helpers and Utilities": "Before starti... | {"rubrics": [{"requirements": "Core Rendering Pipeline: The central mechanism that transforms Mermaid text into visual SVG diagrams", "weight": 3, "sub_tasks": [{"requirements": "Initialization and Execution Flow: The process of setting up the environment and rendering diagrams", "weight": 3, "sub_tasks": [{"requiremen... |
ml-agents | https://github.com/Unity-Technologies/ml-agents | 4cf2f49ad0a973c95eb41325aa3a46959f187708 | {"title": "ml-agents", "description": "Documentation for ml-agents", "subpages": [{"title": "Api Reference", "path": "[\"subpages\", 0]", "content": {"API Reference": "<detail_content>"}}, {"title": "Background: Machine Learning", "path": "[\"subpages\", 1]", "content": {"Unsupervised Learning": "<detail_content>", "Su... | {"title": "ml-agents", "description": "Documentation for ml-agents", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/ml-agents/original/docs"}, "subpages": [{"title": "Api Reference", "description": null, "content": {"API Reference": "Our developer-facing C# classes ha... | {"rubrics": [{"requirements": "Core System Architecture: Dual-component design separating Unity simulation environment from Python training framework with standardized communication protocol", "weight": 3, "sub_tasks": [{"requirements": "Unity Simulation Environment: C# runtime for agent interaction, data collection, a... |
puppeteer | https://github.com/puppeteer/puppeteer | c1105f125c71353587a837958c2748097ef2927d | {"title": "puppeteer", "description": "Documentation for puppeteer", "subpages": [{"title": "Changelog", "path": "[\"subpages\", 0]", "content": {"[24.17.1](https://github.com/puppeteer/puppeteer/compare/puppeteer-v24.17.0...puppeteer-v24.17.1) (2025-08-28)": {"Miscellaneous Chores": "<detail_content>", "Dependencies":... | {"title": "puppeteer", "description": "Documentation for puppeteer", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/puppeteer/original/docs"}, "subpages": [{"title": "Changelog", "description": null, "content": {"[24.17.1](https://github.com/puppeteer/puppeteer/compar... | {"rubrics": [{"requirements": "Browser Automation Engine - Core system that controls web browsers through standardized protocols", "weight": 3, "sub_tasks": [{"requirements": "Multi-Protocol Communication Layer - Manages bidirectional communication with browsers via CDP and WebDriver BiDi", "weight": 3, "sub_tasks": [{... |
qmk_firmware | https://github.com/qmk/qmk_firmware | 1a58fce043e7f2e2b938dee03945dabc29e48d73 | {"title": "qmk_firmware", "description": "Documentation for qmk_firmware", "subpages": [{"title": "Documentation Capabilities", "path": "[\"subpages\", 0]", "content": {"Overall capabilities": {"Dividing lines": "<detail_content>", "Images": "<detail_content>", "Lists": "<detail_content>", "Emoji {#emoji}": {"Direct:":... | {"title": "qmk_firmware", "description": "Documentation for qmk_firmware", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/qmk_firmware/original/docs"}, "subpages": [{"title": "Documentation Capabilities", "description": null, "content": {"Overall capabilities": {"Dividing lines": "[... | {"rubrics": [{"requirements": "Core Firmware Architecture - The fundamental runtime system orchestrating keyboard operations and execution flow", "weight": 3, "sub_tasks": [{"requirements": "Main Execution Loop - The central process that orchestrates all keyboard operations", "weight": 3, "sub_tasks": [{"requirements":... |
rasa | https://github.com/RasaHQ/rasa | f28c69e4672cd978745f5a73396c79c26017d612 | {"title": "rasa", "description": "Documentation for rasa", "subpages": [{"title": "Docs", "path": "[\"subpages\", 0]", "content": {"Useful commands": {"Installation": "<detail_content>", "Local Development": "<detail_content>", "Build": "<detail_content>", "Deployment": "<detail_content>"}, "Manual steps after a new ve... | {"title": "rasa", "description": "Documentation for rasa", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/rasa/original/docs"}, "subpages": [{"title": "Docs", "description": null, "content": {"Useful commands": {"Installation": "Firstly, install python dependencies for Rasa:\n\n```\... | {"rubrics": [{"requirements": "Core Conversational AI Architecture", "weight": 3, "sub_tasks": [{"requirements": "Natural Language Understanding (NLU) Pipeline", "weight": 3, "sub_tasks": [{"requirements": "Text Processing and Tokenization", "weight": 3, "sub_tasks": [{"requirements": "Language-specific tokenizers (Whi... |
storybook | https://github.com/storybookjs/storybook | f739234e9972691f757430404d8988e40b2dcf4c | {"title": "storybook", "description": "Documentation for storybook", "subpages": [{"title": "Frequently Asked Questions", "path": "[\"subpages\", 0]", "content": {"Error: No angular.json file found": "<detail_content>", "How can I opt-out of Angular Ivy?": "<detail_content>", "How can I opt-out of Angular ngcc?": "<det... | {"title": "storybook", "description": "Documentation for storybook", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/storybook/original/docs"}, "subpages": [{"title": "Frequently Asked Questions", "description": null, "content": {"Error: No angular.json file found": "Storybook can be... | {"rubrics": [{"requirements": "Storybook Core Architecture: Dual-Process Component Development System", "weight": 3, "sub_tasks": [{"requirements": "Manager Application: Development Environment Shell", "weight": 3, "sub_tasks": [{"requirements": "React-based UI orchestration system providing main interface elements", "... |
sumatrapdf | https://github.com/sumatrapdfreader/sumatrapdf | cdadfde74471e9b06898e5c1e87edd98b4204597 | {"title": "sumatrapdf", "description": "Documentation for sumatrapdf", "subpages": [{"title": "Md", "description": "Documentation section: md", "path": "[\"subpages\", 0]", "subpages": [{"title": "Accessibility and Text-to-Speech", "path": "[\"subpages\", 0, \"subpages\", 0]", "content": {"Accessibility in SumatraPDF p... | {"title": "sumatrapdf", "description": "Documentation for sumatrapdf", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/sumatrapdf/original/docs"}, "subpages": [{"title": "Md", "description": "Documentation section: md", "content": {}, "metadata": {"type": "directory", "path": "/home/... | {"rubrics": [{"requirements": "Document Processing Engine", "weight": 3, "sub_tasks": [{"requirements": "Multi-Format Document Parsing and Rendering", "weight": 3, "sub_tasks": [{"requirements": "PDF Processing Engine", "weight": 3, "sub_tasks": [{"requirements": "Text Extraction and Search Engine", "weight": 3}, {"req... |
svelte | https://github.com/sveltejs/svelte | be645b4d9f84cb7580683c7b2336d1023906c4da | {"title": "svelte", "description": "Documentation for svelte", "subpages": [{"title": "Svelte", "path": "[\"subpages\", 0]", "content": {"root": []}}, {"title": "01 Introduction", "description": "Documentation section: 01-introduction", "path": "[\"subpages\", 1]", "subpages": [{"title": "Overview", "path": "[\"subpage... | {"title": "svelte", "description": "Documentation for svelte", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/svelte/original/docs"}, "subpages": [{"title": "Svelte", "description": null, "content": {"root": []}, "metadata": {"title": "Svelte"}, "subpages": [], "path"... | {"rubrics": [{"requirements": "Compiler-Driven Architecture", "weight": 3, "sub_tasks": [{"requirements": "Single-file component (.svelte) processing system", "weight": 3, "sub_tasks": [{"requirements": "Parses distinct blocks for logic (<script>), structure (markup), and presentation (<style>)", "weight": 3}, {"requir... |
trino | https://github.com/trinodb/trino | d1501ee536c0c6883ed960a184ba7b3f9e36a6c3 | {"title": "trino", "description": "Documentation for trino", "subpages": [{"title": "Trino documentation", "path": "[\"subpages\", 0]", "content": {"Writing and contributing": "<detail_content>", "Tools": "<detail_content>", "Fast doc build option": "<detail_content>", "Default build": "<detail_content>", "Viewing docu... | {"title": "trino", "description": "Documentation for trino", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/trino/original/docs"}, "subpages": [{"title": "Trino documentation", "description": null, "content": {"Writing and contributing": "We welcome any contributions to the document... | {"rubrics": [{"requirements": "Distributed SQL Query Engine Architecture", "weight": 3, "sub_tasks": [{"requirements": "Core Query Processing Engine", "weight": 3, "sub_tasks": [{"requirements": "Query Execution Model with Coordinator-Worker Architecture", "weight": 3, "sub_tasks": [{"requirements": "Coordinator node m... |
wazuh | https://github.com/wazuh/wazuh | 44b7cd33e05abb7730228bb092b23b419ee4f15e | {"title": "wazuh", "description": "Documentation for wazuh", "subpages": [{"title": "Readme", "path": "[\"subpages\", 0]", "content": {"Introduction ": "<detail_content>"}}, {"title": "Summary", "path": "[\"subpages\", 1]", "content": {"Summary": "<detail_content>", "Development Documentation": "<detail_content>", "Ref... | {"title": "wazuh", "description": "Documentation for wazuh", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWiki-Benchmarking-System/data/wazuh/original/docs"}, "subpages": [{"title": "Readme", "description": null, "content": {"Introduction ": "In an attempt to explain the functioning and responsi... | {"rubrics": [{"requirements": "Distributed Security Information and Event Management (SIEM) Platform", "weight": 3, "sub_tasks": [{"requirements": "Event Processing Engine", "weight": 3, "sub_tasks": [{"requirements": "Core Event Processing Pipeline Architecture", "weight": 3, "sub_tasks": [{"requirements": "Multi-Stag... |
x64dbg | https://github.com/x64dbg/x64dbg | 134e7ebb26523757ca9042f2a0925024751f42c7 | {"title": "x64dbg", "description": "Documentation for x64dbg", "subpages": [{"title": "Compile Linux", "path": "[\"subpages\", 0]", "content": {"Prerequisites": "<detail_content>", "Install MSVC": "<detail_content>", "Build": "<detail_content>", "Issues": "<detail_content>"}}, {"title": "docs", "path": "[\"subpages\", ... | {"title": "x64dbg", "description": "Documentation for x64dbg", "content": {}, "metadata": {"type": "root", "path": "/home/anhnh/CodeWikiBench/data/x64dbg/original/docs"}, "subpages": [{"title": "Compile Linux", "description": null, "content": {"Prerequisites": "```\nsudo apt update\nsudo apt install cmake ninja-build w... | {"rubrics": [{"requirements": "Core Debugging Engine - Multi-architecture debugging system with comprehensive process control and memory management", "weight": 3, "sub_tasks": [{"requirements": "Process Lifecycle Management - Controls target process execution states and debugging sessions", "weight": 3, "sub_tasks": [{... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.